Analysis Tab

NI Requirements Gateway 2018 Help

Edition Date: March 2018

Part Number: 371714F-01

»View Product Info
Download Help (Windows Only)

The Analysis tab contains options for capturing elements of the type you select in the Types List. The options available depend on the item you select.

Note Note  When you select the text, picture, or table element of a type, the Types pane does not display any tabs and includes only the options available in the Selection Properties pane of the Types pane.

Options for Root Nodes

The Analysis tab contains the following options when you select the root node of a type.

  • Convert tool—Select a supported external application for the type to use to convert a project document source file to an intermediate file. The list of conversion tools available corresponds to the list of all types available in the project.
  • Edit tool—Select a supported external application for Requirements Gateway to launch when you select Navigate from a menu in the main window for a document or element. The editing tool you select can be different from the source tool in which the document was originally created. For example, specify to use Microsoft Word to edit a .txt file. The list of editing tools includes several applications that do not correspond to Requirements Gateway types.
  • Extension—The file extension for a source file for a project document of the type you are creating. Enter only the letters of the extension, not the dot. For example, enter doc, not .doc, to convert .doc type files only.
  • Encoding format—A list of available encoding formats for the input file. Select from the default encoding format for the type, UTF-8, UCS-2, UCS-2BE, Shift_JIS, and GBK.
    Note Note  Select the UCS2 option when you want to support text files that contain multi-byte Asian characters.
  • Comment—A free text field in which you can add comments for the type.

Options for Text-Based Types

The Analysis tab can contain the following options when you select an element of a text-based type. The tab contains different options when you select an element of an XML-based type.

  • Regular expression—The regular expression used to capture the specified element in an intermediate file. Some elements may also display an End regular expression control. If you specify only one regular expression, the expression you enter in the Regular expression control captures the entire element. If you also specify an end regular expression, the expression you enter in the Regular expression control captures only the beginning of the element.

    Right-click in the Regular expression control to launch a context menu you can use to specify the information that each field of the regular expression captures. Two parentheses, ( ), define a field. For example, if a requirement element specifies a regular expression (REQ\d+)\|2 ([^\|]+), the expression defines a (REQ\d+) field and a ([^\|]+) field. Assign each field to capture one of the following pieces of information:
    • Identifier—The ID of the element.
    • Label—Optional text used to notarize the element.
    • Text—The text of the element.
    • GUID—An internal ID.
    • Parent—The ID of the element that is one hierarchical level higher than the currently selected element.
    • Depth—The depth of a section heading. This option is available only when you define a section element.


    When you define a reference or link element, select the following additional options for assigning a field.
    • Target—The target requirement ID.
    • Source—The source requirement ID.
    • Target Document—The target document ID.


    When you define a text element, select the following additional options for assigning a field.
    • Text—The text of the element.
    • Column index—The cell index of the element.
  • Test regular expression—Displays the Expressions pane with the regular expression controls prepopulated so you can test whether the regular expressions you create on the Types pane capture the correct information. If you click this button and modify the expression on the Expressions pane, click Update on the Expressions pane to update the regular expression on the Types pane with the correct information.
  • End regular expression—The closing expression for the element if you specified only the beginning expression in the Regular expression control. If this control is blank, the expression you enter in the Regular expression control specifies the starting position of the element, and Requirements Gateway considers the element closed at the beginning of the next captured instance of the element or at the end of the source document.

    You can use an end regular expression to recursively analyze a document. For example, you can capture sections from files that use a hierarchy of sections, such as the following structure:

    [Section]

    Information...

    [Section]

    Other information...

    [end of Section]

    [End of Section]
  • Sub-regular expression—An additional regular expression that captures a second level of analysis to process the result of the preceding regular expression. Use a sub-regular expression when the reference information contains a reference to several requirements. For example, if the reference text contains CoveredRequirements: REQ1, REQ2, REQ3, use the regular expression CoveredRequirements: (.+) and the sub-regular expression (REQ\d).
  • Row regular expression—A regular expression that captures the beginning of a table row. This option is available only when you define a table element.
  • Inverse regular expression—A regular expression that Requirements Gateway uses to capture requirement traceability information formatted in a passive or upstream-to-downstream direction, using the Is covered by syntax, instead of the default active or downstream-to-upstream direction, which uses the Covers syntax.
  • Is external—Specifies that a reference or link element covers a requirement that is external to the current project, such as a web document. An external requirement appears as an undefined requirement in the main window.
  • Prefix expression—A regular expression that Requirements Gateway uses to concatenate the defined prefix and the results the regular expression captures to obtain the entire element ID.

    For example, you may define requirements in a document as follows:

    REQ_Product1_
    Info…
    F1: Max time response shall be 5 ms
    F2: The system shall be active in less than 10 clock periods

    If you specify REQ_Product1 as a prefix expression, you can capture requirements as follows:

    REQ_Product1_F1: Max time response shall be 5 ms
    REQ_Product1_F2: The system shall be active in less than 10 clock periods
  • Is Hierarchical—Specifies that a macro-requirement contains other requirements or macro-requirements.
  • Preserve spaces—Keeps spaces at the beginning and end of the text.

Options for XML-Based Types

The Analysis tab contains the following options when you select the root node of an XML-based type or an element of an XML-based type. The options available depends on the type element you select.

  • XML Tree View—The structure of XML content you want to capture from an XML-based project document source file. Use the options on the Analysis tab to specify the XML structure so you can accurately capture traceability information from the source XML file.

    When you right-click an element in the XML tree view, the context menu contains the following options:
    • Copy—Copies the selected tag or attribute, including all child tags or attributes, to the clipboard.
    • Paste and replace—Pastes the copied tag or attribute, including all the child tags or attributes, and replaces the selected tag or attribute.
    • Paste and add—Pastes the copied tag or attribute, including all the child tags or attributes, and adds the information as a child tag of the selected tag or attribute.
    • Negative—Specifies that the XML type captures the tags or attributes whose value does not match the value specified in the Value control. For example, if you specify an XML tag <Object> that contains the attribute name and you specify ReqID for the attribute value, by default the XML type captures all name attributes that contain the value ReqID. If you right-click the attribute in the XML tree view and select Negative from the context menu, Requirements Gateway appends an exclamation point (!) to the attribute to indicate that the XML type now captures all name attributes that contain any value except ReqID.
    • Reference—Specifies that the selected element is the reference point for analyzing the captured XML information. For example, consider that you specify the following XML structure:

      <root>
        <element>
          <text>
        <description>
          <text>

      By default, the root tag is the reference, so the XML type captures all <text> tags. If you specify that the <element> tag is the reference, the XML type captures only the one child <text> tag.
    • Recursive—Specifies that the XML type captures not only the contents between tags but also contents between children tags. For example, consider that you need to analyze the following sentence:

      <root>Display<child>all the</child> contents.</root>

      By default, the XML type captures Display contents. If you specify that the <root> tag is Recursive, the XML type captures Display all the contents.
    • Optional—Specifies that the XML type element is optional.
  • XML Structure Type—Specifies the type of the XML structure type. Contains the following options:
    • Tag—Specifies whether the XML structure is an XML tag. The root of the XML structure can only be a tag.
    • Attribute—Specifies whether the XML structure is an XML attribute.
  • Name—Specifies the name of the tag or attribute you select.
  • Information Type—Specifies the type of information that the tag captures.

    When you define a section, macro-requirement, requirement, or entity element, the Information Type field contains the following options::
    • Identifier—The information to capture is the ID of the element you select.
    • Label—The information to capture is the label of the element you select.
    • Text—The information to capture is the text of the element you select.
    • GUID—The information to capture is an optional Globally Unique Identifier (GUID) for the element. Requirements Gateway cannot display the value, but you can use the value to identify the element when reanalyzing the document or navigating to the selected element in the source file.
    • Parent—The information to capture is the parent of the element you select.
    • Image—The information to capture is the picture of the selected element.
    • Condition—The information to capture is a value of an XML attribute. When you select this option, enter a regular expression in the Value control for the condition.


    When you select a reference or link element, the Information Type field contains the following options:
    • Target—The target requirement ID.
    • Target Document—The target document ID.
    • GUID—The information to capture is an optional Globally Unique Identifier (GUID) for the element. Requirements Gateway cannot display the value, but you can use the value to identify the element when reanalyzing the document or navigating to the selected element in the source file.
    • Source—The source requirement ID.
    • Condition—The information to capture is a value of an XML attribute. When you select this option, enter a regular expression in the Value control for the condition.


    When you define an attribute or reference attribute element, the Information Type field contains the following options:
    • Identifier—The information to capture is the ID of the element you select.
    • Label—The information to capture is the label of the element you select.
    • GUID—The information to capture is an optional Globally Unique Identifier (GUID) for the element. Requirements Gateway cannot display the value, but you can use the value to identify the element when reanalyzing the document or navigating to the selected element in the source file.
    • Parent—The information to capture is the parent of the element you select.
    • Condition—The information to capture is a value of an XML attribute. When you select this option, enter a regular expression in the Value control for the condition.
  • Value—Specifies the value you expect for an XML attribute or the regular expression Requirements Gateway uses to capture the type element you select.
  • Add an XML tag or attribute—Adds a new XML tag or attribute below the XML tag you select in the XML Tree View. After you add the XML tag or attribute to the tree view, select Tag or Attribute to specify the type of the new XML element.
  • Delete an XML tag or attribute—Deletes the XML tag or attribute you select.
  • Test XML analysis tree—Opens the XML pane of the Configuration dialog box to text the XML syntax.

See Also

WAS THIS ARTICLE HELPFUL?

Not Helpful