Main Content

Requirements Settings

You can manage your Requirements Management Interface (RMI) preferences in the Requirements Settings dialog box. These settings are global and not associated with a particular model. To open the Requirements Settings dialog box, in the Apps tab, click Requirements Manager. In the Requirements pane, set the View drop-down to Links. Then, in the Requirements tab, select Link Settings > Linking Options.

In this dialog box, you can select the:

Selection Linking Tab

In the Requirements Settings dialog box, on the Selection Linking tab, use the following options for linking to the active selection in a supported document.

OptionsDescription
For linking to the active selection within an external document:
Enabled applicationsEnable selection-based linking shortcuts to Microsoft® Word, Excel®, or DOORS® applications.
Document file referenceSelect type of file reference. For information on what settings to use, see Document Path Storage.
Apply this keyword to new linksEnter text to attach to the links you create. For more information about user keywords, see Filter Requirements with User Keywords.
When creating selection-based links:
Modify destination for bidirectional linkingCreates links both to and from selected link destination.
Store absolute path to model fileSelect to store the absolute path to the Simulink® model file.
Use custom bitmap for navigation controls in documentsSelect and browse for your bitmap. You can use your own bitmap file to control the appearance of navigation links in your document.
Use ActiveX® buttons in Word and Excel (backward compatibility)Select to use legacy ActiveX controls to create links in Microsoft Word and Excel applications. By default, if not selected, you create URL-based links.

Filter Requirements with User Keywords

User Keywords and Requirements Filtering

User keywords are user-defined keywords that you associate with specific requirements. With user keywords, you can highlight a model or generate a requirements report for a model in the following ways:

  • Highlight or report only those requirements that have a specific user keyword.

  • Highlight or report only those requirements that have one of several user keywords.

  • Do not highlight and report requirements that have a specific user keyword.

Apply a User Keyword to a Requirement

To apply one or more user keywords to a newly created requirement:

  1. Open the example model:

    openExample("slvnvdemo_fuelsys_officereq.slx")
  2. Open the fuel rate controller subsystem.

  3. To open the requirements document, right-click the Airflow calculation subsystem and select Requirements > Open Outgoing Links dialog.

    The Requirements Traceability Link Editor opens with the details about the requirement that you created.

    Outgoing links dialog box

  4. In the Keywords field, enter one or more keywords, separated by commas, that the RMI can use to filter requirements. In this example, after design, enter a comma, followed by the user keyword test to specify a second user keyword for this requirement.

    User keywords:

    • Are not case sensitive.

    • Can consist of multiple words. For example, if you enter design requirement, the entire phrase constitutes the user keyword. Separate user keywords with commas.

  5. Click Apply or OK to save the changes.

Filter, Highlight, and Report with User Keywords

The slvnvdemo_fuelsys_officereq model includes several requirements with the user keyword design. This section describes how to highlight only those model objects that have the user keyword, test.

  1. Remove highlighting from the slvnvdemo_fuelsys_officereq model. In the Apps tab, click Requirements. In the Requirements pane, in the View drop-down menu, select Links. Then, in the Requirements tab, click Highlight Links.

  2. Select Link Settings > Linking Options.

  3. In the Requirements Settings dialog box, click the Filters tab.

    Filters tab of the Requirements Settings dialog box

  4. To enable filtering with user keywords, click the Filter links by user keywords when highlighting and reporting requirements option.

  5. To include only those requirements that have the user keyword, test, enter test in the Include links with any of these keywords field.

  6. Click Close.

  7. In the Requirements tab, click Highlight Links.

    The RMI highlights only those model objects whose requirements have the user keyword test, for example, the MAP sensor.

  8. Reopen the Requirements Settings dialog box to the Filters tab.

  9. In the Include links with any of these keywords field, delete test. In the Exclude links with any of these keywords field, add test.

    In the model, the highlighting changes to exclude objects whose requirements have the test user keyword. The MAP sensor and Test inputs blocks are no longer highlighted.

  10. In the Requirements tab, select Share > Generate Model Traceability Report.

    The report does not include information about objects whose requirements have the test user keyword.

Apply User Keywords During Selection-Based Linking

When creating a succession of requirements links, you can apply the same user keywords to all links automatically. This capability, also known as selection-based linking, is available only when you are creating links to selected objects in the requirements documents.

When creating selection-based links, specify one or more user keywords to apply to requirements:

  1. In the Requirements tab, click Link Settings > Linking Options.

  2. In the Apply this keyword to new links field of the Selection Linking tab, enter one or more user keywords, separated by commas.

    Selection Linking tab of the Requirements Settings dialog box

    The RMI applies these user keywords to all new selection-based requirements links that you create.

  3. Click Close to close the Requirements Settings dialog box.

  4. In a requirements document, select the specific requirement text.

  5. Right-click a model object and select Requirements.

    The selection-based linking options specify which user keywords the RMI applies to the link that you create. In the following example, you can apply the user keywords design, general, and reqtslink to the link that you create to your selected text.

    Context menu with Requirements Traceability options

Configure Requirements Filtering

In the Requirements Settings dialog box, in the Filters tab, use the following options for filtering requirements in a model.

OptionDescription
Filter links by keyword when highlighting and reporting requirementsEnables filtering for highlighting and reporting, based on specified user keywords.
Include links with any of these keywordsIncludes information about requirements that have the specified user keywords. Separate multiple user keywords with commas.
Exclude links with any of these keywordsExcludes information about requirements that have the specified user keywords. Separate multiple user keywords with commas or spaces.
Apply same filters to link labelsDisables link labels in context menus if one of the specified filters are satisfied, for example, if a requirement has a designated user keyword.
Apply same filters in consistency checkingIncludes or excludes requirements with specified user keywords when running a consistency check between a model and its associated requirements documents.
Under Link type filters, Disable synchronization item links in context menus

Disables links to DOORS surrogate items from the context menus when you right-click a model object. This option does not depend on current user keyword filters.