Main Content

Round-Trip Importing and Exporting for ReqIF Files

Many third-party requirements management applications can export and import requirements using the ReqIF™ format. If you manage your requirements in a third-party tool, you can import the requirements to Simulink® Requirements™, edit the requirements, and export the requirements back to your third-party tool with ReqIF files. This procedure is referred to as a ReqIF round trip.

ReqIF represents requirements as SpecObjects and links as SpecRelations between SpecObjects. Each SpecObjectType specifies the associated SpecObject and the SpecRelationTypes classify each SpecRelation. The SpecObjectType and SpecRelationType define attributes to store requirements and link information. The SpecObjects and SpecRelations contain values for these attributes.

For more information about ReqIF data organization, see Exchange Document Content in Requirements Interchange Format (ReqIF) Version 1.2 .

Considerations for Importing Requirements

You can import requirements from ReqIF files in the Requirements Editor. For more information, see Import Requirements from ReqIF Files.

Import Mapping Considerations

When you import requirements from ReqIF files, you can choose which import mapping to use. For more information, see Choosing an Import Mapping.

If you use a generic mapping during import, you must use a generic mapping during export. The export mapping affects the content exported to the ReqIF file. For more information, see Considerations for Exporting Requirements.

Considerations for ReqIF Files with Multiple Specifications

When you import requirements from ReqIF files with multiple specifications, you can:

  • Select a single ReqIF source specification to import into a requirement set

  • Combine ReqIF source specifications into one requirement set

  • Import each ReqIF source specification into a separate requirement set

For more information, see Importing Requirements from a ReqIF File with Multiple Specifications.

When you export requirements to a ReqIF file, you can only export one requirement set at a time. Consequently, if you plan to perform a ReqIF round trip with a ReqIF file with multiple source specifications, consider which of the three import methods in Importing Requirements from a ReqIF File with Multiple Specifications allows you to export your requirements with your preferred number of ReqIF files.

Edit Imported Content

Edit imported requirements content by using the Requirements Editor. Depending on the import mode that you use, the requirements import as referenced requirements or requirements, which are slreq.Reference or slreq.Requirement objects, respectively. For more information, see Select an Import Mode.

Edit the Attribute Mapping

When you import requirements from a ReqIF file, the import process maps SpecObjectType attributes built-in requirement properties or requirement custom attributes. For more information about SpecObjectType attributes, see Choosing an Import Mapping.

After you import the requirements, you can map the SpecObjectTypes to requirement types. You can also edit the additional SpecObject attribute mappings to requirement properties and custom attributes. See Mapping ReqIF Attributes in Simulink Requirements.

Edit Imported Requirements

You can edit a requirement or referenced requirement and change the requirement properties such as the Summary or Description. You can also define custom attributes for the requirement set and set values for those custom attributes. For more information, see Customize Requirements with Custom Attributes.

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

To unlock individual requirements, navigate to the requirement and, in the Details pane, under Properties, click Unlock.

To add, remove, and edit custom attributes associated with the requirement set, select the requirement set and use the interface in the Details pane under Custom Attribute Registries. For more information about managing custom attributes for requirements, see Customize Requirements with Custom Attributes. Select an individual referenced requirement and unlock it to set custom attribute values.

Update Imported Requirements Content

If you select Allow updates from external source during the import operation, you can update your imported requirement sets with data from the updated ReqIF file. Select the Import node of the requirement set and, in the Details pane, under Requirement Interchange, click Update. The update operation overwrites all local modifications, such as edits to unlocked referenced requirements. The update operation preserves comments and local attributes. For more information, see Manage Imported Requirements with External Applications.

Considerations for Exporting Requirements

You can export a requirement set, an Import node, or a parent requirement and its children to a ReqIF file. When you export requirements, you can also export links associated with the requirements. For more information, see Export Requirements to ReqIF Files.

When you export requirements and links, you can choose which export mapping to use. You can either reuse the same mapping that you used during import, or use a generic mapping. For more information, see Choosing an Export Mapping.

The export mapping that you use affects the content that is exported to the ReqIF file:

  • SpecObjectType values

  • SpecObject attributes

  • SpecRelationType values

For more information about how the export mapping affects the exported content, see Choosing an Export Mapping.

See Also

Related Topics