Extending UML With Enterprise Architect Enterprise Architect is an intuitive, flexible and powerful UML analysis and design tool for building robust and maintainable software. This booklet explains how to use Enterprise Architect to extend the scope of UML in developing models. © Copyright 1998-2009 Sparx Systems Pty Ltd Extending UML With Enterprise Architect © 1998-2009 Sparx Systems Pty Ltd All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the written permission of the publisher. Products that are referred to in this document may be either trademarks and/or registered trademarks of the respective owners. The publisher and the author make no claim to these trademarks. While every precaution has been taken in the preparation of this document, the publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it. In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document. Printed: September 2009 Special thanks to: Publisher All the people who have contributed suggestions, examples, bug Sparx Systems reports and assistance in the development of Enterprise Architect. The task of developing and maintaining this tool has been greatly Managing Editor enhanced by their contribution. Geoffrey Sparks Technical Editors Brad Maxwell Simon McNeilly Neil Capey Nithiya Ugavina Vimal Kumar Sharon Xie Sam Mancarella Contents I Table of Contents Foreword 1 Extending UML 2 UML Profil.e..s.. .............................................................................................................................. 3 Use Profile..s.. ...................................................................................................................................................... 4 Import .a.. .U...M...L.. .P..r..o..f.il.e.................................................................................................................................... 5 Add Pr.o..f.i.l.e.. .O...b..je..c..t.s.. .a..n..d.. .F..e..a..t.u..r.e..s.. .t.o.. .a.. .D...i.a..g..r.a..m........................................................................................... 6 Tagged.. .V...a..l.u..e..s. .i.n.. .P...r.o..f.i.le..s............................................................................................................................ 7 Synchr.o..n..i.z..e.. .T..a..g..g..e..d.. .V...a..lu..e..s.. .a..n..d.. .C...o..n..s..t.r.a..i.n..t.s............................................................................................. 7 Profile Ref.e..r..e..n..c..e..s.. ........................................................................................................................................... 9 Suppo.r.t.e..d.. .T..y..p..e..s......................................................................................................................................... 9 Profile.. .S...t.r.u..c..t.u..r.e......................................................................................................................................... 10 Attrib.u..t.e..s. .S...u..p..p..o..r.t.e..d.. .i.n.. .X..M...L.. .P...r.o..f.i.le........................................................................................................... 11 Exam.p..l.e.. .P...r.o..f.i.le.......................................................................................................................................... 12 UML Ster.e..o..t..y..p..e..s.. .................................................................................................................... 14 Apply Ste.r..e..o..t.y..p..e..s.. .......................................................................................................................................... 15 Stereotyp..e.. .S..e..l.e..c..t.o..r.. ....................................................................................................................................... 16 Stereotyp..e.. .V..i.s..i.b..i.l.i.t.y.. ....................................................................................................................................... 17 Standard. .S..t.e..r..e..o..t.y..p..e..s.. .................................................................................................................................... 18 Stereotyp..e..s.. .w..i.t..h.. .A..l.t..e..r.n..a..t.i.v..e.. .I.m...a..g...e..s.. ........................................................................................................... 19 UML Patt.e..r.n...s.. .......................................................................................................................... 21 Create a P...a..t.t.e..r.n... ............................................................................................................................................. 21 Import a P...a..t.t.e..r..n.. ............................................................................................................................................. 24 Use a Pat.t..e..r.n.. .................................................................................................................................................. 24 MDG Tec.h..n..o...l.o..g..i.e..s.. ................................................................................................................. 27 Import M.D...G... .T..e..c..h..n..o...l.o..g..i.e..s.. ........................................................................................................................... 27 Manage M...D..G... .T..e..c..h..n...o..l.o..g..i.e..s.. .......................................................................................................................... 29 Acces..s.. .R..e..m...o..t.e.. .M...D...G... .T..e..c..h..n..o..l.o..g..i.e..s......................................................................................................... 30 Work with.. .M...D...G... .T..e..c..h..n...o..l.o..g..i.e..s.. ...................................................................................................................... 31 Archimat.e.. ....................................................................................................................................................... 34 BPEL .......................................................................................................................................................... 36 Creat.e.. .a.. .B..P...E..L.. .M...o..d..e..l............................................................................................................................... 37 Mode.l. .a.. .B..P...E..L.. .P...r.o..c..e..s.s.............................................................................................................................. 39 Model Start .E...v..e..n..t............................................................................................................................... 40 Model End E...v.e..n..t................................................................................................................................. 43 Model Interm...e..d..i.a..t.e.. .E..v..e..n..t................................................................................................................... 46 Model Gate.w..a..y.................................................................................................................................... 50 Model Activ.it.y....................................................................................................................................... 52 Model Pool......................................................................................................................................... 57 Creat.e.. .A...s.s..i.g..n..m...e..n..t.s.................................................................................................................................. 58 Gene.r.a..t.e.. .B...P..E..L.......................................................................................................................................... 60 Creat.e.. .a.. .B...P..E..L.. .W....e..b.. .S..e..r.v..i.c..e..................................................................................................................... 61 BPEL. .M...o..d..e..l. .V...a..li.d..a..t.i.o..n.............................................................................................................................. 62 BPMN .......................................................................................................................................................... 64 Chan.g..e.. .B..P...M...N.. .E...le..m...e..n..t. .A...p..p..e..a..r.a..n..c..e........................................................................................................ 67 Data Flow.. .D...i.a..g..r.a..m....s.. ...................................................................................................................................... 68 ICONIX .......................................................................................................................................................... 69 Mind Map..p..i.n..g... ................................................................................................................................................ 72 SoaML .......................................................................................................................................................... 74 SPEM .......................................................................................................................................................... 76 SPEM.. .T...o..o..lb..o..x.. .P...a..g..e..s............................................................................................................................... 78 SysML .......................................................................................................................................................... 82 © 1998-2009 Sparx Systems Pty Ltd II Contents SysM.L.. .P...a..r.a..m...e..t.r.i.c.. .M...o..d..e..ls......................................................................................................................... 83 Simul.a..t.e.. .a.. .S...y.s..M...L.. .M...o..d..e..l.......................................................................................................................... 86 Business. .M...o...d..e..l.i.n..g.. ................................................................................................................. 89 Process M...o..d...e..l.i.n..g.. .N...o..t.a..t.i.o..n... .......................................................................................................................... 90 Inputs, R.e..s..o..u..r.c..e..s.. .a..n...d.. .I.n..f.o..r..m...a..t.i.o..n... ............................................................................................................. 91 Events .......................................................................................................................................................... 92 Outputs .......................................................................................................................................................... 92 Goals .......................................................................................................................................................... 92 A Comple..t.e.. .B...u..s..i.n..e..s..s.. .P..r..o..c..e..s..s.. ..................................................................................................................... 93 Business. .R...u..l.e.. .M...o..d..e..l.i.n...g.. ............................................................................................................................... 93 Creat.e.. .a.. .F..a..c..t. .M...o..d..e..l................................................................................................................................. 95 Creat.e.. .a.. .R...u..le.. .F..l.o..w... .M...o..d..e..l........................................................................................................................ 96 Mode.l. .B..u..s..i.n..e..s..s.. .R..u..l.e..s............................................................................................................................... 99 Com..p..o..s..e.. .B..u..s..i.n..e..s.s.. .R...u..l.e..s....................................................................................................................... 101 Cod.e.. .G...e..n..e..r.a..t.i.o..n.. .F..o..r. .B..u..s..i.n..e..s..s.. .R..u..l.e..s..................................................................................................... 105 Index 108 Extending UML With Enterprise Architect Foreword 1 Foreword This user guide explains how to use Enterprise Architect to extend the scope of UML in developing models. © 1998-2009 Sparx Systems Pty Ltd 2 | Extending UML Enterprise Architect enables you to create models using UML. However, it also enables you to go much further, extending the scope both of your modeling and of the UML components you use, as outlined below. Requirements Management Gathering requirements is typically the first step in developing a solution, be it for developing a software application or for detailing a business process. Requirements are essentially 'what the system must do'. The requirements management built into Enterprise Architect provides full support for defining, organizing and managing the requirements that drive the project. For further information, see Requirements Management in Enterprise Architect. UML Stereotypes Stereotypes are an inbuilt mechanism for logically extending or altering the meaning, display and syntax of a model element. Different model elements have different standard stereotypes associated with them. You can also define your own stereotypes. For further information on stereotypes, see the UML Stereotypes 14 topic. UML Profiles UML Profiles are a means of extending UML, which enables you to build models in particular domains. A Profile is a collection of additional stereotypes and Tagged Values applied to elements, attributes, methods and connectors, which together describe some particular modeling problem and facilitate modeling constructs in that domain. For further information on Profiles, see the UML Profiles 3 topic. UML Patterns Patterns are groups of collaborating Objects/Classes that can be abstracted from a general set of modeling scenarios (that is, parameterized collaborations). They generally describe how to solve an abstract problem, and are an excellent means of achieving re-use and building in robustness. For more information on Patterns, see the UML Patterns 21 topic. MDG Technologies The Model Driven Generation (MDG) Technologies enable you to access and use the resources of a specific technology within Enterprise Architect. Interfaces to some technologies, such as BPMN and Iconix, are integrated with Enterprise Architect, whilst interfaces to others such as Eclipse and Visual Studio can be added separately. You can also link to technologies that you have created yourself. For more information on MDG Technologies, see the MDG Technologies 27 topic. Business Modeling Modeling the business process 89 is an essential part of any software development process. It enables you to establish the broad outline and procedures that govern what it is a business does. As the Business Process Model typically has a broader range than just the software system being considered, it also enables you to clearly map what is in the scope of the proposed system and what is to be implemented in other ways. Extending UML With Enterprise Architect UML Profiles | 3 1 UML Profiles What are UML Profiles? UML Profiles provide a means of extending UML, which enables you to build UML models in particular domains. They are based on additional stereotypes and Tagged Values 9 that are applied to elements, attributes, methods, connectors, connector ends and so on. A Profile is a collection of such extensions that together describe some particular modeling problem and facilitate modeling constructs in that domain. For example, the UML Profile for XML describes a set of extensions to basic UML model elements to enable accurate modeling of XSD Schemas (see Modeling XML Applications with UML, David Carlson, p. 310). Enterprise Architect has a generic UML Profile mechanism 4 for loading and working with different Profiles. UML Profiles for Enterprise Architect are specified in XML files, with a specific format; see the examples 12 in this topic. You can import 5 these XML files into Enterprise Architect as part of an MDG Technology 27 or through the Resources window. Once imported, you can drag and drop Profile elements onto the current diagram. Enterprise Architect attaches the stereotype, Tagged Values and default values, notes and even metafile if one is specified, to the new element. You can also drag and drop attributes and operations onto existing Classes and have them immediately added with the specified stereotype and values. The imported Profile also automatically generates a page of elements and relationships in the Enterprise Architect UML Toolbox. Note: To control the appearance of elements, you can also set a default element template. For more information, see the Set Element Templates Package topic in UML Modeling With Enterprise Architect - UML Modeling Tool. Profiles in the Resources Window The Resources window contains a tree structure with entries for items such as MDG Technologies, Documents, Stylesheets, Matrix profiles and UML Profiles. The UML Profiles node initially contains no entries; to be able to use Profiles you must import them into Enterprise Architect from supplied XML files. © 1998-2009 Sparx Systems Pty Ltd 4 UML Profiles | Items in the Profile represent stereotypes. These can be applied to UML elements in the following ways: · Stereotypes that apply to elements such as Classes and interfaces can be dragged directly from the Resources window to the current diagram, automatically creating a stereotyped element. Alternatively, they can be dragged onto existing elements, automatically applying them to the element. · Stereotypes that apply to attributes can be drag-and-dropped onto a host element (such as a Class); a stereotyped attribute is automatically added to the element's feature list. · Stereotypes that apply to operations are like those that apply to attributes; drag-and-drop onto a host element to add the stereotyped operation. · Stereotypes that apply to connectors such as associations, generalizations, messages and dependencies are added by selecting them in the Project Browser, then clicking on the start element in a diagram and dragging to the end element (in the same manner as adding normal connectors). A stereotyped connector is added. · Stereotypes that apply to association ends can be added by dragging the connector end element over the end of an association in the diagram. To get you started, some Profiles are supplied on the Sparx Systems website at www.sparxsystems.com/ uml_profiles.htm. You can download these and import them into Enterprise Architect. Over time Sparx Systems intend to expand the range of Profiles, the content of each Profile and the degree of customization possible in each Profile. You can also create your own Profiles to describe modeling scenarios specific to your development environment. For more information see SDK for Enterprise Architect 1.1 Use Profiles This topic describes the use of Profiles for UML modeling, including the following tasks: · How to import a UML Profile 5 for use in a model · How to add Profile Objects and Features to a diagram 6 · Use of Tagged Values in Profiles 7 · How to synchronize stereotyped Tagged Values and constraints 7 Extending UML With Enterprise Architect UML Profiles | Use Profiles 5 A Technology Developer might create a new Profile, which they can save (export) to disk for future UML models. The processes of creating and exporting a new UML Profile are described in SDK for Enterprise Architect. 1.1.1 Import a UML Profile Note: This topic describes importing a stand-alone Profile. You can also embed Profiles in an MDG Technology and import the Technology file into the Enterprise Architect installation directory (see SDK for Enterprise Architect ). To import a Profile you must have a suitable Profile XML file, such as the Profiles supplied on the Sparx Systems website at www.sparxsystems.com/uml_profiles.htm. If the Profile includes references to any metafiles, they should be in the same directory as the Profile XML file. Import a Profile To import a Profile, follow the steps below: 1. Open the Resources window (View | Resources). 2. Right-click on the UML Profiles tree node and select the Import Profile context menu option. The Import UML Profile dialog displays. 3. Locate the XML Profile file to import using the [ ... ] (Browse) button. 4. Set the required import option checkboxes for all stereotypes defined in the Profile; you can select: · Element Size - to import the element size attributes · Color and Appearance - to import the color (background, border and font) and appearance (border thickness) attributes · Alternate Image - to import the metafile image · Code Templates - to import the code templates if they exist · Overwrite Existing Templates - to overwrite any existing code templates defined in the current project. 5. Click on the Import button. The Profile is added to the UML Profiles folder. © 1998-2009 Sparx Systems Pty Ltd 6 UML Profiles | Use Profiles If the Profile already exists, Enterprise Architect prompts you to overwrite the existing version and import the new one (or cancel). Once the import is complete, the Profile is ready to use 6 . 1.1.2 Add Profile Objects and Features to a Diagram After you have imported a Profile into the Resources window, the profiled objects (elements and connectors) and features (attributes and operations) are available from the expanded Profile folder in the window and from the appropriate pages of the Enterprise Architect UML Toolbox (click on the More tools option at the top of the Toolbox); see Using Enterprise Architect - UML Modeling Tool. Similarly, when you import an MDG Technology 27 , it adds the appropriate pages of profiled elements and connectors to the Toolbox. To add a Profile-based element to a diagram, click on the element in the Toolbox page or the Resources window, and drag it onto the diagram. To add a Profile-based connector to a diagram, click on the connector in the Toolbox page or Resources window, then click on the source element in the diagram and drag it to the target. You can also drag the connector from the Resources window to the source, which automatically displays the following list box. Select a target element from the list to create the connector to that target. To add a profile-based attribute or operation to a diagram, click on it in either the Toolbox page or the Resources window, and drag it onto the host element on the diagram. The system prompts you to enter a name for the feature. Extending UML With Enterprise Architect