Customize and Extend Requirements Toolbox

Customize requirements, links, the Requirements Editor, and import and save behaviors

Customize and extend requirements and links by creating custom types and properties and editing the requirements index numbering. Customize the Requirements Editor by adding frequently used commands to the quick access toolbar and by configuring views and filters. Customize how requirements import and update, and automate requirement set load and save tasks by using callbacks.

Apps

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

Functions

`slreq.importViewSettings`	Import view settings
`slreq.exportViewSettings`	Export view settings
`slreq.resetViewSettings`	Reset saved view settings
`slreq.refreshCustomizations`	Register Requirements Toolbox customizations (Since R2022a)
`rmipref`	Get or set Requirements Toolbox preferences stored in `prefdir`

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

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

Link Set Methods

Customize Links by Using Stereotypes

`importProfile`	Assign profile to ink set
`profiles`	Get profiles assigned to link set
`removeProfile`	Remove profile from link set

Custom Links by Using Custom Attributes

`addAttribute`	Add custom attribute to link set
`inspectAttribute`	Get information about link set custom attribute
`updateAttribute`	Update information for link set custom attribute
`deleteAttribute`	Delete custom attribute from link set

Link Methods

`getAttribute`	Get link property values
`setAttribute`	Set link property values
`isFilteredIn`	Check filtered links

Requirement Set Methods

Customize Requirements by Using Stereotypes

`importProfile`	Assign profile to requirement set
`profiles`	Get profiles assigned to requirement sets
`saveProfileMapping`	Save profile mapping to XML file
`removeProfile`	Remove profile from requirement set

Custom Requirements by Using Custom Attributes

`addAttribute`	Add custom attribute to requirement set
`inspectAttribute`	Get information about requirement set custom attribute
`updateAttribute`	Update information for requirement set custom attribute
`deleteAttribute`	Delete custom attribute from requirement set

Automate Load and Save Tasks

`getPostLoadFcn`	Get contents of `PostLoadFcn` callback
`getPreSaveFcn`	Get contents of `PreSaveFcn` callback
`setPostLoadFcn`	Assign `PostLoadFcn` callback script
`setPreSaveFcn`	Assign `PreSaveFcn` callback script

Requirement Methods

`getAttribute`	Get requirement property values
`setAttribute`	Set requirement property values
`isFilteredIn`	Check filtered requirements

Referenced Requirement Methods

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

Customize Imported Requirements

`getAttribute`	Get referenced requirement custom attributes
`setAttribute`	Set referenced requirement custom attributes
`isFilteredIn`	Check filtered referenced requirements

Justification Methods

`getAttribute`	Get justification attributes
`setAttribute`	Set justification attributes
`isFilteredIn`	Check filtered justifications

Objects

slreq.View View settings (Since R2022b)

Topics

Customize Requirements and Links

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.

Customize the Requirements Editor

Access Frequently Used Features and Commands from the Requirements Editor
Quickly perform actions or run commands from the quick access toolbar in the Requirements Editor.
Configure Views in the Requirements Editor
Configure the Requirements Editor columns and create filters based on requirement and link metadata.
Requirements Settings
Manage your Requirements Management Interface (RMI) preferences in the Requirements Settings dialog box.

Customize Behaviors by Using Callbacks

Use Callbacks to Customize Requirement Import Behavior
Use callbacks to execute code when you import and update requirements.
Execute Code When Loading and Saving Requirement Sets
Use callbacks to execute code when you load and save requirement sets.

Featured Examples

Manage Custom Attributes for Requirements by Using the Requirements Toolbox API

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

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