Work with external requirement proxy objects
Objects of the
slreq.Reference class represent referenced requirements that
you import from third-party requirements management tools. Referenced requirements are
proxy requirements for the external requirements that you manage by using the
third-party tool. When you make changes to the external requirements, you can update the
finds and returns a referenced requirement or a set of referenced requirements
ref = find(
ref in the requirement set
rs specified by the
adds a referenced requirement
ref = add(
ref to a requirement set
rs which references requirements from the external document
FileName with properties and custom attributes
rs — Requirement set object
Requirement set, specified as an
FileName — Container identifier
File name for a top-level container identifier, such as a Microsoft® Office document name or an IBM® DOORS® Module unique ID.
ref — Referenced requirement
Referenced requirement, specified as an
Id — Referenced requirement ID
Referenced requirement ID, returned as a character vector.
CustomId — Referenced requirement Custom ID
Referenced requirement custom ID, returned as a character vector.
Artifact — Container identifier
Top-level container identifier, like a Microsoft Office document name or an IBM DOORS Module unique ID.
ArtifactId — Requirement identifier
Unique requirement identifier in the source requirements document. For requirements imported from IBM DOORS, the ArtifactId is the Numeric Object Id. For requirements imported from Microsoft Word, the bookmark names are used as the ArtifactId.
Domain — Interface name for external requirement document
The interface name for the external requirement document, returned as a character vector. The name can be one of the built-in names or the name of a custom registered interface. For more information, see Define Custom Document Interface for Importing Requirements.
UpdatedOn — Date and time referenced requirement was last updated
The date and time the referenced requirement was last synchronized with
the external document, specified as a
datetime value. The
software automatically populates this property.
CreatedOn — Date referenced requirement was created
The date the referenced requirement was created, specified as a
datetime value. The software automatically populates
CreatedBy — Referenced requirement creator
The name of the individual or organization who created the referenced requirement.
ModifiedBy — Referenced requirement modifier
The name of the individual or organization who last modified the referenced requirement.
IsLocked — Referenced requirement lock indicator
1 (default) | 0
Indicates if the referenced requirement is locked.
for locked and
0 for unlocked.
Summary — Referenced requirement summary
Referenced requirement summary text, returned as a character vector.
Description — Referenced requirement description
Referenced requirement description text, returned as a multiline character vector.
Rationale — Referenced requirement rationale
Referenced requirement rationale text, returned as a multiline character vector.
Keywords — Referenced requirement keywords
Referenced requirement keywords, specified as a character array.
Type — Referenced requirement type enumeration
'Container' | string scalar | character vector
Referenced requirement type enumeration, specified as
'Container', or a string scalar or character vector
that specifies a custom requirement type. For more information, see Requirement Types.
IndexEnabled — Referenced requirement index enabled indicator
1 (default) |
Indicates if the
referenced requirement index is enabled (
1) or disabled
0), returned as a
0 of data type
the index omits the referenced requirement from the numbered hierarchy
IndexNumber — User-specified referenced requirement index value
double array (default) |
SID — Referenced requirement Session Independent Identifier
The Session Independent Identifier corresponding to the referenced requirement.
FileRevision — Referenced requirement revision number
Referenced requirement revision number, specified as a scalar.
ModifiedOn — Date referenced requirement was modified
The date the referenced requirement was last modified, specified as a
datetime value. The software automatically populates
Dirty — Unsaved changes indicator
Indicates if the requirement has unsaved changes (
does not have unsaved changes (
Comments — Referenced requirement comments
The comments that are attached with the referenced requirement, returned as a structure.
Index — Referenced requirement index
The index of the referenced requirement, specified as a character array.
|add||Add child referenced requirement|
|addComment||Add comments to referenced requirements|
|children||Find children references|
|find||Find children of parent referenced requirements|
|getAttribute||Get referenced requirement custom attributes|
|getImplementationStatus||Query referenced requirement implementation status summary|
|getPostImportFcn||Get contents of |
|getPreImportFcn||Get registered |
|getVerificationStatus||Query referenced requirement verification status summary|
|hasNewUpdate||Check if import node has available update|
|inLinks||Get incoming links for referenced requirements|
|isFilteredIn||Check filtered referenced requirements|
|isJustifiedFor||Check if referenced requirement is justified|
|justifyImplementation||Justify referenced requirements for implementation|
|justifyVerification||Justify referenced requirements for verification|
|moveDown||Move referenced requirement down in hierarchy|
|moveUp||Move referenced requirement up in hierarchy|
|navigateToExternalArtifact||Navigate from imported referenced requirement to original requirement|
|outLinks||Get outgoing links for referenced requirements|
|parent||Find parent item of referenced requirement|
|remove||Remove referenced requirements|
|reqSet||Return parent requirement set|
|setAttribute||Set referenced requirement custom attributes|
|setParent||Set parent of referenced requirement in |
|unlock||Unlock referenced requirements|
|unlockAll||Unlock all child referenced requirements for editing|
|updateFromDocument||Update referenced requirements from external requirements document|
Find a Referenced Requirement
This example shows how to find a referenced requirement in a requirement set.
Load a requirement set called
rs = slreq.load("myReqSet");
Find a requirement with ID
9 in the requirement
req = find(rs,"Type","Reference","ID","9");
ref = Reference with properties: Keywords: [0×0 char] Artifact: 'Req_doc.docx' Id: 'R9' Summary: 'System overview' Description: '' SID: 3 Domain: 'linktype_rmi_word' SynchronizedOn: 25-Jul-2017 11:34:02
Introduced in R2018a