Filter Requirements with User Tags

User Tags and Requirements Filtering

User tags are user-defined keywords that you associate with specific requirements. With user tags, 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 tag.

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

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

Apply a User Tag to a Requirement

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

  1. Open the example model:

    slvnvdemo_fuelsys_officereq
  2. Open the fuel rate controller subsystem.

  3. To open the requirements document, right-click the Airflow calculation subsystem and select Requirements Traceability > Open Link Editor.

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

  4. In the User tag 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 tag test to specify a second user tag for this requirement.

    User tags:

    • Are not case sensitive.

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

  5. Click Apply or OK to save the changes.

Filter, Highlight, and Report with User Tags

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

  1. In the Simulink® Editor, remove highlighting from the slvnvdemo_fuelsys_officereq model by selecting Analysis > Requirements Traceability > Unhighlight model.

  2. Select Analysis > Requirements Traceability > Settings.

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

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

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

  6. Click Close.

  7. In the Simulink Editor, select Analysis > Requirements Traceability > Highlight model.

    The RMI highlights only those model objects whose requirements have the user tag 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 tags field, delete test. In the Exclude links with any of these tags field, add test.

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

  10. In the Simulink Editor, select Analysis > Requirements Traceability > Generate Report.

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

Apply User Tags During Selection-Based Linking

When creating a succession of requirements links, you can apply the same user tags 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 tags to apply to requirements:

  1. In the Simulink Editor, select Analysis > Requirements Traceability > Settings.

  2. Select the Selection Linking tab.

  3. In the Apply this user tag to new links field, enter one or more user tags, separated by commas.

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

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

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

  6. Right-click a model object and select Requirements Traceability.

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

Configure Requirements Filtering

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

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

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

Was this topic helpful?