Create Links to External Requirements

Use links to establish traceability with requirements in third-party tools

Associate designs with requirements in third-party applications by creating direct links. Create bidirectional traceability by adding backlinks to requirements in third-party tools. Check direct links for validity and consistency by using the Model Advisor.

Apps

Requirements Editor	Create and edit requirements
Requirements Manager	Manage requirements and links in model
Profile Editor	Create and manage profiles with stereotypes and properties

Functions

expand all

Establish Traceability

`slreq.createLink`	Create traceable links
`slreq.createTextRange`	Create line ranges (Since R2022b)
`setDestination`	Set requirement link destination
`setSource`	Set requirement link source

Get Traceability Information

`slreq.find`	Find requirement, reference, and link set artifacts
`slreq.outLinks`	Get outgoing links for a block or other linkable item
`slreq.getDependentLinkSets`	Retrieve link sets with incoming links to requirement set (Since R2023a)
`slreq.getExternalURL`	Get navigation URL for link source or destination, requirement, test or Simulink model element (Since R2021a)
`slreq.getIncomingLinkTypeLabel`	Retrieve incoming link type label (Since R2023a)
`slreq.getOutgoingLinkTypeLabel`	Retrieve outgoing link type label (Since R2023a)
`slreq.getTextRange`	Get line ranges (Since R2022b)
`slreq.structToObj`	Convert link source or destination information from structure to model object type
`rmi`	Work programmatically with Requirements Toolbox

Track and Visualize Traceability

`slreq.generateTraceabilityDiagram`	Create a traceability diagram (Since R2021b)
`slreq.show`	Navigate to link source or destination (Since R2020a)
`rmitag`	Manage keywords for links

Load and Manage Link Files

`slreq.load`	Load requirement set, link set, or Requirements Table block
`slreq.clear`	Clear requirements and links from memory
`slreq.map`	Get or set path to link set file
`slreq.cmConfigureVersion`	Set configured version of linked requirements documents
`slreq.cmGetVersion`	Get configured version of linked requirements documents

Integrate with IBM DOORS Next

`slreq.dngConfigure`	Configure IBM DOORS Next session in MATLAB (Since R2020a)
`slreq.dngCountLinks`	Get number of links to IBM DOORS Next artifacts
`slreq.dngGetCurrentProject`	Current project for IBM DOORS Next session (Since R2023b)
`slreq.dngGetProjectConfig`	Configurations in current project for IBM DOORS Next session
`slreq.dngGetSessionConfig`	Configuration context for selected item in IBM DOORS Next
`slreq.dngGetUsedConfig`	Query used IBM DOORS Next configurations from MATLAB/Simulink artifacts
`slreq.dngSetCurrentProject`	Set current project for IBM DOORS Next session (Since R2023b)
`slreq.dngSetSessionConfig`	Set configuration context for IBM DOORS Next session (Since R2023b)
`slreq.dngUpdateConfig`	Update links to IBM DOORS Next configuration

Classes

`slreq.LinkSet`	Work with link sets
`slreq.Link`	Traceable link

Methods

expand all

Link Set Methods

`updateBacklinks`	Synchronize external navigation links
`updateDocUri`	Update link destinations for renamed or moved document
`redirectLinksToImportedReqs`	Redirect link destination from external document to imported requirement set
`save`	Save link set

Objects

`slreq.TextRange`	Line range (Since R2022b)
`slreq.matrix.Configuration`	Traceability matrix configuration (Since R2024a)
`slreq.matrix.Filter`	Filter for traceability matrix (Since R2024a)

Topics

Link to Requirements in Third-Party Applications

Link Directly to Requirements in Third-Party Applications

Link directly from items in MATLAB^® and Simulink^® to requirements in third-party applications.
Document Path Storage
Learn how to specify the absolute or relative path for a requirement.
Define Custom Document Interface for Direct Linking to Requirements
Define a custom document interface to link directly to requirements in third-party applications that Requirements Toolbox™ does not have built-in support for.
Manage Navigation Backlinks in External Requirements Documents
Insert hyperlinks between external requirements documents and linked items in MATLAB or Simulink.
Navigate to Requirements in Microsoft Office Documents from Simulink
Navigate to requirements in Microsoft^® Office documents by using navigation objects.
Synchronize Requirements Traceability in IBM DOORS by Using Surrogate Modules
Use surrogate modules to stablish traceability from Simulink models to IBM^® DOORS^® requirements without modifying the requirements modules.

Check Links to Third-Party Applications

Check Direct Links for Validity

Use Model Advisor checks to detect and resolve outdated and invalid direct links to requirements in third-party applications.

Featured Examples

Navigate to Requirements in IBM DOORS Databases from Simulink

Navigate from your Simulink model to a DOORS requirements document and vice-versa.

Managing Requirements for Fault-Tolerant Fuel Control System (Microsoft Office)

Manage requirements for a fuel control system in Microsoft Office.

Open Live Script

Managing Requirements for Fault-Tolerant Fuel Control System (IBM DOORS)

The Requirements Management Interface (RMI) provides tools for creating and reviewing links between Simulink objects and requirements documents.

Open Live Script

Use a Custom Document Interface to Link External Application Requirements

Requirements Management Interface (RMI) provides tools for creating and reviewing links between model-based design elements and requirements documents.

Open Live Script

Create Surrogate Module for a Fault-Tolerant Control System

Use a surrogate module in IBM® DOORS® to create direct links from a Simulink® model to requirements in an IBM DOORS module, and how to navigate the links.

Open Live Script