Get or set RMI preferences stored in prefdir
rmipref returns list of
Name,Value pairs corresponding to Requirements
Management Interface (RMI) preference names and accepted values for each
preference.
currentVal = rmipref(prefName)prefName.
previousVal = rmipref(Name,Value)Name, and returns the previous value of that RMI
preference.
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.
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
character vector, 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.
Configure the RMI to embed requirements links data in the
model file instead of in a separate .req 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 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 .req file, so the previous
value of this preference was 1.
previousVal =
1After you set the 'StoreDataExternally' preference
to 0, your requirements links are embedded in the
model file.
currentVal = rmipref('StoreDataExternally')currentVal =
0prefName — RMI preference name'BiDirectionalLinking' | 'FilterRequireTags' | 'CustomSettings' | ...RMI preference name, specified as the corresponding
Name character vector listed in Name-Value Pair Arguments.
'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 preferencefalse (default) | trueBidirectional 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
'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 objectstrue (default) | falsePreference 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
'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
'LinkIconFilePath' — Preference to use custom image file as requirements link iconPreference 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) | truePreference to enable filtering by user tag keywords, specified
as a numeric or logical 1
(true) or 0
(false). 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 linksPreference for user tag keywords for requirements links, specified as a comma-separated list of words or phrases in a character vector. 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 reportsPreference 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) | truePreference to disable labels of requirements links with
designated user tags, specified as a numeric or logical
1 (true) or
0 (false). 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) | truePreference to filter Model Advisor requirements consistency
checks with designated user tags, 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 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
'KeepSurrogateLinks' — Preference to keep DOORS® surrogate links when deleting all requirements linksfalse | truePreference 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
'ReportFollowLibraryLinks' — Preference to include requirements links in referenced libraries in generated reportfalse (default) | truePreference 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 reporttrue (default) | falsePreference 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
'ReportNoLinkItems' — Preference to include model objects with no requirements links in
generated requirements reportsfalse (default) | truePreference 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 reportsfalse (default) | truePreference 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
'ReportIncludeTags' — Preference to list user tags for requirements links in generated reportsfalse (default) | truePreference to list user tags 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 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) | truePreference 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®
Rational®
DOORS requirements documents only.
Data Types: logical
'ReportLinkToObjects' — Preference to include links to model objects in generated requirements reportsfalse (default) | truePreference 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
'SelectionLinkWord' — Preference to include Microsoft Word selection link option in Requirements context menutrue (default) | falsePreference 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
'SelectionLinkExcel' — Preference to include Microsoft Excel selection link option in Requirements context
menutrue (default) | falsePreference 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
'SelectionLinkDoors' — Preference to include IBM Rational
DOORS selection link option in Requirements context
menutrue (default) | falsePreference to include IBM
Rational
DOORS selection link option in Requirements context menu,
specified as a numeric or logical 1
(true) or 0
(false).
Data Types: logical
'SelectionLinkTag' — Preference for user tags to apply to new selection-based requirements linksPreference for user tags to apply to new selection-based requirements links, specified as a comma-separated list of words or phrases in a character vector. 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) | truePreference to store requirements links data in external
.req 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 documentsfalse (default) | truePreference 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
'CustomSettings' — Preference for storing custom settingsinUse: 0 (default) | structure array of custom field names and settingsPreference 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
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.