Author Requirements

Author requirements in MATLAB^® and Simulink^®

Author requirements in MATLAB and Simulink by using the Requirements Editor or Requirements Perspective.

Add text, images, and keywords to describe requirements. Add child requirements to specify lower-level functionality. You can also add context to your model by showing requirements and descriptions on the Simulink canvas.

Apps

Requirements Editor

Create and edit requirements

Tools

Profile Editor

Create and manage profiles with stereotypes and properties

Classes

`slreq.ReqSet`	Work with requirement sets
`slreq.Requirement`	Work with requirement objects

Functions

`slreq.clear`	Clear requirements and links from memory
`slreq.closeRequirementsManager`	Close Requirements Manager app in model (Since R2021a)
`slreq.convertAnnotation`	Convert annotations to requirement objects
`slreq.editor`	Open Requirements Editor
`slreq.exportViewSettings`	Export view settings
`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)
`slreq.importViewSettings`	Import view settings
`slreq.load`	Load requirement set or link set
`slreq.new`	Create requirement set
`slreq.open`	Open requirement set
`slreq.openRequirementsManager`	Open Requirements Manager app in model (Since R2021a)
`slreq.refreshCustomizations`	Register Requirements Toolbox customizations (Since R2022a)
`slreq.resetViewSettings`	Reset saved view settings

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)

Requirements Editor View Settings

slreq.View View settings (Since R2022b)

Topics

Author Requirements in MATLAB or Simulink
Create requirements and define the requirement hierarchy with MATLAB or Simulink.
Define Requirements Hierarchy
Define the parent-child hierarchy for the requirements you associate with your design.
Requirement Types
Select requirement types.
Access Frequently Used Features and Commands from the Requirements Editor
Quickly perform actions or run favorite commands from the quick access toolbar in the Requirements Editor.
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.
Define Custom Requirement and Link Types and Properties

Customize requirements and links by using custom types and custom attributes, or stereotypes.
Customize Requirement Index Numbering
Customize or disable the index of an individual requirement.
Execute Code When Loading and Saving Requirement Sets
Use callbacks to execute code when you load and save requirement sets.
Create Requirement Set Hierarchies by Using the Requirements Toolbox API
Programmatically create requirement set hierarchies by using the Requirements Toolbox™ API.
Export Requirement Sets and Link Sets to Previous Versions of Requirements Toolbox
Export requirement and link sets to previous versions of Requirements Toolbox.
Use Command-Line API to Document Simulink Model in Requirements Editor

Programmatically author and link requirements to document your Simulink model design and create traceability.
- STEP 1: Capture Model as Requirements and Create Links
- STEP 2: Import Requirements and Reuse Existing Links
- STEP 3: Programmatically Repair Broken Links

Featured Examples

Use Command-Line API to Document Simulink Model in Requirements Editor

Programmatically author and link requirements to document your Simulink model design and create traceability.

Open Live Script

Manage Custom Attributes for Requirements by Using the Requirements Toolbox API

Manage custom attributes for requirements with the Requirements Toolbox API.

Open Live Script