RY Property macro - Equivalence and manual migration

RY Property macro - Equivalence and manual migration

Context

The main goal of this page is to present every details of the DC RY Property macro and its equivalence in the Cloud.

As Explained in https://confluence.intranet.requirementyogi.com/wiki/x/CgyPaw, the RY Property macro can be add to you Confluence page with the shortcut /req.

image-20250820-072031.png

Feature details

Now let see the different features of this macro and how to migrate it in Requirement Yogi Cloud.

Feature

Description

In Data Center

In the Cloud

Migration from DC to Cloud

Feature

Description

In Data Center

In the Cloud

Migration from DC to Cloud

Rename a property

Goal: Rename a property for the indexing.

In this example: Rename the PropertyName to PropertyRename.

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

image-20250820-072042.png

In a Confluence page, before the table containing the property to rename add the following macro.

image-20250820-073148.png

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

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

Note :
You can use only one Cloud RY Configuration macro for all the renamed done in a single table.

Define a property and its value

Goal: Add a new property with a given value, it allows user to define a new property not present in the Confluence page.

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

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

image-20250820-072059.png

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.

image-20250820-091834.png

 

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.

Filling the Property value without the property Name

This configuration as no effect because the Property name field as not been set.

 

Ignore a property while indexing

This configuration allows to define a column in the Confluence table without defining it as a property to the requirement.
This configuration ignore the property but dependencies during indexing.

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

image-20250820-072130.png

In a Confluence page, before the table containing the property to ignore add the following macro.

image-20250820-074718.png

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

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

Every DC RY property defined in a table header can be replaced with a single RY Configuration before the table.

Ignore dependency while indexing

This configuration allows to define a column in the Confluence table without defining links as dependencies to the requirement.
This configuration ignore dependencies but not the property while indexing.

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

image-20250820-072136.png

In a Confluence page, before the table containing the dependencies to ignore add the following macro.

image-20250820-074718.png

(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 unchecking the Denpendency checkbox of the proper column number.

Every DC RY property defined in a table header can be replaced with a single RY Configuration before the table.

Mark a property as title

This configuration allows to define a property as title/description.

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 containing the property to index as title/description, add the following macro.

(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 checking the Description checkbox of the proper column number.

Every DC RY property defined in a table header can be replaced with a single RY Configuration before the table.

Test Relationship

This configuration allows to set the relationship used for test results when the plugin Test & Compliance is installed

 

image-20250820-072202.png

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

 

Note that the checkbox Whole document in the Data Center RY Property macro can be replaced by adding the Cloud Configuration macro on top of your Confluence page with the checkbox Apply to all following tables checked.

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.