Export Requirements to ReqIF

Documentation / Export

Requirements Interchange Format (ReqIF) is an open industry standard for exchanging requirements between organizations using different requirements management (RM) tools.

The main advantage of ReqIF compared to CSV format is that it supports synchronization of complete requirements specifications including requirements hierarchy, attributes, attachments and traceability without any information loss.

You can use ReqIF to collaborate with your customers that use another RM tool during requirements clarification process. Or collaborate with team members using a Model-based Systems Engineering (MBSE) tool while maintaining traceability between requirements and design elements. For more information about ReqIF use cases see How to Exchange Requirements Between Tools via ReqIF blog post.

Export ReqIF Files

To export a ReqIF file, click File, mouseover Export, and click ReqIF Package. In the Export ReqIF dialog, choose documents to export and other options. After confirmation of the dialog, select a destination for storing the exported ReqIF file (.reqifz).

The exported ReqIF package (ReqIF version 1.2) will store the following information from the current ReqView project:

  • Documents: ReqView documents are exported as ReqIF specifications.

    • ReqView document ID is stored in the ReqIF.ForeignID string attribute.
    • ReqView document name is stored in the ReqIF.Description string attribute.
    • Tree hierarchy of ReqView document sections is preserved.
  • Document Objects: ReqView document objects are exported as ReqIF specification objects with the type matching the original document.

    • ReqView object IDs are stored in the ReqIF.ForeignID string attribute.
    • ReqView system attributes heading and text are stored in ReqIF.ChapterName string attribute and ReqIF.Text XHTML attribute (or the original ReqIF attributes if the objects were imported).
    • ReqView custom attributes are defined in the ReqIF specification object type. All custom attribute values are exported.
    • Rich text format of xhtml custom attributes is preserved.
    • ReqView document objects marked as deleted are not exported.
  • Attachments: ReqView attachments are stored as separate files in the compressed .reqifz package. They are referenced from <object> tags stored in ReqIF.Text XHTML attributes.

  • Traceability Links: ReqView traceability links are exported as ReqIF specification relations between the corresponding specification objects.

Export Options

Documents:

  • Current document — export the current document only
  • Open documents — export all open documents from the main project
  • All documents from the main project — export all documents from the main project

Options:

  • Disambiguate conflicting attribute names — some tools resolve conflicting attribute names (e.g., "Status") when importing a ReqIF file. For instance, IBM DOORS Next Generation (DNG) adds " [DNG-Renamed-x]" suffix to conflicting attribute names for different ReqIF specification object types. Set this option to disambiguate attribute names by adding document IDs for better readability, e.g., "Status (NEEDS)" and "Status (SRS)".

View Exported ReqIF Files

You can view exported ReqIF files in another ReqView project window to verify its content. Click Project, select Create Project. In the Create Project dialog choose From ReqIF, and enter an ID of the new project, and press OK. For more information how to import ReqIF files to ReqView see Import Requirements From ReqIF.

You can also view exported files in a free ReqIF viewer, such as ProR or ReqIF Studio.

ProR is an open-source tool that natively supports the ReqIF standard and supports very basic functionality for viewing and editing textual requirements. It is available for free as part of the Eclipse Requirements Modelling Framework (RMF). The last RMF version 0.11 was released in 2014, and the project is not further maintained.

ReqIF Studio is a free tool based on the Eclipse RMF with a few extensions. The last ReqIF Studio version 2.4.1 was released in 2018. You can download it from ReqIF.academy after a registration.

How to view a ReqIF file exported from ReqView in the ReqIF Studio:

  1. Click File > Import menu and select ReqIFz Import Wizard in the ReqIF Studio.
  2. In the ReqIFz Import dialog, select a .reqifz file exported from ReqView and an existing target project. Alternatively, enter a name to create a new project. Click Finish to import the selected ReqIF file.
  3. Expand the target project in the Project Explorer pane and double click on the .reqif package to open it.
  4. In the Specifications section, double click on an imported ReqIF specification to see its content in a separate tab.

Example: Display the SRS (Software Requirements Specification) document imported from the ReqView Demo project in ReqIF Studio.

Open Software Requirements Specification (SRS) exported from ReqView in ReqIF Studio

Export ReqIF to MBSE Tools

You can export requirements from ReqView to a Model-Based System Engineering (MBSE) tool to maintain traceability between requirements and design elements.

Capella is an open-source MBSE tool originally developed by Thales. It is available as part of the Eclipse PolarSys project now. It supports the popular Arcadia system and software architecture engineering method.

How to import a ReqIF file into Capella:

  1. Install the Requirements Viewpoint addon to Capella.
  2. Add the Requirements Viewpoint in your existing project:
    • Click Window, mouseover Show View, and select Kitalpha > Viewpoint Manager to display Viewpoint Manager pane.
    • Select a model element in the Project Explorer pane, right-click Capella Requirements, and select Reference from the context menu.
  3. Disable import of ReqIF.ForeignID attribute (Capella can only handle integer IDs):
    • Click Window, click Preferences and select Capella > Requirements > Importer in the tree.
    • Deselect ReqIF attributes > ReqIF.ForeignID in the Select attributes to import pane.
  4. Right-click a selected architecture element in the Project Explorer pane, click Requirements Viewpoint in the context menu, click Import from ReqIF.
  5. Unzip a .reqifz package exported from ReqView, and in the Open dialog select the unzipped .reqif file.
  6. In the Image importing options dialog check Choose an absolute path to image folder, click Browse to choose the folder containing the unzipped image attachments. Finally, click OK.
  7. Review and apply changes in the Model Update dialog. In the Synthesis pane, right-click selected imported elements, select Apply change(s) and confirm Merge Options. Finally, click OK.
  8. Click on an imported requirement in the Project Explorer and display its text description in the Properties pane.

Example: Display the SRS (Software Requirements Specification) document imported from the ReqView Demo project in Capella.

Open Software Requirements Specification (SRS) exported from ReqView in Capella

ReqIF SRC Round-trip

You can collaborate with your customers on Stakeholder Request Clarification (SRC) by exchanging ReqIF files, see Workflow for ReqIF Round-trip Between IBM DOORS and ReqView.

IBM DOORS is a legacy requirements management tool, which has been used widely for the development of complex HW/SW products in the aerospace & defense, automotive, and railway industries. IBM DOORS Next Generation (DNG) is its successor based on modern IBM Engineering Lifecycle Management (ELM) platform.

How to import a ReqIF file from ReqView to IBM DOORS Next Generation (DNG) RM tool.

  1. Open a target component in DNG.
  2. Click Artifacts, expand Create dropdown and select Import Artifact to open the Import wizard dialog.
  3. In the first step Import, select Import requirements from a ReqIF file option and click Next.
  4. In the second step Select Package File, click Browse and select a .reqifz file exported from ReqView, click Upload, and finally click Next.
  5. In the third step Specify Import Options, optionally select Import Tagging Options and click Next.
  6. In the fourth step Specify Attributes Options, optionally select imported attributes and click Finish.
  7. In the last step Importing Requirements, click Close.
  8. Click Modules tab and click on an imported module to see its content.

The original RM tool used by your customer can match updated requirements during ReqIF round-trip because ReqView stores ReqIF metadata (such as ReqIF IDs) in project files when you import a ReqIF package and reuses the saved ReqIF metadata when exporting a document back to the customer. For more information how to import ReqIF files to ReqView see Import Requirements From ReqIF.

Example: Export updated AMR Stakeholder Requirements Specification from ReqView to DNG to get supplier feedback via ReqIF round-trip.

Export ReqIF from ReqView:

ReqIF SRC Workflow - Supplier exports reviewed stakeholder requirements specification from ReqView

Import ReqIF to DNG:

ReqIF SRC Workflow - Customer imports reviewed stakeholder requirements specification in IBM DOORS Next Generation (DNG)
Updated for version 2.16.0