Types Pane

NI Requirements Gateway 2018 Help

Edition Date: March 2018

Part Number: 371714F-01

»View Product Info
Download Help (Windows Only)

Select File»Edit Types or click Edit Types on the toolbar in the main window to launch the Types pane of the Configuration dialog box, which you can use to review built-in types, customize built-in types, or create new types for the project.

The Types pane distinguishes between text-based types and XML-based types because Requirements Gateway converts source documents to ASCII or XML intermediate files. Text-based types use regular expressions to capture traceability information from an ASCII intermediate file. XML-based types specify the XML tags and attributes that contain the traceability information you want to capture from an XML intermediate file.

Select Edit»Undo to undo an action of editing or creating an element. Select Edit»Redo to redo an action of editing or creating an element.

The Types pane can contain the following options, depending on the type or type element you select in the Types List.

  • Types List—Displays the list of available types. This list groups the types in folders that correspond to the read-only directories in the <Requirements Gateway>\config\types directory.

    Place custom types in the public folder in this list to make the types available for all projects. Requirements Gateway stores the type definitions for the public folder in <Requirements Gateway Public>\Config\types\public\public.types.

    The last folder in the list represents the custom types defined for any projects located in the same directory as the current project file. Requirements Gateway stores the types placed in the last folder in a <Project Name>.types file in the current project directory.

    Select a type from this list to populate the other options on the Types pane.
  • Toolbar—Contains the following buttons to copy, delete, and add new elements to the Types List or to the elements of a specific type:
    • Add new type—Adds a new custom type in the project folder or creates a new instance of a selected element of a type. When you add a new type to the Types List, the elements under the type define how Requirements Gateway identifies traceability information in an ASCII or XML intermediate file that represents the data extracted from a project document.
    • Add XML type—Adds a new XML-based custom type in the project folder or creates a new instance of a selected element of an XML-based type.
    • Add a type for added elements—Adds a new type for added elements in the project folder or creates a new instance of a selected element of a type for added elements. Apply a type for added elements only to a modification file.
    • Up—Moves the selected type up in the Types List.
    • Down—Moves the selected type down in the Types List.
    • Duplicate—Creates a copy of the selected item in the Types List. If you duplicate a built-in type, Requirements Gateway pastes the copy in the custom types in the project folder. If you duplicate an element of a custom type, Requirements Gateway pastes the copy under the same custom type. You can also right-click the item and select Duplicate from the context menu to copy the item. When you duplicate a built-in type, Requirements Gateway stores the duplicate type in a <Project Name>.types file in the current project directory.
    • Delete type—Removes the selected type or type element from the Types List and permanently deletes the item from the project. You can also right-click the item and select Delete from the context menu to remove the item. This option is available only when you select a custom type.
  • Selection Properties—Options available for the type or type element you select in the Types List. The Selection Properties pane contains the following options:
    • Name—The name for the type or type element.
    • Icon—The icon associated with the type or type element. Click Icon to launch the Select icon dialog box, in which you can specify an icon for the type. Select icons that Requirements Gateway provides, or add a custom 16 × 16 (pixels) .bmp icon and a corresponding mask icon and save them in the <Requirements Gateway Public>\Config\images directory. Requirements Gateway uses the icon files in this directory and the <Requirements Gateway>\config\images directory to populate the Select icon dialog box.
    • Display—The name of the selected type or element Requirements Gateway displays in the main window.

      Use some regular expression variables in the Display control. For example, if you want all the files of the selected type to display with a label that reads Document, enter Document in the Display control. If you want all the files of the selected type to display Document <ID of the document as defined in the Name control on the Types pane>, enter Document $i in the Display control, where $i is a variable that specifies the element ID.

      When you select a reference element of a type from the Types List, the Display control defines the text that Requirements Gateway copies in addition to the requirement ID when you right-click a requirement in the main window and select Copy For from the context menu.
    • Text display—Additional text for the element Requirements Gateway displays in the following locations when you select the element in the main window.
      This option is available only when you select an element of a type.
    • Identifier format—The ID format for the selected element. The ID can use information that the regular expression you specify in the Regular expression control returns. For example, enter \1 and \2 in this control to refer to the first and second fields of the regular expression. You can also enter \d to prefix the identifier with the document name. This option is available only when you select an element of a type.
    • Comment—A free text field in which you can add comments for the type. This option is available only when you select a type for added elements.
    Depending on the element you select from the Types List, the Selection Properties pane can also display the following tabs:

See Also

WAS THIS ARTICLE HELPFUL?

Not Helpful