Project Pane

NI Requirements Gateway 2018 Help

Edition Date: March 2018

Part Number: 371714F-01

»View Product Info
Download Help (Windows Only)

Select File»Edit Project or click Edit Project on the toolbar in the main window to launch the Project pane of the Configuration dialog box, which you can use to configure a project by specifying the documents to include, the type of each document, and the covering relationship between documents.

The Project pane contains the following options:

  • Project Files—Tree view of all the documents and folders the root project directory contains. Each document in the project tree displays the document name and an icon to indicate the document type. New documents and folders appear in the Project Files list when you add them.
  • Project Configuration—Graphical overview of the documents and folders in the project. Place and arrange documents and folders, and add covering links between the project documents to specify a covering relationship between the documents. Drag documents in and out of folders to organize documents hierarchically.

    To zoom in and out on the Project Configuration pane, press <Ctrl> and scroll the mouse wheel up or down to zoom in or out, respectively.

    You can also use the commands in the Project Configuration pane context menu to arrange the elements on the Project Configuration pane.

    To drag a project directory from outside Requirements Gateway and drop it on to the Project Configuration pane, you must first specify a multiple-document type for the directory from the Default type for directory drag and drop pull-down menu on the Options pane.

    Refer to Chapter 2, Managing Requirements, of the Getting Started with NI Requirements Gateway manual for more information about configuring specific elements on the Project Configuration pane.
  • Project Options—Contains the following options for adding folders, documents, modification files, and covering links to a project, and an option for removing selected items from the project.
    • Add a folder—Adds a new folder to the project. The cursor automatically moves to the Project Configuration pane and outlines a folder object. Click on the Project Configuration pane to place the folder. Use the options on the Document Options pane to configure the folder.
    • Add a document—Adds a new document to the project. The cursor automatically moves to the Project Configuration pane and outlines a document object. Click on the Project Configuration pane to place the document. Use the options on the Document Options pane to configure the document.
    • Add a modification document—Adds a modification file to the selected project document. A modification file specifies additional information that modifies, updates, or enhances the information in the original document. This option is available only when you select an original document. A yellow modified icon appears on a document on the Project Configuration pane and in the Project Files list on the Project pane to indicate that the original document now includes a modification.

      Use the options on the Modification Files tab to configure options for the modification file.
    • Add a cover—Inserts a covering link to specify a covering relationship between documents or folders. Click this button, select the covering document or folder on the Project Configuration pane, and then select the covered document or folder. An arrow appears between the two documents or folders. The direction of the arrow specifies the covering relationship.

      You can create covering links between documents at the root level and between documents and folders at any level, you cannot create covering links between documents in the same folder. You can link documents in a folder with documents outside the folder.

      When you select a covering link on the Configuration pane, use the options on the Covers tab of the Document Options pane to configure options for the link.

      Right-click a link and select Cleanup Link from the context menu to remove any unnecessary bends in the link display.
    • Delete an element—Removes the selected element from the Project Configuration pane and Project Files list.
  • Document Options—Contains the following tabs for configuring a selected project document.
    • Details—Contains the following options for configuring the original document or folder.
      • Name—The logical name of the selected document or folder, which appears on the Project Configuration pane, in the Project Files list, and in the main window.
      • Type of Analysis—The generic or custom type applied to a project document. Use the Types pane to review built-in types or create custom types.
      • File or Directory—The source file for a project document or a directory that contains multiple source files, if the type applied to the document supports multiple files. Click the File Browse button in the File or Directory control to navigate to the source file or directory.
      • Ignore Structure Elements—When you enable this option, Requirements Gateway does not report a rule violation for a structure error in a documents. For example, if you do not enable this option and Requirements Gateway detects a Heading 3 section that immediately follows a Heading 1 section with no intermediate Heading 2 section, Requirements Gateway returns a Bad Section Level rule violation. If you enable this option, Requirements Gateway does not return the rule violation.
      • Intermediate file—Typically, Requirements Gateway destroys the intermediate file it converts from a project document source file when analysis completes. Enable this option to retain the intermediate file in an intermediate subdirectory of the current project directory. You may want to retain the intermediate file for reference when you want to create a custom type.
        Note Note  If you enable this option and then modify the original project document source file in its native editing environment, Requirements Gateway does not update the retained intermediate file and does not notify you that the information in the project document source file and intermediate file is out of sync. Select File»Reload All in the main window to force Requirements Gateway to refresh the generated intermediate file.
      • Block reloading—When you enable this option, Requirements Gateway does not reload the selected document when you select File»Reload or File»Reload All in the main window. For example, if you previously analyzed the document and want to continue to use the existing intermediate file, enable this option so that Requirements Gateway does not replace the existing intermediate file with an updated version when reloading the project.
      • Variable—Defines additional parameters for the document. The variables available depend on the type applied to the document. Use the option in the Value column to enable a variable or specify a value for the variable.
      • Value—Enable the option in this column to enable a selected variable or to specify a value for a selected variable.
      • Access—Specifies how Requirements Gateway accesses the source file for the project document. Leave this control blank when the source file is a file on the local computer.

        This column contains the following option when the type in the Type of Analysis column specifies individual file-based documents.
        • HTTP—Instructs Requirements Gateway to retrieve the source file from a website or FTP location using an HTTP connection. When you select this option, the Profile option is available in the Variable pull-down menu. In the Value column, enter the profile you want to use for connecting to an HTTP file.
    • Modification Files—Specifies options for a modification file you apply to a project document. The Modification Files tab contains the same options as the Details tab, except the Modification Files tab includes the following option instead of the Ignore Structure Elements option.
      • Accumulate Information—When you enable this option, the information in the modification file complements the information in the original document. When you disable this option, the information in the modification file replaces the information in the original document. This option is enabled by default.
    • Covers—Contains the following options for a covering link you select on the Project Configuration pane.
      • Source–>Target—Specifies the kind of covering link and the linked project documents.
      • Kind—Specifies one of the following types for the link.
        • Cover—The link contributes to the calculated coverage percentage of a project.
        • Dependency—The link relates the documents but does not contribute to the calculated coverage percentage. For example, you may want to include a project document that relates to another project document but that does not cover any requirements.
        • Mirror—The downstream document of this link must contain the same requirements in the upstream document of this link. Otherwise, Requirements Gateway displays missing requirements in red. Use this link when you need to clone an upstream requirement document for multiple downstream requirements.
      • Category—Specifies one of the following analysis categories for the link.
        • Satisfy
        • Validate
        • Implements
    • Minimize/restore—Minimizes the Document Options pane and maximizes the Project Files and Project Configuration panes. Click this button again to restore the tabs and the default view.

See Also

WAS THIS ARTICLE HELPFUL?

Not Helpful