Importing Requirements from a ReqIF File

Requirements Interchange Format files are XML files used to exchange requirements between different requirement management tools. Requirements Management and Systems Modeling supports importing a .reqif file or a .reqifz ZIP archive containing a .reqif file and associated images. You can create a new requirements model from a ReqIF file or update an existing requirements model.

Context

You can import requirements and associated data from a ReqIF file to either merge into an existing model, or to create a new model in the repository.

We support the following ReqIF file versions:

  • 1.01

  • 1.1

  • 1.2

Procedure

  1. Open the repository explorer from the Quick Links card in your homepage, navigate to the folder you are importing into, and select Start of the navigation pathMenu Next navigation step Import ReqIF FileEnd of the navigation path.

    The Select ReqIF File window pops up.

  2. In the Select ReqIF File tab, click Browse, navigate to the file you want to import, and click Open to select it for import.
    You can import:
    • A .reqif or .xml file containing ReqIF information.

    • A .reqifz or .zip archive file containing a ReqIF file and supporting files, such as images.

    When the file loading is complete, you will see the name of the default Mapping Template used to configure the mappings between ReqIF properties and Requirements Management and Systems Modeling properties.
  3. [optional] Select a mapping template from the Mapping Template dropdown list.

    By default, the Automatic_Match template matches properties by property name. Your administrators may have prepared and shared other templates to support ReqIF standards.

  4. [optional] Click Customize button to review and customize the mappings.

    The Customize Mapping Template window is displayed with the following options:

    Mapping Template
    You can choose another mapping template in the dropdown list. By default, the mapping template is the one that you choose in the Select ReqIF File window.
    Use the following tools to review, edit, and create templates:
    • Manage - To review the list of available templates. You can rename or delete your templates.

    • Save - [if available] To save changes made to the mappings contained in the selected template.

    • Save as - To create a new template from the current mappings. Administrators can select to share the template with other users.

    ReqIF Objects
    You can choose a ReqIF object.
    • The ReqIF specification, which contains a hierarchical list of requirements objects in a ReqIF file, is mapped to the Requirements Management and Systems Modeling requirements model. Choose the Requirements Model tab to view the mapped attributes and a data preview from the uploaded ReqIF file.

    • The ReqIF specification object (SpecObject), which represents a requirements object in a ReqIF file, is mapped to the Requirements Management and Systems Modeling requirement object. Choose the Requirements tab to view the mapped attributes and a data preview from the uploaded ReqIF file.

    Attributes

    It displays the mapping between attributes from ReqIF file and the attributes defined in Requirements Management and Systems Modeling.

    Extension

    You can select one or more requirements extensions in the dropdown list for attributes mapping. After one extension is selected, it is added to the dropdown list of Requirements Management and Systems Modeling attributes after loading. The extension name is the prefix of the extended attribute. You can save the extensions selection and extended attributes mapping as a customized template for future usage.

    After import, you can open the imported requirement model and click Show Model Object Lists button. The selected extension is added to this model automatically.

    Data Preview
    It displays the preview of the ReqIF file content.
  5. Click Import.
    A confirmation dialogue opens.
  6. Choose Confirm to confirm the requirements models you are importing, and how they will be imported into the repository folder. You can change the action type if necessary.
    • If a requirements model detected in the ReqIF file has the same name as a model in this repository folder, its action is set to Merge and its requirements will be merged into the model. You can choose to merge the file into another model in the folder by selecting it in the Import to Model column.

      When merging requirements into an existing model:
      • If the fully-qualified ID,Name, or Code of an imported requirement can be matched to an existing requirement, it updates the existing requirement's properties as appropriate.

        For example, to update the properties of requirement Identified Users in this example, an imported requirement must:
        • Be a direct child of the requirement Use Cases, and

        • Have the Name Identified Users (or, if the name has been updated, have the Code REQ_0002).

      • If the fully-qualified ID, Name, or Code of an imported requirement is not present in the existing list, it is appended as a child of its parent requirement.

        For example, to create a new requirement as a sibling to the requirement Identified Users, an imported requirement must:
        • Be a direct child of requirement Use Cases, but

        • Have a new Name Identified Use Cases and new Code REQ_0003.

    • If no requirements model in this repository folder has the same name, the action is set to New and a new requirements model will be created. Rename the model to be created in the Import to Model column as appropriate.

    After the import, the newly created models are submitted for publication, and the merged models will have a new draft version.

    An import log providing a summary of the actions performed in the import is automatically downloaded to your browser.