Create Requirement Links

Create links to establish traceability between requirements and designs or tests

Link requirements to designs and tests in MATLAB^® and Simulink^®, and architectures in System Composer™.

Alternatively, you can link directly to external requirements in third-party applications. For more information, see Create Links to External Requirements.

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

Blocks

System Requirements

List system requirements in Simulink models

Functions

expand all

Establish Traceability

`slreq.createLink`	Create traceable links
`slreq.generateTraceabilityMatrix`	Create traceability matrix (Since R2021a)
`slreq.createTextRange`	Create line ranges (Since R2022b)
`rmitag`	Manage keywords for links

Get Traceability Information

`slreq.find`	Find requirement, reference, and link set artifacts
`slreq.inLinks`	Get incoming links for requirement or other linkable item
`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
`slreq.show`	Navigate to link source or destination (Since R2020a)

Load, Clear, 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

Classes

expand all

Link Classes

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

Requirement Classes

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

Methods

expand all

Link Set Methods

Get Links

`find`	Find links in link set with matching attribute values
`getLinks`	Get links from link set
`getBrokenLinks`	Get links with invalid destination
`getOrphanLinks`	Get links with invalid source

Get Link Sources, Line Ranges, and Requirement Sets

`sources`	Get link sources
`getRegisteredReqSets`	Get requirement sets registered in link set
`getTextRange`	Get line ranges
`getTextRanges`	Get lines ranges that span multiple lines

Customize Link Sets

`addAttribute`	Add custom attribute to link set
`importProfile`	Assign profile to ink set
`inspectAttribute`	Get information about link set custom attribute
`profiles`	Get profiles assigned to link set
`removeProfile`	Remove profile from link set

Save and Delete Links

`save`	Save link set
`deleteOrphanLinks`	Delete links with invalid source

Link Methods

Get Traceability Information

`linkSet`	Get link set for link
`getDestinationOpenCommand`	Retrieve command that opens link destination
`getSourceOpenCommand`	Retrieve command that opens link source
`getDestinationURL`	Retrieve URL that opens link destination
`getSourceURL`	Retrieve URL that opens link source
`getDestinationLabel`	Get label that identifies link destination
`getSourceLabel`	Get label that identifies link source
`getIncomingTypeLabel`	Get type label for incoming link
`getOutgoingTypeLabel`	Get type label for outgoing link

Get and Set Source and Destination

`source`	Get link source
`destination`	Get link destination
`setSource`	Set requirement link source
`setDestination`	Set requirement link destination

Add Comments and Customize Links

`addComment`	Add comments to links
`getAttribute`	Get link property values
`setAttribute`	Set link property values

Remove Links

remove Delete links

Check Unresolved Links

`getReferenceInfo`	Get unresolved link destination
`isResolved`	Check if the link is resolved
`isResolvedDestination`	Check if the link destination is resolved
`isResolvedSource`	Check if the link source is resolved

Requirement Set Methods

`getImplementationStatus`	Query requirement set implementation status summary
`updateImplementationStatus`	Update requirement set implementation status summary

Requirement Methods

`inLinks`	Get incoming links for requirements
`outLinks`	Get outgoing links for requirements
`getImplementationStatus`	Query requirement implementation status summary
`isJustifiedFor`	Check if requirement is justified
`justifyImplementation`	Justify requirements for implementation

Referenced Requirement Methods

`inLinks`	Get incoming links for referenced requirements
`outLinks`	Get outgoing links for referenced requirements
`getImplementationStatus`	Query referenced requirement implementation status summary
`isJustifiedFor`	Check if referenced requirement is justified
`justifyImplementation`	Justify referenced requirements for implementation

Justification Methods

outLinks Get outgoing links for justifications

Objects

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

Object Functions

expand all

Modify Line Ranges

`deleteLinks`	Delete links for line ranges
`getLineRange`	Get line numbers for line range
`getLinks`	Get links for line range
`getText`	Get contents of line range
`remove`	Delete unused line ranges
`setLineRange`	Set line numbers for line range
`show`	Open and highlight line range in MATLAB Editor

Configure Traceability Matrices

`addFilterToCell`	Add cell filter to traceability matrix configuration
`addFilterToHighlight`	Add highlighting to traceability matrix configuration
`addFilterToLeft`	Add filter to left artifacts in traceability matrix configuration
`addFilterToMatrix`	Add matrix settings filter to traceability matrix configuration
`addFilterToTop`	Add filter to top artifacts in traceability matrix configuration
`exportToScript`	Export traceability matrix configuration to script

Topics

Link Requirements, Architectures, Designs, and Tests

Create and Store Links

Trace requirements to design and test items by creating links.
Requirements Links for Library Blocks and Reference Blocks
Create and manage requirements links in libraries and in models.
Justify Requirements
Provide justifications for your requirements.
Track Requirement Links by Using Implementation Status
Use the requirements implementation status to check how extensively requirements are implemented in your model.
Delete Requirements Links from Simulink Models
Delete requirements links from Simulink model elements and maintain link integrity.

Load and Customize Links

Load and Resolve Links
Load link sets and resolve the links.
Define Custom Requirement and Link Types and Properties
Customize requirements and links by using stereotypes or custom types and custom attributes.
Configure Views in the Requirements Editor
Configure the Requirements Editor columns and create filters based on requirement and link metadata.

Related Information

Featured Examples

Link Test Cases to Requirements

Associate Simulink Test™ test cases with requirements.

Open Live Script

Use Command-Line API to Update or Repair Requirements Links

Update links to maintain link history and properties across requirements changes.

Open Live Script

Manage Custom Attributes for Links by Using the Requirements Toolbox API

Manage custom attributes for links with the Requirements Toolbox™ API.

Open Live Script

Make Requirements Fully Traceable with a Traceability Matrix

Identify requirements within a project that are unlinked and link them to Model-based Design items.

Open Live Script

Modeling System Architecture of Small UAV

Use System Composer™ to set up the architecture for a small unmanned aerial vehicle, composed of six top-level components. Learn how to refine your architecture design by authoring interfaces, inspect linked textual requirements, define profiles and stereotypes, and run a static analysis on such an architecture model.

Open Example

Model-Based Systems Engineering for Space-Based Applications

Explore the CubeSat model-based systems engineering project template.

Open Live Script

Associate Traceability Information with MATLAB Code Lines in Simulink

Traceability management support in the MATLAB Editor is an extension of the Simulink-based Requirements Management Interface to allow associations between MATLAB code lines and external artifacts.

Open Live Script