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, rich text formatting 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.
Summary of ReqIF features:
Note: The features above depends on the tool, in which ReqIF files are open or imported. ReqView supports all these features.
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.
Document Objects: ReqView document objects are exported as ReqIF spec objects with the type matching the original document.
ReqIF.ChapterNamestring attribute and
ReqIF.TextXHTML attribute (or the original ReqIF attributes if the objects were imported).
xhtmlcustom attributes is preserved.
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 spec objects.
ReqIF.ForeignIDin objects – some tools can only handle numeric
ReqIF.ForeignIDspec object attribute values (e.g. Capella). Without this option set, ReqView assigns ForeignIDs like “SRS-123”. Set this option to output compatible ForeignIDs like “123”, see how to configure Capella to display the document ID in requirements’ labels below.
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.
How to view a ReqIF file exported from ReqView in the ReqIF Studio:
Example: Display the SRS (Software Requirements Specification) document imported from the ReqView Demo project in ReqIF Studio.
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:
ReqIF.ForeignIDin objects export option is enabled.
aql:self.eContainer(Requirements::Module).ReqIFLongName + '-' + self.ReqIFForeignID
Example: Display the SRS (Software Requirements Specification) document imported from the ReqView Demo project in Capella.
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.
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:
Import ReqIF to DNG: