Custom traceability rules

You can create custom traceability rules if predefined traceability rules are not sufficient to trace and analyze relationships between elements in your model. In a model, custom traceability rules are considered as derived properties, because their values are produced or calculated from other properties. Usually, the values of custom traceability rules cannot be changed directly, but you can edit and display these rules the same way as any other properties.

Creating a custom traceability rule

Custom traceability rules can be quickly created from the Specification window of a particular element. This way you create a new derived property for all elements of the selected element type.

To create a custom traceability rule

1. In the model browser or a diagram, double-click the element for which you want to create a custom traceability rule to open its Specification window.
2. In the property group list on the left side of the Specification window, select the Traceability group.
3. Click the Create button.
4. In the open Expression dialog, specify the name and expression of a new traceability rule.
5. Click OK and close the Specification window. If you want to create a derived property with a result other than an element, you need to change the derived property type manually.

The customization of the newly created traceability rule is saved in the Derived Properties Package with the «derivedPropertiesSuite» stereotype. This folder is normally hidden in the containment tree of your model. You can find it using the Quick Find functionality. This may be useful when you want to change traceability rule properties.

Editing a custom traceability rule

You can modify a custom traceability rule from the Specification window of a particular element or directly from a table if the traceability rule is displayed in it.

To edit a custom traceability rule

1. In the model browser or a diagram, double-click the element with the traceability rule you want to edit to open its Specification window.
2. In the property group list on the left side of the Specification window, select the Traceability group.
3. In the property specification area on the right side of the window, select the traceability rule you want to edit.
4. Click the Edit button.
5. In the Expression dialog, make desired changes and click OK.
6. Close the Specification window.

If a custom traceability rule is displayed in a table, you can edit it directly from that table.

To edit a custom traceability rule in a table

1. In a table, right-click the header of the desired custom traceability rule column and select Edit Derived Property.
2. In the Expression dialog, make desired changes and click OK.

Displaying a custom traceability rule

If you want to visualize custom traceability rules, you can display them in the compartments of element shapes or in tables.

To display a custom traceability rule on an element shape

1. Do one of the following:
   
   • In a diagram, right-click the desired element shape and select Edit Compartments.

   • In a diagram, select the desired element shape and click the Compartments smart manipulator, click on the down arrow to expand the menu, and select Edit Compartments.

2. In the Compartment Edit dialog, select the Element Properties tab.

3. In the Hidden list on the left side of the dialog, select the traceability rules you want to display.
4. Click  to add the selected traceability rules to the Selected list on the right side of the dialog. If you want to display all properties from the Hidden list, click .
5. Click OK.

To display a custom traceability rule in a table

1. In the toolbar of an active table, click the Show Columns button and from the menu select the Select Columns command.
2. In the Select Columns dialog, set the traceability rules you want to display as true.
3. Click OK.

Removing a custom traceability rule

You can remove a Custom traceability rule from the Specification window of a particular element or directly from a table if the traceability rule is displayed in it.

To remove a custom traceability rule

1. In the model browser or a diagram, double-click the element with the traceability rule you want to remove to open its Specification window.
2. In the property group list on the left side of the Specification window, select the Traceability group.
3. In the property specification area on the right side of the window, select the traceability rule you want to remove.
4. Click the Delete button and close the Specification window.

To remove a custom traceability rule in a table

• In a table, right-click the header of the unwanted custom traceability rule column and select Remove Derived Property.