Cameo Requirements Modeler

Plugin 2024x Refresh1

User Guide

No Magic, Inc., a Dassault Systèmes company, 2024

All material contained herein is considered proprietary information owned by No Magic, Inc. and is not
to be shared, copied, or reproduced by any means. All information copyright 1998-2024 by No Magic,
Incorporated, a Dassault Systèmes company. All Rights Reserved.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company.

Contents

Introduction 7
Installation, licensing, and system requirements 8
User Guide 8
Getting started 9
Understanding the user interface 10
Creating Requirements Project 44
Opening projects 45
Switching between multiple projects 47
Creating requirements 48
Creating requirements in the Containment tree 49
Creating requirements in the Requirement diagram 49
Creating requirements in the Requirement Table 50
Importing requirements 51
Importing ReqIF files 52
Interchanging of requirements using Cameo DataHub 59
Exporting requirements 60
Changing requirements exporting options 62
Applying automated pre-processing scripts before ReqIF file export 63
Exporting ReqIF files from the command-line interface 63
Relating requirements 66
Relating Requirements in the Requirement Diagram 66
Relating Requirements in the Requirement Matrices 66
Nesting requirements in the Requirements Table 66
Creating Requirement Diagram for sub-requirements 67
Modifying requirement text 67
The Stopping Distance Requirement shape with filled Text property. 68
Editing the requirement text 68
Switching the requirement text to HTML or Plain text 69
Modifying the requirement text 71

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 3

Contents
Customizing requirement properties 76
The ExtendedRequirement [Class] extended by the author property is shown
in the Containment tree and diagram pane. 78
Converting requirements 78
Replacing requirements 78
Requirements numbering 78
Requirements numbering. 79
Analyzing Requirements 79
Coverage analysis 80
Change impact analysis 80
Analyzing dependencies in dependency matrix 80
Analyzing dependencies in relation map 82
Tracing requirements 83
Validation 86
Metrics 125
Using Requirement patterns glossary 126
Enabling/disabling the Requirement patterns underlining in Requirement
text 127
Defining custom condition patterns 127
Opening the predefined requirements glossary table 128
Extracting Constraint from Requirement 129
Creating the Satisfy relationship 129
Extracting Constraint from Requirement 130
Exchanging requirements with ReqIf 131
What is ReqIF? 131
ReqIF Support in MagicDraw 132
ReqIF Importer Features 133
More About ReqIF 135
Generating requirement reports 136
Generating the Word document report 136
Basic requirement concepts 137

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 4

Contents
Diagram descriptions 137
Element descriptions 139
Other descriptions 144
Customizations 144
Specifying project properties 144
Assigning shortcut keys 147
Configuration files 149
Customizing environment options 152
Disabling inbound network activity 190
Most common shortcut keys 191
Setting project options 193

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 5

Purpose

Cameo Requirements Modeler Plugin is dedicated for business analysts and architects, software
engineers, enterprise architects, systems engineers, and other users, who work in model-based
requirements engineering. The plugin supports the requirements part of the OMG SysML standard and
provides means to import, export and manage requirements in the model.

The plugin supports Requirements Interchange Format (ReqIF), the industry standard enabling users to
interchange requirements among different requirements management tools. The standard is managed
by the Object Management Group and supported by major tool vendors.

Model-based requirements engineering benefits

• Easy identification of the scope and potential consequence of any change.

• Single and consistent data source: requirements, processes, and design.
• Increased quality of requirements due to the automatic validation and better visibility.
• Saved time and resources as you are working in the same environment where your models are.
• Improved team communication due to the simple and standard notation, clear diagrams, and
web-based reports.
With this plugin you can

• Import and export requirements to ReqIF files to use them with other requirements
management tools, such as
• IBM DOORS 9.4, 9.5, and 9.6
• IBM DOORS Next Generation
• PTC Integrity
• Polarion REQUIREMENTS
• Siemens Teamcenter
• Dassault Systemes Reqtify.
• Trace from requirements to other model elements of business, software, or systems architecture
and align requirements with your model.
• Analyze the impact of changes.
• Track metrics.
• Capture requirements in dedicated diagrams, matrices, and tables.
• Document requirements.
• Extend the plugin by creating new requirement types and customizing the plugin's functionality.
The Cameo Requirements Modeler Plugin documentation consists of the following sections:

Sorry, the widget is not supported in this export.

But you can reach it using the following URL:

https://www.youtube.com/watch?v=OK_Z7zjJKeg

Docs of other versions

• Cameo Requirements Modeler Plugin 18.4 (see page 6)

• Cameo Requirements Modeler Plugin 18.3 (see page 6)
• Cameo Requirements Modeler Plugin 18.2 (see page 6)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 6

Introduction
Purpose

Cameo Requirements Modeler Plugin is dedicated for business analysts and architects, software
engineers, enterprise architects, systems engineers, and other users, who work in model-based
requirements engineering. The plugin supports the requirements part of the OMG SysML standard and
provides means to import, export and manage requirements in the model.

The plugin supports Requirements Interchange Format (ReqIF), the industry standard enabling users to
interchange requirements among different requirements management tools. The standard is managed
by the Object Management Group and supported by major tool vendors.

Model-based requirements engineering benefits

• Easy identification of the scope and potential consequence of any change.

• Single and consistent data source: requirements, processes, and design.
• Increased quality of requirements due to the automatic validation and better visibility.
• Saved time and resources as you are working in the same environment where your models are.
• Improved team communication due to the simple and standard notation, clear diagrams, and
web-based reports.
With this plugin you can

• Import and export requirements to ReqIF files to use them with other requirements
management tools, such as
• IBM DOORS 9.4, 9.5, and 9.6
• IBM DOORS Next Generation
• PTC Integrity
• Polarion REQUIREMENTS
• Siemens Teamcenter
• Dassault Systemes Reqtify.
• Trace from requirements to other model elements of business, software, or systems architecture
and align requirements with your model.
• Analyze the impact of changes.
• Track metrics.
• Capture requirements in dedicated diagrams, matrices, and tables.
• Document requirements.
• Extend the plugin by creating new requirement types and customizing the plugin's functionality.
The Cameo Requirements Modeler Plugin documentation consists of the following sections:

Sorry, the widget is not supported in this export.

But you can reach it using the following URL:

https://www.youtube.com/watch?v=OK_Z7zjJKeg

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 7

 Sorry, the widget is not supported in this export.
But you can reach it using the following URL:

https://www.youtube.com/watch?v=OK_Z7zjJKeg

Installation, licensing, and system requirements

For information regarding installation, licensing, and system requirements, visit the Installation,
licensing, and system requirements1 page.

User Guide
Welcome to the Cameo Requirements Modeler Plugin user guide! It is intended to assist you with
using this plugin. Please read the sections below or use the Quick Search box to find a specific topic.

• Getting started. (see page 9)

This section presents the basic procedures for using the tool, such as:
• creating a new Requirement project
• specifying options and properties
• customizing the environment, understand the concepts in the user interface
• using the search and filter features
• using the most common shortcut keys
• and others.
• Creating requirements. (see page 48)
This section shows how to create Requirements in the Requirement Diagram and Requirement
Table.

• Importing requirements. (see page 51)

This section describes how to import Requirements from ReqIF, CSV, Excel files, and how to use
Cameo DataHub to interchange them.

• Relating requirements.
(see page 66)This section explains how to create specific relationships between Requirements
(including Derive, Refine, Satisfy, or Verify) directly on the Requirement Diagram pane or in the
Requirement Matrices.

• Creating Requirement Diagram for sub-requirements. (see page 67)

This section demonstrates how to create a new Requirements Diagram for the sub-requirement
that becomes the owner of a new diagram and is marked with the diagram sign.

• Modifying requirement text. (see page 67)

This section presents all procedures for editing and modifying the Requirement text by using the
rich text formatting toolbar, Glossary terms, hyperlinks, and images. It also shows how to switch
the requirement text to HTML or a Plain text format.

• Customizing requirement properties. (see page 76)

This section shows how to create custom properties for the Requirements. It is closely related to
the UML Profiling and DSL Guide2 when trying to extend Requirements with custom properties.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 8

 • Replacing requirements. (see page 78)
This section shows how to use the Refactor command to replace one Requirement with another
one.

• Analyzing Requirements. (see page 79)

This section offers mechanisms (such as Dependency Matrices, Relation Maps, validation,
traceability, metrics, and others) allowing you to analyze Requirements in various formats and
ways.

• Extracting Constraint from Requirement. (see page 129)

This section shows how to use the Extract Constraint From Requirement command for
automatic constraint creation directly from the Requirement text.

• Exporting requirements. (see page 60)

This section describes how to export Requirements to ReqIF files manually, from the command-
line interface, or automatically by applying an automated pre-processing script before ReqIF file
export.

• Generating requirement reports. (see page 136)

This section explains how to generate Requirement reports in the .docx and .html/.htm formats
directly from your model.

• Basic requirement concepts. (see page 137)

This section contains all specific requirement concepts and their descriptions.

Getting started
The Cameo Requirement Modeler Plugin implements the requirements’ part of the OMG SysML
standard that is widely used in systems engineering. All concepts and modeling approaches that are
used in requirements modeling with the plugin come from the requirements’ part of the SysML
standard which can be found at http://www.omgsysml.org3. The SysML requirements’ part provides
clear essential means for the model-based requirements management independently from the system
engineering domain, so it is easy to adopt in every other domain such as software, business, and
enterprise.

The article Requirements Writing in SysML Guide4 presents one of the possible requirements modeling
processes which we adopt internally for the development of all our products.

 To start working with the Cameo Requirement Modeler Plugin, install it (see page 8) in the
MagicDraw tool.
If you use the Cameo Systems Modeler5 or Cameo Enterprise Architecture6 you can start using
requirement features at once.

How to start:

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 9

Understanding the user interface
The user interface is where you will control your software installation. The modeling tool window
contains the following:

• Main menu78
• Main toolbar910
• Model Browser1112
• Diagram toolbar1314
• Diagram palette1516
• Status line1718

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 10

  Watch this demo to get familiar with the modeling tool working environment, main concepts,
and functions.

Sorry, the widget is not supported in this export.

But you can reach it using the following URL:

https://www.youtube.com/watch?v=0B76lH-QtrM&

Main menu
The main menu located at the top of the modeling tool window contains the following elements:

Menu Description
element

File Contains basic project management-related commands, e.g., New Project1920, Open Project2122,
and Save Project2324. Among other actions, this menu also allows you to import data from
external sources, export a project, or print diagrams2526.

Edit Use this menu when working with diagrams on the Diagram pane. The Edit menu contains the
commands for selecting, cutting, copying, and pasting2728 symbols or entire diagrams, and
finding elements in the current project.

View Contains commands allowing you to zoom in or zoom out2930 of a diagram, use and customize a
diagram grid3132, manage diagram tabs (if you have several open diagrams) and customize the
toolbars3334 of your modeling tool.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 11

 Menu Description
element

Layout Use this menu for managing the layout3536 of the symbols on an active diagram. To enable certain
Layout menu commands, you must select more than one symbol.

Diagrams Allows you to create a new diagram3738, access diagram wizards and history, and create a custom
diagram type3940.

Options Use this menu to specify project options4142 and environment options4344, select or customize
perspectives4546, and choose the style for your modeling tool.

Tools Contains the set of commands allowing you to execute model transformations4748 for converting
models between different modeling domains, generate reports4950, evaluate expressions5152 on
the actual testing model, generate code for the selected model data, create and organize
macros5354, access the DataHub plugin5556, and more.

Analyze Use this menu to access the wizards of different types of diagrams5758, create implementation
matrices, analyze and show model dependencies, compare two project versions5960, validate a
project6162, display paths6364 or related elements6566, and perform other model analysis-related
actions.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 12

 Menu Description
element

Collaborat Contains the commands for working with server projects6768.

e

Window Allows you to manage the layout of different windows in your modeling tool.

Help Among other actions, this menu allows opening online documentation, managing resources, and
accessing modeling tool-related information.

 Customizable menus
You can choose which of these menus are shown/hidden by customizing modeling tool
perspectives6970.

Toolbars
Toolbars help to speed up your work when performing commonly used tasks. Your modeling tool has
two types of toolbars:

• Main toolbars - contain commands for basic project-related tasks and are located at the top of
the modeling tool window, right under the main menu.
• Diagram toolbars - contain commands for working with diagram symbols and are located at the
top of the diagram pane.

To show or hide different toolbars

• In the main menu, click View, select either Main Toolbars or Diagram Toolbars, and in the
displayed menu select/clear the check boxes of the toolbars that you want to show/hide.
• Right-click the desired toolbar area and in the shortcut menu select/clear the check boxes of the
toolbars that you want to show/hide.

Customizing toolbars
You can customize existing toolbars by adding or removing buttons and also create new custom
toolbars.

To add a new toolbar

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 13

 1. Do one of the following:
• In the main menu, select View > Main Toolbars/Diagram Toolbars > Customize.
• Right-click the toolbar area, and in the shortcut menu select Customize.
2. In the Customize Toolbars dialog, select the desired toolbar group and click the Add > New
Toolbar.
3. Enter the name of the new toolbar and click OK.

After completing the above steps, a new toolbar is created in the selected toolbar group, and you can
choose to show/hide it in the shortcut menu of the respective toolbar area. Note that the newly created
toolbar does not have any buttons, so you need to add them after creating it.

To add a new button to a toolbar

1. Do one of the following:

• In the main menu, select View > Main Toolbars/Diagram Toolbars > Customize.
• Right-click the toolbar area, and in the shortcut menu select Customize.
2. In the Customize Toolbars dialog, select the desired toolbar and click the Add > Button.

3. In the Add Button dialog, select the desired button or command and click OK.
4. Click OK one more time to close the Customize Toolbars dialog.

A new button is added to the selected toolbar. To add more than one button, repeat steps 2 and 3 as
many times as you need.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 14

To remove a toolbar or button

1. Do one of the following:

• In the main menu, select View > Main Toolbars/Diagram Toolbars > Customize.
• Right-click the toolbar area, and in the shortcut menu select Customize.
2. In the Customize Toolbars dialog, select the toolbar or button you want to remove and click the
Remove button.

After completing the above steps, the selected toolbar or button is removed from the respective
toolbar area or toolbar. Toolbars that have been removed do not appear in the menu for selecting
which toolbars you want to show.

 Restoring default toolbars

To undo all the actions for customizing toolbars, open the Customize Toolbars dialog, as
described in step 1 above, and click the Reset to Defaults button.

On this page

• Customizing toolbars (see page 13)

Model Browser
Model Browser provides a visual representation of the hierarchy of your model elements.

The items in the Model Browser hierarchy can be:

• Compressed – a plus sign next to an icon indicates that the icon is compressed. This is the
default setting. It means that the element contains other model elements. Click the plus sign to
expand the icon and view its subordinate items.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 15

 • Expanded – a minus sign next to an icon indicates that the icon is fully expanded. Click the
minus sign to collapse the item.
If there is no plus or minus sign next to an icon, it does not contain other model elements.

The Model Browser is a hierarchical navigation tool that allows you to manage your model data,
including packages, components, classes, all UML diagrams, extension mechanisms, and other data.
The Model Browser may be used as an alternative tool to the menus and toolbars. It is easier to work
with project diagrams and data elements using the Model Browser.

You can perform the following operations in the Model Browser:

• Create and specify model elements.

• Copy, cut, and paste model elements.
• Delete model elements.
• Drag model elements to the Diagram pane and inside the Model Browser.
• Drag data in the Code engineering sets (you may create data in the root package Model branch,
drag it to the Code Engineering sets, and then the round trip object is created automatically).
• View the hierarchy of all model elements.
• Create a symbol for the selected model element in the current diagram.
• Manage diagrams.
• Manage extension mechanisms, such as constraints, stereotypes, and tagged values.
• Java reverse of a class from the classpath.
• Adjust the code engineering sets.
• Generate code for particular sets.
• Filter visible items by any model type (for example, class, package, operation, component, state,
and others - for both views and dates).
• Sort the visible items of the selected model element.
• Sort all model elements.
• Display search results.
• Display locked elements in the server project.

The Model Browser window has the following tabs:

• Containment tab groups data into logical sets.

• Structure tab represents deeply nested structures of the structured classifier.
• Inheritance tab represents the model hierarchy of the project.
• Diagrams tab groups diagrams according to the diagrams type or shows them as a list.
• Model Extensions tab represents all predefined and created constraints and stereotypes.
• Search Results tab displays search results.

 The Search Results tab is not displayed by default. It appears after you perform the search.
• Lock View tab represents locked elements of the server project.

 The Lock View tab is not displayed by default. It can appear if you are working on a server
project. For more information, see Representation of locked elements7172.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 16

 Related pages

• Understanding the user interface (see page 15)

• Main menu (see page 15)
• Toolbars (see page 15)
• Image Library tab (see page 15)
• Changing interface style (see page 15)

Using the Model Browser

Model Browser is displayed when at least one project is open. By default, the Model Browser is placed
on the left side of the main window. It is possible to move the Model Browser to any place on the
window. Also, all tabs can be viewed separately and you can set up the Model Browser according to
your needs by hiding the desired tabs.

To change the size of either part of the Model Browser

• Drag the bar that separates the two parts.

To zoom the Model Browser

1. Select a tab in the Model Browser.

2. Use one of the following shortcuts:
• For Mac
i. Cmd+Mouse scroll wheel
ii. Cmd+Numpad +/-
• For Windows
i. Ctrl+Mouse scroll wheel
ii. Ctrl+Numpad +/-

To change the Model Browser position

• Using the Options menu

a. From the Options menu, select Environment. The Environment Options dialog opens.
b. Click on the Browser option group.
c. In the Browser environment options pane, change the Browser Position property to
Right or Left.
• Using Toggle
In the upper-right corner of the selected tab in the Model Browser, click the Toggle auto-hide
or Toggle floating button.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 17

  This action changes the layout of the interface.

To close or reopen the desired tab of the Model Browser

• Using the Window menu, choose the Model Browser tab you want to close or open.

To reset all Model Browser tabs to the default position

• From the Window menu, choose the Reset Windows Configuration command.

To sort items in the Model Browser alphabetically

1. From the Options menu, select Environment. The Environment Options dialog opens.
2. Click the Browser option group.
3. In the Browser options pane, set the Sort Alphabetically value to true (the default value is true).

Containment tab
The Containment tab displays model data grouped in logical sets. Using the Containment tab, you can
quickly access each model element, change the model element's specification, or create a new model
element.

To open the Containment tab, do one of the following

• At the top of the Model Browser, click the Containment tab.

• If the Containment tab is hidden, from the Window menu, select Containment.

 You can change some Containment tab properties in the Environment Options
7374
dialog in the Browser options group.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 18

The Containment tab consists of the following two components:

• Containment tab (see page 21)

• Containment tree (see page 22)

1 Example of Containment Tree

The Containment tree includes

• The root package Model (see page 0):

The Relations branch
The UML Standard Profile
The Hyperlinks branch

• Code engineering sets (see page 0)

The root package Model

The root package Model in the Containment tree is the top model element wherein the entire model
structure is created. The root package Model represents the model element that is named Model. All
model elements are stored in the root package Model. You can create the structure of your project by
creating packages in the root package Model. This helps to distribute model elements into logical
groups.

Along with model elements that are created by the user, the root package Model may contain the
following default items:

• The Relations branch. This branch appears when at least one relationship is created in the
project. The Relations branch collects all relationships from the particular owner. For example, if
the Relations branch is in the root package Model, that means, all relationships from the root
package Model are listed in the Relations branch owned by the root package Model. The Relations
branch can exist in other elements which may have inner elements and relations among these
elements. For example, in packages, classes, and others.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 19

 • The UML Standard Profile package. This is a profile that is included in every project. It contains
a list of stereotypes, data types, and other elements from the UML 2 metamodel. By default, the
UML Standard Profile is hidden. To display the UML Standard Profile, click the Options button, and
in the shortcut menu, choose Show Auxiliary Resources.

.
There can be more standard profiles (such as SysML, UPDM, Java, and others).

 We highly recommend not to modify our provided standard profiles and libraries as it
could cause problems with version updates, plugins, core modeling tool malfunctions,
and model corruptions.

• The File View package. This package appears when at least one code engineering set is created.
The File View package contains components that are created on code reverse and represents
source files.
• The Hyperlinks branch. This branch appears when at least one hyperlink is added to a
particular element. The Hyperlinks branch contains the list of hyperlinks to the file, element/
symbol, or web page.

Code engineering sets

 Code engineering is available in Professional, Architect, and Enterprise editions.

Code engineering sets can be considered a gateway between your source code and model data. Using
these sets, you can perform Java, C++, IDL, CORBA IDL, and EJB 2.0 round-trip code engineering, that is,
code generation and reverse engineering.

To display Code engineering sets

• In the Containment tab toolbar, click the Options button, then click to select the Show
Code Engineering Sets check box.
In the Code engineering Set branch, you can create a new code engineering set, generate code, and
perform other actions.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 20

 Containment tab toolbar

The Containment tab toolbar contains the following buttons:

Button Tooltip text Description

Collapse All Collapses all of the currently expanded elements in

the Containment tree.

Collapse Selected Recursively Collapses only selected node and all subnodes in that
node.

Open in New Tree Opens the contents of the selected element in a new
tab of the Model Browser. The selected element
becomes the root node of the new tree.

You can choose to open elements in:

• New Containment Tree

• New Structure Tree
• New Inheritance Tree

Favorites Opens the Favorites menu for choosing to do one of

the following:

• Add a selected element to favorites

• Open the dialog for managing favorites
• Navigate to a desired favorite in the
Containment tree

Quick Find Opens the Quick Find dialog.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 21

 Options Click to open the Options menu and then select:

• Filter - opens the Select Element Type

dialog wherein you can select element
types to be visible in the Containment
tree. Learn more on the Filtering7576
page.
• Show Auxiliary Resources - shows or
hides modules and profiles that are used
in your project.
• Show Applied Stereotypes - shows or
hides the applied stereotypes next to the
element name in the Containment tree.
• Show Full Types - shows or hides the full
types of typed elements (for example,
operations, attributes, relationships, and
other) in the Containment tree.
• Show Code Engineering Sets - shows or
hides the code engineering sets.

The same actions you may perform using the shortcut menu of the Containment tree.

Working with model elements in the Containment tree

You can work with elements in the Containment tree using the commands available from the selected
element's shortcut menu.

 Particular actions are available for particular elements.

The shortcut menu contains the following commands:

Command Function

Create Element7778 Creates a new element inside the selected element.

 This command is available if the selected element can be

edited.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 22

 Create Diagram7980 Creates a new diagram inside the selected element.

 This command is available if the selected element can be

edited.

Create Relation > Creates a new relation to or from the selected element.
Outgoing / Incoming8182

Specification8384 Opens the element Specification window wherein you can specify
various element properties.

Validation8586 Open the validation commands for checking the accuracy,

completeness, and correctness of a model.

Go To8788 Opens or selects the item associated with the selected element. The
item may be a diagram, model element, or hyperlink.

Refactor8990 Converts the selected element to the element indicated by a user.

Related Elements9192 Opens a list of functions available for the selected element.

Tools Opens a list of tools that are available for the selected element.
Depends on the selected element.

Stereotype9394 Opens the drop-down list, wherein you can apply an existing
stereotype, or create a new one.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 23

 Find9596 Opens the Find dialog.

Apply Profiles Opens the list of the available to apply profiles.

 • This command is available in the package, model,

and system boundary shortcut menu.
• Only custom profiles can be applied.
• To see this command you have to expand the
shortcut menu, that is, click on the little arrow at
the bottom of the shortcut menu.

Project Usages9798 Opens share packages and export packages to new project
commands.

 This command is available in the package and model

shortcut menu.

Generate Code Generates code for the selected item. Opens the Notification
Framework Window with the information.

Check Syntax Checks syntax in the model according to the default code
engineering language. Opens the Notification Window with the
information.

Generate Report99100 Opens the list of the available report templates.

Reverse from Classpath This command is available in the Class shortcut menu.

Structure tab
On this page

• The Structure tab in the Model Browser. (see page 0)

• Opening the Structure tab (see page 0)
• Displaying Inherited Structure option (see page 0)
• Nesting Satisfied Requirements option (see page 0)
• Structure tab toolbar (see page 0)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 24

Inheritance tab
The Inheritance tab represents classifiers (e.g., packages, data types, and stereotypes) hierarchy within
your project. Inheritance according to the UML Specification is shown using the generalization
relationship.

 If a model element has no generalization relationship, it will not be represented in the

Inheritance tab.

To open a new Inheritance tree

1. Open the Containment, Structure, or Inheritance tab.

2. In the open tab toolbar, click and then select Open in New Inheritance Tree.

101102
 You can change some Inheritance tab properties in the Environment Options dialog in
the Browser options group.

The Inheritance tab consists of the following two components:

• Inheritance tab toolbar

• Inheritance tree

Inheritance tab toolbar

The Inheritance tab toolbar contains the following buttons

Button Tooltip text Description

Collapse All Collapses all currently expanded elements in the

Containment tree.

Collapse Selected Recursively Collapses only selected node and all subnodes in that
node.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 25

 Open in New Tree Opens the contents of the selected element in a new
tab of the Model Browser. The selected element
becomes the root node of the new tree.

You can choose to open elements in:

• New Containment Tree

• New Structure Tree
• New Inheritance Tree

Favorites Opens the Favorites menu for choosing to do one of

the following:

• Add a selected element to favorites

• Open the dialog for managing favorites
• Navigate to a desired favorite in the
Containment tree

Quick Find Opens the Quick Find dialog.

Options Click to open the Options menu and then select:

• Invert Tree - inverts the tree hierarchy -

shows the child
element at the top of the hierarchy.
• Show Applied Stereotypes - shows or
hides the applied
stereotypes next to the element name in
the Containment tree.

Working with model elements in the Inheritance tree

You can work with elements in the Inheritance tree using the commands available from the selected
element's shortcut menu. The shortcut menu contains the following commands:

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 26

 Command Function

Select in Containment Tree Opens the Containment tab and selects the
current element in the Containment tree.

Select in Structure Tree Opens the Structure tab and the structured classifier is selected.

 This command is available for structured classifiers (SysML).

Diagrams tab
The Diagrams tab in the Model Browser represents diagrams created in your project.

In the Diagrams tab, diagrams are by default grouped by their types (see the image above).

To open the Diagrams tab, do one of the following

• At the top of the Model Browser, click the Diagrams tab.

• If the Diagrams tab is hidden, from the Window menu, select Diagrams.

103104
 You can change some Diagrams tab properties in the Environment Options dialog
in the Browser options group.

The Diagrams tab consists of the following two components:

• Diagrams tab toolbar

• Diagrams tree

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 27

 Diagrams tab toolbar
The Diagrams tab toolbar contains the following button:

Butt Tooltip text Description

on

Collapse All Collapses all of the current elements in the Containment tree.

Collapse Selected Collapses only the selected node and all subnodes in that node.
Recursively

Group by Diagram Groups diagrams into packages by the first symbol of their name when the
Name model contains more than 99 diagrams.

Favorites Opens the Favorites menu for choosing

to do one of the following:

• Add a selected element to favorites

• Open the dialog for managing favorites
• Navigate to a desired favorite in the Containment tree

Quick Find Opens the Quick Find dialog.

Some of these actions may be performed right in the shortcut menu of the Diagrams tree.

Working with model elements in the Diagrams tree

You can work with diagrams in the Diagrams tree using the commands available in the selected
diagram's shortcut menu. These are the commonly used commands:

Command Function

Open Opens the selected diagram.

Print Opens the Print dialog.

 Active for the open diagram only.

Select in Containment Opens the Containment tab and selects the current element in the Containment
Tree tree.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 28

 Group by Diagram Name Groups diagrams into packages by the first symbol of their name when the model
contains more than 99 diagrams.

Model Extensions tab

The Model Extensions tab contains all Stereotypes that are predefined and created manually in the
project. In this tree, you can create, review, copy/paste, and delete extension mechanisms.

2 Model Extensions tab

To open the Model Extensions tab, do one of the following

• At the top of the Model Browser, click the Model Extensions tab.
• If the Model Extensions tab is hidden, from the Window menu, select Model Extensions

 You can change some Model Extensions tab properties in the Environment Options
105106
dialog in the Browser options group.

Model Extensions tab consists of the following two components:

• Model Extensions tab toolbar

• Model Extensions tree

Model Extensions tab toolbar

Model Extensions tab toolbar contains the following buttons:

Button Tooltip text Description

Collapse All Collapses all of the current elements in the

Containment tree.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 29

 Collapse Selected Recursively Collapses only selected node and all subnodes
in that node.

Group by Profiles Groups extensions by the profiles.

Group by Metaclasses Groups extensions by the metaclasses.

Favorites Opens the Favorites menu for choosing to do

one of the following:

• Add a selected element to favorites

• Open the dialog for managing
favorites
• Navigate to a desired favorite in the
Containment tree

Quick Find Opens the Quick Find dialog.

The same actions you may perform using the shortcut menu of the Model Extensions tree.

Working with model elements in the Model Extensions tree

You can work with elements in the Model Extension tree using the commands available from the
selected element's shortcut menu.

 For more information about commands available from the shortcut menu in the Model
107108
Browser, see Working with model elements in the Model Browser .

Search Results tab

The Search Results tab is used to display search results. This tab opens only after performing the
search109110 by pressing Ctrl+Shift+F, or by clicking Edit > Find.

The tab is not displayed when performing a Quick Find111112.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 30

3 Search Results tab

The Search Results tab consists of two components:

• Search Results tab toolbar (see page 0)

• Search Results tree (see page 0)

Search Results tab toolbar

The Search Results tab toolbars contains the following buttons:

Button Tooltip text Description

Collapse All Collapses all of the current elements in the

Containment tree.

Collapse Selected Recursively Collapses only selected node and all subnodes in that
node.

Find... Opens the Find dialog.

Clear Results Clears the results of the previous search.

Rerun Search Reruns a search with the already specified search

criteria. Search results are updated according to
changes done in the model.

Save Search Results Saves as a smart package either the search options or
the search results.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 31

 Favorites Opens the Favorites menu for choosing to do one of
the following:

• Add a selected element to favorites

• Open the dialog for managing favorites
• Navigate to a desired favorite in the
Containment tree

Options Click to open the Options menu and then select:

• Show Applied Stereotypes - shows or

hides the applied stereotypes next to the
element name in the Containment tree.
• Show Full Types - shows or hides the full
types of typed elements (for example,
operations, attributes, relationships, and
other) in the Containment tree.

 The same actions you may perform using the shortcut menu of the Search Results tree. For
more information about commands available from the shortcut menu in the Model Browser,
see Working with model elements in the Model Browser113114.

Working with model elements in the Search Results tree

The search results in the Search Results tree are displayed in the following two packages:

• Found in loaded diagrams – symbols that have been found in the diagram(s) are displayed in
this package.
• Found in model – elements that have been found in the model data are displayed in this
package.

Lock View tab

115116
 The Lock View tab is displayed only when working with server projects .

The Lock View tab is used to display what was locked in the project (locked elements, project structure,
symbol styles) and by which users. Next to the locked element, you can see the name of the user who
has locked it. Using the Filter by user list in the Lock View tab toolbar, you can see the elements, locked
by the particular user.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 32

4 Lock View tab

To open the Lock View tab, do one of the following

• At the top of the Model Browser, click the Lock View tab.
• If the Containment tab is hidden, from the Window menu, select Lock View.
The Locked Elements tab consists of the following two components:

• Lock View tab toolbar

• Lock View tree

Lock View tab toolbar

The Lock View tab toolbar contains the following:

• Update Lock Information button

• Filter by user list
• Collapse All button
• Collapse Selected Recursively button

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 33

5 Filter by user list

Using the Filter by user list you can select to display only the elements locked by the particular user.

Working with model elements in the Lock View tree

You can work with elements in the Lock View tree using the commands available from the selected
element's shortcut menu. The shortcut menu contains the following commands:

Command Function

Lock Locks or unlocks the particular element for edit.

Select in Containment Opens the Containment tab and selects the

Tree current element in the Containment tree.

Select in Inheritance Opens the Inheritance tab and selects

Tree the current element in the Inheritance tree.

On this page

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 34

 • Lock View tab toolbar (see page 33)
• Working with model elements in the Lock View tree (see page 34)

Related pages

• Model Browser (see page 32)

• Using the Model Browser (see page 32)
• Containment tab (see page 32)
• Structure tab (see page 32)
• Diagrams tab (see page 32)
• Documentation tab (see page 32)
• Inheritance tab (see page 32)
• Model Extensions tab (see page 32)
• Properties tab (see page 32)
• Search Results tab (see page 32)
• Working with model elements in the Model Browser (see page 32)
• Zoom tab (see page 32)

Zoom tab
The Zoom tab enables you to preview a selected diagram. To select a diagram, go to the Containment
or Diagram tab. You can also use the Zoom tab to zoom in or out of the active diagram.

6 Zoom tab

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 35

 The Zoom tab in the quick properties panel.
To open the Zoom tab, do one of the following

• In the Model Browser, click the Zoom tab.

• On the Window menu, click Zoom.

To zoom in or out of the active diagram

• In the Zoom tab, drag the corners of the blue square.

To quickly access any part of the diagram

• In the Zoom tab, drag the blue square to the desired part of the diagram.
The selected diagram part will be displayed on the diagram pane.

To fit the diagram to the window

• In the Zoom tab, on the blue square , click the Fit in Window button or press CTRL+W.

To show the Diagram Zoom Slider

1. From the Options menu, select Environment. The Environment Options window opens.
2. Select the General options group > Display.
3. In the Display category, select the Show Diagram Zoom Slider check box.
The Diagram Zoom Slider is displayed in the Zoom tab (see the figure above).

Documentation tab
The Documentation tab shows information associated with a selected model element in the Model
Browser or on a diagram pane.

7 Documentation tab

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 36

 The Documentation tab in the quick properties panel.
To open the Documentation tab, do one of the following

• In the Model Browser, click the Documentation tab.

• On the Window menu, click Documentation.

 If there is no documentation for the selected element, the text area is empty.

To write documentation for the selected model element

• In the Documentation tab, click the text area and type the text.

To turn on the HTML text

• In the Documentation tab, click the HTML check box.

The HTML toolbar opens and you can type the HTML text.

Properties tab
The Properties tab at the bottom of the Model Browser allows you to quickly access basic information
about a selected element or diagram.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 37

 An example of the Properties tab in the Quick properties panel

 Multiple selection
• If multiple elements or symbols of different kinds are selected, only their common
properties are displayed in the Properties tab.
• If more than 10 elements in the Containment tree or symbols on the diagram pane are
selected, properties are displayed only by request. You need to click the link Show
common properties for the selected items.

To open the Properties tab, do one of the following

• In the Model Browser, click the Properties tab.

• On the Window menu, click Properties.

The Properties tab includes the following tabs:

Tab name Description

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 38

 Element Contains the main properties of the element's or diagram's
specification.

Symbol Contains the element symbol's properties.

 This tab is available for symbols only.

Tags Contains the tagged values of the selected element.

When you click the Show Only Applied Stereotypes Tags button,
only the tabs with values are listed.

Language properties Contains the same data as the Language Properties property
group in the element's Specification window.

 This tab is available only for the elements used for code
generation, that is, class, attribute, and operation.

Traceability Contains the same data as the Traceability property group in the
element's Specification window.

Working with model elements in the Model Browser

In the Model Browser, you can do the various actions with model elements, such as rename, cut, copy,
delete, and others. These actions are available from the particular model element shortcut menu. See
the list of concrete actions in the following table.

Command Function

Rename Switches the element name into the edit mode.

You can also press F2 for this.

Copy Copies the selected element.

Copy URL Copies a model element URL to a

clipboard.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 39

 Copy Element Hyperlink Copies the hyperlink of the selected element.

Cut Cuts the selected element.

Paste Pastes the copied element.

Delete Deletes the selected element.

To copy/cut and paste the selected model element between different projects

1. Select the model element in the Model Browser.

2. From the model element shortcut menu, select Copy or Cut.
3. Open the project to which you want to paste the selected element(s).
4. Select the container, where you wish to paste the element(s).
5. From the container's shortcut menu, select Paste.

To change the location of an element in the Model Browser

1. Select the element in the Model Browser.

2. Drag it to the new location (possible owner).

Image Library tab

The Image Library tab displays images grouped in logical sets. You can use a bundled image collection
or add your own set of images.

To open the Image Library tab

• From the Window menu, select Image Library.

The Image Library tab opens on the right side of the window.

To add your own set of images into Image Library, do either

• Compress a folder (.zip) with a set of desired images and place it in the modeling tool's
installation directory: \data\imagelibraries\commonsymbols.

 Image formats
You can add images of the following formats: .gif, .jpg, .jpeg, .svg, .png, .wmf.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 40

 • Create an Image Library plugin. See the Writing plugins (see page 40) page.

Using the Image Library tab, you can apply an image on symbol117118.

8 Image Library tab

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 41

The Image Library tab consist of three components:

• Quick filter (see page 42)

• Image Library tree (see page 42)
• Image Library Preview area (see page 42)

Quick filter
You can search for images in the Whole hierarchy or Recently used tabs using one of the following
way:

• Simple Search: type what you want to find in the hierarchy.

• Pattern Search: type * to find any image.

 For example, type "*Bank" if you want to find "Bank" somewhere in the hierarchy.

Image Library tree

You can drag an image from the Image Library tree directly:

• On the symbol (image is applied for symbol).

• To the diagram pane (image shape is created).

Image Library Preview area

You can preview the image before applying it on the symbol in the Image Library Preview area.

Changing interface style

You can change the appearance of your modeling tool windows, dialogs, and menus. The Look and
Feel menu allows you to personalize the user interface using a number of predefined styles and
themes. You can also create a custom theme with your favorite colors and fonts.

To change the interface style

1. In the main menu of a modeling tool, select Options > Look and Feel.
2. Select the desired style from the list of available styles.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 42

 The Look and Feel menu options.

 Important
• The selected style may not look exactly like the style in related operating systems.
• Depending on your operating system, some style options may be unavailable.

Creating a custom theme

Define your own interface style by creating a custom theme. The Custom theme option is located in the
Look and Feel Themes submenu which also offers 8 predefined themes. The Custom theme allows
you to specify text fonts and sizes of the desired interface elements as well as their colors.

To create a custom theme

1. In the main menu of a modeling tool, select Options > Look and Feel > Metal.
2. In the same menu, select Options > Look and Feel > Look and Feel Themes > Custom.
3. In the open dialog, change the values of the desired style properties.
4. Click OK.

 Look and Feel Themes

The themes listed in the Look and Feel Themes submenu are only available if you select the
Metal style.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 43

Creating Requirements Project
You can create requirements using the the Requirements Project template. It contains predefined
packages, elements, and diagrams to start creating your own requirements in the model.

 The Requirements Project template is only available in MagicDraw with Cameo Requirement
Modeler Plugin installed.

To create a Requirement Project

1. Open the New Project dialog. Do one of the following:

• From the File menu, select New Project.
• On the main toolbar, click the New Project button.
• Press Ctrl + Shift + N.
2. In the New Project dialog, specify the following:
• On the left side of the dialog, under the General-Purpose Modeling domain, select the
Requirements Project.
• On the right side of the dialog, type the file name in the Name box.
• On the right side of the dialog, click the

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 44

 button and select the location to store the created project.

3. Click OK.
The new Requirement project is created with predefined structure as shown in the image below.

Related pages

• Working with projects119

Opening projects

 The native modeling tool format is *.mdzip and *.mdxml.

Opening previously created projects

To edit or review previously created projects, do one of the following

• From the File menu, select Open Project. In the Open dialog, select the project and click Open.
• On the main toolbar, click the Open Project button.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 45

 • Drag the project from the open window of your file system to the modeling tool. The project
opens immediately.
• Double-click the project file with the *.mdxml or *.mdzip extension. A new modeling tool window
opens.

 To start the modeling tool with the last project you worked on, select Options > Environment
> General > Save/Load and set the Open Last Project on Startup option to true.

XMI 2.4 / UML 2.4 is the main file format, used by the modeling tool for storing models. This format
does not specify how to store diagrams, so the modeling tool stores and opens diagram data in XMI
extension sections. Thus if you use the modeling tool to open an XMI file exported from another UML
tool, only the model will be opened, but not the diagrams or views.
Accordingly, if you open a modeling tool file in another UML tool, diagrams or views will not be opened
in that tool (unless the tool supports MagicDraw-specific file extensions).
You may open more than one project within the same modeling tool window. A separate workspace
will be created for each opened project.

Opening projects saved with modeling tool 17.0 or earlier

Projects saved with modeling tool 17.0 or earlier can be as well opened with modeling tool of later
versions.
To update older models, simply open them with modeling tool of later versions and then re-save them.
Models will be automatically converted to the latest format.
In case your model is stored in a project that uses other projects, you should open and re-save the used
projects first and only then do the same with the main project. Be advised that having only the used
projects successfully converted to the latest format, you may expect the smooth conversion of the
project that uses them.

If you convert only the project and leave the used projects saved in an old format, you will not be able

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 46

to modify the projects used in the read-write accessibility mode.

Related pages

• Working with projects120

Switching between multiple projects

You may need to manage several projects at the same time, and the modeling tool allows you to do
that easily. All open projects are held in separate workspaces. Different active projects may exchange
data. Entities from one project can be copied or moved to another.

To switch between open projects, do one of the following

• From File menu, select Switch Projects and then click the name of the project you want to
switch to.
• On the main toolbar, click and then select the name of the project you want to switch to.

To close all open projects

• Select Close All Projects from the File menu. The Question message appears.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 47

9 Question message

Choose the way your projects will be closed:

Yes The project you are currently closing will be saved (its name appears in the question). The dialog is
displayed again when the next project closes.

Yes To Save all projects without prompting. The Save dialog will not appear for each open project.
All

No Project you are currently closing will not be saved.

The dialog is displayed again when the next project closes.

No To All All the projects will be closed without saving or further prompting.

Cancel Cancel saving projects.

To exchange model elements between open projects

• Use the Cut, Copy, and Paste commands from the Edit menu or the selected element's
shortcut menu, or the appropriate shortcut keys: Ctrl + X, Ctrl + C, Ctrl + V.

Creating requirements
• Creating requirements in the Containment tree (see page 49)
• Creating requirements in the Requirement diagram (see page 49)
• Creating requirements in the Requirement Table (see page 50)
• Creating a new Requirements (see page 50)
• Adding existing Requirements (see page 50)
• Adding nested Requirements (see page 50)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 48

You can create and represent text-based requirements and relate them to other modeling elements.
The requirements can be depicted in graphical, tabular, or tree structure format. This page provides
instructions for creating requirements in the model. You can create requirements in the:

• Containment tree. (see page 49)

• Requirement Diagram (see page 49).
• Requirement Table (see page 50).

Creating requirements in the Containment tree

If you create Requirements in the Containment tree, the element is created in the Model Browser (see
page 48). After that you can represent them on the diagram pane (see page 48) by dragging them or in the
Requirement Table (see page 48) by adding an existing element.

To create requirements in the Containment tree

1. Open an existing or create a new Requirement Diagram. How to create a new diagram >121
2. In the Containment tree (see page 48), right-click the package, or another Requirement where you
want to create or nest a new Requirement.
3. From the shortcut menu, click Create Element.
4. In the Create Element dialog, select any type of Requirement.

 If you have created your own custom Requirement types, they appear under the Custom
Requirements group.

5. Type a Requirement name.

The new requirement is created in the Model Browser.

Creating requirements in the Requirement diagram

If you create Requirements directly on the diagram pane, the element is created in the Model
Browser (see page 48) as well.

To create Requirements on the Requirement Diagram pane

1. Open an existing or create a new Requirement Diagram. How to create a new diagram >122
2. On the diagram pallet (see page 48), select a Requirement or other type of requirement button
and click on the diagram pane.

 The element is created in the same package where the diagram is stored.
3. On the Requirement shape, type a name, ID, and description.
The Requirement is created and added in the table.

123
 You can find more information about how to work in diagrams on the page Diagramming .

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 49

  To select a different owner
1. Hold Shift, click Add New button, and select a Requirement type from the drop-down menu.
The Select Owner dialog opens, enabling you to choose a different owner.

Creating requirements in the Requirement Table

You can create new, nested requirements, or add existing ones in the Requirement Table.

Creating a new Requirements

To create a new Requirement in a Requirement Table

1. Open an existing or create a new Requirement Table. How to create a table >124
2. On the Requirement table toolbar, click the Add New button or press Insert (Ctrl+I for Mac
users). The list of Requirement types opens.
3. Click a desired requirement type. A new line above the first numbered requirement appears.
4. In that empty line, type a requirement name and specify other requirement properties.

 To select a different owner

1. Hold Shift, click Add New button, and select a Requirement type from the drop-down
menu.
The Select Owner dialog opens, enabling you to choose a different owner.

Adding existing Requirements

To add existing Requirements in a Requirement Table

1. Open an existing or create a new Requirement Table. How to create a table >125
2. Do one of the following:
• On the Requirement table toolbar, click the Add Existing button or press Ctrl + Insert
(Ctrl+I for Mac users). In the Select Requirement dialog, select the requirements you
want to represent in the table and click OK.
• Drag the entire requirements Package from the Containment tree (see page 48) and drop it
on the empty Requirement table to represent all its content in the table.

Adding nested Requirements

To add nested Requirement in the Requirement Table

1. Select Requirement you want to nest in the table.

2. Click the Add Nested button or press Alt+Insert (Alt+I for Mac users).
3. Select the desired Requirement type from the drop-down menu.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 50

  If you have created your own custom Requirement types, they appear under the Custom
Requirements group in the drop-down menu.

 More information about

126
how to work in tables you can find in the following pages:
• Table toolbars
• Table Criteria area127
• Basic tasks in tables128

Related pages

• Creating diagrams129
• Opening diagrams130
• Dragging objects131
• Relating requirements (see page 66)
• Table toolbars132
• Table Criteria area133
• Basic tasks in tables134

Importing requirements

 It is recommended that you import requirements into a separate 135

project which can be used in
other models as a used project. How to manage used projects >>

You can import requirements in one of the following ways:

• By importing ReqIF files. (see page 52)

• By syncing Excel or CSV files with Requirement table.136
• By importing data from Excel or CSV file.137
• By pasting into Requirement table.138
• By pasting into Requirements diagram, or Containment tree.139
• Using Cameo DataHub. (see page 59)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 51

Related pages

Importing ReqIF files

• Importing ReqIF files (see page 52)
• Changing requirements importing options (see page 54)
• Updating requirements (see page 55)
• Managing obsolete requirement elements (see page 56)

Importing ReqIF files

You can import ReqIF files from:

• IBM DOORS 9.4, 9.5, and 9.6

• IBM DOORS Next Generation
• PTC Integrity
• Polarion REQUIREMENTS
• Siemens Teamcenter
• Dassault Systemes Reqtify

 You can import any ReqIF file – with or without specifications.

To import a ReqIF requirement file

1. Open a project wherein you want to import requirements.

2. From the File menu, select Import From > Requirement Interchange Format (ReqIF) File.
3. In the opened Load dialog, browse for your ReqIF file and click Open.
4. The ReqIF file is imported.

 If Requirements in the ReqIF file have ID prefixes, they are set automatically after import only
for imported Requirements. Manage ID prefixes when numbering Requirements (see page 52).

Sorry, the widget is not supported in this export.

But you can reach it using the following URL:

https://www.youtube.com/watch?v=w12dprJkT_0

When the ReqIF file is imported, a notification message appears, stating the quantity of imported or
updated elements. If you import a ReqIF file without specification, the message doesn't contain the line
that indicates new or updated specifications. You also see no option Show imported specification
table(s).

If you imported a ReqIF file with the specification, you can view the list of imported elements. To do

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 52

that, click the Show imported specification table(s) link in the opened notification message. The list is
displayed in a generic table format.

To change import options, click the You can change import and mapping options here link in the
opened notification message.

 The notification message is displayed for a fixed duration, but you can find all project
notification messages in the Notification Window. To open the Notification Window, click
Window > Notification Window, or press Ctrl + M.

Imported requirements are presented in the Containment tree. The requirement specification is
represented as a model package and requirements are represented as model elements.

If there are images or files attached to the ReqIF file, they are marked with the «AttachedFile»
stereotype and placed in a separate package as model elements after the import.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 53

  All images in the BMP file format are automatically converted to the PNG format.

 If there are any deleted elements in the source file, they are automatically marked with the
«deprecated» stereotype once imported onto the modeling tool.

Changing requirements importing options

Changing requirements importing options is beneficial if you have a custom requirement type defined,
or you are importing another type of data instead of requirements, for example, test cases.

 A requirement type is limited to class and class extended types.

You can change the following import options:

• Specify an element type to create for the objects you are importing
• Specify a relationship type to create for the relationships you are importing
• Specify a path to the resource location
• Choose whether to import all properties into the model or not and form a list of ignored and not
imported properties

To change ReqIF file importing options

 We recommend changing importing options before requirements are imported and no

changes are made in the project, because after you have changed importing options, you need
to remove the requirements you have imported and re-import it.

1. Click Options > Project. The Project Options dialog opens.

2. In the options group list, select General, then scroll down to the ReqIF options group.
3. Click a desired option specification cell to change it's value.
4. Click OK after you are finished.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 54

Updating requirements

It is common to modify requirements after importing them. Importing requirements in a ReqIF format
allows updating the requirements present in the model without any data loss – all changes are
identified.

To update ReqIF file by importing a new file

1. Open a project wherein you want to update requirements.

2. Import a ReqIF file with updated requirements.

To update requirements from the project

1. Open the project containing imported requirements.

2. In the Containment tree, select a requirement specification package and open it's shortcut
menu.
3. Click Tools > ReqIF > Update From Requirements Interchange Format (ReqIF) File.
4. In the opened Load dialog, browse for your ReqIF file and click Open. The ReqIF file is updated.
After requirements have been updated, you get a notification message informing about an update
status. If you update a ReqIF file without specification, the message doesn't contain the line that
indicates new or updated specifications. You also see no option Show imported specification table(s).

In the change log table, you can see the detailed list of updated elements.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 55

During update, no elements are removed, only new elements are added and statuses of all elements
are updated. Elements not present in an updated ReqIF file are marked as obsolete.

Managing obsolete requirement elements

In the model, obsolete elements are marked with an exclamation mark in a yellow triangle. A
«deprecated» stereotype is applied to such requirement elements automatically.

Removing Obsolete Elements

In the project, you can choose to remove only the selected obsolete element or all obsolete elements at
a time. To remove one selected obsolete element, use the validating procedure (see page 0) that is
described in the following section.

To remove all obsolete elements

1. In the Containment tree, right-click the requirements specification package.

2. From the shortcut menu, select Tools > ReqIF > Remove Obsolete Elements.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 56

Searching for obsolete elements

To search for obsolete elements

1. In the Containment tree, right-click the requirements specification package.

2. From the shortcut menu, select Validation > Obsolete Elements and one of the following:
• Remove Obsolete Elements – removes the selected obsolete elements from a project
• Ignore – ignores obsolescence from the element and leaves it in the model
• Select in Validation Results – opens the Active Validation Results panel wherein you
can perform appropriate validation actions.

Related pages

Applying automated post-processing scripts after ReqIF file import

After the ReqIF file import, you can apply an automated post-processing script to your project in order
to modify requirements and create custom mapping upon requirements interchange through ReqIF.

 In order to see the scripts and execute them, you must be using ReqIF Profile. To set the
profile, go to File > Use Project, then scroll to select ReqIF Profile.mdzip and click Finish.

To apply the post-processing rules

1. From the Options menu, select Project.

2. In the options group list, select General, then scroll down to the ReqIF options group.
3. Under the ReqIF Import category, find Post-processing rules and select the one you want to
apply.
4. Click OK.

Post-processing Rule Description

Fill Empty Requirement Name When applied to a requirement with an unspecified Name
property, the rule picks the data from Element ID and uses
it as the element name.

Set CustomID as ID When applied to a requirement with an empty Element ID,

the rule sets the specified CustomID as an element ID.

Importing ReqIF files from the command-line interface

Importing from the command-line interface is useful when you want to import files automatically, e.g.,
once a day at midnight.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 57

To import a ReqIF file from the command-line interface

1. Open the Command Prompt window

2. Go to the <model editor installation directory>/plugins/com.nomagic.requirements directory
containing the reqifimport.exe file.
3. At the command prompt, type the following command and specify the values of the required
arguments:
reqifimport project_descriptor=<project URL> reqif_file=<path to ReqIF
file> owner=<element hyperlink or qualified name>
Where:
• project_descriptor is the URL of a project.
How to get a project descriptor?

i. Start your modeling tool and open the required project.

ii. In the main menu, go to File > Project Properties and select the General tab.
iii. Find the project descriptor specified in the Project Descriptor box at the bottom
of the Project Properties dialog and copy it to the clipboard.
• reqif_file is the path to the ReqIF file you want to import.

 If there is a space in a path, surround the argument and its value with escaped
quote (\").

• owner is the hyperlink or qualified name of the owner element. If newly imported
elements are not contained by the Specification element, they are placed under the
specified owner. Note that the owner argument is optional.
How to get the hyperlink of an element?

i. Start your modeling tool and open the required project.

ii. In the Containment tree, right-click an element and select Copy Element
Hyperlink.
The hyperlink of the element is now copied to the clipboard.

4. Press Enter.
Now after opening the project you have imported the ReqIF file into, the imported data is already
present in the Containment tree of the project.

Using a properties file

To make importing from the command-line interface quicker you can specify arguments in a properties
file, which can be easily edited or reused.

To import a ReqIF file from the command-line interface using a properties file

1. Create a properties file and specify the values of the following arguments:
• project_descriptor
• reqif_file
• owner

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 58

 See the example of a properties file below.

1 project_descriptor=file:/C:/Users/johnsmith/Downloads/MagicDraw_185/
samples/requirements/MagicLibrary%20requirements.mdzip
2 #
3 # Specify the project URL.
4 # To get a project descriptor, open a project and in the main menu
go to File > Project Properties > General.
5 #
6 reqif_file=C:/Users/johnsmith/Documents/project_requirements.reqif
7 #
8 # Specify the path to the ReqIF file.
9 # NOTE: If there is a space in a path, surround the argument and its
value with escaped quote (\").
10 #
11 owner=mdel://eee_1045467100313_135436_1
12 #
13 # Specify the hyperlink or qualified name of the owner element.
14 # To get the hyperlink of an element, open a project, right-click
the element in the Containment tree and select "Copy Element
Hyperlink".
15 # NOTE: This argument is optional.
16 #

 When creating a properties file on Windows OS, use only / or \\ as a path separator,
otherwise the command will fail.

2. Open the Command Prompt window.

3. Go to the <model editor installation directory>/plugins/com.nomagic.requirements directory
containing the reqifimport.exe file.
4. At the command prompt, type the following command and specify the value of the
properties_file argument.
reqifimport properties_file=<path to properties file>
Where properties_file is the path to the properties file to be used.

5. Press Enter.

Now after opening the project you have imported the ReqIF file into, the imported data is already
present in the Containment tree of the project.

Interchanging of requirements using Cameo DataHub

The Cameo DataHub is a dedicated solution for the requirements synchronization between different
sources, such as MagicDraw, Rational DOORS®, CSV files, and other. Cameo DataHub is a data bridge
that allows for data importing and exporting, automatic synchronization and creation of references
between requirements and other artifacts. It allows to use different import and synchronization
methods while importing or exporting requirements.

Came DataHub allows to:

• Associate and synchronize data.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 59

 • Change the monitoring statuses such as active, pending update, and pending delete whenever
associated data items are modified or deleted.
• Impact monitoring. Whenever the referenced data item changes, Cameo DataHub reports the
suspect status to direct traceability from each requirement to the respective design artifact.
• Define mappings between data and its’ properties.

 The Cameo DataHub must be installed before taking the following actions. How to install
Cameo DataHub > (see page 59)

To interchange of requirements using Cameo DataHub

1. Open an existing project or create a new one.

2. On the main menu, click Tools > Requirements > DataHub and select a desired action.

 For more information

140
about working with Cameo DataHub, see Cameo DataHub
documentation and Cameo DataHub Tutorial (see page 59).

Sorry, the widget is not supported in this export.

But you can reach it using the following URL:

https://www.youtube.com/watch?v=w12dprJkT_0

Related pages

• Installing Cameo DataHub (see page 59)

• Cameo DataHub documentation141
• Cameo DataHub Tutorial (see page 59)
• Importing requirements (see page 51)

Exporting requirements
You can export ReqIF files to be used with:

• IBM DOORS 9.4, 9.5, and 9.6

• IBM DOORS Next Generation
• PTC Integrity
• Polarion REQUIREMENTS
• Siemens Teamcenter
• Dassault Systemes Reqtify
Exporting requirements to ReqIF files ensures that all html formatting, images, and hyperlinks are
represented in ReqIF format file properly. You can choose to export project elements or specifications,

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 60

also, advanced users can create automated exports and scheduled exports from Teamwork Server or
Teamwork Cloud projects. It should be noted that the exported files keep their original names.

It is recommended to export requirements into a separate project which can be later used in other
models as a used project.

To export requirements to a ReqIF file

1. Open a project from which you want to export requirements.

2. From the File menu, select Export To > Requirement Interchange Format (ReqIF) File.
3. Choose to export one of the following:

• Elements - if you want to export the plain list of requirements.

• Specifications - if you want to export requirements and hierarchical relationships
between them.

 If you choose to export Specifications, make sure you have at least one package
with the «Specification» stereotype applied. To apply the stereotype, your project
has to use the ReqIF Profile. When you try to export specifications from the project
that doesn't have the ReqIF Profile used in it, you get the message asking if you
want to use the profile. In this case, click Yes, apply the «Specification» stereotype
to the required packages and repeat the export procedure.

4. In the open Select Elements / Select Specification Package dialog, select the elements or

specification packages you want to export and click or (if you want to add
elements recursively). Then they appear in the Selected elements list on the right side of the
dialog.
5. When you're done selecting, click OK.
6. In the Select ReqIF file dialog, select the output location for the exported ReqIF file, then select
the file you want to export or type the file name to create a new one.
7. In the ReqIF Flavor pane on the right of the Select ReqIF file dialog, select the flavor of your
exported ReqIF file.

 If you cannot find the needed ReqIF Flavor on the list, please choose MagicDraw.
8. Click Export.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 61

  Images attached to the model are exported to the ReqIF file automatically as well.

When the ReqIF file is exported, a notification message appears, stating the quantity of exported
specifications, elements and relationships. If you choose to export elements only, the message doesn't
contain lines that indicate exported specifications and relationships.

Click the Note: you can change import/export and mapping options here link in the notification
message, if you want to change these options.

 The notification message is displayed for a fixed duration, but you can find all project
notification messages in the Notification Window. To open the Notification Window, click
Window > Notification Window, or press Ctrl + M.

Changing requirements exporting options

Changing requirements exporting options is beneficial if you have a custom requirement type defined,
or you are exporting not a requirement file but another type of data, for example, test cases.

 A requirement type is limited to class and class extended types.

You can change the following export options:

• Specify an element type to create for the objects you are exporting
• Specify a relationship type to create for the relationships you are exporting
• Specify a path to the output location for exported resources (images, documents, etc.)
• Choose whether to export all properties or not and form a list of ignored and not exported
properties

To change ReqIF file exporting options

1. Click Options > Project. The Project Options dialog opens.

2. In the options group list, select General, then scroll down to the ReqIF options group.
3. Click a desired option specification cell to change it's value.
4. Click OK after you are finished.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 62

Related pages

Applying automated pre-processing scripts before ReqIF file export

Prior to the ReqIF file export, you can apply an automated pre-processing script to your project in order
to modify requirements and create custom mapping upon requirements interchange through ReqIF.

 In order to see the scripts and execute them, you must be using ReqIF Profile. To set the
profile, go to File > Use Project, then scroll to select ReqIF Profile.mdzip and click Finish.

To apply the pre-processing rule

1. From the Options menu, select Project.

2. In the options group list, select General, then scroll down to the ReqIF options group.
3. Under ReqIF Export, find Pre-processing rules and select the one you want to apply.
4. Click OK.

Pre-processing Rule Description

Restore Empty Requirement Name When applied to a requirement with a specified Name
property, the rule removes the element name upon export.

Exporting ReqIF files from the command-line interface

Exporting from the command-line interface is useful when you want to export files automatically, e.g.,
once a day at midnight.

To export a ReqIF file from the command-line interface

1. Open the Command Prompt window

2. Go to the <model editor installation directory>/plugins/com.nomagic.requirements directory
containing the reqifexport.exe file.
3. At the command prompt, type the following command and specify the values of the required
arguments:
reqifexport project_descriptor=<project URL> reqif_file=<path to ReqIF
file> export_type=<specifications|elements> elements=
<hyperlinks or qualified names of elements> source_tool_id=<ReqIF flavor>
Where:
• project_descriptor is the URL of a project.
How to get a project descriptor?

i. Start your modeling tool and open the required project.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 63

 ii. In the main menu, go to File > Project Properties and select the General tab.
iii. Find the project descriptor specified in the Project Descriptor box at the bottom
of the Project Properties dialog and copy it to the clipboard.
• reqif_file is the path to the ReqIF file you want to export.

 If there is a space in a path, surround the argument and its value with escaped
quote (\").

• export_type is the type of exported data. The valid value of this argument:

• elements - if you want to export the plain list of requirements.

• specifications - if you want to export requirements and hierarchical
relationships between them.
• elements are hyperlinks or qualified names (or the combination of both) of the elements
to be exported. They must be separated by semicolon (;) symbols.
How to get the hyperlink of an element?

i. Start your modeling tool and open the required project.

ii. In the Containment tree, right-click an element and select Copy Element
Hyperlink.
The hyperlink of the element is now copied to the clipboard.

 If you want to export Specifications, make sure you specify packages with the
«Specification» stereotype applied. To apply the stereotype, your project has to
use the ReqIF Profile. if you try to export packages that don't have the
«Specification» stereotype, the command will fail.

• source_tool_id is the flavor of the ReqIF file. Currently supported flavors are MagicDraw,
IBM Rational DOORS, Polarion, Teamcenter and Reqtify. Note that the source_tool_id
argument is optional.
4. Press Enter.
The ReqIF file with the desired data is now exported to the specified directory.

Using a properties file

To make exporting from the command-line interface quicker you can specify arguments in a properties
file, which can be easily edited or reused.

To export a ReqIF file from the command-line interface using a properties file

1. Create a properties file and specify the values of the following arguments:
• project_descriptor
• reqif_file
• export_type
• elements
• source_tool_id

See the example of a properties file below.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 64

 1 project_descriptor=file:/C:/Users/johnsmith/Downloads/MagicDraw_185/
samples/requirements/MagicLibrary%20requirements.mdzip
2 #
3 # Specify the project URL.
4 # To get a project descriptor, open a project and in the main menu
go to File > Project Properties > General.
5 #
6 reqif_file=C:/Users/johnsmith/Documents/Project_Requirements/
project_requirements.reqif
7 #
8 # Specify the path to the ReqIF file.
9 # NOTE: If there is a space in a path, surround the argument and its
value with escaped quote (\").
10 #
11 export_type=elements
12 #
13 # Specify the type of exported data. The value of the argument can
be "specifications" or "elements".
14 #
15 elements=mdel://_17_0_2_8f90291_1308667744583_445317_24132;mdel://
_17_0_2_8f90291_1308667618344_111153_24071
16 #
17 # Specify the hyperlinks or qualified names (or the combination of
both) of the elements to be exported.
18 # To get the hyperlink of an element, open a project, right-click
the element in the Containment tree and select "Copy Element
Hyperlink".
19 #
20 source_tool_id=MagicDraw
21 #
22 # Specify the flavor of the ReqIF file. Supported flavors are:
"MagicDraw", "IBM Rational DOORS", "Polarion", "Teamcenter" and
"Reqtify".
23 # NOTE: This argument is optional.
24 #

 When creating a properties file on Windows OS, use only / or \\ as a path separator,
otherwise the command will fail.

2. Open the Command Prompt window.

3. Go to the <model editor installation directory>/plugins/com.nomagic.requirements directory
containing the reqifexport.exe file.
4. At the command prompt, type the following command and specify the value of
the properties_file argument.
reqifexport properties_file=<path to properties file>
Where properties_file is the path to the properties file to be used.

5. Press Enter.
The ReqIF file with the desired data is now exported to the specified directory.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 65

Relating requirements
• Relating Requirements in the Requirement Diagram (see page 66)
• Relating Requirements in the Requirement Matrices (see page 66)

You can create relationships directly on the Requirement Diagram pane or in the Requirement Matrices
such as Derive, Refine, Satisfy, or Verify.

Relating Requirements in the Requirement Diagram

To relate requirements on the Requirement Diagram pane

1. Open an existing or create a new Requirement Diagram. How to create a new diagram >142
2. Represent requirements on the Requirement diagram.
3. Select a relation type either from the diagram pane or the smart manipulator of the selected
requirement shape on the diagram pane.
4. Draw the selected relation from one requirement element to other.

Relating Requirements in the Requirement Matrices

To create a relation in the Requirement Matrices

1. Create a corresponding matrix or open an existing one.

2. In the intersection cell do one of the following:
• Double click the intersection cell. The appropriate relation is created.
• Right-click the intersection cell and, on the shortcut menu, and click the relation name.
The relation is created.

 You can create more than one relation in the same cell.

Nesting requirements in the Requirements Table

 If you want to import nested structure of requirements, you must define the Owner property
before the import, with the name or id of the requirement that owns it in the Excel file.
When importing a nested structure of requirements from an Excel file you need to map the
Owner column (defined in the excel file) with the Owner property. Learn more how to import
data from Excel/CSV file >>143

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 66

To nest Requirement

1. Select a Requirement you want to nest in the Requirements Table.

2. Click the Nest button on the table toolbar.
The selected Requirement is owned by the requirement in the previous row.

To unnest Requirement

1. Select a Requirement you want to unnest in the Requirements Table.

2. Click the Unnest button on the table toolbar.
The selected requirement is owned by the owner of the current one.

Creating Requirement Diagram for sub-requirements

You can create a Requirements Diagram for sub-requirements of the selected requirement directly on
the diagram pane.

To create Requirements Diagram for sub-requirements

1. Select a Requirement shape on the diagram pane.

2. On the smart manipulator, click the Create diagram for sub-requirements button.
A new requirements diagram for the sub-requirements is created having the same name as the
selected requirement. The selected requirement is an owner of sub-requirements diagram and is
marked with the diagram sign.

 Double click the owner symbol to open a diagram for sub-requirements and use navigation
buttons on the diagram toolbar to move back or forward through diagrams.

Modifying requirement text

• Editing the requirement text (see page 68)
• Switching the requirement text to HTML or Plain text (see page 69)
• Modifying the requirement text (see page 71)
• Rich text formatting (see page 72)
• Using Glossary terms (see page 73)
• Defining hyperlinks (see page 73)
• Inserting images into HTML text (see page 74)
The requirement always contains two properties: id and text. This section describes how to modify the
text property of the requirement.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 67

 The Stopping Distance Requirement shape with filled Text property.

Editing the requirement text

You can edit the requirement text directly on shapes and in cells, or use the Text dialog.

To open the edit mode of the requirement text, do one of the following

• On the diagram pane (see page 67), select the Text box on the Requirement shape. Click the text
box again. The edit mode opens on the shape.
• In the Requirements table, double-click the Text cell. The edit mode opens on the cell.
• In the Requirements table, double-click the Text cell, and select

. The Text dialog opens.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 68

 • Open Specification window144 of the Requirement, select the Text property, and click

. The Text dialog opens.

Switching the requirement text to HTML or Plain text

You can change the requirement text to HTML or Plain text directly on the Requirement shape or in the
Text dialog.

To switch the requirement text to HTML or Plain text directly on the Requirement shape

1. On the diagram pane, select the text box on the Requirement shape.
2. Click one of the following buttons appearing on the lower left corner of the shape:
• HTML - converts the text to HTML text.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 69

 • Plain - converts the text to plain text.

To switch the requirement text to HTML or Plain text in the Text dialog

1. Open the Text dialog:

• In the Requirements table, double-click the Text cell, and select

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 70

 • Open Specification window145 of the Requirement, select the Text property, and click

.
2. In the Text dialog tootbar, do one of the following:
• Select the HTML check box to convert the text to HTML text.

• Clear the HTML check box to convert the text to plain text.

3. Click OK.

Modifying the requirement text

You can modify the Requirement text in the following ways:

• Rich text formatting (see page 72)

• Using Glossary terms (see page 73)
• Defining Hyperlinks (see page 73)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 71

 • Inserting images into HTML text (see page 74)

Rich text formatting

If you switch the requirement text to HTML (see page 69), you can use the toolbar in the Text dialog to
format it as rich text.

To open the rich text formatting toolbar

• On the diagram pane (see page 67), select the Text box on the Requirement shape. Click the text
box again.
• In the Requirements table, double-click the Requirement Text cell, and select

.
• Open Specification window146 of the Requirement, select the Text property, and click

.
If the Requirement text is in HTML format, the rich text formatting toolbar appears as shown in
the following image.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 72

  HTML text editors
Learn more about how to work with HTML texts:
• Advanced HTML Editor dialog147
• HTML editor148

Using Glossary terms

You can use the terms from the Glossary Table to ensure the same definitions of the concepts. How to
work with Glossary table >>149

If you want to extract a Constraint from a Requirement, you must use the special condition terms when
defining the Requirement text.

 The full procedure for extracting a Constraint from a Requirement is provided in the section
Extracting Constraint from Requirement (see page 67).

Unable to render include or excerpt-include. Could not retrieve page.

Defining hyperlinks
You can add a hyperlink on the requirement text. How to add hyperlinks in text read in the Hyperlinks
in text150 page.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 73

Inserting images into HTML text
To insert an image into HTML text

From the Containment tree

• When the image is already an AttachedFile, please refer to Working with attached files151152.

By using the Advanced HTML Editor

1. Open the Advanced HTML Editor153154.

2. On the toolbar, click Insert Image button , then click one of the following:

• From File – to browse the image in your file system or paste the attached image
file URL into the Picture source field.
• From Attached File – to open the Select Elements dialog and select the
appropriate parent element to which the AttachedFile image should be attached.
• From Image Library – to use images from a bundled image collection or your own
added sets of images.

3. Click OK twice to close both dialogs.

By pasting or dragging the image file from file system

1. Open the image file location, select the file(s) you want to insert, then do one of the following:

• copy/paste them to the HTML Editor. In the Paste Special menu, select Image to paste
image and attach it to the project or Image (without attaching) to paste it only for
referencing in the diagram.
• drag them to the HTML Editor. In the Select Image Owner, select the appropriate
parent element to which the AttachedFile image should be attached. If you click Cancel,
the image will be displayed in the diagram, but not attached to the project.

2. Click OK to close the dialogs.

 If you chose to not attach the image, it is displayed in the HTML Editor, but when you
delete the file from your file system, it is no longer displayed. That also means other
users you want to share the project with won't be able to see the image if they open
the project from another device. This option is very useful when the file you want to
insert is large and you don't want to increase the project size.

 This feature works on both the HTML Editor and Advanced HTML Editor.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 74

By pasting or dragging an image from a web browser

1. Do either:

• copy/paste the image to the HTML Editor. In the Paste Special menu, select Image to
paste image and attach it to the project or HTML Text to paste it only for referencing in
the diagram.
• drag the image to the HTML Editor.

2. Click OK to close the dialogs.

 This feature works only on the HTML Editor.

 This feature works only with Google Chrome and Mozilla Firefox.

By pasting or dragging rich text with an image

1. Do either:

• copy/paste content to the HTML Editor. In the Paste Special menu, select HTML Text
to choose whether paste it only for referencing in the diagram or attach it to the
project, or select Image to paste and attach it to the project, or select Plain Text to
paste only text without an image.
• drag the image to the HTML Editor. In the Select Image Owner, select the appropriate
parent element to which the AttachedFile image should be attached. If you click Cancel,
the image will be displayed in the diagram, but not attached to the project.

2. Click OK to close the dialogs.

 This feature works only on HTML Editor.

 Only rich text from MS Office files is supported.

 If the image from the rich text document is not stored in your file system, you are not
asked to choose whether to attach the file or not.

To insert multiple image files

1. Open the image files location, select the files you want to insert, then do either:

• copy/paste them to the HTML Editor. In the Paste Special menu, select Image to paste
images and attach them to the project or Image (without attaching) to paste them only
for referencing in the diagram.
• drag them to the HTML Editor. In the Select Image Owner, select the appropriate parent
element to which the AttachedFile images should be attached.

2. Click OK to close the dialogs.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 75

  This feature works on both HTML Editor and Advanced HTML Editor.

Related pages

• Extracting Constraint from Requirement (see page 67)

• Advanced HTML Editor dialog155
• HTML editor156
• Text Box157
• Basic tasks in tables158
• Defining hyperlinks159

Customizing requirement properties

You can create specific properties in requirements specifications. This will help identify the
requirement’s version, complexity, priority, severity, status, and other properties. Use the UML Profiling
and DSL Guide160 to extend Requirements with custom properties. Add custom properties to the
general properties list by extending the ExtendedRequirement (see page 76) class.

 Customizing procedure details are described in Creating Customization Data161 and Using
162 163
Customization Data in the UML Profiling and DSL Guide .

To create custom properties

1. In your project, create a Package for your custom properties.

How to create a new package

To create a new package

a. In the Containment tree, right-click the element.

 The element should be a namespace, such as a package, class, or requirement.

b. Select Create Element > Package.
c. Type a name for the new Package (e.g. Custom Properties).
d. Press Enter.
2. In that package, create a new stereotype. How to create a new stereotype >>164
3. Apply a metaclass Class to the created stereotype.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 76

 How to apply metaclass for a stereotype

To apply a metaclass to a stereotype

a. In the Containment tree, right-click the newly created stereotype.

b. From the shortcut menu, select Metaclass.
c. In the Metaclass dialog, select a Class.
d. Click Apply.

4. For the stereotype with the applied metaclass Class, create custom properties.
How to create custom properties for a stereotype

To create custom properties for a stereotype

a. In the Containment tree, right-click stereotype.

b. From the shortcut menu, select Create Element.
c. In the Create Element dialog, select Property.
d.Type a property name and specify a value type.

5. Extend the ExtendedRequirement class using properties created in the stereotype (i.e., you must
relate the stereotype with the Generalization relationship to the ExtendedRequirement class).
How to extend ExtendedRequirement class by custom properties

To extend the ExtendedRequirement class using custom properties

a. In the Containment tree, right-click stereotype.

b. From the shortcut menu, select Create Relation > Outgoing.
c. In the Outgoing dialog, select Generalization.
d. In the Create New Generalization To dialog, select the List tab, clear the Apply Filter
check box, and select the ExtendedRequirement [Class].
e. Click OK.

6. On the main toolbar165, click Save Project button and restart your project.
Your custom properties are added to the general requirement properties. You can assign values
to them in the Requirement’s Specification window166 or in the Properties panel.
The following figure depicts how the stereotype related to the ExtendedRequirement [Class] looks
in the Containment tree (see page 76) and diagram pane (see page 76).

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 77

 The ExtendedRequirement [Class] extended by the author property is
shown in the Containment tree and diagram pane.

Converting requirements
To convert elements

1. From the selected element's shortcut menu, select Refactor > Convert To. The list with available
conversion target types opens.
2. Do one of the following:
• Select the element type from the commonly used element type list. The element is
converted.
• Select More Elements to see the whole list of available conversion targets. In the opened
More Elements dialog, select the element type you need and click OK. The element is
converted and selected element type is included as commonly used element type.

Replacing requirements
To replace one element with another

1. Select a symbol on the diagram pane or an element in the Model Browser and open its shortcut
menu.
2. Click Refactor > Replace With. The warning message appears:
• Click Yes to continue the element replacement. The properties and inner elements of the
original element will be lost.
• Click No to cancel the element replacement. The selected element will not be replaced.
3. If you decided to continue the replacement, the element selection dialog opens.
4. In the element selection dialog, select the element with which you want to replace the original
element.
5. Click OK. The original element is replaced with the target element.

Requirements numbering

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 78

When you create Requirements they are numbered by default with their unique IDs. The default
Requirement IDs in the modeling tool are hierarchical numbers: 1, 1.1, 1.1.1, etc. See the following
figure.

Requirements numbering.
The special validation rules ensure that each Requirement ID in your project is unique. For example, it
is valuable when working with Teamwork Server or Teamwork Cloud and Requirements appear with
the same IDs after commits. The validation rules check that and show errors.

If you want a different Requirement numbering than the default, you can customize 167it manually by
using the Element Numbering dialog (see page 78). However, it is not recommended.

Analyzing Requirements
The requirements analysis encompasses those tasks that determine the needs or conditions a new or
altered product or project must meet. It considers the possibly conflicting requirements of the various
stakeholders by analyzing, documenting, validating and managing software or system requirements.
Requirements analysis is critical to the success or failure of a systems or software project.

You can analyze requirements using the following tools:

• Usages and Dependencies. Discovers the Requirements usage and dependencies on other
model parts: traceability, change impact analysis.
• Dependency Matrix. Checks the Gap analysis, Change Impact analysis, Requirements
completeness and correctness.
• Model validation. Checks Requirements completeness and correctness based on build in or
custom validation suites.
• Traceability. Tracks, visualizes, navigates, and analyzes the elements involved in traceability
relations.
• Relation Map. Visualizes the relations of multilevel requirements: traceability, coverage analysis.
• Generic and Requirements Tables. Makes the coverage analysis in a compact format.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 79

 • Report Wizard. Analysis (e.g. coverage) and estimation (e.g. functional points method) based on
built in or custom documentation generation templates.
The following sections describe the procedures for analyzing requirements:

Coverage analysis
The Coverage analysis provides coverage information at immediate higher or lower levels by analyzing
traceability properties values. Coverage analysis visualizes and verifies that requirements are covered
with design, implementation, test cases, or other subjects.

Test cases not only plan how to verify each requirement, but also identify a relation between the
requirement and test case and show the coverage to ensure that each requirement will be
appropriately tested.

Change impact analysis

Impact analysis minimizes the risk of introducing undesirable effects to the system by increasing your
understanding of how the proposed change might affect the elements in the system change. Once a
change is proposed its impact should be identified.

Traceability links and visualization of related elements display dependencies of requirements and help
you see the full impact of a proposed change in those requirements.

Analyzing dependencies in dependency matrix

You can create, analyze, and modify requirement relations in the matrix, which provides a compact
visual view for analysis. Using a dependency matrix, you can also edit relations between a selected
requirement and model element (i.e., add or remove a desired relation).

The Dependency Matrix enables:

• The visualization of more than one element relations from different diagrams.
• The capability to create domain-specific matrices and their templates.
• Ready-to-use matrix templates: traceability of elements and behavior diagrams, traceability of
requirements, traceability of requirements and elements refining, satisfying, verifying them, and
others.
• Faster creation of traceability links between elements (for example, between requirements and
the architecture or requirements and test cases). This improvement saves a huge amount of time
in comparison to linking elements in diagrams.
To create a dependency matrix

1. From a requirements specification package shortcut menu in the Containment tree, select
Create Diagram and then select one of the following:
• Derive Requirement Matrix to create a Dependency Matrix to analyze, create, and
modify derivation relations between a derived requirement and a source requirement.
• Refine Requirement Matrix to create a Dependency Matrix to analyze, create, and
modify refined relations between a requirement and a model element or a set of elements
refining the requirement.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 80

 • Satisfy Requirement Matrix to create a Dependency Matrix to analyze, create, and
modify satisfaction relations between requirements and model elements fulfilling the
requirements.
• Verify Requirement Matrix to create a Dependency Matrix to analyze, create, or modify
verification relations between requirements and named elements that can determine
whether the systems fulfill the requirements.
2. Type a diagram name.
3. Select criteria and a scope to be represented in the matrix.

 You can specify requirements to be represented as rows and class elements to be

represented as columns.

4. Click the Refresh button.

The following figure shows how particular requirements satisfy particular model class elements.

Example of a dependency matrix.

You can also remove redundant or create missing dependencies using a dependency matrix. For
detailed instructions on how to use dependency matrixes, see Dependency Matrix168.

Related pages

• Dependency Matrix169
• Requirement matrices (see page 80)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 81

Analyzing dependencies in relation map
A relation map allows visual analysis among multiple levels of abstraction, such as how requirements
are satisfied by other model elements. The relation map enables you to show existing relationships,
visualize multilevel relationships, observe traceability from requirements to implementation, or any
other analysis you need.

The relation map is useful for:

• Making fast analysis and overview of a model.

• Observing traceability from requirements to implementation all the way through different levels
of abstraction (such as analysis, design, etc.).
• Discovering the requirements structure.

 You are not allowed to edit relations in the relation map diagram.

To create a relation map

1. From a package or requirement shortcut menu in the Containment tree, select Create Diagram
and then select one of the following:
• Requirement Containment Map.
• Requirement Derivation Map.
2. Type a diagram name.
3. Specify a relation criterion, element type, and scope.
4. Click the Refresh button.
The following figure shows how particular requirements satisfy particular model class elements.

Example of relation map

For detailed instructions on how to use relation maps, see Relation Map170.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 82

Related pages

• Relation Map171

Tracing requirements
• Traceability relations in Specification window (see page 83)
• Traceability relations in Properties panel (see page 84)
• Representing traceability on Notes (see page 85)
• Tracing relations using Go To command (see page 85)

 The traceability solution is available in Architect and Enterprise editions.

The traceability relations help determine how your requirements or other model artifacts are satisfied.
As they change, you can use traceability relations to monitor the impact of these changes. You can
visualize traceability relations using MagicDraw features, such as the Dependency Matrix or Relation
Map. Requirements tracing is a background for analysis and is concerned with recovering the sources
of requirements and predicting the effects of requirements. Tracing is fundamental to performing
impact analysis when requirements change. A requirement should be traceable backwards to the
criteria and stakeholders which motivated it (from functional requirements to business requirements).
A requirement should also be traceable forwards into the design entities that satisfy it.

Traceability makes it easier for you to:

• Find, navigate and define the realization and specification of elements from different levels of
abstraction:
• Understand why an element exists, how the element is realized, and clarify the purpose of the
element.
• Validate the system functionality (to see if it meets customer requirements and if any
superfluous functionality has been implemented).
• Improve a customer's understanding of the system and thus his/her acceptance of the system.
• Have single places for relations analysis used in traceability.
• Check artifact coverage and completeness.
• Bridge the gap between levels of abstraction.
• Trace elements by using out-of-the-box predefined traceability suites.
For detailed instructions on how to use the traceability solution, see Traceability172.

Traceability relations in Specification window

In the selected element's Specification window, you can see traceability relations as properties. You can
also create your own specific properties and edit them here.

To trace element relations in the Specification window

1. Open the Specification window of the selected element.

2. Scroll through the general requirement's properties to get to the Traceability properties list.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 83

 Traceability property group in element's
specification window
For more information about using a Specification window, see Specification window173.

Traceability relations in Properties panel

The same traceability properties are displayed in a Properties panel.

To trace element relations in the Properties panel

1. Select the element in the Model Browser174 or the shape on the diagram pane.
2. In the Model Browser, click the Properties panel > Element tab and scroll through the
properties to get to the Traceability properties list.

Traceability property group in element's properties panel.

For more information about using the Properties panel, see Properties tab175.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 84

Representing traceability on Notes

To trace element relations in a Note

1. Select the element's shape on the diagram pane.

2. Connect a note to the selected shape.
3. Right-click the note and click Edit Compartments on the shortcut menu,or select a note and click
the Edit Element Properties button appearing on the right side of the note.

4. In the Compartment Edit dialog, click the Element Properties tab, select the traceability
properties you want to represent on a note and move them from the Hidden to Selected list.
5. Click OK when you are done.
Selected traceability properties are presented on a note.

Traceability properties on a note

Tracing relations using Go To command

The Go To command allows you to easily find and navigate to the related elements through the
traceability relations.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 85

To trace element relations using the Go To command

1. Select the Requirement in the Containment tree or the shape on the diagram pane.
2. Right-click the selected Requirement. On the shortcut menu, click Go To > Traceability >
Specification / Realization / Owner / Other and select the desired element.
This element is selected in the Containment tree.

For more information about traceability, see Traceability176.

Validation
On this page

• Purpose (see page 86)

• Validation suites (see page 86)
• Validating your model (see page 86)
• Invalid elements representation (see page 87)

Purpose
Validation checks the accuracy, completeness, and correctness of a model, marks invalid elements in
the model, and suggests solutions.

Validation suites
Models are validated against a set of validation rules. Each validation rule captures an imperative
condition that must be checked against the model. Validation rules are grouped into meaningful groups
called validation suites. There are predefined validation suites that you can customize. You can also
create your own rules and group them into suites. Some validation rules are active; that is, they run all
the time. Validation rules and suites can be exported into a separate project in order to reuse them.
They are stored in the Teamwork Server or Teamwork Cloud server for exchange.

• Learn more about MagicDraw predefined validation suites >>177

• Learn more about SysML validation suites >>178
• Learn more about MagicDraw active validation suites >>179
• Learn more about SysML active validation suites >>180

Validating your model

The validation can run on the entire model or on a selected part of it. All the elements in that scope are
checked against relevant validation rules, and elements that violate these rules are reported in the
Validation Results panel (see page 86). They are also marked in the Model Browser (see page 86), and their

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 86

symbols are highlighted. Diagrams, tables, matrices, and relation maps displaying these highlighted
symbols have the validation results marker bar.

• Learn how to start the validation >> (see page 86)

• Learn more about validation results marker bar >> (see page 86)
• Learn more about Validation Results panel >> (see page 86)
• Learn more about Validation dialog >> (see page 86)

Invalid elements representation

The invalid elements are marked as follows:

• - error or fatal error.

• - warning.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 87

 • - debug or info.

 Learn how to customize severity levels >> (see page 86)

You can see invalid elements in the following areas:

• In the Model Browser (see page 86) an invalid element is marked with a small symbol that depends
on the failure severity.

• On the diagram pane (see page 86) an invalid symbol is highlighted.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 88

 • In the validation results marker bar (see page 86) every marker of an invalid symbol is colored
according to the violation severity.

• On the status bar (see page 86) the failure indicator displays the severity icon, number of errors,
and the first letter of the error severity (F - fatal error; E - error; W - warning; D - debug; I - info).

 Solvers of invalid elements

You can analyze invalid elements and solve problems by selecting appropriate commands from
the invalid element or symbol shortcut menu or in the Validation Results panel (see page 86).

Sorry, the widget is not supported in this export.

But you can reach it using the following URL:

https://www.youtube.com/watch?v=YgyeNgpR7TA

Related pages

Requirements validation suites

You can validate your model against a set of constraints called validation suites.

 Each Profile contains its own validation suites. You can create your own validation suites (see
page 89).

You can meet the following Requirements validation suites in the Validation dialog (see page 89) or
Validation Suites dialog (see page 89):

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 89

 • ActiveValSuite - Requirements contains active validation rules about Copy (see page
89)relationship and Test Case (see page 89). The active validation suites enable you to see if a model
is correct and complete immediately. It instantly displays any errors in the model and suggests
appropriate solutions. The active validation suites have «activeValidationSuite» stereotype
applied. Learn how to work with active validation suites >>181
• ValSuite - Requirements contains predefined Requirements validation rules about Copy (see
page 89)relationship, Derive Requirement, Requirement (see page 89), and Test Case (see page 89). You
need to perform the validation manually to check your model against the predefined validation
suites. The predefined validation suites have «validationSuite» stereotype applied. Learn how to
work with predefined validation suites >>182
• ValSuite - Suspect Links contains predefined Requirements validation rules about suspect
links183. You need to perform the validation manually to check your model against the predefined
validation suites. The predefined validation suites have «validationSuite» stereotype applied.
Learn how to work with predefined validation suites >>184

 You can find predefined validation suites in the Containment tree (see page 89) when the Show
Auxiliary Resources option is enabled, expand the MD Customization for Requirements
Package> Requirement constraints Package. The Requirement constraints Package is divided into
separate Packages and contain an appropriate validation rules (see page 89).
To show the auxiliary resources

• In the Model Browser185186, click and enable the Show Auxiliary Resources
option.

Related pages

• MagicDraw predefined validation suites187

• MagicDraw active validation suites188
• SysML validation suites189
• SysML active validation suites190

Requirements validation rules

This page contains all constraints for the Requirements implemented in the tool as validation rules.

The Requirements validation suites and active validation suites include the following validation rules:

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 90

Invalid Copy of requirement
Abbreviation

Copy[A]

Description

A requirement can’t copy more than one requirement.

Severity

warning

Context element

Copy

Solvers

Example

Invalid return parameter type

Abbreviation

TestCase[1]

Description

The type of return parameter of the stereotyped model element must be VerdictKind. (note: this is
consistent with the UML Testing Profile).

Severity

warning

Context element

Behavior

Solvers

Example

Invalid Slave Requirement text

Abbreviation

Copy[2]

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 91

Description

The text property of the client requirement is constrained to be a copy of the text property of the
supplier requirement.

Severity

warning

Context element

Copy

Solvers

Example

Invalid stereotype(s) of client/supplier of Copy

Abbreviation

Copy[1]

Description

A Copy dependency may only be created between two classes that have the “requirement” stereotype,
or a subtype of the “requirement” stereotype applied.

Severity

warning

Context element

Copy

Solvers

Example

Missing Recursive copy of sub-requirement

Abbreviation

Copy[C]

Description

If the supplier requirement has sub requirements, copies of the sub requirements are made recursively
in the context of the client requirement and Copy dependencies are created between each sub
requirement and the associated copy.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 92

Severity

info

Context element

Copy

Solvers

Example

Recursive loop of Copy dependencies

Abbreviation

Copy[B]

Description

Copy dependencies should not from a cyclic graph.

Severity

warning

Context element

Copy

Solvers

Example

Invalid source or target of DeriveReqt

Abbreviation

DeriveReqt[1] and DeriveReqt[2]

Description

A DeriveReqt dependency may only be created between two classes that have the "requirement"
stereotype, or a sub-type of the "requirement" stereotype applied.

Severity

warning

Context element

Derive Requirement

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 93

Solvers

Example

Invalid generalization of Requirement

Abbreviation

Requirement[4]

Description

Classes stereotyped by «requirement» may not participate in generalizations.

Severity

warning

Context element

Generalization

Solvers

Example

Invalid owned attribute of Requirement

Abbreviation

Requirement[2]

Description

The property owned Attribute must be empty.

Severity

warning

Context element

Requirement

Solvers

Example

Invalid owned operation of Requirement

Abbreviation

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 94

Requirement[1]

Description

The property owned Operation must be empty.

Severity

warning

Context element

Requirement

Solvers

Example

Missing requirement stereotype

Abbreviation

Requirement[5]

Description

A nested classifier of a class stereotyped by «requirement» must also be stereotyped by «requirement».

Severity

warning

Context element

Classifier

Solvers

Example

Suspect Unlinked Requirement

Abbreviation

UnlinkReq

Description

An unlinked element was found.

Severity

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 95

warning

Context element

Abstract Requirement

Solvers

Example

Starting the validation

Validation can run on:

• The entire model, or its part (e.g. several packages). (see page 96)
• Diagram, table, matrix, or relation map (see page 96)
• Elements (see page 96)

To start the validation of the entire model or its part

1. Open the Validation dialog. How to open the Validation dialog >>191192
2. Specify the following options:
- Validation Suite.
- Validate For.
- Minimal Severity.
Learn more about each of the option >>193194
3. Click Validate.
The model or its part is validated against the selected validation suite.

To validate the diagram, table, matrix, or relation map

• On the toolbar of diagram, table, matrix, or map, click the Validate Diagram button .
195196
• Right-click the diagram, table, matrix, or map in the Containment tree , select Validation >
Validate Diagram.

To validate the element(s)

1. Right-click the element in the Containment tree197198.

2. In the shortcut menu, point to Validation and select:

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 96

 • Validate Element - to validate only selected element.
• Validate Elements Recursively - to validate all child elements of the selected element.

Validation results marker bar

The validation results marker bar appears at the right side of a diagram pane, if the diagram contains
symbols of invalid elements.

10 Validation results marker bar and summary of diagram validation results

The markers are shown even for the items that are not currently visible on the screen (you may need to
scroll down to see them). The marker bar shrinks to fit the screen and displays relative positions of
annotated symbols on the axis of ordinates. Every marker is colored according to the violation severity.

Clicking a marker on the bar selects the appropriate symbol on the diagram pane. Moving the mouse
over the marker eye (the red square at the top-right corner of the diagram pane) opens the summary
of the diagram validation results.

Validation Results panel

On this page

• Introduction (see page 98)

• Opening the Validation Results panel (see page 98)
• Description of Validation Results panel areas (see page 99)
• Toolbar (see page 99)
• Validation results area (see page 102)
• Summary of severity area (see page 103)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 97

Introduction
The Validation Results panel and Active Validation Results panel display the results of the validation:
invalid element, severity, explanation of the validation rule and its abbreviation. The Active Validation
Results panel shows the results of active validation suites199200, while the Validation Results panel
shows predefined validation suites201202.

The Validation Results and Active Validation Results panels.

Opening the Validation Results panel

The Validation Results panel opens automatically after the validation has ended. How to start the
validation >>203204

Since the active validation suites always check your model's correctness, you must open the Active
Validation Results panel to see the results of active validation.

199 https://docs.nomagic.com/display/MD2024xR1/Active+validation+suites
200 https://docs.nomagic.com/display/MD2024xR1/Active+validation+suites
201 https://docs.nomagic.com/display/MD2024xR1/Predefined+validation+suites
202 https://docs.nomagic.com/display/MD2024xR1/Predefined+validation+suites
203 https://docs.nomagic.com/display/MD2024xR1/Starting+the+validation
204 https://docs.nomagic.com/display/MD2024xR1/Starting+the+validation

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 98

To open the Active Validation Results panel

• On the status line205206, click the failure indicator (e.g. ).

 If you cannot see the failure indicator on the status line, your model is correct according
to active validation suites.

Description of Validation Results panel areas

The Validation Results panel consists of the following areas:

• Toolbar (see page 99)

• Validation results area (see page 102)
• Summary of severity area (see page 103)

The Validation Results panel areas: toolbar, validation results, and summary of severity areas.

Toolbar
The toolbar allows you to manage the validation results. All buttons are described in the following
table.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 99

 Button Button name Description
icon

Expand All Click to expand recursively all the elements in the validation results
area.
11 Expand
All

Collapse All Click to collapse recursively all the elements in the validation results
area.
12 Collaps
e All

Navigate to Validated Click the button to select the element in the Containment tree207208.
Object (Alt+B)
Click the arrow next to the button to open the menu of the following
navigation commands:

• Open Specification - opens Specification

window209210 of the selected element in the validation
results area.
• Go To - opens a submenu whose commands allow
you to track and navigate to the elements.
• Select Rule in The Containment Tree - selects the
failed validation rule in the Containment tree211212 of the
selected element in the validation results area.
• Add to Search Results - selects an element in the
Search Results tree213214.

Solve Click to open the list of available commands to solve a selected

element violation in the validation results area.
13 Solve

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 100

 Button Button name Description
icon

Ignore Click to ignore a selected element violation in the validation results

area. In server projects, you can select whether to ignore the
violation for you as a project user or for all users who works on that
14 Ignore
server project.

The button is available when you select an unignored element in the

validation results area.

Click the arrow next to the button to open the menu of the following
commands:

• Ignore Validation Rule - ignores the validation rule of

a selected element in the validation results area.
• Ignore Validation Suite - ignores the validation suite
of a selected element in the validation results area.

Unignore Click to make a selected element in the validation results area

violation unignored.
15 Unignor
The button is available when you select an ignored element in the
e
validation results area.

Display the full path of Click to show the full path of all elements in the validation results
the elements area.
16 Display
the full
path of the
elements

Run validation with Click to run the validation with current settings.
current settings
17 Run
validation
with
current
settings

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 101

 Button Button name Description
icon

Run validation with new Click to open the Validation dialog215216 and run the validation with
settings new settings.
18 Run
validation
with new
settings

Export Click to export the list of validation results either to .html or .csv file.

19 Export

Validation results area

The validation results area provides a list of violated elements. This area contains the following
columns:

• Element - elements that violate the validation rule.

• Severity - severity level of the validation rule.
• Abbreviation - a short word, phase, or acronym of the validation rule used for sorting/filtering.
• Message - description of the invalid situation when a validation rule fails.
• Is Ignored - indicator of whether the violation is ignored or not.
You can use the validation results area to:

• Manage validation results (see page 102)

• Sort validation results (see page 103)
• Filter validation results (see page 103)

To manage validation results

• Right-click the element in the validation results area and select one of the following commands
from the shortcut menu:
• Solver name
• Ignore
• Navigate to Validated Object
• Open Specification
• Go To
• Select Rule in The Containment Tree

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 102

  All those commands are described in the table above (see page 99).

To sort the validation results

• Click the header of the column you want to sort the validation results. A small arrow appears on
the column header:

• - ascending sorting.

• - descending sorting.

To filter the validation results

1. Point to the header of a column whose value you want to select for filtering the validation results.
2. Click at the right of the column header and select a value from the drop-down list.

Summary of severity area

The summary of the severity area displays the number and severity of violated elements in expanded
packages. If you collapse the package in the validation results area, the number of violated elements
are excluded from the count.

Validation dialog
On this page

• Introduction (see page 103)

• Opening the Validation dialog (see page 104)
• Description of Validation dialog options (see page 105)

Introduction
The Validation dialog allows you to limit the scope of the constraints to validate against your model.
Since the active validation suites217218 check your model all the time, the validation according
predefined validation suites219220must be started by using this dialog. If you select the All Validation
Suite as the Validation Suite in the Validation dialog, your model is validated against all

217 https://docs.nomagic.com/display/MD2024xR1/Active+validation+suites
218 https://docs.nomagic.com/display/MD2024xR1/Active+validation+suites
219 https://docs.nomagic.com/display/MD2024xR1/Predefined+validation+suites
220 https://docs.nomagic.com/display/MD2024xR1/Predefined+validation+suites

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 103

predefined221222 and active validation suites223224 at the same time. To limit the scope of the constraints
to be validated against, select a more specific validation suite, such as Numbering Validation. The model
or its part will be validated against the selected validation suite only. The Validation Results panel225226
shows the results, listing all elements that do not conform to some constraints (invalid elements) in the
selected validation suite.

The Validation dialog. Its options (1,2,3,4,5) are described below.

Opening the Validation dialog

To open the Validation dialog

1. Do one of the following:

- On the main menu, select Analyze > Validation > Validate.
- On the Validation toolbar, click .
2. In the Validation dialog, specify the options. Descriptions of options >> (see page 105)
3. Click Validate.
The model or its part is validated against the selected validation suite. The results are shown in
the Validation Results panel227228.

221 https://docs.nomagic.com/display/MD2024xR1/Predefined+validation+suites
222 https://docs.nomagic.com/display/MD2024xR1/Predefined+validation+suites
223 https://docs.nomagic.com/display/MD2024xR1/Active+validation+suites
224 https://docs.nomagic.com/display/MD2024xR1/Active+validation+suites
225 https://docs.nomagic.com/display/MD2024xR1/Validation+Results+panel
226 https://docs.nomagic.com/display/MD2024xR1/Validation+Results+panel

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 104

  You can run the validation for the entire
229230
diagram, table, matrix, relation map, or elements.
Learn how to start the validation >>

Description of Validation dialog options

The Validation dialog consists of the following:

• The Validation Suite drop-down list (#1 in the image above) allows you to select a validation
suite that you want to validate the model or its part against.

 The list of available validation suites depends on the open project; the validation suites
and validation rules are stored in the model as regular model elements.

• The Validate For drop-down list (#2 in the image above) allows you to choose:
• Whole Project to run validation on the entire model.
• Validation Selection to run validation on special packages and/or elements. Then click
the ... button and select the scope for validation.

 Validation is always recursive. If you select a package for validation, you do not
need to select its inner elements.

• The Minimal Severity drop-down list (#3 in the image above) allows you to select the minimal
severity level: debug, info, warning, error, fatal. Debug is the lowest possible severity level.
• Clear the Exclude elements from projects used in read-only mode check box (#4 in the image
above) if you want to run validation on the elements stored in the read-only project usages.
• Clear the Exclude elements from additional content check box (#5 in the image above) if you
want to include the content of Smart Packages while running the passive validation.
• The Validation Suites button (#6 in the image above) opens the Validation Suites dialog231232.

Custom validation
You can extend existing validation suites that come with Profile233by customizing existing or creating
your own validation suites and rules.

Find an appropriate topic:

Creating validation suites

The validation suite defines the set of validation rules applied when running the validation. The
purpose of the validation suites is to group validation rules (constraints) without duplicating them.
When creating a new validation suite you must choose the active or inactive validation suite you want
to create, depending on the applied stereotype:

• «validationSuite» is dedicated for inactive validation rules. Learn more about predefined
validation suites >>234235

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 105

 • «activeValidationSuite» is dedicated for active validation rules. Learn more about active validation
suites >>236237
You can:

• Create your own validation suites. (see page 106)

• Clone existing validation suites. (see page 107)
• Include/exclude the validation rules to/from validation suites. (see page 107)

 Sharing
You can share validation suites by exporting validation suites Package238239 and then use it in
another project.240241

To create a new validation suite

1. Open the Validation Suites dialog. How to open the Validation Suites dialog >>242243
2. Do the one of the following:
- In the toolbar244245, click and select Validation Suite or Active Validation Suite command.
- Right-click the Validation Suites area246247 and select Create Validation Suite or Create Active
Validation Suite command.
3. In the Select Owner dialog, choose the owner for the new validation suite Package, and click OK.
4. In the Rename dialog, type the name of the new validation suite Package, and click OK.
An empty validation suite Package is created and is located in your model. You can include
validation rules from other validation suites. How to include validation rules >> (see page 107)

 Alternative
An alternative way is to create a new or select existing Package element and apply one of
the following stereotypes:
- «validationSuite»
- «activeValidationSuite»
How to apply a stereotype >>248249

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 106

To clone existing validation suites

1. Open the Validation Suites dialog. How to open the Validation Suites dialog >>250251
2. In the Validation Suites area252253, select the validation suite Package you want to modify.
3. Do the one of the following:
- In the toolbar254255, click .
- Right-click it and select Clone Validation Suite command.
4. In the Select Owner dialog, choose the owner for the cloned validation suite Package, and click
OK.
5. In the Rename dialog, type the name of the cloned validation suite Package, and click OK.
The clone of the existing validation suite Package is created and contains the same validation
rules as the original. You can include or exclude validation rules from the cloned validation suites
Package. How to include/exclude validation rules >> (see page 107)

To include/exclude the validation rules to/from a validation suite Package

1. Open the Validation Suites dialog. How to open the Validation Suites dialog >>256257
2. In the Validation Suites area258259, select the newly created or cloned validation suite Package.

 You cannot include/exclude the validation rules to/from read-only validation suites.
3. In the Validation Rules area260261, select/clear the check boxes for the entire Package or an
appropriate validation rule to include/exclude validation rules to/from the new validation suites
Package.
The validation suites Package contains only selected validation rules.

 Additional information
After you include/exclude the validation rules (constraints), the appropriate Package
Import262263 relation is created/deleted in the model. You can check that in the
Containment tree264265, under newly created or cloned validation suites Package,
Relations group. In the image below, the Numbering Validation, Path Overlapping, and
Pins Displaying validation suites with all Constraints are included in the newly created
Specific constraints validation suite via the Package Import relation.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 107

 Validation Suites dialog
On this page

• Introduction (see page 108)

• Opening the Validation Suites dialog (see page 109)
• Description of Validation Suites dialog areas (see page 109)
• Toolbar (see page 109)
• Validation Suites area (see page 110)
• Validation Rules area (see page 110)

Introduction

The Validation Suites dialog allows you to create new suites, clone read-only validation suites, include
one suite to another, and include/exclude already existing validation rules in validation suites.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 108

 The Validation Suites dialog areas: toolbar, Validation Suites, and Validation Rules areas.

Opening the Validation Suites dialog

To open the Validation Suites dialog

• Do either:
- From the main menu, select Analyze > Validation > Validation Suites.
- Open the Validation dialog266267 and click the Validation Suites button.

Description of Validation Suites dialog areas

The Validation Suites dialog consists of the following areas:

• Toolbar (see page 109)

• Validation Suites area (see page 110)
• Validation Rules area (see page 110)

Toolbar

The toolbar allows you to manage the validation suites. All buttons are described in the following table.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 109

 Button Button name Description
icon

Create New Click to create a new validation suite. This button contains the following
Validation Suite commands:

• Validation Suite - creates a new validation suite, stored in your

model as a Package with «validationSuite» stereotype applied.
The validation rules stored in this suite will check if a model is
correct and complete only when you start your model validation
manually. How to start validation >>268269
• Active Validation Suite - creates a new active validation suite
stored in your model as a Package with «activeValidationSuite»
stereotype applied. The validation rules stored in this suite will
be active and check if a model is correct and complete
immediately. Learn more about active validation suites >>270271

Clone Validation Click to clone an already existing validation suite with its validation rules. It is
Suite stored in your model as a Package with «validationSuite» stereotype applied.

Rename (F2) Click to rename the package of new or cloned validation suites.

Remove Click to delete the new or cloned validation suites from the model.

Validation Suites area

The Validation Suites area shows a list of all validation suites that comes with a profile (read-only) or
your own created validation suites (editable).

 Each profile contains its own validation suites.

You can manage validation suites directly in the Validation Suites area by using the toolbar buttons (see
page 109) or shortcut menu commands: Create Validation Suite, Create Active Validation Suite, Clone
Validation Suite, Rename (F2), or Remove.

 All those commands are described in the table above (see page 109).

Validation Rules area

The Validation Rules area contains:

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 110

 • Constraints Tree displaying the structure of the validation suite Packages with their validation
rules. It allows you to include/exclude validation rules to/from a newly created or cloned
validation suite Package. For this select/clear the check box before the entire Package or an
appropriate validation rule.

 You cannot include/exclude the validation rules to/from read-only validation suites.
• Buttons:

Button Description

Edit Click to open the Specification window272273 of the selected element in the Constraint Tree.

Load Click to load the used project274275 with its validation rules.

Creating new validation rules

You can create your own validation rules in the model and use them to check your model or keep them
only for documentation purpose. You can locate new validation rules anywhere in your model, but
usually they are created for the classifier, stereotype, or metaclass.

To create a new validation rule

1. Create new Constraint element.276277

2. Apply «validationRule» stereotype.278279
3. Specify Constraint Element property.280281
4. Specify the validation rule properties.282283
5. Define Constraint expression.284285
The new validation rule is created in the model.

 Managing new validation rule

You can include a new validation rule to your own created validation suite.
• How to create validation suite >>286287

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 111

 • How to include the validation rules to validation suite Package >>288289
You can manage new validation rules in your model as any other elements.
• How to work with model elements >>290291

Related pages

Related pages in Developer Guide

• Creating validation rules (see page 111)

Creating new Constraint element

Specifying Constraint Element property

You must ensure that the constrained element is specified and points to the necessary classifier. Each
validation rule modeled as a Constraint has a Constrained Element property. This property
determines the type of element this rule applies to. If you create the Constraint for a classifier or
stereotype292293, this property is filled automatically. Otherwise, you need to specify it manually, shown
in the following procedure:

To specify a constrained element manually

1. Open the Constraint Specification window. How to open the Specification window >>294295
2. Find the Constrained Element property and select it's value box.
3. Click and select an appropriate element from the Select Elements dialog.

 For constraints on metaclasses, select an appropriate element from the UML Standard
Profile > UML2 Metamodel. Only the single Constrained Element property value is
supported for validation rules.

4. Click OK.
The Constrained Element property value is specified.

Applying «invariant» and «validationRule» stereotype

After the Constraint element is created, you must apply:

• «validationRule» stereotype. It is derived from the «invariant » stereotype. It expands the

Constraint properties with the ability to specify the following information: severity level (for
sorting/filtering), abbreviation string (a short string, for easy recognition) and error message

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 112

 (complete description of error explanation). How to specify the validation rules properties
>>296297

To apply a stereotype, do one of the following:

• In the corresponding element's Specification window298299300, click the Applied Stereotype

property specification cell, then click , and select stereotypes from the open list. After you have
selected, click Apply.
• In the element's shortcut menu, select Stereotype and select a stereotype that you wish to
apply. Click Apply when you are done.
• On the diagram pane, select an element and in that element's name area, type the stereotype
name between brackets « ». The element's name comes after the stereotype.

 If you want to name the element Books and assign it the «table» stereotype, in the
element's name area type the following: «table» Books. The name completion for the
stereotypes works in the name editing mode, press Ctrl+Spacebar or Ctrl+Backspace to
get a list of available stereotypes.

You can change the order of the stereotypes applied to the element. The symbol style of the last
stereotype in the list will be applied to the element.

Specifying the validation rule properties

If you applied the «validationRule» stereotype to the Constraint element, you must specify the following
validation rule properties in its Specification window: Abbreviation, Error Message, and Severity.

To specify the validation rule properties

1. Open the Constraint Specification window. How to open the Specification window >>301302
2. On the right side of the window, find the Validation Rule group.
3. Specify the following properties:
• Abbreviation. Select the Abbreviation property value box, click and type a
short word, phase, acronym of the validation rule. It allows you to distinguish the
validation rules among other rules when sorting or filtering.
• Error Message. Select the Error Message property value box, click and type the
description of the invalid situation when this validation rule fails.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 113

  If you need to define the variable error message, you can embed expressions
directly in the Error Message value box by using curly brackets - {}. Everything
between them is treated as an expression and evaluated for each validation
result. Expressions are treated as OCL2.0 expressions by default, but you can also
use binary expressions: {bin: <binary expression>}. For example, in the following
error message the budget is calculated according to variables. The result of the
expression is provided as number in the Validation Results panel303304, e.g.
Budget not balanced - overbudget by $500.

Budget not balanced - overbudget by {

ResearchProject::allInstances().budget->sum() -
Sponsor::allInstances().contribution->sum()}$

You can insert a hyperlink. Learn more about defining hyperlinks >>305306

• Severity. Select the Severity property value and from the drop-down list select one of the
following severity levels:
• debug - for missing information of a constrained element that is dedicated for the
developer.
• info - for missing information of a constrained element that is dedicated mostly for
the end-user.
• warning - for incorrect situations that can cause errors. It is used for less severe
situations than the error.
• error - for incorrect situations that must be solved.
• fatal - for critical errors such as model corruption or model is invalid according to
the UML metamodel. This severity level is mostly reserved for future use.

 The icons on invalid elements in the model depend on the selected severity
level described above. Learn more about invalid elements representation
>>307308
You can customize severity levels. How to customize severity levels >>309310

4. Click Close.
The validation rule properties are specified.

Customizing severity levels

You can customize the default severity levels (such as debug, info, warning, error, fatal) by creating
new and and additional levels. For this you must edit the SeverityKind Enumeration311312element,
located in the UML Standard Profile.

 We do not recommend changing the UML Standard Profile.

To customize severity levels

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 114

 1. Edit the UML Standard Profile. (see page 116)
2. Create new or modify default severity levels. (see page 116)
3. Define new icon for severity level. (see page 118)
4. Apply new icon for severity level. (see page 119)
After you create the custom severity level or modify the default severity, you can select it from from the
drop-down list of the Severity property when specifying the validation rule properties313314. In the
following figure the new severity level named critical can be selected as a value of the Severity property
in the Specification window of validation rule (Constraint element). The value order in the Severity
drop-down list is the same as they are listed in the SeverityKind Enumeration element.

The custom severity level named critical in the drop-down list of the Severity property in the validation rule specification.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 115

Editing the UML Standard Profile

To edit the UML Standard Profile

1. Open a project.
2. In the Containment tree315316, click and enable to show the Show Auxiliary Resources in
the Model Browser317318.
3. Right-click the UML Standard Profile Package.
4. Select Project Usages > Open. Learn how to manage project usages >>319320
The UML Standard Profile is now editable.

Creating new or modifying default severity levels

 You can create new or modify default severity levels only if the UML Standard Profile is
editable. To see how to edit the profile read the procedure above (see page 116).

Each Enumeration Literal created for the Enumeration element corresponds to available severity levels.

To modify default severity levels (Enumeration Literals)

1. In the Containment tree321322, click + to expand the UML Standard Profile Package > Validation
Profile Package.
2. Double-click the SeverityKind Enumeration element to open its Specification window323324.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 116

 3. On the left side of the Specification window, select the Enumeration Literals property
group325326.

4. On the right side of the Specification window, select severity level from the list:
- Click to open Specification window327328.
- Click the Up/Down button to move the severity level up/down in the list.

 Severity levels are listed in ascending order according to severity importance.

- Click the Clone button to create the same severity level. The Specification window of newly
created Enumeration Literal opens. Type its unique name.
- Click the Delete button to remove the selected severity level from the model.
5. Click Close.
The default severity levels are modified.

To create a new severity level (Enumeration Literal)

1. In the Containment tree329330, click + to expand the UML Standard Profile Package > Validation
Profile Package.
2. Double-click the SeverityKind Enumeration element to open its Specification window331332.
3. On the left side of the Specification window, select the Enumeration Literals property
group333334.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 117

 4. On the right side of the Specification window, click the Create button. The Specification window
of the newly created Enumeration Literal opens.
5. In the Name property, type the name of the new severity level (e.g. critical).
6. Click Close.
The new severity level is created and can be modified by using buttons (see page 117).

Defining new icon for severity level

You can define a different icon for a custom or default severity levels (Enumeration Literals). For this,
you must create a new stereotype and specify its Icon and Metaclass properties.

To define a new icon for the severity level (Enumeration Literals)

1. In the Containment tree335336, right-click the Validation Profile Package, and select Create
Element > Stereotype.
2. Type its name (e.g. criticalIcon) and press Enter.
3. Double-click newly created Stereotype.
4. In the Specification window337338 of Stereotype specify the following properties:
- Select the Icon property value, click to select an image from the Image Library339340, or to
select an image from your file system.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 118

 - Select the Metaclass property value, click and select EnumerationLiteral.

5. Click Close.
The new stereotype with a new icon is created and ready to be applied to a severity level. How to
apply it >> (see page 119)

Applying new icon for severity level

After you define the new icon for severity level, you can apply it to custom or default severity levels
(Enumeration Literals). This icon is shown when representing invalid elements341342 of your model.

To apply a new icon to a severity level

1. In the Containment tree343344, click + to expand the UML Standard Profile Package > Validation
Profile Package > SeverityKind Enumeration element.
2. Double-click the severity level (Enumeration Literals element) to which you want to apply a new
icon.
3. In its Specification window345346, select the Applied Stereotype property value.
4. Click and select the newly created stereotype (e.g. criticalIcon) dedicated for this severity
level.
5. Select Apply.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 119

 6. Click Close.
The new icon for the severity level is applied. In the figure below, the criticalIcon stereotype is
applied to the new critical EnumerationLiteral element.

Defining Constraint condition

You must specify the validation condition for a validation rule. This condition must be true when
evaluated in order for the Constraint to be satisfied. The result of a validation rule must be of the
boolean type.

To define a Constraint condition

1. Open the Constraint Specification window. How to open the Specification window >>347348
2. Find the Specification property and select its value box.
3. Click .The Specification dialog opens.
, select one of the following languages:
4. From the Language list
OCL349350 2.0 is used for validation rules, specified in OCL language. Learn how to create
OCL2.0 validation rule in Developer Guide >> (see page 120)
•

 OCL Header

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 120

 If you select the OCL2.0 language, the header of the expression from the
constraint information is generated automatically
according to the following rules: context <constrained element> <constraint type>
<constraint name if any>:. See the following image.

Constraint types
Since the Constraint is stereotyped by «validationRule» which is derived from
«invariant » stereotype, inv is shown in the header.
Only inv constraints can be evaluated.
Other types of Constraints
are not evaluated, butcan be modeled for documentation purposes:
• def – for the expression of the constraint with «definition» stereotype
applied.
• init, derive - for the expression of the default value of the property.

 The derive expressions can be evaluated indirectly when the

validation rule (inv constraint) is referencing the property and the
validation rule is evaluated.

• pre, post, body - for the expression of the appropriate fields of operation.

OCL Performance
When evaluating the validation rule defined in OCL language, the validation on the
first run can have a delay of 20-30 seconds (depending on the computer
performance) while the Java compiler is loading. Subsequent validations will run
faster than the first one.
If the validation process is run heavily on medium-large projects, increasing the
default Java VM size is advisable. By default, the VM size is set to 400MB in the
modeling tool; increasing this to 600 (or 800 if the computer has sufficient RAM)
might improve the performance.

• Binary is used for more advanced expressions not easily expressed in OCL.These
expressions are written in Java, compiled, and specified in the modeling tool's classpath.
These expressions can then be specified as validation rule expressions.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 121

 Scripts of JavaScript, Jython, Groovy, and BeanShell. Learn more about script writing in
• Creating executable opaque behaviors351352.
Since constraints cannot have parameters, you may skip the information about managing
parameters.
• StructuredExpression. Learn more about specifying criteria for querying model >>353354

In the Body box, type the expression of the selected language syntax.
5.

 The modeling tool can evaluate only those validation rules whose expression is defined
in one of the languages listed above. The other languages can be used only for
documentation purposes.

355356
 You can add hyperlinks in the Body box. How to define hyperlinks >>
You can define expressions for global validation rules. Learn more about global
validation rules >>357358

(optional) Click the Evaluation Mode button to to execute an expression on the actual testing
model while editing. How to use the Evaluation Mode >>359360
6.
7. Click OK.
The Constraint condition is defined.

Global validation rules

Global validation rules check the result of an element set, while validation rules contained in predefined
validation suites361362 or active validation suites363364 are dedicated to check a separate element. You
can create global validation rules in the same way as other validation rules by defining an appropriate
condition in the Specification property.

• How to create validation rules >365366

• How to define Constraint expression >>367368
For example, the balanced budget validation rule (Constraint specification is shown in the following
figure) is a global validation rule. It is created for the classifier of the ReseachProject Class. The balanced
budget validation rule condition, defined by using OCL2.0 language in the Specification property,

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 122

expresses that the sum of the expenses of all projects must be less than the sum of all Sponsor
contributions. This validation rule is global because it includes all instances in the model, rather than
only the particular instance of ResearchProject that violates the rule.

 Sample model
An example of a global validation rule can be found in the model validation sample model >
Classifiers Validation Rules Class diagram369370. To open this sample do one of the following:
• Download model validation.mdzip371372.
• Find in the modeling tool <modeling tool installation directory>\samples\product
features\model validation.mdzip.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 123

 The specification of the global validation rule named balanced budget.

After the validation finishes, the global validation rule is marked as <model> in the Validation Results
panel373374 > Element column. This means that the entire model, not the separate element, violates the
rule.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 124

 The representation of global validation rule in the Validation Results panel.

Metrics
A metric is information about a specific aspect of the model. A collection of various metrics can be used
to evaluate the current state of your model. When calculated at regular intervals, they can help track
the evolution of the model's development.

There are two metric suites dedicated to coverage analysis:

• The Design metric suite checks incoming satisfy relations.

• The Test cases metric suite checks incoming verify relations.

Example of metrics table.

When working with requirements, it is useful to know what and how many requirements are covered
by design elements (satisfy relations), by test cases (verify relations), are user requirements covered
with system requirements, and how many requirements are already implemented or tested. In these
situations metrics help you evaluate the current state of requirements in your model and track the
progress of their coverage.

The metric suite Requirement Coverage (Treat Owner as Grouping Element) is considered as covered if
it satisfies one of the following conditions:

• A requirement has a satisfy relation with a design element.

• The owning requirement is covered.
• All owned requirements are covered.

The metric suite Requirement Coverage (Treat Owner as Regular Requirement) is considered as
covered if the requirement has a satisfy relation with a design element:

• If all child requirements have incoming satisfy relations, grouping requirements are not
considered as satisfied unless they also have incoming satisfy relations.
• If the grouping requirement has incoming satisfy relation, its child requirements are not
considered as covered unless they have incoming satisfy relations.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 125

 Examples of covered requirements.

To use coverage analysis metrics

1. Select the package that includes the requirements.

2. From the shortcut menu, select Tools > Metrics > New Metric Table.
3. In the Create Metric Table dialog, set to true one of the metric suite:
• Requirement Coverage (Treat Owner as Grouping Element).
• Requirement Coverage (Treat Owner as Regular Requirement).
4. Click OK.
The new metric table with calculated results is created.
You can create custom metric suites using structured expressions or scripts. For detailed procedures
on creating metric suites, calculating metrics, and managing metric results, please see Creating Metric
Suites375 and Metric table376.

Sorry, the widget is not supported in this export.

But you can reach it using the following URL:

https://www.youtube.com/watch?v=YgyeNgpR7TA

Related pages

• Creating Metric Suites377

• Metric table378

Using Requirement patterns glossary

On this page

• Enabling/disabling the Requirement patterns underlining in Requirement text (see page 127)
• Defining custom condition patterns (see page 127)
• Opening the predefined requirements glossary table (see page 128)

You can use the specific condition patterns in Requirement texts if you want to extract Constraint from
Requirement automatically (see page 126).

Enabling/disabling the Requirement patterns underlining in

Requirement text
Before using this feature, make sure the Underline Patterns in Requirement Text option is enabled.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 126

To enable/disable Requirement patterns underlining

1. From the main menu, click Options > Project.

2. In the Project Options dialog, under the General group, click Requirements and select the
Underline Patterns in Requirement Text option.
3. Set its value to true to underline the Requirement text that matches the defined pattern, or false -
to disable it.

 The default value of the Underline Patterns in Requirement Text option is true.

Defining custom condition patterns

If you can't find an appropriate condition pattern from the predefined glossary table, you can define a
custom glossary. For this, you have to create a new Glossary Table with the <<requirementTerms>>
stereotype applied.

To create a new glossary table with the stereotype379<<requirementTerms>>

1. From the main toolbar380, click the Create Diagram button.

2. Double-click the glossary table icon.
3. Open the Specification window of the newly created Glossary table.
4. Change the Applied Stereotype property value to <<requirementTerms>>.
5. Click Close.
The new glossary table with the stereotype <<requirementTerms>> is created. You can now
define your own condition patterns by adding them in the Glossary Table381.

379 https://docs.nomagic.com/display/MD2024xR1/Stereotype
380 https://docs.nomagic.com/display/MD2024xR1/Toolbars
381 https://docs.nomagic.com/display/MD2024xR1/Glossary+table

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 127

Opening the predefined requirements glossary table
You can use condition patterns from the already created glossary table. If you want to check the most
frequently used patterns, open the predefined glossary table.

To open the predefined glossary table

1. In the Model Browser382, click and

select Show Auxiliary Resources.
2. Expand MD Customization for Requirements Package > requirement verification Package.
3. Double-click the requirement verification to open the table (see the figure below).

The glossary table with the stored frequently used condition patterns opens (see the following figure).

382 https://docs.nomagic.com/display/MD2024xR1/Model+Browser

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 128

  Warning
You cannot extend the list of custom condition patterns in this Glossary Table.

Extracting Constraint from Requirement

• Creating the Satisfy relationship (see page 129)
• Extracting Constraint from Requirement (see page 130)
The Extracting Constraint from Requirement functionality provides the ability to verify Requirements
easier when trying to prove the assertion is true (or false). A glossary mechanism extracts the constraint
directly from the Requirement text. If you want to create constraints and associate them with the
requirements automatically, you can use the extract Constraint from Requirement text functionality.

To extract Constraint (see page 129) value from Requirement (see page 129) text

1. Use the Requirements patterns glossary in Requirement text. (see page 129)
2. Create the Satisfy relationship between the specific value of design element and
requirement. (see page 129)
Extract Constraint from Requirement text (see page 130).
3.

Creating the Satisfy relationship

The specific value of the design element must satisfy the Requirement. As shown below, the
distanceOnQuickCharge value of the High-voltage Battery Block satisfies the Quick charge mode distance
Requirement.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 129

Extracting Constraint from Requirement
To extract a Constraint from a Requirement

1. Right-click a value property in the compartment area of the element shape.

2. Select Tools > Extract Constraint From Requirement.
The constraint is created automatically with a value and condition pattern defined in the
Requirement.

In the example below, the text "at least 70" of the Quick charge mode distance Requirement is
automatically parsed to "distanceOnQuickCharge >= 70" and solved as a constraint.

After selecting the Extract Constraint From Requirement command, the constraint
{distanceOnQuickCharge >=70.0} is automatically created. It satisfies the requirement text "at least 70".

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 130

Related pages

• Importing requirements (see page 129)

• Exporting requirements (see page 129)
Sample model

The model used in the figures of this page is the extract requirement values sample model To open
this sample do one of the following:

• Find in modeling tool <modeling tool installation directory>\samples\SysML\extract requirement

values.mdzip.

Exchanging requirements with ReqIf

Requirements are gathered and managed in dedicated requirements tools. When it comes to
requirements refinement and integration with business, software, and system architecture, different
requirements interchange formats are used. It can be comma separated value, MS Excel, Word, or XML.
These are nonstandard ways, which bring drawbacks. It is clear that need for dedicated common
format exists. This is why the German automotive industry started the open, non-proprietary format for
requirements exchange development.

Starting with the upcoming v18.0, all MagicDraw-based Cameo Suite products will support ReqIF import
as part of the new Cameo Requirements Modeler plugin.

• What is ReqIF? (see page 131)

• ReqIF Support in MagicDraw (see page 132)
• ReqIF Importer Features (see page 133)
• More About ReqIF (see page 135)
• ReqIF Recognition (see page 135)
• ReqIF Sources (see page 135)

What is ReqIF?
ReqIF is the XML-based international standard for requirement data exchange, standardized by the
Object Management Group (OMG). It has solid recognition in the industry and adoption by many
requirements management tool vendors. It is used to exchange requirement information between
different tools and toolchains.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 131

“For requirement analysis, ReqIF is the same as Unified Modeling Language (UML) for modeling – it is
the most popular and dedicated requirements interchange format.”

ReqIF Support in MagicDraw

ReqIF Importer imports and updates (previously imported) requirements in models with the following
capabilities:

• Import process includes the ability for custom mapping with the option to import all data and
dynamically create properties.
• Update process includes changing management support with requirements status identification.
After import, new, changed, updated or obsolete requirements are identified with the ability to
check the impact of changes.

Once imported, requirements become first-class citizens in the modeling world. That means they can
be:

• Integrated with other models: business, software, and systems architecture, test cases, and
toolchains: PLM tools (e.g. Teamcenter), CAD tools (e.g. Catia), and others. This enables
requirements-driven design and communication of changes with all stakeholders.
• Reviewed with visualization in diagrams, tables, matrices, and structure maps.
• Analyzed with built-in and custom validation suites, coverage metrics, traceability.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 132

 • Collaborated with a global modeling project’s repository, supporting collaboration inside a
project, change and configuration management, multisite support.
• Simulated with OMG standard-based model execution, debugging, animation, and user
interface prototyping supporting framework.
• Published with MS Office and Open Office docs, Web-based reports, with the ability to have
custom reports incorporating required data.

ReqIF Importer Features

1. Import data that originated in a wide variety of tools*

* Import tested with: IBM Rational DOORS 9.4, 9.5, Next Generation, Polarion, PTC Integrity,
Siemens TC, and other ReqIF 1.0 compatible data sources.
2. Update existing data. It is possible to create relations to any other model element, e.g. test
cases, or architectural components, to realize total traceability as required by the processes. On
update, all custom relations are left untouched.
3. Change status identification (updated, new, unchanged, or obsolete)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 133

 4. Requirements structure and structure changes support

5. Physical requirements remove action

6. Status and summary notification message

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 134

 7. Custom mapping

8. Dynamic properties discovery, no need to determine what data is in ReqIF file, all the
properties can be imported
9. Omit the data you don’t need to import
10. Rich text support

More About ReqIF

ReqIF Recognition
The group working on the initial release of ReqIF consists of the ProSTEP iViP Association, Atego
Systems GmbH, Audi AG, BMW AG, Continental AG, Daimler AG, HOOD GmbH, IBM, MKS GmbH,
PROSTEP AG, Robert Bosch GmbH, and Volkswagen AG.

ReqIF Sources
• Rational DOORS, DOORS Next generation, IBM Rational Requirements composer (http://
www-01.ibm.com/software/rational/)
• Polarion (http://www.polarion.com/2014/reqif-solution.php)
• PTC Integrity (http://www.mks.com/platform/our-product)
• Siemens Teamcenter (http://m.plm.automation.siemens.com/en_us/Images/Siemens-PLM-
Teamcenter-Requirements-Integrator-for-RIF-ReqIF-fs_tcm1224-213684.pdf)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 135

 • LieberLieber for EA (http://www.lieberlieber.com/en/model-engineering/reqif/)
• Agosense (http://www.agosense.com/english/products/platform-und-adapter/
agosensesymphony)
• ReqIF Server (http://enso-managers.de/)
• MS Excel to ReqIF exporter (http://www.pyrrho.com/en/ReqIF/ReqIF-Intro.htm)
• GitHub EnterpriseArchitect_ReqIF_AddIn (https://github.com/redsteve/
EnterpriseArchitect_ReqIF_AddIn)
• Requisis Rex (https://requisis.com/de/produkte/rex-doors-reqif-rif-export.html)
• VISURE (http://www.visuresolutions.com/)
• Formalmind (www.formalmind.com/383)

Generating requirement reports

You can generate Requirement reports in the .docx and .html/.htm formats directly from your model.

• Generating the Word document report (see page 136)

• Generating requirement report by using the Report Wizard (see page 136)
• Generating requirement report from the Containment tree (see page 137)

Generating the Word document report

You can generate the Requirement report in word document in the following ways:

• Generating requirement report by using the Report Wizard (see page 136)
• Generating requirement report from the Containment tree (see page 137)

 Report customization
If you want to customize the report or create your own template for a requirement report , you
may use the Report Wizard384.

Generating requirement report by using the Report Wizard

To create a .docx format report by using the Report Wizard

1. In the Tools menu, click Report Wizard.

2. In the Select Template area, select Requirements, and choose one of the following report type:
- Requirement Dependencies Report. This report contains tables of requirement
dependencies, that is separate tables for Copy, Derive, Refine, Satisfy, Trace, and Verify relations.
- Requirement Diagram. This report lists all requirement diagrams of a selected scope. Diagram
elements and dependencies are described in tables under each diagram.
- Requirement Report. This is a standard detailed requirement report, containing all
requirements attributes. This template may be used as a requirement specification report.
- Requirements Table Diagram Report. This report lists all requirement tables of a selected
scope.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 136

 3. Click Next.
4. In the Select Report Data area, you can then select a predefined report data for the selected
template (default = Built-in). Click Next.
5. In the Select Element Scope area use:
• The Add button to add an element selected in the element tree to the Selected
objects area.
• The Add All button to add all elements directly owned by the element selected in the
element tree to the Selected objects area.
• The Add Recursively button in to add all elements listed under the element selected in
the element tree to the Selected objects area.
• The Remove button in to remove the selected element from the Selected objects area.
• The Remove All button in to remove all selected elements from the Selected
objects area.
6. Click Next.
7. In the Output Options area, define the appropriate options.
8. Click Generate.
Your report is generated and automatically opens.

Generating requirement report from the Containment tree

To generate Requirement reports from the Containment tree

1. In the Containment tree, right-click the selected requirement specification (Package) or

Requirement.
2. From the shortcut menu, click Generate Report > Requirements and select a desired
requirement template.
3. In the Select Location dialog, specify a report location and specify a report file name.
4. Click Save.
The report is generated.

Basic requirement concepts

This section contains all basic concepts that are used while using the Cameo Requirements Modeler
Plugin.

Basic requirement concepts:

Diagram descriptions
This sections provides all descriptions of the requirement diagrams, tables, and matrices.

Requirement Diagram
Requirement Diagram is particularly valuable when you want to demonstrate the traceability from the
requirements to the elements in your system model that are dependent on them. This diagram
provides modeling constructs to represent text-based requirements and relate them to other modeling
elements. These requirement modeling constructs are intended to provide a bridge between traditional
requirement management tools and other SysML models.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 137

Requirements diagrams display requirements, packages, other classifiers, test cases, rationales, and
relationships. Possible relationships available for Requirements diagrams are containments, deriveReqt
and requirement dependencies (‘Copy’, ‘Refine’, ‘Satisfy’, ‘Trace’, and ‘Verify’). The callout notation can
also be used to reflect the relationships of other models.

Requirements can also be shown on other diagrams to illustrate their relationships to other modeling
elements.

20 Requirement Diagram

Requirement Table
A Requirement Table is used to type a requirements into a spreadsheet-like table.

Requirements Table contains requirements. All requirements are text-based. Each row in the table
represents a requirement. A new table consists of four columns by default (#, Id, Name, Text). You can
add more columns to represent the properties of each requirement in the table. With this table, you
can:

• Create new requirements directly in the table, or import existing ones from your model to the
table.
• Edit the properties of requirements directly in the table.
• Generate requirements reports, renumber requirements’ IDs, or export the table into a CSV or
HTML format, or into a Microsoft Excel (.xlsx) spreadsheet.
• Search and filter requirements.
• Access custom requirement’s properties.

21 Requirement Table

Requirement matrices
The matrices enables you to analyze, create, and modify relationships between Requirements and
other design elements. You can create five kind of matrices:

• Derive Requirement Matrix.

• Refine Requirement Matrix.
• Satisfy Requirement Matrix.
• Verify Requirement Matrix.
• SysML Allocation Matrix.

 You can create SysML matrices only if you have SysML Plugin385386 installed. How to install
387388
SysML Plugin >>

The purpose and examples of each matrix are provided in the following pages:

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 138

All SysML matrices are based on Dependency Matrix389390. That's why all it's procedures are allowable
for SysML matrices:

Element descriptions
This section provides all descriptions of the requirement elements.

Business Requirement

A Business Requirement is a requirement that specifies characteristics of the business process that
must be satisfied by the system.

Related diagrams

• Requirement Diagram (see page 139)

• Requirement Table (see page 139)

Design Constraint
A Design Constraint is a requirement that specifies a constraint on the implementation of a system or
on a part of it.

Related diagrams

• Requirement Diagram (see page 139)

• Requirement Table (see page 139)

Extended Requirement
An Extended Requirement is a standard Requirement subtype, which adds some properties to a
requirement element. These properties such as a source, risk, and verify method are important for the
requirement management. Specific projects should add their own properties. All these properties are
now available in the standard Requirement Specification window and Requirements Table. If any of
these property values is specified, a requirement is automatically converted to ExtendedRequirement.

Related diagrams

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 139

 • Requirement Diagram (see page 139)
• Requirement Table (see page 139)

Functional Requirement
A Functional Requirement is a requirement that specifies a behavior that a system or a part of a system
must perform.

Related diagrams

• Requirement Diagram (see page 140)

• Requirement Table (see page 140)

Interface Requirement
An Interface Requirement is a requirement that specifies the ports for connecting systems and parts of
a system. Optionally, it may include the items that flow across the connector and/or the Interface
constraints.

Related diagrams

• Requirement Diagram (see page 140)

• Requirement Table (see page 140)

Performance Requirement
A Performance Requirement refers to a requirement that quantitatively measures the extent to which a
system or a system part satisfy a required capability or condition.

Related diagrams

• Requirement Diagram (see page 140)

• Requirement Table (see page 140)

Physical Requirement
A Physical Requirement specifies the physical characteristics and/or physical constraints of a system or
a system part.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 140

 Related diagrams

• Requirement Diagram (see page 140)

• Requirement Table (see page 140)

Requirement
A Requirement specifies a capability or a condition that must (or should) be satisfied. Requirements are
used to establish a contract between the customer (or other stakeholders) and those responsible for
designing and implementing the system. A requirement can also appear on other diagrams to show its
relationship to other modeling elements.

When a requirement nests other requirements, all the nested requirements apply as part of the
container requirement (the requirement that contains all the nested requirements). Deleting the
container requirement will thus delete all the nested requirements it contains; a functionality inherited
from UML.

Related diagrams

• Requirement Diagram (see page 141)

• Requirement Table (see page 141)

Usability Requirement
A Usability Requirement specifies the fitness for use of a system for its users and other actors.

Related diagrams

• Requirement Diagram (see page 141)

• Requirement Table (see page 141)

Derive
A 'Derive' relationship is a dependency between two requirements (a derived requirement and a source
requirement), where the derived requirement is generated or inferred from the source requirement.

Related diagrams

• Requirement Diagram (see page 141)

• Requirement Table (see page 141)
• Derive Requirement Matrix (see page 141)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 141

Copy
A Copy relationship is a dependency between a supplier requirement (master) and a client requirement
(slave), specifying that the client requirement text is a read-only copy of the supplier requirement text.
In other words, by creating a Copy dependency between two Requirements, you copy the text property
from the supplier to the client.

To create a Copy dependency between two requirements on the diagram

1. On the diagram, select a client Requirement symbol (slave), a symbol you want to be a copy of
the supplier Requirement (master). The smart manipulator appears.

2. Select the Copy command as depicted in the preceding figure and connect the client
Requirement to the supplier Requirement.
3. The Copy path goes yellow because of violation of the rule Invalid Slave Requirement text
meaning the text of the slave Requirement must be the same as of the master Requirement.
Click the Copy path and, in the smart manipulator, select the Validation command.

4. The list of suggested solvers appears. Select Copy text of the supplier requirement to the
client requirement to create and sustain this dependency in your model correctly.

 Ignoring solver
You may select other solvers but note:
• Remove Copy dependency - removes the dependency from the diagram and the
entire model.
• Ignore - ignores the violation and the dependency is created and sustained in the
model with the violation.

Related pages

• Requirement Diagram (see page 142)

• Requirement Table (see page 142)
• Validation391

Test Case
A Test Case (Activity / StateMachine / Interaction) is a method for verifying a requirement.

Related diagrams

• Requirement Diagram (see page 142)

• Requirement Table (see page 142)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 142

Trace
A 'Trace' relationship is a dependency between a requirement and an arbitrary model element traced
by this requirement.

Related diagrams

• Requirement Diagram (see page 143)

• Requirement Table (see page 143)

Verify
A 'Verify' relationship is a dependency between a requirement and a test case or a model element that
can determine whether the system fulfills the requirement. As with other dependencies, the arrow
direction points from the (client) test case to the (supplier) requirement.

Related diagrams

• Requirement Diagram (see page 143)

• Requirement Table (see page 143)
• Verify Requirement Matrix (see page 143)

Refine
A 'Refine' relationship is a dependency that describes how a model element or a set of elements refine
a requirement. For example, a use case or activity diagram may be used to refine a text-based
functional requirement. Alternatively, it may be used to show how a text-based requirement refines a
model element. In this case, some elaborated text could be used to refine a less fine- grained model
element.

Related diagrams

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 143

 • Requirement Diagram (see page 143)
• Requirement Table (see page 143)

Satisfy
A 'Satisfy' relationship is a dependency between a requirement and a model element that fulfills that
requirement. As with other dependencies, the arrow direction points from the satisfying (client) model
element to the (supplier) requirement that is satisfied.

Other descriptions
This section contains other concepts related with the requirements.

ReqIF
The Requirement Interchange Format (ReqIF) standard is an XML based international standard adopted
by Object Management Group (OMG) as a formal specification for exchanging requirements between
software tools from different vendors.
Related pages

• Exchanging requirements with ReqIf (see page 144)

Requirement Specification
A represented collection of requirements that are related by a user decision or needs. A Requirement
Specification may represent requirements for a system, a component, or other subjects. In a means of
MagicDraw, a Requirement Specification is a package of requirements. A Usability Requirement
specifies the fitness for use of a system for its users and other actors.

Customizations

Specifying project properties

The Project Properties dialog provides general information about a project. You can add a title,
author, version, and project description using this dialog.

To open the Project Properties dialog

1. Open the project.

2. Select the Project Properties command from the File menu.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 144

 Project properties dialog.

 Title
The project title is assigned as a value of the project Documentation property392393.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 145

Compatibility range
To specify compatibility range

1. Enter the Version value.

2. Enter the Compatible with. The value must be less or equal to the Version value.
3. Click OK after you are done.

 Compatible With
Compatible With defines the compatibility range between two Standard/System profile
versions. Once specified, it helps to avoid read-only constraints in TWCloud projects when you
use earlier profile versions locally rather than those used in the server project.
When the Version of the Standard/System profile on your computer is earlier (e.g. 19.0 SP1)
than the Version of this profile on TWCloud (e.g. 19.0 SP3), but higher or equal to the value of
Compatible with (e.g. 19.0), you will still be able to edit TWCloud projects using the profile.

Advanced options
To use advanced options

1. Click More to see more options:

• See the list of shared packages in the Shared Packages tab. In this tab you can:
• Define a preferred path to the particular package. Click the ... button to select the
package394395 in the Preferred Path value box.
• Set the project as a standard/system profile by selecting the Standard/System
Profile check box.

 Note
The Shared Packages tab is available for local projects only.

• The Used Projects tab shows the projects and standard/system profiles used in the open
project. Click the Open Project Usages button to open the Used Projects dialog396397,
where you can modify project usages.
• The Advanced tab shows project meta information. In this tab you can:
• Reset all project element IDs. All project elements have their own ID (a unique
identifier). While working with several related projects, you may receive a message
about duplicated element IDs. After clicking the Reset IDs button, new IDs will be
created for all project elements.

 Note
Make sure the project you are resetting IDs for is not used in other projects.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 146

 • Reset the project ID. After clicking the Reset Project ID button, new IDs are created
for the project.

 You cannot reset the project ID for server projects.

Assigning shortcut keys

Most commonly used commands in a modeling tool have shortcut keys398399, allowing you to access the
commands quicker. However, you can assign custom shortcut keys to modeling tool commands and
change or remove already existing shortcut keys.

To assign a new shortcut key to a command

1. From the main menu of a modeling tool, select Options > Environment. The Environment
Options dialog opens.
2. From the option group list on the left side of the dialog, select Keyboard.
3. Search for the command you need to assign a shortcut key to.

 You can also search by the shortcut keys.

4. In the Press new shortcut key box, press the shortcut you want to assign. Do not type the
shortcut, but press the keys as you would when executing the command.
5. Click the Assign button. The assigned shortcut appears in the Current keys box.
6. Click OK.

The shortcut key is then assigned to the selected command and you can start using it.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 147

 Assigning a shortcut key.

 Usage information
• You can assign multiple shortcut keys to one command.
• If you enter a shortcut key that is already assigned to another command, a notification
appears under the Press new shortcut key box.
• If you assign a shortcut key that is already assigned to another command, the shortcut
key is automatically unassigned from that command and assigned to the new one.

Removing shortcut keys

You can remove both default and custom shortcut keys.

To remove a shortcut key

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 148

 1. From the main menu of the modeling tool, select Options > Environment. The Environment
Options dialog opens.
2. From the option group list on the left side of the dialog, select Keyboard.
3. Search for the command you need to assign a shortcut key to.

 You can also search by the shortcut keys.

4. In the Current keys box, select the shortcut key you want to remove.
5. Click the Remove button. To remove all shortcut keys assigned to the selected command, click
the Remove All button.
6. Click OK.

 Restoring shortcut keys

To restore all shortcut keys to their default values, open the Environment Options dialog,
select Keyboard, and click Reset to Defaults.

Configuration files
A configuration file is where the initial parameters and settings of a program are defined. All default
parameter values come with a program installation but you can edit configuration files and define your
own values, for example, define the Java home directory. This page describes the locations where you
can find the configuration files of your modeling tool, and how you can modify them and change their
default storage location. Configuration files can be used to:

• Define application arguments

• Set the Java Home
• Change Java parameters (such as memory allocation)
• Update default Java classpath (advanced: for plugin developers)
The configuration files can be opened and modified using any standard text or code editor. Once
modified, changing the default location of configuration files can allow you to store multiple
configuration files for different versions of the tool.

This page covers all modeling tools:

• MagicDraw
• Cameo Enterprise Architecture
• Cameo Systems Modeler
• Magic Software Architect
• Magic Cyber Systems Engineer
• Magic Systems of Systems Architect

By default the configuration and auxiliary files of a modeling tool are stored in the following location:

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 149

 OS Configuration files storage

Windows C:\Users\<USERNAME>\AppData\Local\.<modeling tool

Vista/7/8/10 name>\<modeling tool version number>

Other OS <user.home>/.<modeling tool name>/< modeling tool version

number>

 Modeling tool file naming

In a file system, modeling tools' folders are named as follows:
Modeling tool File name

MagicDraw magicdraw

Cameo Enterprise Architecture cameoea

Cameo Systems Modeler cameo.systems.modeler

Magic Software Architect magic.software.architect

Magic Cyber Systems Engineer magic.cyber.systems.engineer

Magic Systems of Systems Architect magic.systems.of.systems.architect

Getting the path to configuration files

If you do not know the exact path to your modeling tool configuration files, follow the steps below to
get it.

To get the path to the configuration files

1. From the Help menu, select About <modeling tool name>. The About dialog opens.
2. Click the Environment tab.
3. Click the hyperlink next to Configuration Files. The folder containing modeling tool
configuration files opens.

You can also save configuration files in any of the following locations:

• <modeling tool installation directory>

• Common Application Data location (on Windows OS)
• Another directory

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 150

Storing configuration files in the installation directory or Common Application
Data location on Windows

 Note
The Common Application Data location on Windows Vista/7/8/10 is C:\ProgramData.

To store configuration files in the modeling tool installation directory or Common Application Data
location on Windows

1. Open the <modeling tool name>.properties file, which is located in <modeling tool installation
directory>\bin.
2. In the JAVA_ARGS line, change the -DLOCALCONFIG property value according to the following
table:

-DLOCALCONFIG =true =false

Windows OSx Common Application Data Modeling tool installation directory

Other <user.home>/.<modeling tool Modeling tool installation directory

name>/< modeling tool version
number>

 Important!
It is important to add the -DWINCONFIG=false parameter on Window OS, otherwise, the
configuration files will not be stored in the modeling tool installation directory.

You may also store configuration files in your custom location.

Storing configuration files in a custom location

 Note
If you have defined to store files in the modeling tool installation directory, files will not be
stored in the defined location.

To store modeling tool configuration files in a custom location

Do either:

1. Open the <modeling tool name>.properties file, which is located in <modeling tool installation
directory>\bin.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 151

 2. In the JAVA_ARGS line, add the following property:
-Dlocalconfig.location=<absolute path to a custom location>

 Sample property value

-Dlocalconfig.location\=E\:\\temp\\innerPack

Or:

1. Go to the folder, where the configuration files are stored (see page 150). (see page 149)
2. Create a new file named magicdrawredirect.
3. In the file, type the absolute path to the folder, wherein modeling configuration files will
be saved, e.g., C:/<directory name>.

Customizing environment options

You can customize the application environment according to your preferences via the Environment
Options dialog.

Opening the Environment Options dialog

To open the Environment Options dialog

• From the Options menu, select Environment.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 152

22 Structure of Environment Options dialog

The Environment Options dialog contains various project-independent options grouped by different
features (for example, diagrams, Model Browser, code engineering). Each option group is available in a
different tab. Tabs are displayed in the tab tree.

An option value can be simply changed by typing a new value, setting a value to true/false, or selecting
a value from the list. Click the Reset to Defaults button to restore default option values.

Changing options
In order to change the desired environment option, first of all, you may need to find it. In this case, use
the quick filter400401 in the dialog. Filtering is performed in all available options, not only in the selected
option group. To better understand an option, you can read its description, which tells the effect of
changing the option value.

To read the option description

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 153

 1. Make sure that the Show Description mode is turned on in the Environment Options dialog. To
turn the Show Description mode on or off, click the Show Description button on the tab toolbar.

23 The Show Description button in the Environment Options toolbar

2. Click an option whose value you want to change.

3. Read the option description in the area below the tab options list. You are ready now to
change the option value.

Environment Options

 The table below displays the default environment options. Additional options may appear
based on installed plugins.

Option Default value Value options Description

General

Active Validation

Active Validation All All Specify the active validation mode. Select 'All' to
enable all active validation suites. Select 'System'
System to enable only those validation rules that are
responsible for project composition integrity.

Active Validation 2 Real Specify the period (in seconds) of waiting until the
Period (seconds) active validation will be run in the model. Note:
better performance of the application can be
ensured by specifying a longer period.

Display

Language English System Specify the language for the application GUI.
Restart the application to apply changes.
English

French

German

Japanese

Russian

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 154

 Option Default value Value options Description

Display Title Bars true true/false Set to true to display the title bar area in
application dialogs.

Show Status Bar true true/false Set to true to display the status bar at the bottom
of the application window.

Show Diagram Zoom true true/false Set to true to display the diagram zoom slider.
Slider

Show Enter true true/false Set to true to display the Enter Presentation Mode
Presentation Mode button on the status line.
Button

Show Memory Monitor false true/false Set to true to display the memory monitor on the
application status line.

Notify about Low true true/false Set to true to be notified when low memory might
Memory slow down performance.

Show Welcome Screen true true/false Set to true to display the Welcome screen if there
are no opened projects.

Hide Toolbars in the true true/false Set to true to hide the main toolbar in the full
Full Screen Mode screen mode.

Show the Exit Full true true/false Set to true to display the Full Screen toolbar in
Screen Toolbar the full screen mode.

Show Extra Features true true/false Set to true to show the features which are
available only in a higher edition or not installed
plugins.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 155

 Option Default value Value options Description

Hint Display Mode Display all Display Select 'Display all hints' to show all hints about
hints custom hint the application functionality that are related to
set user actions. Select 'Display custom hint set' to
show a set of hints, excluding the ones that were
Display all selected by the user not to be shown. Select 'Do
hints not display' to hide hints.
Hints are displayed in the lower right corner of the
Do not display application.

Notifications Display Display custom Display Select 'Display all notifications' to show all
Mode notifications custom notifications about specific events happening in
set notifications the system. Select 'Display custom notifications
set set' to show a set of notifications, excluding the
ones that were selected by the user not to be
Display all shown. Select 'Do not display' to hide
notifications notifications.
Notifications are displayed in the lower right
Do not display corner of the application or at the bottom of some
dialogs.

Show Boolean true true/false Set to true to display label texts next to check
Property Checkbox boxes in the boolean property editor.
Text

Show Active true true/false Select to show active navigation icons on element
Navigation Icons symbols. An icon represents an active hyperlink
or a diagram that opens when you double-click
the element symbol. Elements with an active
hyperlink or a modified default navigation are
marked with an icon in the Model Browser.

Show Font Face in false true/false Set to true to display in the original font the font
Font List names that are listed in the drop-down list box on
the diagram toolbar.

UI Font Default L&F multi-list Change the default font the application should be
Font displayed in.

Editing

Opaque Expression 3 1-5 Specify the number of lines for displaying an

Displaying Lines opaque expression in element specification
All lines windows.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 156

 Option Default value Value options Description

Synchronize Diagram true true/false Set to true to synchronize the diagram name with
Name with its Context the diagram context name. For example, an
Name activity diagram is automatically named after the
name of the activity that owns the diagram.

Create Behavior true true/false Set to true to create a behavior diagram when
Diagram When the selecting the Behavior Type for the Transition
Behavior Type is Effect and State Entry/Exit/Do activities.
Selected for Transition
Effect or State
Activities

Automatically Create true true/false Set to true to automatically create slots in links.
Slots in Link The created slots will always reference instance
specifications connected to the link.

Show message When true true/false When a relation end is moved, the relation is
Moving Sections moved too. This property controls whether a
question message should be displayed to the user
with the question to move the relation or not.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 157

 Option Default value Value options Description

Opaque Expression English Binary Specify the default language for opaque
Default Language (recommende expressions.
d)

StructuredExp
ression
(recommende
d)

Groovy
(recommende
d)

English

OCL2.0

BeanShell

Built-in Math

Dymola

JEXL

Javascript
Rhino

Mathematica

Python

Jython

General

Save Settings on Exit true true/false Set to true to store the altered settings within the
current application session and apply for all
future sessions.

Show Tip of the Day false true/false Set to true to display the Tip of the Day dialog
every time the application is started.

Show Tips While true true/false Set to true to display the Tip of the Day dialog
Running Long Tasks within the progress bar while running long tasks.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 158

 Option Default value Value options Description

Recent Files List Size 4 1-30 Specify the number of recently opened projects
that appear under the File menu.

Recent Server Projects 8 1-30 Specify the number of recently opened server
List Size projects that appear under the Recent Projects
menu in the Collaborate Main Menu.

Recent Windows List 4 1-10 Specify how many recently opened diagrams you
Size want to be listed under the Window menu.

Editor Tab Limit 20 1-100 Set the open editor tab limit. If the number is
exceeded, the last active tab is closed.

Undo List Size 100 Real Specify the number of actions that will be
available for undo/redo operations.
Important: the maximum undo/redo list size is
500.

Show Autowire Parts true true/false Set to true display an information message after
Message Autowire Parts. In this message, you can choose
whether you want to highlight newly created
connections or not.

Show AutoDelegation true true/false Set to true display an information message after
Message AutoDelegation. In this message, you can choose
whether you want to highlight newly created
connections or not.

Image Export

Save Diagram false true/false Set to true to save the diagram together with its
Background in Image background as an image. Otherwise, the diagram
background becomes white after saving the
diagram as an image.

JPEG Compression 1.0 0.0-1.0 Specify the quality for saving an image as a JPEG
Quality file. Set the value to 1.0 to define the highest
quality.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 159

 Option Default value Value options Description

Use SVG <text> Tag for false true/false Set to true to turn all text into SVG shapes during
Text Output the image conversion.

Letter Spacing 3 0-10 Specify spacing reduction between letters when

Reduction in SVG exporting SVG with <text> tag. Use the slider to
specify a number between 0 and 10, where 1
means -0.1 px. Increasing the number reduces the
spacing between the letters.

Render SVG Icons as false true/false Set to true to render SVG icons as raster images in
Raster Images in EMF the EMF output. Otherwise, the SVG icons are
rendered as vector graphics.

Image Resolution 72 1-4800 Specify the measure for spatial printing.

(DPI)

Exported Image Size 100 10-1000 Specify exported image scaling ratio in percent. If
[%] the set value is higher than 100, then the view is
enlarged (zoomed in) before generating an image.
Raster image will not lose its quality as additional
pixels are introduced.

TIFF Color Space RGB RGB Specify the color format for the tagged image file
format (TIFF).
CIE Lab

YCbCr

TIFF Compression LZW No Specify the type for compression of the tagged
compression image file format (TIFF).

LZW

JPEG in TIFF

Deflate/Inflate

Byte-oriented
RLE

ZIP in TIFF

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 160

 Option Default value Value options Description

Internal Errors

Display Internal Errors true true/false Set to true to display internal errors. It is
recommended to have this option selected to get
early warnings on potential data loss or model
corruption.

Automatically Submit false true/false Set to true to automatically submit internal errors
INternal Errors to the support.

Attach Log File to true true/false Set to true to attach the log file when submitting
Automatic Internal internal errors automatically to the support.
Errors Report

Memory Settings

Maximum Heap Size (- 4000 Real Sets the maximum memory allocated for the
Xmx), in megabytes product in megabytes. If the out-of-memory error
dialog appears during your work, you can change
the maximum java heap size by using this option.

Thread Stack Size (- 1024 Real Thread stack size is the amount of memory
Xss), in kilobytes allocated to a single JVM thread in kilobytes.

Merge and Compare

Optimize for Speed Speed Specify the model merge and compare
optimization mode.
Memory

Do Not Detect Order - multi- Specify properties/tags for which order changes
Changes for selection should not be detected.

Automatically Resolve Target Target Specify the default resolution to resolve conflicts
Conflicts by Choosing during project merge automatically.
Source

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 161

 Option Default value Value options Description

Detect Changes in Direct Changes Direct Select which changes to detect in diagrams.
Diagrams Changes

All Changes

Detect Changes in true true/false Set to false to stop the calculation of differences
Diagrams from Used in diagrams from used projects in Teamwork
Projects in Teamwork Cloud. Skipping changes in diagrams from used
Cloud projects may increase merge performance.

Navigation

Default Action for Open in the Open in the Set the default behavior for opening one diagram
Opening Diagram same tab same tab from another diagram.
from Another Diagram
Open in the
new tab

Default Action for Open in the Open in the Set the default behavior for opening a diagram
Opening Diagram new tab new tab from the Containment tree and menu actions.
from Model
Open in the
same tab

Save/Load

Create Backup File true true/false Set value to true to create backup files for the
project. Backup files will be saved as
<project_name>.xml.bak or
<project_name.xml>.zip.bak.

Save Project Recovery true true/false Set to true to enable creating the recovery file for
Data on Idle an opened project when the application is not
used.

Idle Time to Activate 5 Real Specify the period (in minutes) of waiting until the
Recovery Save project recovery information saving is activated.

Open Last Project on false true/false Set to true to load the last opened project
Startup automatically when the application is started.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 162

 Option Default value Value options Description

Time Limit to Load 5 Real Set a time limit (in seconds) to load the table
Table Completely completely. If the time is exceeded, the table is
partially loaded.

Save Rich XMI false true/false Set to true to store default metaproperty values
when saving the project.

XML Version 1.0 Choose XML version to be used when saving

project files.

Save UUID false true/false Set to true to add the "xmi:uuid" attribute for
each model element in the XMI file.

Check Dependencies Allow Do not check Specify the dependency checking mode during
on Package Export/ dependencies the project export or package share.
Sharing Allow
dependencies

Do not allow
dependencies

Blank Project <install.root>\t Custom Specify the location and name of the default
Template emplates\tem project template.
plate.mdzip

Global Path to Used - Custom Specify global paths to the used projects. The
Projects project-specific paths can be defined for each
project in the 'Project Options' dialog (select
Options → Project).

Check Changes in the true true/false Set to true to check changes in the numbering
Numbering Scheme scheme. The numbering scheme will be checked
by validation rules.

Specifications

Strip Multiline Text false true/false Set to true to strip multiline text in the
Specification window.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 163

 Option Default value Value options Description

Specification Opening In the same In the same Specify the Specification window opening mode
Mode window window (in the same window or in a new one).

In a new
window

Recent Specifications 10 1-20 Specify the list size for element specifications.
List Size The possible range is 1 to 20.

Specifications History 5 1-20 Specify the history size for an opened element
Size specification.

Usage Analytics

Share Analytics true true/false Select to share anonymous analytics information

Information and usage data automatically to help us improve
the quality and performance. The usage analytics
data includes hardware and software
specifications.

Diagram

Editing

Use Smart Path true true/false Set to true to automatically set breakpoints when
Layout modeling paths.

Use Smart Path true true/false Set to true to automatically set breakpoints for
Layout On Shape paths when moving shapes around.
Move

Auto-insert Nested false true/false Set to true to automatically create nested

Activations in activation for the message in the sequence
Sequence Diagrams diagram.

Edit Name with true true/false Set to true to edit the stereotype name together
Stereotypes with the element name in diagrams.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 164

 Option Default value Value options Description

Optimize Paths true true/false Set to true to optimize the paths when a part of
the path is moved in various directions; this
option removes loops from the path.

Display Paths on true true/false Display paths between symbols after dragging
Element Drop them from the Model Browser to the diagram
pane.

Insert Element Ask where to Before path Specify the mode of splitting the path into two
insert paths by drawing a symbol on it. This option is
After path valid only for the paths in the State Machine and
Activity diagrams.
Do not insert

Ask where to
insert

Join Control Flows Ask to join Yes Set to true to join incoming/outgoing control
control flows flows after an action is removed.
No

Ask to join
control flows

Set Preferred Size If no Always Specify if the shape size should be set to the
After Hiding connected preferred size after one of the shape's
Compartment paths Never compartments is suppressed in the diagram.

If no
connected
paths

Display

Text Antialiasing true true/false Set to true to smooth the jagged edges of text.

Graphics Antialiasing true true/false Set to true to smooth the jagged edges of
graphics.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 165

 Option Default value Value options Description

Show Centerlines in true true/false Set to true to display the centerline in the flow
Flow Diagrams diagrams. The centerline allows aligning the
symbols in one line.

Grid Style Sparse Dense Specify the style of the grid which is used in the
diagram pane.
Sparse

Symbols Manipulation

Show Manipulation true true/false Set to true to highlight the errors in the modeling
Highlighting process. This helps to see the errors in the model
at drawing time.

Group Selection Mode Partial Partial Specify what symbols are selected by rectangular
coverage coverage selection - completely or partially covered by
selection rectangular. Press CTRL to invert mode
Complete temporarily.
coverage

Mark Selected Labels true true/false Set to true to mark the path labels after a path is
selected.

Zoom

Zoom Step Size 0.2 0.1-1.0 Specify the zooming step for diagrams. The step
value should be in the range from 0.1 to 1.0. The
value 0.1 is equal to the 10% zoom ratio.

Center on the Mouse true true/false Set to true to center zooming according to mouse
Location When arrow.
Zooming

Smart Manipulators

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 166

 Option Default value Value options Description

Mouse's Left Button Create Create Specify the mouse's left button action. The
Action element element mouse's left button can be specified to create a
new element or make a breakpoint.
Make a
breakpoint

Smart Manipulator 1 Real Specify the fade time in seconds for the smart
Fade Time on Mouse manipulators.
Over (seconds)

Smart Manipulator Mouse over Smart Specify the appearance mode of the smart
Appearance Mode Manipulator manipulators. If the mouseover mode is specified,
it means that a smart manipulator is displayed
Shift after the mouse is over the symbol. If the Shift
mode is specified, it means that smart
manipulators appear after the symbol is selected
and the Shift key is pressed.

Toolbar

Show Names in true true/false Set to true to display the element names in
Toolbar toolbars near element icons.

Toolbar Position Left Left Specify the toolbar position in the workspace. The
toolbar can be located on the right or left side of
Right the diagram pane.

Relation Map

Inform about the true true/false Set to true to display the information message
Removal of Existing when elements already exist in the Relation Map
Elements when and the context element changes.
Changing a Context
Element

Show Question Dialog true true/false Set to true to display the question dialog, which
when Restoring asks to preserve or not manually suppressed/
Layout expanded branches and hidden elements when
restoring the layout.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 167

 Option Default value Value options Description

Preserve Manually true true/false Set to true to preserve manually suppressed/

Suppressed/Expanded expanded branches and hidden elements when
Branches and Hidden restoring layout.
Elements

Browser

General

Browser Position Left Left Specify the browser position in the workspace.
The browser can be located on the right or left
Right side of the diagram.

Show Full Types true true/false Select to show the qualified name for the element
type.

Show Auxiliary false true/false Select to show elements with the applied
Resources <<auxiliaryResources>> stereotype.

As Whether to Show true true/false Select for a prompt to show auxiliary resources
Auxiliary Resources when projects are not visible in the Model
Browser.

Sort Alphabetically true true/false Select to sort the added model elements
alphabetically in the Model Browser.

Show Applied false true/false Select to show the applied stereotypes next to the
Stereotypes element name.

Show Changes true true/false Select to highlight the edited or added model
elements and diagrams in the Model Browser.

Show Hyperlinks true true/false Select to display the hyperlinks which are added
to the model elements.

Diagrams Tree

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 168

 Option Default value Value options Description

Group by Diagram false true/false Select to group by diagram name.

Name

Inheritance Tree

Invert Tree false true/false Select to invert the tree to show the child element
at the top of the hierarchy.

Search Results

Group By Element Type Element Type Choose the search result grouping criterion.

No Grouping

Model Extensions Tree

Group by Profiles true true/false Select to group by profiles.

Group by Metaclasses true true/false Select to group by metaclasses.

Structure Browser

Show Inherited true true/false Select to show properties inherited from the
Structure general classifiers.

Nest Satisfied true true/false Select to nest requirements within the satisfying
Requirements elements.

Composition Inspection

General

Removal of the true true/false Set to true to ask for confirmation when a shared
package share package is removed from a used project.
confirmation

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 169

 Option Default value Value options Description

Removal of shared true true/false Set to true to ask for confirmation when an
package element element is removed from a shared package of a
confirmation used project.

Element moved true true/false Set to true to ask for confirmation when an
outside shared element is moved outside the shared package in a
package confirmation used project.

Element moved true true/false Set to true to ask for confirmation when an
between used projects element is moved from one used project to
confirmation another.

Collaboration

General

Auto Login to Server false true/false Set to true to enable the automatic logging in to
the server upon starting the application.

Show Project Versions true true/false Set to true to display a warning message when
Conflict Warning two projects have the same usages.

Include Project Ask User Ask User Specify the mode of the project version
Version Information to information usage in the element URL.
Element URL

Remember User Name true true/false Select to remember the last entered user name in
Between Sessions the login dialog.

Remember Server true true/false Select to remember all server names to which a
Between Sessions successful connection was established.

Server Name localhost localhost specify the name of the server. the name is
automatically set once you have logged in to the
server.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 170

 Option Default value Value options Description

Single Sign On Server localhost localhost Specify the name of the Single Sign On server. The
Name name is automatically set once you have logged
in to the server.

Use Secured false true/false Set to true to use a secured connection (SSL)
Connection (SSL) while working with the server.

Auto-Commit After true true/false Set to true to allow the application to auto-
Project is Migrated to commit a project to the server after the project is
New Version migrated due to new Standard/System profiles or
new model extensions.

SSO Authentication as false true/false Set to true to set Singl Sign On authentication as a
Default default method. If the value is set to false, the
basic username/password authentication is set as
default.

Notify About New true true/false Set to true to get a notification when a server
Project Versions on project is modified on the server by other users.
the Server

Notify About Newer Open Open Specify commands when the notifications about
Project Usages newer project usages should be shown.
Open, Update

Never

Interval to Check For 120 30 Specify how often to check for a new project
New Project Version version on the server (in seconds).
(in seconds) 45

60

90

120

Enable Locking true true/false Lock elements without updating the project when
Without Forced possible.
Project Update

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 171

 Option Default value Value options Description

Support Mount Points true true/false Create Mount Relationships to connect former
of Usages on Server mount point packages to the former mounted
elements when importing projects to the server.

Web Application - Custom Specify the Web Application Platform URL (for
Platform URL example, https://example.com:8443). It is used to
quickly access Teamwork Cloud web apps from
within the modeling tool.

Representation of User Name User Name Select the field to represent the users. If the
Users selected field is left empty, the User Name is
Full Name shown by default.

Email

3DEXPERIENCE

Enable Collaboration false true/false Select to enable a collaborative environment

Powered by powered by 3DEXPERIENCE Platform integration.
3DEXPERIENCE
Platform

CATIA Systems Synthesis Analysis

Publish MDZipX Upon false true/false Select to publish the MDZipX file to Teamwork
Commit Cloud upon project commit.

Publish Diagrams from false true/false Select to include diagrams from used projects in
Used Projects MDZipX file.

Floating

General

FLEXNet License localhost Custom Specify the name of the FLEXNet license server.
Server Name

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 172

 Option Default value Value options Description

FLEXNet License 1101 Custom Specify the port number of the FLEXNet license
Server Port server.

DSLS License Server localhost:4085 Custom Specify the name of the DSLS license server
Address address.

DSLS License Server ORGANIZATIO Custom Specify the DSLS server mode.
Mode N_DEFINED

Auto Login to the false true/false Set to true to enable automatic logging into the
License Server license server upon starting the application.

Borrowing Period 24 Real Specify the period in time (in hours) for borrowing
(hours) licenses from the server and using them offline.

Ask if Run MagicDraw true true/false Set to true to display the question message if the
Without Unavailable user wants to run the application without an
Plugins unavailable plugin. An unavailable plugin is one
whose license is not available in the license
server.

Network

HTTP Proxy

Use HTTP Proxy Server false true/false Set to true to use the HTTP proxy server when the
application is checking for updates.

HTTP Proxy Server - Custom Specify the name or IP address of the HTTP proxy
Address server.

HTTP Proxy Server 8080 Custom Specify the port of the HTTP proxy server. The
Port default port is 8080.

HTTP Proxy Server - Custom Specify the name of the HTTP proxy server user.
User

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 173

 Option Default value Value options Description

Authenticate HTTP false true/false Set to true to authenticate with the HTTP proxy
Proxy Server server.

General

Timeout (seconds, 0 - 30 Real Specify the waiting period (in seconds) before
infinite) canceling a connection prompt.

Keyboard

Assign new, edit, or remove shortcut keys for the main menu, shortcut menu items, and main and diagram
element toolbars.

Plugins

Review detailed information about all installed plugins.

Resources

Review and configure external resources that are used during project load.

Path Variables

Paths variable402403 is a path used in the code engineering process, project usages, hyperlinks, etc. Specify
predefined or create and configure custom variables for referencing to file system objects.

Spelling

Spelling

Check Spelling As You true true/false Set to true to underline incorrectly spelled words
Type and provide the suggestion list of possible
corrections in the context menu.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 174

 Option Default value Value options Description

Check Tagged Values true true/false Set to true to check all tagged values that are of
string type.

Dictionary English English Select the language for spelling. All languages
supported by the "Open Office" can be
French additionally added to the existing list of
supported languages (Environment Options →
Russian Spelling → Add Spelling Dictionaries).

German

Thai

Spanish

Case Sensitive false true/false Set to true to differentiate the words in meaning
based on differing use of uppercase and
lowercase letters.

Use Camel Case Words true true/false Set to true to spell the compound words or
phrases in which the words are joined without
spaces and are capitalized within the compound -
as in BlackColor, as separated words.

Ignore Upper Case false true/false Set to true to not check the spelling of the words
Words with all uppercase letters.

Skip Numbers true true/false Set to true to not check the spelling of the words
with all uppercase letters.

Add Spelling dictionaries. You can add your custom dictionaries.

Launchers

Launchers show which programs will be used for opening different file types in the application. Add new, edit, or
remove launchers and specify their properties (file extension, program path or name, program arguments).

Experience

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 175

 Option Default value Value options Description

General

Main Menu Expert false true/false Set to true to show complete command lists in
Mode the main menu. Otherwise, command lists will
not be complete, and arrows for expanding
menus will be visible at the very end of each
menu command list.

Context Menu Expert false true/false Set to true to show complete command lists in
Mode the context menu. Otherwise, command lists will
not be complete, and arrows for expanding
menus will be visible at the very end of each
menu command list.

Main Toolbar Expert false true/false Set to true to show complete command lists in
Mode the main toolbar. Otherwise, command lists will
not be complete, and arrows for expanding the
toolbar will be visible at the very end of each
toolbar command list.

Diagram Main Toolbar false true/false Set to true to show complete command lists in
Expert Mode the diagram main toolbar. Otherwise, command
lists will not be complete, and arrows for
expanding the diagram main toolbar will be
visible at the very end of each diagram main
toolbar command list.

Diagram Elements false true/false Set to true to show complete command lists in
Toolbar Expert Mode the diagram element toolbar. Otherwise,
command lists will not be complete, and arrows
for expanding the diagram element toolbar will
be visible at the very end of each diagram
element toolbar command list.

Element Properties Standard Standard Specify the mode of displaying properties in the
Mode element specification dialog.
Expert

All

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 176

 Option Default value Value options Description

Symbol Properties Standard Standard Specify the mode of displaying properties in the
Mode symbol properties dialog.
Expert

All

Smart Manipulator false true/false Set to true to show complete command lists in
Expert Mode the smart manipulators. Otherwise, command
lists will not be complete, and arrows for
expanding smart manipulators will be visible at
the very end of each smart manipulator
command list.

External Tools

Specify external tools to be launched from the application. This allows to easily pass modeling artifacts to 3rd
party tools, thus facilitating model transformations, code generation, etc.

Notifications

General

Notification Display 10 Real Specify the notification display time in seconds.

Time (seconds)

Severity

Error RGB [255, 0, 0] Custom Change the color of the Error text in the
Notification window.

Warning RGB [0, 0, 0] Custom Change the color of the Warning text in the
Notification window.

Information RGB [0, 0, 0] Custom Change the color of the Information text in the
Notification window.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 177

 Option Default value Value options Description

Minimal Severity Level Information Information Specify the minimum severity level. Notification
messages of both the specified and higher
Warning severity levels will be displayed in the Notification
window. The lowest severity level is Information.
Error The highest severity level is Error.

History

Retain History (days) 30 Real Specify the number of days for how long
notification messages should be kept in history.

Server Certificates404405

Trusted by All Users

Manage server certificates trusted by all users in this application on this machine. Add, remove, or view details of
the selected trusted server certificate. You may need system administrator rights to manage these certificates.

Trusted by Current User

Manage server certificates trusted by the current user in this application on this machine. Add, remove, or view
details of the selected trusted server certificate.

Code Engineering

General

Show Code true true/false Select to show the code engineering set items in
Engineering Sets the Model Browser.

Concept Modeling

Concept Modeling

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 178

 Option Default value Value options Description

Enable experimental false true/false Set to true to enable experimental Cameo

features Concept Modeler features.

Subproperties Tree

Invert tree false true/false Set to true to invert the subproperties hierarchy
so that at the top of the hierarchy the subproperty
is displayed.

Hide properties true true/false Set to true to hide properties directly between
directly between top top and bottom in the subproperties tree.
and bottom

Eclipse UML2 XMI

Eclipse UML2 (v2.x) XMI

Export

Export Model to Do not Do not Select the mode of the application model export
Eclipse UML2 XMI on respond respond on project save action. The model will be
Project Save exported without diagrams.
Ask before
export

Always export

Ask to Overwrite true true/false Set to true to display a message requesting

Exported Files confirmation to overwrite previously exported
files.

Element ID Export Use Element ID Generate ID Specify how the element ID should be exported.
Policy The Server ID is only available in server projects.
Use Element
ID

Use Server ID
(if applicable)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 179

 Option Default value Value options Description

Show Stereotype true true/false Set to true to display warning message warnings
Property Type Change when exporting a model to the Eclipse UML2 XMI
Warning file after the stereotype property type has been
changed.

Show 'Stereotypes true true/false Set to true to display a warning message that the
from the Same Profile' stereotype will not be applied to the element if
Warning this element is in the same profile with the
stereotype.

Apply All Profiles to true true/false Set to true to apply all the exported profiles to the
Root Model root model. Otherwise, all the exported profiles
will be applied to the nearest nesting package.

Move Stereotype to true true/false Set to true to move not a directly contained
Nesting Profile stereotype to a nesting profile.

Change Stereotype Do not change Do not change Specify the mode of changing the stereotype's
Property Type property type's stereotype on model export.
Stereotype Single
extended
metaclass
only

Common
super of
extended
classes

Change not eCore true true/false Set to true to change the stereotype's property
Datatype to String type to String on export if the type is not eCore
data type.

Import/Export

Show Element true true/false Set to true to display the warning message
Mapping Warning showing the elements' (metaclasses and data
types) mappings between the application and
Eclipse UML2. A warning message will appear
when exporting or importing a model.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 180

 Option Default value Value options Description

Display Warning in true true/false Set to true display project exporting warning in
message Window the Message Window.

Import

Use Stereotype true true/false Set to true to use keywords as names for the
Keyword as name stereotypes when importing a model from the
Eclipse UML2.

Preserve IDs true true/false Set to true to preserve element IDs on import.

Eclipse UML2 (v3.x) XMI

Export

Export Model to Do not Do not Select the mode of the application model export
Eclipse UML2 XMI on respond respond on project save action. The model will be
Project Save exported without diagrams.
Ask before
export

Always export

Ask to Overwrite true true/false Set to true to display a message requesting

Exported Files confirmation to overwrite previously exported
files.

Element ID Export Use Element ID Generate ID Specify how the element ID should be exported.
Policy The Server ID is only available in server projects.
Use Element
ID

Use Server ID
(if applicable)

Show Stereotype true true/false Set to true to display warning message warnings
Property Type Change when exporting a model to the Eclipse UML2 XMI
Warning file after the stereotype property type has been
changed.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 181

 Option Default value Value options Description

Show 'Stereotypes true true/false Set to true to display a warning message that the
from the Same Profile' stereotype will not be applied to the element if
Warning this element is in the same profile with the
stereotype.

Apply All Profiles to true true/false Set to true to apply all the exported profiles to the
Root Model root model. Otherwise, all the exported profiles
will be applied to the nearest nesting package.

Move Stereotype to true true/false Set to true to move not a directly contained
Nesting Profile stereotype to a nesting profile.

Change Stereotype Do not change Do not change Specify the mode of changing the stereotype's
Property Type property type's stereotype on model export.
Stereotype Single
extended
metaclass
only

Common
super of
extended
classes

Change not eCore false true/false Set to true to change the stereotype's property
Datatype to String type to String on export if the type is not eCore
data type.

Import/Export

Show Element true true/false Set to true to display the warning message
Mapping Warning showing the elements' (metaclasses and data
types) mappings between the application and
Eclipse UML2. A warning message will appear
when exporting or importing a model.

Display Warning in true true/false Set to true display project exporting warning in
message Window the Message Window.

Import

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 182

 Option Default value Value options Description

Use Stereotype true true/false Set to true to use keywords as names for the
Keyword as name stereotypes when importing a model from the
Eclipse UML2.

Preserve IDs true true/false Set to true to preserve element IDs on import.

Eclipse UML2 (v4.x) XMI

Export

Export Model to Do not Do not Select the mode of the application model export
Eclipse UML2 XMI on respond respond on project save action. The model will be
Project Save exported without diagrams.
Ask before
export

Always export

Ask to Overwrite true true/false Set to true to display a message requesting

Exported Files confirmation to overwrite previously exported
files.

Element ID Export Use Element ID Generate ID Specify how the element ID should be exported.
Policy The Server ID is only available in server projects.
Use Element
ID

Use Server ID
(if applicable)

Show Stereotype true true/false Set to true to display warning message warnings
Property Type Change when exporting a model to the Eclipse UML2 XMI
Warning file after the stereotype property type has been
changed.

Show 'Stereotypes true true/false Set to true to display a warning message that the
from the Same Profile' stereotype will not be applied to the element if
Warning this element is in the same profile with the
stereotype.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 183

 Option Default value Value options Description

Apply All Profiles to true true/false Set to true to apply all the exported profiles to the
Root Model root model. Otherwise, all the exported profiles
will be applied to the nearest nesting package.

Import/Export

Show Element true true/false Set to true to display the warning message
Mapping Warning showing the elements' (metaclasses and data
types) mappings between the application and
Eclipse UML2. A warning message will appear
when exporting or importing a model.

Display Warning in true true/false Set to true display project exporting warning in
message Window the Message Window.

Import

Use Stereotype true true/false Set to true to use keywords as names for the
Keyword as name stereotypes when importing a model from the
Eclipse UML2.

Preserve IDs true true/false Set to true to preserve element IDs on import.

Eclipse UML2 (v5.x) XMI

Export

Export Model to Do not Do not Select the mode of the application model export
Eclipse UML2 XMI on respond respond on project save action. The model will be
Project Save exported without diagrams.
Ask before
export

Always export

Ask to Overwrite true true/false Set to true to display a message requesting

Exported Files confirmation to overwrite previously exported
files.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 184

 Option Default value Value options Description

Element ID Export Use Element ID Generate ID Specify how the element ID should be exported.
Policy The Server ID is only available in server projects.
Use Element
ID

Use Server ID
(if applicable)

Show Stereotype true true/false Set to true to display warning message warnings
Property Type Change when exporting a model to the Eclipse UML2 XMI
Warning file after the stereotype property type has been
changed.

Show 'Stereotypes true true/false Set to true to display a warning message that the
from the Same Profile' stereotype will not be applied to the element if
Warning this element is in the same profile with the
stereotype.

Apply All Profiles to true true/false Set to true to apply all the exported profiles to the
Root Model root model. Otherwise, all the exported profiles
will be applied to the nearest nesting package.

Import/Export

Show Element true true/false Set to true to display the warning message
Mapping Warning showing the elements' (metaclasses and data
types) mappings between the application and
Eclipse UML2. A warning message will appear
when exporting or importing a model.

Display Warning in true true/false Set to true display project exporting warning in
message Window the Message Window.

Import

Use Stereotype true true/false Set to true to use keywords as names for the
Keyword as name stereotypes when importing a model from the
Eclipse UML2.

Preserve IDs true true/false Set to true to preserve element IDs on import.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 185

 Option Default value Value options Description

Enterprise Architect Import

General

Switch aggregation false true/false Set to true to switch aggregation side. this option
side (Recommended is recommended if the XMI is exported from EA
for XMI exported from 7.1.
EA 7.1)

Exclude EA specific false true/false Set to true if EA-specific data is not required to be
data imported.

Generate conversion true true/false Set to true to generate a conversion log file.
log

Open project after false true/false Set to true to open the project after finishing
conversion import.

Activity element mapping

Convert EA AddVariableVal AddVariableVa Select the element type that you want to convert
WriteVariable Action ueAction lueAction WriteVariable Action to.
to
RemoveVariab
leValueAction

Convert EA CreateLinkActi CreateLinkActi Select the element type that you want to convert
WriteLinkAction to on on WriteLinkAction to.

DestroyLinkAc
tion

Convert EA AddStructuralF AddStructural Select the element type that you want to convert
WriteStructuralFeatur eatureValueAct FeatureValueA EA WriteStructuralFeatureAction to.
eAction to ion ction

RemoveStruct
uralFeatureVal
ueAction

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 186

 Option Default value Value options Description

Macros

General

Default Macro Groovy Groovy Set the default macro language. To ensure the
Language (recommende best performance experience, it is strongly
d) suggested that you use the recommended
language.
JavaScript
Rhino

Jython

Beanshell

Report Wizard

Change various Report Wizard options and configurations.

UAF

System Engineering false true/false Set to true to expand the SysML palettes in the
User Interface Mode UAF diagrams.

Suggest to change true true/false Set to true to get a suggestion to change the
perspective to perspective to a preferable one (if it is not set)
preferable one each time a new UAF project is started, a project
is changed, or the existing UAF project is loaded.

Inform if the Is true true/false Set to true to be informed when the Is Capable
Capable To Perform To Perform relationships are not deleted from
relationships are not the model after removing actions or swimlane
deleted from the representations from the behavior diagrams.
model

Show Strategic true true/false Set to true to show the Strategic Phasing/CV-3/
Phasing Gantt Chart StV-3/NCV-3/Cr creation wizard every time when
Creation Wizard creating a new chart.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 187

 Option Default value Value options Description

Show Actual Strategic true true/false Set to true to show the Actual Strategic Phases
Phases Gantt Chart Gantt Chart creation wizard every time when
Creation Wizard creating a new chart.

Show Personnel true true/false Set to true to show the Personnel Availability
Availability Gantt Gantt Chart creation wizard every time when
Chart Creation Wizard creating a new chart.

Show Projects true true/false Set to true to show the Projects Roadmap/PV-2/
Roadmap Creation AcV-2/NPV-1/Lr creation wizard every time when
Wizard creating a new chart.

Show Resources/ true true/false Set to true to show the Resources Forecast/
Personnel Forecast Personnel Forecast/SV-9/NSV-9/P1 and Standards
and Standards Roadmap/StdV-2/TV-2/NTV-2 diagram creation
Roadmap Creation wizard every time when creating a new chart.
Wizard

Show Strategic Actual true true/false Set to true to show the Strategic Actual
Deployment Creation Deployment/CV-5/StV-5/NCV-5 creation wizard
Wizard every time when creating a new chart.

Creating path variables

The main purpose of the path variables feature is to give additional sharing flexibility. It enables you to
store paths in your project as named variables that can be easily adjusted on different machines.

Path Variables may be used in:

• Code engineering classpath

• Working directories
• Hyperlinks
• Modules paths
• Reports

To create a path variable

1. In the main menu, go to Options > Environment. The Environment Options dialog406407 opens.
2. On the left part of the dialog, select Path Variables.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 188

 3. In the Path Variables area click the Add button. The Path Variable dialog opens.

4. In the appropriate boxes enter the path variable name and description.
5. Next to the Value box, click , navigate to the desired location, and click Open.
6. In the Path Variable dialog, click OK. Your custom path variable is created and shown in
the Defined Path Variables list.
7. In the Environment Options dialog, click OK.

Every user can specify different values of the same path variables. However, path variables should be
resolved only on demand, when they are used. If a modeling tool determines you can use path
variables, once you specify your absolute path, the application automatically opens the Use Path
Variables dialog box. For example, this dialog may open when in your project, you try to use another
project From a predefined location and add a new path to the Paths to used projects list.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 189

If you do not want your modeling tool to automatically display the Use Path Variables dialog box, clear
the Show suggestion to use path variables check box. To use the original path and cancel this dialog,
click the Use Original button.

To use a suggested path variable

• In the Available forms list, select a path and click the Use Selected button.

If you have your own documentation running on the local server, you can define the path in the
documentation.server option.

Disabling inbound network activity

Note that after disabling inbound network activity, you will not be able to open the modeling tool Help
or submit an issue.

 Useful information
If you disable inbound network activity, double-clicking a project file (.mdzip) opens the project
in a new modeling tool window.

To disable inbound network activity

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 190

 1. Go to <modeling tool installation directory>\bin and open the properties file, e.g., <modeling tool
name>.properties.
2. In the JAVA_ARGS line, add the following argument:

-DDISABLEINBOUNDCON=true

3. Save and close the file.

Most common shortcut keys

The following table outlines the most commonly used shortcut keys:

What do you want to do? Shortcut keys

Windows OS X

Open the Find dialog Ctrl+Shift+F Cmd+Shift+F

Open the Quick Find dialog Ctrl+Alt+F Cmd+Alt+F

Open the Find and Replace dialog Ctrl+R Cmd+R

Remove both symbols from an active Ctrl+D Cmd+D

diagram and element from the model

Remove only a symbol from an active Delete Del

diagram, but not the model element

Select all shapes on an active diagram Ctrl+A Cmd+A

Select an element in the Containment Alt+B Alt+B

tree

Switch from List to Tree view in the

Select Element dialog

Zoom in/out Model Browser Ctrl+Mouse scroll wheel Cmd+Mouse scroll wheel

Ctrl+Numpad +/- Cmd+Numpad +/-

Add more symbols to selection Shift+Left mouse button Shift+Left mouse button

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 191

 Select elements of the same type Alt+Left mouse button Alt+Left mouse button

Open a list of possible elements to Ctrl+Spacebar Ctrl+Spacebar

assign when typing on a symbol

Add a new line in the compartment of Shift+Enter Shift+Enter

a shape, for example, create an
attribute for a class

Open element's Specification window Enter Enter

Open element's Symbol Properties Alt+Enter Alt+Enter

dialog

Open the Report Wizard Ctrl+Shift+G Cmd+Shift+G

See the list of recently opened F12 –

diagrams

Cut a selected item Ctrl+X Cmd+X

Copy a shape or text Ctrl+C Cmd+C

Copy a shape Drag the shape to the empty –

place
on the diagram, while holding
down Ctrl

Paste Ctrl+V Cmd+V

Paste with New Element Ctrl+E Cmd+E

Save Ctrl+S Cmd+S

Commit changes to the server Ctrl+K Cmd+K

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 192

 Undo Ctrl+Z Cmd+Z

Redo Ctrl+Y Cmd+Y

Print Ctrl+P Cmd+P

Assign a shortcut key to print a report Alt+ number 1 to 9 Alt+ number 1 to 9

Turn on the Full Screen mode F11 –

Open a recently closed diagram Ctrl+Shift+T –

Paste a symbol style Ctrl+Shift+V Cmd+Shift+V

Reverse path direction Draw the path while holding Draw the path while holding
down Alt down Alt

Reorder elements/properties in a list, Ctrl+Up Alt+Up

tree, and Specification window
Ctrl+Down Alt+Down

Select a previous or next result in a tree Shift+F3 Shift+F3

F3 F3

Setting project options

Use the Project Options dialog to do the following:

• Specify general project-specific options.

• Specify summarizing information (for example, diagram author, diagram creation and
modification dates) that will be displayed on each diagram.
• Specify symbol property styles for shapes, paths, diagrams, and stereotypes within the project.

 For the instructions how to create, edit, clone, import /export, or remove symbol
property styles, please refer to Style Engine.

• Change default element property values.

 For the instructions about setting the default element property values, please refer to
Default Property Values.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 193

 • Set general code generation or code reversing options as well as code formatting styles for
selected programming languages.

The Project Options dialog includes option groups, each designated for one of the above mentioned
features and containing lists of corresponding options. Groups are represented using the tree
structure.

An option value can be simply changed by typing a new value, setting a value to true / false, or selecting
a value from the list. Click the Reset to Defaults button to restore default option values.

To open the Project Options dialog

• From the Options menu, select Project.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 194

Changing options
In order to change a desired project option, first of all you need to find it in the Project Options dialog.
These options are grouped into categories to make it easier for you to locate them. Use the q408409uick
filter410411 to find find the desired option in the list. Filtering is performed in the all available options,
not only in the selected option group.

To make sure you selected the right option, first read its description and see if the effect of changing
the option value is what you expect to be done.

 Make sure that the Show Description mode is turned on in the Project Options dialog.
To turn the Show Description mode on or off, click the Show Description button on the
following toolbar in the Project Options dialog.

24 The Show Description button in the Project Options toolbar

To read the option description

1. Click an option that you want to change.

2. Read the option description in the area below the options list.

Project Options

 The table below displays the default environment options. Additional options may appear
based on installed plugins.

Option Default value Value Description

options

General

Browser

Group true true/ Set to true to show composite instances under their owning
Composite false instances instead of the actual owning package in the
Instances Containment tree.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 195

 Option Default value Value Description
options

Show Diagram false true/ Set to true to display abbreviations in front of the diagram
Abbreviations false names in the Containment Tree. Learn more >>>412413

Concept Modeling

Concept Modeling

Preferred - custom The preferred annotation property for comment providing

annotation documentation. When nothing is selected, 'http://purl.org/
property dc/terms/description' (see page 193) will be used.

Always ask to true true/ Opening a project with named generalization sets will
remove false prompt to automatically remove names of generalization
generalization sets.
set names

OWL Import/Export

Always ask for true true/ Turns off use of the default file path and opens a file explorer
a file false window of OWL files.
destination
when
exporting to
OWL

Generate label Ask Always Preferred option for generating labels when exporting to
when generat OWL. "Always generate a matching label" will generate a
exporting to ea label when it would match the end of the element's IRI.
OWL matchin "Never generate a matching label" will not generate a label
g label when it would match the end of an element's IRI. "Ask" will
prompt for every export.
Never
generat
ea
matchin
g label

Ask

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 196

 Option Default value Value Description
options

Freeze IRI Ask Always Preferred option for freezing IRIs when exporting OWL.
when freeze "Always freeze before export" will silently set missing IRI
exporting OWL before values. "Never freeze before export" will not set missing IRI
export values. "Ask" will prompt for every exporting package that
has elements with missing IRI values.
Never
freeze
before
export

Ask

OWL Export RDF/XML RDF/ The preferred syntax for OWL export.
Syntax XML

JSON-
LD

OWL
Functio
nal

Turtle

Manches
ter

OWL Import - custom An Oasis-*standard catalog file to map IRIs to local files or
Catalog other IRIs. See https://www.oasis-open.org/committees/
download.php/14809/xml-catalogs.html for more
information.

URI Hash URI Hash The preferred URI construction strategy, as defined in
Construction URI HTTP://www.w3org/TR/cooluris/414.
Strategy
303 URI

Glossary Table

Add classes to false true/ Generate a glossary entry for classes.

the glossary false

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 197

 Option Default value Value Description
options

Add false true/ Generate a glossary entry for association ends.

association false
ends to the
glossary

Add attributes false true/ Generate a glossary entry for attributes.

to the glossary false

Add false true/ Generate a glossary entry for enumerations.

enumerations false
to the glossary

Add false true/ Generate a glossary entry for enumeration literals.

enumeration false
literals to the
glossary

Natural Language Glossary Report

Natural - custom An ordered list of annotation properties to include in every

Language Natural Language Glossary entry, in addition to preferred
Glossary annotation property used for the definition.
annotation
property list

Include true true/ Lists property definitions in addition to class definitions in

property false the Natural Language Glossary.
definitions in
the Natural
Language
Glossary

Corba IDL

CORBA UML Interface UML Specify whether the CORBA Interfaces should be
Interfaces Class implemented as a UML Class or UML Interface.
implemented
as UML
Interfac
e

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 198

 Option Default value Value Description
options

DDL

Show No special No Possibility to change relationship's display mode in IMM

relationship notation special diagrams.
ends as notation

With
multipli
cities

Crow's
foot

Dependency Checker

Check for false true/ Set to true to check for cyclic dependencies during the
Cyclic false project export or package share.
Dependencies
among Used
Projects

Dependency Info Info Specify the dependency checker severity. The dependencies
Checker of the specified and higher severity will be displayed.
Severity Level Warning

Error

Ignore true true/ Set to true to exclude standard/system profiles when

Standard/ false checking for cyclic dependencies in used projects.
System
Profiles

Diagrams

Use i18n true true/ Set to false to disable the i18n property. If the i18n property is
property for false set to false, all text symbols that are displayed in the diagram
text rendering pane (for example, text which is displayed on the symbol) will
in the not be distorted at any zoom ratio.
diagrams

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 199

 Option Default value Value Description
options

Display All Pins true true/ Set to true to always display pin elements in the diagrams.
in Diagrams false Note: if this option is set to true and the pin symbol is deleted
from the diagram, then the corresponding pin element will
be deleted from the model, too.

Display All true true/ Set to true to always display activity parameter node
Activity false elements in the diagrams. Note: if this option is set to true
Parameter and the activity parameter node symbol is deleted from the
Nodes in diagram, then the corresponding activity parameter node
Diagrams element will be deleted from the model, too.

Use different true true/ Use different notations to draw Join/Fork and Decision/
Join/Fork and false Merge.
Decision/
Merge
notations

Hide false true/ Set to true to hide the arrow notation that adorns the
Information false realizing element if the Conveyed Information of a realized
Flow If Information Flow is hidden or unspecified.
Conveyed
Information is Learn more >>>415416
Missing
Learn more >>>417418

Diagram Create Create A new diagram context element will be created automatically
Context Automatically Automat when the new diagram owned by a Package is created. This
ically option is valid for all diagrams based on a Composite
Structure Diagram.
Do Not
Create

Apply Image Type and Notify Type (This is personal property, meaning its value is unique for
To and each user). Specify whether to apply an image to the property
Notify or its type when dragging or selecting an image from the
Image Library or other resource. This option is available
Type when the Type Selection Mode is switched on.

Property

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 200

 Option Default value Value Description
options

Use Aspects false true/ Set to true to use definable diagram aspects in the project.
false

Ignored - multi- Specify the aspects which should not be used in the project.
Aspects selectio
n

Suspend Auto- true true/ Set to true to keep the original size of shapes while editing
Resizing of false the model by cutting text to fit inside the shape. You can use
Shapes the Resize to Fit Content command (a small black square on
the bottom line of the selected shape) to adjust the size of
the shape to fit the content completely.

Suspend Auto- true true/ Set to true if you do not want to automatically show labels on
Displaying of false the diagram pane while editing the model. You can use the
Labels Show Suspended Labels command (a small black square on
the selected path) to show suspended labels on the diagram
pane.

Highlight true true/ Set to true to highlight suspended symbols with not
Suspended false completely visible content.
Symbols

Time Limit to 60 Real Specify the maximum time (in seconds) allotted for diagram
Build Diagram building while exporting a diagram. If the time limit is
exceeded, the diagram is not exported. Set to 0 to export the
diagram without the time limit.

Image Height 10000 Real Specify the maximum image height (in pixels) for diagram
Limit export. If the height limit is exceeded, the exported diagram
is cropped, or the diagram is not exported at all, depending
on the selected preference. Set to 0 to export the diagram
without the image height limit.

Image Width 10000 Real Specify the maximum image width (in pixels) for diagram
Limit export. If the width limit is exceeded, the exported diagram is
cropped, or the diagram is not exported at all, depending on
the selected preference. Set to 0 to export the diagram
without the image width limit.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 201

 Option Default value Value Description
options

Export Export Cropped Export Specify the diagram export preference if the diagram image
Preference Diagram Cropped height and/or width limits are exceeded.
When Limits Diagram
Exceeded
Do Not
Export

Element References

Default Name Name Specify how the hyperlink to the model element is displayed
Element by default. Select 'Name' to display the element name from
Hyperlink Text Icon + its Specification window. The 'Representation text' displays
Display Mode Represe the full element title, visible in the Containment tree. Choose
ntation the 'Icon+Representation text' to display the element icon
text together with the full element title. Select 'Custom text' to
type your own text.
Represe
ntation
text

Custom
text

Default Automatically Automat Specify when the hyperlink to the model element will be
Element updated ically updated by default if the referenced element and the
Hyperlink Text updated hyperlink become inconsistent. Select 'Automatically
Update Mode updated' to update hyperlink text or the referenced element
Automat name automatically. Choose 'Automatically checked' to
ically enable active validation rules which check if the hyperlink
checked and the referenced element are coherent. The 'Manually
checked' option allows you to run validation manually, while
Manuall the 'Do not update' option means that validation will not find
y any inconsistencies.
checked

Do not
update

General

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 202

 Option Default value Value Description
options

Path to Used <project.dir> Custom Specify the paths to store used projects and extension
Project elements.
<install.root>\pr
ofiles

<install.root>\m
odelLibraries

Enable Dot false true/ Set to true to use the dot notation for associations. If the dot
Notation for false notation is applied to an association, the association end is
Associations decorated with the dot if that end is owned by a classifier.
The absence of the dot signifies ownership by the
association.

Change true true/ Set to true to automatically change ownership of the non-
Ownership of false navigable association end when the navigability of the
Non-Navigable association was changed.
Association
End when
Changing
Navigability

Qualified Model Library Absolute Specify the mode of displaying the element qualified name. If
Name Display Relative the Model Library Relative mode is specified, it means that
Style Model the element's full qualified name hierarchy is displayed on
Relative the shape, starting from the

Model
Library
Relative

Model or
Model
Library
Relative

Synchronize true true/ Set to true to synchronize the associated elements on

Parameters false elements creation or update.
and
Arguments

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 203

 Option Default value Value Description
options

Layout Definition Usage Specify the mode layout template diagram creation. Choose
Template 'Definition' to create the layout templates as a class diagram.
Creation Mode Definitio Choose 'Usage' to create the layout templates as a composite
n structure diagram.

Layout Use false true/ Set to true to automatically lay out the activity diagram of the
Case Scenario false use case scenario every time it is opened.
Activity
Diagram

Decimal Places 4 Real Specify the maximum number of decimal places to be used
when displaying the real number in tables and element
Specification windows.

Eclipse UML2 - Custom Specify the path to the location where the exported Eclipse
XMI Output UML2 XMI will be saved.
Location

Use Glossary true true/ Set to true to use the glossary functionality: mark terms in
false the text, create terms directly from the text, or reuse them in
newly created texts.

Show Excel/ true true/ If true, the Migration message is shown each time when
CSV Import false importing Excel/CSV mapping created with the CSV Import
Migration plugin.
Message

Tooltips Style Do Not Show Do Not (This is personal property, meaning its value is unique for
Show each user). Specify the mode to display the element tooltip.

Show
Element
Name

Show
Element
Docume
ntation

Legends

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 204

 Option Default value Value Description
options

Filtering Show Show Specify the default filtering preference for Legends.
Preference
Hide

Use Legends true true/ Set to true to enable Legends adorning and filtering
false functionalities across all tables and diagrams with symbols in
the project.

Ignored - multi- Specify the Legends which should not be used in the project.
Legends selectio
n

Numbering

Use Element false true/ Element auto-numbering option to control (turn off or turn
Auto-Number false on) element numbering functionality for the whole project.

Display false true/ The 'Display Element Number' option allows to turn on or
Element false turn off the representation of the element number.
Number

Lock Element false true/ If set to true, the element auto-numbering is locked and
Auto- false cannot be changed.
Numbering

Check Element false true/ Set to true to include the main element number together
Number false with all internal element numbers into element uniqueness
Uniqueness checking.
Including all
Properties

Check Element true true/ Set to true to check element number uniqueness.
Number false
Uniqueness

Check Element - multi- Element number uniqueness options allow specifying where
Number selectio your element number should be unique.
Uniqueness in: n

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 205

 Option Default value Value Description
options

ReqIF

Path to the <project.dir> custom Specify the path to ReqIF resources to allow for exchanging
resources projects among users. The default location is the project
directory <project.dir>. Absolut local path, URL, and path
variables are supported.

Store ReqIF false true/ Set to true to store the ReqIF metadata information in the
Metadata false model.
Information

Relationship - custom Specify the relationship types to export. Otherwise, all

Types relationship types are exported.

Pre-processing - custom Select rules to apply before export.

Rules

Exclude A list of - Add properties to ignore and not export into the ReqIF file.
Properties properties

Element Type - custom Specify an element type to create for the objects you are
importing. The default type, unless otherwise specified, is
Requirement.

Relation Type - custom Specify a relationship type to create for the relationships you
are importing. The default type, unless otherwise specified, is
DerivedReqt.

Post- - custom Select rules to apply after import.

processing
Rules

Import All true true/ Set to true to import all the properties into the model.
Properties false

Exclude A list of - Add properties to ignore and not import into the project.
Properties properties

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 206

 Option Default value Value Description
options

Requirements

Unredline false true/ Set to true to underline the Requirement text that matches
Patterns in false the predefined pattern.
Requirement
Text

Show Reuse true true/ (This is personal property, meaning its value is unique for
Dialog when false each user)
Deriving
Requirement Show a dialog before reusing the name and text when
creating a new Derive relation.

Reuse true true/ (This is personal property, meaning its value is unique for
Requirement false each user)
Name and Text
Reuse name and text when creating a new Derive relation.

Styling

Ask to update true true/ Set to true to ask to update outdated 'Default' symbol styles.
outdated false
'Default'
symbol styles

Ask to update true true/ Set to true to ask to update outdated 'Defined Elsewhere'
outdated false symbol styles.
'Defined
Elsewhere'
symbol styles

Suspect Links

Enable false true/ Set to true to start tracking suspect links.

Tracking false

Track true true/ Set to true to track element deletions.

Deprecated false
Elements

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 207

 Option Default value Value Description
options

Track Links in true true/ Set to true to track suspect links in the main project only.
main Project false
Only

Tracking - multi- Select elements whose suspicions should be tracked.

Scope selectio
n

SysML

Propagate true true/ If True, the propagation mechanism is turned on which

SysML Values false allows value reconfiguration from the nested structures of
the context. Propagated values will be displayed in the
initialValue compartment. Set to False to turn off the Value
Propagation mechanism. Then the values will be collected
only from the specified instances.

Change true true/ If enabled, Behavior::context will be the Block to which

allocated false behavior is allocated.
Behavior
context

Rename false true/ If set to true, the name of the property or port (except
Property on false Association End) that is default tool-generated is
Type Change automatically changed to a type name after specifying the
type for them.

Rename true true/ If set to true, the name of the Association End that is default
Association false tool-generated is automatically named as a type specified at
End on Type the role end after connecting or reconnecting the
Change Association.

Create false true/ If enabled, an association between a part property type and
Association on false part owner is created automatically.
Part Creation

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 208

 Option Default value Value Description
options

Include false true/ If enabled, includes all owned and inherited Directed
Directed false Features of the property type into derived combined
Features into direction of the Proxy Port. Tread Provided as Out, Required
Combined as In direction.
Direction of
Proxy Port

Show Units false true/ If enabled, the units are shown next to values and can be
false specified or changed directly on a Value Specification.

Show Type false true/ Use type name in property path "dot notation" when
Names in false property name is empty.
Property Path

Allocation Ask and Definitio Select the Usage mode to create allocation relationships
Mode Remember n between an Action and Part Property representing a
(Activity swimlane in which the action is contained. Select the
allocate Definition mode to create an allocation relationship between
d to a behavior of action (Activity) and Block representing a
Block) swimlane in which the action is contained.

Usage
(Activity
allocate
d to
Part)

Ask and
Remem
ber

Item Flow Direct Between Select the mode for managing Item Flow in your project:
Creation Mode Part
Types Select "Direct" to create the Item Flow between ports or parts
in SysML Internal Block Diagram.
Direct
Select "Between Part Types" to create the Item Flow between
Part property types. The "Between Part Types" option also
allows you to quickly realize and synchronize Flows on
Activity Edges, Connectors, and Messages.

Remove Not false true/ Set to true to automatically remove Item Flows after the last
Realized Item false element that realizes them is deleted.
Flows

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 209

 Option Default value Value Description
options

Creation of Disabled Fully Select "Fully Enabled" to establish relationships

Contextual enabled contextualization throughout the project.
Relationships
Partially Select "Partially Enabled" to ignore the contextualization
Enabled while creating relationships on the diagram pane.

Disabled Select "Disabled" to bypass contextualization.

Show Item true true/ Set to true to update all affected diagrams and show the
Flows on false Conveyed Items of Item Flows realized on Connectors,
Affected Activity Edges, Messages, or Associations whenever a new
Diagrams Item Flow is created or an existing one is modified.

Check Item true true/ Set to true to check the Item Flow compatibility with the
Flow false behavior model while running the Behavior to Structure
Realization Synchronization.
Compatibility Learn more about UAF Behavior to structure
synchronization419420.

Learn more about SysML Behavior to structure

synchronization421422.

UAF

Architecture - DoDAF, The architecture framework option identifies the

Framework DoDAF environment and a subset of aliases to use within the context
2.0, of the project (i.e., UAF, DoDAF, MODAF, etc.). To change the
MODAF, framework, go to File > Convert To.
NAF,
NAF 4.0,
UAF
UAF
Enterpri
se
Architec
ture

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 210

 Option Default value Value Description
options

ISO Date Time YYYY-MM-DD Various, Select ISO Date Time format for setting dates for elements.
format accordin
g to your
locale

Use MIL- None Availabl Specifies which MIL-STD-2525 Symbology Library Version to
STD-2525 e library use for the project.
Symbology versions
Library

BPMN false true/ Specifies whether the compliant BPMN stereotypes should be
Compliance false applied to UAF Elements. The options must be true to create
Mode UAF diagrams dependent on the Business Process Diagram.

Map UAF false true/ Specifies whether the Entity stereotype should be applied to
Information false the UAF Entity Item element. The options must be true to
Elements on create a UAF Entity Relationship Diagram.
ERD Entities

Auto Check false true/ If true, the user will be automatically notified about model
Model false incompleteness (recommended for novice UAF users). Note,
Completeness that the auto-check may decrease the performance of the
modeling tool.

Respect UAF true true/ Specifies whether the realization of inherited Operational
Information false Exchanges/Resource Exchanges is allowed or not.
Flows on
Generalization

Respect UAF true true/ Specifies whether the realization of aggregated Operational
Information false Exchanges/Resource Exchanges is allowed or not.
Flows on
Aggregation

Default - - Defines the default owner for Property Sets, that are created
Property Sets using Property Set Models such as SV-7, NSV-7, or SvcV-7.
owner

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 211

 Option Default value Value Description
options

Inform about true true/ Set to true to inform about user read-only projects that
user read-only false haven't been converted during project conversion.
projects after
conversion

Show default true true/ Specifies whether the default Package documentation should
documentatio false be shown in the UAF Packages Documentation property:
n for UAF Set to true to show the default Package documentation for
Packages the newly created UAF Packages.
Set to false to create the new UAF Packages without the
default documentation. Learn more>>>423424

Default Operational - Defines the default owner for Operational constraints.

Operational Constraints Depending on the framework, the default owner is
Constraints Operational Constraints, Business Rules, OV-6a, NOV-6a, or
Owner L8. Change the default owner by choosing a different one
from the model.

Default Resource - Defines the default owner for Resource constraints.

Resource Constraints Depending on the framework, the default owner is Resource
Constraints Constraints, SV-10a, NSV-10a, or P8. Change the default
Owner owner by choosing a different one from the model.

Default Service Service - Defines the default owner for Service Policies and Service
Constraints Constraints Contracts constraints. Depending on the framework, the
Owner default owner for the Service Policies constraints is Service
Constraints, SOV-4a, SvcV-10a, or S8 and for the Service
Contracts, the default owner is Service Constraints. Change
the default owner by choosing a different one from the
model.

Default Strategic - Defines the default owner for Strategic constraints.

Strategic Constraints Depending on the framework, the default owner is Strategic
Constraints Constraints or C8. Change the default owner by choosing a
Owner different one from the model.

Default Security - Defines the default owner for Security constraints. Depending
Security Constraints on the framework, the default owner is Security Constraints.
Constraints Change the default owner by choosing a different one from
Owner the model.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 212

 Option Default value Value Description
options

Validation

Validation - multi- Specify the validation scope. The validation scope can be the
Scope selectio entire model or some part of it. When the validation is run,
n each validation rule is evaluated for each suitable element in
the validation scope.

Validate only true true/ Set to true to validate only elements in one or more visible
Visible false diagrams.
Diagrams

Exclude true true/ Set to true to exclude projects used in read-only mode and
Elements from false the elements that exist in these projects. Excluded projects
Used Read- will not be validated.
Only Project

Mark in Tree true true/ Set to true to highlight the invalid model elements in the
and Diagrams false browser with a small x symbol. The element symbol will be
colored according to the severity level of the problem in the
diagram.

Ignored - multi- Specify the validation suites which should not be run during
Validation selectio the model validation.
Suites n

Ignored - multi- Specify the validation rules that should not be run during the
Validation selectio automatic model validation.
Rules n

Minimal warning debug Specify the minimal severity. When the validation is running,
Severity only the validation rules of the specified and the higher
info severity level will be run.

warning

error

fatal

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 213

 Option Default value Value Description
options

Composition Standard Standar Select the level of composition inspection in your projects.
Inspection d The Standard inspection searches for issues only in the
project, while the Advanced inspection, in addition to the
Advance Standard inspection, searches for issues in all the used
d projects. The inspection runs validation rules which validate
the correctness of model integrity and project composition.

Detect Illegal true true/ Set to true to check for illegal model references in projects.
Model false Illegal references are one of the main reasons why recovered
References in elements appear in shared projects.
Shared
Projects

Ignored - multi- Specify the validation suites which should not be run during
Validation selectio the passive diagram validation.
Suites n

Ignored - multi- Specify the validation rules which should not be run during
Validation selectio the passive diagram validation.
Rules n

Minimal warning debug Specify the minimal severity. When passive diagram
Severity validation is running, only the validation rules of the specified
info and the higher severity level will be run.

warning

error

fatal

Diagram Info

Diagram information shows summarized data in each diagram, e.g. the author, creation and modification dates,
etc. Choose the diagram tags in standard mode, their values should be shown in a predefined diagram
information table, or choose how diagram information should e represented using the HTML code.

Symbol styles

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 214

 Option Default value Value Description
options

Specify the shape, path, diagram, and stereotype symbol properties. Create, edit, clone, import/export, or
remove element display styles. Also, set default styles or apply new styles to existing diagrams.

Default

Fill Color RGB [255, 255, Custom Change the fill color of the shape.
204]

Use Fill Color true true/ Shapes are colored on the diagram.
false

Pen Color RGB [66, 66, 66] Custom Change the color of the path or lines around shapes.

Text Color RGB [0, 0, 0] Custom Change the color of the text.

Line Width 1 Real Specify the line width of the symbol.

Font Arial 11 multi- Change the font style of the text.

list

Show Number true true/ The option allows you to turn on or turn off the element
Tag Name false number tag name on the symbol.

Element Before the Above The element number display mode option specifies the
Number element name the position on the symbol where the element number should be
Display Mode element displayed.
name

Before
the
element
name

Do not
display
on
symbol

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 215

 Option Default value Value Description
options

Shapes

Fill Color RGB [255, 255, Custom Change the fill color of the shape.
204]

Use Fill Color true true/ Shapes are colored on the diagram.
false

Pen Color RGB [66, 66, 66] Custom Change the color of the path or lines around shapes.

Text Color RGB [0, 0, 0] Custom Change the color of the text.

Line Width 1 Real Specify the line width of the symbol.

Font Arial 11 multi- Change the font style of the text.

list

Show Number true true/ The option allows you to turn on or turn off the element
Tag Name false number tag name on the symbol.

Element Before the Above The element number display mode option specifies the
Number element name the position on the symbol where the element number should be
Display Mode element displayed.
name

Before
the
element
name

Do not
display
on
symbol

Autosize false true/ Adjusts the size of a symbol to the contained information so
false that it uses minimum space.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 216

 Option Default value Value Description
options

Use Fixed false true/ When drawing a path between shapes, the end of the path is
Connection false connected to the fixed point of the shape.
Points

Suspend Auto- Same as Diagram Same as Set to true to keep the original size of the selected shape
Resizing of Diagram while editing the model by cutting text to fit the shape. You
Shape can use the Resize to Fit Content command (a small black
true square on the bottom line of the selected shape) to adjust the
size of the shape to fit the content completely. By default, the
false appropriate property defined for the diagram is used.

Suspend Auto- Same as Diagram Same as Set to true if you do not want to automatically show labels on
Displaying of Diagram the diagram pane while editing the model. You can use the
Label Show Suspended labels command (a small black square on
true the selected path) to show suspended labels on the diagram
pane. By default, the appropriate property defined for the
false diagram is used.

Label Horizontal Horizont Specify the orientation of the labels. Automatic label
Orientation al orientation will rotate labels of symbols according to the
symbol orientation or edge orientation on which the symbol
Vertical is placed.

Automat
ic

Header in Bold true true/ Shows the name of the symbol as bolded.
false

Text Vertical Top Top Choose text and compartments' vertical position within the
Position symbol.
Center

Bottom

Stereotype RGB [0, 0, 0] Custom Change the color of the stereotype text label.
Color

Stereotype Arial 11 multi- Change the font style of the stereotype text label.
Font list

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 217

 Option Default value Value Description
options

Show Text and Icon Text and Display stereotypes on symbols.

Stereotypes Icon

Text

Icon

Shape
Image
and Text

Shape
Image

Do Not
Display

Show DSL All All Specify whether to show all, none, or only the last of the DSL
Stereotypes Stereotypes (stereotypes that have DSL customization with
Only the option hideMetatype = true) on a symbol.
Last

None

Show true true/ Displays constraints on symbols.

Constraints false

Show Owner Do Not Display Do Not Displays the name of the owner model element (beneath the
Display corresponding model element name - old style notation, in
the same line with the name, or above the element name).
Below
Element
Name

In Same
Line
With
Name

Above
Element
Name

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 218

 Option Default value Value Description
options

Wrap Words false true/ Wraps words to a new line when text exceeds textbox (name,
false constraint, tagged value, conveyed information, extension
point, or provided and required interfaces) width.

Show Tagged true true/ Displays tagged values on symbols.

Values false

Tagged Values Right Center Choose the text alignment position of tagged values and
and constraints on the shape.
Constraints Left
Horizontal
Position Right

Constraint Expression Name Choose the constraint name or expression to be displayed on

Text Mode the symbol.
Expressi
on

Name
and
Expressi
on

Show Element false true/ Choose if the properties are displayed on the symbol of the
Properties false element.

Show Icons in true true/ Set to true to show the icon before the element name in the
Compartments false compartment.

Show Element false true/ Set to true to show the element type before its name when
Type in false the icons are hidden in the compartment.
Compartments

Show Derived false true/ Set to true to show the derived sign (/) before the element
Sign false name in the Tagged Values compartment.

Paths

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 219

 Option Default value Value Description
options

Fill Color RGB [255, 255, Custom Change the fill color of the shape.
204]

Use Fill Color true true/ Shapes are colored on the diagram.
false

Pen Color RGB [66, 66, 66] Custom Change the color of the path or lines around shapes.

Text Color RGB [0, 0, 0] Custom Change the color of the text.

Line Width 1 Real Specify the line width of the symbol.

Font Arial 11 multi- Change the font style of the text.

list

Show Number true true/ The option allows you to turn on or turn off the element
Tag Name false number tag name on the symbol.

Element Before the Above The element number display mode option specifies the
Number element name the position on the symbol where the element number should be
Display Mode element displayed.
name

Before
the
element
name

Do not
display
on
symbol

Path Style Rectilinear Rectiline Choose the style for the selected path.
ar

Oblique

Bezier

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 220

 Option Default value Value Description
options

Rounded false true/ Path breakpoints rounded or not.

Corners false

Constraint Expression Name Choose the constraint name or expression to be displayed on

Text Mode the symbol.
Expressi
on

Name
and
Expressi
on

Suspend Auto- Same as Diagram Same as Set to true to keep the original size of the selected shape
Resizing of Diagram while editing the model by cutting text to fit the shape. You
Shape can use the Resize to Fit Content command (a small black
true square on the bottom line of the selected shape) to adjust the
size of the shape to fit the content completely. By default, the
false appropriate property defined for the diagram is used.

Suspend Auto- Same as Diagram Same as Set to true if you do not want to automatically show labels on
Displaying of Diagram the diagram pane while editing the model. You can use the
Label Show Suspended labels command (a small black square on
true the selected path) to show suspended labels on the diagram
pane. By default, the appropriate property defined for the
false diagram is used.

Label Horizontal Horizont Specify the orientation of labels. Automatic label orientation
Orientation al will rotate labels of symbols according to the symbol
orientation or edge orientation on which the symbol is
Vertical placed.

Automat
ic

Diagram

Pen Color RGB [66, 66, 66] Custom Change the color of the path or lines around shapes.

Text Color RGB [0, 0, 0] Custom Change the color of the text.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 221

 Option Default value Value Description
options

Line Width 1 Real Specify the line width of the symbol.

Font Arial 11 multi- Change the font style of the text.

list

Show Number true true/ The option allows you to turn on or turn off the element
Tag Name false number tag name on the symbol.

Element Before the Above The element number display mode option specifies the
Number element name the position on the symbol where the element number should be
Display Mode element displayed.
name

Before
the
element
name

Do not
display
on
symbol

Background RGB [255, 255, Custom Change the color of the diagram background.
Color 255]

Use Gradient true true/ Use gradient for the shape color.
Fill false

3D Shadow true true/ Display 3D shadow on shapes.

false

Show Grid false true/ Displays gridlines on the diagram background.

false

Grid Size 7 2-30 Define the desired size for the gridlines.

Snap Paths to true true/ When moving paths, snap them to the grid.
Grid false

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 222

 Option Default value Value Description
options

Snap Shapes true true/ When moving shapes, snap them to the grid.
to Grid false

Show Message true true/ Show message numbers on the diagram.

Numbers false

Use Advanced true true/ Use advanced numbering.

Numbering false

Show true true/ Display activation bars on lifelines in sequence diagrams.

Activations false

Show Diagram false true/ Display the table with the main information (name, author,
Info false creation and modification dates, etc.) about the diagram.

Show Owner false true/ Displays diagram owner on the diagram tab.
false

Show Text and Icon Text and Display stereotypes on symbols.

Stereotypes Icon

Text

Icon

Shape
Image
and Text

Shape
Image

Do Not
Display

Show DSL All All Specify whether to show all, none, or only the last of the DSL
Stereotypes Stereotypes (stereotypes that have DSL customization with
Only the option hideMetatype = true) on a symbol.
Last

None

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 223

 Option Default value Value Description
options

Use Diagram Context Use diagram stereotype or diagram context stereotype.

Stereotype
Diagram

Stereotype RGB [0, 0, 0] Custom Change the color of the stereotype text label.
Color

Stereotype Arial 11 multi- Change the font style of the stereotype text label.
Font list

Diagram Vertical Vertical Set a diagram orientation mode.

Orientation
Horizont
al

Add Line Horizontal Line None Specified how line jumps are added to intersections of links
Jumps To on the diagram. None - specifies that the diagram use no line
Horizont jumps. Horizontal Line - specified that the line jumps appear
al Line only on horizontal lines. Vertical Line - specified that the line
jumps appear only on the vertical lines.
Vertial
Line

Suspend Auto- Same as Diagram Same as Set to true to keep the original size of the selected shape
Resizing of Diagram while editing the model by cutting text to fit the shape. You
Shape can use the Resize to Fit Content command (a small black
true square on the bottom line of the selected shape) to adjust the
size of the shape to fit the content completely. By default, the
false appropriate property defined for the diagram is used.

Suspend Auto- Same as Diagram Same as Set to true if you do not want to automatically show labels on
Displaying of Diagram the diagram pane while editing the model. You can use the
Label Show Suspended labels command (a small black square on
true the selected path) to show suspended labels on the diagram
pane. By default, the appropriate property defined for the
false diagram is used.

Show Diagram true true/ Displays diagram frame on the diagram.

Frame false

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 224

 Option Default value Value Description
options

Show false true/ Shows full/abbreviated diagram keyword type on the

Abbreviated false diagram frame header.
Type

Show Diagram true true/ The diagram name is displayed or hidden in the diagram
Name false frame header.

Show Diagram false true/ The diagram kind is displayed or hidden in the diagram frame
Type false header.

Show true true/ The diagram context element parameters (if there are any)
Parameters false are displayed in the diagram frame header.

Show Context true true/ The diagram context element name is displayed or hidden in
Name false the diagram frame header.

Show Context false true/ The diagram context element type is displayed or hidden in
Type false the diagram frame header.

Show Context true true/ The context kind is a keyword predefined in UML (e.g.,
Kind false package, class, activity).

Autosize false true/ Adjusts the size of a symbol to the contained information so
false that it uses minimum space.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 225

 Option Default value Value Description
options

Aspect Ratio Unspecified Unspecif Choose the diagram frame aspect ratio from the list or define
ied a new one. the format of your defined aspect ratio should be
'W:H'.
1:1

4:3

3:4

16:9

9:16

A4
Landsca
pe

A4
Portrait

US
Letter
Landsca
pe

US
Letter
Portrait

Use Rounded true true/ Use rounded corners on the diagram frame. Diagram frames
Corners false in Activity and State Machine diagrams can be represented as
rounded rectangles.

Suspend Auto- Same as Diagram Same as Set to true to keep the original size of shapes while editing
Resizing of Diagram the model by cutting text to fit inside the shape. You can use
Shapes the Resize to Fit Content command (a small black square on
true the bottom line of the selected shape) to adjust the size of
the shape to fit the content completely.
false

Stereotypes

Create elements' properties by stereotype. These properties will be applied when the symbol of the stereotyped
element is created on the diagram pane.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 226

 Option Default value Value Description
options

Default model properties

In the Default model properties tab, select an element and change its default property values (the element will
have these values after its creation). To change the default value only for a specific diagram, go to Diagrams
main menu / Customize and edit the selected element properties.

Code Engineering

Set general code generation or code reversing options. Also, configure generated code formatting styles for the
selected programming languages. Subcategories:

Code Generation

Reverse

Java Language Options

C++ Language Options

CORBA IDL 3.0 Language Options

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 227