Macro-requirement Element

NI Requirements Gateway 2018 Help

Edition Date: March 2018

Part Number: 371714F-01

»View Product Info
Download Help (Windows Only)

A macro-requirement contains requirements and passes its attributes, text, or links onto those requirements. If a downstream element directly references a macro-requirement, the downstream element also covers all the requirements the macro-requirement contains.

A macro-requirement element defines a starting location and an ending location, where Requirements Gateway associates any requirement element between the locations with the macro-requirement. For example, a macro-requirement element might interpret the syntax [MacroReq_reqid], where reqid is the macro-requirement ID, as a starting location, and the syntax [End_of_MacroReq] as an ending location.

If you use the main window to add attributes, text, or links to a macro-requirement, Requirements Gateway adds the attributes, text, or links to any requirements and derived requirements the macro-requirement contains.

Note Note  A derived macro-requirement does not exist. A macro-requirement that exists at an intermediate level in the traceability of a project but does not reference upstream requirements remains a macro-requirement. If the macro-requirement contains derived requirements, adding links to the macro-requirement transforms each derived requirement into a requirement. Thus, a macro-requirement that is referenced at least once does not contain any derived requirements. Refer to Chapter 3, Analyzing Requirements, of the Getting Started with NI Requirements Gateway manual for more information about using multiple levels of traceability in a project.


Specify the following macro-requirement element options on the Types pane of the Configuration dialog box:

Example Macro-requirement Expression

The following figure shows an example of how you may use a macro-requirement to contain requirements in a source file.

The following figure shows the intermediate file for a Microsoft Word source document which uses the previous macro-requirement structure.

Complete the following steps to specify a regular expression and an end regular expression to capture the macro-requirement shown in the figure.

  1. For a macro-requirement element you create, enter the expression \s+(Level\d+Requirement_\S*) in the Regular expression control on the Analysis tab of the Types pane.
    • \s+ specifies one or several white space characters before the macro-requirement IDs, as you can see in the example intermediate file.
    • (Level\d+Requirement_\S*) defines a field for the requirement IDs. In this example, Requirements Gateway captures Level1Requirement_1, Level2Requirement_1, and Level2Requirement_2.
  2. Enter \s+Endof(Level\d+Requirement_\S*) in the End regular expression control.

See Also


Not Helpful