Text Type

NI Requirements Gateway 2018 Help

Edition Date: March 2018

Part Number: 371714F-01

»View Product Info
Download Help (Windows Only)

The Text type browses a specified ANSI text file (.txt) for text that uses the correct syntax for sections, macro-requirements, requirements, references, attributes, and text.

Traceability Elements

The Text type captures the following traceability information from a text source file:

  • Sectionn.n.n.n. text, where n is a numeric value and text is the label for the section. The type supports up to four numeric levels.
  • Macro-Requirement—Text that begins with [MacroReq_reqid] and ends with [End_of_MacroReq].
  • RequirementprefixREQnn: label, where prefix is non-spaced alphanumeric characters, nn is a numeric value, and label is any text.
  • Reference[Covers: reqid1, reqid2].
  • Attribute-Priority: text, where text must be Low, Med, or High. The attribute must appear after the corresponding requirement.
  • Text<<text>>, where text is the requirement text value. The requirement text must appear on a new line after the corresponding section or requirement element.

Configuring a Text Document

The Text type defines the following document settings you configure for a Text document on the Details tab of the Project pane of the Configuration dialog box:

  • File or Directory—The text file.
  • Variable—Defines the following document variable:
    • Category—Assigns an analysis category to the Access document. Select a category from the Value pull-down menu. Use the Overall Quality pane of the Management view to review the use of analysis categories in a project.

Creating a Text Reference from Requirements Gateway

To add a reference in a Text document, insert the correct syntax for a Text reference into a text file. In Requirements Gateway, right-click a requirement in an upstream document covered by a downstream Text document and select Copy For»Text Covers Reference from the context menu to copy [Covers: reqid] to the clipboard. You can then paste the reference in the text file.

Special Considerations when Creating a Custom Text Type

The default Text type can analyze only ANSI files. You can create a custom Text type to analyze text files that encode data using a different encoding format.

When you create a custom Text type, use the Encoding format control on the Analysis tab of the Types pane of the Configuration dialog box to specify one of the following encoding formats for the custom Text type to use:

  • Default—ANSI encoding (ISO 8859-1)
  • UTF8—8-bit Unicode transformation format
  • UCS2—2-byte Unicode Little Endian format
  • UCS2be—2-byte Unicode Big Endian format
Note Note  Select the UCS2 option when you want to support text files that contain multi-byte Asian characters.

WAS THIS ARTICLE HELPFUL?

Not Helpful