Roundtrip Workflows with ReqIF Files

Simulink® Requirements™ supports roundtrip workflows with ReqIF files. ReqIF is an open standard XML format developed for lossless exchange of requirements and their associated metadata​ between requirements management applications. You can import, edit, and export requirements by using ReqIF files.

Import Requirements from ReqIF Files

To import requirements from a ReqIF file,

  1. Open the Document Import dialog box and select ReqIF file (*.reqif or *.reqifz) as the document type in the Document type field.

  2. In the Document location field, select the ReqIF file location.

  3. Simulink Requirements scans the ReqIF file and detects the source tool of the file. You can, however, select a Source tool from the drop-down list. Simulink Requirements readily supports ReqIF files created using Polarion, PREEvision, IBM® Rational® DOORS®, or IBM Rational DOORS Next Generation. If you are importing requirements from an external application that is not listed here, select Generic.

  4. Select the location for the destination requirement set. If you are working with requirements that are maintained outside of Simulink Requirements and want to be able to update the imported requirement set with data from updated versions of the ReqIF file, select Allow updates from external source. If you plan to migrate your data into Simulink Requirements, do not check this option in order to freely edit the imported requirements. Complete the import process by clicking Import.

In ReqIF, a requirement is represented as a SpecObject, which has user-defined attributes. Simulink Requirements enables you to map the attributes of a SpecObject to either built-in or custom attributes of a requirement and to save this mapping as an XML file for future use. The mapping allows you to customize how requirements data imported from an external requirements management application is displayed in the Requirements Spreadsheet and in the Properties pane of the Requirements Editor or Requirements Perspective View.

To modify the attribute mapping after you import, select the top-level Import node of the requirement set (denoted by ) and expand the Attribute Mapping pane. You can also load a previously saved attribute mapping by clicking Load mapping.

Edit Imported Content

Edit imported requirements content by using the editing capabilities of the Requirements Editor. You can unlock and edit a requirement's information such as its Description or Rationale. You can also define custom attributes on the requirement set and set values for those custom attributes on selected requirements.

Unlock and Edit Imported Requirements

Before you edit an imported requirement, you must unlock it. To unlock all requirements in the requirement set, select the top-level Import node of the requirement set and click Unlock all in the Requirement Interchange pane. To unlock individual requirements, navigate to the requirement and click Unlock in the Properties pane.

To add, remove, and edit custom attributes associated with the requirement set, navigate to the top-level node of the requirement set and use the actions available in the Custom Attribute Registries pane. Select an individual requirement and unlock it set custom attribute values.

Update Imported Requirements Content

If you selected Allow updates from external source during the Import operation, you can update your imported requirement sets with data from the source ReqIF file. Navigate to the top-level Import node of the requirement set and click Update. The Update operation overwrites all local modifications such as edits to unlocked requirements with values from the ReqIF source file. The Update operation preserves comments and local attributes.

Export Requirements Content

You can export a requirement set or an individual requirement and its child requirements to ReqIF files from Simulink Requirements. Navigate to the node that you want to export and select File > Export to ReqIF.

In the Export to ReqIF dialog box, you can select the export mapping and the output ReqIF file name and path. If you are exporting requirement artifacts that you previously imported (roundtrip workflow), it is recommended to use the same import settings for the Export operation.

The Export operation inverts the attribute mapping used by the Import operation. Any local custom attributes that you added to or defined in the Custom Attribute Registry are also included in the export mapping so that they are visible in external requirements management applications.

See Also

Related Topics