Difference between RY Property macro and RY Configuration macro

Rename a property

Goal: Rename a property so the text in the header can be different than the property name in the requirement’s detail.

In this example: Rename the PropertyName to something like PropertyRename.

In a Confluence page, in the column header containing the name of the property, add the following macro: /ry property.

Open

In a Confluence page, before the table containing the property to rename add the following macro: /requirement yogi configuration.

Open

(Assuming the property to rename is defined in the column n°3)

Every DC requirement-property defined in a table header can be replaced with a single RY Configuration before the table. Each property can be renamed in the RY Configuration by filling the Override name of the proper column number.

Note :
- You can configure each column within one macro, whereas in DC, the macro only configured one column.

Define a default property and its value

Goal: Add a new property with a default value. User will be able to define a new property not present in the Confluence page.

In this example: Add a PropertyRenamed&Default with the value DefaultValue.

Note:
- Filling the Property value without the property Name has no effect because the Property name field as not been set.

In a Confluence page, in the column header containing the name of the property, add the following macro /ry property.

Open

There is no configuration equivalent in the Cloud.

However you can add a new column to your table and fill the header with the property name and all the cells with the property value.

Also, Requirement Types allow you to define a new property with a default value.

Open

You can add a new column to define this property and set all the cells to the wanted value.

For more advanced users with a lot of structure in their key naming, you can use the Requirement type feature to define, for this set of requirements, a new property with its default value.

Mark a property as title

Goal: This configuration allows to define a property as title (DC phrasing) /description (Cloud phrasing).

In a Confluence page, in the column header containing the name of the property to index as title/description, add the following macro.

In a Confluence page, before the table, add the following macro /Requirement Yogi Configuration. Tick the description to index it as title/description.

Open

(Assuming the property to index as Description is defined in the column n°5 - see )

Each property defined as title/description can be set in the RY Configuration by ticking the Description checkbox of the proper column number.

Ignore a property while indexing

Goal: This configuration lets you add columns in the Confluence table without us indexing its content as a property of the requirement.
This configuration still indexes dependencies.

In a Confluence page, in the column header containing the name of the property to ignore, add the following macro /RY Property.

Open

In a Confluence page, before the table, add the following macro: Requirement Yogi Configuration. Untick the box property for the columns you want us to ignore.

Open

(Assuming the property to ignore is defined in the column n°3 - see )

Each property ignored can be set in the RY Configuration by unticking the Property checkbox of the proper column number.

Ignore dependency while indexing

Goal: This configuration lets you define columns in the Confluence table without us indexing links as dependencies of the requirement.
This configuration ignores dependencies but will still index content as a property.

In a Confluence page, in the column header containing the name of the dependencies to ignore, add the following macro /RY Property.

Open

In a Confluence page, before the table, add the following macro /Requirement Yogi Configuration. Untick the dependency box to ignore.

Open

(Assuming the dependencies to ignore are defined in the column n°4 - see )

Each property with the ignored dependencies can be set in the RY Configuration by unticking the Denpendency checkbox of the proper column number.

Apply to whole document

Goal: This DC option is useful when the macro has been added outside of a table. In this condition, it impacts all requirements defined in the page.

In a Confluence page, in the column header or outside of a table, add the following macro /RY Property.

You can set up a default Property and Property value and apply it to the whole page.

In a Confluence page, before the table, add the following macro /Requirement Yogi Configuration. Set up your configuration, and tick Apply to all following tables.

Note that this will configure requirements defined in tables only, and not requirements put in paragraphs.

Note that the checkbox Whole document in the Data Center RY Property macro can be used all requirements (in or outside of tables). Whereas in the Cloud, the configuration can only be applied to requirements in tables.

To replace the Whole document configuration, you can add the Cloud Configuration macro on top of your Confluence page with the checkbox Apply to all following tables checked.

Test Relationship

Goal: This configuration let you set the relationship used for test results when the plugin RY Testing & Compliance is installed.

There is no configuration equivalent in the Cloud because the RY Testing & Compliance plugin is not available in the Cloud.