rmipref

Get or set RMI preferences stored in prefdir

Syntax

rmipref

currentVal = rmipref(prefName)

previousVal = rmipref(Name,Value)

Description

rmipref returns a list of the Name,Value pairs that correspond to the Requirements Management Interface (RMI) preference names and accepted values.

currentVal = rmipref(prefName) returns the current value of the preference specified by prefName.

previousVal = rmipref(Name,Value) sets a new value for the RMI preference specified by Name, and returns the previous value of that RMI preference.

Examples

References to Simulink Model in External Requirements Documents

Choose the type of reference that the RMI uses when it creates links to your model from external requirements documents. The reference to your model can be either the model file name or the full absolute path to the model file.

The value of the 'ModelPathReference' preference determines how the RMI stores references to your model in external requirements documents. To view the current value of this preference, enter the following code at the MATLAB^® command prompt.

currentVal = rmipref('ModelPathReference')

The default value of the 'ModelPathReference' preference is 'none'.

currentVal =

none

This default value specifies that the RMI uses only the model file name in references to your model that it creates in external requirements documents.

Automatic Application of User Keywords to Selection-Based Requirements Links

Configure the RMI to automatically apply a specified list of user keyword keywords to new selection-based requirements links that you create.

Specify that the user keywords design and reqts apply to new selection-based requirements links that you create.

previousVal = rmipref('SelectionLinkKeyword','design,reqts')

When you specify a new value for an RMI preference, rmipref returns the previous value of that RMI preference. In this case, previousVal is an empty character vector, the default value of the 'SelectionLinkKeyword' preference.

previousVal =

     ''

View the currently specified value for the 'SelectionLinkKeyword' preference.

currentVal = rmipref('SelectionLinkKeyword')

The function returns the currently specified comma-separated list of user keywords.

currentVal =

design,reqts

These user keywords apply to all new selection-based requirements links that you create.

Internal Storage of Requirements Traceability Data

Configure the RMI to embed requirements links data in the model file instead of in a separate SLMX file.

Note

If you have existing requirements links for your model that are stored internally, you need to move these links into an external SLMX file before you change the storage settings for your requirements traceability data. See Move Internally Stored Requirements Links to External Storage for more information.

If you would like to embed requirements traceability data in the model file, set the 'StoreDataExternally' preference to 0.

previousVal = rmipref('StoreDataExternally',0)

When you specify a new value for an RMI preference, rmipref returns the previous value of that RMI preference. By default, the RMI stores requirements links data externally in a separate SLMX file, so the previous value of this preference was 1.

previousVal =

     1

After you set the 'StoreDataExternally' preference to 0, your requirements links are embedded in the model file.

currentVal = rmipref('StoreDataExternally')

currentVal =

     0

Input Arguments

prefName — RMI preference name

'BiDirectionalLinking' | 'FilterRequireKeywords' | 'CustomSettings' | ...

RMI preference name, specified as the corresponding Name character vector listed in Name-Value Arguments.

Name-Value Arguments

Example: 'BiDirectionalLinking',true enables bidirectional linking for your model, so that when you create a selection-based link to a requirements document, the RMI creates a corresponding link to your model from the requirements document.

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside single quotes (' ').

BiDirectionalLinking — Bidirectional selection linking preference

false (default) | true

Bidirectional selection linking preference, specified as a numeric or logical 1 (true) or 0 (false).

This preference specifies whether to simultaneously create return link from target to source when creating link from source to target. This setting applies only for requirements document types that support selection-based linking.

Data Types: logical

CustomSettings — Preference for storing custom settings

inUse: 0 (default) | structure array of custom field names and settings

Preference for storing custom settings, specified as a structure array. Each field of the structure array corresponds to the name of your custom preference, and each associated value corresponds to the value of that custom preference.

Data Types: struct

DocumentPathReference — Preference for path format of links to requirements documents from model

'modelRelative' (default) | 'absolute' | 'pwdRelative' | 'none'

Preference for path format of links to requirements documents from model, specified as one of the following values.

Value	Document reference contains...
'absolute'	full absolute path to requirements document.
'pwdRelative'	path relative to MATLAB current folder.
'modelRelative'	path relative to model file.
'none'	document file name only.

For more information, see Document Path Storage.

Data Types: char

DuplicateOnCopy — Preference for copying requirements links with model objects

true (default) | false

Preference for copying requirements links along with model objects, specified as a numeric or logical 1 (true) or 0 (false).

This preference specifies whether requirements links should be duplicated when copying Simulink^® and Stateflow^® objects. When set to false, links are duplicated only when you highlight links in the source model where the model objects are copied from.

Data Types: logical

FilterEnable — Preference to enable filtering by user keyword keywords

false (default) | true

Preference to enable filtering by user keyword keywords, specified as a numeric or logical 1 (true) or 0 (false). When you filter by user keyword keywords, you can include or exclude subsets of requirements links in highlighting or reports. You can specify user keyword keywords for requirements links filtering in the 'FilterRequireKeywords' and 'FilterExcludeKeywords' preferences. For more information about requirements filtering, see Filter Requirements with User Keywords.

Data Types: logical

FilterRequireKeywords — Preference for user keyword keywords for requirements links

empty character vector (default) | comma-separated list of user keyword keywords

Preference for user keyword keywords for requirements links, specified as a comma-separated list of words or phrases in a character vector. These user keywords apply to all new requirements links you create. Requirements links with these user keywords are included in model highlighting and reports. For more information about requirements filtering, see Filter Requirements with User Keywords.

Data Types: char

FilterExcludeKeywords — Preference to exclude certain requirements links from model highlighting and reports

empty character vector (default) | comma-separated list of user keyword keywords

Preference to exclude certain requirements links from model highlighting and reports, specified as a comma-separated list of user keyword keywords. Requirements links with these user keywords are excluded from model highlighting and reports. For more information about requirements filtering, see Filter Requirements with User Keywords.

Data Types: char

FilterMenusByKeywords — Preference to disable labels of requirements links with designated user keywords

false (default) | true

Preference to disable labels of requirements links with designated user keywords, specified as a numeric or logical 1 (true) or 0 (false). When set to true, if a requirement link has a user keyword designated in 'FilterExcludeKeywords' or 'FilterRequireKeywords', that requirements link will be disabled in the Requirements context menu. For more information about requirements filtering, see Filter Requirements with User Keywords.

Data Types: logical

FilterConsistencyChecking — Preference to filter Model Advisor requirements consistency checks with designated user keywords

false (default) | true

Preference to filter Model Advisor requirements consistency checks with designated user keywords, specified as a numeric or logical 1 (true) or 0 (false). When set to true, Model Advisor requirements consistency checks include requirements links with user keywords designated in 'FilterRequireKeywords' and excludes requirements links with user keywords designated in 'FilterExcludeKeywords'. For more information about requirements filtering, see Filter Requirements with User Keywords.

Data Types: logical

KeepSurrogateLinks — Preference to keep IBM^® DOORS^® surrogate links when deleting all requirements links

empty (default) | false | true

Preference to keep DOORS surrogate links when deleting all requirements links, specified as a numeric or logical 1 (true) or 0 (false). When set to true, right-clicking Requirements at This Level > Delete All Outgoing Links deletes all requirements links including DOORS surrogate module requirements links. When not set to true or false, right-clicking Requirements at This Level > Delete All Outgoing Links opens a dialog box with a choice to keep or delete DOORS surrogate links.

Data Types: logical

LinkIconFilePath — Preference to use custom image file as requirements link icon

empty character vector (default) | full image file path

Preference to use custom image file as requirements link icon, specified as full path to icon or small image file. This image will be used for requirements links inserted in external documents.

Data Types: char

LoginProvider — Custom authentication callback function for integration with web-based services

character vector

Custom authentication callback function for integration with web-based services, specified as a character vector.

If your network requires advanced authentication that the default authentication process does not support, use this argument to register a custom authentication callback function. For example, if you register a custom authentication callback function and then use slreq.dngConfigure, the function calls your custom function to authenticate the connection with the IBM DOORS Next server. For more information, see the Tips section of slreq.dngConfigure.

Note

The custom authentication callback function should take this form:

function [success,cookies] = myCustomLoginProvider(server,options)
% Provide your implementation here
end

The custom authentication function should return two arguments: success status and cookies received from the server.

Example: "myCustomLoginProvider"

ModelPathReference — Preference for path format in links to model from requirements documents

'none' (default) | 'absolute'

Preference for path format in links to model from requirements documents, specified as one of the following values.

Value	Model reference contains...
'absolute'	full absolute path to model.
'none'	model file name only.

Data Types: char

OslcServerAddress — OSLC server address

string scalar | character vector

Open Services for Lifecycle Collaboration (OSLC) server address, specified as a string scalar or a character vector.

Data Types: char | string

OslcServerRMRoot — OSLC server requirements management root

rm (default) | string scalar | character vector

Open Services for Lifecycle Collaboration (OSLC) server requirements management root, specified as a string scalar or a character vector. The default value is rm.

Data Types: char | string

OslcServerUser — OSLC username

string scalar | character vector

Open Services for Lifecycle Collaboration (OSLC) username, specified as a string scalar or a character vector.

Data Types: char | string

OslcUseGlobalConfig — Preference to allow global configuration

false or 0 (default) | true or 1

Preference to allow global configurations when configuring a MATLAB session for integration with IBM DOORS Next, specified as a numeric or logical 1 (true) or 0 (false).

Data Types: logical

ReqifMappingFilePath — Directory for custom import mapping files

string scalar | character vector

Directory for custom import mapping files, specified as a string scalar or character vector. Specify the directory using a full file path. You can specify multiple directories by entering a semicolon separated list.

Example: ReqifMappingFilePath="C:/users/jdoe/MATLAB/mappings"

Example: ReqifMappingFilePath="C:/users/jdoe/MATLAB/mappings;C/users/jdoe/downloads"

Data Types: char | string

ReportDocDetails — Preference to include extra detail from requirements documents in generated reports

false (default) | true

Preference to include extra detail from requirements documents in generated reports, specified as a numeric or logical 1 (true) or 0 (false). When set to true, generated requirements reports load linked requirements documents to include additional information about linked requirements. This preference applies to Microsoft^® Word, Microsoft Excel^®, and IBM DOORS requirements documents only.

Data Types: logical

ReportFollowLibraryLinks — Preference to include requirements links in referenced libraries in generated report

false (default) | true

Preference to include requirements links in referenced libraries in generated report, specified as a numeric or logical 1 (true) or 0 (false). When set to true, generated requirements reports include requirements links in referenced libraries.

Data Types: logical

ReportHighlightSnapshots — Preference to include highlighting in model snapshots in generated report

true (default) | false

Preference to include highlighting in model snapshots in generated report, specified as a numeric or logical 1 (true) or 0 (false). When set to true, snapshots of model objects in generated requirements reports include highlighting of model objects with requirements links.

Data Types: logical

ReportIncludeKeywords — Preference to list user keywords for requirements links in generated reports

false (default) | true

Preference to list user keywords for requirements links in generated reports, specified as a numeric or logical 1 (true) or 0 (false). When set to true, generated requirements reports include user keywords specified for each requirement link. For more information about requirements filtering, see Filter Requirements with User Keywords.

Data Types: logical

ReportLinkToObjects — Preference to include links to model objects in generated requirements reports

false (default) | true

Preference to include links to model objects in generated requirements reports, specified as a numeric or logical 1 (true) or 0 (false). When set to true, generated requirements reports include links to model objects. These links work only if the MATLAB internal HTTP server is active.

Data Types: logical

ReportNoLinkItems — Preference to include model objects with no requirements links in generated requirements reports

false (default) | true

Preference to include model objects with no requirements links in generated requirements reports, specified as a numeric or logical 1 (true) or 0 (false). When set to true, generated requirements reports include lists of model objects that have no requirements links.

Data Types: logical

ReportUseDocIndex — Preference to include short document ID instead of full path to document in generated requirements reports

false (default) | true

Preference to include short document ID instead of full path to document in generated requirements reports, specified as a numeric or logical 1 (true) or 0 (false). When set to true, generated requirements reports include short document IDs, when specified, instead of full paths to requirements documents.

Data Types: logical

SelectionLinkDoors — Preference to include IBM DOORS selection link option in Requirements context menu

true (default) | false

Preference to include IBM DOORS selection link option in Requirements context menu, specified as a numeric or logical 1 (true) or 0 (false).

Data Types: logical

ReqIfImportUseProfile — Preference to use stereotypes when importing requirements from ReqIF™ files

false (default) | true

Preference to use stereotypes when importing requirements from ReqIF files, specified as a numeric or logical 1 (true) or 0 (false). For more information, see Use Stereotypes when Importing from ReqIF Files.

Example: ReqIfImportUseProfile=true

Data Types: logical

SelectionLinkExcel — Preference to include Microsoft Excel selection link option in Requirements context menu

true (default) | false

Preference to include Microsoft Excel selection link option in Requirements context menu, specified as a numeric or logical 1 (true) or 0 (false).

Data Types: logical

SelectionLinkKeyword — Preference for user keywords to apply to new selection-based requirements links

empty character vector (default) | comma-separated list of user keyword keywords

Preference for user keywords to apply to new selection-based requirements links, specified as a comma-separated list of words or phrases in a character vector. These user keywords automatically apply to new selection-based requirements links that you create. For more information about requirements filtering, see Filter Requirements with User Keywords.

Data Types: char

SelectionLinkWord — Preference to include Microsoft Word selection link option in Requirements context menu

true (default) | false

Preference to include Microsoft Word selection link option in Requirements context menu, specified as a numeric or logical 1 (true) or 0 (false).

Data Types: logical

StoreDataExternally — Preference to store requirements links data in external SLMX file

false (default) | true

Preference to store requirements links data in external SLMX file, specified as a numeric or logical 1 (true) or 0 (false). This setting applies to all new models and to existing models that do not yet have requirements links. For more information about storage of requirements links data, see Requirements Link Storage.

Data Types: logical

UseActiveXButtons — Preference to use legacy ActiveX^® buttons in Microsoft Office requirements documents

false (default) | true

Preference to use legacy ActiveX buttons in Microsoft Office requirements documents, specified as a numeric or logical 1 (true) or 0 (false). The default value of this preference is false; requirements links are URL-based by default. ActiveX requirements navigation is supported for backward compatibility.

Data Types: logical

Output Arguments

currentVal — Current value of the RMI preference specified by prefName

true | false | 'absolute' | 'none' | ...

Current value of the RMI preference specified by prefName. RMI preference names and their associated possible values are listed in Name-Value Arguments.

previousVal — Previous value of the RMI preference specified by prefName

true | false | 'absolute' | 'none' | ...

Previous value of the RMI preference specified by prefName. RMI preference names and their associated possible values are listed in Name-Value Arguments.

Version History

Introduced in R2013a

R2023b: Use custom import mapping for ReqIF files

Use custom import mappings by registering the folder that contains the mapping by using the ReqifMappingFilePath name-value argument.

R2023a: Use profiles when importing requirements and links from ReqIF files

Use the ReqIfImportUseProfile name-value argument to use profiles when you import requirements and links from ReqIF files. For more information, see Use Stereotypes when Importing from ReqIF Files.