MagicDraw UserManual

USERS MANUAL

version 9.5

No Magic, Inc.

April, 2005

CONTENTS 0CONTENTS 2

1 INTRODUCING MAGICDRAW 1-12MagicDraw Editions and Features 1-13

MagicDraw Personal edition 1-13MagicDraw Standard edition 1-13MagicDraw Professional editions 1-13MagicDraw Enterprise edition 1-14MagicDraw Reader Edition 1-14MagicDraw Community Edition 1-14

MagicDraw Documentation and Support 1-14Help 1-15Users Guides 1-15

Other Documentation 1-16Support 1-17

FAQ 1-17Newsgroups 1-17E-mail 1-17Bug Reports 1-17

2 GETTING STARTED 2-20Installing and Running 2-20

System requirements 2-20Java Virtual Machine (JVM) 2-20

Operating system - dependent issues 2-21Installation procedure 2-21

Windows 2000/9x/NT/XP 2-21Unix 2-22MAC OS X 2-22All other platforms instructions (no install version) 2-22

Updating 2-22Auto-Check for Updates dialog box 2-23

structure of menus and toolbars 2-23Setting Personal Preferences 2-24

Environment Options 2-24General pane 2-25

Diagram pane 2-28Browser pane 2-29

M a g i c D r a w U s e r s M a n u a lC o n t e n t sTeamwork pane 2-31Floating pane 2-32CVS pane 2-33Update pane 2-34HTTP Proxy pane 2-35Keyboard pane 2-36Plugins pane 2-37Resources pane 2-38Path Variables Pane 2-39Launcher Pane 2-40

Look and Feel: Controlling Interface 2-40JIDE and Multiple Windows interface styles 2-42

3 WORKING WITH PROJECTS 3-44Creating New Project 3-44

Creating new project from already created template 3-45Importing project 3-46

Saving and Exporting 3-46Exporting project as template 3-47Saving diagram as image 3-48Autosave 3-50

Loading 3-50Project Options. Style Engine 3-51

Project Options 3-51Symbols Properties Styles Tree 3-54

Working with Properties Styles 3-58Properties extension by diagram 3-58Properties Inheritance 3-59General Style Properties 3-60Shapes, Paths and Diagrams Properties 3-60Stereotypes properties 3-61

Modules Functionality. Reusing project part - Partitioning 3-63Working with modules 3-63

Exporting Project Module 3-63Using Project Module 3-65Importing Project Module 3-65Sharing packages 3-65Opening Module As a Project 3-67Reloading Module 3-67

Dependencies between elements 3-68Packages dependencies by relationships 3-68Dependencies by reference 3-71Diagrams dependencies 3-71

Package Dependencies dialog box 3-723 2004 No Magic, Inc.

M a g i c D r a w U s e r s M a n u a IC o n t e n t sProfiles 3-74Creating profiles 3-74Using and importing profiles 3-75Exporting profiles 3-76

Model Differencing 3-76Models comparison 3-77

Understanding model differences 3-78Diagrams Comparison 3-81

Working with multiple projects 3-83Using Browser 3-84

The Browser window parts 3-85Containment tree 3-87

Data branch 3-89Code engineering sets 3-89

Diagrams tree 3-91Inheritance tree 3-92Model Extensions Tree 3-93Search Results Tree 3-94Working with model elements in the Browser tree 3-95Multiple selection 3-96Documentation/Zoom Control/Properties 3-96

Documentation tab 3-96Zoom Control tab 3-97Properties tab 3-98

Searching 3-99Java Regular Expressions 3-101

Metacharacters 3-101Character Sets 3-102Grouping 3-102Quantifiers 3-102Boundary Matchers 3-103Embedded Flag Expressions 3-103

MagicDraw and Rational Rose 3-104Rational Rose 3-104MagicDraw 3-106Metamodel and XMI incompatibilities 3-107

Other noticed incompatibilities 3-109MagicDraw and Together ControlCenter 3-109

Together ControlCenter 3-110MagicDraw 3-111Metamodel and Unisys XMI incompatibilities 3-112

Other noticed incompatibilities 3-114Resources Manager 3-114 2004 No Magic, Inc. 4

M a g i c D r a w U s e r s M a n u a lC o n t e n t s4 DIAGRAMS BASICS 4-120Working with Diagrams 4-120

Diagrams dialog box 4-122Diagram Properties 4-124

Table with diagram information 4-125Drawing Shapes 4-126Drawing Relationship paths 4-129Smart Manipulation 4-130Selection. Multiple Selection 4-131Dragging, Copying, Cutting, and Pasting 4-132Specifying Model Elements 4-133

Specification dialog boxes 4-133Relations tab 4-134Stereotypes tab 4-135Tagged Values tab 4-136Constraints tab 4-138General tab 4-139Attributes tab 4-141Operations tab 4-142Hyperlinks tab 4-143Buttons available in the Specification dialog boxes 4-144

Formating Symbols 4-144Owner of the model element 4-145

Model Traceability 4-146Usages functionality 4-146Dependent Elements functionality 4-146

Find Usages / Dependent Elements Options dialog box 4-147Elements Using \ Dependencies windows 4-148

Defining Hyperlinks 4-150Insert Hyperlink dialog box 4-151

Laying out 4-153Orthogonal Layouter 4-154Hierarchic Layouter 4-154Tree Layouter 4-156Organic Layouter 4-158Circular Layouter 4-159Orthogonal Path Router 4-160Organic Path Router 4-160Class Diagram Layouter 4-161Quick Diagram Layout feature 4-162

Zooming 4-162Using Grid 4-163Assigning Shortcut Keys 4-164Printing 4-165

Print Range tab 4-1655 2004 No Magic, Inc.

M a g i c D r a w U s e r s M a n u a IC o n t e n t sPrint Options Tab 4-167Print Header/Footer Tab 4-168

Model Elements Common in all Diagrams 4-169Note Anchor 4-169Constraint path 4-170Separator 4-170Documentation 4-170

5 UML DIAGRAMS 5-174System Views 5-175

Use Case View 5-175Logical View 5-175Process view 5-176Component view 5-176Deployment view 5-176

Class Diagram 5-176Class diagram elements 5-178Classes 5-183

Working with classes 5-183Interface 5-186Attribute 5-188Operation 5-193

Template / Parameterized class 5-199Port 5-200Data types 5-201

Enumeration 5-203Primitive 5-205Programming Language Data Type 5-205

Design Patterns 5-205Class presentation options 5-206Packages 5-208

Working with packages 5-208Subsystem 5-210Model 5-213Collaboration 5-214Generalization 5-216

Generalizable elements 5-218Association 5-218

Association End 5-220Realization 5-225Dependency 5-226

Abstraction 5-227Binding dependency 5-227 2004 No Magic, Inc. 6

Permission 5-228

M a g i c D r a w U s e r s M a n u a lC o n t e n t sUsage 5-229Merge 5-229Import 5-229

Containment 5-230Use Case Diagram 5-230

Use Case diagram elements 5-231Actors 5-233

Working with actors 5-233Use Cases 5-235Use Case Extensions 5-237Relationships in Use Case diagram 5-238

Association 5-238Extend 5-238Include 5-240Generalization 5-241Dependency 5-241Realization 5-241Containment 5-241

Collaboration Diagram 5-242Instance level 5-242Specification level 5-242Collaboration Diagram elements 5-244Instance 5-245

Instances Specification dialog boxes 5-245Link 5-248Classifier role 5-251Association role 5-252Stimulus / Message 5-254

Predecessors and activators 5-259Actions 5-260

Action types 5-263Active objects 5-264

Sequence Diagram 5-265Sequence diagram elements 5-266Interaction Use 5-268Combined Fragment 5-269Lifelines 5-271Messages in sequence diagram 5-272

State Diagram 5-274State Diagram elements 5-275State 5-278Concurrent state 5-282Submachine 5-282Synch state 5-285PseudoStates 5-2867 2004 No Magic, Inc.

M a g i c D r a w U s e r s M a n u a IC o n t e n t sInitial state 5-286Final state 5-286History state 5-286Junction and dynamic choice points 5-287

Actions in State and Activity diagrams 5-287Action labels 5-288

Events 5-288Event types 5-290

Internal transitions 5-290Transition 5-291

Guard Specification dialog box 5-293Activity Diagram 5-294

Activity Diagram elements 5-296Action state 5-299Call State 5-302Subactivity state 5-302Flow Final 5-304Decision Point 5-305Object flow state 5-305Signal sending / receipt shapes 5-308

Signal sending 5-308Signal receipt 5-309

Swimlanes 5-309Implementation Diagrams 5-312

Component diagram overview 5-312Deployment diagram overview 5-312Implementation Diagram elements 5-314Components 5-318Nodes 5-321

UML Extension Mechanisms 5-323Stereotype 5-323

Stereotype Specification dialog box 5-324Profiles dialog box, Stereotypes tab 5-326UML Web Extension stereotypes 5-327

Tag definitions 5-334Tag Definition Specification dialog box 5-335Tagged Value Specification dialog box 5-336Profiles dialog box, Tag Definitions tab 5-337TODO item 5-339Groups 5-339

Constraints 5-339Constraint Specification dialog box 5-341Profiles dialog box, constraints tab 5-342 2004 No Magic, Inc. 8

M a g i c D r a w U s e r s M a n u a lC o n t e n t s6 EXTENSION DIAGRAMS 6-358Content Diagram 6-359

Content Diagram Elements 6-360Robustness Diagram 6-363

Robstness Diagram Elements 6-364Web Diagram 6-365

Web Diagram Elements 6-367CORBA IDL Diagram 6-371

CORBA IDL Diagram Elements 6-372DDL Diagram 6-374

DDL Diagram Elements 6-375WSDL Diagram 6-376

WSDL Diagram Elements 6-377XML Schema Diagram 6-379

XML Schema Diagram Elements 6-380Time Diagram 6-382

Time Diagram Elements 6-383

7 TOOLS 7-386Reports 7-386

Template Management tab 7-387Document Options 7-391Model Report 7-392Use Case Report 7-394Software design Description 7-395Model Extension Report 7-397

Select Packages tab 7-398Select Diagrams tab 7-399Output Options tab 7-400Report Customization 7-401

New report style creation example 7-402Fonts in PDF and PS reports 7-404

Report Generator Tool 7-404Starting report generator 7-404Generating Configuration file 7-404

Class Diagram Wizard 7-405Package Dependency Wizard 7-410Package Overview Diagram Wizard 7-412Tools for Analysis 7-417

Hierarchy Diagram Wizard 7-418Realization Diagram Wizard 7-421

Content Diagram Wizard 7-426Sequence Diagram from Java Source Wizard 7-428Pattern Wizard 7-432Creating Setters / Getters 7-4389 2004 No Magic, Inc.

M a g i c D r a w U s e r s M a n u a IC o n t e n t sImplementing or Overriding Operations 7-439Model Transformation Wizard 7-440

Types of the transformations 7-440Model Transformation Wizard 7-441Model Transformation Mapping 7-444Transformation Mapping Possibilities 7-445Model Transformation Update 7-448

Metrics 7-449Metrics suites 7-449Displaying metrics 7-450Invoking Metrics 7-451

Metrics window 7-452Exporting metrics 7-454Comparing metrics 7-455Metrics Options 7-455Metrics properties 7-458

INDEX 464 2004 No Magic, Inc. 10

I N T R O D U C I N G M A G I C D R A W 1

Todays 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 softwares 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.2005 No Magic, Inc. 1-12

I N T R O D U C I N G M A G I C D R A WMagicDraw Edi t ions and Features

1MagicDraw 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 FEATURESThe detailed list of MagicDraw features find at:http://www.magicdraw.com/files/brochures/a4/MagicDrawDataSheet.pdf

M A G I C D R A W P E R S O N A L E D I T I O NThe 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 A G I C D R A W S T A N D A R D E D I T I O NThe 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 A G I C D R A W P R O F E S S I O N A L E D I T I O N S 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.1-13 2005 No Magic, Inc.

I N T R O D U C I N G M A G I C D R A WMagicDraw Documentat ion and Support

1 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 A G I C D R A W E N T E R P R I S E E D I T I O NThe 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 A G I C D R A W R E A D E R E D I T I O NMagicDraw 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 A G I C D R A W C O M M U N I T Y E D I T I O NMagicDraw 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 SUPPORTMagicDraw 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. 2005 No Magic, Inc 1-14

1-


1Help

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 UserManual.pdf

Includes detailed explanations and instructions of installing and working with MagicDraw.

/manual

Start/Programs/MagicDrawUML/MagicDraw User Manual.pdf

www.magicdraw.com -> Download->Download Manual15 2005 No Magic, Inc.


1O T H E R D O C U M E N T A T I O N Readme files. In the main MagicDraw installation directory, the main

readme.html file is located. Also readme documents are available for MagicDraw integrations.

MagicDraw CodeEngineering UserGuide.pdf

In this user guide you will find not only basic information about reverse and generation in MagicDraw but also detailed descriptions about DDL, CORBA IDL, EJB 2.0, and XML Schema usage in MagicDraw.

/manual

www.magicdraw.com -> Download->Download Manual

MagicDraw Tutorials UserGuide.pdf

Step by step instructions presenting the basics of using MagicDraw diagramming, creation of sequence diagram, integration with CVS and Eclipse.

MagicDraw Integrations UserGuide.pdf

You will find here the full description of how to integrate MagicDraw with Eclipse, Borland JBuilder, Sun One Studio (before called Forte) including Netbeans, and CVS.

MagicDraw FloatingLicense UserGuide.pdf

Here you will find how setup and how to use MagicDraw Floating License server.

MagicDraw Teamwork UserGuide.pdf

In this document, you will 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 UserGuide.pdf

This document describes MagicDraw Open Java API and provides instructions how to write your own plug-ins, create actions in the menus and toolbars, change UML foundation elements, and create new patterns.

/openapi/docs

Name Description Location 2005 No Magic, Inc 1-16


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

Support

F A QBefore 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 E W S G R O U P SDiscuss and get answers about MagicDraw in newsgroups.

E - M A I LWe 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 U G R E P O R T SSubmit 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.1-17 2005 No Magic, Inc.

G E T T I N G S T A R T E D 2

INSTALLING AND RUNNING

System requirements

To run MagicDraw UML, your system must meet the following requirements:

Java Vi r tual 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'

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 Machine (JVM)

JDK 1.4 Suns JDK 1.4.2_03 2005 No Magic, Inc. 2-20

description, if you have problems on the specific OS.

G E T T I N G S T A R T E DInstal l ing and Running

2JDK 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 P E R A T I N G S Y S T E M - D E P E N D E N T I S S U E SBecause 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.4.2_03 is recommended, JDK 1.5 is supported.

Sun (JDK standard) for Windows (2000, NT, 95/98). JDK 1.4.2_03 is recommended, JDK 1.5 is supported.

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).

Ins ta l la t ion 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 I N D O W S 2 0 0 0 / 9 X / N T / X PAfter downloading, double-click MD_UML_95_win.exe (for the Personal Edition MD_UML_95_PE_win.exe).

The Setup Wizard automatically adds MagicDraw UML shortcuts to the start menu and the 2-21 2005 No Magic, Inc.

desktop. You may also execute the shortcuts from the installation directory.

G E T T I N G S T A R T E DUpdat ing

2U N I XAfter downloading, open a shell and go to the directory where you downloaded the installer.At the prompt type: sh ./MD_UML_95_unix.sh (for the Personal Edition MD_UML_95_PE_unix.sh).

M A C O S X

After downloading, double-click MD_UML_95_mac.dmg (for the Personal Edition MD_UML_95_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 L L O T H E R P L A T F O R M S I N S T R U C T I O N S ( N O I N S T A L L V E R S I O N )Download MD_UML_95_no_install.zip (for the Personal Edition MD_UML_95_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.

UPDATINGAutomatic 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 2-24.

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. 2005 No Magic, Inc 2-22

2-

G E T T I N G S T A R T E Dstructure of menus and toolbars

2A U T O - C H E C K F O R U P D A T E S D I A L O G B O XThe 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.

STRUCTURE OF MENUS AND TOOLBARSBefore 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.

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.

Element Name Function

Show this tip next time

If selected, the dialog box is opened each time, when the 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.

Function Accessibility

Main operations of editing (copy, cut, paste, delete)

Edit menu. Main toolbar buttons. Shortcut keys. Shortcut menu commands from Browser.

Opening of Specification dialog boxes

By double-clicking the model element. Specification command from the element shortcut menu on the

diagram or Browser. When adding one model element to another model element

from the Specification dialog box or Browser.

Defining symbols properties (font, color, etc.)

Symbol shortcut menu -> Symbol(s) Properties. Options menu -> Project. Main toolbar buttons23 2005 No Magic, Inc.

G E T T I N G S T A R T E DSet t ing Personal Preferences

2SETTING PERSONAL PREFERENCES

Envi ronment Opt ions

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. 2005 No Magic, Inc 2-24

2-


2G E N E R A L P A N E

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

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.

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.25 2005 No Magic, Inc.


2EMF character set Choose the encoding standard for the characters that will be copied to EMF.

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.

Icon size Select the size of the icons on the toolbar. The possible choices of icon sizes are 32 and 24.

Idle time to activate recovery save

Enter the system idle time (in minutes) when to activate file recovery save.

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 ThaiNOTE Restart MagicDraw to apply the changed

language.

Mark elements with active hyperlink

Shows active hyperlink arrow on element symbol.

Open last project on startup

The project you have finished the last session will be opened next time you start MagicDraw UML.

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.

Save diagram background in image

Saves the diagram background in the image together with the saved as image diagram. By default the diagram background, after saving as image, is white.

Save project recovery data on idle

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

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

Property name Function 2005 No Magic, Inc 2-26


2Show hyperlinks in specification dialog

Shows the Hyperlinks tab in the element Specification dialog box.

Show memory monitor Shows the project memory usage line in the bottom of the Magic Draw window.

Show model enrichment suggestion dialog

Opens the Model Enrichment dialog box in report generation.

Show status bar Shows status bar line in the bottom of the Magic Draw window.

Show tip of the day Shows the Tips of the Day dialog box every time you start the tool.

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.

Use icons in dialogs Icons on the button of dialog boxes are shown.

Use list for type select If selected, displays the list of available classifiers, if not selected, the hierarchy of all model elements is displayed in a drop-down list for selecting a type.

Use model enrichment wizard

Opens the Software Design Model Wizard or Use Case Model Wizard in report generation.

Property name Function2-27 2005 No Magic, Inc.


2D I A G R A M P A N E

Figure 2 -- Environment Options dialog box. Diagram pane


Allow class members selection

Operations and attributes can be selected and dragged & dropped to the other class.

Apply stereotype style for all symbols

Applies created stereotype style to symbol when adding stereotype to element.

Apply stereotype style for symbols in unlocked diagrams

Applies stereotype style in teamwork for unlocked diagrams.

Center on the mouse location when zooming

Centers zooming according to mouse arrow.

Display paths on element drop

When dragging and dropping an element from the Browser or executing a Create Symbol action, path to existing symbols are created.

Edit name with stereotypes

Allows to manage stereotypes by editing stereotype name directly on the Diagram pane

Graphics antialiasing Smooths the jagged edges of graphics. 2005 No Magic, Inc 2-28

Grid style Select one of the following style of the grid: Dense and Sparse.

2-


2B R O W S E R P A N E

Figure 3 -- Environment Options dialog box. Browser pane

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 highlighting

Enable error highlighting of the modeling process. This helps you 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 4-130.

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.


Property name Function29 2005 No Magic, Inc.


2Browser 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.

Group by base class Groups stereotypes, tagged values and constraints by base class in the in the Model Extensions Tree.

Group by diagram type

Groups diagrams according to diagram type in the Diagrams tree.

Group by profiles Groups stereotypes, tagged values and constraints by profiles in the in the Model Extensions Tree.

Show changes in browser

Highlight edited or added model elements and diagrams in the Browser.

Show code engineering sets

Shows code engineering sets items in the browser.

Show diagram zoom slider

Shows zoom slider in the Zoom Control tab.

Show full types in browser

Shows the full attributes, operations, and relationships data.

Show hyperlinks in browser

Shows hyperlinks that are assigned to the model elements.

Show stereotypes in browser

Shows stereotypes that are assigned to the model elements.

Sort always Always alphabetically sort browser items.

Property name Function 2005 No Magic, Inc 2-30

2-


2T E A M W O R K P A N E

Figure 4 -- Environment Options dialog box. Teamwork pane


Auto login to server

The user automatically logs on to the Teamwork Server after starting MagicDraw.

Teamwork server name

Shows the name of your teamwork server.

Show commit warning

The warning appears while committing project to the Teamwork Server.

Show modules versions conflict warning

The warning appears when two modules (or module and a project) use the same submodules.31 2005 No Magic, Inc.


2F L O A T I N G P A N EThis pane is available only if you use MagicDraw Floating License.

Figure 5 -- Environment Options dialog box. Floating pane


Floating license server name

Specify the name of the Floating License Server.

Floating license server port

Enter the port number of the Floating License Server. The server may be started on many different ports.

Auto login to floating license server

If selected, automatically logs in to the Floating License Server when starting MagicDraw. 2005 No Magic, Inc 2-32

2-


2C V S P A N E

Figure 6 -- Environment Options dialog box. CVS pane


Add project to CVS after saving

Every time adds a newly created project in the checked out directory to CVS. The Add Project to CVS dialog box appears.

Commit project to CVS after saving

Updates the project that is added to CVS while loading. The Update CVS Project dialog box appears.

Update project from CVS before loading

Commits project to CVS after saving it. The Commit Project to CVS dialog box appears.

Location of .cvspass

The path where the .cvspass is located. You may type it or choose 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.33 2005 No Magic, Inc.


2U P D A T E P A N E

Figure 7 -- Environment Options dialog box. Update pane


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 confirmation dialog box

If selected, shows the confirmation dialog each time before auto-checking. 2005 No Magic, Inc 2-34

2-


2H T T P P R O X Y P A N E

Figure 8 -- Environment Options dialog box. HTTP Proxy pane


Use HTTP proxy server

If selected, uses the Http Proxy Server when MagicDraw is checking for updates.

HTTP proxy server address

Type the Http Proxy Server name or IP address.

HTTP proxy server port

Type the port of the HTTP Proxy Server. The default number is 8080.

HTTP proxy server user

Type the name of the Http Proxy Server user.

Authenticate HTTP proxy server

Authenticates Http Proxy Server.35 2005 No Magic, Inc.


2K E Y B O A R D P A N E

Figure 9 -- Environment Options dialog box. Keyboard pane


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 shortcut key

The field for entering the new key. Puts a human representation of any 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 assigned to

Shows the name of the command of the entered new key if this key is already assigned to some command. By default is hidden. This label is visible just if entered key is already assigned to some command. 2005 No Magic, Inc 2-36

Assign Assigns the entered key to the selected command. The entered key is added to the Current Keys list.

2G E T T I N G S T A R T E DSet t ing Personal Preferences

2P L U G I N S P A N E

Figure 10 -- Environment Options dialog box. Plugins pane

Remove Removes the selected keys from the selected command.

Remove All Removes all keys from the selected command.


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.

Property name Function-37 2005 No Magic, Inc.


2R E S O U R C E S P A N EDisplays the external resources such as dtd, xsd, etc. that are used in MagicDraw.

Figure 11 -- Environment Options dialog box. Resources pane


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 2005 No Magic, Inc 2-38

Resource dialog box.

2-


2P A T H V A R I A B L E S P A N E

Add Add a new external resource that will be ignored.

Remove Remove the selected ignored resource from the list.

Property name Function39 2005 No Magic, Inc.


2L A U N C H E R P A N E

Figure 12 -- Environment Options dialog box. Launcher pane

Look and Feel : Control l ing In ter face

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


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. 2005 No Magic, Inc 2-40


2To 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

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

Theme Description

Metal Standard Java Swing library (default)

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.2-41 2005 No Magic, Inc.


2 Khaki

Kunststoff Theme

Custom set your own options in the Properties dialog box.

J I D E A N D M U L T I P L E W I N D O W S I N T E R F A C E S T Y L E SSince 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 tools 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.2-42 2005 No Magic, Inc.

W O R K I N G W I T H P R O J E C T S 3

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 44

2 "Saving and Exporting", on page 463 "Loading", on page 504 "Project Options. Style Engine", on page 515 "Modules Functionality. Reusing project part - Partitioning", on page 636 "Profiles", on page 747 "Model Differencing", on page 768 "Working with multiple projects", on page 839 "Using Browser", on page 8410"Searching", on page 9911"MagicDraw and Rational Rose", on page 10412"MagicDraw and Together ControlCenter", on page 10913"Resources Manager", on page 114

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, 2005 No Magic, Inc. 3-44

and stereotypes, which are UML standard and can be used in various cases. The

WO R K I N G WI T H PR O J E C T SCreat ing New Project

3following 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.

Creat ing new project f rom al ready 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. 3-45 2005 No Magic, Inc.

WO R K I N G WI T H PR O J E C T SSaving and Expor t ing

3To open the New From Template dialog box

From the File menu, choose New From Template.

Figure 14 -- 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.

Impor t ing 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 EXPORTINGIMPORTANT!Beginning with MagicDraw version 3.6, the native MagicDraw format is .xml. 2005 No Magic, Inc 3-46

Saving in .mdf format is not allowed.


3To 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 15 -- 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 2-24.

Expor t ing project as template

You may save (export) the created project as a template and use the same project for 3-47 2005 No Magic, Inc.

creating other new projects.


3To 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 16 -- Export Template dialog box

Sav ing 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)

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 2005 No Magic, Inc 3-48

Scalable Vector Graphics (*.svg)


3 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 17 -- Save As Image dialog box

The filename of the saved diagram will be the same as the name of that diagram.3-49 2005 No Magic, Inc.

WO R K I N G WI T H PR O J E C T SLoading

3The 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.

LOADINGIMPORTANT! 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 2005 No Magic, Inc 3-50

MagicDraw. The project is started at once.

NOTES:

WO R K I N G WI T H PR O J E C T SProject Opt ions. S ty le Engine

3If 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 v1.0, v 1.1 and v1.2 are native MagicDraw file formats for model storage. But these 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 Unisys XMI 1.0. If your tool does not support Unisys XMI 1.0, you will not be able fully (with diagrams) exchange the model. More about interchange with Rational Rose ant Together ControlCenter, see in Section MagicDraw and Rational Rose on page 3-104 and Section MagicDraw and Together ControlCenter on page 3-109.

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 ENGINEStyle 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.

Pro ject Opt ions

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.3-51 2005 No Magic, Inc.


3To change the default project options and Code Engineering tasks

From the Options main menu, choose Project. The Project Options dialog box appears.

Figure 18 -- Project Options dialog box

The Project Options dialog box has several collections of customizable options:

To find elements to change, browse the options tree in the Project Options dialog box. The items in this hierarchy are either:

General Project Options

Define the default packages where the extension elements 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 Styles

Expands tree hierarchy of all the styles defined within the 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 users guide. 2005 No Magic, Inc 3-52

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


3your 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:

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.

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.3-53 2005 No Magic, Inc.


3To 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 Y M B O L S P R O P E R T I E S S T Y L E S T R E EExpands 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. 2005 No Magic, Inc 3-54


3Figure 19 -- 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 constraints 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.3-55 2005 No Magic, Inc.


3Show 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 Operations

Shows additional information sign in the class, artifact or 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 Direction Kind

Show Operations Properties

Show Operations Visibility

Shows the direction kind for operations parameters

Shows tagged values and concurrency of an operation.

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) 2005 No Magic, Inc 3-56


3Stereotype Color

Stereotype Font

Show Stereotypes

Show ConstraintsShow Tagged Values

The color that will be used to draw stereotypes. The Color dialog box appears.

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

Shows stereotype labels on symbols.

Shows constraints on symbols.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 Elements

Hides specification elements of a subsystem.

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.

Property Function (when selected)3-57 2005 No Magic, Inc.


3Working wi th Proper t ies S ty le s

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 R O P E R T I E S E X T E N S I O N B Y D I A G R A MDiagrams, 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 20 -- Element extension by diagram 2005 No Magic, Inc 3-58


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

Figure 21 -- 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 22 -- 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 23 -- Remove extended diagram

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

P R O P E R T I E S I N H E R I T A N C EAll element properties have inherited check box. This check box indicates if property is derived from the base element properties, or is it specific.3-59 2005 No Magic, Inc.


3The 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 E N E R A L S T Y L E P R O P E R T I E SYou 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 H A P E S , P A T H S A N D D I A G R A M S P R O P E R T I E SAll 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 24 -- Select Diagrams dialog box 2005 No Magic, Inc 3-60


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

Figure 25 -- 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 T E R E O T Y P E S P R O P E R T I E SStereotypes 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.3-61 2005 No Magic, Inc.


3To 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 26 -- 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 2005 No Magic, Inc 3-62

Apply Default Symbol Style button.

WO R K I N G WI T H PR O J E C T SModules Funct ional i t y. Reus ing project par t - Par t i t ioning

3To 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.

MODULES FUNCTIONALITY. REUSING PROJECT PART - PARTIT IONING

Partitioning functionality it is the segmentation of the MagicDraw project into multiple independent parts, called modules. This functionality is based on referencing. These modules are saved using the same file format, as do regular MagicDraw projects, so the modules can be opened and edited in any MagicDraw client application. This approach allows easy reuse of the same basic model libraries in multiple projects.

Work ing wi th modules

E X P O R T I N G P R O J E C T M O D U L EThe export module action saves the content of the selected package into a separate file. Exporting module is the only way to create a module. The package and all the containing elements after exporting have a readonly status. The module name is displayed in the brackets near the package name in the Browser tree.3-63 2005 No Magic, Inc.


3To 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 appears.

Figure 27 -- The Select Package dialog box for module exportation

2 In the All Data list, select the package, which you want to be saved as a separate module. Click the Add button. The package will be placed to the Selected Objects list.

3 If desired, type the description of the module, which will be displayed in as the documentation of the package.

4 Click OK. The Save dialog box appears.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 a package, which you want to be saved as a separate module (multiple packages selection is possible).

2 From the package shortcut menu, choose Modules, and then choose Export Module. The Export Profile/Module dialog box appears.

3 In the All Data list, select the package, which you want to be saved as a 2005 No Magic, Inc 3-64

separate module. Click the Add button. The package will be placed to the Selected Objects list.


34 If desired, type the description of the module, which will be displayed in as the documentation of the package.

5 Click OK. The Save dialog box appears.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. In order to export the created

diagram, you have to move it to the package, which contains elements to export.

U S I N G P R O J E C T M O D U L EThe use module action opens the module for using it in the project. Module will be loaded in a read-only status. You may use this module in your project, although for editing you have to import this module or open it as a separate project.

To use module in the project

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

project and click OK.

I M P O R T I N G P R O J E C T M O D U L EAfter the module is opened for use or when exported, it is in the read-only status. The import module action makes a package and entire inner elements editable. Module model after importing is merged with the project model.

To make module editable

In the Browser tree, from the module shortcut menu, choose Modules and then choose Import.

NOTE: There is another way to change modules content and make inner elements editable use the Open Module As Project command. A module will be opened as a separate project.

S H A R I N G P A C K A G E SSince MagicDraw version 8.0, a new concept of shared packages is presented. Module editing limitations now are removed and if module is opened as a project, it is treated as regular MagicDraw project only includes shared packages.

Packages can be shared only if they are not dependent on other model (the same principle as now in "export module"). If project has shared packages, dependencies should be checked on every saving.

Every project that has "shared packages" can be used in other projects as a module. When opening it as a module, only shared packages will be loaded from this project file and used "read only", other packages and all project related information remains not loaded. If there are no shared packages, this project can't be used as a module.3-65 2005 No Magic, Inc.


3To share a package

1 Create package. Select it in the Browser. Invoke model element shortcut menu, select the Modules command and then the Shared Packages command. The Shared Packages dialog box appears.

2 In the Shared Packages dialog box, the Selected Objects tree, package you want to share is selected. Click OK. If package doesn't have dependencies with not shared packages, it is shared.

After package is shared, in the Browser, next to the shared package name appears word [shared].

To share few packages at the same time

1 Select few packages in the Browser and then invoke the Shared Packages dialog box. In the Shared Packages dialog box, the Selected Objects tree, packages you want to share are selected.

2 In the Shared Packages dialog box, you may add packages you want to share. To do this, in the All Data tree, select packages you want share and click the Add button. Click Ok button.

TIP Not only package can be shared, but model and subsystem too. 2005 No Magic, Inc 3-66


3To unshare shared package

1 Select shared package in the Browser. Invoke shared package shortcut menu, choose the Modules command and then the Shared Packages command. The Shared Packages dialog box appears.

2 In the Shared Packages dialog box, the Selected Objects tree are listed shared packages. So, in the Selected Objects tree, select the package or packages you want to unshare, and click Remove. If you want to unshare all shared packages, click on the Remove All button.

Restrictions of shared packages usage

Actions which are not allowed with shared packages:

Shared package can not include module. This is so, because shared package is module itself.For example, draw parent package p1 and package inside it p2. Invoke the Shared Packages dialog box. To the Selected Objects list add the p1 package. In the All Data tree, select the p2 package. Message appears: p2 parent package p1 is already selected. If you will move shared package p1 to other shared package p2, [shared] words removes from p2 package, because parent package is shared. Move p2 package from p1 package, next to the package name [shared] is written again.

Cannot export package with inner shared package.

O P E N I N G M O D U L E A S A P R O J E C TSince MagicDraw version 8.0, after opening module as a separate project, all available packages, are enabled for editing, with the correspon

Documents

MagicDraw UserManual