Get Started EA UML Modeling

Getting Started With Enterprise
Architect

Enterprise Architect is an intuitive, flexible and powerful UML
analysis and design tool for building robust and maintainable
software.

This guide describes Enterprise Architect, how to set it up and
how to immediately start using it.

© Copyright 1998-2008 Sparx Systems Pty Ltd

Getting Started With Enterprise Architect

© 1998-2008 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: October 2008

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
Simon McNeilly
Bill Mioch
Brad Maxwell
John Redfern

Contents I

Table of Contents
Foreword 1

Enterprise Architect UML Tool 2
What is Enterprise Architect?
................................................................................................................................... 4
Uses of Enterprise Architect
.......................................................................................................................................................... 5
Key Features
.......................................................................................................................................................... 8
Differences Between Editions
.......................................................................................................................................................... 9
Sparx Systems MDG Add-Ins
.......................................................................................................................................................... 12
Help and ................................................................................................................................... 13
Support
Available..........................................................................................................................................................
Helpfile Formats 14
Support .......................................................................................................................................................... 15
Formal Statements
................................................................................................................................... 16
Copyright Notice
.......................................................................................................................................................... 17
End User..........................................................................................................................................................
License Agreement 18
Trademarks
.......................................................................................................................................................... 21
Acknowledgements
.......................................................................................................................................................... 22
If You Have the Trial Version
................................................................................................................................... 23
Order Enterprise Architect
.......................................................................................................................................................... 24
Installation
.......................................................................................................................................................... 25
Register ..........................................................................................................................................................
a Full License 26

Start UML Modeling 28
Work with Enterprise Architect
................................................................................................................................... 29
Modeling..........................................................................................................................................................
With UML 31
Manage UML Models
.......................................................................................................................................................... 32
Code Engineering
.......................................................................................................................................................... 33
Quick Start - Create a Project
................................................................................................................................... 34
Add a View to a Model
.......................................................................................................................................................... 36
Add a Package To a Model
.......................................................................................................................................................... 37
Add a Diagram to a Package
.......................................................................................................................................................... 38
Add Elements
.......................................................................................................................................................... 39
Add Connectors
.......................................................................................................................................................... 40
Define Properties
.......................................................................................................................................................... 41
Move Components
.......................................................................................................................................................... 43
Delete Components
.......................................................................................................................................................... 45
Save Changes
.......................................................................................................................................................... 46
Quick Start - Project Tasks
................................................................................................................................... 47

UML Tool Project Roles 49
Business................................................................................................................................... 50
Analysts
Software ................................................................................................................................... 52
Architects
Software ................................................................................................................................... 54
Engineers
Developers
................................................................................................................................... 55
Project Managers
................................................................................................................................... 57
Testers ................................................................................................................................... 58
Implementation Manager
................................................................................................................................... 59
Technology Developers
................................................................................................................................... 60
Database................................................................................................................................... 62
Administrators


II Contents

License Management 63
Finding Your License Information
................................................................................................................................... 64
Add License Key
................................................................................................................................... 65
Keystore................................................................................................................................... 67
Troubleshooting
Upgrade ................................................................................................................................... 68
an Existing License
Register Add-In
................................................................................................................................... 71

Index 72


Foreword 1

Foreword

This guide describes Enterprise Architect, how
to set it up and how to immediately start using it.


2 Enterprise Architect UML Tool | |

1 Enterprise Architect UML Tool

Welcome to Sparx Systems' Enterprise Architect, a UML 2.1 based modeling tool for designing and
constructing software systems, for business process modeling, and for generalized modeling purposes such
as visualizing existing systems and processes.
This user guide provides tutorials, guidance and reference material to help you use Enterprise Architect to
perform:
· UML Model Management
· Model Auditing
· Model Baselining and Differencing
· Model User Security
· Model Version Control
· Modeling With Enterprise Architect
· RTF and HTML Document Creation (Reports)
· Project Management
· Code Engineering
· Visualization of code execution (debugging)
· MDA Transformations

See What is Enterprise Architect? 4 for further details of what Enterprise Architect can do and what you can
use it for.
Enterprise Architect makes extensive use of UML, so we provide a UML Dictionary of diagrams, elements and
connectors. Enterprise Architect also includes a Software Developers' Kit (SDK for Enterprise Architect) that
enables you to extend and customize the tool.

To Use This Guide
If you are new to modeling and UML as well as Enterprise Architect, or otherwise want a rapid review of the
process of modeling with Enterprise Architect, go to the Getting Started with UML Modeling 28 tutorial. This is
not just a theoretical description - the first things you do are start Enterprise Architect and immediately create
a model project.
Enterprise Architect is very flexible and has lots of features. When working through Getting Started, you will
see many links to more extensive descriptions of features, functions, tasks and procedures, in Using
Enterprise Architect - UML Modeling Tool. You could read Using Enterprise Architect - UML Modeling Tool in
conjunction with this guide to get more information on any topic.
Using Enterprise Architect - UML Modeling Tool is the first of the main references for working with Enterprise
Architect. The documentation includes further Enterprise Architect guides for each of the subject areas listed
at the start of this topic.
You should read the Sparx Systems Formal Statements 16 , including the Copyright Notice and our End User
Licensing Agreement.

Your Feedback
Sparx Systems likes to stay in touch with what Enterprise Architect users require in order to accomplish their
tasks efficiently and effectively. We value any suggestions, feedback and comments you might have regarding
this product, documentation or install process.
You can access our online feedback pages at:


Enterprise Architect UML Tool | | 3

· www.sparxsystems.com/bug_report.htm and
· www.sparxsystems.com/feature_request.htm.
Alternatively, you can contact Sparx Systems by email at: support@sparxsystems.com.


4 Enterprise Architect UML Tool | What is Enterprise Architect? |

1.1 What is Enterprise Architect?

Powerful UML Analysis and Design Tool
Enterprise Architect is a comprehensive UML analysis and design tool, covering all aspects of the software
development cycle from requirements gathering, through analysis, model design, testing, change control and
maintenance to implementation, with full traceability. Enterprise Architect combines the power of the latest
UML 2.1 specification with a high performance, intuitive interface, to bring advanced modeling to the whole
development team. It is a multi-user, visual tool with a great feature set (see below), helping analysts, testers,
project managers, quality control staff and deployment staff around the world to build and document robust,
maintainable systems and processes.

The UML Modeling Tool of Choice, Globally
With over 150,000 licenses sold, Enterprise Architect has proven highly popular across a wide range of
industries and is used by thousands of companies world-wide. From large, well-known, multi-national
organizations to smaller independent companies and consultants, Enterprise Architect has become the UML
modeling tool of choice for developers, consultants and analysts in over 60 countries.
Sparx Systems software is used in the development of many kinds of application and system in a wide range
of industries, including: aerospace, banking, web development, engineering, finance, medicine, military,
research, academia, transport, retail, utilities (such as gas and electricity) and electrical engineering. It is also
used effectively for UML and enterprise architecture training in many prominent colleges, training companies
and universities around the world.
Now see:
· Uses of Enterprise Architect 5
· Enterprise Architect Key Features 8


Enterprise Architect UML Tool | What is Enterprise Architect? | Uses of Enterprise Architect 5

1.1.1 Uses of Enterprise Architect
Enterprise Architect is a powerful tool for specifying, documenting and building your software and business
process projects. Using Enterprise Architect's support for UML and its related standards, you can model
new complex software and business systems, or visualize and maintain existing systems.

Design and Build Diverse Systems Using UML
UML 2.1 is an open standard that provides a rich language for describing, documenting and designing
software, business and IT systems in general. Enterprise Architect enables you to leverage the full expressive
power of UML 2.1 to model, design and build diverse systems in an open and well understood manner. You
can generate code, database structures, documentation and metrics; transform models; or specify behavior
and structure as the basis for contractual agreements.
For further information, see the UML Dictionary.

Model and Manage Complexity
Enterprise Architect helps individuals, groups and large organizations model and manage complex
information. Often this relates to software development and IT systems design and deployment, but it can also
relate to business analysis and business process modeling. Enterprise Architect integrates and connects a
wide range of structural and behavioral information, helping to build a coherent and verifiable architectural
model, either what-is or what-will-be. Tools to manage version control, track and compare differences, audit
changes and enforce security help control project development and enforce compliance to standards.
For further information, see User Security in UML Models, Baseline UML Models, Version Control Within UML
Models Using Enterprise Architect and Auditing UML Models.

Share Models
Enterprise Architect enables you to share complete models or specific aspects of a model between members
of a team, including (through the 'Lite', read-only edition) stakeholders who can study a model but not change
or manage it. You can make the project .EAP file available on a shared network drive, or replicate the .EAP file
for complex distributed development. Alternatively, you can develop the project in one of several shared
DBMS repositories, such as SQL Server; My SQL; PostgreSQL; Oracle 9i, 10g or 11g; and Sybase ASA. You
can import and export data as XMI files to distribute and update frameworks and other package-based model
structures. You control changes through the version control repository. Enterprise Architect provides a data
transfer wizard that enables you to upsize or downsize the complete model for maximum flexibility, and it
enables you to export and import reference data so that you do not have to recreate it for related projects.
For further information, see UML Model Management.

Model, Manage and Trace Requirements
Enterprise Architect enables you to capture requirements and use full traceability from base requirements to
design, build, deployment and beyond. You can use impact analysis to trace from proposed changes to
original requirements, and build the 'right' system.
For further information, see UML Modeling with Enterprise Architect – UML Modeling Tool.

Develop Personal Views and Extracts of the Model
Enterprise Architect enables you to develop any number of different views of your model, or parts of it, either
for your personal use or for the use of your team. These Model Views are generated by reports, so they can
be set up to always show the current status of the selected view. The facility also enables you to create
Favorites folders of hyperlinks to frequently-used data structures.
For further information, see Using Enterprise Architect - UML Modeling Tool.

Track and Trace Model Structures
In even a small model, it can be difficult to locate packages, diagrams and elements, even if you apply a
rigorous naming and structure policy. Enterprise Architect has a wealth of facilities that enable you to locate
structures quickly and easily, through the Model Search, Element List, Auditing facility, Hierarchy window,
Relationship Matrix and reports. The Element menu, Diagram menu and Project Browser context menus also
enable you to locate elements in diagrams and in the Project Browser, and you can store hyperlinks to
important or commonly-used elements and diagrams in the Model Views. Finally, having located one element
you can import any related elements into a diagram in a single operation.


6 Enterprise Architect UML Tool | What is Enterprise Architect? | Uses of Enterprise Architect


Generate Documentation
Enterprise Architect provides powerful document generation and reporting tools with a full WYSIWYG
template editor for RTF or HTML output. You can generate complex and detailed reports from Enterprise
Architect with the information you require in the format your company or client demands.
For further information, see Report Creation in UML Models.

Generate and Reverse Engineer Source Code
Enterprise Architect supports generation and reverse engineering of source code for many popular languages,
including C++, C#, Java, Delphi, VB.Net, Visual Basic, ActionScript, Python and PHP. With a built in 'syntax
highlighting' source code editor, Enterprise Architect enables you to quickly navigate and explore your model
source code in the same environment. Code generation templates enable you to customize the generated
source code to your company specifications.
For further information, see Code Engineering Using UML Models.

Visualize, Inspect and Understand Complex Software
Software is complex and often hard to understand. You can use Enterprise Architect to reverse engineer code
in a wide range of software development languages and database repository schema, to understand static
structure. To complete the picture, use the unique built-in profiling and debugging tools to capture and
visualize executing software at run-time. Create run-time instances of model elements and invoke methods
using the built in Object Workbench.
You can also bring in complete frameworks from source code or Java .jar files - or even .Net binary
assemblies! By importing frameworks and library code, you can maximize re-use and understanding of your
existing investment.
For further information, see Code Engineering Using UML Models and Debug and Profiling in Enterprise
Architect.

Perform MDA Transformations
Model Driven Architecture (MDA) is an open standard designed to facilitate rapid application development in a
platform independent manner. Models can be built at a high level of abstraction and, using MDA based tools,
transformed into models and code targeting a specific platform or domain.
Enterprise Architect supports advanced MDA transformations using easily edited and developed
transformation templates. With built-in transformations for DDL, C#, Java, EJB and XSD, you can quickly
develop complex solutions from simple platform independent models (PIMs) targeted at platform specific
models (PSMs). One PIM can be used to generate and synchronize multiple PSMs, providing a significant
productivity boost.
For further information, see the MDA Transformations User Guide.

Model Databases
Enterprise Architect enables you to reverse engineer from many popular DBMS systems, including Oracle 9i,
10g or 11g; SQL Server; My SQL; Access and PostgreSQL. You can model database tables, columns, keys,
foreign keys and complex relationships using UML and an inbuilt data modeling profile, and forward generate
DDL scripts to create target database structures.
For further information, see Code Engineering Using UML Models.

Customize Enterprise Architect
Enterprise Architect also includes a Software Developers' Kit that enables experienced tool developers to
customize and extend Enterprise Architect to suit the specific requirements of their organization with, for
example, in-house UML Profiles, Add-Ins and Code Templates. The very detailed Automation Interface gives
you access to most element features, major functions such as XMI import/export, and attached information.
Most properties are fully writable from the automation client. The Automation Interface provides great support
for plug-ins, with the ability to embed automation client windows in the main diagram view. The Interface is
accessible from any automation-aware client language, such as VB, C#, C++ and Delphi.
For further information, see SDK for Enterprise Architect.


Enterprise Architect UML Tool | What is Enterprise Architect? | Uses of Enterprise Architect 7

Link Enterprise Architect to IDEs
Using Sparx Systems Model Driven Generation (MDG) Link plug-ins, you can develop source code in your
preferred Integrated Development Environment such as Visual Studio .NET or Eclipse, use Enterprise
Architect to locate the source code for Classes, attributes and operations, and to model, navigate, track,
reverse engineer, build and run your project.
The MDG Integration products for Eclipse and Visual Studio 2005 provide an even closer, seamless
integration of Enterprise Architect and UML 2.1 with your IDE, bringing the functionality required of a fully
fledged modeling platform right inside the IDE.


8 Enterprise Architect UML Tool | What is Enterprise Architect? | Key Features

1.1.2 Key Features
Enterprise Architect is renowned for its rich feature set. Some of the key features are highlighted in the
following list:
· Model complex information, software and hardware systems using UML-compliant notation
(comprehensive UML 2.1 support for all 13 UML diagrams)
· Extended modeling for Requirements, User Interface Design, Mind Mapping, Data Modeling and more
· Built-in Requirements Management enables you to specify, trace and verify requirements directly against
the design, right through to the deployed solution
· Comprehensive and flexible MS Word-compatible HTML and RTF report options
· Leverage industry-standard Enterprise Architecture frameworks (Zachman, TOGAF, DoDAF-MODAF)
· Support in forward and reverse code engineering for many languages ‘out of the box’: ActionScript 3.0,
Java, C#, C++, VB.Net, Delphi, Visual Basic , Python and PHP
· Ability to perform database modeling, to reverse engineer from a range of DBMSs via ODBC, and to
forward generate DDL scripts to create database structures
· Manage, track and control change using baseline model merge and auditing capabilities
· Centralize enterprise-wide documentation of processes and information systems
· Model dependencies between elements, system dynamics and state
· Model class hierarchies, deployment, components and implementation details
· Record project issues, tasks and system glossary
· Assign resources to model elements and track effort expended against required effort
· Testing support for test cases, JUnit and NUnit
· Integrated Debug Workbench for profiling executable Java and .Net applications, instantiating run-time
model objects and generating Sequence diagrams from a stack trace
· Manage Version control using any Common Source Code Control (SCC)-compliant tool and XMI
· Inbuilt user and group security and access control management
· Distributed development through shareable files, use of shared repositories in a range of major
Database Management Systems, file replication, data transfer, and import and export of reference data
· Share models using the latest XMI 2.1 format
· Import models from other tools in XMI format
· Built-in Model Driven Architecture (MDA) Transformations, and facilities to import or create others
· Facilities to import database schema, XSD and WSDL source, .NET and Java binaries
· Software Developers' Kit for scripting and customizing Enterprise Architect
· A range of internal and external commercial MDG Add-Ins 12 to integrate the facilities of Enterprise
Architect with IDEs and other technologies, and templates to write your own
· Read-only Viewer enables stakeholders to view but not change milestone deliverables
· Price: Enterprise Architect is priced to outfit the entire team, making collaboration and team development a
real possibility
· Speed: Enterprise Architect is quick to load and a spectacularly fast performer, even with large models
· Scalability: Enterprise Architect supports single users and the development of small models, or many
concurrent users developing extremely large models, with equal ease
· Usability: many of our users agree, Enterprise Architect gets you started and productive quickly, with a rich
user interface and the ability to create patterns, templates, model views and 'favorites' collections of
commonly-used elements and diagrams

For a complete list of the new features of the latest version of Enterprise Architect, click on the Help | Read
Me menu option.

Enterprise Architect is available in three editions: Corporate, Professional and Desktop, each of which offers
a different range of features. For a comparison of the Enterprise Architect editions, see the Differences
Between Editions 9 topic.


Enterprise Architect UML Tool | What is Enterprise Architect? | Differences Between Editions 9

1.1.3 Differences Between Editions
Enterprise Architect is available in three editions: Corporate, Professional and Desktop. Functionality for
each version is described below:

Functionality Corporate Edition Professional Desktop Edition
Edition

.EAP Project Files P P P
Advanced UML 2.1 Modeling P P P
Business Process Modeling P P P
Shared Models P P X
Shared/Floating License Version P X X
Automation API & Scripting P P P
Source Code Engineering P P X
Database Engineering P P X
WSDL Engineering P P X
XML Schema/XSD Engineering P P X
Reverse Engineer Binaries (Java, .NET) P P X
Microsoft Access Repository P P P
SQL Server; MySQL; Oracle 9i, 10g and 11g;
PostgreSQL; MSDE; Adaptive Server Anywhere P X X
Database Repositories

Version Control P P P
Replication P P X
Profile/Metamodel Extensibility P P P
MDG Technologies (Create and Use) P P X
MDG Link for Eclipse and MDG Link for Visual
Studio.NET P P X
Security (Role Based) P X X
Shape Script Customization P P P
Test Management P P P
Auditing of model changes P X X
Baselines P X X
Compare (Diff) Utility P P X
Relationship / Traceability Matrix P P P


10 Enterprise Architect UML Tool | What is Enterprise Architect? | Differences Between Editions

Functionality Corporate Edition Professional Desktop Edition
Edition

Requirements Management P P P
Element List (Tabular Editing) P P P
Metadata/Repository Search P P P
Project Discussion Forum P P X
Project Data Transfer P X X
XMI Import and Export, Version 2.1, 1.2, 1.1, 1.0 P P P
MDA-Style Transformations P P X
Visualization (Debug) Of Applications P P X
Document Generation - RTF & HTML P P P
Report Customization - WYSIWYG Rich-text
Templates P P X
State Chart Editor P P P
Link RTF Documents To UML Elements P X X

Enterprise Architect Corporate Edition
Aimed at larger development teams, the Corporate edition supports everything in the Desktop and
Professional versions, plus the ability to connect to MySQL, SQL Server, PostgreSQL, Sybase Adaptive
Server Anywhere and Oracle 9i, 10g or 11g DBMS back ends as the shared repository. This provides
additional scalability and improved concurrency over the shared .EAP file approach to model sharing. User
security, user logins, user groups and user level locking of elements, user/group based security (with locking
at diagram and element levels) are also supported. Security comes in two modes: in the first mode, all
elements are considered 'writeable' until explicitly locked by a user or group; in the second mode, all elements
are considered locked until checked out with a user lock.
The Corporate edition is available in either standalone (fixed license) or Floating License form. The Corporate
Floating License arrangement is particularly useful for companies that manage a central store of license keys.
Floating license keys can be used by different employees over time, temporarily or permanently.

Enterprise Architect Professional Edition
Aimed at work groups and developers, the Professional edition supports shared projects through replication
and shared network files. This edition has an ActiveX interface for interrogating Enterprise Architect projects
and extracting information in XMI format. The Professional edition fully supports code import/export and
synchronization of model elements with source code. It enables reverse engineering SQL Server, MS Access
and Oracle 9i, 10g or 11g databases. Support for MDG Technologies and MDG Link (sold separately) is
included with the Professional version of Enterprise Architect. The shared repository available in the
Professional edition is restricted to the .EAP file format (JET database).

Enterprise Architect Desktop Edition
The Desktop edition is targeted at single developers producing UML analysis and design models.


Enterprise Architect UML Tool | What is Enterprise Architect? | Differences Between Editions 11

Tip:
In order to help you understand the differences between these editions and the advantages and limitations of
each, the Trial version of Enterprise Architect can be opened in any required configuration. When Enterprise
Architect starts, select the mode to trial; you can close down Enterprise Architect and restart it in another
mode for comparison.
The fully functional 30 day trial version of Enterprise Architect is available free of charge at www.
sparxsystems.com/bin/easetup.exe.
More information about Enterprise Architect editions is available on the Sparx Systems website.


12 Enterprise Architect UML Tool | What is Enterprise Architect? | Sparx Systems MDG Add-Ins

1.1.4 Sparx Systems MDG Add-Ins
Enterprise Architect is the core for a range of Model Driven Generation (MDG) Add-Ins that enable you to
extend its modeling capabilities to use more specialized, niche frameworks and profiles. Some of these, such
as ICONIX, BPMN, Data Flow Diagrams and Mind Mapping, are already provided with the Enterprise Architect
installer (see UML Modeling with Enterprise Architect.- UML Modeling Tool).
Enterprise Architect provides support for downloading MDG Technologies from external system files or
websites, or for creating your own easily with the Enterprise Architect MDG Technology Wizard. For further
information, see SDK for Enterprise Architect.
Sparx Systems also market a number of MDG products, as follows:
· MDG Technology For:
· Zachman Framework
· The Open Group Architecture Framework (TOGAF)
· Department Of Defense Architecture Framework - Ministry Of Defence Architecture Framework
(DoDAF-MODAF)
· Data Distribution Service (DDS)
· Systems Modeling Languages (SysML)
· Python (for Enterprise Architect versions 4.5 to 5.0, integrated in later versions) (* free product! *)
· CORBA (* free product! *)
· Java Beans (* free product! *)
· Testing (* free product! *)
· MDG Integration For:
· Eclipse 3.3
· Visual Studio 2005 and 2008
· Siemens PLM Teamcenter Systems Engineering (TcSE)
· MDG Link For
· Eclipse
· Visual Studio.Net
· Microsoft Visio (* free product! *)
· Telelogic DOORS
Over time, this list is being extended to include further products.

Product Information
For the latest list of available Add-Ins and an introduction to each product, including details of pricing,
purchasing and download options, see the Products Page on the Sparx Systems website. When you purchase
one of the Add-Ins, you receive one or more license keys and instructions on obtaining, installing and
registering the product.
The information page for most products provides a link to download the product User Guide in .pdf format.
The product User Guide can also be displayed as a .chm file online within the product itself. To access this
online help in Enterprise Architect, select the Add-Ins | <productname> | Help menu option.


Enterprise Architect UML Tool | Help and Support | 13

1.2 Help and Support

Enterprise Architect has three main help and information systems to assist you in using the product:
· Tasks Pane
· Enterprise Architect Help
· The Sparx Systems website.
In addition Sparx Systems recommend that you fully explore the sample project supplied with Enterprise
Architect. It assists you in learning to use Enterprise Architect and offers tips on getting the most out of
Enterprise Architect's features. Click on the EAExample option on the Enterprise Architect Start Page.
If you have purchased Enterprise Architect and are a registered user, you can also contact Sparx Support 15
to answer any queries or problems.

Tasks Pane
The Enterprise Architect Tasks Pane provides context-sensitive guidance, tools, demonstrations and other
online resources to help you understand any area of Enterprise Architect that you are interested in. The Tasks
Pane automatically displays on the right of the screen when you first open Enterprise Architect, showing the
Getting Started topics. You can select other task areas by clicking on the More tasks option in the toolbar.

Enterprise Architect Help
Enterprise Architect Help provides comprehensive documentation of Enterprise Architect and covers every
aspect and facility of the product. To access Help within Enterprise Architect:

· Click on the Help icon ( ) in the various toolbars
· Select the Help | Help Contents menu option
· Click on the Help button on a dialog (for Help specific to that dialog.
Enterprise Architect Help is extensive; if you cannot quickly locate the topic you require in the online contents
list, you can use one of two search facilities:
· Click on the Index tab, type in a keyword or key phrase appropriate to the subject you require help for, and
press [Enter]; double-click on the appropriate index item
· Click on the Search tab, type in a word or phrase to search for, and click on the List Topics button; double-
click on the required topic.
The Enterprise Architect Help is also available separately from the product, in different formats. See the
Available Helpfile Formats 14 topic.

Sparx Systems Website
The Sparx Systems website is also extensive, and provides information and announcements concerning the
company and its full range of products, as well as tutorials, white papers, templates and solutions. It also
provides a user forum and support network; Sparx Systems are highly responsive to user feedback and
requirements, and the web site enables rapid communication concerning problems, solutions and
enhancements.
You can access the web page and user forum within Enterprise Architect from the View | More Windows |
Web Browser menu option, and through the Tasks Pane Online Resources topics.
If you do not have Enterprise Architect open, the Sparx Systems website address is http://www.sparxsystems.
com/.
The user forum address is www.sparxsystems.com/cgi-bin/yabb/YaBB.cgi.


14 Enterprise Architect UML Tool | Help and Support | Available Helpfile Formats

1.2.1 Available Helpfile Formats
You can access the latest Enterprise Architect help files from the following locations:
· .CHM format: www.sparxsystems.com/bin/EA.chm
· .CHM format inside a .ZIP file: www.sparxsystems.com/bin/EAHelp.zip
· .PDF format: www.sparxsystems.com/bin/EAUserGuide.pdf
· .HTML format: www.sparxsystems.com/EAUserGuide/index.html
Version and release date information for the help files can be found at:
· www.sparxsystems.com/ea_downloads.htm#Helpfiles, or
· www.sparxsystems.com/registered/reg_ea_down.htm#Helpfiles (registered users).


Enterprise Architect UML Tool | Help and Support | Support 15

1.2.2 Support
Technical support for Enterprise Architect is available to registered users. Responses to support queries are
sent by email. Sparx Systems endeavors to provide a rapid response to all product-related questions or
concerns.
Registered users can lodge a support request, by visiting:
http://www.sparxsystems.com/registered/reg_support.html.
Trial users can contact Sparx Systems with questions regarding their evaluation at:
support@sparxsystems.com.
An online user forum is also available for your questions and perusal, at
http://www.sparxsystems.com/cgi-bin/yabb/YaBB.cgi.


16 Enterprise Architect UML Tool | Formal Statements |

1.3 Formal Statements

Please take the time to read the following legal statements concerning Sparx Systems Enterprise Architect:
· Software Copyright Notice 17
· Enterprise Architect End User Licensing Agreement 18

· Acknowledgement of Trademarks 21
Spark Systems would also like to gratefully acknowledge contributions 22 to the development of Enterprise
Architect.


Enterprise Architect UML Tool | Formal Statements | Copyright Notice 17

1.3.1 Copyright Notice

Copyright © 1998 - 2008 Sparx Systems Pty. Ltd. All rights reserved.
The software contains proprietary information of Sparx Systems Pty Ltd. It is provided under a license
agreement containing restrictions on use and disclosure and is also protected by copyright law. Reverse
engineering of the software is prohibited. Please read the license agreement 18 for full details.
Due to continued product development, this information can change without notice. The information and
intellectual property contained herein is confidential between Sparx Systems and the client and remains the
exclusive property of Sparx Systems. If you find any problems in the documentation, please report them to us
in writing. Sparx Systems does not warrant that this document is error-free. No part of this publication may be
reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical,
photocopying, recording or otherwise without the prior written permission of Sparx Systems. Licensed users
are granted the right to print a single hardcopy of the user manual per licensed copy of the software, but may
not sell, distribute or otherwise dispose of the hardcopy without written consent of Sparx Systems.
Sparx Systems Pty. Ltd.
7 Curtis St,
Creswick, Victoria 3363,
AUSTRALIA
Phone: +61 (3) 5345 1140
Fax: +61 (3) 5345 1104
Support Email: support@sparxsystems.com
Sales Email: sales@sparxsystems.com
Website: www.sparxsystems.com


18 Enterprise Architect UML Tool | Formal Statements | End User License Agreement

1.3.2 End User License Agreement
Enterprise Architect - UML CASE Tool - Desktop, Professional and Corporate editions, Version 7.1

Copyright (C) 1998-2008 Sparx Systems Pty Ltd. All Rights Reserved
IMPORTANT- READ CAREFULLY: This End User License Agreement ("EULA") is a legal agreement
between YOU as Licensee and SPARX for the SOFTWARE PRODUCT identified above. By installing,
copying, or otherwise using the SOFTWARE PRODUCT, YOU agree to be bound by the terms of this EULA. If
YOU do not agree to the terms of this EULA, promptly return the unused SOFTWARE PRODUCT to the place
of purchase for a full refund.
The copyright in the SOFTWARE PRODUCT and its documentation is owned by Sparx Systems Pty Ltd A.B.N
38 085 034 546. Subject to the terms of this EULA, YOU are granted a non-exclusive right for the duration of
the EULA to use the SOFTWARE PRODUCT. YOU do not acquire ownership of copyright or other intellectual
property rights in any part of the SOFTWARE PRODUCT by virtue of this EULA.
Your use of this software indicates your acceptance of this EULA and warranty.

DEFINITIONS
In this End User License Agreement, unless the contrary intention appears:
· "ACADEMIC EDITION" means an edition of the Software Product purchased for educational purposes at
an academic discount price.
· "EULA" means this End User License Agreement.
· "SPARX" means Sparx Systems Pty Ltd A.B.N 38 085 034 546.
· "Licensee" means YOU, or the organization (if any) on whose behalf YOU are taking the EULA.
· "Registered Edition of Enterprise Architect" means the edition of the SOFTWARE PRODUCT which is
available for purchase from the web site: http://www.sparxsystems.com/products/ea/purchase.html.
following the thirty day free evaluation period.
· "SOFTWARE PRODUCT" or "SOFTWARE" means Enterprise Architect, UML Case Tool, Desk top,
Professional and Corporate editions, which includes computer software and associated media and printed
materials, and may include online or electronic documentation.
· "Support Services" means email based support provided by SPARX, including advice on usage of
Enterprise Architect, investigation of bugs, fixes, repairs of models if and when appropriate and general
product support.
· "SPARX support engineers" means employees of SPARX who provide on-line support services.
· "Trial edition of Enterprise Architect" means the edition of the SOFTWARE PRODUCT which is available
free of charge for evaluation purposes for a period of 30 days.
· "EA LITE" means the LITE version of Enterprise Architect that is distributed free of charge as a read-only
viewer of .EAP files.

GRANT OF LICENSE
In accordance with the terms of this EULA YOU are granted the following rights:
a) To install and use one copy of the SOFTWARE PRODUCT or, in its place, any prior version for the same
operating system, on a single computer. As the primary user of the computer on which the SOFTWARE
PRODUCT is installed, YOU may make a second copy for your exclusive use on either a home or portable
computer.
b) To store or install a copy of the SOFTWARE PRODUCT on a storage device, such as a network server,
used only to install or run the SOFTWARE PRODUCT over an internal network. If YOU want to increase
the number of users entitled to concurrently access the SOFTWARE PRODUCT, YOU must notify SPARX
and agree to pay an additional fee.
c) To make copies of the SOFTWARE PRODUCT for backup and archival purposes.

EVALUATION LICENSE
The Trial version of Enterprise Architect is not free software. Subject to the terms of this agreement, YOU are
hereby licensed to use this software for evaluation purposes without charge for a period of 30 days.
Upon expiration of the 30 days, the Software Product must be removed from the computer. Unregistered use
of Enterprise Architect after the 30-day evaluation period is in violation of Australian, U.S. and international
copyright laws.
SPARX may extend the evaluation period on request and at their discretion.


Enterprise Architect UML Tool | Formal Statements | End User License Agreement 19

If YOU choose to use this software after the 30 day evaluation period a license must be purchased (as
described at http://www.sparxsystems.com/products/ea/purchase.html). Upon payment of the license fee,
YOU will be sent details on where to download the registered edition of Enterprise Architect and will be
provided with a suitable software 'key' by email.

EA LITE
Subject to the terms of this Agreement EA LITE may be installed on any machine indefinitely and free of
charge. There are no fees or Sparx support services in relation to EA LITE.

ADDITIONAL RIGHTS AND LIMITATIONS
YOU hereby undertake not to sell, rent, lease, translate, adapt, vary, modify, decompile, disassemble, reverse
engineer, create derivative works of, modify, sub-license, loan or distribute the SOFTWARE PRODUCT other
than as expressly authorized by this EULA.
YOU further undertake not to reproduce or distribute license key-codes except under the express and written
permission of SPARX.
If the Software Product purchased is an Academic Edition, YOU ACKNOWLEDGE THAT the license is limited
to use in an educational context, either for self-education or use in a registered teaching institution. The
Academic Edition may not be used to produce commercial software products or be used in a commercial
environment, without the express written permission of SPARX.

ASSIGNMENT
YOU may only assign all your rights and obligations under this EULA to another party if YOU supply to the
transferee a copy of this EULA and all other documentation including proof of ownership. Your license is then
terminated.

TERMINATION
Without prejudice to any other rights, SPARX may terminate this EULA if YOU fail to comply with the terms
and conditions. Upon termination YOU or YOUR representative shall destroy all copies of the SOFTWARE
PRODUCT and all of its component parts or otherwise return or dispose of such material in the manner
directed by SPARX.

WARRANTIES AND LIABILITY
WARRANTIES
SPARX warrants that the SOFTWARE PRODUCT will perform substantially in accordance with the
accompanying written materials for a period of ninety (90) days from the date of receipt, and any Support
Services provided by SPARX shall be substantially as described in applicable written materials provided to
YOU by SPARX, and SPARX support engineers will make commercially reasonable efforts to solve any
problems associated with the SOFTWARE PRODUCT.

EXCLUSIONS
To the maximum extent permitted by law, SPARX excludes, for itself and for any supplier of software
incorporated in the SOFTWARE PRODUCT, all liability for all claims, expenses, losses, damages and costs
made against or incurred or suffered by YOU directly or indirectly (including without limitation lost costs, profits
and data) arising out of:
· YOUR use or misuse of the SOFTWARE PRODUCT
· YOUR inability to use or obtain access to the SOFTWARE PRODUCT
· Negligence of SPARX or its employees, contractors or agents, or of any supplier of software incorporated
in the SOFTWARE PRODUCT, in connection with the performance of SPARX' obligations under this EULA,
or
· Termination of this EULA by either party for any reason.

LIMITATION
The SOFTWARE PRODUCT and any documentation are provided "AS IS" and all warranties whether express,
implied, statutory or otherwise, relating in any way to the subject matter of this EULA or to this EULA generally,
including without limitation, warranties as to: quality, fitness; merchantability; correctness; accuracy; reliability;
correspondence with any description or sample, meeting your or any other requirements; uninterrupted use;
compliance with any relevant legislation and being error or virus free are excluded. Where any legislation
implies in this EULA any term, and that legislation avoids or prohibits provisions in a contract excluding or


20 Enterprise Architect UML Tool | Formal Statements | End User License Agreement

modifying such a term, such term shall be deemed to be included in this EULA. However, the liability of
SPARX for any breach of such term shall if permitted by legislation be limited, at SPARX's option to any one or
more of the following upon return of the SOFTWARE PRODUCT and a copy of the receipt:
· If the breach relates to the SOFTWARE PRODUCT:
· the replacement of the SOFTWARE PRODUCT or the supply of an equivalent SOFTWARE PRODUCT
· the repair of such SOFTWARE PRODUCT
· the payment of the cost of replacing the SOFTWARE PRODUCT or of acquiring an equivalent
SOFTWARE PRODUCT, or
· the payment of the cost of having the SOFTWARE PRODUCT repaired.
· If the breach relates to services in relation to the SOFTWARE PRODUCT:
· the supplying of the services again, or
· the payment of the cost of having the services supplied again.

TRADEMARKS
All names of products and companies used in this EULA, the SOFTWARE PRODUCT, or the enclosed
documentation may be trademarks of their corresponding owners. Their use in this EULA is intended to be in
compliance with the respective guidelines and licenses.

Windows, Windows NTâ, Windows ME, Windows XP, Windows Vista, Windows 2000 and Windows 2003 are
trademarks of Microsoftâ.

GOVERNING LAW
This agreement shall be construed in accordance with the laws of the Commonwealth of AUSTRALIA.


Enterprise Architect UML Tool | Formal Statements | Trademarks 21

1.3.3 Trademarks

Trademarks of Microsoft
· Microsoft Word
· Microsoft Office
· Windows®
· ActiveX

Registered Trademarks of The OMG
· CORBA®
· the OMG Object Management Group logo
· The Information Brokerage®
· CORBA Academy®
· IIOP®
· XMI®

Trademarks of The OMG
· OMG™
· Object Management Group™
· The CORBA logo
· ORB™
· Object Request Broker™
· The CORBA Academy design
· OMG Interface Definition Language™
· IDL™
· CORBAservices™
· CORBAfacilities™
· CORBAmed™
· CORBAnet™
· Unified Modeling Language™
· UML™
· The UML Cube logo
· MOF™
· CWM™
· Model Driven Architecture™
· MDA™
· OMG Model Driven Architecture™
· OMG MDA™


22 Enterprise Architect UML Tool | Formal Statements | Acknowledgements

1.3.4 Acknowledgements
Some parts of this application include code originally written by various authors and modified for use in
Enterprise Architect.

Marquet Mike
Print listview contents
mike.marquet@altavista.net

Davide Pizzolato
CXImage Library
© 7-Aug-2001
ing.davide.pizzolato@libero.it
Also, many thanks to all those who have made suggestions, reported bugs, offered feedback and helped with
the beta-testing of Enterprise Architect. Your help has been invaluable.


Enterprise Architect UML Tool | If You Have the Trial Version | 23

1.4 If You Have the Trial Version

If you are exploring one of the Enterprise Architect trial versions, note that the software operates for a limited
period. To continue using Enterprise Architect when the trial period expires, you can purchase and register a
full license as explained in the following topics:
· Order Enterprise Architect 24
· Installation 25
· Register a Full License 26 .
If you already have a full license edition of Enterprise Architect and want to register Add-Ins or upgrade to the
Professional or Corporate editions, see the License Management 63 topic.


24 Enterprise Architect UML Tool | If You Have the Trial Version | Order Enterprise Architect

1.4.1 Order Enterprise Architect
Enterprise Architect is designed, built and published by Sparx Systems and available from Sparx Systems.
The trial version of Enterprise Architect is identical to the registered edition with the exception that all diagrams
are output to files with an embedded watermark. The trial software stops working after the trial period has
elapsed. On purchase of a suitable license or licenses, the registered version is made available for download.
The latest information on pricing and purchasing is available at: Sparx Systems Purchase/Pricing Website.

Purchase Options
· On-line using a secure credit-card transaction; see: Pricing and Purchase Options
· Fax
· Check or equivalent
· Bank transfer.
For more information, contact sales@sparxsystems.com.


Enterprise Architect UML Tool | If You Have the Trial Version | Installation 25

1.4.2 Installation
Enterprise Architect is distributed as a single executable setup file (.exe). The Corporate edition requires
additional files and supplementary installation processes if you plan to use the SQL Server, MySQL,
PostgreSQL, Sybase Adaptive Server Anywhere or Oracle 9i, 10g or 11g options (see below). Please note that
installation and maintenance of these database management systems is not covered under the support
agreement.
The latest evaluation and registered versions of Enterprise Architect are always available from the Sparx
Systems website. The registered version is available through the registered user area of the web site, which
requires a username and password to access. These are provided upon purchase of a license.

System Requirements
The system requirements for installing Enterprise Architect are defined on the Enterprise Architect | System
Requirements page of the Sparx Systems website.

Windows Vista
Under Windows Vista (with User Account Control turned on) an application starts with only Standard
permissions, regardless of what level of authority the current user has. As a result, an installer run normally
with an Admin account under Vista only has Standard privileges and either is not able to write to certain critical
areas of the registry/file system, or redirects the write requests to a per-user virtualized registry/file system.
Sparx Systems recommend that if you are installing on Windows Vista, always run the Enterprise Architect
installer with Administrator privileges (right-click on the downloaded installer icon and select the Run as
administrator menu option).

Install Enterprise Architect
Run the Enterprise Architect setup program. Generally you can accept all the default options without change.
To place Enterprise Architect in a directory other than the default, enter the name of the destination when
prompted.
You might be prompted to restart your computer when the installation completes. Although this is not always
necessary (if you already have the components Enterprise Architect requires installed on your computer), you
should restart just to be certain.
If you intend to run Enterprise Architect on Linux, refer to the Installation and Use page on the Sparx Systems
website.
Corporate edition users planning to use SQL Server, MySQL, PostgreSQL, Sybase Adaptive Server Anywhere
or Oracle 9i, 10g or 11g as their model repository can access scripts that create the required data structures
for the choice of DBMS. You can find these at one of the following pages:
· The Corporate edition Resources page
· The Trial Corporate edition Resources page.

Note:
Enterprise Architect requires Read/Write access to the program files directory where Enterprise Architect has
been installed.


26 Enterprise Architect UML Tool | If You Have the Trial Version | Register a Full License

1.4.3 Register a Full License
The trial version of Enterprise Architect available for download is an evaluation version only. For the full
version you must first purchase one or more licenses. The license code supplied determines which edition
(Desktop, Professional or Corporate) is activated on installation.

Register Enterprise Architect
To obtain the full version and complete the registration process, follow the steps below:
1. Purchase one or more licenses.
Once you have paid for a licensed version of Enterprise Architect, you receive (via email or other
suitable means):
· a license key or keys
· the address of a web site from which to download the full version.
2. Save the license key and download the latest full install package from the address supplied.
3. Run the setup program to install the full version.
4. Open Enterprise Architect from the Start Menu or desktop icon.
5. Select the Help | Register and Manage License Key(s) menu option. The License Management dialog
displays.

6. Click on the Add Key button. The Enter Registration dialog displays.
7. In the Copy registration key... field, copy the license key, including the { and } bracket characters (use
Copy and Paste from an email to avoid typing mistakes).

8. Click on the OK button. The full version is now activated on your PC, and Enterprise Architect displays
the message: Registration succeeded! Thank you for purchasing Enterprise Architect <type> Edition.


Enterprise Architect UML Tool | If You Have the Trial Version | Register a Full License 27

See Also
· Add License Key 65
· Upgrade an Existing License 68

· Register Add-In 71


28 Start UML Modeling | |

2 Start UML Modeling

This guide provides two options to help you gain an understanding of how to perform UML modeling with
Enterprise Architect:
· A brief outline of the types of work and tasks 29 that Enterprise Architect supports, so that you can quickly
locate the more detailed explanations of subjects that interest you
· A Quick Start tutorial to Enterprise Architect that illustrates how to open and create new projects, navigate
Enterprise Architect, and use Enterprise Architect to perform various tasks in system and process
modeling. It leads on to examining the Enterprise Architect User Interface and work areas applicable to
certain Project Roles 47 .

At various points throughout the Enterprise Architect Help, there are further Quick Start topics and sections
to help you use the system immediately to experiment with a feature of Enterprise Architect. Use the Help
Index tab and search for Quick Start to locate these topics.


Start UML Modeling | Work with Enterprise Architect | 29

2.1 Work with Enterprise Architect

Enterprise Architect is a powerful CASE tool for specifying, documenting and building software projects. Using
Enterprise Architect's support for UML and its related standards, you can model new complex software and
business systems, or visualize and maintain existing systems.
This topic introduces the fundamental processes that Enterprise Architect supports.

Modeling with UML
Enterprise Architect is a comprehensive UML analysis and design tool. To create models with Enterprise
Architect, you therefore should become familiar with:
· how Enterprise Architect implements the UML standards and
· how you apply UML in Enterprise Architect to develop your models.
For more information, see the Modeling With UML 31 topic.

Managing UML Models
To manage the models in your projects, you both protect and manage the model data itself, and communicate
information on the data in the form of RTF and HTML documentation and reports.
For more information, see the Manage UML Models 32 topic.

Code Engineering
In Enterprise Architect, UML modeling both depends on and supports code engineering - you generate and
update code from a model, and you create and update models from code. In this broad sense, Enterprise
Architect enables you to:
· Forward engineer, reverse engineer, round-trip and synchronize code in a range of programming
languages
· Debug and profile code
· Model and generate code for XML Technologies
· Perform database modeling and database design for a range of database management systems
· Convert model components from one domain to another using Model Driven Architecture (MDA)
Transformations.
For more information, see the Code Engineering 33 topic in this section.

Managing Projects
Enterprise Architect provides strong support for Project Management, particularly in the following areas:
· Project estimation - working out how much time and effort is required to build and deploy a solution, using
the Use Case metrics facility and carefully-calibrated metrics
· Defining, assigning and managing resources
· Monitoring and managing problems, changes, issues and tasks that affect both individual elements and
the project as a whole
· Managing the development, execution and results of testing, from Integration through to User Acceptance,
and
· Maintaining a project glossary of terms, procedures and policies applied to the project.
For more information, see Project Management with Enterprise Architect.
Project management discussions and decisions can be communicated to the project through the Project
Discussion Forum (see Using Enterprise Architect – UML Modeling Tool).


30 Start UML Modeling | Work with Enterprise Architect |

The scope of your project management might include upgrades to Enterprise Architect and installation of
related technologies. In this case, also see License Management 63 .

Extending Enterprise Architect Facilities
Experienced Technology Developers can develop customized additions to the functionality already present
within Enterprise Architect. These additions include:
· UML Profiles and Stereotypes
· UML Patterns
· Code Templates
· Tagged Value Types
· MDG Technologies and
· Enterprise Architect Add-Ins.
By creating these extensions the Technology Developer can customize the Enterprise Architect modeling
process to specific tasks and speed up development.
For more information, see SDK For Enterprise Architect.


Start UML Modeling | Work with Enterprise Architect | Modeling With UML 31

2.1.1 Modeling With UML
Enterprise Architect is a comprehensive UML analysis and design tool. Enterprise Architect has a library of
UML data structures that you can use and extend to develop your models.

UML Structures
To explain how Enterprise Architect interprets the UML standards and specifications, Sparx Systems provides
a UML Dictionary of diagrams, elements and connectors.
· You create your projects and models using the Start Page or File Menu, which provide templates on
which to base your models
· You initially create your packages and diagrams using the Toolbars and Menus, and the elements and
connectors using the Enterprise Architect UML Toolbox
· You can also create new structures through the Project Browser, and re-use existing structures using
the Project Browser, Model Views, Element List and Model Search.

UML Modeling With Enterprise Architect
Modeling in Enterprise Architect is the process of graphically representing a business process or software
system. The resulting model can be used to emphasize a certain aspect of the system being represented and
to record and communicate its detail.
Building models requires the use of various UML data structures and Enterprise Architect tools, as above. A
further extremely useful tool is the:
· Relationship Matrix, which enables you to visualize and amend the relationships and hence organization
of structures within the model.
Enterprise Architect also provides particular support for:
· Requirements Management and
· Modeling the business process, an essential part of any software development process.
You can extend the scope of your models by using:
· UML Stereotypes, Profiles and Patterns, and
· MDG Technologies.
For more information, see UML Modeling with Enterprise Architect - UML Modeling Tool.


32 Start UML Modeling | Work with Enterprise Architect | Manage UML Models

2.1.2 Manage UML Models
To manage the UML models in your projects, you both protect and manage the model data itself, and
communicate information on the data in the form of documentation and reports.

UML Model Management
In managing models, you control:
· The model files in a Microsoft JET database or (Corporate edition) in one of a range of DBMS repositories
· Model data integrity
· Development of the models in a shared, team environment
· Versions of the model, ensuring that work on different areas of the model is coordinated and synchronous
rather than conflicting
· User security
· Transfer of value data and reference data between projects and models
· Changes to model data, using model auditing, Baselines and a differencing utility that enables you to roll
back changes to a previous state
· Model upgrades
· Replication of models for parallel development (.EAP repositories only)
· Extensions of development with Add-Ins and the Enterprise Architect Automation Interface
You can also have recorded discussion and communication of decisions using the Project Discussion
Forum.
For further information, see UML Model Management.

Generating Model Documentation
You can generate documentation from the components of your model, in RTF or HTML format. You can also
generate a range of RTF reports on your model.
For more information, see Report Creation in UML Models.


Start UML Modeling | Work with Enterprise Architect | Code Engineering 33

2.1.3 Code Engineering
Code Engineering with Enterprise Architect broadly encompasses various processes for generating or
transforming code from your UML model and importing code into the model, to support model development in
several coding languages, database development and SOA development.

Code Engineering
Enterprise Architect supports:
· Source code generation and reverse engineering for many popular languages, including C++, C#, Java,
Delphi, VB.Net, Visual Basic, ActionScript, Python and PHP.
Enterprise Architect also provides:
· A built in 'syntax highlighting' source code editor
· Code generation templates, which enable you to customize the generated source code to your company
specifications.
For more information, see Code Engineering Using UML Models.

MDA Transformations
Enterprise Architect provides:
· Advanced Model Driven Architecture (MDA) transformations using transformation templates
· Built-in transformations for DDL, C#, Java, EJB and XSD.
One PIM can be used to generate and synchronize multiple PSMs, providing a significant productivity
boost.
For more information, see the MDA Transformations User Guide.

Debug And Profile
Enterprise Architect enables you to:
· Build, test, debug, run and execute deployment scripts
· Integrate UML development and modeling with source development and compilation
· Generate NUnit and JUnit test Classes from source Classes using MDA Transformations
· Integrate the test process directly into the Enterprise Architect IDE
· Debug .NET, Java and Microsoft Native (C, C++ and Visual Basic) applications.
For more information, see Debug and Profiling in Enterprise Architect.

Database Modeling
Enterprise Architect enables you to:
· Reverse engineer from many popular DBMSs, including SQL Server, My SQL, Access, PostgreSQL
and Oracle 9i, 10g or 11g
· Model database tables, columns, keys, foreign keys and complex relationships using UML and an
inbuilt data modeling profile
· Forward generate DDL scripts to create target database structures.

XML Technology Engineering
Enterprise Architect enables you to rapidly model, forward engineer and reverse engineer two key W3C
XML technologies:
· XML Schema (XSD)
· Web Service Definition Language (WSDL).
XSD and WSDL support is critical for the development of a complete Service Oriented Architecture (SOA),
and the coupling of UML 2.1 and XML provides the natural mechanism for implementing XML-based SOA
artifacts within an organization.


34 Start UML Modeling | Quick Start - Create a Project |

2.2 Quick Start - Create a Project

Tutorial
Welcome to Enterprise Architect! This quick-start tutorial helps you start UML modeling with Enterprise
Architect.
As you read through the Quick Start sections, have Enterprise Architect open so that you can explore and try
out the functions described. By the end of the Quick Start tutorial you should be able to begin modeling your
own software projects with Enterprise Architect and UML.
The tutorial guides you through creating a simple project. Throughout the descriptions there are hyperlinks to
more detailed information on a range of topics. Follow these links if you would like more information, or ignore
them if you want to just follow the steps.
Your task is to create a new project and then add a View, package, diagram, elements and connectors.

Create a Project
When you start Enterprise Architect it opens at the Start Page:

1. Click on the Create a New Project... option. The New Project dialog displays.
2. In the File name field, type a meaningful name for the project and click on the Save button to create the
project file. The Model Wizard displays.
3. You now select one or more model templates (these provide you with the basic structures - packages
and diagrams - for your project, as well as references to useful help files to get you started). Select the
checkbox of each model that interests you.
4. Click on the OK button. Enterprise Architect creates your project and displays it in the Project Browser,
on the right-hand side of the screen.

Note:
You could also quickly create a project by copying an existing base project provided with Enterprise Architect;
see the Copy a Base Project topic in UML Model Management.

Expand The Project
To navigate through your project, in the Project Browser click on the 'plus' icon against each folder or package
to expand it.


Start UML Modeling | Quick Start - Create a Project | 35

Double-click on the diagram icon displayed underneath a package name. Enterprise Architect displays the
sample diagram for that model in the Diagram View, which is in the middle of the screen.

Add a View To Your Model
Now that you have created a project containing at least one model, you can add another View to a model, and
then add a package with diagram, elements and connectors (relationships).


36 Start UML Modeling | Quick Start - Create a Project | Add a View to a Model

2.2.1 Add a View to a Model
A View is the highest-level container, or package, within a model. There are six types of View, five of which
represent conventional ways of categorizing the structures or purposes of a model, and one (Simple View) for
developing your own categorization.
To create a View, follow the steps below:
1. Right-click on your model name in the Project Browser. The context menu displays.
2. Select the New View menu option. The Create New View dialog displays.

3. In the Name field, type the name of the View.
4. In the Set View Icon Style panel, click on the radio button for the type of View to create.
5. If the model root node had been under version control, the Add to Version Control checkbox would
display, defaulted to selected. Ignore this for now.
6. Click on the OK button.

Add a Package To Your Model
Now that you have created a View in the model, you can add a package 37 and diagram to that View or any
other in the model, and then add elements and connectors (relationships).


Start UML Modeling | Quick Start - Create a Project | Add a Package To a Model 37

2.2.2 Add a Package To a Model
A Package is a container of model elements, and is displayed in the Project Browser as the 'folder' icon
familiar to Windows users. Package contents are arranged alphabetically.
In the Project Browser click on a package and, in the Project Browser toolbar, click on the New Package icon

.
Enterprise Architect displays a prompt for the package name.

Note:
This prompt also contains the Automatically add new diagram option for automatically creating a diagram
for the package, which defaults to selected. This is very a useful feature, but for the purposes of this
introduction deselect the checkbox against the option.

Type in a name and click on the OK button. Enterprise Architect adds the new package subordinate to the
package you selected.

Add a Diagram To a Package
Now add a diagram 38 .

Additional Information
For additional information on adding packages and Views (top-level packages), see the Add a Package 37
topic in UML Modeling with Enterprise Architect – UML Modeling Tool and Add Additional Views topic in UML
Model Management.


38 Start UML Modeling | Quick Start - Create a Project | Add a Diagram to a Package

2.2.3 Add a Diagram to a Package
A diagram is a representation of the components or elements of your model and, depending on the type of
diagram, how those elements are connected or how they interact.
When you first create a project, Enterprise Architect provides simple examples of diagrams appropriate to your
selected model patterns, with annotations. You can edit these diagrams, but here we create an additional one.

Click on your new package and, in the Project Browser toolbar, click on the New Diagram icon .
The New Diagram dialog displays.

Note:
When you create a package, if you leave the Automatically add new diagram option selected, the New
Diagram dialog displays automatically.

Click on a diagram category in the Select From panel, and a diagram type in the Diagram Types panel, then
click on the OK button. Enterprise Architect adds a diagram object to the package, with the same name as the
package. It also opens the Diagram View for your diagram, in the center of the screen.

Add Elements to a Diagram and a Package
Now add some elements 39 .

For additional information on adding diagrams to a project, see the Add New Diagrams topic in UML Modeling
with Enterprise Architect – UML Modeling Tool.


Start UML Modeling | Quick Start - Create a Project | Add Elements 39

2.2.4 Add Elements
You have several options for adding elements (the UML model building units) to a package and/or diagram.
The simplest method is to use the Enterprise Architect UML Toolbox to the left of the diagram, which
automatically lists the elements applicable to the type of diagram you have created. Just click on the required
element and drag it onto your diagram.
Two things might occur before the element displays on the diagram:
· If you have selected an Object element, Enterprise Architect prompts you to define what stereotype the
object is based on (an object can represent a wide range of things, and a stereotype helps you define what
the object or element is); for now, select any value.
· The element Properties 41 dialog displays. If it does not display, double-click on the element on the
diagram.
You can use the Properties dialog to define the characteristics of the element, such as its name. Type a name
in the Name field, and click on the OK button. Look at the Project Browser, underneath the package in which
you created the diagram. The element is listed.

Tip:
Enterprise Architect has two very useful features:
· To find out more about the type of element you have dragged on to a diagram, right-click on the element
and select the UML Help menu option. This displays a Help page on the element type.
· If you are creating several elements of one type, after creating the first just press [Shift]+[F3] or [Ctrl]+
click to create the next element of that type.

You can also drag or paste existing elements onto a diagram from the Project Browser. This enables you to
make use of previous work in defining elements.

Add Connectors Between Elements
Now connect the elements 40 with relationships.

For additional information on adding elements to a project, including via the Quick Linker, see the Create
Elements topic and the Create New Elements topic in Using Enterprise Architect - UML Modeling Tool.


40 Start UML Modeling | Quick Start - Create a Project | Add Connectors

2.2.5 Add Connectors
Connectors define specific relationships between specific elements, so you usually create them directly on the
diagram by dragging the required relationship type from the Enterprise Architect UML Toolbox. As for
elements, the Toolbox automatically presents the connector or relationship types appropriate to the type of
diagram.
Create two elements on the diagram. Click on a connector in the Toolbox, click on the source element in the
relationship, then drag across to the target element. This creates the selected connection between the two
elements. If you double-click on the connector, the connector Properties 41 dialog displays, and you can
define the characteristics of the relationship.

Tip:
Enterprise Architect has three very useful features:
· To find out more about the type of connector you have dragged on to a diagram, right-click on the
connector and select the UML Help menu option. This displays a Help page on the connector type.
· If you are creating several connectors of one type, after creating the first just click on the appropriate
source element and press [F3] to create the next connector of that type.
· As you drag a connector, you can press [Shift] to create a bend in the connector. If necessary, you can put
several bends in the connector line, pressing [Shift] every time you want to change direction. To roll back
the bends, keep holding the left mouse button down and press [Backspace] as many times as is
necessary.

Moving and Deleting Elements and Connectors
Having created a model with some components, you can move 43 those components around and delete 45
them. You should also know how to save 46 your work.

For additional information on creating a connector through the Project Browser, or with the Quick Linker, see
the Create Connector topic in UML Modeling with Enterprise Architect – UML Modeling Tool and the Create
Connections Between Elements topic in Using Enterprise Architect - UML Modeling Tool.


Start UML Modeling | Quick Start - Create a Project | Define Properties 41

2.2.6 Define Properties
When you create an element and connect it to another element, you usually have to define various
characteristics of both the element and the connector to identify the purpose and function they represent. You
do this using a Properties dialog.
Enterprise Architect is initially configured to display the Properties dialog automatically when you create an
element or connector, but it is easy (and often convenient) to turn the dialog display off (see the Properties
topic in Using Enterprise Architect - UML Modeling Tool). If the default display has been turned off, you can
display the dialog by:
· double-clicking on the element or connector in the diagram or
· right-clicking on it in the Project Browser and selecting the Properties menu option.
Properties dialogs vary between element types and between elements and connectors but, as you saw when
you created your first element, they look something like this:

When you create elements, Enterprise Architect automatically names and numbers them by type - for
example, Class1, Class2 - so you should at least change the Name field to more easily identify each element.
See the Element Properties topic in UML Modeling with Enterprise Architect – UML Modeling Tool for a full
description of the element Properties dialog.
Enterprise Architect does not automatically name connectors, but for many connector types you should
provide a name that describes the purpose of the connection.
See the Connector Properties topic in UML Modeling with Enterprise Architect – UML Modeling Tool for a full
description of the connector Properties dialog.

Explore User Interface
So far you have been using the Project Browser and Diagram View to develop your project. At this point you


42 Start UML Modeling | Quick Start - Create a Project | Define Properties

should find out a bit more about the other facilities of the Enterprise Architect User Interface in Using
Enterprise Architect - UML Modeling Tool.
When you have finished exploring the User Interface topics, go to Quick Start - Project Tasks 47 to identify
areas of Enterprise Architect that provide particular support for your job role.


Get Started EA UML Modeling

Recommandé

Recommandé

Contenu connexe

Tendances

Tendances (20)

En vedette

En vedette (20)

Similaire à Get Started EA UML Modeling

Similaire à Get Started EA UML Modeling (20)

Dernier

Dernier (20)

Get Started EA UML Modeling