slreq.Reference Class

Namespace: slreq

Work with external requirement proxy objects

Description

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 referenced requirements.

Creation

ref = find(rs, 'Type', 'Reference', 'PropertyName', PropertyValue) finds and returns a referenced requirement or a set of referenced requirements ref in the requirement set rs specified by the properties matching PropertyName and PropertyValue.

ref = add(rs, 'Artifact', FileName, 'PropertyName', PropertyValue) adds a referenced requirement ref to a requirement set rs which references requirements from the external document specified by FileName with properties and custom attributes specified by PropertyName and PropertyValue.

Input Arguments

rs — Requirement set object

slreq.ReqSet object

Requirement set, specified as an slreq.ReqSet object.

FileName — Container identifier

character vector

File name for a top-level container identifier, such as a Microsoft^® Office document name or an IBM^® DOORS^® Module unique ID.

Output Arguments

ref — Referenced requirement

slreq.Reference object

Referenced requirement, specified as an slreq.Reference object.

Properties

Id — Referenced requirement ID

character vector

Referenced requirement ID, returned as a character vector.

Attributes:

GetAccess	public
SetAccess	private

CustomId — Referenced requirement Custom ID

character vector

Referenced requirement custom ID, returned as a character vector.

Attributes:

GetAccess	public
SetAccess	private

Artifact — Container identifier

character vector

Top-level container identifier, like a Microsoft Office document name or an IBM DOORS Module unique ID.

Attributes:

GetAccess	public
SetAccess	private

ArtifactId — Requirement identifier

character vector

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.

Attributes:

GetAccess	public
SetAccess	private

Domain — Interface name for external requirement document

character vector

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.

Example: 'linktype_rmi_word','custom_jira'

Attributes:

GetAccess	public
SetAccess	private

UpdatedOn — Date and time referenced requirement was last updated

datetime

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.

Attributes:

GetAccess	public
SetAccess	private

CreatedOn — Date referenced requirement was created

datetime

The date the referenced requirement was created, specified as a datetime value. The software automatically populates this property.

Attributes:

GetAccess	public
SetAccess	private

CreatedBy — Referenced requirement creator

character vector

The name of the individual or organization who created the referenced requirement.

Attributes:

GetAccess	public
SetAccess	private

ModifiedBy — Referenced requirement modifier

character vector

The name of the individual or organization who last modified the referenced requirement.

Attributes:

GetAccess	public
SetAccess	private

IsLocked — Referenced requirement lock indicator

1 (default) | 0

Indicates if the referenced requirement is locked. 1 for locked and 0 for unlocked.

Attributes:

GetAccess	public
SetAccess	private

Summary — Referenced requirement summary

character vector

Referenced requirement summary text, returned as a character vector.

Attributes:

GetAccess	public
SetAccess	public

Description — Referenced requirement description

character vector

Referenced requirement description text, returned as a multiline character vector.

Attributes:

GetAccess	public
SetAccess	public

Rationale — Referenced requirement rationale

character vector

Referenced requirement rationale text, returned as a multiline character vector.

Attributes:

GetAccess	public
SetAccess	public

Keywords — Referenced requirement keywords

character array

Referenced requirement keywords, specified as a character array.

Attributes:

GetAccess	public
SetAccess	public

Type — Referenced requirement type enumeration

'Functional' | 'Informational' | 'Container' | string scalar | character vector

Referenced requirement type enumeration, specified as 'Functional', 'Informational', 'Container', or a string scalar or character vector that specifies a custom requirement type. For more information, see Requirement Types.

Attributes:

GetAccess	public
SetAccess	public

IndexEnabled — Referenced requirement index enabled indicator

1 (default) | 0

Indicates if the referenced requirement index is enabled (1) or disabled (0), returned as a 1 or 0 of data type logical. Disabling the index omits the referenced requirement from the numbered hierarchy list.

Attributes:

GetAccess	public
SetAccess	public

IndexNumber — User-specified referenced requirement index value

empty double array (default) | int32 array

User-specified referenced requirement index value, returned as an empty double array or an int32 array. If empty, Requirements Toolbox™ calculates the Index value. Otherwise, Requirements Toolbox sets the Index property to the specified integer value.

Attributes:

GetAccess	public
SetAccess	public

SID — Referenced requirement Session Independent Identifier

character vector

The Session Independent Identifier corresponding to the referenced requirement.

Attributes:

GetAccess	public
SetAccess	private

FileRevision — Referenced requirement revision number

scalar

Referenced requirement revision number, specified as a scalar.

Attributes:

GetAccess	public
SetAccess	private

ModifiedOn — Date referenced requirement was modified

datetime

The date the referenced requirement was last modified, specified as a datetime value. The software automatically populates this property.

Attributes:

GetAccess	public
SetAccess	private

Dirty — Unsaved changes indicator

0 | 1

Indicates if the requirement has unsaved changes (1) or does not have unsaved changes (0).

Attributes:

GetAccess	public
SetAccess	private

Comments — Referenced requirement comments

structure array

The comments that are attached with the referenced requirement, returned as a structure.

Attributes:

GetAccess	public
SetAccess	private

Index — Referenced requirement index

character array

The index of the referenced requirement, specified as a character array.

Attributes:

GetAccess	public
SetAccess	private

Methods

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
getExternalTypeName	Get requirement type name from external artifact
getImplementationStatus	Query referenced requirement implementation status summary
getPostImportFcn	Get contents of PostImportFcn callback
getPreImportFcn	Get registered PreImportFcn callback script
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 PostImportFcn callback
setPostImportFcn	Assign PostImportFcn callback script
setPreImportFcn	Assign PreImportFcn callback script
unlock	Unlock referenced requirements
unlockAll	Unlock all child referenced requirements for editing
updateFromDocument	Update referenced requirements from external requirements document

Examples

Find a Referenced Requirement

This example shows how to find a referenced requirement in a requirement set.

Load a requirement set called myReqSet.

rs = slreq.load("myReqSet");

Find a requirement with ID 9 in the requirement set.

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

Version History

Introduced in R2018a