Main Content

Track Changes to Requirement Links

After you author or import requirements and create links between design elements and your requirements, Requirements Toolbox™ tracks the links and detects when linked requirements change. You can track change information from the Requirements Editor or in the Traceability Matrix and, then resolve change issues or clear changes that have no impact on the requirement status.

Enable Change Tracking for Requirement Links

To enable change tracking for requirement links:

  1. Open the Requirements Editor. From your Simulink® model, in the Apps tab, click Requirements Manager. In the Requirements tab, click Requirements Editor. Alternatively, enter this command at the MATLAB® command prompt.

    slreq.editor
  2. Open a requirement set.

  3. On the View tab under Information , select Change Information.

Once you enable Change Information, this setting stays enabled even after you close the Requirements Editor.

Alternatively, you can enable change tracking for requirement links from the Requirements Perspective. Right-click an item in the Requirements Perspective and select Change Information.

Run Change Tracking Analysis

Requirements Toolbox does not perform change tracking analysis until you run the analysis. You can run the analysis in the Requirements Editor or Requirements Perspective.

A banner in the Requirements Editor or Requirements Perspective indicates when results are pending. To run the analysis, click Analyze now in the banner. Alternatively, click Refresh in the Requirements Editor or the refresh button in the Requirements Perspective.

Change tracking analysis continuously runs in the background until you use slreq.clear.

Review Changes to Requirements, Test Objects, and MATLAB Code Lines

After you run change tracking analysis, you can use the Requirements Editor to review the changes.

Review Changes to Requirements

You can link requirements to other types of items. For a full list of linkable items, see Linkable Items. When you change linked requirement, the Requirements Editor and Traceability Matrix window and show a change issue. After you enable change tracking for requirements links, you can view the change issues associated with a particular requirement from the Requirements Editor or the Traceability Matrix window.

Note

Requirements Toolbox provides change tracking information for unresolved links only if the linked requirement is valid. For more information on why a link might become unresolved, see Unresolved Links.

In the Requirements Editor, click Show Requirements. The linked requirements with changes are highlighted in red. When you select a requirement, the associated link is also highlighted in red in the right pane, under Links. To view the change issue, select a requirement and, under Links, point to the link, then click the link icon () to the right of the linked item.

In the Traceability Matrix window, under Highlight Missing Links click Highlight Changed Links to highlight the row, column, and cell associated with the linked requirement. To view changes to the linked requirement, select the cell and, in the dialog box that appears, click the requirement hyperlink next to Source or Destination. To view the change issue, click the link hyperlink next to Link. To learn more about using the Traceability Matrix window to find change issues, see View and Clear Change Issues for Links.

Review Changes to Test Objects

To create links between requirements and test objects, see Link to Test Cases from Requirements. When you change Simulink Test™ test objects, the Requirements Editor and Traceability Matrix window highlight the link to indicate that the source object has changed.

In the Requirements Editor, click Show Requirements. The linked requirements show the change issues related to the source of the links. The editor indicates linked requirements that have change issues with the change issue icon.

When you link a test case to a requirement, the associated link is highlighted in red in the right pane, under the Links section. To view the change issue, select the link, then click Change Information.

You can clear the change issues for test cases from the Requirements Editor or the Traceability Matrix by.

  • Compare requirement sets or link sets files: You can compare the two versions with and without the changes..

  • Clear issues in the Requirements Editor: If a change has no impact, you can clear the change issue. If the change issue affects requirements or test cases, first resolve the discrepancy, then clear the issue.

  • Clear issues using the Traceability Matrix window: In the Traceability Matrix, click Highlight Missing Links > Highlight Changed Links to highlight the row, column, and cell associated with the changed requirement. From the Filter Panel, select Change Tracking > With Change Issues to filter the test cases that have changed.

Review Changes to MATLAB Code Lines

When you change MATLAB code lines orMATLAB Function block, the Requirements Editor and Traceability Matrix window highlight the link to indicate that the source object has changed.

In the Requirements Editor, select Show Requirements from the Requirements pane. The linked requirements show the change issues related to the source of the links. The editor indicates linked requirements that have change issues with the change issue icon .

For more information on linking the requirements to MATLAB code, see Verify Requirements with MATLAB Tests. You can view the change issue in the MATLAB code when you:

  • Add or remove lines.

  • Insert or remove text from the existing lines.

Image showing the change issue.

In the requirements view, you can see the highlighted link in the Links section along with the change icon on the requirement in the requirement tree.

To view the change issue, click the icon in the Links section. This directs you to the section of code with the changes. To clear the change issue, click the links in Links view and select Clear Issue under Change Information.

MATLAB code lines within MATLAB Function blocks in Simulink models are also tracked for change issues.

Resolve Change Issues

The Requirements Editor displays change information, including change issues, for each link. Click Show Links and, in the right pane, expand Change Information. Requirements Toolbox compares the stored timestamp and revision to the current timestamp and revision for the linked artifact. If you change the source or the requirement after you create the link, or after the last time you changed it, then the Requirements Editor indicates a change issue.

You can resolve change issues from the Requirements Editor or the Traceability Matrix. If a change has no impact, you can clear the change issue. The link change information is updated with the current timestamp and revision for the requirement. If the change issue affects the status of your requirements, you can change the model, the requirements, the test cases, or the links themselves to resolve the revision discrepancy, and then clear the issue.

In the Requirements Editor, links with change issues are highlighted in red when you select Show Links. To clear a change issue, select the link and, in the right pane, under Change Information, click Clear Issue.

In the Traceability Matrix, you can highlight links with change issues by selecting Highlight Missing Links > Highlight Changed Links. To clear the change issue, select the cell containing the link and, in the toolstrip, click Clear Change Issue.

Clear Change Issues for Multiple Links

You can clear change issues for multiple links at a time in the Requirements Editor or in the Traceability Matrix.

In the Requirements Editor, select multiple links by pressing Shift or Ctrl and clicking the links. Right-click one of the selected links and click Clear Issue from the context menu. To clear all change issues for an entire link set, select the link set and, in the right pane, under Change Information, click Clear All. You can also right-click the link set and select Clear All Change Issues from the context menu.

In the Traceability Matrix, select multiple cells by clicking and dragging, or pressing Shift or Ctrl, click the cells, and click Clear Change Issue in the toolstrip.

Add Comments to Links

When you resolve change issues, it is good practice to add a comment to the link describing the actions. Each link has a Comments property. When you clear a change issue in either the Requirements Editor or Traceability Matrix, a dialog box appears and you are prompted to add a comment.

To add an additional comment:

  1. In the Requirements Editor, click Show Links.

  2. Select the link.

  3. In the right pane, under Comments, click Add Comment.

Manually Check for Using Links Change Tracking

Change tracking information is automatically updated in the Requirements Editor, but you can also manually refresh it. To refresh the change tracking information:

  • In the Requirements Editor, click Refresh.

  • In the Traceability Matrix, click Update.

In the Traceability Matrix, you need to refresh change tracking information manually.

Related Topics