Documentation Center

  • Trial Software
  • Product Updates

rmipref

Get or set RMI preferences stored in prefdir

Syntax

  • rmipref
  • currentVal = rmipref(prefName) example
  • previousVal = rmipref(Name,Value) example

Description

rmipref returns list of Name,Value pairs corresponding to Requirements Management Interface (RMI) preference names and accepted values for each preference.

example

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

example

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

expand all

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 Tags to Selection-Based Requirements Links

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

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

previousVal = rmipref('SelectionLinkTag','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 string, the default value of the 'SelectionLinkTag' preference.

previousVal =

     ''

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

currentVal = rmipref('SelectionLinkTag')

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

currentVal =

design,reqts

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

External Storage of Requirements Traceability Data

Configure the RMI to store requirements links data in a separate .req file, instead of embedded in the model file.

    Note:   If you have existing requirements links for your model that are stored internally, you need to move these links into an external .req 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 store requirements traceability data in a separate .req file, set the 'StoreDataExternally' preference to 1.

previousVal = rmipref('StoreDataExternally',1)

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 internally with the model, so the previous value of this preference was 0.

previousVal =

     0

After you set the 'StoreDataExternally' preference to 1, your requirements links are stored externally, in a separate .req file.

currentVal = rmipref('StoreDataExternally')
currentVal =

     1

Input Arguments

expand all

prefName — RMI preference name'BiDirectionalLinking' | 'FilterRequireTags' | 'CustomSettings' | ...

RMI preference name, specified as the corresponding Name string listed in Name-Value Pair Arguments.

Name-Value Pair Arguments

Example: 'BiDirectionalLinking',true enables bi-directional 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' — Bi-directional selection linking preferencefalse (default) | true

Bi-directional selection linking preference, specified as a logical value.

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

'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 strings.

StringDocument 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

'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 strings.

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

Data Types: char

'LinkIconFilePath' — Preference to use custom image file as requirements link iconempty string (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

'FilterEnable' — Preference to enable filtering by user tag keywordsfalse (default) | true

Preference to enable filtering by user tag keywords, specified as a logical value. When you filter by user tag keywords, you can include or exclude subsets of requirements links in highlighting or reports. You can specify user tag keywords for requirements links filtering in the 'FilterRequireTags' and 'FilterExcludeTags' preferences. For more information about requirements filtering, see Filter Requirements with User Tags.

Data Types: logical

'FilterRequireTags' — Preference for user tag keywords for requirements linksempty string (default) | comma-separated list of user tag keywords

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

Data Types: char

'FilterExcludeTags' — Preference to exclude certain requirements links from model highlighting and reportsempty string (default) | comma-separated list of user tag keywords

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

Data Types: char

'FilterMenusByTags' — Preference to disable labels of requirements links with designated user tagsfalse (default) | true

Preference to disable labels of requirements links with designated user tags, specified as a logical value. When set to true, if a requirement link has a user tag designated in 'FilterExcludeTags' or 'FilterRequireTags', that requirements link will be disabled in the Requirements context menu. For more information about requirements filtering, see Filter Requirements with User Tags.

Data Types: logical

'FilterConsistencyChecking' — Preference to filter Model Advisor requirements consistency checks with designated user tagsfalse (default) | true

Preference to filter Model Advisor requirements consistency checks with designated user tags, specified as a logical value. When set to true, Model Advisor requirements consistency checks include requirements links with user tags designated in 'FilterRequireTags' and excludes requirements links with user tags designated in 'FilterExcludeTags'. For more information about requirements filtering, see Filter Requirements with User Tags.

Data Types: logical

Preference to keep DOORS surrogate links when deleting all requirements links, specified as a logical value. When set to true, selecting Requirements > Delete All Links deletes all requirements links including DOORS surrogate module requirements links. When not set to true or false, selecting Requirements > Delete All Links opens a dialog box with a choice to keep or delete DOORS surrogate links.

Data Types: logical

Preference to include requirements links in referenced libraries in generated report, specified as a logical value. 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 reporttrue (default) | false

Preference to include highlighting in model snapshots in generated report, specified as a logical value. When set to true, snapshots of model objects in generated requirements reports include highlighting of model objects with requirements links.

Data Types: logical

'ReportNoLinkItems' — Preference to include model objects with no requirements links in generated requirements reportsfalse (default) | true

Preference to include model objects with no requirements links in generated requirements reports, specified as a logical value. 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 reportsfalse (default) | true

Preference to include short document ID instead of full path to document in generated requirements reports, specified as a logical value. When set to true, generated requirements reports include short document IDs, when specified, instead of full paths to requirements documents.

Data Types: logical

'ReportIncludeTags' — Preference to list user tags for requirements links in generated reportsfalse (default) | true

Preference to list user tags for requirements links in generated reports, specified as a logical value. When set to true, generated requirements reports include user tags specified for each requirement link. For more information about requirements filtering, see Filter Requirements with User Tags.

Data Types: logical

'ReportDocDetails' — Preference to include extra detail from requirements documents in generated reportsfalse (default) | true

Preference to include extra detail from requirements documents in generated reports, specified as a logical value. 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® Rational® DOORS requirements documents only.

Data Types: logical

'ReportLinkToObjects' — Preference to include links to model objects in generated requirements reportsfalse (default) | true

Preference to include links to model objects in generated requirements reports, specified as a logical value. 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

'SelectionLinkWord' — Preference to include Microsoft Word selection link option in Requirements context menutrue (default) | false

Preference to include Microsoft Word selection link option in Requirements context menu, specified as a logical value.

Data Types: logical

'SelectionLinkExcel' — Preference to include Microsoft Excel selection link option in Requirements context menutrue (default) | false

Preference to include Microsoft Excel selection link option in Requirements context menu, specified as a logical value.

Data Types: logical

'SelectionLinkDoors' — Preference to include IBM Rational DOORS selection link option in Requirements context menutrue (default) | false

Preference to include IBM Rational DOORS selection link option in Requirements context menu, specified as a logical value.

Data Types: logical

'SelectionLinkTag' — Preference for user tags to apply to new selection-based requirements linksempty string (default) | comma-separated list of user tag keywords

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

Data Types: char

'StoreDataExternally' — Preference to store requirements links data in external .req filefalse (default) | true

Preference to store requirements links data in external .req file, specified as a logical value. 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 and Specify Storage for Requirements Links.

Data Types: logical

'UseActiveXButtons' — Preference to use legacy ActiveX® buttons in Microsoft Office requirements documentsfalse (default) | true

Preference to use legacy ActiveX buttons in Microsoft Office requirements documents, specified as a logical value. The default value of this preference is false; requirements links are URL-based by default. ActiveX requirements navigation is supported for backward compatibility. For more information on legacy ActiveX navigation, see Navigate with Objects Created Using ActiveX in Microsoft Office 2007 and 2010.

Data Types: logical

'CustomSettings' — Preference for storing custom settingsinUse: 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

Output Arguments

expand all

currentVal — Current value of the RMI preference specified by prefNametrue | 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 Pair Arguments.

previousVal — Previous value of the RMI preference specified by prefNametrue | 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 Pair Arguments.

See Also

Was this topic helpful?