Magicdraw Manual.Book
Total Page:16
File Type:pdf, Size:1020Kb
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 3 © 2004 No Magic, Inc. MagicDraw User’s ManuaI Contents 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 © 2004 No Magic, Inc. 4 MagicDraw User’s Manual Contents 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 5 © 2004 No Magic, Inc. MagicDraw User’s ManuaI Contents 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 © 2004 No Magic, Inc. 6 MagicDraw User’s Manual Contents 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 7 © 2004 No Magic, Inc. MagicDraw User’s ManuaI Contents 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 © 2004 No Magic, Inc. 8 MagicDraw User’s Manual Contents 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 9 © 2004 No Magic, Inc.