PDF Type

NI Requirements Gateway 2018 Help

Edition Date: March 2018

Part Number: 371714F-01

»View Product Info
Download Help (Windows Only)

The PDF type browses a specified Adobe PDF file for text that uses the correct syntax for sections, macro-requirements, requirements, references, attributes, and text.

Note Note  You must install Java Runtime Environment version 1.5 or later, which you can download from the Java website at www.java.com, to use the PDF type. Requirements Gateway recommends you installing the version 1.6 or later.

If Requirements Gateway prompts you to install Java Runtime Environment even after you have installed it, verify that the PATH environment variable in Windows includes path to java.exe.

Traceability Elements

The PDF type captures the following traceability information from a PDF source file (.pdf):

  • 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 that indicates the requirement ID, and label is the name of the requirement in natural language. A colon (:) must separate the requirement ID and label. Otherwise, the PDF type captures the entire string as the requirement ID. The label is optional.
  • Reference[Covers: reqid]. 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 the following attribute elements:
    • PriorityPriority: text, where text must be Low, Med, or High. The attribute must appear after the corresponding requirement.
    • AllocationAllocated to: text, where text is the attribute value.
  • 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 PDF Document

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

  • File or Directory—The PDF file.
    Note Note  Requirements Gateway cannot analyze encrypted or protected PDF files.
  • Variable—Defines the following document variables:
    • Options—Select this variable and click the button in the Value column to launch the PDF Conversion Options dialog box. In this dialog box, you can specify options for analyzing the PDF file.
    • Category—Assigns an analysis category to the PDF 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 PDF Reference from Requirements Gateway

To add a reference in a PDF file, insert the correct syntax for a PDF reference into the PDF file. In Requirements Gateway, right-click an upstream requirement covered by a downstream PDF document and select Copy For»Covers Reference from the context menu to copy [Covers: reqid] to the clipboard. You can then paste the reference in the source file for the PDF document and update the PDF document, or then paste the reference in a note in the PDF document and configure the PDF type to capture traceability information from notes.


Not Helpful