Word Type

NI Requirements Gateway 2018 Help

Edition Date: March 2018

Part Number: 371714F-01

»View Product Info
Download Help (Windows Only)

The Word type browses a specified Microsoft Word file (.docx or .doc) for paragraph styles applied to text that uses the correct syntax for macro-requirements, requirements, or references. Use the Multi Word type to analyze more than one Word file in a single Requirements Gateway document.

Traceability Elements

The Word type captures the following traceability information from a Word source file.

Note Note  To capture the traceability information from headers or footers of a Word source file, customize the built-in Word type by specifying requirement elements for headers or footers.
Requirements Gateway does not capture information from footnotes of a Word source file.
  • Section—Text that uses any Heading paragraph style and numbering to indicate sections of a document.
  • Macro-requirement—Text that begins with [MacroReq_reqid] and ends with [End_of_MacroReq].
  • Requirement—Any text that uses a Requirement_ID paragraph style. A colon character delimits the ID and label for a requirement.

    You must manually create the Requirement_ID paragraph style. (Word 2007) In the Word file, select the text you want to use as a requirement, right-click the selected text, and select Styles»Save Selection as a New Quick Style to launch the Create New Style from Formatting dialog box, in which you can specify the name for the new style as Requirement_ID. You must save the style if you want the new style to remain available after you restart Word. For versions of Word other than 2007, refer to the documentation for the version of Microsoft Word you use for more information about creating paragraph styles.
  • Reference[Covers: reqid1, reqid2]. A reference statement can list multiple requirements separated by commas (,) or semicolons (;). For example, the reference [Covers: REQ1, REQ2, REQ3] covers three requirements.
  • Attribute—Defines one of the following attribute elements:
    • PriorityPriority: value, where value must be Low, Med, or High. The attribute must appear after the corresponding requirement.
    • Allocation—Specified by Allocated to: text, where text is the allocation ID. The attribute must appear after the corresponding requirement.
  • Text—Text that uses a Requirement_Text paragraph style and that appears after the corresponding section or requirement element. You must manually create the Requirement_Text paragraph style.
  • Picture—A picture inserted into the document from the clipboard or from a file. You cannot specify a picture element that is linked in a Word document.

Configuring a Word Document

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

  • File or Directory—The Word file.
  • Variable—Defines the following document variables:
    • Options—Select this variable and click the button in the Value column so that you can click to open the Word Conversion Options dialog box. In this dialog box, you can specify options for analyzing the Word file.
    • Category—Assigns an analysis category to the Word 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.
    • With Rich Text—Adds information to the intermediate file about the rich text formats of the captured text. You can include this information in a report.

Creating a Word Reference from Requirements Gateway

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

Special Considerations when Creating a Custom Word Type

When you create a custom Word type, you must select a conversion tool from the Convert tool pull-down menu on the Analysis tab of the Types pane of the Configuration dialog box. The intermediate file that a custom Word type generates must conform to the format the conversion tool expects.

You can select from the following conversion tools:

  • Word—Captures only numbering and text as part of the intermediate file.
  • WordWithStyles—Captures style information, numbering, and text as part of the intermediate file. The default Word type uses this conversion tool.
  • WordX—Captures style information, numbering, and text from Word 2007 or later (.docx) files.
    Note Note  The WordX conversion tool is obsolete in Requirements Gateway 2012 or later. If in a previous version of Requirements Gateway you created a custom type that used the WordX conversion tool, National Instruments recommends that you update the type to use the WordWithStyles conversion tool instead.

See Also


Not Helpful