Skip to main content

Configuring requirement properties

You can add Requirement Yogi configuration macros to change the way your requirements are indexed.

To add a configuration macro, in the page edit mode, type /requi  or /config, or click on the + dropdown like you would to add any other Confluence macro.

After adding a macro to the page, you can edit it simply by clicking on the macro:

In tables

When you define requirements in table, by default, the requirement key should be in the first column, with a description in the second column, and properties in the following columns.

This table:

Gets indexed as:

Here is the default configuration for requirements in tables:

With the configuration macro, you can:

  • Rename properties.

  • Change the column type.

Here, I changed the column of "Author" in "Original Author".

My "Dependencies" column was indexed both as a dependency and as a property, so I added a 4th column to my configuration macro to uncheck the indexing as a property, and I set the configuration macro to apply to all the following tables in the document (This configuration is not global, you need to add the macro to every Confluence page with requirements).

After inserting the macro and publishing the edited Confluence page, my requirement is now indexed with the changed properties as:

You can quickly "unindex" the requirements in a page by adding a configuration macro at the top of the document and uncheck the requirements column. It can be useful when you have duplicated requirement definitions.

In paragraphs and headings

New feature

When you define requirements in paragraph or headings, by default, the description of the requirement is the following text.

For this page:

Here are my requirements:

With the configuration macro, you can:

  • Change the property name.

  • Treat the bold text as normal text.

  • Change the dependency name.

  • Ignore the numbering in headings.

After inserting the macro and publishing the document, here is my requirement again:

In headings

You can ignore the numbered headings by passing a regular expression specifying the numbering format.

My headings:

will get saved as:

Here are a few common ways to number headings and their regexes:



















JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.