Import and Integrate Requirements

Import requirements from third-party requirements management tools and integrate with OSLC servers

Integrate Requirements Toolbox™ with third-party requirements management tools by importing requirements or by using a command-line OSLC client.

You can import requirements from external applications such as Microsoft^® Word, Microsoft Excel^®, IBM^® DOORS^®, and IBM DOORS Next. You can also import requirements from ReqIF™ files. Migrate requirements to Requirements Toolbox or continue to manage the requirements in the third-party tool and update the imported requirements when you make changes in the third-party tool.

Apps

Requirements Editor	Create and edit requirements
Profile Editor	Create and manage profiles with stereotypes and properties

Functions

expand all

Import and Update Requirements

`slreq.import`	Import requirements from external documents
`slreq.getCurrentImportOptions`	Get import options in `PreImportFcn` callback (Since R2022a)
`slreq.updateReqIfMappings`	Refresh registered custom ReqIF import mappings (Since R2023b)

Configure Navigation for Imported Requirements

`slreq.registerNavigationFcn`	Register navigation function for referenced requirements
`slreq.getNavigationFcn`	Get registered navigation function for referenced requirements

Get Requirements

`slreq.find`	Find requirement, reference, and link set artifacts
`slreq.getCurrentObject`	Get selected objects in Requirements Editor, Requirements Browser, or Requirements Table block (Since R2021a)

Load and Clear Requirements

`slreq.load`	Load requirement set, link set, or Requirements Table block
`slreq.open`	Open requirement set
`slreq.clear`	Clear requirements and links from memory

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)

Methods

expand all

Requirement Set Methods

`importFromDocument`	Import editable requirements from external documents
`updateReferences`	Update referenced requirements in requirement set
`updateSrcArtifactUri`	Update document resource identifier of imported requirements
`updateSrcFileLocation`	Update document location of imported requirements

Referenced Requirement Methods

Get Requirements, Requirement Sets, and External Requirements

`find`	Find children of parent referenced requirements
`children`	Find children references
`parent`	Find parent item of referenced requirement
`reqSet`	Return parent requirement set
`getExternalTypeName`	Get requirement type name from external artifact
`navigateToExternalArtifact`	Navigate from imported referenced requirement to original requirement

Add Comments and Customize Imported Requirements

`addComment`	Add comments to referenced requirements
`getAttribute`	Get referenced requirement custom attributes
`setAttribute`	Set referenced requirement custom attributes

Edit and Update Requirements

`hasNewUpdate`	Check if import node has available update
`updateFromDocument`	Update referenced requirements from external requirements document
`unlock`	Unlock referenced requirements
`unlockAll`	Unlock all child referenced requirements for editing

Customize Import Behavior

`getPostImportFcn`	Get contents of `PostImportFcn` callback
`getPreImportFcn`	Get registered `PreImportFcn` callback script
`setPostImportFcn`	Assign `PostImportFcn` callback script
`setPreImportFcn`	Assign `PreImportFcn` callback script
`setParent`	Set parent of referenced requirement in `PostImportFcn` callback
`moveUp`	Move referenced requirement up in hierarchy
`moveDown`	Move referenced requirement down in hierarchy

Objects

expand all

Open Services for Lifecycle Collaboration

Client and Core Objects

`oslc.Client`	Client to integrate with OSLC providers (Since R2021a)
`oslc.core.CreationFactory`	OSLC service provider creation factory (Since R2021a)
`oslc.core.Dialog`	OSLC service provider user interface dialog (Since R2021a)
`oslc.core.QueryCapability`	OSLC service provider query capability (Since R2021a)

Resource Objects

`oslc.rm.Requirement`	Requirement resource for OSLC requirements management domain (Since R2021a)
`oslc.rm.RequirementCollection`	Requirement collection resource for OSLC requirements management domain (Since R2021a)
`oslc.qm.TestCase`	Test case resource for OSLC quality management domain (Since R2021a)
`oslc.qm.TestExecutionRecord`	Test execution record resource for OSLC quality management domain (Since R2021a)
`oslc.qm.TestPlan`	Test plan resource for OSLC quality management domain (Since R2021a)
`oslc.qm.TestResult`	Test result resource for OSLC quality management domain (Since R2021a)
`oslc.qm.TestScript`	Test script resource for OSLC quality management domain (Since R2021a)
`oslc.cm.ChangeRequest`	Change request resource for OSLC change management domain (Since R2021a)

Topics

Import and Update Requirements

Import Requirements from Third-Party Applications

Import requirements from external documents and requirements management tools.
Configure Requirements Toolbox for Interaction with Microsoft Office and IBM DOORS
Configure Requirements Toolbox to communicate with third-party requirements management tools or documents.
Configure Requirements Toolbox for IBM DOORS Software
Copy additional MATLAB^® files into your DOORS software installation.
Define Custom Document Interface for Importing Requirements
Define a custom document interface to import requirements from third-party applications.
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.
Update Imported Requirements
Update referenced requirements with updates from external documents or third-party requirements management tools.

Customize Imported Requirements

Create and Edit Attribute Mappings
Create and customize attribute mappings for importing and exporting ReqIF files.
Use Callbacks to Customize Requirement Import Behavior
Use callbacks to execute code when you import and update requirements.
Define Custom Requirement and Link Types and Properties
Customize requirements and links by using stereotypes or custom types and custom attributes.
Customize Requirement Index Numbering
Customize or disable the index of an individual requirement.

View Requirements

Configure Views in the Requirements Editor
Configure the Requirements Editor columns and create filters based on requirement and link metadata.

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

Working with IBM DOORS Requirements

Import, link, update, and set a requirements baseline for a control system with requirements in IBM DOORS.

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