Reports Pane

NI Requirements Gateway 2018 Help

Edition Date: March 2018

Part Number: 371714F-01

»View Product Info
Download Help (Windows Only)

Select Reports»Edit Reports on the menu bar in the main window to launch the Reports pane of the Configuration dialog box, which you can use to review the built-in report models or create a custom report model.

The Reports pane contains the following options:

  • Reports List—Lists the built-in and custom reports for the project. Select a report in the Reports List to populate the other options on the Reports pane. Rename a category of reports, such as library reports, by specifying a new name in the English name control on the Selection Properties pane. The Reports List specifies the following categories of reports:
    • Library Reports—Default read-only report types for project-related information. Library reports are available for all projects and stored in <Requirements Gateway>\config\doc_models\Library Reports.xml.
    • Requirement Details—Default read-only report types for requirement-related information. Requirement details reports are available for all projects and stored in <Requirements Gateway>\config\doc_models\Requirement Details.xml.
    • Public Reports—Custom reports available for all projects and stored in <Requirements Gateway Public>\Config\doc_models\Public Reports.xml.
    • Project Reports—Custom reports available only for a specific project and stored in the same directory as the project in doc_models\Project Reports.xml.

      Click New Report to add a new report to the Reports List and place the new report in the Project Reports section. If you define that a report is specific to a project, the report is available from the Reports menu only for that project.
  • Toolbar—Contains the following buttons to create, rearrange, and delete reports from the Reports List.
    • New report—Adds a new report to the Reports List. By default, Requirements Gateway adds the new report to the Project Reports section. Click Up to add the new report to the Public Reports section to save the report in <Requirements Gateway Public>\Config\doc_models\Public Reports.xml.
    • Up—Moves the selected report up in the Reports List. If the report is at the top of the Project Reports section in the Reports List, clicking this button moves the selected report into the Public Reports section.
    • Down—Moves the selected report down in the Reports List.
    • Remove an element—Deletes the selected report from the Reports List.
    • Report elements—Toggles the controls below the Reports List to display the properties for the item you select on the Report Configuration pane or the elements available to insert in the report. You can also double-click Report elements to launch a modal Report elements window.
  • Properties—Contains the following panes that display separately when you toggle Report elements.
    • Selection Properties—Options for configuring the item you select in the Reports List or on the Project Configuration pane. The options available depend on the element you select.

      When you select a report in the Reports List, this pane appears by default and contains the following options:
      • English name—The report name.
      • Template—The output format template for the report. If you leave the template format as [Not specified], select the report format when generating the report. If you select a specific template format, generate the report only in that format and cannot change the format when generating the report.

        Requirements Gateway provides report templates for rich text formats (RTF), HTML, or PDF reports. Customize the default templates to use your own styles, or use the default templates to create a separate custom report template that becomes available for saving reports and defining report types.
        Note Note  By default, Requirements Gateway displays RTF reports in Microsoft Word because Microsoft WordPad may not properly display tables in RTF reports. If you do not want to use Word to view RTF files, National Instruments recommends using Microsoft Word Viewer 2003 or later.


      The Selection Properties pane contains other options depending on the element you select in the report body. For some elements, you can specify conditions written in OTScript.
    • Report ElementsStructures, data blocks, and other parameters you can add to the report. When you select an element on the Report Configuration pane, Requirements Gateway highlights on the Report Elements pane the valid elements you can insert into the selected element. Drag a valid element to the Report Configuration pane to add that item to the report.

      The Report Elements pane contains the following tabs:
      • Structures—Elements that define the structure of the report, such as text, paragraph, list, or table.
      • Data—Elements associated with the object you select on the Report Configuration pane, such as the project, a document, or a requirement. When you insert a structure that supports data, Requirements Gateway alphabetically adds a new variable, or iterator, to the Data list. By default, the Data tab contains only a project iterator. Each iterator node contains a tree view of categories for the available data types.

        Requirements Gateway dynamically populates the Data tab as you build the report body. When you add a new non-terminal element, which is an element that contains other elements, to the report body, Requirements Gateway inserts a new corresponding variable in the Data list as a node. Each node contains all the authorized elements for that data type.
      • Parameters—Data type elements you can pass to a structure element.
  • Report Configuration—A graphical model of the active report selected in the Reports List. Drag structures, data blocks, and other parameters from the Report Elements pane and drop them on the Report Configuration pane to build the report model. You cannot modify a built-in report, but you can right-click a built-in report model and select Duplicate from the context menu to create a custom copy of the report that you can modify. You can also click New Report to create a new blank custom report.

    Select an element on the Report Elements pane and drag it to the Report Configuration pane. Requirements Gateway highlights the element on the Report Configuration pane with hatching, and the Report Elements pane bolds the names of other elements you can drag into the element.
    Tip Tip  When you drag an element to an existing element on the Report Configuration pane, Requirements Gateway displays a plus icon to indicate that you can add the element in the current location or a slash icon to indicate that you cannot insert the element in the current location.


    Right-click the Report Configuration pane and select Undo or Redo from the context menu. You can also right-click an element and select Delete from the context menu to remove the element from the report.

See Also

WAS THIS ARTICLE HELPFUL?

Not Helpful