Magicdraw Manual.Book

USER’S MANUAL version 10.0

No Magic, Inc. October, 2005

CONTENTS 1

CONTENTS 2

2INTRODUCING MAGICDRAW 2-10 MagicDraw Editions and Features 2-11 MagicDraw Personal edition 2-11 MagicDraw Standard edition 2-11 MagicDraw Professional editions 2-11 MagicDraw Enterprise edition 2-12 MagicDraw Reader Edition 2-12 MagicDraw Community Edition 2-12 MagicDraw Documentation and Support 2-12 Help 2-13 User’s Guides 2-13 Other Documentation 2-14 Support 2-15 FAQ 2-15 Newsgroups 2-15 E-mail 2-15 Bug Reports 2-15

3GETTING STARTED 3-18 Installing and Running 3-18 System requirements 3-18 Java Virtual Machine (JVM) 3-18 Operating system - dependent issues 3-19 Installation procedure 3-19 Windows 2000/9x/NT/XP 3-19 Unix 3-20 MAC OS X 3-20 All other platforms instructions (no install version) 3-20 Updating 3-20 Auto-Check for Updates dialog box 3-21 structure of menus and toolbars 3-21 Setting Personal Preferences 3-22 Environment Options 3-22 General pane 3-23 Diagram pane 3-26 Browser pane 3-28 MagicDraw User’s Manual Contents

Teamwork pane 3-29 Floating pane 3-30 CVS pane 3-31 Update pane 3-32 HTTP Proxy pane 3-33 Keyboard pane 3-34 Plugins pane 3-35 Resources pane 3-36 Path Variables Pane 3-37 Launcher Pane 3-38 Look and Feel: Controlling Interface 3-38 JIDE and Multiple Windows interface styles 3-40

4WORKING WITH PROJECTS 4-42 Creating New Project 4-42 Creating new project from already created template 4-43 Importing project 4-44 Saving and Exporting 4-44 Exporting project as template 4-45 Saving diagram as image 4-46 Autosave 4-48 Loading 4-48 Project Options. Style Engine 4-49 Project Options 4-49 Symbols Properties Styles Tree 4-52 Working with Properties Styles 4-56 Properties extension by diagram 4-56 Properties Inheritance 4-57 General Style Properties 4-58 Shapes, Paths and Diagrams Properties 4-58 Stereotypes properties 4-59 Reusing project parts in modules 4-61 Working with Modules 4-61 Exporting Project Module 4-61 Using Project Modules 4-63 Importing Project Modules 4-63 Sharing packages 4-63 Opening Your Module As a Project 4-65 Reloading Your Module 4-65 Dependencies Between Elements 4-66 Packages dependencies by relationships 4-66 Dependencies by reference 4-69 Diagrams dependencies 4-69 Package Dependencies Dialog Box 4-70

Profiles 4-72 Creating Profiles 4-72 Using and Importing Profiles 4-72 Exporting Profiles 4-74 Model Differencing 4-74 Models comparison 4-74 Understanding model differences 4-75 Diagrams Comparison 4-78 Working with multiple projects 4-80 Using Browser 4-82 The Browser window parts 4-83 Containment tree 4-84 Data branch 4-86 Code engineering sets 4-86 Diagrams tree 4-88 Inheritance tree 4-89 Model Extensions Tree 4-90 Search Results Tree 4-91 Working with model elements in the Browser tree 4-91 Multiple selection 4-92 Documentation/Zoom Control/Properties 4-93 Documentation tab 4-93 Zoom Control tab 4-94 Properties tab 4-94 Searching 4-95 Java Regular Expressions 4-98 Metacharacters 4-98 Character Sets 4-99 Grouping 4-99 Quantifiers 4-99 Boundary Matchers 4-100 Embedded Flag Expressions 4-100 Resource Manager 4-101 MagicDraw RConverter 4-103

5DIAGRAMS BASICS 5-104 Working with Diagrams 5-104 Diagrams Dialog Box 5-106 Diagram Properties 5-107 Table with diagram information 5-109 Drawing Shapes 5-110 Drawing Relationship paths 5-113 Smart Manipulation 5-114 Selection & Multiple Selection 5-116 Dragging, Copying, Cutting, and Pasting 5-116

Specifying Model Elements 5-118 Specification dialog boxes 5-118 Documentation/Hyperlinks tab 5-119 Relations tab 5-121 Tagged Values tab 5-122 Constraints tab 5-124 General tab 5-124 Attributes tab 5-126 Operations tab 5-127 Teplate Parameters tab 5-128 Buttons available in the Specification dialog boxes 5-129 Formatting Symbols 5-129 Owner of the model element 5-130 Model Traceability 5-130 Usages Functionality 5-131 Dependent Elements functionality 5-131 Find Usages / Dependent Elements Options dialog box 5-132 Elements Using/Dependencies windows 5-133 Defining Hyperlinks 5-135 Insert Hyperlink dialog box 5-136 Laying out 5-138 Orthogonal Layouter 5-139 Hierarchic Layouter 5-139 Tree Layouter 5-141 Organic Layouter 5-143 Circular Layouter 5-144 Orthogonal Path Router 5-145 Organic Path Router 5-145 Class Diagram Layouter 5-146 Quick Diagram Layout feature 5-147 Zooming 5-147 Using Grid 5-148 Assigning Shortcut Keys 5-149 Printing 5-150 Print Range tab 5-150 Print Options Tab 5-152 Print Header/Footer Tab 5-153 Model Elements Common in all Diagrams 5-154 Anchor to Note 5-155 Constraint path 5-155 Separator 5-156 Documentation 5-156

6 UML DIAGRAMS 6-158 System Views 6-159 Use Case View 6-159 Logical View 6-159 Process view 6-160 Component view 6-160 Deployment view 6-160 Class Diagram 6-160 Class diagram elements 6-162 Use Case Diagram 6-167 Use Case diagram elements 6-168 Communication Diagram 6-170 Communication Diagram elements 6-171 Sequence Diagram 6-171 State Diagram 6-174 State Diagram elements 6-174 Activity Diagram 6-178 Activity Diagram elements 6-179 Implementation Diagram 6-183 Component diagram overview 6-183 Deployment diagram overview 6-184 Implementation Diagram elements 6-185 Composite Structure Diagram 6-190 Composite Structure Diagram elements 6-191

7MODEL ELEMENTS 7-194 Classes 7-194 Working with classes 7-194 Interface 7-197 Attribute 7-198 Operation 7-203 Template / Parameterized class 7-208 Port 7-209 Data types 7-211 Enumeration 7-212 Primitive 7-214 Design Patterns 7-214 Class presentation options 7-215 Packages 7-216 Working with packages 7-217 Profile 7-218 Model 7-219 Collaboration 7-219 Generalization 7-221

Generalizable elements 7-223 Association 7-223 Association End 7-225 Realization 7-229 Dependency 7-231 Template Binding dependency 7-232 Abstraction 7-233 Usage 7-233 Package Merge 7-234 Package Import 7-234 Element Import 7-234 Containment 7-235 Actors 7-235 Working with Actors 7-235 Use Cases 7-236 Use Case Extensions 7-238 Relationships in Use Case Diagrams 7-239 Association 7-240 Extend 7-240 Include 7-242 Generalization 7-242 Dependency 7-243 Realization 7-243 Instance Specification 7-243 Instance Specification dialog boxes 7-243 Connector 7-245 Lifeline 7-247 Message 7-248 Predecessors and activators 7-252 Actions 7-253 Interaction Use 7-255 Combined Fragment 7-256 Lifelines in Sequence Diagram 7-257 Messages in Sequence Diagram 7-258 State 7-258 Composite State 7-260 Submachine 7-261 Pseudo State 7-262 Initial 7-262 Final state 7-263 Terminate 7-263 Entry Point 7-263 Exit Point 7-263 Deep History 7-263 Shallow History 7-263

Junction 7-263 Choice 7-263 Fork/Join 7-264 Transition 7-264 Event types 7-266 Internal transitions 7-266 Flow Final Node 7-267 Decision Node 7-267 Object Node 7-268 Send Signal Action 7-269 Accept Event Action 7-270 Swimlanes 7-271 Components 7-274 Nodes 7-276

8 UML EXTENSION MECHANISMS 8-280 Stereotype 8-280 Stereotype Specification dialog box 8-280 Profiles dialog box, Stereotypes tab 8-282 UML Web Extension stereotypes 8-284 Tag Definitions 8-291 Tagged Value Edition 8-292 TODO item 8-294 Constraints 8-294 Constraint Specification dialog box 8-296

9EXTENSION DIAGRAMS 9-298 Content Diagram 9-299 Content Diagram Elements 9-300 Robustness Diagram 9-303 Robstness Diagram Elements 9-305 Web Diagram 9-306 Web Diagram Elements 9-308 CORBA IDL Diagram 9-312 CORBA IDL Diagram Elements 9-313 DDL Diagram 9-315 DDL Diagram Elements 9-316 WSDL Diagram 9-317 WSDL Diagram Elements 9-318 XML Schema Diagram 9-320 XML Schema Diagram Elements 9-321 Time Diagram 9-323 Time Diagram Elements 9-324 Business Process Diagram 9-325

Business Process Diagram Elements 9-326

10TOOLS 10-332 Reports 10-332 Template Management tab 10-333 Document Options 10-337 Model Report 10-338 Use Case Report 10-340 Software design Description 10-341 Model Extension Report 10-343 Select Packages tab 10-344 Select Diagrams tab 10-345 Output Options tab 10-346 Report Customization 10-347 New report style creation example 10-348 Fonts in PDF and PS reports 10-349 Report Generator Tool 10-350 Starting report generator 10-350 Generating Configuration file 10-350 Class Diagram Wizard 10-351 Package Dependency Wizard 10-355 Package Overview Diagram Wizard 10-358 Tools for Analysis 10-363 Hierarchy Diagram Wizard 10-364 Realization Diagram Wizard 10-367 Content Diagram Wizard 10-372 Sequence Diagram from Java Source Wizard 10-374 Pattern Wizard 10-378 Creating Setters / Getters 10-385 Implementing or Overriding Operations 10-386 Model Transformation Wizard 10-387 Types of transformations 10-387 Model Transformation Wizard 10-388 Model Transformation Mapping 10-391 Transformation Mapping Options 10-392 Model Transformation Update 10-395 Metrics 10-396 Metric Suites 10-397 Displaying Metrics 10-397 Starting Metrics 10-398 Metrics window 10-401 Exporting Metrics 10-401 Comparing metrics 10-403 Metrics Options 10-403 Metrics Properties 10-405

Today’s graphical software can be extremely complex in its structure and architecture, but that does not mean it must be difficult to use. We have learned much from the hardware industry, where everything you see is scattered pieces. This approach also works well in the software world – objects at a higher abstraction level are treated like “software pieces.” To simplify the process further, we may use pictures instead of textual descriptions to show the relationships between objects in a complex system. Though pictures work better than textual descriptions alone, experience has proven that communicating complex ideas effectively requires more than simple flowcharts. Early methodologies, such as Booch notation, OMT, and others, served the same purpose: to graphically express the software’s architecture information. However, these methodologies accomplished this in slightly different ways and with different levels of thoroughness. In 1994, Grady Booch, Jim Raumbaugh, and Ivar Jacobson came together to unify their varied methods and experience. The UML (Unified Modeling Language) was the fruit of their joint effort. UML was crafted with two objectives: To reflect the best practices of the industry, and to demystify the process of software system modeling. In short, UML provides standardized pictures of your software applications and allows your development team to quickly grasp the functionality contained within the application. UML is a language and a process with neutral notation, which means that you may use it to design your entire OO system in any programming language and any software development process. The development of a model for an industrial-strength software system, prior to its construction or renovation, is as essential as having a blueprint for a large building. Good models are vital for effective communication among project teams. In the early 1990s, the tools for OO software modeling emerged, followed by the development of the visual modeling approach. Visual modeling means that you first design your system by drawing diagrams (blueprints) and then employ tools to convert those diagrams into code. The value of such an approach is that the often tedious framework coding is done automatically, freeing the programmer to focus on design issues, plus, the transition from the design to the implementation phase is smoother more and straightforward. Moreover, using the features of reverse engineering and code generation, the developer may move back and forth between the code and the design that is expressed in the diagrams. Today, visual modeling tools provide many features that replace some of the more tedious tasks for the designer, programmer, and documentation writer. Some of the leading tools provide so-called code round-trip engineering capabilities – the structure of reverse engineered code is changed in the modeling tool and is generated back without the implementation of specific information (e.g. method bodies, comments) loss.

MagicDraw is a visual UML modeling and CASE tool with teamwork support. Designed for Business Analysts, Software Analysts, Programmers, QA Engineers, and Documentation Writers, this dynamic and versatile development tool facilitates analysis and design of Object Oriented (OO) systems and databases. It provides the industry's best code engineering mechanism (with full round-trip support for Java, C#, C++, WSDL, XML Schema, and CORBA IDL programming languages), as well as database schema modeling, DDL generation and reverse engineering facilities.

MAGICDRAW EDITIONS AND FEATURES The detailed list of MagicDraw features find at: http://www.magicdraw.com/files/brochures/a4/MagicDrawDataSheet.pdf

M AGICD RAW PERSONAL EDITION The MagicDraw Personal Edition contains all of MagicDraw's powerful UML diagramming capabilities, including full UML 1.4 support and extensibility features, basic reporting functionality and image export. Files are stored in XMI format. All model elements can be accessed via MagicDraw's Open API. In this edition, you will find everything you need to draw, edit and publish your UML models. MagicDraw Personal Edition is available only in a standalone version and is not designed for use with the MagicDraw Teamwork Server.

M AGICD RAW STANDARD EDITION The Standard Edition takes all of the Personal Edition's features and adds to them a WAE, content, and Robustness diagrams, model analysis and facilitation features, customizable and extendable patterns, integrations with most popular IDEs and a set of predefined model templates and UML profiles. The Standard Edition also supports UNISYS XMI diagramming extensions for interchanging the MagicDraw models you create with other UML modeling tools as well as the latest Model Driven Architecture (MDA) tool offerings. The Standard Edition is available in standalone, floating and mobile license versions and is fully compatible with the MagicDraw Teamwork Server. The Standard Edition is ideally suited for all analysts and architects who need various model extensions and modeling facilitations.

M AGICD RAW PROFESSIONAL EDITIONS The Professional Edition is built on the Standard Edition's capabilities and is available in one of three programming language specific versions-Java, C++ and C#. In addition to the Standard Edition's features, the Professional Edition adds code generation and reverse engineering functionality. Depending on the language version selected, the user will receive:

• Java version - Code engineering for Java, Java bytecode. Integration with Java IDEs.

• C++ version - Code engineering for C++.

• C# version - Code engineering for C#, CIL (MSIL). The Professional Edition is ideal for anyone who wants to generate code out of an existing model or create a UML model from an existing project.

M AGICD RAW ENTERPRISE EDITION The MagicDraw Enterprise Edition represents the top of the line of the MagicDraw family of products and represents the ultimate solution for all your modeling needs. The Enterprise Edition combines all of the functionality of the Personal and Standard Editions, and all three versions of the Professional Edition, into a comprehensive state-of-the-art UML programming solution. But the Enterprise Edition does not stop there and adds code engineering and diagramming functionality in CORBA IDL, EJB, WSDL and XML schema. For working with DB structure, the Enterprise Edition not only provides code engineering and diagramming but also provides structure retrieval via JDBC. The MagicDraw Enterprise Edition is a must when working with multiple development technologies and databases. The MagicDraw family of award-winning products represents the most powerful and best value in the UML modeling industry today.

M AGICD RAW READER EDITION MagicDraw Reader edition is made for reading and previewing UML models created with MagicDraw and is free of charge. It is extremely useful when you want to share your ideas expressed in UML with partners, colleagues, or clients, who do not have their copy of MagicDraw. This edition is also equipped with printing and image export capabilities.

M AGICD RAW COMMUNITY EDITION MagicDraw Community edition is a free edition for developers working on non-commercial projects. It has a minimal functionality set and only class diagram has no limitations. Other diagrams allows saving a project with 25 use cases, 25 states, 25 classifier roles, 25 action states, 25 instances, 25 nodes, and 25 components. MagicDraw Community edition is designed for creating static structure models, when XMI output is needed and is ideally suited for Open Source projects. This edition is also equipped with printing and image export capabilities.

MAGICDRAW DOCUMENTATION AND SUPPORT MagicDraw provides several kinds of documentation. Choose the way you want to know how to use MagicDraw. The main information about MagicDraw, you may find at www.magicdraw.com.

Help

Integrated in the MagicDraw help is based on JavaHelp. MagicDraw help provides detailed description of all MagicDraw dialog boxes, commands, shortcut menus, also you will find their a How to.. list, main descriptions and examples of all UML model elements.

User’s Guides

Name Description Location MagicDraw Includes detailed • /manual instructions of installing and • Start/Programs/MagicDraw working with MagicDraw. UML/MagicDraw User Manual.pdf • www.magicdraw.com -> Download->Download Manual

Name Description Location MagicDraw In this user guide you will • /manual UserGuide.pdf information about reverse • www.magicdraw.com -> and generation in Download->Download MagicDraw but also Manual detailed descriptions about DDL, CORBA IDL, EJB 2.0, and XML Schema usage in MagicDraw. MagicDraw Tutorials Step by step instructions UserGuide.pdf presenting the basics of using MagicDraw diagramming, creation of sequence diagram, integration with CVS and Eclipse. MagicDraw Integrations You will find here the full UserGuide.pdf description of how to integrate MagicDraw with Eclipse, Borland JBuilder, Sun One Studio (before called Forte) including Netbeans, and CVS. MagicDraw Here you will find how setup FloatingLicense and how to use MagicDraw UserGuide.pdf Floating License server. MagicDraw Teamwork In this document, you will UserGuide.pdf find information how to install, set up, and use Teamwork Server and Teamwork Server Administrator. Also included detailed descriptions of how to work with the teamwork projects. MagicDraw OpenAPI • /openapi/docs This document describes MagicDraw Open Java API and provides instructions how to write your own plugins, create actions in the menus and toolbars, change UML foundation elements, and create new patterns.

O THER DOCUMENTATION • Readme files. In the main MagicDraw installation directory, the main readme.html file is located. Also readme documents are available for MagicDraw integrations.

• Notes. In the notes.html file you will find the main information about MagicDraw features.

Support

FAQ Before you call or write an email, look into our FAQ (Frequently Asked Questions) list. It is constantly updated and perhaps it contains an answer to your question.

N EWSGROUPS Discuss and get answers about MagicDraw in newsgroups.

E-MAIL We provide a professional e-mail support for registered MagicDraw users. [email protected] - private questions about product installation, and more. [email protected] - questions regarding academic and site discounts, quotes. [email protected] - e-mail for other contacts. Get an answer in 24 hours!

B UG REPORTS Submit notifications of software errors by submitting a bug directly from MagicDraw application (Help menu->Submit a Bug) or by sending an email to [email protected]. These reports help us address defects in a more timely manner, as well as speed up the release of maintenance releases free of known defects. When sending your report by email, please include (if applicable):

• MagicDraw UML version number and name of the edition (Reader, Community, Personal, Standard, Enterprise, Professional Java, Professional C++, Professional C#, Demo, or Academic).

• Source where you got the version from (demo CD, our homepage download).

• Version distribution (Standard/Professional, Windows/Java bytecode).

• Your OS name and version.

• JDK version, JVM vendor.

• CLASSPATH settings. If you don't have this information, you can find it by opening the About dialog from MagicDraw Help menu. If MagicDraw is unable to load your file, and the file is non- confidential, please attach it to your submission. This will assist us in our analysis of your problem.

INSTALLING AND RUNNING

System requirements

To run MagicDraw UML, your system must meet the following requirements: Resource type Minimum Recommended CPU Pentium III 500 Pentium 4 1600 Memory 256 MB 512MB; 1GB is recommended for larger projects Disk space 200 MB 200 MB or more Video mode 800*600 @ 64k Colors 1280*1024 @ 64k Colors Operation system All that have Java compatible JVM 1.4: Windows 95/98/NT/2000/XP, Linux, Mac OS X (most testing procedures and debugging were performed on those platforms) HTML browser Any Netscape Navigator or IE Java Virtual JDK 1.4 Sun’s JDK 1.5.0_03 Machine (JVM)

Java Virtual Machine (JVM)

You may have the JVM installed on your computer or install JVM together with MagicDraw specifically for MagicDraw application. JVM is an application that provides the interpretation of the bytecode Java class files. Different operating systems may have different JVM implementations, thus some bugs may be specific to the operating system or JVM. MagicDraw is a stable environment, if it is configured properly and if the stable JVM is used. USE RECOMMENDED JVM TO AVOID A LOT OF PROBLEMS. All recommendations are written below. As MagicDraw is a Java application, most of the stability and performance depends on the JVM implementation. Refer to the JVM specification and problems' description, if you have problems on the specific OS.

JDK 1.1.x, 1.2.x, and 1.3.x is not supported. You can review your system and JVM information in the About dialog box, Info tab (from the Help menu, choose About). JDK version also can be encountered from command line by writing: java -version

To change Java version Change line in file mduml.properties (this file is in bin folder): JAVA_HOME =

O PERATING SYSTEM - DEPENDENT ISSUES Because MagicDraw is 100% Pure Java, it is platform independent and runs on a variety of operating systems. However, for Java applications to interact properly with the operating system, Java Virtual Machine (JVM) software is required. JVM software varies depending on the operating system, and MagicDraw may perform inadequately with the wrong one. The performance of Java applications depends on the performance of the Java Virtual Machine. A badly designed Machine may degrade the performance of MagicDraw. It could even cause MagicDraw to fail or crash. To avoid these problems, we recommend that you use the following Virtual Machines:

• Sun (JDK standard) for Solaris and Linux. JDK 1.5.0_03 is recommended.

• Sun (JDK standard) for Windows (2000, NT, 95/98). JDK 1.5.0_03 is recommended.

• MagicDraw runs only on Mac OS X operating system. We recommend to use JDK 1.4.x. MagicDraw has some problems on default Mac OS X JDK (JDK1.3).

Installation procedure

First, obtain the MagicDraw installation files. You may download the latest version from the MagicDraw homepage (http://www.magicdraw.com/.) Because MagicDraw is a Java application, you will need more than the installation files to run the tool successfully. You may also install JVM together with MagicDraw or you may have it already installed. Information about the latest Java ports is available at http://www.magicdraw.com/jvm_list.htm. NOTE If an installation is for Windows, and has a JVM you don't need anything else.

W INDOWS 2000/9X /NT/XP After downloading, double-click MD_UML_100_win.exe (for the Personal Edition MD_UML_100_PE_win.exe). The Setup Wizard automatically adds MagicDraw UML shortcuts to the start menu and the desktop. You may also execute the shortcuts from the installation directory.

U NIX After downloading, open a shell and go to the directory where you downloaded the installer. At the prompt type: sh ./MD_UML_100_unix.sh (for the Personal Edition MD_UML_100_PE_unix.sh).

MAC OS X After downloading, double-click MD_UML_100_mac.dmg (for the Personal Edition MD_UML_100_PE_mac.dmg) and install application by dropping launcher to the Applications folder (or somewhere else). Requires Mac OS X 10.3 (Panther) and Java 1.4.2.

A LL OTHER PLATFORMS INSTRUCTIONS (NO INSTALL VERSION) Download MD_UML_100_no_install.zip (for the Personal Edition MD_UML_100_PE_no_install.zip). After downloading, extract the contents of the zip. These files require some modifications prior to launching them. On Windows platform:

• Launch mduml.exe in bin directory to start MagicDraw. On Unix or Mac OS X platform:

• Launch ./mduml in bin directory to start MagicDraw. Be sure you have JVM installed.

UPDATING Automatic updates feature is implemented in MagicDraw. Notification and update of all the patches can be done automatically.

To enable an automatic checking for MagicDraw updates

1 Open the Environment Options dialog box, Update pane. For a detailed description of this dialog box, see Section “Setting Personal Preferences” on page 3-22. 2 Choose a period when MagicDraw checks for updates from the Check for Updates drop-down list box: Manually, On startup, Once a day, Once a week, Once a month. It is recommended to check for updates once a month. NOTE You may also manually check for updates: go to the Help menu and choose the Check for Updates command.

A UTO-CHECK FOR UPDATES DIALOG BOX The dialog box is opened, when automatic checking for MagicDraw UML updates is enabled on the Update pane in the Environment Options dialog box and the Show Auto- Checking Confirmation Dialog Box check box is selected. Element Name Function Show this tip If selected, the dialog box is opened each time, when the next time MagicDraw should be updated according to the schedule selected on the Update pane in the Environment Options dialog box. Check Starts checking for MagicDraw UML updates in the http://www.magicdraw.com page. Cancel Closes the dialog box without saving changes. Help Displays MagicDraw Help.

STRUCTURE OF MENUS AND TOOLBARS Before starting working with MagicDraw, keep in mind how MagicDraw is organized. Not all information will be described, as nearly all commands are accessible in various ways, that are listed in the table below. Function Accessibility Main operations of • Edit menu. editing (copy, cut, • Main toolbar buttons. paste, delete) • Shortcut keys. • Shortcut menu commands from Browser. Opening of • By double-clicking the model element. Specification dialog • Specification command from the element shortcut menu on the boxes diagram or Browser. • When adding one model element to another model element from the Specification dialog box or Browser. Defining symbols • Symbol shortcut menu -> Symbol(s) Properties. properties (font, • Options menu -> Project. color, etc.) • Main toolbar buttons

NOTES Symbol shortcut menu is also accessible from Edit menu, Symbol. The toolbar of the particular diagram presents the paths and shapes available for the corresponding diagram. If an arrow is placed on the diagram toolbar button, select a button representing the corresponding model element by right- clicking the button.

SETTING PERSONAL PREFERENCES

Environment Options

You may customize MagicDraw according to your preferences: Change the application settings of your project in the Environment Options dialog box.

To open the Environment Options dialog box Choose Environment from the Options menu.

Buttons available in the Environment Options dialog box

Reset to Defaults Resets all properties to the default ones. OK Saves changes and exits the dialog box. Cancel Exits the dialog box without saving changes. Help Displays MagicDraw Help.

G ENERAL PANE

Figure 1 -- Environment options dialog box. General pane Change the appropriate fields according to your preferences. If the check box is selected, the description False changes into True. Property name Function EMF character set Choose the encoding standard for the characters that will be copied to EMF. Save diagram Saves the diagram background in the image together with the background in image saved as image diagram. By default the diagram background, after saving as image, is white. Use icons in dialogs Icons on the button of dialog boxes are shown.

Property name Function Language Choose the language you wish the MagicDraw GUI to be displayed: • Default – according to your application. It is set by default. • English • French • German • Italian • Japanese • Korean • Portuguese Brazil • Spanish • Thai NOTE Restart MagicDraw to apply the changed language. Icon size Select the size of the icons on the toolbar. The possible choices of icon sizes are 32 and 24. Show status bar Shows status bar line in the bottom of the Magic Draw window. Show memory monitor Shows the project memory usage line in the bottom of the Magic Draw window. Create backup file Back up files of your projects will be created. Backups are saved with name pattern old_name.xml.bak or old_name.xml.zip.bak. Save project recovery Saves AutoRecovery file of the opened project(s) when a system data on idle is not in use. Idle time to activate Enter the system idle time (in minutes) when to activate file recovery save recovery save. Diagrams load mode Choose how to load diagrams after opening MagicDraw project. • Load all Diagrams – opens all diagrams that are created in the project. • Load Only Opened Diagrams – opens only diagrams that were not closed in earlier usages of the project. • Do not Load Diagrams – all diagrams are closed after opening a project. Save rich XMI Saves maximum additional information to xmi file, which is not required on Magic Draw load but may be needful using other tools. Save settings on exit The changed settings within current MagicDraw session will be restored in the later sessions. Show tip of the day Shows the Tips of the Day dialog box every time you start the tool. Recent files list size Type the number of the projects to appear on the File menu. Click the file name to open it. The maximum files list size is 10. The file name list shows files that were used in MagicDraw UML. Recent windows list size Type the number of recently used windows that are listed in the Window menu. Click the window name to make it active. The maximum windows list size is 10.

Property name Function Undo list size Type the number of actions that will be available for undo/redo operations. They will be listed in undo/redo drop down lists on the main toolbar. The maximum undo/redo list size is 500. Open last project on The project you have finished the last session will be opened startup next time you start MagicDraw UML. Mark elements with Shows active hyperlink arrow on element symbol. active hyperlink Opaque Expression Possible choises: defautl language • Englich • OCL Opaque Expression Possible choises: displaying lines • 1 • 2 • 3 • 4 • 5 • All Lines Show font face in font list Font names that are listed in the Font drop-down list box on the main toolbar will be displayed in the original font. Help font Choose the font that will be used in Help window. Help server port The default Help server port is 1111. Change it, if some other server is started on this port. Use model enrichment Opens the Software Design Model Wizard or Use Case Model wizard Wizard in report generation. Show model enrichment Opens the Model Enrichment dialog box in report generation. suggestion dialog Show hyperlinks in Shows the Hyperlinks tab in the element Specification dialog specification dialog box. Specification opening Possible choises: mode • In the same window • In a new window Recent specifications list Specify list size of specifications. Possible range 1 to 20. size Specifications history size Specify history size of openend elements specifications. Possible range 1 to 20.

D IAGRAM PANE

Figure 2 -- Environment Options dialog box. Diagram pane Property name Function Allow class members Operations and attributes can be selected and dragged & selection dropped to the other class. Apply stereotype style Applies created stereotype style to symbol when adding stereotype for all symbols to element. Apply stereotype style Applies stereotype style in teamwork for unlocked diagrams. for symbols in unlocked diagrams Center on the mouse Centers zooming according to mouse arrow. location when zooming

Property name Function Display paths on When dragging and dropping an element from the Browser or element drop executing a Create Symbol action, path to existing symbols are created. Edit name with Allows to manage stereotypes by editing stereotype name directly stereotypes on the Diagram pane Graphics antialiasing Smooths the jagged edges of graphics. Grid style Select one of the following style of the grid: Dense and Sparse. Mark selected labels Mark paths labels after selecting a path. Optimize paths When a path is drawn in various directions, this selected option removes loops from the path. Show manipulation Enable error highlighting of the modeling process. This helps you highlighting to see the errors in the model at the drawing time. The valid and invalid actions will be highlighted in different colors (defaults are red for invalid actions, blue for valid actions). Text antialiasing Smooths the jagged edges of text. Use smart manipulation Easy you work of working with symbols. For the detailed description about smart manipulation feature, see Section “Smart Manipulation” on page 5-114. Zoom step size Type in the step value of zooming your diagram views. Step value should be in range from 0.1 to 1.0. Show Smart Set smart manipulators visibility. Manipulations Mouse’s Left Button Possible choises: Action Create element - target element is created during creation of path after mouse click on diagram pane. Make a break point - set a brake point for path after mouse click. Smart Manipulator fade Set smart manipulators fade time in seconds. time on mouse over Smart Manipulator Possible choises: appearance • Mouse Over • Shift Show Names in Shows element names in toolbars near icon. Toolbar Use Small Icons Change icons to smaller size, when selected. Toolbar Position Change toolbar appearance near diagram pane.Possible choises: • Right • Left

B ROWSER PANE

Figure 3 -- Environment Options dialog box. Browser pane Property name Function Browser position In the drop-down list, select the Left if you wish the browser to appear in the left side of the workspace. Select the Right if you wish the browser to appear on the right side of the workspace. Show code Shows code engineering sets items in the browser. engineering sets Show full types in Shows the full attributes, operations, and relationships data. browser Sort always Always alphabetically sort browser items. Show stereotypes in Shows stereotypes that are assigned to the model elements. browser Show changes in Highlight edited or added model elements and diagrams in the browser Browser. Show hyperlinks in Shows hyperlinks that are assigned to the model elements. browser Group by diagram Groups diagrams according to diagram type in the Diagrams type tree. Group by profiles Groups stereotypes, tagged values and constraints by profiles in the in the Model Extensions Tree.

Property name Function Group by Groups stereotypes by Metaclass in the Model Extensions Tree. Metaclasses Show diagram zoom Shows zoom slider in the Zoom Control tab. slider

T EAMWORK PANE

Figure 4 -- Environment Options dialog box. Teamwork pane Property name Function Auto login to The user automatically logs on to the Teamwork Server after server starting MagicDraw. Teamwork server Shows the name of your teamwork server. name Show commit The warning appears while committing project to the Teamwork warning Server. Show modules The warning appears when two modules (or module and a project) versions conflict use the same submodules. warning

F LOATING PANE This pane is available only if you use MagicDraw Floating License.

Figure 5 -- Environment Options dialog box. Floating pane Property name Function Floating license Specify the name of the Floating License Server. server name Floating license Enter the port number of the Floating License Server. The server may server port be started on many different ports. Auto login to If selected, automatically logs in to the Floating License Server when floating license starting MagicDraw. server

CVS PANE

Figure 6 -- Environment Options dialog box. CVS pane Property name Function Add project to Every time adds a newly created project in the checked out directory CVS after saving to CVS. The Add Project to CVS dialog box appears. Commit project to Updates the project that is added to CVS while loading. The Update CVS after saving CVS Project dialog box appears. Update project Commits project to CVS after saving it. The Commit Project to CVS from CVS before dialog box appears. loading Location of The path where the .cvspass is located. You may type it or choose .cvspass the path from the Open dialog box. Local folder The path where the module will be saved on checkout action. You may type it or choose the path from the Open dialog box.

U PDATE PANE

Figure 7 -- Environment Options dialog box. Update pane Property name Function Check for Updates Choose the period for checking MagicDraw updates. • Manually • On startup • Once a day • Once a week • Once a month (recommended) Show auto-checking If selected, shows the confirmation dialog each time before auto- confirmation dialog checking. box

HTTP PROXY PANE

Figure 8 -- Environment Options dialog box. HTTP Proxy pane Property name Function Use HTTP proxy If selected, uses the Http Proxy Server when MagicDraw is server checking for updates. HTTP proxy server Type the Http Proxy Server name or IP address. address HTTP proxy server Type the port of the HTTP Proxy Server. The default number is port 8080. HTTP proxy server Type the name of the Http Proxy Server user. user Authenticate HTTP Authenticates Http Proxy Server. proxy server

K EYBOARD PANE

Figure 9 -- Environment Options dialog box. Keyboard pane Property name Function Category The list of all available categories of the keys (File, Edit, Tools, etc.). The default item in this choice is always All Categories. Selecting the category opens its context in the Commands list. Commands The list of commands from the selected category. If All Categories is selected in the Categories list, all commands of an application are shown in this list. Commands are alphabetically sorted. The selecting of the command shows already assigned shortcut keys in the Current keys list. Current keys The list of keys assigned to the selected command. Press new The field for entering the new key. Puts a human representation of any key shortcut key pressed in the field. If the pressed key is already assigned to other command, the Currently Assigned To label with this command name appears. Currently Shows the name of the command of the entered new key if this key is assigned to already assigned to some command. By default is hidden. This label is visible just if entered key is already assigned to some command. Assign Assigns the entered key to the selected command. The entered key is added to the Current Keys list. Remove Removes the selected keys from the selected command. Remove All Removes all keys from the selected command.

P LUGINS PANE

Figure 10 -- Environment Options dialog box. Plugins pane Property name Function Name The name of the plugin. Provider The name of the company which provides a plugin. Version Version number of the selected plugin. Loaded Indicates if the plugin is correctly loaded. Enabled Shows the status of the plugin. If True, the selected plugin is activated in MagicDraw. Disable/Enable Disables or enables the selected plugin.

R ESOURCES PANE Displays the external resources such as dtd, xsd, etc. that are used in MagicDraw.

Figure 11 -- Environment Options dialog box. Resources pane Property name Function Configure External Resources. Define external resources that will be used in XML parsing. Location The location of the external resource. URI The URI of the external resource. Edit Edit the location and the URI of the resource in the External Resource dialog box. Add Add a new external resource Remove Remove the selected resource form the list. Configure Ignored Resources URI The URI of the external resource that will not ignored in MagicDraw. Edit Edit the URI of the ignored external resource in the External Resource dialog box. Add Add a new external resource that will be ignored. Remove Remove the selected ignored resource from the list.

P ATH VARIABLES PANE

L AUNCHER PANE

Figure 12 -- Environment Options dialog box. Launcher pane Property name Function Default Launcher The Launcher Properties dialog box appears. Default Browser The Launcher Properties dialog box appears. Defined Launchers Edit Opens the Launcher Properties dialog box for editing launcher information. Add Adds launcher in the Launcher Properties dialog box. Remove Removes launcher from the list. Reset to Defaults Resets all properties to the default ones. OK Saves changes and exits the dialog box. Cancel Exits the dialog box without saving changes. Help Displays MagicDraw Help.

Look and Feel: Controlling Interface

The appearance of MagicDraw UML windows, dialog boxes, menus, and everything inside them can be changed.

To make changes to the interface: From the Options menu, choose Look and Feel and then choose the style you wish.

Figure 13 -- Look and Feel Themes submenu Theme Description Metal Standard Java Swing library CDE/Motif Similar to GUI that is used on UNIX operating systems Windows Microsoft Windows 95, Windows NT 4.0, Windows 2000 interface Kunststoff Is an extension of the Java Metal Look and Feel. MagicDraw will have a more modern and smoother look. The chosen style will not look exactly like the applications in those operating systems because every style of graphical interface is implemented within a Swing library, but it will look quite similar. Depending on which operating system you use, some choices might be unavailable to you. For example, Windows9x/NT users may not switch to the Mac interface style. Look and Feel Themes – themes listed in Look and Feel Themes subcommands are valid only for the metal style. Choose from any of the following themes:

• Aqua

• Contrast

• Big Contrast

• Green

• MagicDraw

• Big MagicDraw

• Khaki

• Kunststoff Theme

• Custom – set your own options in the Properties dialog box.

JIDE AND MULTIPLE WINDOWS INTERFACE STYLES Beginning with MagicDraw version 7.5, modern JIDE library is implemented. Using the JIDE interface style, it is possible to work with Browser window in more flexible way, use documentation, zoom, and message windows as dockable and place above the main window. Now you may arrange the Browser window in your desired combination, hide the desired Browser windows Also you may use Multiple Windows style. It allows you to manage all windows independently, as if they belong to different applications. For instance, you may overlap the tool’s windows across each other, resize them independently and so on. There is no main window where all other windows are placed.

To set interface style From the Options menu, choose Interface Style, and then choose one of the desired interface styles: Multiple Windows, or JIDE.

The term “project” is used to describe the problem that must be solved, including all the possible solutions for how the problem can be resolved and finally developed. All works in MagicDrawTM UML are organized into projects. Project is a top one entity where all model- related data (the set of diagrams) is held. Project data is organized by object orientation, which makes its management intuitive and in accordance with the problem that is being solved. In this Section, you will find the following chapters: 1 "Creating New Project ", on page 42 2 "Saving and Exporting", on page 44 3 "Loading", on page 48 4 "Project Options. Style Engine", on page 49 5 "Reusing project parts in modules", on page 61 6 "Profiles", on page 72 7 "Model Differencing", on page 74 8 "Working with multiple projects", on page 80 9 "Using Browser", on page 82 10"Searching", on page 95 11"Resource Manager", on page 101 12"MagicDraw RConverter", on page 103

CREATING NEW PROJECT All project information is stored in a single file. A project name matches the file name where the project is saved. The newly created project consists of the following packages:

• Data package is empty and holds all model elements.

• Component View package contains components that are created during the code engineering and represent source files. Adding a resident element to a particular component causes that element to be generated within the source file.

• MagicDraw Profile contains tagged values and stereotypes that are necessary for working with various parts of MagicDraw.

• UML Standard Profile contains primitive data types, constraints, tagged values, and stereotypes, which are UML standard and can be used in various cases. The following data types are specified in Magic Draw: boolean, byte, char, double, float, int, integer, long, short, and void.

You may also create your own packages for holding the model elements, but, by default, packages may not be deleted or renamed in a project (except for the Component View package). To start a new project, you must create a new workspace for it.

To create a new workspace for a project

• From the File menu, choose New Project.

• On the main toolbar, click the New Project button.

• Press shortcut key CTRL+N. In all cases, you receive a new project named UntitledN, and it is selected as an active project.

Creating new project from already created template

C++, CIL, Java, C#, DDL, EJB, WSDL, XML Schema, MOF, RUP extensions, CORBA IDL, and UMLWebExtension templates are available in the New From Template dialog box. The New From Template command is used for creating a new project from the selected template file.

To open the New From Template dialog box From the File menu, choose New From Template.

Figure 1 -- New From Template dialog box The newly created project from template will contain specific model elements and stereotypes. TIP! All MagicDraw templates are located in the /templates folder so you may import the desired template in your already created project using Import command from the File menu.

Importing project

To import an already created project to an opened project

1 From the File menu, choose Import. 2 The Import dialog box appears. Choose the project you want to import and click OK. The diagrams of the imported project are placed in the opened one.

SAVING AND EXPORTING IMPORTANT!Beginning with MagicDraw version 3.6, the native MagicDraw format is .xml. Saving in .mdf format is not allowed.

To save changes for the later sessions, revised projects must be saved. While saving, you may edit the changeable name of the project and the file format.

To save the project

1 From the File menu, choose the Save Project or Save Project As command, or click the Save button on the main toolbar, or press shortcut keys CTRL+S. The Save dialog box appears. 2 Select the destination directory (where you wish to save the project) and type the file name for it. 3 Choose the format for saving a project: Packed XML (*xml.zip) (default) or Extensible Markup Language (*.xml) 4 Choose the version of XMI - 1.0, 1.1, or 1.2. Also if you want to save maximum additional information to xmi file, which is not required on Magic Draw load but may be useful using other tools, select Rich XMI button.

Figure 2 -- Save dialog box NOTE If the Create Backup File check box is selected in the Environment Options dialog box, MagicDraw always creates a backup file that has the previously saved project. The backup is held in a file with a name identical to that of the project. For a detailed description of the Environment Options dialog box, see Section “Setting Personal Preferences” on page 3-22.

Exporting project as template

You may save (export) the created project as a template and use the same project for creating other new projects.

To export project as template

1 Open a project you want to export as a template. From the File menu, choose Export, and then Template. 2 The Export Template dialog box appears. 3 Type the name and a description of a template. 4 Click OK.

Figure 3 -- Export Template dialog box Box Function Template Name Type a template name. Description Type information about the template. OK Exports the template and the description to the Templates folder. Cancel Closes the dialog box without exporting the template. Help Displays MagicDraw Help

Saving diagram as image

Diagrams that were created in the model can be saved as image in the following formats:

• Enhanced Metafile Format (*.emf) - supports language specific symbols.

• Encapsulated PostScript (*.eps)

• Joint Photographic Experts Group (*.jpg, *.jpeg)

• Portable Network Graphics (*.png)

• Scalable Vector Graphics (*.svg)

• Windows Metafile Format (*.wmf)

To save the current diagram, or the selected element, within the diagram as an image

1 From the File menu, choose Save As Image. The Save As Image dialog box appears. 2 Select the Active Diagram or the Selected Symbols option button. 3 Select the file format (*.svg, *.eps, *.dxf, *.wmf, *.png, *.jpg, *.emf), file name, and the location directory.

To save the selected diagrams of your project as images

1 Choose the Save Selected Diagrams As Images command from the File menu. The Save As Image dialog box appears. 2 Choose diagrams you want to save as image from the Not Empty Diagrams list. 3 In the Working Directory field, type in the name of the destination directory, or click the ‘...’ button to, browse the directory list. 4 Select the graphical file format in the File Format drop down list (JPG, PNG, WMF, EPS, EMF, or SVG) and click Save.

Figure 4 -- Save As Image dialog box The filename of the saved diagram will be the same as the name of that diagram.

The Not Empty Diagrams list contains all exportable diagrams that contain UML elements. Empty diagrams are not displayed, select the diagrams you wish to export:

To make multiple selections Press the CTRL key and click the diagrams you wish to export.

To select or unselect all diagrams Click the Select All button (press CTRL+A keys) or Unselect All button.

To display in the list all diagrams that are available in the project Click the Load All Diagrams button in the Save As Image dialog box.

Autosave

After you stop working with MD, an idle time passes and the current project is saved to a special file - AutoRecovery file. If application is terminated normally, AutoRecovery file is removed. If application crashes, AutoRecovery file is left. On startup, MagicDraw checks for AutoRecovery file, if it exists, suggests to load a project from this file.

To save AutoRecovery file of the opened project(s) when a system is not in use.

1 Open the Environment Options dialog box. 2 In the General pane, select the Save Project Recovery Data on Idle check box. Also enter the system idle time (in minutes) when to activate file recovery save in the Idle Time to Activate Recovery Save text box.

LOADING IMPORTANT! Beginning with MagicDraw Version 3.6, the native MagicDraw format is .xml. Saved projects can be loaded back to MagicDraw.

To edit or review already created projects

1 From the File menu, choose Open Project, or click the Open Project button on the main toolbar. 2 In the Open dialog box, choose the project you wish to open and click Open. TIP: Drag and drop the project you wish to open directly from the open window to the MagicDraw. The project is started at once. NOTES:

If the Open Last Project on Startup check box in the Environment Options dialog box is selected, the last project you worked with will be opened right after MagicDraw starts. XMI v2.1 is native MagicDraw file format for model storage. But this formats do not specify how to store diagrams. So if you use MagicDraw to open the XMI file, exported with another tool, only the model will be loaded (diagrams, views not). MagicDraw can not "import" such XMI, it can only open it. For model interchange you should use the RConverter. More about it, see See “MagicDraw RConverter” on page 103. You may load more than one project within the same MagicDraw session. Separate workspace will be created for each project that is opened.

PROJECT OPTIONS. STYLE ENGINE Style engine is a part of the MagicDraw UML system that defines diagrams, shapes, paths, and stereotypes properties. There may be few properties styles defined but all symbols are created according to the style that is selected as default. There is possibility to apply different presentation styles for diagram/shape/path/stereotype depending on diagram type.

Project Options

The Project Options dialog box is used for defining properties for model elements (shapes and paths) and diagrams, for creating your own project style, importing or exporting the created project style, and defining code engineering options.

To change the default project options and Code Engineering tasks From the Options main menu, choose Project. The Project Options dialog box appears.

Figure 5 -- Project Options dialog box The Project Options dialog box has several collections of customizable options: General Project Define the default packages where the extension elements Options will be stored. Also if desired you may choose the package every time when creating a new extension element, the dialog box asking about the storage place will appear. In the Modules Path text box, enter the path where by default modules will be stored. Diagram Info Customize what and how information will be displayed in the Diagram Info table. Symbols Properties Expands tree hierarchy of all the styles defined within the Styles project. You may create as many of these styles as you like. NOTE To apply the changed project option to the opened project, click the Apply button. Code Engineering Define general code engineering options as well as options specific to languages. The description about this part, see Code Engineering user’s guide. To find elements to change, browse the options tree in the Project Options dialog box. The items in this hierarchy are either:

• Compressed - a plus sign next to an icon indicates that the icon is compressed, and contains other model elements. This is the default setting when you start

your application. Click the plus sign to expand the icon and view its subordinate items.

• 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 sign next to an icon, it does not contain other model elements. The following buttons are available in the Project Options dialog box: Button name Function Clone Clone (duplicate) the selected style. Rename Change the name of all existing style. Type a new name for a style in the Enter Style Name dialog box. Delete Remove the selected style. Make Default Make the selected style as your default style for the newly created projects. Apply Apply the selected style to the opened project. Import The Open dialog box appears. Select the style you wish to import (*.stl). Export The Save dialog box appears. Select the directory where you wish to export a style. Reset to Defaults Changes all settings to the default configuration.

To create a new style by cloning the existing one

1 Select the default style in the Styles list box and click the Clone button. 2 Type the name for the new style in the Enter Style Name dialog box. 3 Change options of the new style.

To change the name of the selected style

1 Select a style you want to rename and click the Rename button. 2 Type a new name for the style in the Enter Style Name dialog box.

To remove the selected style Click the Delete button in the Project Options dialog box.

To make a selected style your default style for newly created projects Click the Make Default button in the Project Options dialog box.

To apply the selected style or changed option to a current project

• Click the Apply button in the Project Options dialog box, Styles pane. NOTE: You may also apply the desired options to the selected diagrams model elements. Click the Apply button in the specific elements pane.

To import an already created (and exported) project style Click the Import button. The Open dialog box appears. Select the style you wish to import (*.stl).

To save the created style (export) for a later usage or for other users Click the Export button. The Save dialog box appears. Select the directory where you wish to export a style.

S YMBOLS PROPERTIES STYLES TREE Expands the tree hierarchy of all the styles defined within the project. You may use as many of these styles as you wish. Shape and Paths trees have the inner structure to help you find the model element, the representation of which must be changed. The right side of the dialog box contains possible choices and instruments to manage them.

Figure 6 -- Project Options dialog box. Styles In the following table you may find all possible options that can be set for the symbols: Property Function (when selected) Fill Color The fill color of the symbol. The Color dialog box appears. Use Fill Color Uses the fill color and symbols are colored on the diagram. Pen Color The pen color that is used to draw elements. The Color dialog box appears. Text Color The color that is used for text coloring. The Color dialog box appears. Font Font that is used for a name and other displayed properties of the model element. The Font dialog box appears. Autosize Adjusts the size of a symbol to the contained information. Element borders are changed so that it uses minimum space. Use Fixed Connection Points The end of the path is connected to the fixed point of the shape. Path Style The drawing style of a path. Possible choices: Rectilinear, Oblique, or Bezier. Attribute Color The color of the attribute name. The Color dialog box appears. Attribute Font Font that is used for a name of the attribute. The Font dialog box appears. Attributes Sort Mode The mode for sorting attributes. Possible choices: No Sorting, By Name, By Stereotype, or By Visibility. Constraint Text Mode Displays constraint’s name or expression on a symbol. Direction The direction of a signal. Possible choices: Right or Left. Header Position The package name position on the symbol. Possible choices: Top or In Tab. Header in Bold Shows the name of the symbol as bolded. HTML Text Activates HTML editor for the text of a note and a text box. Line Style A line style for a horizontal separator. Possible choices: Dashed or Solid. Operation Color The color of the operation name. The Color dialog box appears. Operation Font Font that is used for a name of the operation. The Font dialog box appears. Operations Sort Mode The mode for sorting operations. Possible choices: No Sorting, By Name, By Stereotype, or By Visibility. Orientation Primarily the sychronization bar diagram button is set to vertical or horizontal position. Show Attributes Constraints Shows constraints of attributes. Show Attributes Properties Shows tagged values of an attribute. Show Attributes Stereotypes Shows stereotypes of attributes.

Property Function (when selected) Show Attributes Visibility Shows attribute visibility signs (+, -, #,~). Show Base Classes Shows a base class on stereotype symbol. Show Classifier Shows a classifier name near a model element name. Show Direction Arrow Shows the direction arrow on the association. The association must be set as Navigable. Show Elements List Shows model elements that are assigned to a model, package or subsystem as a list. Show Entire Activation Shows entire activation bar on active classifier role in sequence diagram. Show Full Classifier Type Shows all attributes that are defined within a class or assigned classifier. Show Initial Attribute Value Shows initial attribute value on a class or artifact. Show Message Numbers Shows the messages numbers on a diagram. Show More Sign for Attributes Shows additional information sign “…” in the class, artifact attributes list, when omissions are made by editing class compartment. Show More Sign for Shows additional information sign “…” in the class, artifact or Operations numeration operations list, when omissions are made by editing class, artifact or enumeration compartment. Show Multiplicity Shows multiplicity value. Show Name Shows the name of a relationship, role and message/stimulus Show Operations Constraints Shows constraints of operations. Show Operations Signature Shows all of the operation arguments and the return type. Show Operations Stereotypes Shows stereotypes of operations. Show Operation Parameters Shows the direction kind for operations parameters Direction Kind

Show Operations Properties Shows tagged values and concurrency of an operation.

Show Operations Visibility Shows operation visibility signs (+, -, ~ #). Show Owner Shows the name of the owner model element (in parenthesis beneath the corresponding model element name.) Show Predecessors Shows predecessors on message. Show Visibility Shows role visibility signs (+, -, #).

Property Function (when selected) Stereotype Color The color that will be used to draw stereotypes. The Color dialog box appears.

Stereotype Font The font that will be used to draw stereotypes. The Font dialog box appears.

Show Stereotypes Shows stereotype labels on symbols.

Show Constraints Shows constraints on symbols. Show Tagged Values Shows tagged values on symbols. Suppress Actions Hides actions associated with the state. Suppress Attributes Hides attributes list. Suppress Content Displays only an icon of an assigned element or stereotype. NOTE Only when a model element contains an icon or a stereotype with an icon, the Suppress Content command is activated on the element shortcut menu. Suppress Extension Points Hides use-case extensions on a use case. Extension Point Color The color of the extension point name. The Color dialog box appears. Extension Point Font Font that is used for a name of the extension point. The Font dialog box appears. Suppress Enumeration Literals Hides enumeration literals on a enumeration. Enumeration Literal Color The color of the enumeration literal name. The Color dialog box appears. Enumeration Literal Font Font that is used for a name of the enumeration literal. The Font dialog box appears. Suppress Operations Hides operations compartment section. Suppress Realization Elements Hides realization elements of a subsystem. Suppress Specification Hides specification elements of a subsystem. Elements Text Position Changes the text position of a separator. Possible choices: Center, Left, or Right. Wrap Words Wraps printed text at the edge of text container. Background Color The color of the diagram background. Click the ‘...’ button to open the Color dialog box, select the background color. Snap Paths to Grid Snaps paths to grid. Snap Shapes to Grid Snaps shapes to grid. Grid Size Grid size settings from 2 to 30. Show Grid Shows a grid on the diagrams. Show Diagram Info Shows diagram information table on diagram pane.

Working with Properties Styles

All symbols in MagicDraw UML are created according to active properties style. There may be more than one properties style in the same project, and the whole style may be applied for the project. Every style has its own presentation of Diagram, Shape, Path, and Stereotype that you may modify using the Project Options dialog box in the Symbols Properties Styles branch. You may set your own options for every model element to the current style. Paths, Shapes, and Stereotypes branches have the inner structure that helps you find the model element, the representation of which must be changed. The section on the right side of the dialog box contains possible choices and instruments to manage them. The following properties are defined for the formatting symbols:

• Shapes. Set general options for the shapes in the right pane of the Project Options dialog box. You may set such options for all shapes that appear on the Diagram pane.

• Paths. Set general options for the paths in the right pane of the Project Options dialog box. You may set options for all paths that appear on the Diagram pane.

• Diagram. Set general options about a diagram.

• Stereotypes. Set general options for the stereotypes in the right pane of the Project Options dialog box. You may set options for all stereotypes that may be applied to elements on the Diagram pane.

P ROPERTIES EXTENSION BY DIAGRAM Diagrams, shapes, paths, and stereotypes properties may be extended by particular diagram type. It means that presentation style options will be applied only for the specified element symbol in the specific diagram.

To extend element properties by diagram

1 In the Project Options dialog box, the Symbols Properties Styles tree, expand a branch, select the specific element (shape, path, diagram, or stereotype) and right click the mouse button. The list of diagrams in which element symbol may be created, appears.

Figure 7 -- Element extension by diagram

2 Select the diagram type. Diagram is added as additional branch to the section.

Figure 8 -- Extended diagram addition 3 Set the style properties for the element in the right pane of the Project Options dialog box. Properties will be applied only in the specified type of diagram. • Element may be extended by diagram in the Project Options dialog box, specific elements pane, clicking the Extend by Diagram button. The Extend by Diagram dialog box appears. Click the Add Diagram button and select a diagram from the list.

Figure 9 -- Extend by Diagram dialog box

To remove extended diagram from the tree

• Select extended diagram and on the right click mouse button, choose Remove.

Figure 10 -- Remove extended diagram • In the Project Options dialog box, extended diagram style properties pane, click the Remove button.

P ROPERTIES INHERITANCE All element properties have “inherited” check box. This check box indicates if property is derived from the base element properties, or is it specific.

The Inherited column check box value in the elements properties pane specifies if current property is synchronized with its parent property. When the Inherited value is “true”, elements property is changed after changing the parent property. If property has no correspondent property in upper (parent) level, the Inherited column check box is cleared and disabled. If property is modified for the specific element and value differs from the upper level current property value, the Inherited column check box is cleared automatically.

G ENERAL STYLE PROPERTIES You may define the common properties for the whole style. The style properties are displayed when properties style is selected in the Project Options dialog box styles tree.

S HAPES, PATHS AND DIAGRAMS PROPERTIES All shapes, paths and diagrams that may be created in the project, are listed in the Project Options dialog box. If the Shapes, Paths or Diagrams branches are selected in the tree, the general properties may be set in the right pane of this dialog box. When expanding any of these branches, the style for concrete element (diagram) may be created.

To apply a new style for the already created element symbol

1 In the Project Options dialog box, change element style properties and click the Apply button. The Select Diagrams dialog box appears. The list of diagrams, which were created in the project, is displayed.

Figure 11 -- Select Diagrams dialog box

2 Select diagrams in which element properties will be applied and click OK. The Select Properties to Apply dialog box appears.

Figure 12 -- Select Properties to Apply dialog box 3 Choose which properties will be applied to element symbol from the All to Selected list. Click OK. NOTE! If a new style was set, it will be applied for all newly created elements after drawing them on diagram pane. You may always set the default symbols style to element by clicking the Apply Default Symbol Style button in the main toolbar.

S TEREOTYPES PROPERTIES Stereotypes properties may be applied only if stereotype properties style is created in the Project Options dialog box. Stereotype properties are derived from their base class. Stereotype base class is defined in the label of the right pane of the Project Options dialog box. The same element may have several stereotypes assigned. In this case, style of the first stereotype will be applied to the element symbol. If stereotype is removed from the element, the next (first) stereotype properties are applied. If the last stereotype is removed from the element, the base class (shape or path) properties are applied to the element symbol. Stereotypes may be extended by diagram. All stereotypes that have defined symbol properties are included into the Stereotypes branch. By default only boundary, control, and entity stereotypes are added to the tree when expanding the Stereotypes branch and default style is created for these stereotypes.

To add stereotype to the branch

1 In the Project Options dialog box, the Symbols Properties Styles tree right-click the Stereotypes branch. The list of stereotypes appears.

Figure 13 -- List of stereotypes 2 Select the check box near the stereotype and click the Apply button. Stereotype will be included into the Stereotypes branch. Set the stereotype style properties in the right pane of the Project Options dialog box.

To remove stereotype from the branch

1 In the Project Options dialog box, the Symbols Properties Styles tree select the Stereotypes branch. The list of stereotypes appears. 2 Clear the check box near the stereotype and click Apply. Stereotype is removed from the branch.

To change stereotype properties

1 Expand the Stereotypes branch and select a stereotype. 2 Set properties in the right pane of the Project Options dialog box.

To apply stereotype properties for already created symbol with assigned stereotype

1 When stereotype style properties in the right pane of the Project Options dialog box are changed, click the Apply button. The Select Diagrams dialog box appears. 2 Select diagrams in which stereotype properties will be applied and click OK. 3 In the Select Properties to Apply dialog box, choose which properties will be applied to stereotype. Click OK. NOTE! You may apply stereotype properties to symbol after changing style properties and in the Project Options dialog box clicking OK. Style will be applied when selecting symbol on the diagram pane and from the main toolbar clicking the Apply Default Symbol Style button.

To apply stereotype properties when assigning stereotype to element NOTE! In the Environment Options dialog box, Diagrams tab, the Apply Stereotype Style for All Symbols check box should be selected and in the Project Options dialog box, the style properties should be changed for stereotype. 1 In the created diagram, draw an element. 2 From the element shortcut menu, choose Stereotype. The list of available stereotypes appears. 3 Select the check box near the stereotype you want to assign to element. Click Apply. Stereotype properties are applied automatically when assigning stereotype to element.

REUSING PROJECT PARTS IN MODULES With Magic Draw's Partitioning feature, you can segment your MagicDraw project into multiple independent parts called modules. Because these modules are saved using the same file format as regular MagicDraw projects, they can be opened and edited in any MagicDraw client application. This approach allows easy reuse of the same basic model libraries in multiple projects.

Working with Modules

E XPORTING PROJECT MODULE Using the Export/Profile Module dialog box, you can save the content of a selected package as a separate module. Once exported, the package and its containing elements are read-only, and the module name is displayed in the brackets next to the package name in the Browser tree.

To export any module using the File menu

1 From the File main menu, choose Export, and then choose Profile/Module. The Export Profile/Module dialog box opens.

Figure 14 -- The Select Package dialog box for module exportation 2 In the All Data list, select the package you want to save as a separate module. Click Add. The package is added to the Selected Objects list. 3 If desired, type a description of the module in the Profile/Module Description window. This description is displayed in the package's documentation. 4 Click OK. The Save dialog box opens. 5 Select the destination directory where you wish to save the project module. Type the file name, choose the format for saving, and click OK.

To export the selected module using the package shortcut menu

1 In the Browser tree, select the package you want to save as a separate module (you can also select multiple packages). 2 From the package shortcut menu, choose Modules, and then choose Export Module. The Export Profile/Module dialog box opens. 3 In the All Data list, select the package you want to save as a separate module. Click Add. The package is added to the Selected Objects list.

4 If desired, type the description of the module in the Profile/Module Description window. This description is displayed in the package's documentation. 5 Click OK. The Save dialog box opens. 6 Select the destination directory, where you wish to save the project module. Type the file name, choose the format for saving and click OK. NOTE: Only packages can be exported as modules. To export the created diagram, you must move it to a package containing elements to export.

U SING PROJECT MODULE S The Use Profile/Module action opens tthe module, making it available for use in the project. The module is loaded as read-only. Though you can use this module in your project for editing purposes, you must either import it or open it as a separate project.

To use a module in your project

1 From the File main menu, choose Use Profiles/Modules. 2 In the Use Profile/Module dialog box, select the module you want to use in your project and click OK.

I MPORTING PROJECT MODULE S After the module is opened for use, or once it has been exported, its format changes to read-only. Importing a module makes a package and its entire inner elements editable. Once imported, the module model is merged with the project model.

To make a module editable In the Browser tree, from the module shortcut menu, choose Modules and then Import. NOTE: You can also change a module's content and make its inner elements editable by selecting Open Module As Project (from the module shortcut menu, Modules submenu). The module opens as a separate project.

S HARING PACKAGES MagicDraw version 8.0 addressed limitations on editing modules by introducing the concept of "shared packages." When a module is opened as a project, it is treated as a regular MagicDraw project and includes only shared packages. Packages can be shared only if they are not dependent on other models (this same principle operates when exporting modules). If a project contains shared packages, dependencies should be checked on every saving operation. Every project containing "shared packages" can be used in other projects as a module. When you open such a package as a module, only shared packages are loaded - in read- only format - from this project file. Non-shared packages, along with all project-related information, remain unloaded. If the project doesn't contain shared packages, it can't be used as a module.

To share a package

1 Create your package, then select it in the Browser. From the model element shortcut menu, choose Modules, and then choose Shared Packages. The Shared Packages dialog box opens.

2 The package you want to share is now highlighted in the Selected Objects tree. Click OK. If your package contains no dependencies with unshared packages, it is shared. Once the package is shared, the word [shared] appears beside the package name in the Browser.

To share multiple packages simultaneously

1 In the browser, select the packages you want to share. Then, from the model element shortcut menu, choose Modules, and then choose Shared Packages. The Shared Packages dialog box opens. The packages you selected to share are highlighted in the Selected Objects tree. 2 In the Shared Packages dialog box, you may add packages you want to share. To do this, in the All Data tree, select the packages you want share and click Add. Then click OK. TIP Along with packages, you can also share models and profiles.

To unshare a currently shared package

1 Select the shared package in the Browser. Using the shared package shortcut menu, choose Modules, and then choose Shared Packages. The Shared Packages dialog box opens. 2 Shared packages are listed in the Selected Objects tree. Select the package or packages you want to unshare and click Remove. To unshare all shared packages displayed in the tree, click Remove All.

Restrictions on shared packages usage Certain actions are not allowed with shared packages:

• Because a shared package is itself a module, shared packages cannot include modules. For example, draw the parent package p1 and inside it, include package p2. In the Selected Objects list of the Shared Packages dialog box, add the p1 package. In the All Data tree, select the p2 package. The following message appears: "p2 parent package p1 is already selected." If you move the shared package p1 to the shared package p2, the word [shared] is removed from the p2 package. This occurs because the parent package is shared. Once you remove the p2 package from the p1 package, [shared] will reappear beside the p2 package name.

• ·Similarly, you cannot export a package containing an inner shared package.

O PENING YOUR MODULE AS A PROJECT Beginning with MagicDraw version 8.0, once you open a module as a separate project, all available packages are enabled for editing, with the corresponding module package marked as shared. When loading your module as a project, you can separate an existing module into submodules, make changes to the containing elements, and add new ones.

To open your module as a project In the Browser tree, choose Modules from the exported module shortcut menu, and then choose Open Module As Project.

R ELOADING YOUR MODULE The best way to access the latest changes to your module is to reload it. All modifications made in the other project for this module and then exported as modules with the same name are reloaded in the current project.

To reload the module In the Browser tree, from the exported module shortcut menu, choose Modules, and then choose Reload Module. NOTE: If you open your module as a project, be sure to save any changes you have made (by using the Save command). All modifications appear after reloading the

module in the other opened project, which includes your module as a component).

Dependencies Between Elements

A package can be exported into an independent module only if it does not depend on external elements (except other modules). Cyclic dependencies between several modules are not allowed. There are three types of dependencies:

• Dependencies by relationships

• Dependencies by reference

• Diagrams dependencies

P ACKAGES DEPENDENCIES BY RELATIONSHIPS

The module depends on external elements If a module element has a relationship with an external element and this relationship is contained in the module package, an error message appears when exporting the module.

Figure 15 -- Example of module dependency on external element Such dependencies on external elements are displayed in the Browser tree:

Figure 16 -- Package has dependency on external element

In this situation, MagicDraw can suggest moving the relationship into the parent package of this external element. For example, in this example package1 is a parent of class B, so the relationship can be moved from module into package1:

Figure 17 -- Resolved package dependency on external element This movement can be achieved by clicking Solve in the Package Dependencies dialog box. For a detailed description of this dialog box, see Section “Package Dependencies Dialog Box” on page 4-70.

Figure 18 -- Error in the Package Dependencies dialog box You can also drag-and-drop the relationship from one package to another in the Browser tree.

The module depends on an external element, but can be exported (with warning) Though the module's element has a relationship with an external element, this relationship is contained in an external package:

Figure 19 -- Example of “legal” module dependency on external element

In this case, the dependency on external elements is displayed in the Browser tree:

Figure 20 -- “Legal” module dependency on external element in data model browser The package can be exported as a module because the relationship is contained in an external package. You will be warned about such dependencies, because they have some logical meaning:

Figure 21 -- Warning in the Package Dependencies dialog box If you want to skip this dependency, click Export. When you open the module as a separate project, this relationship is absent.

The module does not depend on an external element If the module element's relationship with an external element is irrelevant in the context of UML (for instance, the external model uses the module, but not vice versa) and this

relationship is contained in an external model, the package can be exported into an independent module without warnings:

Figure 22 -- Example of relationship when module does not depend on external element

D EPENDENCIES BY REFERENCE The module depends on external elements, when model elements from the module’s packages have references to external elements.

Figure 23 -- Example of dependency by reference In this case, the module package cannot be exported into an independent module.

D IAGRAMS DEPENDENCIES The diagram depends on all model elements displayed within it. If the diagram is contained in a module package and depends on external elements, this package cannot be exported into a module.

Figure 24 -- Example of the relationship when diagram depends on external element For more information about the package dependencies on external elements, see the Section “The module depends on external elements” on page 4-66.

In this case, if the diagram is not important for the module, it can be moved from the module package into any external package by dragging and dropping it within the Browser tree:

Figure 25 -- Diagram is moved from the module package to the package1 package. The module package can now be exported into an independent module.

Package Dependencies Dialog Box

The Package Dependencies dialog box opens when the package cannot be exported to the project module, because dependencies with external model elements have been found (see more detailed information about the types of package dependencies in the Section “Packages dependencies by relationships” on page 4-66.

To open the Package Dependencies dialog box In the Browser tree, select the package containing a dependency with an external model element. From the shortcut menu, choose Modules, and then Export Module.

Figure 26 -- The Package Dependencies dialog box

Box name Function Status Status of the problem. It can be Error or Warning. Module Element The name of the model element. Element Type The type of element. Dependency Type The type of dependency. Depends On Model element on which the package element is dependent. Solve Solves Error dependencies. Available, when error status dependency is selected in the table and a solution for the problem can be found. The message detailing how the dependency can be solved displays. Dependency status in the dependencies table is changed from Error to Warning. Select in Containment Tree Select the element in the Browser, which is already selected in the dependent elements table. Refresh Perform module dependency checking and refreshes the module dependencies table. Export Export a package as a separate module. Available, when all module dependencies have a Warning status or no problematic dependencies exist. Cancel Exit the dialog box without saving changes. Help Display MagicDraw Help. Every MagicDraw UML project module (package or diagram), or group of modules, can be saved into a separate xml file: from the File menu, choose Export, then Profile/Module. You can save a reusable model part as a module xml file. The module file is a simple MagicDraw project file and therefore can be opened as a separate project. The module xml file can later be imported into other MagicDraw projects: from the File menu, choose Import. All elements from the module xml file are copied into the target project. There is no linkage between these two projects (files) after import; both can be used separately. NOTE: We advise against using modules for splitting a project into parts and developing these parts simultaneously. After splitting, you will need to merge all project parts into one project. Only model elements are merged on import. If you export the same diagram into separate files, it will be duplicated after importing it back. Therefore, when merging model elements, follow this simple rule: Two model elements are identical if their names are identical. When the same model element is exported into two different files, and its name is changed in one of those files, the merging of these two parts will result in two model elements.. The primary purpose of the Save Project Module functionality is to allow the user to export a project part into a separate file and import later it into another project, an entirely different situation than splitting a project into parts and later connecting those parts into one project. MagicDraw Teamwork Server is an ideal solution for group work on the same project. For more information about the Teamwork Server, see the MagicDraw Teamwork System User’s Guide.

PROFILES Profiles are defined using UML's extensibility mechanisms. These allow modelers to customize UML for specific domains such as software development processes. In MagicDraw, the profiles mechanism is similar to the modules functionality, except that the profile is a package containing the stereotype <>, and its content is visible in both the Profiles dialog box and the UML extensions tabs of the Specification dialog boxes. There are several ways to work with profiles. You may: 1 Create your own profile. 2 Use preexisting profile. 3 Import a preexisting profile. 4 Export your created profile. Further details on these functions are found in the following sections.

Creating Profiles

Usually the profile contains specific stereotypes, constraints, and tagged values that you can use according to your needs. Profiles often contain other specific model elements, which MagicDraw allows you to include in your profile. You can use your existing profile in other parts or projects. Additionally, other users may reuse your profile as a module.

To create your own profile

1 Create profile element (in the Browser or using Class Diagram toolbar, Profiling Mechanism group) 2 Add the stereotypes, constraints, and/or other model elements you need for extending UML.

For information on how to add stereotypes, tagged values, or constraints to the profile (package), See “UML Extension Mechanisms” on page 280. The existing profile will appear in the Profiles dialog box. For more information on working with UML extensions, See “UML Extension Mechanisms” on page 280.

Using and Importing Profiles

You may use other profiles in your project, or import them. MagicDraw offers several profiles, found in the /profiles folder.

To use a preexisting profile in your project

1 From the File menu, choose Use Profile/Module. 2 The Use Profile/Module dialog box opens. If needed, select the directory where the desired profile is located. Choose the desired profile, and click OK. The chosen profile appears in the Browser tree as read-only. You may use it in your project. If necessary, you can also import and edit your profile.

To import a preexisting profile into your project

• From your chosen profile, go to the Browser's shortcut menu. Choose Modules and then choose Import Module.

• From the File menu, choose Import. The Import dialog box opens. Choose the profile you want to import and click Open. The imported profile will appear as a editable package in the Browser.

Profiles dialog box

Figure 27 -- Profiles dialog box

Exporting Profiles

If you want to use the existing profile in another project, or enable other users to use it, you may save the existing profile in the selected directory. Exporting profiles is similar to exporting modules functionality. 1 From the File menu, choose Export, and then choose Profile/Module. 2 The Export Profile/Module dialog box opens. Choose the profile package you want to export and add it to the Selected list. Write the description of the profile in the text box, click OK, and save it to the desired directory.

MODEL DIFFERENCING Since MagicDraw version 9.0, model differencing functionality is presented. Now you are able to compare two MagicDraw UML local projects or teamwork project versions, as well as diagrams. Model elements are compared by elements ID. You may compare:

• current project with locally saved project

• current project with opened project

• two teamwork project versions

• current project with teamwork project version.

• local project and teamwork project version.

• diagrams

Models comparison

First of all you have to choose projects you want to compare. Model comparison will be displayed as two model trees. Differences between model versions are marked using colors and highlighting. When comparing two models such data changes will be reflected:

• New model elements.

• Deleted model elements.

• Model elements with modified data.

• Model elements that changed location.

• Inner elements changes.

To choose projects you want to compare

1 Open a project you want to compare and from the Tools menu, choose Compare Projects. 2 The Compare Projects dialog box appears.

Figure 28 -- Select Projects to Compare dialog box 3 From the Active Project combo box, choose a project you want to compare with another project. The list contains names of all opened projects in MagicDraw. 4 From the Compare With combo box, choose a project with which you want to compare the first project. The following options are available: • opened project names are listed, except the project, which is selected in the Active Project combo box.

• Local Project. Click the "…" button and choose a project version you want to compare the current project with.

• Teamwork Project. Click the “...” button and from the Open Teamwork Project dialog box, select a project ant its version you want to compare with.

• Disk version. By selecting this option you will be able to compare currently changed project version with the project version on the disc without current changes.

By default the first opened project should be selected. If there are no more projects opened, value Local Project is selected.

U NDERSTANDING MODEL DIFFERENCES All model version differences are displayed in the Difference Viewer dialog box.

Figure 29 -- Difference Viewer dialog box In the Difference Viewer dialog box two compared projects are displayed. At the bottom of the dialog box number of differences is displayed. Differences number includes inserted, deleted, and modified elements. Number does not include elements that inner elements are changes. Differences number is displayed in following order: For marking model element changes several colors are used:

• Elements that do not exist in the other model (inserted elements). Element is displayed only in the right-hand tree. New element is highlighted in light green color.

• Elements that exist in other model, but do not exist in current model (deleted elements). Elements always are displayed in the left-hand tree. Deleted element is highlighted in grey color.

• Elements with modified element data (modified elements). Modified element is highlighted as changed in both trees. Modified element is highlighted in light blue color.

• Elements that changed location (parent has changed). Element is marked as modified element. Empty nodes are displayed in opposite tree where element does not exist. On moved element and on its former position button is displayed. Pressing button on former position selects place where element is moved. Pressing button on moved elements position selects former element place. Also you may perform these operations using shortcut menu commands Go to former position or Go to moved element.

• Elements that inner elements are changed. Element is marked in both trees. Such element is highlighted in light grey color dashes. Element with modified element data and changed inner elements is marked as modified and as element with changed inner elements. Element is marked as modified when:

• Element specification properties have changed. Element specification properties include all properties, which are not displayed in Browser as separate elements. Model element specification properties are treated as changed only if element property may be changed from element specification. If element specification has changed because of changes made to other elements, the element should be not treated as changed. Example: typed values in tagged values specification, attribute links in object and instance specification, etc.

• Element parent has changed.

• Path is drawn from/to element. Buttons available in the Difference Viewer dialog box: Button Function Both trees are expanded.

Expand All Both trees are collapsed.

Collapse All Select the difference, which is previous to the selected one.

Go to Previous Difference Select the difference, which is next to the selected one.

Go to Next Difference The Filter dialog box appears. Show/hide the elements you want to analyze. Filter

Button Function Relations are displayed in elements specification. Relation added to element means that element is marked as modified. Include Relation Ends Display: All - Shows all elements of the projects. All Differences - Shows only differences made between he projects. Deleted Elements - Shows only elements that were deleted from the projects. Inserted Elements - Shows only elements that were inserted in the projects. Modified Elements - Shows only elements that were modified. The Find dialog box appears. Search for elements within the corresponding project. Find Next Element More>> More/Less button shows/hides element properties table. By default <

Diagrams Comparison

To compare diagrams

1 In the Difference Viewer dialog box, select the diagram you want to compare and click the Compare Diagrams button.

2 The Diagrams Difference Viewer dialog box appears, which displays both diagrams with changes made in them.

Figure 30 -- Diagram Difference Viewer dialog box Diagrams Difference Viewer displays two diagrams:

• Current (or first opened) project diagram is displayed at the right-hand side.

• Diagram that is compared with is displayed at the left-hand side. Symbols changes that are reflected in the diagram:

• Modified symbol properties

• New symbol creation

• Symbol deletion

• Symbol bound changes (resize, bound changes because of element properties changes) All changes are highlighted in light blue color dashes.

Buttons available in the Diagrams Difference Viewer dialog box: Button Function If pressed, zooming affects both diagrams: zooming one diagram invokes zooming of another diagram. Synchronize Zooming If pressed, scrolling one diagram invokes scrolling of another diagram. Synchronize Scrolling If pressed, places where diagram has changed are marked on both diagrams. Mark Changes Prints the corresponding diagram together with marked changes.

Print Diagram Zooms the corresponding diagram(s) to the original size.

Zoom 1:1 Zooms the corresponding diagram(s) to the size that fits in window. Fit in Window Zooms the corresponding diagram(s) in.

Zoom In Zooms the corresponding diagram(s) out.

Zoom Out Choose the percentage for zooming the corresponding diagram(s).

WORKING WITH MULTIPLE PROJECTS Because you may have to manage several projects at the same time, MagicDraw allows you to work with several projects simultaneously. All opened projects are held in separate workspaces. Different activated projects may exchange data. Entities from the one project can be copied or moved to another.

To switch between loaded projects

• In the Projects drop-down combo box, click the additional project you wish to open.

• Choose Projects from the File menu and click the name of the project you wish to open.

To close all opened projects Choose Close All Projects from the File menu. The Question message box appears.

Figure 31 -- Question message box Choose the way your projects will be closed: Yes The project you are currently closing will be saved (its name appears in the question). Dialog box is displayed again when the next project closes. Yes To All Save all projects without prompting. The Save dialog box appears for each opened project. No Project you are currently closing will not be saved. The dialog box is displayed again when the next project closes. No To All All the projects will be closed without saving and prompting. Cancel Cancels saving projects.

To exchange model entities between opened projects

• Use the Cut, Copy, and Paste commands in the Edit menu, or appropriate shortcut keys: Ctrl+X, Ctrl+C, Ctrl+V or the toolbar buttons.

• Drag-and-drop the created model element from the Browser tree to the Diagram pane. NOTE Data may only be exchanged between projects that are currently opened within MagicDraw. You may not copy/paste elements between instances of different tools that are currently running or to other applications.

USING BROWSER The Browser provides a visual representation of the hierarchy for your model elements. The items in this hierarchy are either:

• Compressed - a plus sign next to an icon indicates that the icon is compressed, that is, it contains other model elements. This is the default setting when you start your application. Click the plus sign to expand the icon and view its subordinate items.

• 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 sign next to an icon, means that it does not contain other model elements. The Browser is a hierarchical navigational tool that allows you to manage your model data, including packages, components, classes, all UML diagrams, extension mechanisms, and other data. You may use the Browser as an alternative tool to the menus and toolbars that are in MagicDraw. It is easier to work with projects diagrams and data elements using the Browser. The Browser performs the following operations:

• Creation and specification of model elements without viewing them.

• Copying, cutting, and pasting of model elements.

• Opening and deletion of model elements.

• Dragging and dropping of model elements to the Diagram pane and inside the Browser.

• Dragging and dropping of data in the Code engineering sets (you may create data in the Data branch, drag it to the Code Engineering sets, and the round trip object is created automatically).

• Hierarchical viewing of all model elements.

• Trace viewing for the selected model element.

• Symbol creation for the selected model element in the current diagram.

• Managing diagrams.

• Managing extension mechanisms such as constraints, stereotypes, and tagged values.

• Java reversing a class directly from classpath.

• Adjusting the code engineering sets.

• Code generation for the particular sets.

• Filtering of the visible items (by any model type, e.g. class, package, operation, component, state and others - both for views and dates), when the Filter from the Browser shortcut menu is selected.

• Sorting of the visible items for the selected model element.

• Sorting of all model elements.

• Displaying search results.

T HE BROWSER WINDOW PARTS The Browser window is divided into two parts:

• Containment tree/Diagrams tree/Inheritance tree/Model Extensions tree/Search Results part. The Containment tree tab groups data in the logical sets. The Diagrams tab groups diagrams that are represented on the diagram pane according to the diagrams types or shows them as a list. The Inherence tree tab represents class hierarchy of the project. The Model Extensions tree tab represents all predefined and created constraints, stereotypes, and tagged values. The Search results tab displays search results.

• Documentation/Zoom Control part. The Documentation tab shows documentation associated with selected item. The Zoom Control tab is responsible for zooming current diagram.

Figure 32 -- Browser When at least one Project is open, the Browser is placed to the left side of the main window. Beginning with MagicDraw version 7.5, it is possible to place Browser in any plane of the

MagicDraw application, also all tabs can be viewed separately, you may set up Browser according your need by hiding the desired tabs.

To change the size of either part of the Browser Drag the bar that separates the two parts.

To change the Browser position from the Options menu

1 Choose Environment from the Options menu. The Environment Options dialog box appears. 2 In the Browser tab, change the Browser Position property to Right or Left.

To close or reopen the desired tab of the Browser From the Window menu, choose the tab you want to close/open.

To reset all Browser tabs to it default position From the Window menu, choose Reset Windows Configuration command.

To sort alphabetically items in browser

1 Choose Environment command from the Options menu. The Environment Options dialog box appears. 2 In the Browser tab, set the Sort Always check box to “true” (default “true”). The same option is available from the Browser shortcut menu.

Containment tree

The Containment tree displays model data, grouping it in logical sets.

To open the Containment tree

• Click the Containment Tree tab in the upper side of the Browser.

• If the Containment tree is hidden, from the Window menu, choose Containment Tree.

Figure 33 -- Containment tree

To show the full information of operations, attributes, and relationships in the Containment Tree

• In the Containment Tree tab, click the Show Full Types in Browser button . 1 Choose Environment command from the Options menu. The Environment Options dialog box appears. 2 In the Browser tab, set the Show Full Types in Browser check box to “true” (default “false”).

To show stereotypes in Containment tree

• In the Containment Tree tab, click the Show Stereotypes in Browser button . 1 Choose Environment command from the Options menu. The Environment Options dialog box appears. 2 In the Browser tab, set the Show Stereotypes in Browser check box to “true” (default “false”).

To show/hide Code Engineering sets branch

• In the Containment Tree tab, click the Show Code Engineering Sets button . 1 Choose Environment command from the Options menu. The Environment Options dialog box appears. 2 In the Browser tab, set the Show Code Engineering Sets check box to “true” (default “true”).

D ATA BRANCH The Data branch represents a project’s model and structure. All model elements are stored in packages. This helps you distribute data into logical groups. By default, all new model elements data (inner structure) are stored in the Data package. You may create your own packages for storing your model elements data. The Data branch also contains the Component View, Data Types, and Relations (appears only when at least one path is drawn on the diagram pane) branches. Component View is already created package where the components during code engineering are placed. Data Types contains the list of primitive data types: Boolean, byte, char, double, float, int, long, short, and void. You may create your own data types.

To create a new data type

1 Choose New Element from the package in the Browser shortcut menu and then choose Data Type. 2 Type the name of the data type directly in the Browser tree. For more information about managing model elements from the Browser, see Section “Working with model elements in the Browser tree” on page 4-91.

C ODE ENGINEERING SETS The Code engineering sets branch is a gateway between your source code and model data. Using sets, you may perform Java, C++, IDL, DDL, EJB, CIL, and C# code round-trip engineering (code generation + reverse engineering).

To create a new Code engineering set

1 Right-click the Code Engineering Sets item and choose New from the item shortcut menu or open the Code Engineering Sets dialog box and click the New button. The New Set dialog box appears. 2 Type the set name and select programming language from the drop-down list (by default - Java). 3 Click OK to finish set creation.

To edit the selected set Choose Edit from the set shortcut menu. The Round Trip Set dialog box appears. You may add/remove files or classes from the Code engineering set.

To rename the selected set Choose Rename from the set shortcut menu and type the set name.

To change code generation properties Choose Properties from the set shortcut menu. The CG Properties Editor for Data dialog box opens.

The detailed description about the CG Properties Editor dialog boxes, see MagicDraw Help.

To delete the selected set Choose Delete from the set shortcut menu.

To restore the deleted set From the Edit menu, choose Undo or press shortcut keys CTRL+Z.

To generate code from the selected set

1 Choose Generate from the set shortcut menu. The Code Generation Options dialog box appears. 2 Adjust your own code generation options. 3 Click OK. The Messages Window dialog box appears. You may see information about generated files.

To check syntax Choose Check Syntax from the set shortcut menu. If no errors are found, the There are no syntax errors in the model message box appears.

To reverse the selected set

1 Choose Reverse from the set shortcut menu. 2 The Reverse Options dialog box appears. Define options and click OK. For the detailed descriptions about the reverse, see Section Reverse in the Code Engineering User’s Guide.

To reverse files that have been changed

1 Choose Refresh from the set shortcut menu. 2 The Reverse Options dialog box appears. Define options and click OK. For the detailed descriptions about the reverse, see Section “Reverse” in the Code Engineering User’s Guide. TIP! All above listed functions can be performed in the Code Engineering Sets dialog box.

To choose a text editor for source code

1 In the Options menu, choose Environment and select the Launchers group in the opened dialog box. 2 In the Default launchers field, click the “...” button and select the directory where the text editor is located. 3 Click OK.

Diagrams tree

The Diagrams tree in the Browser represents a diagram’s external structure.

Figure 34 -- Diagrams tree In the Diagrams tree, with the selected diagrams, you may perform the operations listed below.

To group diagrams according their diagrams types

• Click the Group by Diagram Type button in the Diagrams tree.

• From the shortcut menu, select the Group by Diagram Type check box.

To open the selected diagram from the Browser Choose Open from the item shortcut menu or double-click the item of the diagram.

To delete the selected diagram Choose Delete from the selected diagram shortcut menu.

To rename the selected diagram Choose Specification from the diagram shortcut menu. The corresponding Diagram Specification dialog box appears. Type the diagram name and click OK. TIP! Also in the Diagram Specification dialog box you may add documentation of the diagram, define steretypes, contraints and tagged values, view ther relationships in which the diagram participates, and difine hyperliks.

To print the selected diagram

• Choose Print from the diagram item shortcut menu. If the diagram is empty, it will not be printed. Also there are other ways for printing diagram. For more details about printing, see Section “Printing” on page 5-150.

Inheritance tree

The Inheritance tree represents classifiers, packages, data types, stereotypes hierarchy of your project. The inheritance according UML Specification is shown using generalization relationship.

Figure 35 -- Inheritance tree For more information about managing model elements from the Browser, see Section “Working with model elements in the Browser tree” on page 4-91.

To show stereotypes in Inheritance tree

• In the Inheritance Tree tab, click the Show Stereotypes in Browser button .

1 Choose Environment command from the Options menu. The Environment Options dialog box appears. 2 In the Browser tab, set the Show Stereotypes in Browser check box to “true” (default “false”).

Model Extensions Tree

The Model Extensions Tree contains all Stereotypes that are predefined and created manually in the project. In this tree you may create, review, copy/paste, and delete extensions mechanisms. It can be mainly used for the work of the team using the Teamwork server for locking for edit/unlocking extension mechanisms.

Figure 36 -- Model Extensions Tree

To group extensions by profiles

• In the Model Extensions Tree, click the Group by Profiles button .

• From the Model Extensions Tree shortcut menu, select the Group by Profiles check box.

To group extensions by their base classes

• In the Model Extensions Tree, click the Group by Metaclasses button .

• From the Model Extensions Tree shortcut menu, select the Group by Profiles check box.

Search Results Tree

The Search Results tree shows results of the search, which may be performed through the Find dialog box.

Figure 37 -- Search Results tab The results in the tab are dispalyed in two packages:

• From Diagrams - shown are those elements that are displayed on the diagram(s).

• From Model - shown are those elements that are created in the model data. How to perform search, see Section “Searching” on page 4-95.

To open the Find dialog box, from the Search Results Tree Click the Find button , or press CTRL+F keys.

To clear the results of the previous search Click the lear Clear Results button or select the Clear Results button from the Search Results tab.

Working with model elements in the Browser tree

To create a model element or a diagram in the Browser

1 Right-click the package in the Browser.

2 From the New command, select the model element or a diagram you wish to create.

To copy/cut and paste the selected model element in the Browser tree

1 Choose Copy or Cut from the item shortcut menu. 2 Select an item where you wish to put the copy of the model element. 3 Choose Paste from the item shortcut menu.

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

1 Choose Copy or Cut from the item shortcut menu. 2 Change the project name in the Projects list on main window toolbar. 3 Select where you wish to put the copy of the element. 4 Choose Paste from the item shortcut menu.

To delete a model element from the Browser tree Choose Delete from the item shortcut menu.

To drag-and-drop the selected item in the Browser tree

1 Make sure that the place you wish to drag the item is visible. 2 Drag the selected item to the destination and drop it.

To draw a symbol on the diagram Choose Create Symbol from the items in the Browser shortcut menu. NOTE You may draw a symbol by dragging and dropping an item to the Diagram pane

To show/hide model elemens in the Browser tree

1 Right-click in the Browser. 2 From the shortcut menu, choose Filter. 3 The Items Filter dialog box appears. Clear the check boxes of those model elements that you would not like to appear in the Browser tree

Multiple selection

A group of model elements can be selected within the Browser tree, and you may edit all the selected model elements at the same time.

To make multiple selections

• Hold down the SHIFT key and click the last element you wish to include in to multiple selection.

• For more precise selection, hold down the CTRL key and click (while holding the key down) with the mouse on the elements you wish to select.

To select all model elements or all browser tree items Click the mouse pointer in the area you want to select all elements and press shortcut keys CTRL+A. NOTE All selected model elements can be moved or deleted as a single selected element. While moving the set MultipleDrag, a border appears denoting the area you have selected. Be careful when deleting multiple elements because no confirmation dialog box will appear.

Documentation/Zoom Control/Properties

D OCUMENTATION TAB The Documentation tab shows information associated with the selected model element in the Browser tree or diagram.

To open the Documentation tab Click the Documentation tab in the lower side of the Browser window or from the Window menu, choose Documentation. If there is no documentation for the selected element, No documentation message is displayed in the section.

To write documentation for the selected model element

1 Click the Documentation tab. 2 Type information.

Z OOM CONTROL TAB In this tab, you may preview the desired diagram simply by selecting it in the Browser on on the Content diagram. Also you use this tab for zooming the diagram.

To zoom in for a close-up view of your diagram, or to zoom out and see more of the diagram at a reduced size

1 Click the Zoom Control tab in the Browser window. 2 Drag the rectangle or drag the slider. NOTE: By default the zoom slider is not visible. To display the zoom slider in the Zoom Control tab, in the Environment Options dialog box, Browser tab, select the Show Diagram Zoom Slider check box.

Quickly access any part of the diagram using the Zoom Control tab Drag the blue square to the desired part of the diagrm. The desired diagram part will be displayed on the diagram window.

To fit diagram in window, through the Zoom Control tab Click the Fit in Window button on the square in the Zoom Control tab.

P ROPERTIES TAB Since MagicDraw version 8.0, you may edit model elements and diargram properties such as data, sybol properties, language properties directly from in the Browser, Properties tab. Properties tab has two modes - Standard ant Expert. Depending on your needs you may choose one of them.

Figure 38 -- Customize Properties dialog box

SEARCHING MagicDraw search mechnism enables the serch within model elements data, symbols, and extensions. You may also search for usages and dependant elements of the selected elements. This functionality is described in Section “Usages Functionality” on page 5-131 and in Section “Dependent Elements functionality” on page 5-131.

To find quickly the needed classifier or diagram From the Edit menu, choose Quick Find. In the appeared screen, type the name of the classifier or diagram (also you may choose it from the drop-down list), and choose one of the needed option buttons.

Figure 39 -- Quick Find screen

Find all elements of some type

1 From the Edit menu, choose Find, or press corresponding shortcut key Ctrl+F, or click the Find button on the main toolbar. The Find dialog box appears. 2 Type the "*" symbol in the Name text box. 3 Click the "..." button near the Type text box to open the Select Model Elements Types drop-down combo box. Select types of elements and click OK. Model elements in this box are listed according metamodel. 4 Click the Find button to start search. The search results appear in the Search Tree in the Browser. TIP! To generalize the beginning or ending of the name, add the "?" symbol in the front or in the end of the string.

Find model elements and symbols in your project

1 Choose Find from Edit menu or press corresponding shortcut key Ctrl+F or click the Search tab in the Browser. 2 In the Name text box, type the name of the element. If you want to find all elements of the selected type, enter the "*" symbol in the Name text box. 3 Click the "..." button near the Type text box to open the Select Model Element/Symbol Types drop-down combo box. Select types of elements and click OK. Model elements in this box are listed according metamodel. 4 To start search, click the Find button. The search results appear in the Search Results tree in the Browser. TIP! To generalize the beginning or ending of the name, add the "?" symbol in the front or in the end of the string. NOTE If the Clear Previous Results check box is cleared, new results are appended to previous search results in the tree.

TIP! Select Search Data Unused in Diagrams check box to find only elements lacking shapes.

Find dialog box

Figure 40 -- Find dialog box The Find dialog box contains five tabs:

• Search Element by Name tab

• Search Element by Stereotype tab

• Search Element by Tagged Value tab

• Search Element by Constraint Value tab

• Search Element by Documentation tab

Element Function Name Type the name of the item you wish to find. NOTE: You may define wildcards <*> and for the search. For example, if you define the following input string , the system looks for items with at the beginning and at the end of the string. If you define such string as , all strings containing will be found. Type Select a type of elements from the proposed items, or leave this field empty.

Value Select or type a value of Tagged Value or Constaint. Only available for Search Element by Tagged Value and Constraint Value tab. Case Sensitive Searches for the groups of items that have the names and capitalization exactly as defined in the string entered in the Item to Find box. When unselected, MagicDraw UML does not distinguish between uppercase and lowercase characters of the item name entered in the Name box while searching for the item. Match Whole Searches for the groups of items with names that exactly match Words Only the string entered in the Item to Find box. When unselected, the MagicDraw searches for the groups of items with the names matching the first parts of the string entered in the Name field. Search Data Searches only elements that do not contain symbols in any Unused in diagram. Diagrams Java Regular In the Section “Java Regular Expressions” on page 4-98, you Expression may find several expressions that will help you to make a search in MagicDraw. Clear Previous Removes from the Browser tree all previously found items. Results Find Searches for items and displays the results of the search in the found items list field. If MagicDraw does not find any item, the message is displayed. Close Exits the dialog box. Help Displays MagicDraw Help.

Java Regular Expressions

M ETACHARACTERS There are supported several character, which are used to form search pattern ([{\^$|)?*+. There are two ways to force a metacharacter to be treated as an ordinary character: