Import, Update, and Export Requirements

Integrate Requirements Toolbox™ with third-party requirements management tools

Integrate Requirements Toolbox with third-party requirements management tools to import requirements from external sources, update imported requirements when you make changes in the third-party tool, and export requirements to third-party tools. You can import the requirements and manage them with Requirements Toolbox or import the requirements as referenced requirements and manage the requirements in the third-party tool.

You can import requirements from external applications such as Microsoft^® Word, Microsoft Excel^®, IBM^® DOORS^®, and IBM DOORS Next, and other applications that can export requirements using the ReqIF™ format. You can also export requirements from Requirements Toolbox to a ReqIF file.

Apps

Requirements Editor

Create and edit requirements

Tools

Profile Editor

Create and manage profiles with stereotypes and properties

Classes

expand all

Requirement Classes

`slreq.ReqSet`	Work with requirement sets
`slreq.Reference`	Work with external requirement proxy objects

Callback Classes

`slreq.callback.CustomImportOptions`	Custom import options (Since R2022a)
`slreq.callback.DOORSImportOptions`	IBM DOORS import options (Since R2022a)
`slreq.callback.MSExcelImportOptions`	Microsoft Excel import options (Since R2022a)
`slreq.callback.MSWordImportOptions`	Microsoft Word import options (Since R2022a)
`slreq.callback.ReqIFImportOptions`	ReqIF import options (Since R2022a)

Objects

`ExportOptions`	Options for exporting requirements to ReqIF files (Since R2023a)
`slreq.View`	View settings (Since R2022b)

Functions

expand all

Import, Update, and Export Requirements

`slreq.import`	Import requirements from external documents
`slreq.export`	Export requirements as ReqIF files (Since R2023a)
`slreq.getCurrentImportOptions`	Get import options in `PreImportFcn` callback (Since R2022a)
`slreq.updateReqIfMappings`	Refresh registered custom ReqIF import mappings (Since R2023b)
`importFromDocument`	Import editable requirements from external documents
`updateFromDocument`	Update referenced requirements from external requirements document
`updateReferences`	Update referenced requirements in requirement set

Manage View Settings

`slreq.importViewSettings`	Import view settings
`slreq.exportViewSettings`	Export view settings
`slreq.resetViewSettings`	Reset saved view settings

Manage Requirements and Referenced Requirements

`slreq.find`	Find requirement, reference, and link set artifacts
`slreq.convertAnnotation`	Convert annotations to requirement objects
`slreq.getCurrentObject`	Get selected objects in Requirements Editor, Requirements Browser, or Requirements Table block (Since R2021a)
`slreq.getNavigationFcn`	Get registered navigation function for referenced requirements
`slreq.registerNavigationFcn`	Register navigation function for referenced requirements

Load, Open, and Clear Requirements

`slreq.open`	Open requirement set
`slreq.load`	Load requirement set or link set
`slreq.clear`	Clear requirements and links from memory
`slreq.openRequirementsManager`	Open Requirements Manager app in model (Since R2021a)
`slreq.closeRequirementsManager`	Close Requirements Manager app in model (Since R2021a)

Topics

Import Requirements from Third-Party Applications

Import requirements from external documents and requirements management tools.
Configure Views in the Requirements Editor
Configure the Requirements Editor columns and view a subset of requirements and links by creating a filter based on requirement and link metadata.
Use Stereotypes when Importing from ReqIF Files
Map requirement and link types from ReqIF files to stereotypes in Requirements Toolbox when you import requirements.
Round-Trip Importing and Exporting for ReqIF Files
Import, edit, and export requirements by using ReqIF files.
Best Practices and Guidelines for ReqIF Round-Trip Workflows
Learn the best practices for using ReqIF round-trip workflows.
Export Requirements to ReqIF Files
Export requirements from Requirements Toolbox to ReqIF files.
Create and Edit Attribute Mappings
Create and customize attribute mappings for importing and exporting ReqIF files.
Update Imported Requirements
Update referenced requirements with updates from external documents or third-party requirements management tools.
Customize Requirement Index Numbering
Customize or disable the index of an individual requirement.
Use Callbacks to Customize Requirement Import Behavior
Use callbacks to execute code when you import and update requirements.

Featured Examples

Import and Edit Requirements from a Microsoft Word Document

Import and update requirements from a Microsoft® Word requirements document. After you import the requirements, you can modify the requirements in either the Requirements Editor or the Word document. This functionality is available only on Microsoft Windows® platforms. Simulink® Online™ does not support importing requirements from Microsoft Word documents.

Open Live Script

Import Requirements from IBM DOORS by Using the API

Import requirements authored in IBM DOORS by using the Requirements Toolbox API.

Open Live Script

Import Requirements from a Microsoft Excel Document

Use a callback to map requirement types and hierarchy from Microsoft Excel to imported requirements.

Open Live Script

Export Requirement and Link Information to Excel

Use Requirements Toolbox™ to export requirement and link information programmatically. The example constructs a custom function that you can use on a requirement set and saves the information as an Excel® spreadsheet.

Open Script