Main Content

Requirements Consistency Checks

Identify requirement links with missing documents

Check ID: mathworks.req.Documents

Verify that requirements link to existing documents.

Description

You used the Requirements Management Interface (RMI) to associate a design requirements document with a part of your model design and the interface cannot find the specified document.

Available with Requirements Toolbox™.

Results and Recommended Actions

ConditionRecommended Action
The requirements document associated with a part of your model design is not accessible at the specified location. Open the Requirements dialog box and fix the path name of the requirements document or move the document to the specified location.

Capabilities and Limitations

You can exclude blocks and charts from this check.

Tips

If your model has links to a DOORS® requirements document, to run this check, the DOORS software must be open and you must be logged in.

Identify requirement links that specify invalid locations within documents

Check ID: mathworks.req.Identifiers

Verify that requirements link to valid locations (e.g., bookmarks, line numbers, anchors) within documents.

Description

You used the Requirements Management Interface (RMI) to associate a location in a design requirements document (a bookmark, line number, or anchor) with a part of your model design and the interface cannot find the specified location in the specified document.

Available with Requirements Toolbox.

Results and Recommended Actions

ConditionRecommended Action
The location in the requirements document associated with a part of your model design is not accessible.Open the Requirements dialog box and fix the location reference within the requirements document.

Capabilities and Limitations

You can exclude blocks and charts from this check.

Tips

If your model has links to a DOORS requirements document, to run this check, the DOORS software must be open and you must be logged in.

If your model has links to a Microsoft® Word or Microsoft Excel® document, to run this check, those applications must be closed on your computer.

Identify selection-based links having description fields that do not match their requirements document text

Check ID: mathworks.req.Labels

Verify that descriptions of selection-based links use the same text found in their requirements documents.

Description

You used selection-based linking of the Requirements Management Interface (RMI) to label requirements in the model's Requirements menu with text that appears in the corresponding requirements document. This check helps you manage traceability by identifying requirement descriptions in the menu that are not synchronized with text in the documents.

Available with Requirements Toolbox.

Results and Recommended Actions

ConditionRecommended Action
Selection-based links have descriptions that differ from their corresponding selections in the requirements documents.If the difference reflects a change in the requirements document, click Update in the Model Advisor results to replace the current description in the selection-based link with the text from the requirements document (the external description). Alternatively, you can right-click the object in the model window, select Edit/Add Links from the Requirements menu, and use the Requirements dialog box that appears to synchronize the text.

Capabilities and Limitations

You can exclude blocks and charts from this check.

Tips

If your model has links to a DOORS requirements document, to run this check, the DOORS software must be open and you must be logged in.

If your model has links to a Microsoft Word or Microsoft Excel document, to run this check, those applications must be closed on your computer.

Identify requirement links with path type inconsistent with preferences

Check ID: mathworks.req.Paths

Check that requirement paths are of the type selected in the preferences.

Description

You are using the Requirements Management Interface (RMI) and the paths specifying the location of your requirements documents differ from the file reference type set as your preference.

Available with Requirements Toolbox.

Results and Recommended Actions

ConditionRecommended Action
The paths indicating the location of requirements documents use a file reference type that differs from the preference specified in the Requirements Settings dialog box, on the Selection Linking tab.

Change the file reference type or the specified paths by doing one of the following:

  • Click Fix to change the current path to the valid path.

  • In the Apps tab, click Requirements Manager. In the Requirements pane, in the View drop-down menu, select Links. In the Requirements tab, select Link Settings > Linking Options.

    In the Selection Linking tab, change the value for the Document file reference option.

Linux Check for Absolute Paths

On Linux® systems, this check is named Identify requirement links with absolute path type. The check reports warnings for requirements links that use an absolute path.

The recommended action is:

  1. Right-click the model object and select Requirements > Edit/Add Links.

  2. Modify the path in the Document field to use a path relative to the current working folder or the model location.

Capabilities and Limitations

You can exclude blocks and charts from this check.

Identify IBM DOORS objects linked from Simulink that do not link to Simulink

Identify IBM® DOORS objects that are targets of Simulink®-to-DOORS requirements traceability links, but that have no corresponding DOORS-to-Simulink requirements traceability links.

Description

You have Simulink-to-DOORS links that do not have a corresponding link from DOORS to Simulink. You must be logged in to the IBM DOORS Client to run this check.

Available with Requirements Toolbox.

Results and Recommended Actions

The Requirements Management Interface (RMI) examines Simulink-to-DOORS links to determine the presence of a corresponding return link. The RMI lists DOORS objects that do not have a return link to a Simulink object. For such objects, create corresponding DOORS-to-Simulink links:

  1. Click the Fix All hyperlink in the RMI report to insert required links into the DOORS client for the list of missing requirements links. You can also create individual links by navigating to each DOORS item and creating a link to the Simulink object.

  2. Re-run the link check.