Enterprise Architect User Guide

Enterprise Architect is an intuitive, flexible and powerful

UML analysis and design tool for building robust and
maintainable software. From requirements gathering,
through analysis, modeling, implementation and testing to
deployment and maintenance, Enterprise Architect is a fast,
feature-rich, multi-user UML modeling tool, driving the
long-term success of your software project.

Copyright © 1998-2010 Sparx Systems Pty Ltd

 Enterprise Architect User Guide
Introduction
by Geoffrey Sparks

Enterprise Architect is a complete UML-based

solution for analysing, designing, managing, sharing
and building software systems.
Enterprise Architect User Guide

© 1998-2010 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: August 2010

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
Geoffrey Sparks
Dermot O'Bryan
Simon McNeilly
Neil Capey
Sam Mancarella
John Redfern
Vimal Kumar
Howard Britten
Brad Maxwell
Steve Meagher
 I Contents

Table of Contents
Foreword 1

Part I Introduction 3
Overview ................................................................................................................................... 4
What You ..........................................................................................................................................................
Can Do 4
Key Benefits
.......................................................................................................................................................... 5
Key Features
.......................................................................................................................................................... 8
Enterprise
...................................................................................................................................
Architect Editions 10
The Trial ..........................................................................................................................................................
Version 10
Editions Available
.......................................................................................................................................................... 12
The Read-only
..........................................................................................................................................................
'Lite' Edition 15
Formal Statements
................................................................................................................................... 16
Copyright..........................................................................................................................................................
Notice 16
End User..........................................................................................................................................................
License Agreement 16
Trademarks
.......................................................................................................................................................... 19
Acknowledgements
.......................................................................................................................................................... 20
Installation
................................................................................................................................... 21
Register ...................................................................................................................................
a Full License 22
Help and...................................................................................................................................
Support 23
Available..........................................................................................................................................................
Helpfile Formats 24
Support .......................................................................................................................................................... 24

Part II Getting Started 26

Basics ................................................................................................................................... 27
A Quickstart
...................................................................................................................................
Tutorial 28
Add a View
..........................................................................................................................................................
to a Model 29
Add a Package
..........................................................................................................................................................
To a Model 30
Add a Diagram
..........................................................................................................................................................
to a Package 30
Add Elements
.......................................................................................................................................................... 31
Add Connectors
.......................................................................................................................................................... 32
Define Properties
.......................................................................................................................................................... 33
Move Components
.......................................................................................................................................................... 34
Delete Components
.......................................................................................................................................................... 35
Save Changes
.......................................................................................................................................................... 36
Typical Project
...................................................................................................................................
Roles 37
Summary..........................................................................................................................................................
of Typical Tasks 37
Business..........................................................................................................................................................
Analysts 38
Software ..........................................................................................................................................................
Architects 40
Software ..........................................................................................................................................................
Engineers 41
Developers
.......................................................................................................................................................... 42
Project Managers
.......................................................................................................................................................... 43
Testers .......................................................................................................................................................... 43
Implementation
..........................................................................................................................................................
Managers 45
Technology
..........................................................................................................................................................
Developers 46
Database..........................................................................................................................................................
Developers 47
User Interface
...................................................................................................................................
Guide 48
Introduction
.......................................................................................................................................................... 48
Start Page
.......................................................................................................................................................... 50
Tasks Pane
.......................................................................................................................................................... 51
Main Menu.......................................................................................................................................................... 54

Enterprise Architect User Guide

 Contents II

File ......................................................................................................................................................... 56
Remove Recent .........................................................................................................................................
Projects 56
Edit ......................................................................................................................................................... 57
Paste Elements .........................................................................................................................................
Submenu 58
View ......................................................................................................................................................... 58
View Submenus ......................................................................................................................................... 59
.........................................................................................................................................................
Project 60
Documentation .........................................................................................................................................
Submenu 61
Source Code .........................................................................................................................................
Engineering Submenu 62
Execution Analyzer.........................................................................................................................................
Submenu 62
Database Engineering
.........................................................................................................................................
Submenu 63
Transformations .........................................................................................................................................
Submenu 63
Model Validation .........................................................................................................................................
Submenu 64
Web Services .........................................................................................................................................
Submenu 64
XML Schema .........................................................................................................................................
Submenu 64
Security Submenu ......................................................................................................................................... 64
Version Control .........................................................................................................................................
Submenu 65
Import/Export .........................................................................................................................................
Submenu 65
.........................................................................................................................................................
Diagram 65
.........................................................................................................................................................
Element 67
Inline Features .........................................................................................................................................
Submenu 68
Advanced Submenu ......................................................................................................................................... 68
Source Code .........................................................................................................................................
Engineering Submenu 69
Appearance.........................................................................................................................................
Submenu 69
Position Submenus ......................................................................................................................................... 70
Tools......................................................................................................................................................... 70
Data Management .........................................................................................................................................
Submenu 71
Manage .EAP .........................................................................................................................................
File Submenu 71
Addins......................................................................................................................................................... 72
.........................................................................................................................................................
Settings 73
Window......................................................................................................................................................... 74
Help ......................................................................................................................................................... 74
Standard..........................................................................................................................................................
Windows 75
Dock.........................................................................................................................................................
Windows 76
.........................................................................................................................................................
Autohide Windows 78
Standard..........................................................................................................................................................
Toolbars 79
.........................................................................................................................................................
Default Tools Toolbar 80
.........................................................................................................................................................
Project Toolbar 81
Code.........................................................................................................................................................
Generation Toolbar 81
UML .........................................................................................................................................................
Elements Toolbar 83
.........................................................................................................................................................
Diagram Toolbar 83
.........................................................................................................................................................
Current Element Toolbar 84
.........................................................................................................................................................
Current Connector Toolbar 84
Format.........................................................................................................................................................
Toolbar 85
.........................................................................................................................................................
Workspace Layouts 86
Status.........................................................................................................................................................
Bar 89
Customization
.......................................................................................................................................................... 90
.........................................................................................................................................................
The Customize Dialog 90
Customize .........................................................................................................................................
Commands 91
Customize Toolbars......................................................................................................................................... 92
Custom Tools ......................................................................................................................................... 94
Open External ...................................................................................................................................
Tools 96
Pass Parameters ...................................................................................................................................
to Applications 97
Customize Keyboard......................................................................................................................................... 98
Customize.........................................................................................................................................
Menu 100
Customize.........................................................................................................................................
Options 101
.........................................................................................................................................................
Visual Styles 101
Other Windows
.......................................................................................................................................................... 102

© 1998-2010 Sparx Systems Pty Ltd

 III Contents

The.........................................................................................................................................................
Output Window 102
The.........................................................................................................................................................
Web Browser 103
Keyboard
..........................................................................................................................................................
Shortcuts 104
.........................................................................................................................................................
Keyboard-Mouse Shortcuts 109

Part III Projects and Teams 111

Introduction
................................................................................................................................... 112
What is ..........................................................................................................................................................
a Project? 113
Open a Project
.......................................................................................................................................................... 114
Model Shortcuts
.......................................................................................................................................................... 115
.........................................................................................................................................................
Create Copy Or Shortcut 116
.........................................................................................................................................................
Capture Current Work Environment 117
.........................................................................................................................................................
Encrypt Repository Password 119
File Based
...................................................................................................................................
Repositories 120
Copy a Base
..........................................................................................................................................................
Project 121
Server Based
...................................................................................................................................
Repositories 122
Create a..........................................................................................................................................................
Repository 123
.........................................................................................................................................................
Access 2007 123
.........................................................................................................................................................
MySQL Repository 123
SQL.........................................................................................................................................................
Server Repository 126
.........................................................................................................................................................
Oracle Server Repository 129
.........................................................................................................................................................
PostgreSQL Repository 129
.........................................................................................................................................................
Adaptive Server Anywhere Repository 132
MSDE.........................................................................................................................................................
Server Repository 134
.........................................................................................................................................................
Progress OpenEdge Repository 134
Set Up an
..........................................................................................................................................................
ODBC Driver for a Connection to a Repository 135
.........................................................................................................................................................
MySQL ODBC Driver 135
.........................................................................................................................................................
PostgreSQL ODBC Driver 138
ASA.........................................................................................................................................................
ODBC Driver 141
.........................................................................................................................................................
Progress OpenEdge ODBC Driver 145
Connect..........................................................................................................................................................
to a Data Repository 147
.........................................................................................................................................................
MySQL Data Repository 148
SQL.........................................................................................................................................................
Server Data Repository 150
.........................................................................................................................................................
Oracle Data Repository 153
.........................................................................................................................................................
PostgreSQL Data Repository 160
ASA.........................................................................................................................................................
Data Repository 162
MSDE.........................................................................................................................................................
Server Data Repository 165
.........................................................................................................................................................
Progress OpenEdge Repository 165
Upsize to
..........................................................................................................................................................
Access 2007 169
Upsize to
..........................................................................................................................................................
Sybase ASA 170
Upsize to
..........................................................................................................................................................
Progress OpenEdge 171
Upsize to
..........................................................................................................................................................
MSDE 173
Upsize to
..........................................................................................................................................................
PostgreSQL 173
Upsize to
..........................................................................................................................................................
Oracle 9i, 10g or 11g 175
Upsize to
..........................................................................................................................................................
SQL Server 176
Upsize to
..........................................................................................................................................................
MySQL 178
The WAN ..........................................................................................................................................................
Optimizer 180
Team Development
................................................................................................................................... 182
Project Sharing
.......................................................................................................................................................... 182
.........................................................................................................................................................
Share Enterprise Architect Projects 183
.........................................................................................................................................................
Share Projects on Network Drive 183
.........................................................................................................................................................
Distributed Development 183
.........................................................................................................................................................
Replication 184
Design Masters ......................................................................................................................................... 185
Create Replicas ......................................................................................................................................... 185
Synchronize .........................................................................................................................................
Replicas 186
Remove Replication
......................................................................................................................................... 186
Enterprise Architect User Guide
 Contents IV

Upgrade Replicas......................................................................................................................................... 186

Resolve Conflicts
......................................................................................................................................... 187
Configure
..........................................................................................................................................................
User Security 188
.........................................................................................................................................................
Enable Security 189
.........................................................................................................................................................
Security Policy 190
.........................................................................................................................................................
Maintain Users 191
.........................................................................................................................................................
Import User IDs From Active Directory 192
.........................................................................................................................................................
Assign User To Groups 194
Set .........................................................................................................................................................
Up Single Permissions 195
View.........................................................................................................................................................
All User Permissions 196
.........................................................................................................................................................
Maintain Groups 197
Set .........................................................................................................................................................
Group Permissions 197
List .........................................................................................................................................................
of Available Permissions 198
View.........................................................................................................................................................
and Manage Locks 200
.........................................................................................................................................................
Password Encryption 200
.........................................................................................................................................................
Change Password 202
Lock.........................................................................................................................................................
Model Elements 204
Add.........................................................................................................................................................
Connectors To Locked Elements 204
Lock.........................................................................................................................................................
Packages 205
Apply.........................................................................................................................................................
a User Lock 205
.........................................................................................................................................................
Locked Element Indicators 206
.........................................................................................................................................................
Identify Who Has Locked An Object 207
.........................................................................................................................................................
Manage Your Own Locks 207
Team Review
..........................................................................................................................................................
Tools 208
.........................................................................................................................................................
Context Menu 209
Add.........................................................................................................................................................
a New Category 211
Add.........................................................................................................................................................
a New Topic 212
Add.........................................................................................................................................................
a New Post 213
Reply.........................................................................................................................................................
to a Post 214
Edit.........................................................................................................................................................
an Item 215
Team .........................................................................................................................................................
Review Editor 215
Add.........................................................................................................................................................
Object Links 216
Team .........................................................................................................................................................
Review Resources 217
.........................................................................................................................................................
Search Team Review 217
Copy .........................................................................................................................................................
Path to Clipboard 218
Team .........................................................................................................................................................
Review Options 218
Team .........................................................................................................................................................
Review Connections 218
Workflow
..........................................................................................................................................................
Scripts 220
.........................................................................................................................................................
Workflow Script Functions 220
Sharing..........................................................................................................................................................
Reference Data 223
.........................................................................................................................................................
Export Reference Data 223
.........................................................................................................................................................
Import Reference Data 225
Change...................................................................................................................................
Management 228
Version ..........................................................................................................................................................
Control 228
.........................................................................................................................................................
Introduction 229
System Requirements
.........................................................................................................................................
and Configuration 229
Version Control .........................................................................................................................................
Usage 230
Version Control .........................................................................................................................................
Basics 230
Version Control .........................................................................................................................................
and Reference Data 231
Apply Version .........................................................................................................................................
Control To Models 231
Version Control .........................................................................................................................................
& Team Deployment 232
Project Browser .........................................................................................................................................
Indicators 233
.........................................................................................................................................................
Version Control Setup 233
Version Control .........................................................................................................................................
Settings Dialog 234
Version Control...................................................................................................................................
Nested Packages 236
Version Control .........................................................................................................................................
with SCC 236
Upgrade at ...................................................................................................................................
Enterprise Architect 4.5 239
Version Control .........................................................................................................................................
with CVS 240

© 1998-2010 Sparx Systems Pty Ltd

 V Contents

CVS with ...................................................................................................................................

Remote Repositories 240
CVS with ...................................................................................................................................
Local Repositories 244
Version Control
.........................................................................................................................................
with Subversion 247
................................................................................................................................... 247
Set up Subversion
Create a new...................................................................................................................................
Repository Sub-tree 248
...................................................................................................................................
Create a Local Working Copy 249
Subversion ...................................................................................................................................
Under WINE-Crossover 249
...................................................................................................................................
Version Control Configuration 250
TortoiseSVN ................................................................................................................................... 252
Version Control .........................................................................................................................................
with TFS 253
Connect an Enterprise Architect Model to Version Control using
TFS ................................................................................................................................... 253
Use.........................................................................................................................................................
Version Control 256
Project Version .........................................................................................................................................
Control Menu 256
Package Version .........................................................................................................................................
Control Menu 257
Configure .........................................................................................................................................
Controlled Package 259
Use Existing .........................................................................................................................................
Configuration 260
Validate Package.........................................................................................................................................
Configurations 260
Check In and .........................................................................................................................................
Check Out Packages 261
Include Other .........................................................................................................................................
Users' Packages 263
Apply Version .........................................................................................................................................
Control To Branches 264
Export Controlled
.........................................................................................................................................
Model Branch 264
Import Controlled
.........................................................................................................................................
Model Branch 265
Review Package .........................................................................................................................................
History 266
Refresh View .........................................................................................................................................
of Shared Project 267
Resynchronize .........................................................................................................................................
the Status of Version Controlled Packages 267
Offline Version .........................................................................................................................................
Control 268
Tracking..........................................................................................................................................................
Changes 269
.........................................................................................................................................................
Auditing 270
Auditing Quickstart
......................................................................................................................................... 271
Auditing Settings
......................................................................................................................................... 271
Audit Scope ................................................................................................................................... 272
Audit Logs................................................................................................................................... 272
................................................................................................................................... 273
Auditing Level
................................................................................................................................... 273
Audit Options
The Audit .........................................................................................................................................
View 274
Audit View...................................................................................................................................
Controls 276
Audit History .........................................................................................................................................
Tab 278
Auditing Performance
.........................................................................................................................................
Issues 279
Audit View.........................................................................................................................................
Performance Issues 279
.........................................................................................................................................................
Package Baselines 279
Baselines ......................................................................................................................................... 280
...................................................................................................................................
Manage Baselines 281
...................................................................................................................................
Create Baselines 282
The Compare ...................................................................................................................................
Utility (Diff) 283
Compare ...................................................................................................................................
Options 284
Example Comparison
......................................................................................................................................... 284
Compare ...................................................................................................................................
Utility Tab Options 285
Model Transfer
.......................................................................................................................................................... 287
XMI.........................................................................................................................................................
Import and Export 288
Export to XMI ......................................................................................................................................... 289
Import from .........................................................................................................................................
XMI 290
Import EMX/UML2 .........................................................................................................................................
Files 291
Limitations.........................................................................................................................................
of XMI 293
The UML DTD ......................................................................................................................................... 293
Controlled.........................................................................................................................................
Packages 293
Controlled...................................................................................................................................
Package Menu 294
Configure...................................................................................................................................
Packages 295
Remove Package ...................................................................................................................................
from Control 296

Enterprise Architect User Guide

 Contents VI

Save a Package ................................................................................................................................... 297

Load a Package ................................................................................................................................... 297
Batch XMI...................................................................................................................................
Export 298
Batch XMI...................................................................................................................................
Import 298
Manual Version ...................................................................................................................................
Control with XMI 299
CSV.........................................................................................................................................................
Import and Export 300
CSV Specifications
......................................................................................................................................... 300
CSV Export ......................................................................................................................................... 303
CSV Import ......................................................................................................................................... 305
.........................................................................................................................................................
Project Data Transfer 306
Perform a .........................................................................................................................................
Project Data Transfer 307
Why Compare .........................................................................................................................................
Projects? 308
Compare Projects......................................................................................................................................... 308
Copy Packages .........................................................................................................................................
Between Projects 309
Project ...................................................................................................................................
Management 312
The Project
..........................................................................................................................................................
Management Window 312
Project Resources
.......................................................................................................................................................... 313
.........................................................................................................................................................
Resource Allocation 314
.........................................................................................................................................................
Effort Management 315
Risk.........................................................................................................................................................
Management 316
.........................................................................................................................................................
Metrics 317
.........................................................................................................................................................
Resource Report 318
.........................................................................................................................................................
Effort Types 319
.........................................................................................................................................................
Metric Types 320
Risk.........................................................................................................................................................
Types 322
The System
..........................................................................................................................................................
Window 323
Project Glossary
.......................................................................................................................................................... 323
The.........................................................................................................................................................
Glossary Dialog 324
.........................................................................................................................................................
Project Glossary Tab 325
.........................................................................................................................................................
Generate a Report 328
.........................................................................................................................................................
Glossary Report Output Sample 328
Project Tasks
.......................................................................................................................................................... 329
Add,.........................................................................................................................................................
Modify and Delete Tasks 330
Project Issues
.......................................................................................................................................................... 331
.........................................................................................................................................................
Project Issues Dialog 331
.........................................................................................................................................................
Project Issues Tab 332
Add,.........................................................................................................................................................
Delete and Modify Issues 334
.........................................................................................................................................................
Report From Project Issues Dialog 334
.........................................................................................................................................................
Report From Project Issues Tab 334
.........................................................................................................................................................
Report Output Sample 335
Use Case..........................................................................................................................................................
Estimation 335
.........................................................................................................................................................
Technical Complexity Factors 336
.........................................................................................................................................................
Environment Complexity Factors 337
.........................................................................................................................................................
Estimating Project Size 338
.........................................................................................................................................................
Default Hours 340
Update Package
..........................................................................................................................................................
Status 340
Manage..........................................................................................................................................................
Bookmarks 341
Monitor ..........................................................................................................................................................
Events 342
Maintenance
................................................................................................................................... 344
Project Data
..........................................................................................................................................................
Integrity 344
.........................................................................................................................................................
Check Project Data Integrity 344
Run.........................................................................................................................................................
SQL Patches 346
Project Upgrade
.......................................................................................................................................................... 346
The.........................................................................................................................................................
Upgrade Wizard 347
.........................................................................................................................................................
Upgrade Replicas 347
Rename..........................................................................................................................................................
a Project 348
Compact ..........................................................................................................................................................
a Project 348
Repair a..........................................................................................................................................................
Project 348
© 1998-2010 Sparx Systems Pty Ltd
 VII Contents

Local Options
................................................................................................................................... 350
General.......................................................................................................................................................... 351
Standard
..........................................................................................................................................................
Colors 353
Diagram.......................................................................................................................................................... 355
.........................................................................................................................................................
Appearance 356
Set Default.........................................................................................................................................
Fonts 357
.........................................................................................................................................................
Behavior 359
.........................................................................................................................................................
Sequence 360
Objects .......................................................................................................................................................... 362
.........................................................................................................................................................
Element Visibility 363
Links .......................................................................................................................................................... 364
Communication
..........................................................................................................................................................
Message Colors 366
XML Specifications
.......................................................................................................................................................... 367

Part IV Modeling Fundamentals 370

Modeling
................................................................................................................................... 371
Models ................................................................................................................................... 372
Model Wizard
.......................................................................................................................................................... 372
Model Templates
.......................................................................................................................................................... 373
.........................................................................................................................................................
Business Process Model Template 374
.........................................................................................................................................................
Requirements Model Template 374
Use.........................................................................................................................................................
Case Model Template 375
.........................................................................................................................................................
Domain Model Template 376
.........................................................................................................................................................
Class Model Template 376
.........................................................................................................................................................
Database Model Template 377
.........................................................................................................................................................
Component Model Template 378
.........................................................................................................................................................
Deployment Model Template 378
.........................................................................................................................................................
Testing Model Template 380
.........................................................................................................................................................
Maintenance Model Template 381
.........................................................................................................................................................
Project Model Template 381
Views ................................................................................................................................... 383
Add Views
.......................................................................................................................................................... 383
Rename..........................................................................................................................................................
Views 384
Delete Views
.......................................................................................................................................................... 385
Packages
................................................................................................................................... 387
Open Package
..........................................................................................................................................................
in the Project Browser 387
Add a Package
.......................................................................................................................................................... 387
Rename..........................................................................................................................................................
a Package 388
Copy a Package
.......................................................................................................................................................... 388
Drag a Package
..........................................................................................................................................................
Onto a Diagram 389
Show or..........................................................................................................................................................
Hide Package Contents 389
Delete a..........................................................................................................................................................
Package 390
Diagrams
................................................................................................................................... 391
Diagram..........................................................................................................................................................
Context Menu 394
.........................................................................................................................................................
Insert Elements and Connectors 395
Print Preview
.......................................................................................................................................................... 395
Diagram..........................................................................................................................................................
View 396
Diagram..........................................................................................................................................................
Tabs 397
Diagram..........................................................................................................................................................
Toolbox 399
.........................................................................................................................................................
Toolbox Appearance Options 401
.........................................................................................................................................................
Toolbox Shortcut Menu 403
.........................................................................................................................................................
Common Group 405
Use.........................................................................................................................................................
Case Group 406
.........................................................................................................................................................
Class Group 407
.........................................................................................................................................................
Object Group 408
.........................................................................................................................................................
Composite Group 409

Enterprise Architect User Guide

 Contents VIII

.........................................................................................................................................................
Communication Group 409
.........................................................................................................................................................
Interaction Group 410
.........................................................................................................................................................
Timing Group 410
.........................................................................................................................................................
State Group 411
.........................................................................................................................................................
Activity Group 412
.........................................................................................................................................................
Component Group 412
.........................................................................................................................................................
Deployment Group 413
.........................................................................................................................................................
Profile Group 414
.........................................................................................................................................................
Metamodel Group 415
.........................................................................................................................................................
Analysis Group 416
.........................................................................................................................................................
Custom Group 417
.........................................................................................................................................................
Requirement Group 418
.........................................................................................................................................................
Maintenance Group 418
User.........................................................................................................................................................
Interface Group 419
WSDL.........................................................................................................................................................
Group 420
XML.........................................................................................................................................................
Schema Group 420
Data.........................................................................................................................................................
Modeling Group 421
Diagram..........................................................................................................................................................
Tasks 421
Add.........................................................................................................................................................
New Diagrams 422
.........................................................................................................................................................
Diagram Properties 423
General Tab ......................................................................................................................................... 424
Diagram Tab ......................................................................................................................................... 425
Elements Tab ......................................................................................................................................... 426
Features Tab ......................................................................................................................................... 427
Connectors .........................................................................................................................................
Tab 428
Visible Class .........................................................................................................................................
Members 429
.........................................................................................................................................................
Paste from Project Browser 430
Paste Multiple .........................................................................................................................................
Items 431
Paste Composite .........................................................................................................................................
Elements 431
Paste Activities......................................................................................................................................... 432
Copy.........................................................................................................................................................
And Paste Diagram Element 433
.........................................................................................................................................................
Place Related Elements on Diagram 433
.........................................................................................................................................................
Delete Diagram 434
.........................................................................................................................................................
Rename Diagram 434
.........................................................................................................................................................
Change Diagram Type 434
.........................................................................................................................................................
Diagram Navigation Hotkeys 435
Copy.........................................................................................................................................................
Image to Disk 435
Copy.........................................................................................................................................................
Image to Clipboard 436
Copy.........................................................................................................................................................
(Duplicate) Diagram 436
.........................................................................................................................................................
Z Order Elements 437
Set .........................................................................................................................................................
the Default Diagram 437
Open.........................................................................................................................................................
Package From Diagram 438
.........................................................................................................................................................
Feature Visibility 438
.........................................................................................................................................................
Insert Diagram Properties Note 440
.........................................................................................................................................................
Create Legends 441
.........................................................................................................................................................
Autosize Elements 444
.........................................................................................................................................................
Swimlanes Matrix 444
.........................................................................................................................................................
Using the Image Manager 447
Create Custom .........................................................................................................................................
Diagram Background 448
Import Image .........................................................................................................................................
Library 449
Swimlanes......................................................................................................................................... 450
Show.........................................................................................................................................................
Realized Interfaces of Class 452
.........................................................................................................................................................
Label Menu Section 452
Pan.........................................................................................................................................................
and Zoom a Diagram 453
Move.........................................................................................................................................................
Elements In Diagram Sections 454
View.........................................................................................................................................................
Last and Next Diagram 455
Set .........................................................................................................................................................
Diagram Page Size 455
.........................................................................................................................................................
Scale Image to Page Size 456

© 1998-2010 Sparx Systems Pty Ltd

 IX Contents

Lock.........................................................................................................................................................
Diagram 457
Undo.........................................................................................................................................................
Last Action 458
Redo.........................................................................................................................................................
Last Action 458
Layout Diagrams
.......................................................................................................................................................... 458
.........................................................................................................................................................
Circular/Elliptical Layout 459
Box.........................................................................................................................................................
Layout 463
Per .........................................................................................................................................................
Page Layout 464
.........................................................................................................................................................
Digraph Layout 465
.........................................................................................................................................................
Spring Layout 466
.........................................................................................................................................................
Neaten Layout 467
.........................................................................................................................................................
Converge/Diverge Layout 467
Fan.........................................................................................................................................................
Relations Layout 469
Auto.........................................................................................................................................................
Route Layout 470
Lay .........................................................................................................................................................
Out a Diagram Automatically 471
The Quick
..........................................................................................................................................................
Linker 474
.........................................................................................................................................................
Create New Elements 475
.........................................................................................................................................................
Create Connectors 476
Elements
................................................................................................................................... 478
Element..........................................................................................................................................................
Property Displays 480
.........................................................................................................................................................
Properties Dialog 481
General Settings......................................................................................................................................... 482
Advanced...................................................................................................................................
Settings 483
Details ......................................................................................................................................... 484
Requirements ......................................................................................................................................... 485
...................................................................................................................................
External Requirements 487
Constraints ......................................................................................................................................... 488
Links ......................................................................................................................................... 489
Scenarios ......................................................................................................................................... 490
Structured...................................................................................................................................
Specification Tab 493
Set Up Scenario ...................................................................................................................................
Specification 494
Structured...................................................................................................................................
Specification Toolbar 495
Structured...................................................................................................................................
Specification Item Context Menu 496
Structured...................................................................................................................................
Specification Selected Text Context Menu 497
Structured...................................................................................................................................
Specification Entry Points Context Menu 498
Structured...................................................................................................................................
Specification Floating Toolbar 499
Generate ...................................................................................................................................
Diagrams 499
Generated...................................................................................................................................
Activity Diagram 500
Generated...................................................................................................................................
RuleFlow Diagram 501
Generated...................................................................................................................................
State Machine Diagram 501
Generated...................................................................................................................................
Sequence Diagram 503
Generated...................................................................................................................................
Robustness Diagram 504
Generate ...................................................................................................................................
Test Cases 505
...................................................................................................................................
Context References Tab 506
...................................................................................................................................
Scenario Constraints Tab 507
Associated.........................................................................................................................................
Files 507
Tagged Values .........................................................................................................................................
Tab 508
.........................................................................................................................................................
Properties Docked Window 508
The.........................................................................................................................................................
Element Browser 510
Generate Scenario
.........................................................................................................................................
From Activity Diagram 513
The.........................................................................................................................................................
Scenarios & Requirements Window 514
.........................................................................................................................................................
Select <Item> Dialog 515
Select Property .........................................................................................................................................
Dialog 517
Object Classifiers
.......................................................................................................................................................... 519
Using.........................................................................................................................................................
Classifiers 520
Visual Representation
.......................................................................................................................................................... 520
.........................................................................................................................................................
Element Icons 521
.........................................................................................................................................................
Compartments 521
Element..........................................................................................................................................................
Tasks 522

Enterprise Architect User Guide

 Contents X

.........................................................................................................................................................
Create Elements 523
Add.........................................................................................................................................................
Elements Directly To Packages 524
Use.........................................................................................................................................................
Auto Naming and Auto Counters 525
Set .........................................................................................................................................................
Element Parent 526
Show .........................................................................................................................................................
Element Use 526
Set .........................................................................................................................................................
Up Cross References 527
Move .........................................................................................................................................................
Elements Within Diagrams 529
Move .........................................................................................................................................................
Elements Between Packages 530
Copy .........................................................................................................................................................
Elements Between Packages 531
.........................................................................................................................................................
Change Element Type 532
Align.........................................................................................................................................................
Elements 532
.........................................................................................................................................................
Resize Elements 533
.........................................................................................................................................................
Delete Elements 534
.........................................................................................................................................................
Customize Visibility of Elements 535
.........................................................................................................................................................
Create Notes and Text 536
Link.........................................................................................................................................................
Note to Internal Documentation 537
Set .........................................................................................................................................................
an Element's Default Appearance 538
.........................................................................................................................................................
Get/Set Project Custom Colors 540
Set .........................................................................................................................................................
Element Templates Package 542
.........................................................................................................................................................
Highlight Context Element 543
Make .........................................................................................................................................................
Linked Element a Local Copy 544
Copy .........................................................................................................................................................
Features Between Elements 544
Move .........................................................................................................................................................
Features Between Elements 545
Element..........................................................................................................................................................
Context Menu 547
.........................................................................................................................................................
Properties Menu Section 548
Advanced .........................................................................................................................................
Submenu 549
Custom Properties
.........................................................................................................................................
Dialog 550
Add.........................................................................................................................................................
Submenu 550
Insert Related .........................................................................................................................................
Elements 551
Find.........................................................................................................................................................
Submenu 552
.........................................................................................................................................................
Embedded Elements Submenu 552
Embedded.........................................................................................................................................
Elements Window 553
.........................................................................................................................................................
Features Menu Section 554
Code .........................................................................................................................................................
Engineering Menu Section 554
.........................................................................................................................................................
Appearance Menu Section 555
Set Element .........................................................................................................................................
Font 556
.........................................................................................................................................................
Element Multiple Selection Menu 557
Attributes
.......................................................................................................................................................... 558
.........................................................................................................................................................
Attributes Dialog - General Tab 560
.........................................................................................................................................................
Attributes Dialog - Detail 562
.........................................................................................................................................................
Attributes Dialog - Constraints 563
.........................................................................................................................................................
Attribute Tagged Values 564
.........................................................................................................................................................
Create Properties 565
.........................................................................................................................................................
Display Inherited Attributes 567
.........................................................................................................................................................
Create Object From Attribute 568
Behavior .......................................................................................................................................................... 569
.........................................................................................................................................................
Operations 569
Operations.........................................................................................................................................
Dialog - General 570
Operations ...................................................................................................................................
Dialog - Behavior 573
Initial Code ................................................................................................................................... 576
Operations ...................................................................................................................................
Dialog - Constraints 577
Operation .........................................................................................................................................
Tagged Values 577
Override Parent .........................................................................................................................................
Operations 578
Display Inherited
.........................................................................................................................................
Operations 579
.........................................................................................................................................................
Interactions and Activities 581
.........................................................................................................................................................
Behavior Calls 581
Associate .........................................................................................................................................
with Different Behaviors 582
Synchronize .........................................................................................................................................
Arguments 582

© 1998-2010 Sparx Systems Pty Ltd

 XI Contents

.........................................................................................................................................................
Behavior Call Arguments 582
.........................................................................................................................................................
Behavior Parameters 583
Parameters .........................................................................................................................................
Dialog 583
Parameter.........................................................................................................................................
Tagged Values 585
Operation .........................................................................................................................................
Parameters by Reference 586
In-place..........................................................................................................................................................
Editing Options 586
.........................................................................................................................................................
In-place Editing Tasks 586
Edit.........................................................................................................................................................
Element Item Name 588
Edit.........................................................................................................................................................
Feature Stereotype 588
Edit.........................................................................................................................................................
Feature Scope 589
Edit.........................................................................................................................................................
Attribute Keyword 590
Edit.........................................................................................................................................................
Operation Parameter Keyword 591
Edit.........................................................................................................................................................
Parameter Kind 592
.........................................................................................................................................................
Insert New Feature 592
.........................................................................................................................................................
Insert Operation Parameter 593
.........................................................................................................................................................
Insert Maintenance Feature 594
.........................................................................................................................................................
Insert Testing Features 595
Linked Documents
.......................................................................................................................................................... 597
.........................................................................................................................................................
Create Document Artifact 599
Link.........................................................................................................................................................
Document to UML Element 599
Edit.........................................................................................................................................................
Linked Documents 600
.........................................................................................................................................................
Hyperlink From Linked Document 601
.........................................................................................................................................................
Create Element From Document 602
.........................................................................................................................................................
Replace or Delete Documents 602
.........................................................................................................................................................
Create Linked Document Templates 603
Edit.........................................................................................................................................................
Linked Document Templates 604
Connectors
................................................................................................................................... 606
Connector
..........................................................................................................................................................
Context Menu 606
.........................................................................................................................................................
Properties Menu Section 607
.........................................................................................................................................................
Type-Specific Menu Section 607
.........................................................................................................................................................
Advanced Menu Section 608
Style.........................................................................................................................................................
Menu Section 608
.........................................................................................................................................................
Appearance Menu Section 609
Connector
..........................................................................................................................................................
Tasks 609
.........................................................................................................................................................
Connect Elements 610
.........................................................................................................................................................
Connect to Element Feature 611
Add.........................................................................................................................................................
a Note to a Connector 612
.........................................................................................................................................................
Arrange Connectors 613
.........................................................................................................................................................
Change Connector Type 614
.........................................................................................................................................................
Change the Source or Target Element 614
.........................................................................................................................................................
Connector Styles 615
.........................................................................................................................................................
Create Connector in Project Browser 618
.........................................................................................................................................................
Relationship Visibility 619
.........................................................................................................................................................
Delete Connectors 619
.........................................................................................................................................................
Generalization Sets 620
.........................................................................................................................................................
Hide/Show Connectors 621
.........................................................................................................................................................
Hide/Show Labels 622
.........................................................................................................................................................
Connector In-place Editing Options 623
.........................................................................................................................................................
Reverse Connector 623
Set .........................................................................................................................................................
Association Specializations 623
.........................................................................................................................................................
Change Sequence Message Scope 624
Show .........................................................................................................................................................
Uses Arrow Head 625
Tree.........................................................................................................................................................
Style Hierarchy 625
Connector
..........................................................................................................................................................
Properties 626
.........................................................................................................................................................
Connector Constraints 628
.........................................................................................................................................................
Source Role 629
.........................................................................................................................................................
Target Role 631
.........................................................................................................................................................
Connector Tagged Values 631

Enterprise Architect User Guide

 Contents XII

Tagged ...................................................................................................................................
Values 632
Quick Add
..........................................................................................................................................................
- Tagged Value To Elements 634
Assign a..........................................................................................................................................................
Tagged Value to an Item 635
Assign Notes
..........................................................................................................................................................
to a Tagged Value 636
Show Duplicate
..........................................................................................................................................................
Tags 637
Advanced..........................................................................................................................................................
Tag Management 638
Notes ................................................................................................................................... 641
Notes Toolbar
.......................................................................................................................................................... 642
Reference
...................................................................................................................................
Data 644
People .......................................................................................................................................................... 645
.........................................................................................................................................................
Project Authors 645
.........................................................................................................................................................
Project Roles 648
.........................................................................................................................................................
Project Resources 650
.........................................................................................................................................................
Project Clients 651
General..........................................................................................................................................................
Types 653
.........................................................................................................................................................
Status Types 653
.........................................................................................................................................................
Constraint Types 655
.........................................................................................................................................................
Constraint Status Types 656
.........................................................................................................................................................
Requirement Types 657
.........................................................................................................................................................
Scenario Types 658
.........................................................................................................................................................
Metrics and Estimation 659
Maintenance
.......................................................................................................................................................... 660
.........................................................................................................................................................
Problem Types 660
.........................................................................................................................................................
Testing Types 661
UML Types
.......................................................................................................................................................... 662
.........................................................................................................................................................
Stereotype Settings 662
Shape Editor ......................................................................................................................................... 664
.........................................................................................................................................................
Tagged Value Types 664
.........................................................................................................................................................
Cardinality 665
Data.........................................................................................................................................................
Types 666
Resources
.......................................................................................................................................................... 667
.........................................................................................................................................................
Favorites 669

Part V Modeling Languages 671

Standard
...................................................................................................................................
UML Models 672
UML Diagrams
.......................................................................................................................................................... 673
.........................................................................................................................................................
Behavioral Diagrams 673
Activity Diagram......................................................................................................................................... 674
Use Case .........................................................................................................................................
Diagram 676
State Machine .........................................................................................................................................
Diagrams 678
Regions ................................................................................................................................... 681
Pseudo-States ................................................................................................................................... 682
State Machine .........................................................................................................................................
Table 682
State Machine ...................................................................................................................................
Table Options 684
State Machine ...................................................................................................................................
Table Operations 686
Change State ...................................................................................................................................
Machine Table Position 687
Change State ...................................................................................................................................
Machine Table Size 687
Insert New ...................................................................................................................................
State 687
Insert Trigger ................................................................................................................................... 688
Insert/Change ...................................................................................................................................
Transition 688
Reposition...................................................................................................................................
State or Trigger Cells 689
Add Legend ................................................................................................................................... 689
Find Cell in ...................................................................................................................................
State Machine Diagram 689
State Machine ...................................................................................................................................
Table Conventions 689
Export State ...................................................................................................................................
Table To CSV File 690
Timing Diagram ......................................................................................................................................... 690
Create a Timing ...................................................................................................................................
Diagram 692
© 1998-2010 Sparx Systems Pty Ltd
 XIII Contents

Set a Time...................................................................................................................................
Range 692
...................................................................................................................................
Edit a Timing Diagram 692
...................................................................................................................................
Add and Edit State Lifeline 693
...................................................................................................................................
Edit States In State Lifeline 693
...................................................................................................................................
Edit Transitions In State Lifeline 694
...................................................................................................................................
Add and Edit Value Lifeline 696
Add States...................................................................................................................................
In Value Lifeline 696
...................................................................................................................................
Edit Transitions In Value Lifeline 696
Configure...................................................................................................................................
Timeline - States 697
Configure...................................................................................................................................
Timeline - Transitions 699
...................................................................................................................................
Time Intervals 700
...................................................................................................................................
Time Interval Operations 703
Sequence.........................................................................................................................................
Diagram 706
...................................................................................................................................
Denote Lifecycle of an Element 708
Layout of ...................................................................................................................................
Sequence Diagrams 709
Sequence...................................................................................................................................
Elements 710
Sequence...................................................................................................................................
Diagrams and Version Control 710
Sequence...................................................................................................................................
Element Activation 711
...................................................................................................................................
Lifeline Activation Levels 712
Sequence...................................................................................................................................
Message Label Visibility 714
Change the ...................................................................................................................................
Top Margin 714
Inline Sequence...................................................................................................................................
Elements 714
Communication .........................................................................................................................................
Diagram 715
Communication ...................................................................................................................................
Diagrams in Color 716
Interaction.........................................................................................................................................
Overview Diagram 717
.........................................................................................................................................................
Structural Diagrams 719
Package Diagram ......................................................................................................................................... 720
Class Diagram ......................................................................................................................................... 721
Object Diagram ......................................................................................................................................... 723
Composite.........................................................................................................................................
Structure Diagram 724
Properties................................................................................................................................... 726
Deployment .........................................................................................................................................
Diagram 727
Component .........................................................................................................................................
Diagram 730
Profile Diagram ......................................................................................................................................... 732
.........................................................................................................................................................
Extended Diagrams 733
Analysis Diagram......................................................................................................................................... 733
Custom Diagram ......................................................................................................................................... 734
Requirements .........................................................................................................................................
Diagram 736
Maintenance .........................................................................................................................................
Diagram 737
User Interface .........................................................................................................................................
Diagram 738
Database .........................................................................................................................................
Schema 739
Business Modeling/Interaction
......................................................................................................................................... 739
UML Elements
.......................................................................................................................................................... 741
.........................................................................................................................................................
Behavioral Diagram Elements 742
Action ......................................................................................................................................... 743
Action Notation ................................................................................................................................... 745
Set Feature ...................................................................................................................................
Dialog 748
Action Expansion...................................................................................................................................
Node 749
Action Pin................................................................................................................................... 749
Assign Action ...................................................................................................................................
Pins 751
Local Pre/Post ...................................................................................................................................
Conditions 752
Activity ......................................................................................................................................... 753
................................................................................................................................... 754
Activity Notation
...................................................................................................................................
Activity Parameter Nodes 755
................................................................................................................................... 756
Activity Partition
Actor ......................................................................................................................................... 757
Central Buffer
.........................................................................................................................................
Node 758
Choice ......................................................................................................................................... 758

Enterprise Architect User Guide

 Contents XIV

Combined.........................................................................................................................................
Fragment 759
...................................................................................................................................
Create a Combined Fragment 761
Interaction...................................................................................................................................
Operators 762
Datastore ......................................................................................................................................... 764
Decision ......................................................................................................................................... 765
Diagram Frame
......................................................................................................................................... 766
Diagram Gate
......................................................................................................................................... 767
Endpoint ......................................................................................................................................... 768
Entry Point......................................................................................................................................... 769
Exception ......................................................................................................................................... 769
Expansion.........................................................................................................................................
Region 769
...................................................................................................................................
Add Expansion Region 771
Exit Point ......................................................................................................................................... 771
Final ......................................................................................................................................... 772
Flow Final......................................................................................................................................... 772
Fork/Join ......................................................................................................................................... 773
Fork ................................................................................................................................... 775
Join ................................................................................................................................... 776
History ......................................................................................................................................... 777
Initial ......................................................................................................................................... 778
Interaction......................................................................................................................................... 779
Interaction.........................................................................................................................................
Occurrence 780
Interruptible
.........................................................................................................................................
Activity Region 781
...................................................................................................................................
Add Interruptible Activity Region 782
Junction ......................................................................................................................................... 782
Lifeline ......................................................................................................................................... 783
Merge ......................................................................................................................................... 784
Message Endpoint
......................................................................................................................................... 784
Message Label
......................................................................................................................................... 785
Note ......................................................................................................................................... 785
Partition ......................................................................................................................................... 786
Receive ......................................................................................................................................... 787
Region ......................................................................................................................................... 788
Send ......................................................................................................................................... 789
State ......................................................................................................................................... 789
Composite ...................................................................................................................................
State 790
State/Continuation
......................................................................................................................................... 792
...................................................................................................................................
Continuation 792
...................................................................................................................................
State Invariant 793
State Lifeline ......................................................................................................................................... 794
State Machine ......................................................................................................................................... 796
Structured.........................................................................................................................................
Activity 796
Structured...................................................................................................................................
and Sequential Nodes 798
Loop and ...................................................................................................................................
Conditional Nodes 798
Synch ......................................................................................................................................... 802
System Boundary ......................................................................................................................................... 802
Boundary...................................................................................................................................
Element Settings 803
Terminate......................................................................................................................................... 804
Trigger ......................................................................................................................................... 804
Use Case ......................................................................................................................................... 806
Use Case...................................................................................................................................
Extension Points 807
Rectangle...................................................................................................................................
Notation 808
Value Lifeline ......................................................................................................................................... 808
.........................................................................................................................................................
Structural Diagram Elements 809
Artifact ......................................................................................................................................... 810
Class ......................................................................................................................................... 811
Active Classes ................................................................................................................................... 812
Parameterized ...................................................................................................................................
Classes (Templates) 813

© 1998-2010 Sparx Systems Pty Ltd

 XV Contents

Collaboration
......................................................................................................................................... 814
Collaboration
.........................................................................................................................................
Occurrence 815
Component ......................................................................................................................................... 816
Data Type......................................................................................................................................... 817
Deployment.........................................................................................................................................
Spec 818
Device ......................................................................................................................................... 818
Document.........................................................................................................................................
Artifact 819
Enumeration
......................................................................................................................................... 819
Execution .........................................................................................................................................
Environment 820
Expose Interface
......................................................................................................................................... 820
Information
.........................................................................................................................................
Item 821
Interface ......................................................................................................................................... 821
Node ......................................................................................................................................... 822
Object ......................................................................................................................................... 823
Run-time ...................................................................................................................................
State 823
...................................................................................................................................
Define a Run-time Variable 824
Remove a...................................................................................................................................
Defined Variable 824
...................................................................................................................................
Object State 824
Package ......................................................................................................................................... 825
Part ......................................................................................................................................... 825
Add Property ...................................................................................................................................
Value 826
Port ......................................................................................................................................... 826
Add a Port...................................................................................................................................
to an Element 827
Inherited and ...................................................................................................................................
Redefined Ports 827
The Property ...................................................................................................................................
Tab 829
Primitive ......................................................................................................................................... 829
Qualifiers ......................................................................................................................................... 830
Qualifiers ...................................................................................................................................
Dialog 832
Signal ......................................................................................................................................... 834
.........................................................................................................................................................
Inbuilt and Extension Stereotypes 835
Analysis Stereotypes
......................................................................................................................................... 835
Boundary ......................................................................................................................................... 836
...................................................................................................................................
Create a Boundary 836
Composite.........................................................................................................................................
Elements 837
Control ......................................................................................................................................... 838
...................................................................................................................................
Create a Control Element 838
Entity ......................................................................................................................................... 839
Create an...................................................................................................................................
Entity 839
Event ......................................................................................................................................... 839
Feature ......................................................................................................................................... 840
Hyperlinks......................................................................................................................................... 840
Hyperlinks...................................................................................................................................
To Files 842
...................................................................................................................................
Script Hyperlinks 842
Add Action ...................................................................................................................................
As Hyperlink 842
Hyperlinks...................................................................................................................................
Between Diagrams 842
N-Ary Association
......................................................................................................................................... 844
Packaging.........................................................................................................................................
Component 845
Process ......................................................................................................................................... 846
Requirements ......................................................................................................................................... 846
Screen ......................................................................................................................................... 847
Test Case......................................................................................................................................... 848
Table ......................................................................................................................................... 849
UI Control.........................................................................................................................................
Element 849
Web Stereotypes ......................................................................................................................................... 851
UML Connectors
.......................................................................................................................................................... 852
.........................................................................................................................................................
Aggregate 854
Change Aggregation
.........................................................................................................................................
Connector Form 855
.........................................................................................................................................................
Assembly 855

Enterprise Architect User Guide

 Contents XVI

.........................................................................................................................................................
Associate 855
.........................................................................................................................................................
Association Class 856
Connect New .........................................................................................................................................
Class to Association 857
.........................................................................................................................................................
Communication Path 858
.........................................................................................................................................................
Compose 858
.........................................................................................................................................................
Connector 859
.........................................................................................................................................................
Control Flow 860
.........................................................................................................................................................
Delegate 861
.........................................................................................................................................................
Dependency 861
Apply a Stereotype
......................................................................................................................................... 862
.........................................................................................................................................................
Deployment 862
.........................................................................................................................................................
Extend 862
.........................................................................................................................................................
Generalize 863
.........................................................................................................................................................
Include 864
.........................................................................................................................................................
Information Flow 864
Convey Information
.........................................................................................................................................
on a Flow 865
Realize an.........................................................................................................................................
Information Flow 866
.........................................................................................................................................................
Interrupt Flow 867
.........................................................................................................................................................
Manifest 867
.........................................................................................................................................................
Message 867
Message (Sequence
.........................................................................................................................................
Diagram) 868
................................................................................................................................... 871
Self-Message
Call ................................................................................................................................... 872
Message ...................................................................................................................................
Examples 873
Change the ...................................................................................................................................
Timing Details 874
................................................................................................................................... 876
General Ordering
...................................................................................................................................
Asynchronous Signal Message 877
Message (Communication
.........................................................................................................................................
Diagram) 879
...................................................................................................................................
Create a Communication Message 880
Re-Order ...................................................................................................................................
Messages 880
Message (Timing .........................................................................................................................................
Diagram) 882
Create a Timing...................................................................................................................................
Message 883
......................................................................................................................................................... 885
Nesting
......................................................................................................................................................... 886
Notelink
.........................................................................................................................................................
Object Flow 886
Object Flows .........................................................................................................................................
in Activity Diagrams 886
.........................................................................................................................................................
Occurrence 888
.........................................................................................................................................................
Package Import 888
.........................................................................................................................................................
Package Merge 888
.........................................................................................................................................................
Realize 889
.........................................................................................................................................................
Recursion 890
Role.........................................................................................................................................................
Binding 890
.........................................................................................................................................................
Represents 891
.........................................................................................................................................................
Representation 891
.........................................................................................................................................................
Trace 892
.........................................................................................................................................................
Transition 892
Use......................................................................................................................................................... 894
UML Stereotypes
.......................................................................................................................................................... 895
.........................................................................................................................................................
Apply Stereotypes 896
.........................................................................................................................................................
Stereotype Selector 897
.........................................................................................................................................................
Stereotype Visibility 898
.........................................................................................................................................................
Standard Stereotypes 899
.........................................................................................................................................................
Stereotypes with Alternative Images 900
UML Patterns
.......................................................................................................................................................... 901
.........................................................................................................................................................
Create a Pattern 902
.........................................................................................................................................................
Import a Pattern 904
Use.........................................................................................................................................................
a Pattern 904
UML Profiles
.......................................................................................................................................................... 906

© 1998-2010 Sparx Systems Pty Ltd

 XVII Contents

Use.........................................................................................................................................................
Profiles 907
Import a UML .........................................................................................................................................
Profile 908
Add Profile.........................................................................................................................................
Objects and Features to a Diagram 909
Tagged Values .........................................................................................................................................
in Profiles 910
Synchronize .........................................................................................................................................
Tagged Values and Constraints 910
.........................................................................................................................................................
Profile References 912
Supported.........................................................................................................................................
Types 912
Profile Structure
......................................................................................................................................... 913
Attributes .........................................................................................................................................
Supported in XML Profile 914
Example Profile ......................................................................................................................................... 915
Specialized
...................................................................................................................................
UML Models 917
Requirements
.......................................................................................................................................................... 917
.........................................................................................................................................................
Create Requirements 918
Requirement .........................................................................................................................................
Properties 919
Color Code ...................................................................................................................................
External Requirements 920
Extend Requirement
.........................................................................................................................................
Properties 920
Display Tagged ...................................................................................................................................
Values On Diagrams 921
Connect Requirements
......................................................................................................................................... 921
Import Requirements
.........................................................................................................................................
and Hierarchies in CSV 922
.........................................................................................................................................................
Model Requirements 922
Internal Requirements
......................................................................................................................................... 925
Make Internal ...................................................................................................................................
Requirement External 926
.........................................................................................................................................................
Manage Requirements 927
View Requirements
......................................................................................................................................... 928
Trace Use.........................................................................................................................................
of Requirements 928
Manage Requirement
.........................................................................................................................................
Changes 928
Report on .........................................................................................................................................
Requirements 929
Business
..........................................................................................................................................................
Models 930
.........................................................................................................................................................
Analysis Models 931
Process Modeling.........................................................................................................................................
Notation 931
Inputs, Resources
.........................................................................................................................................
and Information 931
Events ......................................................................................................................................... 932
Outputs ......................................................................................................................................... 932
Goals ......................................................................................................................................... 933
A Complete .........................................................................................................................................
Business Process 933
Business
..........................................................................................................................................................
Rules 934
.........................................................................................................................................................
Model Business Rules For RuleTasks 937
.........................................................................................................................................................
Create a Business Domain Model 938
.........................................................................................................................................................
Create a Rule Flow Model 939
Pass Parameters .........................................................................................................................................
to Rule Flow Activity 942
Model Rules .........................................................................................................................................
In an Operation 943
.........................................................................................................................................................
Compose Business Rules 945
.........................................................................................................................................................
Validate Business Rules 950
Code.........................................................................................................................................................
Generation For Business Rules 951
BPMN Models
.......................................................................................................................................................... 952
.........................................................................................................................................................
Change BPMN Element Appearance 956
.........................................................................................................................................................
Migrate BPMN 1.0 Model to BPMN 1.1 957
BPEL Models
.......................................................................................................................................................... 958
.........................................................................................................................................................
Create a BPEL Model 959
.........................................................................................................................................................
Model a BPEL Process 961
Model Start .........................................................................................................................................
Event 962
Model End.........................................................................................................................................
Event 965
Model Intermediate
.........................................................................................................................................
Event 968
Model Gateway ......................................................................................................................................... 972
Model Activity ......................................................................................................................................... 974
Model Pool ......................................................................................................................................... 979
.........................................................................................................................................................
Model a Sequence Flow Connector 980
.........................................................................................................................................................
Create Assignments 981

Enterprise Architect User Guide

 Contents XVIII

.........................................................................................................................................................
Generate BPEL 983
.........................................................................................................................................................
Create a BPEL Web Service 983
BPEL.........................................................................................................................................................
Model Validation 984
Systems..........................................................................................................................................................
Engineering 986
.........................................................................................................................................................
SysML 989
SysML Model .........................................................................................................................................
Elements 991
SysML Block .........................................................................................................................................
Definition 992
SysML Internal .........................................................................................................................................
Block 994
SysML Parametrics
......................................................................................................................................... 995
SysML Activity ......................................................................................................................................... 996
SysML Interaction
......................................................................................................................................... 998
SysML State .........................................................................................................................................
Machine 999
SysML Use .........................................................................................................................................
Case 1000
SysML Requirements
......................................................................................................................................... 1001
.........................................................................................................................................................
SysML Parametric Models 1002
Simulate .........................................................................................................................................
a SysML Model 1005
.........................................................................................................................................................
Create a Requirements Model 1007
.........................................................................................................................................................
Create an Operational Domain Model 1007
.........................................................................................................................................................
Compose System Design 1009
.........................................................................................................................................................
Create Reusable Subsystems 1011
Data Models
.......................................................................................................................................................... 1011
.........................................................................................................................................................
A Data Model Diagram 1013
.........................................................................................................................................................
Create a Table 1013
.........................................................................................................................................................
Working with Tables 1014
Set Table.........................................................................................................................................
Owner 1016
Set MySQL .........................................................................................................................................
Options 1016
Set Oracle .........................................................................................................................................
Table Properties 1017
Create Columns......................................................................................................................................... 1019
Create Oracle .........................................................................................................................................
Packages 1022
.........................................................................................................................................................
Primary Key 1022
SQL Server .........................................................................................................................................
Non Clustered Keys 1024
.........................................................................................................................................................
Foreign Key 1024
Create Foreign.........................................................................................................................................
Key 1025
Define Foreign.........................................................................................................................................
Key Name Template 1028
.........................................................................................................................................................
Stored Procedures 1030
Create Individual
.........................................................................................................................................
Class Procedure 1030
.........................................................................................................................................................
Advanced Topics 1031
Views ......................................................................................................................................... 1032
Index, Trigger,
.........................................................................................................................................
Check Constraint 1033
Data Type .........................................................................................................................................
Conversion Procedure 1035
Data Type .........................................................................................................................................
Conversion for a Package 1036
DBMS Datatypes......................................................................................................................................... 1037
XML Schema
..........................................................................................................................................................
- XSD 1039
XML.........................................................................................................................................................
Technologies 1039
.........................................................................................................................................................
Model XSD 1040
UML Profile .........................................................................................................................................
for XSD 1041
XSD Datatypes .........................................................................................................................................
Package 1047
Abstract .........................................................................................................................................
XSD models 1047
Default UML ...................................................................................................................................
to XSD Mappings 1049
Web Services
..........................................................................................................................................................
- WSDL 1049
.........................................................................................................................................................
Model WSDL 1050
WSDL Namespace......................................................................................................................................... 1051
WSDL Document ......................................................................................................................................... 1053
WSDL Service ......................................................................................................................................... 1054
WSDL Port .........................................................................................................................................
Type 1056
WSDL Message ......................................................................................................................................... 1056
WSDL Binding ......................................................................................................................................... 1057
WSDL Port .........................................................................................................................................
Type Operation 1059

© 1998-2010 Sparx Systems Pty Ltd

 XIX Contents

WSDL Message .........................................................................................................................................

Part 1060
SPEM .......................................................................................................................................................... 1061
.........................................................................................................................................................
SPEM Toolbox Pages 1062
MDG Technologies
..........................................................................................................................................................
- Using 1066
.........................................................................................................................................................
Work with MDG Technologies 1067
Manage MDG .........................................................................................................................................
Technologies 1069
Access Remote ...................................................................................................................................
MDG Technologies 1070
.........................................................................................................................................................
Import MDG Technologies 1071
.........................................................................................................................................................
Extensions - MDG Technologies 1073
.........................................................................................................................................................
Archimate 1073
.........................................................................................................................................................
Data Flow Diagrams 1076
.........................................................................................................................................................
Entity Relationship Diagrams (ERDs) 1077
.........................................................................................................................................................
Eriksson-Penker Extensions 1080
GoF.........................................................................................................................................................
Patterns 1083
.........................................................................................................................................................
ICONIX 1084
.........................................................................................................................................................
Mind Mapping 1087
.........................................................................................................................................................
SoaML 1089
Build Your
...................................................................................................................................
Own Modeling Language 1092
MDG Technology
..........................................................................................................................................................
SDK 1092
.........................................................................................................................................................
Developing Profiles 1093
Custom Stereotypes
......................................................................................................................................... 1093
Create Profiles
......................................................................................................................................... 1095
Create a...................................................................................................................................
Profile Package 1095
...................................................................................................................................
Add Stereotypes and Metaclasses 1096
...................................................................................................................................
Define Stereotype Tagged Values 1098
...................................................................................................................................
With Predefined Tag Types 1099
With Supported...................................................................................................................................
Attributes 1100
Use the ...................................................................................................................................
Tagged Value Connector 1101
...................................................................................................................................
Define Stereotype Constraints 1101
...................................................................................................................................
Add Enumeration Elements 1103
Add Shape ...................................................................................................................................
Scripts 1104
Set Default ...................................................................................................................................
Appearance 1106
Export a...................................................................................................................................
Profile 1106
Save Profile ...................................................................................................................................
Options 1107
Supported ...................................................................................................................................
Attributes 1108
Define a...................................................................................................................................
Stereotype as a Metatype 1109
...................................................................................................................................
Define Multiple-Stereotype Level 1110
...................................................................................................................................
Define Creation of Instance 1110
...................................................................................................................................
Create Composite Elements 1111
Define Child ...................................................................................................................................
Diagram Types 1111
Stereotype ...................................................................................................................................
Profiles 1113
Quick Linker ......................................................................................................................................... 1113
Quick Linker ...................................................................................................................................
Definition Format 1113
Quick Linker ...................................................................................................................................
Example 1115
Hide Default ...................................................................................................................................
Quick Linker Settings 1117
Quick Linker ...................................................................................................................................
Object Names 1117
MDG.........................................................................................................................................................
Technologies - Creating 1118
Create MDG .........................................................................................................................................
Technologies 1118
Add a Profile ................................................................................................................................... 1122
Add a Pattern ................................................................................................................................... 1123
Add a Diagram ...................................................................................................................................
Profile 1124
Add a Toolbox ...................................................................................................................................
Profile 1125
Add Task ...................................................................................................................................
Panel Pages 1126
Add Tagged ...................................................................................................................................
Value Types 1127
Add Code ...................................................................................................................................
Modules 1128
Add MDA ...................................................................................................................................
Transforms 1130
Add Images ................................................................................................................................... 1130
Add Scripts ................................................................................................................................... 1131

Enterprise Architect User Guide

 Contents XX

Add RTF...................................................................................................................................
Report Templates 1132
Add Linked ...................................................................................................................................
Document Templates 1133
Working .........................................................................................................................................
with MTS Files 1133
Customize .........................................................................................................................................
Toolbox Profiles 1134
...................................................................................................................................
Create Toolbox Profiles 1134
Toolbox ...................................................................................................................................
Page Attributes 1135
Create Hidden...................................................................................................................................
Sub-Menus 1135
Override...................................................................................................................................
Default Toolboxes 1136
Assign Icons ...................................................................................................................................
To Toolbox Items 1136
...................................................................................................................................
List of Enterprise Architect Toolboxes 1137
Elements...................................................................................................................................
Used in Toolboxes 1137
Connectors ...................................................................................................................................
Used In Toolboxes 1138
Create Diagram.........................................................................................................................................
Profiles 1139
...................................................................................................................................
Built-In Diagram Types 1140
Attribute...................................................................................................................................
Values - stylex & pdata 1140
Create Tasks .........................................................................................................................................
Pane Profiles 1141
Define Tasks ...................................................................................................................................
Pane Toolboxes 1141
...................................................................................................................................
Built-In Tasks Pane Commands 1142
Run Add-In ...................................................................................................................................
Functions 1143
Define Tasks ...................................................................................................................................
Pane Contexts 1144
Allocate ...................................................................................................................................
Tasks Pane Contexts 1144
Save a Tasks ...................................................................................................................................
Pane Profile 1145
Define Validation
.........................................................................................................................................
Configuration 1145
Incorporate .........................................................................................................................................
Model Templates 1146
Deploy An .........................................................................................................................................
MDG Technology 1146
.........................................................................................................................................................
Shape Scripts 1147
Getting Started
.........................................................................................................................................
With Shape Scripts 1148
Shape Editor ......................................................................................................................................... 1150
Write Scripts ......................................................................................................................................... 1151
...................................................................................................................................
Syntax Grammar 1151
...................................................................................................................................
Shape Attributes 1152
Drawing ...................................................................................................................................
Methods 1154
Color Queries................................................................................................................................... 1158
Conditional ...................................................................................................................................
Branching 1158
Query Methods................................................................................................................................... 1158
...................................................................................................................................
Display Element/Connector Properties 1158
Sub-Shapes ................................................................................................................................... 1160
Reserved ...................................................................................................................................
Names 1161
Miscellaneous................................................................................................................................... 1162
Example .........................................................................................................................................
Scripts 1163
.........................................................................................................................................................
Tagged Value Types 1166
Predefined .........................................................................................................................................
Structured Types 1166
Create Structured
.........................................................................................................................................
Tagged Values 1168
Predefined .........................................................................................................................................
Reference Data Types 1169
Create Reference
.........................................................................................................................................
Data Tagged Values 1170
Create Custom .........................................................................................................................................
Tagged Value Type 1171
.........................................................................................................................................................
Code Template Framework 1172
Code Template .........................................................................................................................................
Syntax 1172
Literal Text ................................................................................................................................... 1172
Macros ................................................................................................................................... 1173
Template...................................................................................................................................
Substitution Macros 1173
...................................................................................................................................
Field Substitution Macros 1174
Tagged Value ...................................................................................................................................
Substitution Macros 1186
Function...................................................................................................................................
Macros 1187
...................................................................................................................................
Control Macros 1190
EASL Code ...................................................................................................................................
Generation Macros 1193
...................................................................................................................................
EASL Collections 1194
...................................................................................................................................
EASL Properties 1196

© 1998-2010 Sparx Systems Pty Ltd

 XXI Contents

Variables................................................................................................................................... 1200
The Code.........................................................................................................................................
Template Editor in MDG Development 1202
Custom ...................................................................................................................................
Templates 1202
Override...................................................................................................................................
Default Templates 1204
Add New...................................................................................................................................
Stereotyped Templates 1205
...................................................................................................................................
Create Custom Language Template 1206

Part VI Navigate, Search and Trace 1208

The Project
...................................................................................................................................
Browser 1209
Order Package
..........................................................................................................................................................
Contents 1210
Set Default
..........................................................................................................................................................
Behavior 1210
Project..........................................................................................................................................................
Browser Toolbar 1212
Project..........................................................................................................................................................
Browser Icon Overlays 1213
Project..........................................................................................................................................................
Browser Context Menus 1213
.........................................................................................................................................................
Model (Root Node) Context Menu 1213
.........................................................................................................................................................
Package Menu 1214
Add Sub-Menu ......................................................................................................................................... 1216
Documentation .........................................................................................................................................
Sub-Menu 1216
Code Engineering
.........................................................................................................................................
Sub-Menu 1217
Execution.........................................................................................................................................
Analyzer Sub-Menu 1217
Import/Export .........................................................................................................................................
Sub-Menu 1218
Contents.........................................................................................................................................
Sub-Menu 1218
.........................................................................................................................................................
Element Menu - Project Browser 1218
Add Sub .........................................................................................................................................
Menu 1219
.........................................................................................................................................................
Diagram Menu - Project Browser 1220
.........................................................................................................................................................
Operation Menu - Project Browser 1221
Model ...................................................................................................................................
Views 1222
Model ..........................................................................................................................................................
Views Toolbar 1223
Model ..........................................................................................................................................................
Views Context Menus 1224
Model ..........................................................................................................................................................
Views Operations 1226
Diagram
..........................................................................................................................................................
Slide Show 1228
Model ...................................................................................................................................
Search 1231
Use the..........................................................................................................................................................
Model Search 1233
Work On..........................................................................................................................................................
Objects In Search 1234
Search..........................................................................................................................................................
Definitions 1235
.........................................................................................................................................................
Advanced Search Options 1238
.........................................................................................................................................................
Create Search Definitions 1239
.........................................................................................................................................................
Pre-defined Searches 1241
Add.........................................................................................................................................................
Filters 1242
Fields and .........................................................................................................................................
Conditions 1243
Traceability
................................................................................................................................... 1245
Packages
..........................................................................................................................................................
and Elements 1246
Create ..........................................................................................................................................................
Traceability Diagrams 1250
Traceability
..........................................................................................................................................................
Tools 1251
The Traceability
..........................................................................................................................................................
Window 1253
Element
...................................................................................................................................
List 1255
Element
..........................................................................................................................................................
List Options 1258
Relationship
...................................................................................................................................
Matrix 1261
Open the
..........................................................................................................................................................
Relationship Matrix 1262
Set Element
..........................................................................................................................................................
Type 1262
Set Connector
..........................................................................................................................................................
Type and Direction 1263
Set Source
..........................................................................................................................................................
and Target Package 1264
Relationship
..........................................................................................................................................................
Matrix Options 1265
Modify..........................................................................................................................................................
Relationships in Matrix 1266
Export..........................................................................................................................................................
to CSV 1267
Matrix ..........................................................................................................................................................
Profiles 1267

Enterprise Architect User Guide

 Contents XXII

Review..........................................................................................................................................................
Source and Target Elements 1268
The Relationships
...................................................................................................................................
Window 1269
Diagram
...................................................................................................................................
Filters 1271
Work With
..........................................................................................................................................................
Diagram Filters 1272
The Pan
...................................................................................................................................
& Zoom Window 1275

Part VII Software Development 1277

Overview
...................................................................................................................................
of Development 1279
Software
...................................................................................................................................
Engineering 1281
Modeling
..........................................................................................................................................................
Conventions 1282
.........................................................................................................................................................
ActionScript Conventions 1283
Ada.........................................................................................................................................................
2005 1284
.........................................................................................................................................................
C Conventions 1285
Object Oriented
.........................................................................................................................................
Programming In C 1286
C#.........................................................................................................................................................
Conventions 1287
C++.........................................................................................................................................................
Conventions 1289
Managed.........................................................................................................................................
C++ Conventions 1290
C++/CLI .........................................................................................................................................
Conventions 1291
.........................................................................................................................................................
Delphi Conventions 1292
.........................................................................................................................................................
Java Conventions 1293
AspectJ Conventions
......................................................................................................................................... 1294
PHP.........................................................................................................................................................
Conventions 1294
.........................................................................................................................................................
Python Conventions 1295
.........................................................................................................................................................
System C Conventions 1295
.........................................................................................................................................................
VB.Net Conventions 1296
.........................................................................................................................................................
Verilog Conventions 1298
.........................................................................................................................................................
VHDL Conventions 1299
.........................................................................................................................................................
Visual Basic Conventions 1301
Code Template
..........................................................................................................................................................
Framework 1301
.........................................................................................................................................................
Code Templates 1302
Base Templates......................................................................................................................................... 1302
The.........................................................................................................................................................
Code Template Editor 1305
.........................................................................................................................................................
Synchronize Code 1307
Synchronize .........................................................................................................................................
Existing Sections 1308
Add New.........................................................................................................................................
Sections 1308
Add New.........................................................................................................................................
Features and Elements 1308
Generate
..........................................................................................................................................................
Source Code 1308
.........................................................................................................................................................
Generate a Single Class 1309
.........................................................................................................................................................
Generate a Group of Classes 1311
.........................................................................................................................................................
Generate a Package 1311
.........................................................................................................................................................
Update Package Contents 1313
.........................................................................................................................................................
Namespaces 1313
Generate
..........................................................................................................................................................
From Behavioral Models 1314
SW.........................................................................................................................................................
Code Generation - State Machine Diagrams 1316
Java Code .........................................................................................................................................
Generated From State Machine Diagram 1317
.........................................................................................................................................................
State Machine Modeling For HDLs 1319
Code.........................................................................................................................................................
Generation - Interaction Diagrams 1322
Code.........................................................................................................................................................
Generation - Activity Diagrams 1323
Synchronize
..........................................................................................................................................................
Model and Code 1327
Import ..........................................................................................................................................................
Source Code 1328
.........................................................................................................................................................
Import Source Code 1329
.........................................................................................................................................................
Notes on Source Code Import 1331
.........................................................................................................................................................
Import a Directory Structure 1332
.........................................................................................................................................................
Import Binary Module 1334
MDG .........................................................................................................................................................
Integration and Code Engineering 1334
.........................................................................................................................................................
Classes Not Found During Import 1335

© 1998-2010 Sparx Systems Pty Ltd

 XXIII Contents

Other Settings
.......................................................................................................................................................... 1335
.........................................................................................................................................................
Source Code Engineering 1336
Source Code .........................................................................................................................................
Options 1336
...................................................................................................................................
Import Component Types 1337
Options -.........................................................................................................................................
Code Editors 1337
...................................................................................................................................
Editor Language Properties 1338
Options -.........................................................................................................................................
Object Lifetimes 1340
Options -.........................................................................................................................................
Attribute/Operations 1341
Code Page .........................................................................................................................................
for Source Editing 1342
.........................................................................................................................................................
Local Paths 1343
.........................................................................................................................................................
Local Paths Dialog 1343
.........................................................................................................................................................
Language Macros 1344
Set.........................................................................................................................................................
Collection Classes 1345
.........................................................................................................................................................
Language Options 1347
ActionScript .........................................................................................................................................
Options 1348
Ada 2005.........................................................................................................................................
Options 1348
C Options ......................................................................................................................................... 1349
C# Options ......................................................................................................................................... 1350
C++ Options ......................................................................................................................................... 1351
Delphi Options......................................................................................................................................... 1352
...................................................................................................................................
Delphi Properties 1353
Java Options
......................................................................................................................................... 1355
PHP Options
......................................................................................................................................... 1356
Python Options
......................................................................................................................................... 1356
SystemC.........................................................................................................................................
Options 1357
VB.Net Options
......................................................................................................................................... 1358
Verilog Options
......................................................................................................................................... 1358
VHDL Options
......................................................................................................................................... 1359
Visual Basic
.........................................................................................................................................
Options 1360
MDG Technology
.........................................................................................................................................
Language Options 1360
Reset Options
......................................................................................................................................... 1361
Database
...................................................................................................................................
Engineering 1363
Import ..........................................................................................................................................................
Database Schema 1363
.........................................................................................................................................................
Select a Data Source 1365
.........................................................................................................................................................
Select Tables 1366
The .........................................................................................................................................................
Imported Class Elements 1367
Generate
..........................................................................................................................................................
DDL 1367
.........................................................................................................................................................
Generate DDL For a Table 1367
.........................................................................................................................................................
Generate DDL for a Package 1369
XML Engineering
................................................................................................................................... 1373
Import ..........................................................................................................................................................
XSD 1373
.........................................................................................................................................................
Global Element and ComplexType 1375
Import ..........................................................................................................................................................
WSDL 1376
Generate
..........................................................................................................................................................
XSD 1376
.........................................................................................................................................................
Generate Global Element 1378
Generate
..........................................................................................................................................................
WSDL 1379
Generate
..........................................................................................................................................................
MOF 1380
.........................................................................................................................................................
Getting Started 1381
.........................................................................................................................................................
Export MOF to XMI 1383
Model ...................................................................................................................................
Transformations - MDA 1385
Transform
..........................................................................................................................................................
Elements 1387
.........................................................................................................................................................
Chaining Transformations 1388
Built-in..........................................................................................................................................................
Transformations 1388
C#.........................................................................................................................................................
Transformation 1389
Data.........................................................................................................................................................
Model To ERD Transformation 1390
DDL .........................................................................................................................................................
Transformation 1393
EJB .........................................................................................................................................................
Transformations 1397

Enterprise Architect User Guide

 Contents XXIV

ERD.........................................................................................................................................................
To Data Model Transformation 1399
.........................................................................................................................................................
Java Transformation 1403
.........................................................................................................................................................
JUnit Transformation 1405
.........................................................................................................................................................
NUnit Transformation 1407
.........................................................................................................................................................
WSDL Transformation 1408
XSD.........................................................................................................................................................
Transformation 1409
Transformation
..........................................................................................................................................................
Templates 1412
.........................................................................................................................................................
Import Transformations 1414
Write Transformations
.......................................................................................................................................................... 1414
.........................................................................................................................................................
Default Transformation Templates 1415
.........................................................................................................................................................
Intermediary Language 1415
.........................................................................................................................................................
Objects 1415
.........................................................................................................................................................
Connectors 1419
.........................................................................................................................................................
Copy Information 1421
.........................................................................................................................................................
Convert Types 1421
.........................................................................................................................................................
Convert Names 1422
.........................................................................................................................................................
Cross References 1423
Integrated
...................................................................................................................................
Development 1424
Getting..........................................................................................................................................................
Started 1424
.........................................................................................................................................................
Prerequisites 1424
.........................................................................................................................................................
Available Tools 1424
.........................................................................................................................................................
Workspace Layout 1424
.........................................................................................................................................................
General Workflow 1425
.........................................................................................................................................................
Code Generation and Synchronization - Safeguards 1425
.........................................................................................................................................................
Code Editing For MDDE 1425
Setup .......................................................................................................................................................... 1425
.........................................................................................................................................................
Managing Scripts 1426
.........................................................................................................................................................
Defining Script Actions 1427
.........................................................................................................................................................
Setting the Default Script 1428
Code Editors
.......................................................................................................................................................... 1428
.........................................................................................................................................................
Syntax Highlighting 1429
.........................................................................................................................................................
Bookmarks 1430
.........................................................................................................................................................
Cursor History 1430
.........................................................................................................................................................
Brace Matching 1430
.........................................................................................................................................................
Automatic Indentation 1431
.........................................................................................................................................................
Commenting Selections 1431
.........................................................................................................................................................
Scope Guides 1431
.........................................................................................................................................................
Zooming 1432
.........................................................................................................................................................
Line Selection 1432
.........................................................................................................................................................
Intellisense 1432
.........................................................................................................................................................
Code Editor Key Bindings 1433
.........................................................................................................................................................
Code Editor Context Menu 1437
.........................................................................................................................................................
Script Editor 1439
The.........................................................................................................................................................
Source Code Viewer 1441
Source Code .........................................................................................................................................
Viewer Toolbar 1442
Build .......................................................................................................................................................... 1443
.........................................................................................................................................................
Add Commands 1444
.........................................................................................................................................................
Recursive Builds 1446
Debugging
.......................................................................................................................................................... 1446
.........................................................................................................................................................
How it Works 1446
.........................................................................................................................................................
Setup for Debugging 1447
Operating.........................................................................................................................................
System Specific Requirements 1447
UAC-Enabled ...................................................................................................................................
Operating Systems 1448
WINE Debugging................................................................................................................................... 1450
Microsoft.........................................................................................................................................
C++ and Native (C, VB) 1451
...................................................................................................................................
Debug Symbols 1452
Java ......................................................................................................................................... 1452
General ...................................................................................................................................
Setup for Java 1453

© 1998-2010 Sparx Systems Pty Ltd

 XXV Contents

Advanced ...................................................................................................................................
Techniques 1454
Attach to...................................................................................................................................
Virtual Machine 1454
...................................................................................................................................
Internet Browser Java Applets 1454
Working ...................................................................................................................................
with Java Web Servers 1456
...................................................................................................................................
JBOSS Server 1458
...................................................................................................................................
Apache Tomcat Server 1459
...................................................................................................................................
Apache Tomcat Windows Service 1460
.NET ......................................................................................................................................... 1460
General ...................................................................................................................................
Setup for .NET 1461
...................................................................................................................................
Debug Assemblies 1461
Debug - ...................................................................................................................................
CLR Versions 1462
Debug COM ...................................................................................................................................
Interop 1463
Debug ASP ...................................................................................................................................
.NET 1463
.........................................................................................................................................................
The Debug Window 1467
.........................................................................................................................................................
Breakpoint and Marker Management 1468
How Markers .........................................................................................................................................
are Stored 1469
Setting Code .........................................................................................................................................
Breakpoints 1469
Setting Data .........................................................................................................................................
Breakpoints 1470
.........................................................................................................................................................
Debugging Actions 1470
Displaying .........................................................................................................................................
Windows 1471
Start & Stop .........................................................................................................................................
Debugger 1471
Debug Another .........................................................................................................................................
Process 1472
Step Over .........................................................................................................................................
Lines of Code 1472
Step Into.........................................................................................................................................
Function Calls 1473
Step Out.........................................................................................................................................
of Functions 1473
View the .........................................................................................................................................
Call Stack 1473
View the .........................................................................................................................................
Local Variables 1474
View Content .........................................................................................................................................
Of Long Strings 1474
View Variables.........................................................................................................................................
in Other Scopes 1475
Inspect Process
.........................................................................................................................................
Memory 1476
Break When .........................................................................................................................................
a Variable Changes Value 1477
Show Loaded .........................................................................................................................................
Modules 1478
Show Output .........................................................................................................................................
from Debugger 1478
Debug Tooltips.........................................................................................................................................
in Code Editors 1479
.........................................................................................................................................................
Recording Actions 1480
Step Through .........................................................................................................................................
Function Calls 1480
Create Sequence
.........................................................................................................................................
Diagram of Call Stack 1480
Saving the .........................................................................................................................................
Call Stack 1482
Run .......................................................................................................................................................... 1482
Add.........................................................................................................................................................
Run Command 1482
Testing.......................................................................................................................................................... 1483
Add.........................................................................................................................................................
Testing Command 1483
Deploying
.......................................................................................................................................................... 1484
Add.........................................................................................................................................................
Deploy Command 1484
Searching
..........................................................................................................................................................
Files 1485
.........................................................................................................................................................
Search in Files 1485
Visual ...................................................................................................................................
Execution Analysis 1488
Introducing
..........................................................................................................................................................
the Visual Execution Analyzer 1488
Structure
..........................................................................................................................................................
of the Visual Execution Analyzer 1489
Execution
..........................................................................................................................................................
Analysis 1490
.........................................................................................................................................................
Recording Sequence Diagrams 1490
How it Works ......................................................................................................................................... 1491
Setup for.........................................................................................................................................
Recording 1492
Pre-Requisites................................................................................................................................... 1492
Configure ...................................................................................................................................
Recording Detail 1492
Enable Filter ................................................................................................................................... 1493
...................................................................................................................................
Record Arguments To Function Calls 1494
Record Calls ...................................................................................................................................
To External Modules 1494

Enterprise Architect User Guide

 Contents XXVI

...................................................................................................................................
Record Calls to Dynamic Modules 1495
Limit Auto ...................................................................................................................................
Recording 1496
...................................................................................................................................
Enable Diagnostic Messages 1496
Advanced ...................................................................................................................................
Techniques 1497
Recording ...................................................................................................................................
Activity for a Class 1497
Recording ...................................................................................................................................
Activity for a Single Method 1498
Place Recording
.........................................................................................................................................
Markers 1499
...................................................................................................................................
Marker Types 1499
...................................................................................................................................
Setting Recording Markers 1502
...................................................................................................................................
The Breakpoints and Markers Window 1503
Activate ...................................................................................................................................
and Disable Markers 1503
Working ...................................................................................................................................
with Marker Sets 1503
Differences...................................................................................................................................
to Breakpoints 1503
Control the
.........................................................................................................................................
Recording Session 1504
...................................................................................................................................
Auto-Recording 1504
...................................................................................................................................
Manual Recording 1504
...................................................................................................................................
Pause Recording 1505
Resume...................................................................................................................................
Recording 1505
...................................................................................................................................
Stop Capture 1505
Generating
.........................................................................................................................................
Sequence Diagrams 1505
...................................................................................................................................
The Recording History 1506
Generate...................................................................................................................................
a Diagram 1507
Diagram...................................................................................................................................
Features 1507
...................................................................................................................................
Saving Recording 1507
Add State.........................................................................................................................................
Transitions 1507
Setup for...................................................................................................................................
Capturing State Changes 1508
The State ...................................................................................................................................
Machine 1509
Recording ...................................................................................................................................
and Mapping State Changes 1511
.........................................................................................................................................................
Unit Testing 1512
Set Up Unit .........................................................................................................................................
Testing 1512
Run Unit.........................................................................................................................................
Tests 1513
Record Test .........................................................................................................................................
Results 1514
.........................................................................................................................................................
Profiling Native Applications 1514
System Requirements
......................................................................................................................................... 1516
Getting Started
......................................................................................................................................... 1516
Start & Stop .........................................................................................................................................
the Profiler 1517
Profiler Operation
......................................................................................................................................... 1517
Setting Options
......................................................................................................................................... 1518
Save and.........................................................................................................................................
Load Reports 1518
Save Report .........................................................................................................................................
in Team Review 1519
.........................................................................................................................................................
Object Workbench 1519
How it Works ......................................................................................................................................... 1520
Workbench .........................................................................................................................................
Variables 1521
Create Workbench
.........................................................................................................................................
Variables 1521
Invoke Methods......................................................................................................................................... 1522

Part VIII Test and Quality Control 1527

Model ...................................................................................................................................
Validation 1528
Configure
..........................................................................................................................................................
Model Validation 1530
Rules Reference
.......................................................................................................................................................... 1530
.........................................................................................................................................................
Well-Formedness 1531
.........................................................................................................................................................
Element Composition 1531
.........................................................................................................................................................
Property Validity 1532
OCL.........................................................................................................................................................
Conformance 1532
Testing................................................................................................................................... 1536
The Testing
..........................................................................................................................................................
Workspace 1537
The Test
..........................................................................................................................................................
Details Dialog 1538

© 1998-2010 Sparx Systems Pty Ltd

 XXVII Contents

Unit Testing
.......................................................................................................................................................... 1539
Integration
..........................................................................................................................................................
Testing 1540
System..........................................................................................................................................................
Testing 1541
Acceptance
..........................................................................................................................................................
Testing 1542
Scenario
..........................................................................................................................................................
Testing 1543
Move or..........................................................................................................................................................
Copy Tests Between Categories 1544
Import ..........................................................................................................................................................
Scenario as Test 1544
Import ..........................................................................................................................................................
Test From Other Elements 1546
Import ..........................................................................................................................................................
Responsibility or Constraint as Test 1547
Create ..........................................................................................................................................................
Maintenance Item From Test 1548
Testing..........................................................................................................................................................
Details Report 1549
Show Test
..........................................................................................................................................................
Script Compartments 1549
Test Documentation
.......................................................................................................................................................... 1550
Spell Checking
................................................................................................................................... 1552
Using the
..........................................................................................................................................................
Spell Checker 1552
Correcting
..........................................................................................................................................................
Words 1553
Select ..........................................................................................................................................................
a Different Language 1554

Part IX Maintenance and Bug Tracking 1557

Maintenance
................................................................................................................................... 1558
The Maintenance
..........................................................................................................................................................
Workspace 1558
Maintenance
..........................................................................................................................................................
Item Properties 1559
Move or..........................................................................................................................................................
Copy Maintenance Items 1561
Create ..........................................................................................................................................................
Elements From Maintenance Item 1561
Show Maintenance
..........................................................................................................................................................
Script in Diagram 1561
Changes
...................................................................................................................................
and Defects 1563
Defects..........................................................................................................................................................
(Issues) 1563
Changes.......................................................................................................................................................... 1564
Element..........................................................................................................................................................
Properties 1565
Assign..........................................................................................................................................................
People to Defects or Changes 1566

Part X Report Generation 1568

RTF Documents
................................................................................................................................... 1569
Generate
..........................................................................................................................................................
RTF Documents 1570
.........................................................................................................................................................
Diagram Options 1571
.........................................................................................................................................................
Exclude Package from Report 1573
.........................................................................................................................................................
Generate RTF Documentation Dialog 1573
.........................................................................................................................................................
RTF Templates Tab 1576
RTF Style .........................................................................................................................................
Template Editor 1578
Select Components
.........................................................................................................................................
for Reporting 1579
Tabular Sections
......................................................................................................................................... 1581
Child Sections......................................................................................................................................... 1584
Constraint .........................................................................................................................................
and Scenario Sections 1585
Add Content ......................................................................................................................................... 1586
RTF Style .........................................................................................................................................
Template Editor Options 1587
Scroll Through...................................................................................................................................
Text 1588
File and ...................................................................................................................................
Print Options 1588
Cut and ...................................................................................................................................
Paste Options 1589
View Options ................................................................................................................................... 1590
Image and ...................................................................................................................................
Object Inserts 1591
Character ...................................................................................................................................
Formatting 1592
Paragraph ...................................................................................................................................
Formatting 1593
Tab Support ................................................................................................................................... 1595
Page Breaks ...................................................................................................................................
and Repagination 1595
Headers...................................................................................................................................
and Footers 1596
Hyperlinks ...................................................................................................................................
and Bookmarks 1597

Enterprise Architect User Guide

 Contents XXVIII

Table Commands................................................................................................................................... 1597

Sections...................................................................................................................................
and Columns 1599
Stylesheets ...................................................................................................................................
and Table of Contents 1600
User-Defined ...................................................................................................................................
Section Numbering 1601
Frames and ...................................................................................................................................
Drawing Objects 1604
Search and ...................................................................................................................................
Replace Commands 1605
.........................................................................................................................................................
Import RTF Template 1606
.........................................................................................................................................................
Resource Documents 1606
.........................................................................................................................................................
Document Options 1607
.........................................................................................................................................................
Element Filters 1611
.........................................................................................................................................................
Other Filters 1612
.........................................................................................................................................................
Project Constants 1614
Word.........................................................................................................................................................
Substitution 1615
.........................................................................................................................................................
Language Substitution 1615
Virtual ..........................................................................................................................................................
Documents 1616
.........................................................................................................................................................
Create Master Document 1618
.........................................................................................................................................................
Create Model Document 1619
Add .........................................................................................................................................................
Packages to Model Document 1620
.........................................................................................................................................................
Delete Package in Model Document 1621
.........................................................................................................................................................
Document Order 1622
.........................................................................................................................................................
Section Numbering in Virtual Documents 1623
.........................................................................................................................................................
Generate the Document 1623
Other Documents
.......................................................................................................................................................... 1624
.........................................................................................................................................................
Dependency Report 1624
.........................................................................................................................................................
Diagrams Only Report 1625
.........................................................................................................................................................
Implementation Report 1626
Set Target .........................................................................................................................................
Types Dialog 1627
.........................................................................................................................................................
Testing Report 1627
The Legacy
..........................................................................................................................................................
RTF Report Generator 1628
.........................................................................................................................................................
Document a Single Element 1629
Set.........................................................................................................................................................
the Main RTF Properties 1629
.........................................................................................................................................................
Apply a Filter 1630
.........................................................................................................................................................
Exclude Elements 1630
RTF .........................................................................................................................................................
Diagram Format 1631
.........................................................................................................................................................
Model Include 1631
RTF .........................................................................................................................................................
Report Options 1632
RTF .........................................................................................................................................................
Report Selections 1633
.........................................................................................................................................................
Generate the Report 1634
.........................................................................................................................................................
Legacy RTF Style Templates 1634
Save.........................................................................................................................................................
as Document 1636
.........................................................................................................................................................
Custom Language Settings 1637
Use MS..........................................................................................................................................................
Word 1638
Open.........................................................................................................................................................
a Report in Microsoft Word 1638
.........................................................................................................................................................
Change Linked Images to Embedded 1638
RTF .........................................................................................................................................................
Bookmarks 1639
.........................................................................................................................................................
Other Features of Word 1641
Add Table .........................................................................................................................................
of Contents 1641
Add Table .........................................................................................................................................
of Figures 1642
Add Headers .........................................................................................................................................
and Footers 1643
Manipulate .........................................................................................................................................
Tables in Word 1644
Refresh Links ......................................................................................................................................... 1646
HTML Reports
................................................................................................................................... 1647
Create ..........................................................................................................................................................
an HTML Report 1647
The Generate
..........................................................................................................................................................
HTML Report Dialog 1648
Web Style
..........................................................................................................................................................
Templates 1649
HTML Template
..........................................................................................................................................................
Fragments 1651

Part XI Automation and Scripts 1659

© 1998-2010 Sparx Systems Pty Ltd
 XXIX Contents

Scripting
................................................................................................................................... 1660
Scripts..........................................................................................................................................................
Tab 1661
.........................................................................................................................................................
Script Group Properties 1663
Console..........................................................................................................................................................
Tab 1663
Enterprise
...................................................................................................................................
Architect Object Model 1666
Using the
..........................................................................................................................................................
Automation Interface 1666
.........................................................................................................................................................
Connect to the Interface 1666
Set References.........................................................................................................................................
In Visual Basic 1668
.........................................................................................................................................................
Examples and Tips 1669
Call from.........................................................................................................................................
Enterprise Architect 1670
Available.........................................................................................................................................
Resources 1671
Reference
.......................................................................................................................................................... 1671
.........................................................................................................................................................
Interface Overview 1672
App......................................................................................................................................................... 1674
.........................................................................................................................................................
Enumerations 1675
ConstLayoutStyles
.........................................................................................................................................
Enum 1675
CreateBaselineFlag
.........................................................................................................................................
Enum 1676
CreateModelType
.........................................................................................................................................
Enum 1676
EAEditionTypes.........................................................................................................................................
Enum 1676
EnumRelationSetType
.........................................................................................................................................
Enum 1676
ExportPackageXMIFlag
.........................................................................................................................................
Enum 1677
MDGMenus .........................................................................................................................................
Enum 1677
ObjectType .........................................................................................................................................
Enum 1677
PropType.........................................................................................................................................
Enum 1678
ReloadType .........................................................................................................................................
Enum 1678
ScenarioDiagramType
.........................................................................................................................................
Enum 1678
ScenarioStepType
.........................................................................................................................................
Enum 1679
ScenarioTestType
.........................................................................................................................................
Enum 1679
XMIType.........................................................................................................................................
Enum 1679
.........................................................................................................................................................
Repository 1679
Repository ......................................................................................................................................... 1680
Author ......................................................................................................................................... 1693
Client ......................................................................................................................................... 1694
Collection......................................................................................................................................... 1695
Datatype......................................................................................................................................... 1696
EventProperties
......................................................................................................................................... 1697
EventProperty ......................................................................................................................................... 1697
ModelWatcher ......................................................................................................................................... 1698
Package ......................................................................................................................................... 1698
ProjectIssues ......................................................................................................................................... 1703
ProjectResource
......................................................................................................................................... 1704
PropertyType ......................................................................................................................................... 1704
Reference ......................................................................................................................................... 1705
Stereotype ......................................................................................................................................... 1706
Task ......................................................................................................................................... 1707
Term ......................................................................................................................................... 1708
.........................................................................................................................................................
Element 1708
Constraint
......................................................................................................................................... 1710
Effort ......................................................................................................................................... 1710
Element ......................................................................................................................................... 1711
File ......................................................................................................................................... 1717
Issue (Maintenance)
......................................................................................................................................... 1718
Metric ......................................................................................................................................... 1719
Requirement
......................................................................................................................................... 1719
Resource......................................................................................................................................... 1720
Risk ......................................................................................................................................... 1721
Scenario......................................................................................................................................... 1722
ScenarioExtension
......................................................................................................................................... 1723
Enterprise Architect User Guide
 Contents XXX

ScenarioStep ......................................................................................................................................... 1723

TaggedValue ......................................................................................................................................... 1724
Test ......................................................................................................................................... 1725
.........................................................................................................................................................
Element Features 1726
Attribute ......................................................................................................................................... 1727
AttributeConstraint
......................................................................................................................................... 1729
AttributeTag ......................................................................................................................................... 1730
CustomProperties
......................................................................................................................................... 1730
EmbeddedElements
......................................................................................................................................... 1731
Method ......................................................................................................................................... 1732
MethodConstraint
......................................................................................................................................... 1733
MethodTag ......................................................................................................................................... 1734
Parameter ......................................................................................................................................... 1735
Partitions......................................................................................................................................... 1736
Properties ......................................................................................................................................... 1736
Transitions ......................................................................................................................................... 1737
.........................................................................................................................................................
Connector 1738
ConnectorConstraint
......................................................................................................................................... 1738
Connector ......................................................................................................................................... 1739
ConnectorEnd ......................................................................................................................................... 1742
ConnectorTag ......................................................................................................................................... 1744
RoleTag ......................................................................................................................................... 1744
.........................................................................................................................................................
Diagram 1745
Diagram ......................................................................................................................................... 1746
DiagramLinks ......................................................................................................................................... 1749
DiagramObjects......................................................................................................................................... 1750
SwimlaneDef ......................................................................................................................................... 1751
Swimlanes ......................................................................................................................................... 1751
Swimlane......................................................................................................................................... 1752
.........................................................................................................................................................
Project Interface 1753
Project ......................................................................................................................................... 1753
.........................................................................................................................................................
Code Samples 1765
Open the.........................................................................................................................................
Repository 1765
Iterate Through
.........................................................................................................................................
a .EAP File 1766
Add and .........................................................................................................................................
Manage Packages 1766
Add and .........................................................................................................................................
Manage Elements 1767
Add a Connector
......................................................................................................................................... 1767
Add and .........................................................................................................................................
Manage Diagrams 1768
Add and .........................................................................................................................................
Delete Features 1769
Element .........................................................................................................................................
Extras 1769
Repository .........................................................................................................................................
Extras 1772
Stereotypes ......................................................................................................................................... 1773
Work With .........................................................................................................................................
Attributes 1773
Work With .........................................................................................................................................
Methods 1774
Enterprise
...................................................................................................................................
Architect Add-In Model 1776
Add-In..........................................................................................................................................................
Tasks 1777
.........................................................................................................................................................
Create Add-Ins 1777
Define Menu .........................................................................................................................................
Items 1777
Deploy Add-Ins......................................................................................................................................... 1778
Tricks and .........................................................................................................................................
Traps 1779
The Add-In
..........................................................................................................................................................
Manager 1781
Add-In..........................................................................................................................................................
Search 1781
XML.........................................................................................................................................................
Format (Search Data) 1782
Add-In..........................................................................................................................................................
Events 1782
.........................................................................................................................................................
EA_Connect 1782
.........................................................................................................................................................
EA_Disconnect 1783
.........................................................................................................................................................
EA_GetMenuItems 1783
.........................................................................................................................................................
EA_GetMenuState 1784

© 1998-2010 Sparx Systems Pty Ltd

 XXXI Contents

.........................................................................................................................................................
EA_MenuClick 1785
.........................................................................................................................................................
EA_OnOutputItemClicked 1785
.........................................................................................................................................................
EA_OnOutputItemDoubleClicked 1786
.........................................................................................................................................................
EA_ShowHelp 1787
Broadcast
..........................................................................................................................................................
Events 1787
.........................................................................................................................................................
EA_FileOpen 1788
.........................................................................................................................................................
EA_FileClose 1788
.........................................................................................................................................................
EA_FileNew 1789
.........................................................................................................................................................
EA_OnPostCloseDiagram 1789
.........................................................................................................................................................
EA_OnPostOpenDiagram 1789
.........................................................................................................................................................
Pre-Deletion Events 1790
EA_OnPreDeleteElement
......................................................................................................................................... 1790
EA_OnPreDeleteAttribute
......................................................................................................................................... 1791
EA_OnPreDeleteMethod
......................................................................................................................................... 1791
EA_OnPreDeleteConnector
......................................................................................................................................... 1792
EA_OnPreDeleteDiagram
......................................................................................................................................... 1792
EA_OnPreDeletePackage
......................................................................................................................................... 1793
.........................................................................................................................................................
Pre-New Events 1793
EA_OnPreNewElement
......................................................................................................................................... 1793
EA_OnPreNewConnector
......................................................................................................................................... 1794
EA_OnPreNewDiagram
......................................................................................................................................... 1795
EA_OnPreNewDiagramObject
......................................................................................................................................... 1795
EA_OnPreNewAttribute
......................................................................................................................................... 1796
EA_OnPreNewMethod
......................................................................................................................................... 1797
EA_OnPreNewPackage
......................................................................................................................................... 1797
.........................................................................................................................................................
EA_OnPreExitInstance 1798
.........................................................................................................................................................
Post-New Events 1798
EA_OnPostNewElement
......................................................................................................................................... 1798
EA_OnPostNewConnector
......................................................................................................................................... 1799
EA_OnPostNewDiagram
......................................................................................................................................... 1800
EA_OnPostNewDiagramObject
......................................................................................................................................... 1800
EA_OnPostNewAttribute
......................................................................................................................................... 1801
EA_OnPostNewMethod
......................................................................................................................................... 1801
EA_OnPostNewPackage
......................................................................................................................................... 1802
.........................................................................................................................................................
EA_OnPostInitialized 1802
.........................................................................................................................................................
EA_OnPostTransform 1803
.........................................................................................................................................................
Technology Events 1803
EA_OnInitializeTechnologies
......................................................................................................................................... 1803
EA_OnPreActivateTechnology
......................................................................................................................................... 1804
EA_OnPostActivateTechnology
......................................................................................................................................... 1805
EA_OnPreDeleteTechnology
......................................................................................................................................... 1805
EA_OnDeleteTechnology
......................................................................................................................................... 1806
EA_OnImportTechnology
......................................................................................................................................... 1806
.........................................................................................................................................................
Context Item Events 1807
EA_OnContextItemChanged
......................................................................................................................................... 1807
EA_OnContextItemDoubleClicked
......................................................................................................................................... 1808
EA_OnNotifyContextItemModified
......................................................................................................................................... 1809
.........................................................................................................................................................
Compartment Events 1809
EA_QueryAvailableCompartments
......................................................................................................................................... 1809
EA_GetCompartmentData
......................................................................................................................................... 1810
.........................................................................................................................................................
Model Validation Broadcasts 1811
EA_OnInitializeUserRules
......................................................................................................................................... 1812
EA_OnStartValidation
......................................................................................................................................... 1812
EA_OnEndValidation
......................................................................................................................................... 1813
EA_OnRunElementRule
......................................................................................................................................... 1813
EA_OnRunPackageRule
......................................................................................................................................... 1813
EA_OnRunDiagramRule
......................................................................................................................................... 1814
EA_OnRunConnectorRule
......................................................................................................................................... 1814

Enterprise Architect User Guide

 Contents XXXII

EA_OnRunAttributeRule
......................................................................................................................................... 1815
EA_OnRunMethodRule
......................................................................................................................................... 1815
EA_OnRunParameterRule
......................................................................................................................................... 1816
Model Validation
.........................................................................................................................................
Example 1816
.........................................................................................................................................................
EA_OnRetrieveModelTemplate 1820
Custom
..........................................................................................................................................................
Views 1820
.........................................................................................................................................................
Create a Custom View 1821
MDG Add-Ins
.......................................................................................................................................................... 1821
.........................................................................................................................................................
MDG Events 1822
MDGBuild .........................................................................................................................................
Project 1822
MDGConnect ......................................................................................................................................... 1822
MDGDisconnect ......................................................................................................................................... 1823
MDGGetConnectedPackages
......................................................................................................................................... 1824
MDGGetProperty......................................................................................................................................... 1824
MDGMerge ......................................................................................................................................... 1825
MDGNewClass ......................................................................................................................................... 1826
MDGPostGenerate
......................................................................................................................................... 1827
MDGPostMerge ......................................................................................................................................... 1827
MDGPreGenerate......................................................................................................................................... 1828
MDGPreMerge ......................................................................................................................................... 1828
MDGPreReverse ......................................................................................................................................... 1829
MDGRunExe ......................................................................................................................................... 1830
MDGView ......................................................................................................................................... 1830

Part XII Glossary of Terms 1833

A ................................................................................................................................... 1834
B ................................................................................................................................... 1836
C ................................................................................................................................... 1837
D ................................................................................................................................... 1840
E ................................................................................................................................... 1842
F ................................................................................................................................... 1843
G ................................................................................................................................... 1844
H ................................................................................................................................... 1845
I ................................................................................................................................... 1846
J ................................................................................................................................... 1848
L ................................................................................................................................... 1849
M ................................................................................................................................... 1850
N ................................................................................................................................... 1852
O ................................................................................................................................... 1853
P ................................................................................................................................... 1854
Q ................................................................................................................................... 1857
R ................................................................................................................................... 1858
S ................................................................................................................................... 1860
T ................................................................................................................................... 1863
U ................................................................................................................................... 1864
V ................................................................................................................................... 1865

Part XIII License Management 1867

Finding...................................................................................................................................
Your License Information 1869

© 1998-2010 Sparx Systems Pty Ltd

 XXXIII Contents

Add License
...................................................................................................................................
Key 1870
Keystore
...................................................................................................................................
Troubleshooting 1872
Upgrade
...................................................................................................................................
an Existing License 1873
Register
...................................................................................................................................
Add-In 1876

Index 1878

Enterprise Architect User Guide

 Foreword 1

Foreword

This user guide provides an introduction to the

features contained in Enterprise Architect - a
UML modeling tool for developing and building
software systems with UML.

© 1998-2010 Sparx Systems Pty Ltd

Part

I
 Introduction | 3

1 Introduction

Welcome to Sparx Systems Enterprise Architect, a UML 2.3 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.
The Enterprise Architect User Guide provides tutorials, guidance and reference material to help you use
Enterprise Architect in:
· Model Development 370
· Model Management 111
· Project Management 312
· Model Auditing 270
· Model Baselining and Differencing 279
· Model User Security 188
· Model Version Control 228
· Using and Creating Modeling Languages 671
· Code Engineering 1281
· Visualization and Analysis of Code Execution 1488
· RTF and HTML Document Creation 1568 (Reports)

See the Overview 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 describe the Enterprise Architect representations 370
of UML diagrams, elements and connectors. Enterprise Architect also includes a Technology Developer's
interface (see Automation and Scripts 1659 ) 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 Quickstart Tutorial 26 . 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 the Quickstart tutorial you
will see many links to more extensive descriptions of features, functions, tasks and procedures, in the User
Interface Guide 48 . You can follow any of these immediately if you require more information.
You should read the Sparx Systems Formal Statements 16 , including the Copyright Notice and our End User
Licensing Agreement.
You can also check the Glossary 1833 for definitions of various terms and concepts used in this guide.

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:
· www.sparxsystems.com/bug_report.htm and
· www.sparxsystems.com/feature_request.htm.
Alternatively, you can contact Sparx Systems by email at: [email protected].

© 1998-2010 Sparx Systems Pty Ltd

 4 Introduction | Overview

1.1 Overview

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.3 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 8 , 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 200,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 130 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:
· Key Benefits of Enterprise Architect 5

· Enterprise Architect Key Features 8

1.1.1 What You Can Do

This topic introduces the fundamental processes that Enterprise Architect supports.
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.

Modeling
Enterprise Architect is a comprehensive model 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 Modeling Fundamentals 370 .

Managing 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 Projects and Teams 111 .

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

Enterprise Architect User Guide

 Introduction | Overview 5

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 Software Development 1279 .

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 Projects and Teams 111 .

Project management discussions and decisions can be communicated to the project through the Team
Review Tools 208 .
The scope of your project management might include upgrades to Enterprise Architect and installation of
related technologies. In this case, also see License Management 1867 .

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 Build Your Own Modeling Language 1092 .

1.1.2 Key Benefits

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.3 672 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 370 of UML 2.3 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.

© 1998-2010 Sparx Systems Pty Ltd

 6 Introduction | Overview

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 228 , track and compare differences 283 , audit 270
changes and enforce security 188 , help control project development and enforce compliance to standards .

Structured Use Case Scenarios

Enterprise Architect's Structured Scenario 493 editor enables you to develop structured Use Case Scenarios,
to capture vital analysis information in the form of natural language descriptions.
The editor helps you use this information to drive downstream development and maximize traceability across
the development life-cycle. The editor also helps you to dynamically link scenario steps to associated model
elements, such as domain elements, business rules and glossary terms. From structured scenarios, you can
automatically generate test case descriptions, and Activity and other UML behavioral diagrams. You can even
reverse engineer existing process diagrams into structured, textual specifications to produce documentation
deliverables.

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 15 edition) stakeholders who can study a model but not
change or manage it.
You can make your project .EAP file available on a shared network drive 183 , or replicate 184 the .EAP file for
complex distributed development. Alternatively, you can develop the project in one of several shared DBMS
repositories 122 , such as Access 2007, SQL Server; My SQL; PostgreSQL; Oracle 9i, 10g or 11g; and Sybase
ASA. You can import and export data as XMI files 288 to distribute and update frameworks and other
package-based model structures. You control changes through the version control 228 repository. Enterprise
Architect provides a data transfer wizard 307 that enables you to upsize or downsize the complete model for
maximum flexibility, and it enables you to export and import reference data 223 so that you do not have to
recreate it for related projects.

Model, Manage and Trace Requirements

Enterprise Architect enables you to capture requirements 917 and use full traceability 1245 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.

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

Track and Trace Model Structures

In even a small model, it can be difficult to locate specific packages, diagrams or 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 1231 , Element List 1255 , Auditing facility 270 , Traceability 1253 window, Relationship Matrix 1261
and reports 1624 . The Element 67 menu, Diagram 65 menu and Project Browser context menus 1213 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 1222 . Finally, having located one
element you can import any related elements 551 into a diagram in a single operation.

Generate Documentation
Enterprise Architect provides powerful document generation and reporting tools with a full WYSIWYG

Enterprise Architect User Guide

 Introduction | Overview 7

template editor for RTF 1569 or HTML 1647 output. You can generate complex and detailed reports from
Enterprise Architect with the information you require in the format your company or client demands.

Generate and Reverse Engineer Source Code

Enterprise Architect supports generation 1308 and reverse engineering 1328 of source code for many popular
languages, such as C++, C#, Java, Delphi, VB.Net, Visual Basic, ActionScript, Python and PHP.
With a built in 'syntax highlighting' source code editor 1441 , Enterprise Architect enables you to quickly navigate
and explore your model source code in the same environment. Code generation templates 1302 enable you to
customize the generated source code to your company specifications.

Visualize, Inspect and Understand Complex Software

Software is complex and often hard to understand. You can use Enterprise Architect to reverse engineer 1328
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 1488 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 1519 .
You can also bring in complete frameworks from source code 1329 or Java .jar files - or even .Net binary 1334
assemblies! By importing frameworks and library code, you can maximize re-use and understanding of your
existing investment.

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 1385 using easily edited and developed
transformation templates. With built-in transformations 1388 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.

SOA (Service Oriented Architecture) Support

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

Systems Engineering support

Integrating many high-end features for Systems Engineers, the Ultimate 13 and Systems Engineering 14
editions of Enterprise Architect provide built-in support for SysML 1.1 989 , parametric model simulation,
executable code generation 569 , as well as model to code transformations for Hardware Description
Languages 1319 and Ada 2005 1284 .

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 2007 and PostgreSQL.
You can model database 1011 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.

Customize Enterprise Architect

Enterprise Architect also includes facilities that enable experienced tool developers to customize and extend
Enterprise Architect to suit the specific requirements of their organization with, for example, in-house UML
Profiles 1093 , Add-Ins 1776 and Code Templates 1172 .
The very detailed Automation Interface 1666 gives you access to most element features, major functions such

© 1998-2010 Sparx Systems Pty Ltd

 8 Introduction | Overview

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.

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, while you 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 2008 provide an even closer, seamless
integration of Enterprise Architect and UML 2.3 with your IDE, bringing the functionality required of a fully
fledged modeling platform right inside the IDE.

1.1.3 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.3 support for all 14 UML diagrams)
· Extended modeling for Requirements, User Interface Design, Mind Mapping, Data Modeling, SysML,
SPEM, BPMN 1.1 and more
· Generate BPEL scripts automatically from Business Process models
· 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 software and hardware languages ‘out of the
box’: ActionScript 3.0, Java, C#, C++, VB.Net, Delphi, Visual Basic , Python, PHP, Verilog, VHDL and
SystemC
· 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
· Connect to shared database repositories using MS SQL Server, MySQL, Oracle and more
· 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 visualizing executable Java and .Net applications, instantiating run-time
model objects and generating Sequence diagrams from a stack trace
· Migrate changes across a distributed environment using Controlled XMI Packages
· Manage Version control though XMI using SCC CVS and Subversion configurations
· 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 in XMI format from other tools
· 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
· Use UML Profiles to create custom extensions for domain-specific modeling
· Save and load complete diagrams as UML Patterns
· Create and share dynamic views of model elements and diagram sets using Model Views
· Analyze and trace relationships between elements using the tabular Relationship Matrix
· Generate executable business logic from rule tasks and trace to natural language business rules

Enterprise Architect User Guide

 Introduction | Overview 9

· Transform behavioral models into executable source code for software and hardware description
languages (HDLs) such as Verilog, VHDL, and SystemC
· Simulate SysML parametric models
· Script and automate common tasks using a detailed Automation Interface and Model Scripts
· A range of internal and external commercial MDG Add-Ins 1073 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 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 six editions: Ultimate, Business and Software Engineering, Systems
Engineering, Corporate, Professional, and Desktop, each of which offers a different range of features. For
a comparison of the Enterprise Architect editions, see the Editions Available 12 topic.

© 1998-2010 Sparx Systems Pty Ltd

 10 Introduction | Enterprise Architect Editions

1.2 Enterprise Architect Editions

Enterprise Architect is available in a number of different editions, each tailored to support a particular business
case.
· Before purchase, you can test the product in a number of configurations in the Trial version 10 .
· Whilst using the Trial version, consider the specific features of the six work environment editions available
12 - Desktop, Professional, Corporate, Business and Software Engineering, Systems Engineering, and
Ultimate.
· For project reviews and other read-only tasks, you can use the free, read-only or 'Lite' edition 15 .

1.2.1 The Trial Version

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.
If you are evaluating the Enterprise Architect trial version, note that the software operates for a limited period.
The trial software stops working after the trial period has elapsed. To continue using Enterprise Architect when
the trial period expires, you can either apply to extend the trial period (see below 11 ), or purchase and register
a full license. 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.
For more information, contact [email protected].
When you order and pay for an edition of Enterprise Architect, you receive installation instructions and the
location of the executable files for download. See the following topics:
· Installation 21
· Register a Full License 22 .
If you already have a full license edition of Enterprise Architect and want to register Add-Ins or upgrade to the
Professional, Corporate, Business and Software Engineering, Systems Engineering or Ultimate editions, see
the License Management 1867 topic.

Try Out Editions

When you start up the Enterprise Architect trial version, the Select Trial Version prompt displays:

Enterprise Architect User Guide

 Introduction | Enterprise Architect Editions 11

This enables you to select the edition of Enterprise Architect to evaluate, by clicking on the appropriate radio
button. The prompt also directs you to useful information such as a comparison of the different editions, or a
walkthrough of the Enterprise Architect facilities. When using Enterprise Architect, you can select from a range
of workspace layouts 86 ; the Select Trial Version prompt enables you to select the initial layout to use.

Extend Trial Period

If you are testing the trial version and need more than 30 days to evaluate it, you can apply to Sparx Systems
Sales ([email protected]) for an extension of the trial period. This extension can be an additional 30
to 150 days; if you do not request a long enough extension in the first place, you can submit further requests.
Sparx Systems Sales send you an extension key by email.

Note:
The trial period must expire before you can enter the extension key.

To extend the trial period, after receipt of your extension key, follow the steps below:
1. Open the Enterprise Architect trial version. The Evaluation Version of Enterprise Architect dialog
displays.

© 1998-2010 Sparx Systems Pty Ltd

 12 Introduction | Enterprise Architect Editions

Note:
Once the trial period has expired, you cannot proceed beyond this dialog without extending the trial
period.

2. Press [Ctrl] whilst you click on the Continue Trial button. The Upgrade Key dialog displays.

3. In the Upgrade Key field, type or copy-and-paste the extension key you received from Sparx Systems
Sales.
4. Click on the OK button. Enterprise Architect confirms that your trial period has been extended.
Your trial period is extended by the period of days stated in the email from Sparx Systems Sales. You can
now restart and use the Trial version of Enterprise Architect.

1.2.2 Editions Available

Enterprise Architect is available in six editions: the Ultimate, Business and Software Engineering, and
Systems Engineering 'suite' editions, and the Corporate, Professional, and Desktop editions.
Functionality for each edition is described below; the features of and differences between the editions are
listed in the table provided on the Sparx Systems website.

Enterprise Architect User Guide

 Introduction | Enterprise Architect Editions 13

Tip:
To help you understand the differences between these editions and the advantages and limitations of each,
the Trial version 10 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.

Ultimate Edition
The Ultimate edition is designed for power users and those working across multiple domains, providing deep
support for Business, for Software Engineering and for Systems Development seamlessly integrated into a
single development environment. It enables you to drill down to the lowest levels of systems design and
construction, with SysML and executable code generation for standard and hardware description languages.
Business users can leverage BPEL, the Rules Composer and executable UML, in addition to all the advanced
features of the other editions of Enterprise Architect. Software developers can integrate their Eclipse and
Visual Studio projects with their UML models and leverage the advanced executable code generators to target
different domains.
This edition enables end to end traceability throughout a global vision of your enterprise - unifying strategy,
business process, interfaces, software, rules, data and fine grained systems. Powerful tools, domain-specific
technologies, frameworks, integration platforms and a consistent, scalable, and robust interface work in unison
to help you deliver on the promise of Model Driven Development.
As explained above, the Ultimate edition incorporates a number of MDG Technologies 1073 and Add-Ins. The
Ultimate edition and MDG Technologies are all available in either Fixed License or Floating License form. The
Floating License arrangement is particularly useful for companies that manage a central store of license keys,
which can be used by different employees over time, temporarily or permanently.
The Ultimate edition provides:
· Executable Code Generation - support for generating functional source code for State Machines,
Interactions and Activities in C, C++, C#, Java and VBNet
· Full round trip support for Hardware Description Languages (Verilog, VHDL and SystemC) including
support for generating State Machine code
· SysML Simulation Support - including support for simulating SysML 1.1 constraint models with results
graphing capabilities
· BPEL Generation – transform BPMN 1.1 Business process models down to BPEL 1.1 code
· Business Rules – trace from abstract business rules down to automatically generated behavioral code.

Business and Software Engineering Edition

The Business and Software Engineering edition is aimed at software development professionals, business
modelers, architects, requirements experts, project managers and others involved in the design and
construction of quality software and business services. It combines powerful new features such as executable
code generation from UML models, BPEL, advanced scripting and a multi-purpose Rules Composer targeting
executable code from Business Domain models, and bundles licenses for integration products and
frameworks such as DoDAF-MODAF, TOGAF and Zachman, to provide advanced model-driven construction
tools to tightly bind your code development in Eclipse or Visual Studio.

© 1998-2010 Sparx Systems Pty Ltd

 14 Introduction | Enterprise Architect Editions

As explained above, the Business and Software Engineering edition incorporates a number of MDG
Technologies 1073 and Add-Ins. The Business and Software Engineering edition and MDG Technologies are all
available in either Fixed License or Floating License form. The Floating License arrangement is particularly
useful for companies that manage a central store of license keys, which can be used by different employees
over time, temporarily or permanently.
The Business and Software Engineering edition provides:
· Generation of Behavioral Code from State, Sequence and Activity models, supporting standard
programming languages such as Java and .NET
· Advanced math functions within the scripting engine
· BPEL Generation from BPMN 1.1 models - including validation and WSDL support
· A Business Rules Composer that enables you to build Business Domain models and generate code to
implement complex business rules in standard programming languages.

Systems Engineering Edition

The Systems Engineering edition is designed for systems and software development professionals working on
real-time, embedded and systems solutions. It combines new features such as executable code generation
from UML models (including support for hardware languages such as Verilog and VHDL), Ada, SysML 1.1,
executable SysML Parametric diagrams and advanced scripting, and bundles licenses for DoDAF-MODAF,
SysML, DDS, TcSE and integration products to provide powerful model-driven construction tools for the
Systems Engineering domain to tightly bind your code development in Eclipse or Visual Studio with the
UML/SysML models developed in Enterprise Architect.
As explained above, the Systems Engineering edition incorporates a number of MDG Technologies 1073 and
Add-Ins. The Systems Engineering edition and MDG Technologies are all available in either Fixed License or
Floating License form. The Floating License arrangement is particularly useful for companies that manage a
central store of license keys, which can be used by different employees over time, temporarily or permanently.
This edition provides:
· Executable Code Generation - support for generating functional source code for State Machines,
Interactions and Activities in C, C++, C#, Java and VBNet
· Full round trip support for Hardware Description Languages, including Verilog, VHDL and SystemC, with
support for generating State Machine code
· SysML Simulation Support - Includes support for simulating SysML 1.1 constraint models with results
graphing capabilities.

Corporate Edition
Aimed at larger development teams, the Corporate edition enables you to connect to the following DBMS back
ends as the shared repository: MySQL, SQL Server, PostgreSQL, Sybase Adaptive Server Anywhere, Access
2007 and Oracle 9i, 10g or 11g. 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 forms the base for the three extended editions described above. Like those editions, it is
available in either Fixed License or Floating License form. The Floating License arrangement is particularly
useful for companies that manage a central store of license keys, which can be used by different employees
over time, temporarily or permanently.

Enterprise Architect User Guide

 Introduction | Enterprise Architect Editions 15

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 of SQL Server; MS
Access 97, 2000 and 2003; 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).

Desktop Edition
The Desktop edition is targeted at single analysts and developers producing UML analysis and design
models. It provides facilities for UML modeling, XMI import/export, document generation, version control
integration and profile/metamodel extensibility.

1.2.3 The Read-only 'Lite' Edition

Enterprise Architect Lite is a free, read-only edition of Enterprise Architect that enables people such as project
sponsors to review the project without making any changes.
However, users of Enterprise Architect Lite also have wider access to:
· The Team Review 208 , where readers can create and respond to posts, and link their comments to
elements
· The Source Code Viewer 1441 , where readers can open and edit external source code files, debug code,
and configure and run package build scripts
· The File 56 menu, where readers can copy the project or create a shortcut to access it
· The Relationship Matrix, where readers can export the matrix contents 1267 to a CSV file to be opened in a
spreadsheet application
· The Default Hours 340 tab to review project metrics.
You can download the Enterprise Architect Lite edition (as the Enterprise Architect Viewer) from the Sparx
Systems website at http://www.sparxsystems.com/products/ea/downloads.html.

Other Read-Only Options

You can also make your model available to others in a read-only format by:
· Running Enterprise Architect over a VPN connection
· Generating an HTML report 1647 on the model, which can be published on the web with read-only access.

© 1998-2010 Sparx Systems Pty Ltd

 16 Introduction | Formal Statements

1.3 Formal Statements

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

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

1.3.1 Copyright Notice

Copyright © 1998 - 2010 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 16 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: [email protected]
Sales Email: [email protected]
Website: www.sparxsystems.com

Scintilla and SciTE

Copyright 1998-2003 by Neil Hodgson <[email protected]> All Rights Reserved.
Permission to use and distribute this (Scintilla) software and its documentation for any purpose and without fee
is hereby granted, provided that the above copyright notice appears in all copies and that both that copyright
notice and this permission notice appear in supporting documentation.

1.3.2 End User License Agreement

Enterprise Architect Modeling Tool Version 8.0

Desktop, Professional, Corporate, Business and Software Engineering, Systems Engineering &
Ultimate Editions

Copyright (C) 1998-2010 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 SYSTEMS ("SPARX") for the SOFTWARE PRODUCT identified

Enterprise Architect User Guide

 Introduction | Formal Statements 17

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.C.N
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.C.N 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/ea_purchase.htm.
· "SOFTWARE PRODUCT" or "SOFTWARE" means Enterprise Architect, UML Case Tool, Desk Top,
Professional, Corporate, Business and Software Engineering, Systems Engineering and Ultimate 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 thirty (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 only.

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 thirty (30) days.
Upon expiration of the thirty (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.
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/ea_purchase.htm). 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.

© 1998-2010 Sparx Systems Pty Ltd

 18 Introduction | Formal Statements

EA LITE
Subject to the terms of this Agreement EA LITE 15 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
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:

Enterprise Architect User Guide

 Introduction | Formal Statements 19

· 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 98, Windows NT, Windows ME, Windows XP, Windows Vista, Windows 2000 and
Windows 2003 Server are trademarks of Microsoftâ.

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

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®
· UML®
· The UML Cube logo

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™
· MOF™

© 1998-2010 Sparx Systems Pty Ltd

 20 Introduction | Formal Statements

· CWM™
· Model Driven Architecture™
· MDA™
· OMG Model Driven Architecture™
· OMG MDA™

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
[email protected]

Davide Pizzolato
CXImage Library
© 7-Aug-2001
[email protected]

Neil Hodgson
Scintilla editor
© 1998-2003
[email protected]

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 User Guide

 Introduction | Installation 21

1.4 Installation
Enterprise Architect is distributed as a single executable setup file (.exe). After you execute this file, Enterprise
Architect is immediately available to create projects as .EAP files.
If you plan to use the Corporate, Business and Software Engineering, Systems Engineering or Ultimate edition
with SQL Server, MySQL, PostgreSQL, Access 2007, Sybase Adaptive Server Anywhere or Oracle 9i, 10g or
11g as a model repository (see below), you require additional files and supplementary installation processes.
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. To support the Scripting facility in the Corporate and extended editions of Enterprise Architect, you
must also install Internet Explorer 6.0 or later revisions.
Corporate, Business and Software Engineering, Systems Engineering and Ultimate edition users planning to
use SQL Server, MySQL, PostgreSQL, Sybase Adaptive Server Anywhere, Access 2007 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.

© 1998-2010 Sparx Systems Pty Ltd

 22 Introduction | Register a Full License

1.5 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 supplied determines which edition (Enterprise Architect Desktop, Professional, Corporate,
Business and Software Engineering, System Engineering or Ultimate) is activated after installation.
The Corporate, Business and Software Engineering, System Engineering and Ultimate editions can be
activated by either a private license key or a shared (floating) license key. Shared license keys, for a user
population that includes temporary users, are checked out of and in to a Sparx Systems keystore.
Private license keys and shared license keys have different formats, so you cannot use one in place of the
other.

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
· if you have purchased a Sparx Systems key store, the address of a web site from which to download
the keystore.
2. Save the license key(s) 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. The License Management dialog
displays.

5. Click on the Add Key button. The Add Registration Key dialog displays.
6. Refer to the Add License Key 1870 topic.
7. 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.
See Also (in Project Development in Enterprise Architect):
· Upgrade an Existing License 1873

· Register Add-In 1876

Enterprise Architect User Guide

 Introduction | Help and Support 23

1.6 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, EAExample, supplied with
Enterprise Architect. This 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
50 .

If you have purchased Enterprise Architect and are a registered user, you can also contact Sparx Support 24
to answer any queries or problems.

Tasks Pane
The Enterprise Architect Tasks Pane 51 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, either:
· Click on the Help icon ( ) in the various toolbars
· Select the Help | Help Contents menu option, or
· 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 24 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, community site (see below) 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 | Other Project Tools
| Internal Web Browser menu option, and through the Online Resources topics in the Tasks Pane.
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.

© 1998-2010 Sparx Systems Pty Ltd

 24 Introduction | Help and Support

Community Site
The Sparx Systems website also hosts the Sparx Systems Enterprise Architect Community Site. This is a
central location for the Enterprise Architect community to publish resources and share experiences.
From this site you can download the latest news, tutorials, resources, best practices, tips, techniques and
user-generated content for Enterprise Architect. You can also, as a registered author, contribute content and
share your expertise with the wider community.

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

1.6.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:
[email protected].
An online user forum is also available for your questions and perusal, at
http://www.sparxsystems.com/cgi-bin/yabb/YaBB.cgi.

Enterprise Architect User Guide

Part

II
 26 Getting Started |

2 Getting Started

This guide helps you understand the options available when you start Enterprise Architect 27 , and to quickly
gain an understanding of how to use these options to create models.
After starting Enterprise Architect, use the Quick Start 28 tutorial to immediately create a project.
The tutorial leads on to examining:
· Work areas applicable to certain Project Roles 37 and
· The Enterprise Architect User Interface 48 , or workspace.
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.

Enterprise Architect User Guide

 Getting Started | Basics 27

2.1 Basics

When you install Enterprise Architect on your computer, a new program folder called Enterprise Architect is
created in your Start menu (unless you changed the default name during installation).

Start Enterprise Architect

You can start Enterprise Architect from the icon created on your Windows desktop during installation, or
alternatively:
1. Open the Windows Start menu.
2. Locate the Enterprise Architect program folder.
3. Select Enterprise Architect.
After a short pause, the Start Page 50 displays. From this page you can:
· Open a project file 114 (.EAP file)
· Create a new project 120 (.EAP file)
· Connect to a DBMS repository 147 (Corporate and extended editions).

Note:
By default, when you install Enterprise Architect, an empty 'starter' project called 'EABase.EAP' is installed,
as well as an example project named 'EAExample.EAP'. We recommend that new users select the
'EAExample' file and explore it in some detail while you become familiar with UML and software engineering
using Enterprise Architect.

To begin a guided exploration of Enterprise Architect immediately, go to the A Quick Start Tutorial 28 topic.

© 1998-2010 Sparx Systems Pty Ltd

 28 Getting Started | A Quickstart Tutorial

2.2 A Quickstart Tutorial

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 113 and then add a View, a package, a diagram, elements and connectors.

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

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 Select Model(s) 372 dialog displays.
3. You now select one or more model templates 373 (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 a Model Package for each selected template and
displays it in the Project Browser 1209 , on the right-hand side of the screen.

Enterprise Architect User Guide

 Getting Started | A Quickstart Tutorial 29

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

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.
Double-click on the diagram icon displayed underneath a package name. Enterprise Architect displays the
sample diagram for that model in the Diagram View 396 , 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 a View 29 to the model, and
then add a package with diagram, elements and connectors (relationships).

2.2.1 Add a View to a Model

A View 383 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 228 , an 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 30 and diagram to that View or any
other in the model, and then add elements and connectors (relationships).

© 1998-2010 Sparx Systems Pty Ltd

 30 Getting Started | A Quickstart Tutorial

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

Additional Information
For additional information on packages, and adding packages and Views (top-level packages), see the
Packages 387 , Add a Package 387 and Add Views 383 topics.

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 a new one.

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

Enterprise Architect User Guide

 Getting Started | A Quickstart Tutorial 31

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

Additional Information
For additional information on diagrams and adding them to a project, see UML Diagrams 673 and Add New
Diagrams 422 .

2.2.4 Add Elements

You have several options for adding elements (the model building units) to a package and/or diagram.
The simplest method is to use the 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 33 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.

© 1998-2010 Sparx Systems Pty Ltd

 32 Getting Started | A Quickstart Tutorial

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 32 with relationships.

Additional Information
When you click on an element on a diagram, a number of icons display outside the top right corner. These are
the Quick Linker 474 and Toolbar 521 icons that enable you to quickly add more elements and connectors and
to operate on the elements. You can read about and experiment with these later.
For additional information on elements and adding elements to a project, see UML Elements 741 , Create
Elements 523 and Paste From the Project Browser 430 .

2.2.5 Add Connectors

Connectors 852 define specific relationships between specific elements, so you usually create them 610 directly
on the diagram by dragging the required relationship type from the 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 33 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 34 those components around and delete 35
them. You should also know how to save 36 your work.

Additional Information
For further information on creating a connector through the Project Browser, or with the Quick Linker, see the
Create Connector in Project Browser 618 topic and the Quick Linker - Create Connectors 476 topic.

Enterprise Architect User Guide

 Getting Started | A Quickstart Tutorial 33

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 481 . 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.
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 Properties Dialog 481 topic and the Connector Properties 626 topic for a full description of the element
and connector Properties dialogs.

© 1998-2010 Sparx Systems Pty Ltd

 34 Getting Started | A Quickstart Tutorial

2.2.7 Move Components

You have created a project containing packages, diagrams and elements, and you have connected the
elements. You might have arranged your components in the wrong project structure. How do you change
where things are?
In this topic, the explanations refer to the following example:

Notes:
· You display and work on your model in the Project Browser, and display and work on a diagram in the
Diagram View.
· In the Project Browser, the contents of a package are listed in the order diagrams | child packages |
elements. Elements are further arranged in type order. Within their types, components are initially listed in
alphabetical or numerical order.
· Moving an element or package has no effect on any relationships that the element, package, or elements
within the package have. You have to specifically create, delete or move the relationships themselves.

Move Components Within a Package in the Project Browser

To move a diagram, child package or element within its parent package, click on it in the Project Browser and
click on or in the toolbar at the top of the window.
You could move Class3 in the Project Browser above Class1, or move the Actors package underneath
Classes A.
To revert to listing components in alphabetical order, right-click on the package and select the Contents |
Reset Sort Order menu option.

Move Components Between Packages in the Project Browser

You might have created a diagram, child package or element in the wrong place in the Project Browser. To
move a model component to another package, click on the component and drag it to the new package. This
can be at either a higher level or a lower level.
You might, for example, drag Class1 from the Use Case Model package into the Business Process Model
package. Class1 then is listed in the Business Process Model package in the Project Browser. As a similar
example, you could drag Class Diagram into the Business Process Model package.
Moving elements in the Project Browser does not affect the use of elements in diagrams. In our example,
Class1 is initially in a diagram in the Use Case Model package. When you move Class1 in the Project Browser
from Use Case Model to Business Process Model, it still shows in the diagram in Use Case Model, and does
not display in any diagram in Business Process Model.

Enterprise Architect User Guide

 Getting Started | A Quickstart Tutorial 35

Note:
Moving a diagram generally does not affect the location of elements in packages. If you move the Class
Diagram out of Use Case Model into Business Process Model, all the elements in the diagram remain in the
Use Case Model package.
However, elements of certain types might be used only within one diagram, have no meaning outside that
diagram, and never be re-used in any other diagram. Such elements include Decision 765 , Initial 778 and Final
Node 772 elements. Therefore, if you move a diagram containing these elements, they are moved to the new
parent package with the diagram.

To remove Class1 from the Use Case Model diagram, click on it on the diagram and delete 35 it. Nothing
happens to the element in the Project Browser. To put Class1 into a diagram in the Business Process Model
package, open the diagram in that package and drag the element from the Business Process Model package
in the Project Browser onto the diagram.

Move Elements in a Diagram

If an element is not in the right position in the diagram, just click on the middle of it and drag it to the correct
place. In the diagram above, you might move Class2 below Class 3, and move Class3 to the left. The element
brings its connectors with it.
To make fine adjustments, press [Shift]+["], [!], [#] or [$].

Move Elements Between Diagrams

If an element is in the wrong diagram, you can delete it from that diagram and then drag it from the Project
Browser into the right diagram.
Alternatively, select the element and cut it from the source diagram ([Ctrl]+[X], or the Cut icon in the Default
Tools toolbar) and then paste the element ([Shift]+[Insert] or the Paste icon in the Default Tools toolbar) into
the target diagram.
You can also copy and paste elements between diagrams. In the source diagram, select the element and
press [Ctrl]+[C] (or click on the Copy icon in the Default Tools toolbar), then in the target diagram press
[Shift]+[Insert] (or click on the Paste icon in the Default Tools toolbar).

Move Connectors in a Diagram

You might have connected the wrong pair of elements. To move the end of a connector to a different element
(for example, Class2 instead of Class3), click on the end to display a black 'handle' box and drag the end to its
new position. Be aware that the connector does not break from the original target element until the cursor is on
the new target.
You can also tidy up a connection by dragging the end of the connector to a better position on the edge of the
element, or move both ends at once by dragging the middle of the connector.

Additional Information
See the Delete Components 35 and Save Changes 36 topics.
For additional information on moving connectors and elements, see the Arrange Connectors 613 topic and the
Order Package Contents 1210 topic.

2.2.8 Delete Components

You can delete the components of a model from a diagram or from the Project Browser.

Delete From a Diagram

A diagram can contain elements, connectors, packages and other diagrams. To delete any of these from the
diagram, click on it and press [Delete] on the keyboard.

© 1998-2010 Sparx Systems Pty Ltd

 36 Getting Started | A Quickstart Tutorial

Notes:
· Remember that the contents of the model are listed in the Project Browser. If you delete something from a
diagram, it is not deleted from the Project Browser. This is because you can use the same component in
several diagrams at once, so you only remove the representation of the component from a diagram.
· To delete a connector from a diagram, click on it and press [Delete]. This time, Enterprise Architect
prompts you to select whether to delete the connector or just hide it. Unlike elements, the same connector
is not reapplied in several places, so if you delete one it is removed completely from the model.
· Connectors can get confusing on a complex diagram, so it is useful to hide some of them to clarify a
specific aspect of a more complex picture. To identify and reveal hidden connectors, see the Links 489
topic.

Delete From Project Browser

To delete a package, diagram or element from the Project Browser, right-click on the component and select
the Delete <name> menu option.
For a package, this completely removes the package and all its contents - diagrams, child packages and
elements - from the model.
For an element, this completely removes the element and its properties, connectors, child elements and child
diagrams from the model, and from every diagram that contains it.
For a diagram, this completely removes the diagram and connectors from the model, but not the diagram's
component elements. They remain in the parent package.

Additional Information
See the Save Changes 36 topic.
For additional information on deleting elements, connectors and model views in Enterprise Architect, see the
Delete Elements 534 , Delete Connectors 619 and Delete Views 385 topics.

2.2.9 Save Changes

Throughout much of your work in Enterprise Architect, any changes you make are automatically saved when
you close the dialog (data entry window) on which you made the changes. In some cases the dialog contains
a Save or Apply button, which enables you to save your changes and then keep working on the dialog.
If there is no specific dialog, such as when you create a diagram, you can save your work by:

· Clicking on the Save icon in the Diagram toolbar ( )

· Pressing the [Ctrl]+[S] keyboard keys, or
· Selecting the Diagram | Save menu option.
Often, Enterprise Architect does not let you close a screen without confirming that you want to save or discard
your changes.
You can also save your diagram changes automatically, by selecting the Auto Save Changes checkbox on
the Diagram Behavior 359 page of the Options dialog.

Explore User Interface

So far you have been using the Project Browser and Diagram View to develop your project. At this point you
should find out a bit more about the other facilities of the Enterprise Architect User Interface 48 or Application
Workspace.
When you have finished exploring the User Interface topics, go to Summary of Typical Tasks 37 to identify
areas of Enterprise Architect that provide particular support for your job role.

Enterprise Architect User Guide

 Getting Started | Typical Project Roles 37

2.3 Typical Project Roles

Enterprise Architect performs a number of tasks that are suited to a variety of professions. This topic
describes some common working practices with Enterprise Architect for a range of project roles. There are
tools for the roles of:
· Business Analyst 38
· Software Architect 40
· Software Engineer 41
· Developer 42
· Project Manager 43
· Tester 43
· Implementation Manager 45

· Technology Developer 46
· Database Developer 47
You can review a summary of the typical tasks 37 supported for each role, or click on the appropriate role title
to explore how Enterprise Architect can assist you in carrying out that role within a model driven project.

2.3.1 Summary of Typical Tasks

Throughout a design and development project there are many different tasks to be performed, which could be
carried out either by one person or - more probably - by members of a team with different responsibilities. In
either case, Enterprise Architect supports most - if not all - of the responsibilities you might have on your
project.
Therefore, the next topics to explore depend on the work you normally do on a project.
The descriptions below cover a number of job roles that Enterprise Architect supports. For those that most
resemble your role on a project, follow the job title hyperlink to display a description of how that role might use
Enterprise Architect, then follow links within those topics to explore some of the Enterprise Architect features
of importance to the role.
Most of these roles work with specific types of diagram, so you might want to learn more about diagram types
in general and specific types of diagram in particular. See the UML Diagrams 673 topic
Several types of project team member might want to generate documentation on their work and reports on
how the project is developing and changing. Enterprise Architect enables you to generate project
documentation in either RTF or HTML format - see the Report Generation 1568 topic.

Note:
The Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of Enterprise
Architect have a user security feature that can be applied or turned off. If security is turned on, you require
the appropriate access permissions to use many of the Enterprise Architect facilities listed above. For further
information, see the List of Available Permissions 198 topic.

© 1998-2010 Sparx Systems Pty Ltd

 38 Getting Started | Typical Project Roles

Business Analyst Database Developer

A Business Analyst 38 might be responsible for A Database Developer 47 might be responsible for:
modeling:
· Developing databases
· Requirements · Modeling database structures
· High-level business processes · Creating logical data models
· Business activities · Generating schema
· Work flows · Reverse engineering databases.
· System behavior.
Tester
Software Architect A Tester 43 might be responsible for:
A Software Architect 40 might be responsible for:
· Developing test cases
· Mapping functional requirements of the system · Importing requirements, constraints and
· Mapping objects in real time scenarios
· Mapping the deployment of objects · Creating Quality Test documentation
· Defining deliverable components. · Tracking element defects and changes.

Software Engineer Project Manager

A Software Engineer 41 might be responsible for: A Project Manager 43 might be responsible for:
· Mapping Use Cases into detailed Classes · Providing project estimates
· Defining the interaction between Classes · Resource Management
· Defining system deployment · Risk Management
· Defining software packages and the software · Maintenance Management.
architecture.

Developer Implementation Manager

A Developer 42 might be responsible for: An Implementation Manager 45 might be
responsible for:
· Forward, reverse and round-trip engineering
· Visualizing the system states · Modeling the tasks in rolling-out a project,
including network and hardware deployment
· Visualizing package arrangements
· Assigning and tracking maintenance items on
· Mapping the flow of code. elements (issues, changes, defects and tasks).

Technology Developer
A Technology Developer 46 might be responsible for
creating or customizing:
· UML Profiles
· UML Patterns
· Code Templates
· Tagged Value Types
· MDG Technologies
· Add-Ins.

2.3.2 Business Analysts

A Business Analyst can use Enterprise Architect to create high-level models of business processes 930 . These
include business requirements, activities, work flow, and the display of system behavior.
Using Enterprise Architect, a Business Analyst can describe the procedures that govern what a particular
business does. Such a model is intended to deliver a high-level overview of a proposed system.

Enterprise Architect User Guide

 Getting Started | Typical Project Roles 39

Model High Level Business Processes

With Enterprise Architect the Business Analyst can model high level processes of the business with Analysis
diagrams 733 . Analysis diagrams are a subset of UML 2.3 Activity diagrams and are less formal than other
diagram types, but they provide a useful means for expressing essential business characteristics and
requirements.

Model Requirements
Gathering requirements 917 is typically the first step in developing a solution, be it for developing a software
application or for detailing a business process. It is an important step in the implementation of a project.
Enterprise Architect enables you to define the Requirement elements, connect Requirements to the model
elements for implementation, connect Requirements together into a hierarchy, report on Requirements, and
move Requirements out of model element responsibilities.

Model Business Activities

The Business Analyst can use Activity diagrams 674 to model the behavior of a system and the way in which
these behaviors are related to the overall flow of the system. Activity diagrams do not model the exact internal
behavior of the system but show instead the general processes and pathways at a high level.

Model Work Flow

To visualize the cooperation between elements involved in the work flow, the Business Analyst can use an
Interaction Overview diagram 717 , which provides an overview of sub activities that are involved in a system.

Display System Behavior

In displaying the behavior of a system as a Use Case diagram 676 , Enterprise Architect gives the Business
Analyst an easily understood tool for mapping the functional requirements and behavior of a system.

© 1998-2010 Sparx Systems Pty Ltd

 40 Getting Started | Typical Project Roles

2.3.3 Software Architects

Software Architects can use Enterprise Architect to map functional requirements with Use Cases, perform real
time modeling of objects using Interaction diagrams (Sequence 706 , Timing 690 , Communication 715 or
Interaction Overview 717 ), design the Deployment 727 model and detail the deliverable components using
Component 730 diagrams.

Map Functional Requirements of the System

With Enterprise Architect the Software Architect can take the high level business processes that have been
modeled by the Business Analyst and create detailed Use Cases 806 . Use Cases are used to describe the
proposed functionality of a system and are only used to detail a single unit of discrete work.

Map Objects in Real Time

The Software Architect can use Interaction diagrams (Sequence and Communication diagrams) to model the
dynamic design of the system. Sequence diagrams are used to detail the messages that are passed between
objects and the lifetimes of the objects. Communication diagrams are similar to Sequence diagrams, but are
used instead to display the way in which the object interacts with other objects.

Map Deployment of Objects

The Software Architect can use Deployment diagrams to provide a static view of the run-time configuration of
processing nodes and the components that run on the nodes. Deployment diagrams can be used to show the
connections between hardware, software and any middleware that is used on a system.

Enterprise Architect User Guide

 Getting Started | Typical Project Roles 41

Detail Deliverable Components

Component diagrams enable the Software Architect to model the physical aspects of a system. Components
can be executables, libraries, data files or another physical resource that is part of a system. The component
model can be developed from scratch from the Class model or can be brought in from existing projects and
from third-party vendors.

See Also
· Analysis Diagrams 733
· Modeling Fundamentals 370
· XMI Import and Export 288
· XML Technologies 1039

2.3.4 Software Engineers

Software Engineers using Enterprise Architect can map Use Cases onto Class 721 diagrams, detail the
interactions between Classes, define the system deployment with Deployment 727 diagrams and define
software packages with Package 720 diagrams.

Map Use Cases into Detailed Classes

In Enterprise Architect the Software Engineer can study the Use Cases 676 developed by the Software
Architect, and with that information create Classes that fulfill the objectives defined in the Use Cases. A Class
is one of the standard UML constructs that is used to detail the pattern from which objects are produced at run
time. To record the relationships between Use Cases and Classes, the Software Engineer can create
diagrams linking the elements with Realize 889 connectors, and/or map the Realize connectors in the
Relationship Matrix 1261 .

Detail Interaction Between Classes

Interaction diagrams (Sequence 706 and Communication 715 diagrams) enable the Software Engineer to
model the dynamic design of the system. Sequence diagrams are used to detail the messages passed
between objects and the lifetimes of the objects. Communication diagrams are similar to Sequence diagrams,
but are used instead to display the way in which objects interact with other objects.

Define System Deployment

Deployment diagrams can be used to provide a static view of the run-time configuration of processing nodes
and the components that run on the nodes. Deployment diagrams can be used to show the connections
between hardware, software and any middleware that is used on a system, to explain the connections and
relationships of the components.

© 1998-2010 Sparx Systems Pty Ltd

 42 Getting Started | Typical Project Roles

Define Software Packages

The Software Engineer can use Package diagrams to detail the software architecture. Package diagrams are
used to organize diagrams and elements into manageable groups, declaring the dependencies.

See Also
· Modeling Fundamentals 370

2.3.5 Developers
Developers can use Enterprise Architect to perform round trip code engineering 1281 , which includes reverse
engineering of existing code and generation of code 1308 from Class elements 811 .

State Machine 678 , Package 720 and Activity 674 diagrams can be used by the developer to better understand
the interaction between code elements and the arrangement of the code.

Round Trip Engineering

Enterprise Architect gives the developer unparalleled flexibility, with the ability to round trip software from
existing source code to UML 2.3 models and back again. Round trip Engineering involves both forward and
reverse engineering of code. Keeping the model and code synchronized 1327 is an important aspect of round
trip engineering.

Reverse Engineering
Enterprise Architect enables developers to reverse engineer 1328 code from a number of supported languages
and view the existing code as Class 721 diagrams. The developer can use Class diagrams to illustrate the
static design view of the system. Class diagrams consist of Classes and interfaces and the relationships
between them. The Classes defined in UML Class diagrams can have direct counterparts in the
implementation of a programming language.

Forward Engineering
As well as the ability to reverse engineer code, Enterprise Architect offers the developer the option of forward

Enterprise Architect User Guide

 Getting Started | Typical Project Roles 43

engineering code (code generation). This enables the developer to make changes to their model with
Enterprise Architect and have these changes implemented in the source code.

Determine the System State

To visualize the state of the system the developer can use State Machine diagrams to describe how elements
move between states, classifying their behavior according to transition triggers and constraining guards. State
Machine diagrams are used to capture system changes over time, typically being associated with particular
Classes (often a Class can have one or more State Machine diagrams used to fully describe its potential
states).

Visualize Package Arrangement

Package diagrams are used to help design the architecture of the system. They are used to organize
diagrams and elements into manageable groups, and to declare their dependencies.

Follow the Flow of Code

Activity diagrams are used to enable a better understanding of the flow of code. Activity diagrams illustrate the
dynamic nature of the system. This enables modeling of the flow of control between Activities and represents
the changes in state of the system.

See Also
· XML Technologies 1039
· Model Transformations - MDA 1385

· Visual Execution Analysis 1488

2.3.6 Project Managers

Enterprise Architect provides support for the management of projects 312 . Project Managers can use
Enterprise Architect to assign resources to elements, measure risk and effort, and estimate project sizes.
Enterprise Architect also helps them manage element status 340 , change control and maintenance 1558 .

Provide Project Estimates

With Enterprise Architect the Project Manager has access to a comprehensive project estimation 335 tool that
calculates effort from Use Case and Actor objects, coupled with project configurations defining the technical
and environmental complexity of the work environment.

Resource Management
Managing the allocation of resources 313 in the design and development of system components is an
important and difficult task. Enterprise Architect enables the Project Manager or Development Manager to
assign resources directly to model elements and track progress over time.

Risk Management
The Project Management window can be used to assign Risk 316 to an element within a project. The Risk
Types 322 enable the Project Manager to name the risk, define the type of risk, and give it a weighting.

Maintenance
Enterprise Architect enables the Project Manager to track and assign maintenance-related items to elements
within Enterprise Architect. This enables rapid capture and record keeping for items such as issues 331 ,
changes, defects 1563 and tasks 329 . They can also create and maintain a project Glossary 323 of processes,
procedures, terms and descriptions.

2.3.7 Testers
Enterprise Architect provides support for design testing by enabling you to create test scripts against elements
in the modeling environment.
You assign test cases to individual model elements, requirements 917 and constraints 488 . You can add
scenarios to model elements, and use element defects 1559 to report problems associated with model
elements.

© 1998-2010 Sparx Systems Pty Ltd

 44 Getting Started | Typical Project Roles

For more detailed information on testing, see the Introduction to Testing 1536 topic.

Test Cases
With Enterprise Architect, Quality Assurance personnel can set a series of tests for each model element. The
test types include Unit testing, Acceptance testing, System testing and Scenario testing.

Import Requirements, Constraints and Scenarios

To help ensure that testing maintains integrity with the entire business process, Enterprise Architect enables
the tester to import requirements, constraints and scenarios defined in earlier iterations of the development life
cycle. Requirements indicate contractual obligations that elements must perform within the model. Constraints
are conditions which must be met in order to pass the testing process. Constraints can be Pre-conditions
(states which must be true before an event is processed), Post Conditions (events that must occur after the
event is processed) or invariant constraints (which must remain true through the duration of the event).
Scenarios are textual descriptions of an object's action over time and can be used to describe the way a test
works.

Create Quality Test Documentation

Enterprise Architect provides the facility to generate high quality test documentation. Enterprise Architect
produces test documentation in the industry-standard .RTF file format.

Element Defect Changes

Defect tracking enables you to allocate defect reports to any element within the Enterprise Architect model.
This enables all who are involved in the project to quickly view the status of defects, to see which defects have
to be addressed and which have been dealt with.

Enterprise Architect User Guide

 Getting Started | Typical Project Roles 45

2.3.8 Implementation Managers

Using Deployment 727 diagrams in Enterprise Architect, you can model the roll out of a project, including
network deployment and workstation deployment. Users involved in project deployment can add maintenance
tasks to the diagram elements.

Deployment diagrams provide a static view of the run-time configuration of nodes on the network or of
workstations, and the components that run on the nodes or are used in the workstations.

© 1998-2010 Sparx Systems Pty Ltd

 46 Getting Started | Typical Project Roles

Maintenance
Enterprise Architect enables you to track and assign maintenance 1558 -related items to elements within
Enterprise Architect. This enables you to rapidly capture and keep records of maintenance tasks such as
issues, changes, defects and tasks. By providing a centralized facility for each element involved in the
deployment process Enterprise Architect offers a powerful solution for tracing the maintenance of the items
and processes involved in system deployment.

2.3.9 Technology Developers

Technology Developers are Enterprise Architect users who create customized additions to the functionality
already present within Enterprise Architect.
Additions include UML Profiles, UML Patterns, Code Templates, Tagged Value Types, Scripts, Custom
Queries, Transformations, 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.

UML Profiles
By creating UML Profiles 906 the technology developer can create a customized extension for building UML
models that are specific to a particular domain. Profiles are stored as XML files and can be imported into any
model as required.

UML Patterns
Patterns 901 are sets of collaborating Objects and Classes that provide a generic template for repeatable
solutions to modeling problems. As patterns are discovered in any new project, the basic pattern template can
be created. Patterns can be re-used with the appropriate variable names modified for any future project.

Code Templates
Code Templates 1301 are used to customize the output of source code generated by Enterprise Architect. This
enables the generation of code languages not specifically supported by Enterprise Architect and enables you
to define the way Enterprise Architect generates source code to comply with your own company style
guidelines.

Tagged Value Types

Tagged Values are used in Enterprise Architect to extend the information relating to an element in addition to
the information directly supported by the UML language. A Tagged Value, strictly, is the value of a property of
a modeling item 633 , the property being called a tag. For example, a Class element called Person might have
a tag called Age with the Tagged Value of 42. More loosely, the combination of tag and value can be referred
to as a Tagged Value.
A Tagged Value Type 664 is a group of parameters that define and/or limit the possible values of a tag and, in
many instances, how a specific value is assigned to the tag. For example, the tag Age might have a Tagged
Value Type of Integer, so the user simply types in a numeric value. Alternatively, the type could be Spin, with
lower and upper limits of, say, 20 and 120, so the user sets a value by clicking on arrows in the field to
increment or decrement the value within the limits of 20 and 120.
Typically, Tagged Values are used during the code generation process, or by other tools to pass on
information that is used to operate on elements in particular ways.

MDG Technologies
MDG Technologies 1066 can be used to create a logical collection of resources that can contain UML Profiles,
Patterns, Code Templates, Image files and Tagged Value types that are accessed through a technology file.

Enterprise Architect Add-Ins

Enterprise Architect Add-Ins 1776 enable you to build your own functionality into Enterprise Architect, creating
your own mini programs that can extend the capabilities of Enterprise Architect, defining your own menus, and
creating your own Custom Views.

Enterprise Architect User Guide

 Getting Started | Typical Project Roles 47

Enterprise Architect Technology Developer Support

For explanations of how the features identified above are used within Enterprise Architect, see Build Your Own
Modeling Language 1092 . However, MDG Technology SDK 1092 explains in detail how to develop and integrate
these facilities.

2.3.10 Database Developers

Enterprise Architect supports a range of features for the development of databases 1011 , including modeling
database structures 739 , importing database structures from an existing database and generating DDL for
rapidly creating databases from a model.

Create Logical Data Models

With Enterprise Architect the Database developer can build database diagrams using the built-in UML Data
Modeling Profile. This supports the definition of Primary and Foreign keys, cardinality, validation, triggers,
constraints and indexes.

Generate Schema
By using Enterprise Architect's DDL generation function the Database Administrator can create a DDL script
for creation of the database table structure from the model. Enterprise Architect currently supports JET-based
databases; DB2; InterBase; Informix; Ingres; MySQL; SQL Server; PostgreSQL; Sybase Adaptive Server
Anywhere and Adaptive Server Enterprise; and Oracle 9i, 10g and 11g.

Reverse Engineer Database

Using an ODBC data connection the Database Administrator can import a database structure from an existing
database to create a model of the database. Generating the model directly from the database enables the
DBA to quickly document their work and create a diagrammatic account of a complex database through the
graphical benefits of UML.

© 1998-2010 Sparx Systems Pty Ltd

 48 Getting Started | User Interface Guide

2.4 User Interface Guide

This section provides a detailed exploration of the Enterprise Architect tools and features for modeling
software systems and business processes, including:
· The User Interface 48
· Starting Enterprise Architect 27
· The Start Page 50
· The Tasks Pane 51
· The Project Browser 1209
· The Main Menu 54
· The Diagram Toolbox 399
· Workspace Toolbars 79
· Diagram Tabs 397
· The Element List 1255
· Model Views 1222
· Model Searches 1231
· The Web Browser 103
· Dockable Windows 75
· Code Editors 1428
· The Quick Linker 474
· Defaults and User Settings 90
· Keyboard Shortcuts 104
· The Team Review Tools 208
· The Spell Checker 1552

2.4.1 Introduction
The Enterprise Architect Application Workspace consists of a number of windows, menus and toolbars as
described below. Together these elements provide a simple and flexible software engineering environment.
In concept the Application Workspace is similar to programs such as Microsoft Outlook and the Microsoft
Visual Studio application suite; if you have used these applications you should find the Enterprise Architect
interface quite familiar.

Enterprise Architect in Action

A demonstration of Enterprise Architect in use is provided on the Sparx Systems website.

Workspace Components
This section outlines the components of the Enterprise Architect Application Workspace. To obtain further
information on specific features, follow the hyperlinks in each description.

Main Menu and Toolbars

At the top of the workspace are the Main Menu 54 and toolbars 79 . The Main Menu provides access to
further submenus. There are several toolbars, which you can hide or display as necessary.

Context Menus
Throughout Enterprise Architect, if you right-click on work areas, lists and objects, Enterprise Architect
displays a menu of options specific to the work context. For examples, see:

Enterprise Architect User Guide

 Getting Started | User Interface Guide 49

· Package Context Menu (Project Browser) 1214

· Diagram Context Menu (Project Browser) 1220
· Element Context Menu (Project Browser) 1218
· Diagram Context Menu (Diagram) 394
· Element Context Menu (Diagram) 547 .

Key Combinations
Many main menu and context menu options have alternative key combinations to perform the same operation.
Instead of displaying a menu and selecting the required option, you can press the key combination. See
Keyboard Shortcuts 104 for a full list of key combinations and their functions, or display the Help Keyboard 108
dialog (select the Help | Keyboard Accelerator Map menu option). You can also customize 98 these function
keys.

Toolbox
The Enterprise Architect Diagram Toolbox 399 is an Outlook-style toolbar from which you can select model
elements and relationships to add to your modeling diagrams. This is an important feature of Enterprise
Architect, as it provides all the components and connectors that you use to create your models in whatever
diagrams are appropriate.

Diagram View
The large central area of the Enterprise Architect display is the Diagram View 396 . This is where you can
arrange new model elements and set their characteristics in a model diagram. Note that when you first open
Enterprise Architect there is no active diagram; you must create and/or open the required diagram.

Project Browser
The Project Browser 1209 is used to navigate your project. Double-click on package icons to open them and
display the diagrams and elements they contain. Similarly, double-click on elements to open them, and on
diagrams to display them in the Diagram View. You can drag elements 430 from the Project Browser to add
them to diagrams.

Model Views
You can set up tailored views of your model, containing sections or organizations of your model that are of
particular relevance to you or your team. Model Views 1222 are stored in the model and are visible to all users.
You can set up Favorites folders to give you easy access (hyperlinks) to commonly-used packages and
elements. You also have a My Views model stored locally on your machine and only visible to you, and
Technology-defined views that are read only and stored with MDG technologies. You can associate each view
with a query-built search that you can run by either double-clicking or expanding it.

Visual Style
You can configure the look and feel 101 of Enterprise Architect to suit your working environment. Options
range from a classic windows application to an enhanced XP appearance.

Arranging Windows
You can rearrange windows and some menus to adapt the screen space to your work habits. You can:
· Dock 76 windows against any edge of the workspace, or move them freely (float them) as you work; for a
list of dockable windows, see Standard Windows 75
· Autohide 78 windows so that they display only when you are actually using them.

© 1998-2010 Sparx Systems Pty Ltd

 50 Getting Started | User Interface Guide

2.4.2 Start Page

When you start Enterprise Architect, the first page displayed is the Start Page.

This page offers the following options:

Option Use to

Search Locate an object in Enterprise Architect. Type the name of the object in this field
and click on the [ ... ] button. Enterprise Architect displays the results of the
search on the Model Search 1231 screen.
Click on an item in the search results to highlight it in the Project Browser 1209 .

Open a Project File Display the Open Project 114 dialog, which you use to open an existing project
(where you have more project files than can be listed in the Recent panel).

Create a New Project Save a new project and open the Model Wizard 372 dialog.
120

Copy a Base Project Select a different Base Project 121 to generate a new project from.

Connect to Server 147 Specify a Data Source name to connect to. MySQL 123 , SQL Server 126 , Oracle
9i, 10g and 11g 129 , PostgreSQL 129 , MSDE 134 , Adaptive Server Anywhere 132 ,
Access 2007 123 and Progress OpenEdge 134 repositories are supported.

Note:
This feature is available in the Corporate, Business and Software Engineering,
Systems Engineering and Ultimate editions.

Getting Started Open the Tasks Pane 51 , to display useful topics and guides for various areas of
work in Enterprise Architect.

Configure Options Display the Help on the Options 350 dialog, which enables you to define how
Enterprise Architect displays and processes information.

Online Resources & Open the Resources page of the Sparx Systems website, which provides access
Tutorials to a wide range of Enterprise Architect and UML tutorials, demonstrations,
examples, Add-Ins and advice.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 51

Option Use to

Enterprise Architect Access the Sparx Systems Enterprise Architect Community Site, which contains
Community a range of articles, discussions, tools and resources provided by both Sparx
Systems and the Enterprise Architect user community.
You must register to use the facilities of the site; you can also register as an
author and submit material yourself, for others to read and use.

Recent Select from a list of the most recently used Enterprise Architect projects (both .
EAP files and DBMS connections). Click on the required project to open it.
If you have created and used shortcuts 115 to your models, a model might have
two entries - one for the model accessed through Enterprise Architect and one
for the model accessed through the desktop shortcut. These open the same
model, although the shortcut entry also enacts any view profile you have defined.
To remove a hyperlink to a project from this list, see Remove Recent Projects 56
.

If your model has a default diagram 437 set, the default diagram opens immediately over the top of the Start
Page. You can still access the Start Page from the diagram tabs 397 below the diagram. However, if you have
set a shortcut view profile, that overrides the default diagram setting.

2.4.3 Tasks Pane

Access: View | Other Project Tools | Tasks Pane.
The Tasks Pane window provides access to a range of context-specific help topics, online resources and
Enterprise Architect facilities to give you quick access to information and facilities in areas of interest in
Enterprise Architect.
When you first open Enterprise Architect, the Tasks Pane automatically displays on the right of the screen.

© 1998-2010 Sparx Systems Pty Ltd

 52 Getting Started | User Interface Guide

Enterprise Architect User Guide

 Getting Started | User Interface Guide 53

The Tasks Pane has several topic areas, including:

The list of topic areas varies, and can include topics specific to any MDG Technologies 1066 being used with
Enterprise Architect.
To switch between the topic areas, either:
· Click on the More Tasks option in the toolbar and select the required area from the list, or
· Click on the left or right arrow buttons in the toolbar.
The 'Home' icon returns you to the Getting Started topic area.

Tasks Pane Contents

The Tasks Pane provides several types of information and resources. Click on a:
· icon to open appropriate topics from the Enterprise Architect Help file
· icon to open web pages or documents on the Sparx Systems web site
· icon to begin Enterprise Architect tasks appropriate to the Tasks Pane topic area; you must be in an
appropriate functional area of Enterprise Architect in order for these tasks to function, such as in an open
diagram
· icon to begin Add-In tasks appropriate to the Tasks Pane topic area; you must be in an appropriate
functional area in order for these tasks to function
· icon to open report facilities to provide information or data collation tools

· icon to start demonstrations of Enterprise Architect functions in action.

The selected information, web page or demonstration displays on a Browser tab in the main view, or the
appropriate task or report window opens.

© 1998-2010 Sparx Systems Pty Ltd

 54 Getting Started | User Interface Guide

2.4.4 Main Menu

The Enterprise Architect Main menu provides mouse-driven access to many high-level functions related to the
project life cycle, as well as administration functions.

In order, the menus available are the:

· File 56 menu
· Edit 57 menu
· View 58 menu
· Project 60 menu
· Diagram 65 menu
· Element 67 menu
· Tools 70 menu
· Add-Ins 72 menu
· Settings 73 menu
· Window 74 menu
· Help 74 menu.
The above topics provide an overview of the functions available from the Main menu, and their general
purposes.
Additionally, if you right-click on the Toolbar area just under the menu bar, a composite context menu displays
providing options to display the toolbars and the more significant windows and views.

Enterprise Architect User Guide

Getting Started | User Interface Guide 55

© 1998-2010 Sparx Systems Pty Ltd

 56 Getting Started | User Interface Guide

2.4.4.1 File
The File menu provides options to create, open, close and save projects, and also to perform print tasks.

Menu Option & Function Use to

Keys

New Project [Ctrl]+[N] Create a new Enterprise Architect project 120 .

Open Project [Ctrl]+[O] Open a project 114 .

Open Source File Open any type of source file (code, XML, DDL) for editing 1442 .
[Ctrl]+[Alt]+[O]

Close Project Close the current project.

Save Project As Save the current model 115 with a new name, or create a desktop shortcut to
the current model.
(This option is also active in the 'Lite 15 ', read-only edition of Enterprise
Architect.)

Reload Current Project Reload the current project 267 (use in a multi-user environment to refresh
[Ctrl]+[Shift]+[F11] the Project Browser).

Print Setup Configure your printer's settings.

Page Setup Configure the page settings for printing.

Print Preview Preview 395 how the currently displayed diagram prints.

Print [Ctrl]+[P] Print the currently displayed diagram.

Enterprise Architect provides facilities to change the scale 456 of the printed
diagram (the number of pages it takes up) and to print or omit page headers
and footers 425 on the diagram.

Recent Files List Select from a list of the most recently opened projects.

Exit Exit Enterprise Architect.

2.4.4.1.1 Remove Recent Projects

To remove a project hyperlink from the Recent list on the Start Page 50 , follow the steps below:

1. Select File | Open Project from the menu bar or press [Ctrl]+[O]. The Open Project dialog displays.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 57

2. In the Recent Projects panel click on the project to remove.

3. Click on the Remove Selection from List button.

Note:
Removing the hyperlink to a project from the Start Page only removes the link to the project and does not
remove the .EAP file from the file system.

2.4.4.2 Edit
The Edit menu provides a range of functions to apply to diagram elements for the currently open diagram.

Menu Option & Function Use to

Keys

Undo [Ctrl]+[Z] Undo 458 the last action performed; note that some actions cannot be
undone.

Redo [Ctrl]+[Y] Re-apply the last undone action.

Copy [Ctrl]+[C] 1. Copy the selected elements to the MS Windows clipboard. To paste
the selected elements, see the Paste Elements submenu 58 .
2. Copy an image of the selected elements to the clipboard. If no
elements are selected, the entire diagram is copied.
The image can be saved as a bitmap or a metafile; you set the format on the
Options 351 dialog.

Add to Project Clipboard Add the current element to the Enterprise Architect clipboard.
[Ctrl]+[Space]

Clear Project Clipboard Clear any elements from the Enterprise Architect clipboard.

Paste Element(s) Paste clipboard elements into current diagram. See the Paste Elements 58
submenu.

Select All Select all elements concurrently on the current diagram.

Select By Type Specify a particular type of element to select.

Clear Selection Deselect all elements.

Model Search [Ctrl]+[Alt] Display the Model Search 1233 window, to search for particular phrases or
+[A] words.

File Search Display the File Search 1485 window, to search for text in code files and
scripts.

Bookmark Selected Bookmark 341 the selected element(s). If the selected element is already
[Shift]+[Space] bookmarked, this option removes the bookmark.

Clear All Bookmarks Clear bookmarks 341 from any bookmarked elements in the current diagram.

Delete Selected Element(s) Delete the selected element from the diagram.
[Ctrl]+[D]

© 1998-2010 Sparx Systems Pty Ltd

 58 Getting Started | User Interface Guide

2.4.4.2.1 Paste Elements Submenu

To paste what is in the buffer either as a new element or as a hyperlink to the element, select the Edit | Paste
Element(s) menu option.

Note:
You can paste images from the Enterprise Architect Clipboard or the MS Windows clipboard. The Enterprise
Architect clipboard takes precedence, so you must clear that clipboard before you can paste from the MS
Windows clipboard.

Menu Option & Function Use to

Keys

as Link [Shift]+[Insert] Paste the element in the buffer as a link 430 (that is, a reference) to the
element.
If there are images in the MS Windows clipboard and none in the Enterprise
Architect clipboard, you can:
· Paste an image from the MS Windows clipboard into a new element as
the appearance of the new element or
· Paste an image from the MS Windows clipboard into the diagram as a
new boundary's appearance.
as New [Ctrl]+[Shift]+[V] Paste the element in the buffer as a completely new 430 element.

Paste Image From Paste the element in the Enterprise Architect Clipboard into the same
Clipboard diagram or a different diagram, as a metafile (that is, a definition of the
[Ctrl]+[Shift]+[Insert] element) as many times as is necessary.
If you paste the element into a different diagram, the classifier identifies the
source diagram for the element.

2.4.4.3 View
From the View menu you can set local user preferences, including which toolbars or windows are hidden or
visible.

Menu Option & Function Keys Use to

Project Browser [Alt]+[0] Show or hide the Project Browser 1209 .

Model Views [Ctrl]+[Shift] Show or hide the Model Views 1222 window.
+[5]

Team Review Open the Team Review 208 window.

[Ctrl]+[Alt]+[U]

Relationship Matrix Open the Relationship Matrix 1261 to cross reference elements to each
other by connector type.

Element List [Ctrl]+[Alt]+[R] Display the current diagram or package in a context-sensitive, editable
table, the Element List 1255 .

Other Project Tools Display a submenu 59 containing options for the Resources, Tasks Pane,
System, Audit View windows, and the internal Web Browser.

Diagram Toolbox [Alt]+[5] Show or hide the Diagram Toolbox 399 .

Diagram Filters Display the Diagram Filters 1271 window, for selecting the elements to
show or hide on a diagram.

Pan and Zoom [Ctrl]+[Shift] Display the Pan & Zoom 1275 window for panning across a diagram to
+[N] display sections at greater magnification.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 59

Menu Option & Function Keys Use to

Layout Tools Display the Layout Tools 458 window, for reformatting your diagram in one
of a range of layouts.

Element Browser [Alt]+[9] Explore the components of the selected element, in the Element Browser
510 window.

Traceability [Ctrl]+[Shift]+[4] Show or hide the Traceability 1253 window, for tracing the relationships of
an element through the model.

Element Properties [Alt]+[1] Show or hide the Properties 508 window for the selected element.

Scenarios & Requirements Display the Scenarios, internal Constraints and Requirements 514 for the
[Ctrl]+[Shift]+[3] selected element, as tabs of the main work space.

Testing [Alt]+[3] Show or hide the Testing 1537 window.

Other Element Tools Display a submenu 59 containing options for the Project Management,
Maintenance, Source Code and Relationships tools.

Execution Analyser Display the Debug Workbench options. See View Submenus 60 .

Scripting Show or hide the Scripter 1660 window.

System Output [Ctrl]+[Shift] Show or hide the Output 102 window.

+[8]

Add-In Windows Display a window, or list of windows, provided by any Add-Ins you have
installed and enabled.
If no windows are provided, displays an empty, docked Add-Ins window.

Notes [Ctrl]+[Shift]+[1] Show or hide the Notes 641 window.

Tagged Values Show or hide the Tagged Values 632 window.

[Ctrl]+[Shift]+[6]

Toolbars Show or hide individual toolbars. See View Submenus 60 .

Visual Style See View Submenus 60 .

Workspace Layouts Displays the Workspace Layout dialog for changing the content and
layout 86 of the Enterprise Architect workspace.

2.4.4.3.1 View Submenus

The Other Project Tools Sub-Menu

Select the windows to be visible and deselect those to be hidden. You can select from:
· Resources [Alt]+[6] - Show or hide the Resources 667 window.
· Tasks Pane [Ctrl]+[Shift]+[9] - Show or hide the Tasks Pane 51 .
· System [Alt]+[2] - Show or hide the System 323 window.
· Audit View - Display the Audit View 274 , which shows the information that has been recorded by auditing.
· Internal Web Browser 103 [Ctrl]+[Alt]+[W] - Open the web browser page at the site you have specified on
the Options 351 dialog, in the Web Home field.

The Other Element Tools Submenu

Select the windows to be visible and deselect those to be hidden. You can select from:
· Project Management [Ctrl]+[Shift]+[7] - Show or hide the Project Management 312 window.
· Maintenance [Alt]+[4] - Show or hide the Maintenance 1558 window.
· Source Code [Alt]+[7] - Show or hide the Source Code Viewer 1441 window.

© 1998-2010 Sparx Systems Pty Ltd

 60 Getting Started | User Interface Guide

· Relationships [Ctrl]+[Shift]+[2] - List the element's connectors on the Relationships 1269 window.

The Execution Analyzer Menu

Select the aspect of the debugging process you want to explore, from the following options:

· Debugger [Alt]+[8] - Show or hide the Debug 1471 window, which also enables you to display some or all of
the other debugger windows listed below, at the same time.
· Profiler 1514 - displays the Profiler window.
· Call Stack 1473
· Record & Analyze 1506
· Locals 1474
· Watches 1475
· Modules 1478
· Debug Output 1478
· Workbench 1519 - enables you to create your own workbench variables 1521 and invoke methods 1522 on them
· Breakpoints & Markers 1503
· Memory Viewer 1476

The Toolbars Sub-Menu

Select the toolbars to be visible and deselect those to be hidden. You can select from:
· Default Tools 80
· Project 81
· Code Generation 81
· UML Elements 83
· Diagram 83
· Current Element 84
· Current Connector 84
· Format Tool 85
· Workspace Layouts 86
· Status Bar 89 .

The Visual Style Sub-Menu

Presents options to:
· Select different visual styles 101 or themes for the Enterprise Architect user interface
· Animate windows that have been automatically hidden 78
· Toggle the down-arrow on the end of each toolbar that enables you to customize the toolbar buttons, as
shown below:

· Hide or redisplay the diagram caption bar 396 at the top or bottom of a diagram. The caption bar is
illustrated below:

2.4.4.4 Project
Use the Project menu for tasks related to the management of your project, such as recording issues, setting
estimation parameters and compiling a glossary.

Menu Option & Function Use to

Keys

Add Package [Ctrl]+[W] Create a new package 387 .

Enterprise Architect User Guide

 Getting Started | User Interface Guide 61

Menu Option & Function Use to

Keys

Add Diagram [Ctrl]+[Insert] Create a new diagram 422 in the current package.

Add Element [Ctrl]+[M] Create a new element 523 on the current diagram.

Documentation See Documentation Submenu 61 .

Source Code Engineering See Source Code Engineering Submenu 62 .

Execution Analyzer See Execution Analyzer Submenu 62 .

Database Engineering See Database Engineering Submenu 63 .

Transformations See Model Transformations Submenu 63 .

Model Validation See Model Validation Submenu 64 .

Web Services See Web Services Submenu 64 .

XML Schema See XML Schema Submenu 64 .

Security See Security Submenu 64 .

Version Control See Version Control Submenu 65 .

Import/Export See Import/Export Submenu 65 .

Manage Baselines [Ctrl] Store a model branch as a snapshot or baseline 281 . Available in the
+[Alt]+[B] Corporate, Business and Software Engineering, Systems Engineering and
Ultimate editions.

Use Case Metrics Set Use Case Metrics 338 to assist in estimating project size.

Project Statistics View some basic project statistics.

2.4.4.4.1 Documentation Submenu

To generate various types of documentation, select the Project | Documentation menu option.

Menu Option & Function Keys Use to

Rich Text Format Report [F8] Generate a report for the currently selected package in Rich Text Format
1569 .

HTML Report [Shift]+[F8] Generate a report for the currently selected package in HTML 1647 format.

Diagrams Only Report Generate an RTF report containing only diagrams 1625 .
[Ctrl]+[Shift]+[F8]

Testing Report Generate an RTF report of the model's existing tests 1550 .

Issues Generate an RTF report of the model's issues 331 .

Glossary Generate an RTF report of the model's Glossary 328 .

Implementation Details Generate an implementation report 1626 for the currently-selected

package.

Dependency Details Generate a dependency report 1624 for the currently-selected package.

Testing Details Generate test details 1549 for the currently-selected package.

Resource and Tasking Details View resource details 318 .

© 1998-2010 Sparx Systems Pty Ltd

 62 Getting Started | User Interface Guide

2.4.4.4.2 Source Code Engineering Submenu

To forward and reverse engineer code using the language of your choice select the Project | Source Code
Engineering menu option (Professional, Corporate, Business and Software Engineering, Systems
Engineering and Ultimate editions).

Menu Option & Use to

Function Keys

Generate Package Generate source code 1311 for the currently selected package.
Source Code
[Ctrl]+[Alt]+[K]

Synchronize Package Synchronize selected package with the source code.

Contents
[Ctrl]+[Alt]+[M]

Import Source Import 1332 and reverse engineer an entire directory structure.
Directory
[Ctrl]+[Shift]+[U]

Import Binary Module Import a binary module 1334 .

Import ActionScript Import code written in ActionScript 1331 with the file extension .AS.
Files

Import C Files Import code written in ANSI C 1331 with the file extension .C or .H.

Import C# Files Import code written in the C# 1331 programming language with the file extension .
CS.

Import C++ Files Import code written in the C++ 1331 programming language with the file extension .
H, .HPP or .HH.

Import Delphi Files Import code written in the Delphi 1331 programming language with the file
extension .PAS.

Import Java Files Import code written in the Java 1331 programming language with the file
extension .JAVA.

Import PHP Files Import code written in PHP 1332 with the file extension .PHP, .PHP4, .INC.

Import Python Files Import code written in Python 1332 with the file extension .PY.

Import Visual Basic Import code written in the Visual Basic 1332 programming language with the file
Files extension .FRM, .CLS, .BAS or .CTL.

Import VB.Net Files Import code written in the VB.Net 1332 programming language with the file
extension .VB.

2.4.4.4.3 Execution Analyzer Submenu

To link your project with a compiler for building, running and debugging, select the Project | Execution
Analyzer menu option.

Menu Option & Use to

Function Keys

Package Build Scripts Create and configure Package Build compiler scripts 1426 .
[Shift]+[F12]

Build [Ctrl]+[Shift] Build 1444 the application for your current script. Execute the Build command in
+[F12] the Build Scripts dialog.

Test [Ctrl]+[Alt]+[T] Execute the Test 1483 command you configured in the Build Scripts dialog.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 63

Menu Option & Use to

Function Keys

Run [Ctrl]+[Alt]+[N] Execute the Run 1482 command you configured in the Build Scripts dialog.

Deploy [Ctrl]+[Shift] Execute the Deploy 1484 command you configured in the Build Scripts dialog.
+[Alt]+[F12]

Debug Run [F6] Run the application and Debug 1447 the Run command in the Build Scripts dialog.

Debug Pause Pause and restart execution of a debug run.

Step Into [Shift]+[F6] Step into 1473 the current function.

Step Over [Alt]+[F6] Step over 1472 the current function.

Step Out [Ctrl]+[F6] Step out 1473 of the current function.

Debug Stop [Ctrl] Stop 1471 the current debug session.

+[Alt]+[F6]

Start Debug Recording Start recording 1504 your trace for a debug session.

Stop Debug Recording Stop a debug recording 1504 .

Auto Record Thread Autorecord 1504 your debug session. The Stack Trace History, Stack tab and
Source Code Editor dynamically update to reflect the current execution sequence
for the thread; Stack Trace Recording ends when the thread ends or when you
click on the Stop button.

Show/Hide Execution Display the executing code when a thread has encountered a breakpoint. The
option presents the source code file in an editor window with the current line of
code highlighted for the thread that has the current focus.

Create Sequence Create a Sequence diagram 1507 from the Stack Trace History.
Diagram

2.4.4.4.4 Database Engineering Submenu

Select the Project | Database Engineering menu option.

Menu Option Use to

Import DB Schema from Import a database schema from an ODBC 1363 data source.
ODBC

Generate Package DDL Generate a Package DDL 1369 script to create the tables in the currently
selected package.

2.4.4.4.5 Transformations Submenu

Select the Project | Transformations menu option.

Menu Option & Function Keys Use to

Transform Selected Elements Perform an MDA-style transformation to the currently selected elements
[Ctrl]+[H] 1387 .

Transform Current Package Perform an MDA-style transformation to the currently selected package
[Ctrl]+[Shift]+[H] 1387 .

© 1998-2010 Sparx Systems Pty Ltd

 64 Getting Started | User Interface Guide

2.4.4.4.6 Model Validation Submenu

Select the Project | Model Validation menu option.

Menu Option & Function Keys Use to

Validate Selected [Ctrl]+[Alt] Validate 1528 a selected element, diagram or package from the Project
+[V] Browser.

Cancel Validation Cancel the validation process.

Configure Configure the Validation 1530 rules from the list of available rules.

2.4.4.4.7 Web Services Submenu

Select the Project | Web Services menu option.

Menu Option Use to

Import WSDL Reverse engineer 1376 a Web Service Definition Language (WSDL) file as a UML Class
model.

Generate WSDL Forward 1379 engineer a UML Class model to a WSDL file.

2.4.4.4.8 XML Schema Submenu

Select the Project | XML Schema menu option.

Menu Option Use to

Import XML Schema Reverse 1373 engineer a W3C XML Schema (XSD) file as a UML Class model.

Generate XML Schema Forward 1376 engineer a UML Class model to a W3C XML Schema (XSD) file.

2.4.4.4.9 Security Submenu

To configure security settings for your project, select the Project | Security menu option.

Note:
This feature is available in the Corporate, Business and Software Engineering, Systems Engineering and
Ultimate editions.

Menu Option & Function Use to

Keys

Manage Users Add, modify and remove users 191 , including maintaining permissions.

Manage Groups Add, modify and remove security groups 197 , including maintaining
permissions.

Manage Locks View and manage element locks 200 .

Change Password Change current security password 202 .

Login as Another User Switch the login to a different user ID.

My Locks [Ctrl]+[Shift]+[L] View and delete your own locks 207 .

Enable Security Enable or disable user security 189 to limit access to update functions in the
model.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 65

Menu Option & Function Use to

Keys

Require User Lock to Edit Toggle the security policy 190 in force.

Encrypt Password Add encryption 200 to your password (prior to Enterprise Architect Release
7.1).

2.4.4.4.10 Version Control Submenu

Select the Project | Version Control menu option.

Menu Option & Use to

Function Keys

Configure Current Specify whether this package 259 (and its children) is controlled and, if so, which
Package file it is controlled through.
[Ctrl]+[Alt]+[P]

Version Control Specify the options 234 required to connect to a Source Code Control (SCC)
Settings provider.

Validate Configurations Validate the version control configuration 260 of each package in the model.

Work Offline Toggle between 'offline' version control 268 and online version control.

2.4.4.4.11 Import/Export Submenu

To perform import and export to XMI and CSV, select the Project | Import/Export menu options.

Menu Option & Function Keys Use to

Import Package from XMI Import a package 290 from an XMI (XML based) file.
[Ctrl]+[Alt]+[I]

Export Package to XMI Export 289 the currently selected package to an XMI (XML based) file.
[Ctrl]+[Alt]+[E]

CSV Import/Export Import 305 or Export 303 information on Enterprise Architect elements in
[Ctrl]+[Alt]+[C] CSV format.

CSV Import/Export Set up CSV import Export Specifications 300 .

Specifications

Batch XMI Export Export a group 298 of controlled packages in one action.

Batch XMI Import Run a batch import 298 of multiple packages.

2.4.4.5 Diagram
The Diagram menu enables you to save diagram images to file as well as configure diagram properties and
options.

Menu Option & Function Use to

Keys

Properties [F5] View and edit the <type> Diagram: <name> dialog for the current diagram.

Layout Diagram Automatically layout 471 the current diagram (not available for Behavioral
diagrams).

Lock Diagram Prevent the diagram from being edited, or release the locked diagram for

© 1998-2010 Sparx Systems Pty Ltd

 66 Getting Started | User Interface Guide

Menu Option & Function Use to

Keys

editing.

Note:
This does not apply in the Corporate, Business and Software Engineering,
Systems Engineering and Ultimate editions if security is enabled. In that
case, see Lock Model Elements 204 .

Save [Ctrl]+[S] Save the current position of all diagram elements.

Save Image [Ctrl]+[T] Save the diagram as a bitmap file (.BMP), Graphics Interchange Format file (.
GIF) or Windows Metafile (.WMF).

Copy Image [Ctrl]+[B] Copy an image of the current diagram to the clipboard. The image can be in
metafile or bitmap format; you set the format on the Options 351 dialog.

Save UML Pattern Save the current diagram as a UML pattern 902 .

Swimlanes and Matrix Add, modify and delete swimlanes 450 or the swimlanes matrix 444 for the
current diagram.

Visible Relations [Ctrl] Hide or show individual connectors 619 for the current diagram.
+[Shift]+[I]

Property Note Display the properties note 440 for the current diagram on screen.

Sequence Messages Change 880 the order of the communication messages 879 in the current
diagram.

Find in Project Browser Locate the current diagram in the Project Browser window.
[Shift]+[Alt]+[G]

Make User Default (Use in the Corporate, Business and Software Engineering, Systems
Engineering and Ultimate editions of Enterprise Architect, if security is
enabled.)
Make the current diagram the default diagram opened when you re-open this
model. The User Default diagram overrides the Model Default diagram (see
Make Model Default, below).
To cancel a User Default diagram, either:
· Create a dummy diagram, set it as the User Default and delete it, or
· Delete the original diagram (if it is no longer relevant).
This still blocks the Model Default diagram, whilst Security is enabled. To re-
establish the Model Default diagram, set it as the User Default.

Make Model Default Make the current diagram the default diagram 437 opened when the current
model is re-opened (unless you set a User Default diagram, which overrides
the model default; see above).
To cancel a Model Default diagram, either:
· Create a dummy diagram, set it as the Model Default and delete it, or
· Delete the original diagram (if it is no longer relevant).
Change Type Change the type 434 of the current diagram.

Repeat Last Element Create an instance of the same type as the last element created.
[Shift]+[F3]

Repeat Last Connector Create an instance of the same type as the last connector created.
[F3]

Enterprise Architect User Guide

 Getting Started | User Interface Guide 67

Menu Option & Function Use to

Keys

Show Grid Show or hide the diagram grid

Snap To Grid Position elements on the diagram grid. There are two options:
· Standard Grid - constrains elements to the grid when they are added to
diagrams
· Smart Placement - places elements even distances away from other
elements and spaces elements evenly.
If neither of these options are enabled, the elements can be placed freely on
the diagram.

Zoom Change the zoom 453 factor on the current diagram.

2.4.4.6 Element
You can configure and access element details using the Element menu. This enables you to control element
layout, generate documentation and manage project resources.

Menu Option & Function Keys Use to

Properties [Alt]+[Enter] View the Properties 481 dialog of the selected element.

Add Tagged Value [Ctrl] Add a Tagged Value 634 to the currently selected element.
+[Shift]+[T]

Linked Document [Ctrl]+[Alt] Link the element 599 to a rich text document.
+[D]

Attributes [F9] View and edit the attributes 560 for the selected element.

Operations [F10] View and edit the operations 570 (methods) for the selected element.

Inline Features See the element Inline Features Submenu 68 .

Feature Visibility [Ctrl]+[Shift] Select which features and characteristics of the selected element are
+[Y] visible 438 on a diagram.

Advanced See the element Advanced Submenu 68 .

Rich Text Format (RTF) Report Generate a report for the currently selected package in rich text format
1569 .

Source Code Engineering See the element Source Code Engineering Submenu 69 .

Open Source in External Open the source code of the selected Class in the default external editor
Editor [F12] for that language. (Source code must have been generated 1308 , and the
selected element must be a Class.)

Find in Project Browser [Alt] Find the currently selected element in the Project Browser window. (If no
+[G] element is selected, finds the current diagram in the Project Browser
window.)

Find in Diagrams [Ctrl]+[U] Display all occurrences of the currently selected element.

Custom References [Ctrl]+[J] Show model element cross references 527 .

Appearance See the element Appearance Submenu 69 .

Alignment

Make Same
See the element Position Submenus 70 .

© 1998-2010 Sparx Systems Pty Ltd

 68 Getting Started | User Interface Guide

Menu Option & Function Keys Use to

Z Order

Size

Move

Space Evenly

2.4.4.6.1 Inline Features Submenu

The Inline Features sub-menu provides various options to directly edit Class diagram model elements from
the Class diagram. Select the Element | Inline Features menu option to access this submenu.

Menu Option & Function Use to

Keys

Edit Selected [F2] Attach a note or attach a constraint to the element.

View Properties Open the dialog containing details of the selected element feature, or the
element if no feature is selected.

Insert New After Selected Insert a new item in the element.

Create Linked Note Add a Note element linked to the selected item, reflecting the content of that
item.

Add Attribute [Ctrl]+[Shift] Add an attribute 558 to the element.

+[F9]

Add Operation [Ctrl]+[Shift] Add an operation 569 to the element.

+[F10]

Add Other [Ctrl]+[F11] Insert a feature on the specific element item, such as Maintenance features
and Testing features.

Delete Selected from Model Delete the selected item from the model.
[Ctrl]+[Shift]+[Delete]

Other options that are available while in editing elements mode in a diagram (when an attribute or operation is
highlighted) include:

Key Use to

[Enter] Accept current changes.

[Ctrl]+[Enter] Accept current changes and open a new slot to add a new item.

[Esc] Abort edit, without save.

[Shift]+[F10] Display the context menu for in-place editing.

[Ctrl]+[L] Invoke the Set Element Classifier dialog.

2.4.4.6.2 Advanced Submenu

The Advanced sub-menu provides various options to choose from to customize the appearance of model
elements. Select the Element | Advanced menu option to display this submenu.

Menu Option & Function Keys Use to

Overrides & Implementations Automatically override 578 methods from parent Classes and from

Enterprise Architect User Guide

 Getting Started | User Interface Guide 69

Menu Option & Function Keys Use to

[Ctrl]+[Shift]+[O] realized interfaces.

Set Parents and Interfaces [Ctrl] Manually set the element's parents or an interface 526 that it realizes.
+[I]

Embedded Elements [Ctrl] Attach elements 553 to the currently selected element.
+[Shift]+[B]

Change Type Change the element type 532 of the selected element.

2.4.4.6.3 Source Code Engineering Submenu

To forward and reverse engineer code using the language of your choice, select the Element | Source Code
Engineering menu option.

Menu Option & Function Keys Use to

Generate Current Element [F11] Generate source code 1309 for the currently selected element.

Synchronize Current Element Synchronize the selected Class with the source code.
[F7]

Batch Generate Selected Batch generate source code for the currently selected element(s).
Element(s)
[Shift]+[F11]

Batch Synchronize Selected Batch synchronize the currently selected element(s) with source code.
Element(s)
[Ctrl]+[R]

Open Source Directory Open the directory containing the source for this element.
[Ctrl]+[Alt]+[Y]

2.4.4.6.4 Appearance Submenu

The Appearance sub-menu provides various options to choose from to customize the appearance of model
elements.

Menu Option & Function Use to

Keys

Autosize [Alt]+[Z] Auto-size a group of elements in a diagram to a best fit.

Default Appearance Set border, font and background color and border thickness for the selected
[Ctrl]+[Shift]+[E] element, as its default appearance 538 .

Alternate Image Select an alternative image for the selected element.

[Ctrl]+[Shift]+[W]

Apply Image From Insert the image currently held on the clipboard.
Clipboard

Set Font Change the font 556 of the text displayed on the element in a diagram.

© 1998-2010 Sparx Systems Pty Ltd

 70 Getting Started | User Interface Guide

2.4.4.6.5 Position Submenus

These Element menu submenus enable you to size and position elements on the diagram, relative to each
other.

The Alignment Sub-Menu

Use the Alignment sub-menu to align the selected element(s) to each other.

Menu Option &Function Keys Use to

Left [Ctrl]+[Alt]+[Left] Align left edges of elements.

Right [Ctrl]+[Alt]+[Right] Align right edges of elements.

Top [Ctrl]+[Alt]+[Up] Align top edges of elements.

Bottom [Ctrl]+[Alt]+[Down] Align bottom edges of elements.

Centers Align centers of elements, horizontally or vertically.

The Make Same Sub-Menu

Use the Make Same sub-menu to make the selected elements the same width, the same height or both.

The Z Order Sub-Menu

Use the Z Order sub-menu to move the selected element(s) back, forward, to the front of all other elements or
behind all other elements.

The Size Sub-Menu

Use the Size sub-menu to make the selected element(s) wider, narrower, taller or shorter by one increment.
Alternatively, press [Ctrl]+["], [!], [#] or [$].

The Move Sub-Menu

Use the Move sub-menu to move the selected element(s) left, right, up or down by one increment.
Alternatively, press [Shift]+["], [!], [#] or [$].

The Space Evenly Sub-Menu

Use the Space sub-menu to distribute the selected elements evenly.

Menu Option & Function Keys Use to

Across [Alt]+[-] Space elements evenly, horizontally.

Down [Alt]+[=] Space elements evenly, vertically.

2.4.4.7 Tools
The Tools menu provides access to various tools including those related to code engineering, managing .EAP
files, spelling options, external resources and customization of features such as configuring shortcuts.

Menu Option & Function Use to

Keys

Spell Check Project [Ctrl] Spell check 1552 the current project.
+[F7]

Spell Check Current Spell check 1552 the current package.

Package

Enterprise Architect User Guide

 Getting Started | User Interface Guide 71

Menu Option & Function Use to

Keys

[Ctrl]+[Shift]+[F7]

Spelling Language Select a language 1554 other than English in which to perform the spell check
(having downloaded the language dictionaries from the Sparx Systems
website).

Data Management Manage your project's data 71 .

Manage .EAP File Repair, compact or replicate 71 your .EAP file.

Run Patch Execute an SQL patch 346 .

Export Reference Data Export reference data 223 to XML files for convenient model updating.

Import Reference Data Import reference data 225 from XML files for convenient model updating.

Import Technology Import 1071 an MDG Technology file. (This method no longer recommended.)

Generate MDG Display the MDG Technology Wizard 1118 .

Technology File

Wordpad Open Wordpad.

Windows Explorer Open Windows Explorer. (Different options might be listed, to open other
applications.)

Customize Customize 90 the operation of Enterprise Architect.

Options [Ctrl]+[F9] Customize your general settings through the Options 351 dialog 351 .

2.4.4.7.1 Data Management Submenu

Use the options on the Data Management submenu to manage your project's data.

Menu Option & Function Keys Use to

Project Transfer Move a complete project 306 from one repository to another.

Note:
You cannot move a project from a source .EAP file of a version earlier
than 3.5.0.

Project Compare Compare 308 the total project sizes of two projects.

Project Integrity Check Check the data integrity 344 of a project.

[Shift]+[F9]

2.4.4.7.2 Manage .EAP File Submenu

Use the options on this submenu to repair, compact or replicate your .EAP file.

Menu Option Use to

Repair .EAP File Repair 348 an Enterprise Architect project. If a project has not been closed properly,
in rare cases it might not open correctly. This option attempts to repair such
projects.

© 1998-2010 Sparx Systems Pty Ltd

 72 Getting Started | User Interface Guide

Menu Option Use to

Note:
All users must be logged off the project while it is being repaired.

Compact .EAP File Compact 348 an Enterprise Architect project. Eventually projects might benefit from
compacting to conserve space.

Note:
Ensure everyone is logged off the target project, then select this option to compact
the project.

Make Design Master Make a design master 185 project; this is the master project for creating replicas.

Create New Replica Create a new replica 184 from the Design Master 185 .

Synchronize Copy changes 186 from one replica set member to another.
Replicas

Remove Replication Remove 186 all replication features if you no longer require a model to be replicable.

Resolve Replication Resolve any conflicts 187 caused when multiple users have changed the same
Conflicts element between synchronization points.

2.4.4.8 Addins
The Add-Ins menu enables you to connect to, display information on, work with and manage your Add-Ins.
The option displays only after you have installed an Add-In on your system.

Menu Option Use to

Connect External List external Add-Ins and, when you select one of them, open a project list for the Add-
Project in. If there is only one active project available, the Add-In might automatically go on to
open that project.

<Add-In Name> Access the Add-In submenu 72 for the selected Add-In.

Manage Add-Ins Display the Manage Add-Ins 1781 dialog, which you use to enable or disable Add-Ins for
use.
Any technology loaded by an Add-In is automatically enabled; if you do not want to
use it, you can disable it on the dialog.

Add-In Submenu
Menu Option Use to

<Add-In specific List options to perform various functions specific to the Add-In. For example, the MDG
options> Technology For Zachman Framework, as an Add-In, has the options Open Example
Model and Insert New Framework Model.

Help Display the Help subsystem for the Add-In.

About Display information on the Add-In installation, such as version, registration details and
copyright statement.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 73

2.4.4.9 Settings
The Settings menu enables you to configure various settings for your overall project.
Configure: the resources involved, general types, maintenance types, metrics and estimation types,
stereotypes, Tagged Values, cardinality values, datatypes, language macros, local directories, image
management, CSV import and export specifications, and reference data export/import.

Menu Option & Use to

Function Keys

People Display the People 645 dialog, which enables you to configure the authors,
clients, resources and roles for your project.

General Types Display the General Types 653 dialog, which enables you to configure
requirements, status types, constraints and scenarios for your project.

Maintenance Display the Maintenance 660 dialog, which enables you to track problem types
and test types.

Project Indicators Define the project indicators (risks 322 , efforts 319 and metrics 320 ) used in
Resource Management 313 .

Estimation Factors Display the Estimation factors dialog, which enables you to configure estimation
335 factor types (Technical Complexity Factors 336 , Environmental Complexity
Factors 337 , and Default Hour Rate 340 ) for your project.

UML Configure stereotypes 662 , Tagged Value Types 664 and the cardinality list 665 for
your project.

MDG Technologies Display the MDG Technologies 1069 dialog, which enables you to load in and use
MDG Technology files.

Namespaces Locate and delete model namespaces 1313 .

Template Package Configure or change the default element template directory.

Local Paths Configure local directories and paths 1343 .

Auto Name Counters Configure automatic naming 525 for elements.

Code Datatypes Add, modify and delete programming languages datatypes 666 .

Database Datatypes Add, modify and delete database datatypes 1037 .

Preprocessor Macros Add and delete preprocessor macros 1344 .

Code Generation Modify code generation templates using the Code Templates Editor 1301 .
Templates
[Ctrl]+[Shift]+[P]

Transformation Modify transformation templates using the Transformation Templates Editor 1412 .
Templates
[Ctrl]+[Alt]+[H]

Images Open the Image Manager 447 .

Colors Configure the custom colors for the project. There are two options:
· Get Project Custom Colors - get the custom colors
· Set Project Custom Colors - set the custom colors
Custom colors are as used in the Appearance 538 dialog.

© 1998-2010 Sparx Systems Pty Ltd

 74 Getting Started | User Interface Guide

2.4.4.10 Window
The Window menu provides access to various actions related to configuring open windows.

Menu Option & Function Use to

Keys

Full Screen Reset the display to full screen so that only the work area and main menu
are shown - no toolbars or windows.
To return to your normal working display, either click on the Full Screen
option again or click on the Close Full Screen pop-up menu option.
You can also restore individual menus and toolbars using the View menu
options.

Close Active Window Close the window that currently has focus.
[Ctrl]+[F4]

Autohide Active Window Autohide 78 the window that currently has focus.
[Ctrl]+[Shift]+[F4]

Autohide All Docked Autohide 78 all windows that are docked.

Windows

Close Current View Close the current view.

Close All Except Current Close all except the currently selected view.

Reload Current View Refresh the current view 267 .

Save All Modified Save all modified data.

Close All Close all opened windows in the main tab view.

Always on Top Force the main Enterprise Architect window to be on top of all other
windows.

Set Focus to Current View Make the current view the active one, so that key strokes immediately act
[Ctrl]+[Shift]+[0] on that view.

2.4.4.11 Help
The Help menu provides access to the Enterprise Architect help files, the Read Me file, the Enterprise
Architect End User License Agreement and various features on the Sparx Systems website.

Menu Option Use to

About EA View information about Enterprise Architect, including your registration

details.

Register and Manage License Configure and manage the license keys used to register the name and
Key(s) keys for Enterprise Architect and its Add-Ins. For more information see
the License Management 1867 topic.

Read Me View the Readme.txt file, which details the changes and enhancements in
Enterprise Architect, build by build.

Open Example Model Open the EA.Example model provided with the Enterprise Architect
installer.

View License Agreement View the Enterprise Architect End User License Agreement.

Ordering Information View information on how to purchase Enterprise Architect.

Help Contents Display the introductory page of the Enterprise Architect Help.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 75

Menu Option Use to

Keyboard Accelerator Map View the keyboard accelerator map. You can customize your keyboard
shortcuts 98 , if required.

On-Line Resources See below.

Enterprise Architect on the Visit the Sparx Systems website.

Web

The On-Line Resources Sub-Menu

Access help and resources on-line at the Sparx Systems website.

Menu Option Use to

User Forum and News Visit the Enterprise Architect user forum.

Request-a-Feature Request a feature you would like to see in Enterprise Architect.

Bug Report Page Report the details of a bug you have found in Enterprise Architect.

Latest Version Details Display the Announcements folder of the user forum, providing details of
the latest Enterprise Architect build.

Automation Interface Access the Enterprise Architect Automation Interface pages on the Sparx
Systems website.

Introducing UML Access the Sparx Systems online UML tutorials.

Pricing and Purchase Options Purchase or upgrade Enterprise Architect over the internet.

2.4.5 Standard Windows

There are many dockable 76 windows available to use in Enterprise Architect. These can be accessed either:
· Through the View menu, or
· Through the context menu accessed by right-clicking on the main menu.
Having displayed a window, you can also reduce it to a tab off to one side, or autohide 78 it.
The dockable windows available include:
· Project Browser 1209
· Properties 508
· System 323
· Testing 1537
· Maintenance 1558
· Toolbox 399
· Resources 667
· Source Code Viewer 1441
· Scripter window 1660
· Debug 1471
· Tasks Pane 51
· Notes 641
· Traceability 1253
· Tagged Values 632
· Project Management 312
· Model Views 1222
· Element Browser 510
· Relationships 1269
· Scenarios & Requirements 514

© 1998-2010 Sparx Systems Pty Ltd

 76 Getting Started | User Interface Guide

· Pan & Zoom 1275

· Layout Tools 458
· Team Review 208
· Diagram Filters 1271 .

Tip:
If the text in a window panel is too small to read comfortably, click on it, press and hold [Ctrl] and use the
mouse wheel to expand and reduce the text size.

Note:
On the Testing, Maintenance and Project Management windows, any descriptive, history, input or results text
for a selected item is also displayed in the Notes window. You cannot edit this text in the Notes window.

2.4.5.1 Dock Windows

A number of Enterprise Architect windows can be freely positioned on the screen, or docked against any edge
of the application workspace. These windows are collectively called dockable windows 75 .
Drag the window around the application workspace until you find a comfortable way of working. The examples
below describe a few ways you can rearrange the windows to suit your work habits.

Floating Windows
To float a window anywhere on the screen, just drag the window by its title bar to the required position.

Dock a Window Against an Edge

The navigation compass enables you to dock windows against an edge of the application workspace. You
drag the window over one of the points of the compass to dock it into a tabbed location. The window does not
overlap any other window, so if you are docking several windows you could cover the workspace; however,
you can avoid this by combining them in a single tabbed frame 77 .
To dock a window against an edge, follow the steps below:
1. Click on the item to move and start dragging it towards the required position. This activates the
navigation compass.

2. Drag the window onto a compass point. The screen display shades the area where the window is to be
placed.
3. Release the mouse button over the compass point to confirm the position; this docks the window.

In the example below, when the mouse button is released the Model Views window is docked into the shaded
area.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 77

Dock Required Windows into One Frame

You can also dock all of the windows you are using into a single frame, by either:
· Dragging the title bar of each window up to the title bar of the first docked window, or
· Dragging each window over the 'tabbed frame' icon in the middle of the compass, when another window is
already docked.

© 1998-2010 Sparx Systems Pty Ltd

 78 Getting Started | User Interface Guide

You can do this with all dockable windows. The following example shows the Testing, Project Browser,
Resources, Model Views and Tagged Values windows all in one frame.

To separate a window from a combined frame, click on the window tab at the bottom of the frame and drag it
away.

2.4.5.2 Autohide Windows

Autohide Using the Toggle Button

You can automatically hide browser frames by clicking on the button, located in the top right corner of the
frame.

To turn off the autohide for a particular set of windows within a frame, click on the button.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 79

Use Automatically Hidden Windows

When you automatically hide a set of windows in a frame, the tabs contract to the outside of the application
workspace.

Hover the cursor over a window symbol to expand both the tab and the associated window.

Tip:
You can also use the View | Visual Style | Animate Autohide Windows menu option to animate windows
that have been automatically hidden.

2.4.6 Standard Toolbars

Enterprise Architect provides you with a selection of toolbars that you can drag and dock within the application
frame.
These toolbars provide convenient shortcuts to common tasks. You can also float toolbars over the application
by dragging them off the application toolbar section; this is useful when you are using a certain set of functions
a lot in a particular area.
You can customize toolbars by deleting and reordering the default button set. See Customize Commands 91
for more information. You can customize which toolbars are active by right-clicking on the toolbar background
and selecting the required items at the end of the context menu.

Note:
You can dock toolbars to the edge of the Enterprise Architect workspace by dragging them by the title bar
and placing them against the appropriate edge. The example below shows the Default Tools toolbar docked
to the left side of the workspace:

© 1998-2010 Sparx Systems Pty Ltd

 80 Getting Started | User Interface Guide

The toolbars available include:

· Default Tools Toolbar 80
· Project Toolbar 81
· Code Generation Toolbar 81
· UML Elements Toolbar 83
· Diagram Toolbar 83
· Current Element Toolbar 84
· Current Connector Toolbar 84
· Format Toolbar 85
· Workspace Layouts Toolbar 86
· Status Bar 89
· Notes Toolbar 642

Each toolbar has a drop-down arrow at the right-hand end, , which can be enabled or hidden 60 . If you
click on this drop-down arrow, the Add or Remove Buttons option displays. Select this option to show a
context menu listing the toolbars that are currently displayed, and an option to customize 90 both your own
toolbars and the system-provided toolbars.
You can select one of the toolbars identified on the context menu to list the icons available through that
toolbar. Click on the icons as necessary to hide or show them in the toolbar.

2.4.6.1 Default Tools Toolbar

The Default Tools toolbar provides quick access to the following functions (in order):

Enterprise Architect User Guide

 Getting Started | User Interface Guide 81

· New project [Ctrl]+[N]

· Open a project [Ctrl]+[O] - click on the folder icon to display the Open Project 114 dialog, which enables
you to open files or connect to a server, or click on the drop-down arrow to display a list of recently-opened
projects and select one of those
· Save current diagram [Ctrl]+[S]
· Cut selected element(s) from diagram [Ctrl]+[X] (the element is not removed from the source diagram until
it is pasted from the clipboard into another diagram)
· Copy to Enterprise Architect clipboard [Ctrl]+[Space]
· Paste from Enterprise Architect clipboard as instance [Shift]+[Insert]
· Undo last action [Ctrl]+[Z]
· Redo last undone action [Ctrl]+[Y]
· Print Preview (for generated documents and diagrams)
· Page setup
· Print [Ctrl]+[O]
· Show Element List for currently-selected package or diagram [Ctrl]+[Alt]+[R]
· Open Model Search [Ctrl]+[Alt]+[A]
· Select the layout of docked windows, toolbars and the Toolbox (<default> is Enterprise Architect, other
options display for any MDG Technologies 1069 you have enabled)
· Help [F1].
You can move this toolbar to any dockable position and it retains that position in subsequent sessions. You
can hide or show the toolbar by clicking on the View | Toolbars | Default Tools menu option.

2.4.6.2 Project Toolbar

The Project toolbar provides quick access to the following functions (in order):
· Reload current project 267 [Ctrl]+[Shift]+[F11]
· New diagram
· New package [Ctrl]+[W]
· New element [Ctrl]+[M]
· Search Project Browser window [Ctrl]+[Shift]+[F]
· Search entire project, using Model Search 1233 [Ctrl]+[F]
· New RTF document [F8]
· Project issues
· Project glossary
· Options (preferences) [Ctrl]+[F9]
You can move this toolbar to any dockable position and it retains that position in subsequent sessions. You
can hide or show the toolbar by clicking on the View | Toolbars | Project menu option.

2.4.6.3 Code Generation Toolbar

The Code Generation toolbar provides quick access to the following functions (in order):
· Set the default language
· Set the default database
· Import Classes and Interfaces from source files (see menu below)
· Generate code for a single selected Class [F11]

© 1998-2010 Sparx Systems Pty Ltd

 82 Getting Started | User Interface Guide

· Batch generate code for one or more selected Classes [Shift]+[F11]

· Synchronize selected Classes with source code [F7]
· View code 1441 in default editor [F12].

Set Default Code Language

To set the default language for the model click on the Default Language drop-down arrow and select the
appropriate language.

Set Default Database

To set the default database type for modeling click on the Default Database drop-down arrow and select the
appropriate database type.

Import Code
To select a language for code generation, click on the drop-down arrow for the Import button.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 83

You can move this toolbar to any dockable position and it retains that position in subsequent sessions. You
can hide or show the toolbar by clicking on the View | Toolbars | Code Generation menu option.

2.4.6.4 UML Elements Toolbar

The UML Elements toolbar provides quick access to the following functions (in order):
· Insert new element - displays a list of elements 523 matching the content of the current Toolbox pages, with
an Other option to list other elements
· Insert new System Boundary 802 element
· Insert new Note 536
· Insert new Text element 536
· Insert new diagram note 440
· Insert diagram Legend 441
· Insert new hyperlink 840
· Insert new note link 886 .
You can move this toolbar to any dockable position and it retains that position in subsequent sessions. You
can hide or show the toolbar by clicking on the View | Toolbars | UML Elements menu option.
The specific elements and the Notelink connector are also available in the Common 405 page of the Toolbox.

2.4.6.5 Diagram Toolbar

The Diagram toolbar provides quick access to the following functions (in order):
· Align selected elements to the left [Ctrl]+[Alt]+[!]
· Align selected elements to the right [Ctrl]+[Alt]+["]
· Align selected elements to the top [Ctrl]+[Alt]+[#]

© 1998-2010 Sparx Systems Pty Ltd

 84 Getting Started | User Interface Guide

· Align selected elements to the bottom [Ctrl]+[Alt]+[$]

· Bring selected element to top of Z order
· Move selected element to bottom of Z order
· Go to previous diagram [Alt]+[!]
· Go to next diagram [Alt]+["]
· Go to default diagram
· Zoom In
· Zoom Out
· Zoom to fit diagram
· Zoom to fit page
· Zoom to 100%
· Auto-layout diagram (not for Behavioral diagrams) in the Digraph 465 layout
· Show diagram properties [F5]
· Paste appearance as copied into the Painter from an element's Appearance 555 context menu
· Delete selected element(s) [Ctrl]+[D]
Any actions that result in a change in diagram content and appearance (including Zoom) can be saved as
changes to the diagram.
You can move this toolbar to any dockable position and it retains that position in subsequent sessions. You
can hide or show the toolbar by clicking on the View | Toolbars | Diagram menu option.

2.4.6.6 Current Element Toolbar

The Current Element toolbar provides quick access to the following functions (in order):
· View and modify element properties [Alt]+[Enter]
· Set an element's parent or implement interfaces [Ctrl]+[I]
· View and modify Operations [F10]
· View and modify Attributes [F9]
· Specify the visibility of element features and compartments [Ctrl]+[Shift]+[Y]
· Specify the run state of an element (or, for Parts, property value) [Ctrl]+[Shift]+[R]
· View use of element in other structures such as diagrams [Ctrl]+[U]
· Locate the element in the Project Browser window [Alt]+[G]
· View the cross reference list for this element [Ctrl]+[J]
· Lock or unlock the current element
Note:
This does not apply in the Corporate, Business and Software Engineering, Systems Engineering and
Ultimate editions if security is enabled. In that case, see the Lock Model Elements 204 topic.

· Add a Tagged Value to the current element [Ctrl]+[Shift]+[T]

You can move this toolbar to any dockable position and it retains that position in subsequent sessions. You
can hide or show the toolbar by clicking on the View | Toolbars | Current Element menu option.

2.4.6.7 Current Connector Toolbar

The Current Connector toolbar provides quick access to the following functions (in order):
· View and modify properties for the current connector
Enterprise Architect User Guide
 Getting Started | User Interface Guide 85

· Set the connector line style

· Attach a note to the currently selected connector

· Set the visibility for labels of the connector
· Set the visible or hidden relations in the current diagram [Ctrl]+[Shift]+[I]
· Reverse the direction of the currently selected connector
· Pin the start and/or connector ends to a position on the target element (drop menu).

You can move this toolbar to any dockable position and it retains that position in subsequent sessions. You
can hide or show the toolbar by clicking on the View | Toolbars | Current Connector menu option.

2.4.6.8 Format Toolbar

Use the Format toolbar to change the appearance of a selected element (or several selected elements) in the
current diagram; this does not affect any other occurrence of the selected elements anywhere else in the
model.

Notes:
· To set the global appearance of all elements throughout a model, use the Options dialog. Select the Tools
| Options menu option, then select Standard Colors 353 and Diagram | Appearance 356 from the options
tree.
· To override the global appearance and define a default appearance of a selected element (or several
selected elements) on all diagrams on which it occurs, right-click on the element and select the
Appearance | Default Appearance context menu option. The Default Appearance 538 dialog displays.

The Format toolbar provides quick access to the following functions (in order):
· Text font, style, size and effects, through the Font 556 dialog
· Text Color (drop-down color palette)
· Fill Color (drop-down color palette)
· Border or Connector Line Color (drop-down color palette)
· Border or Connector Line Width (arrows increase/decrease between 1 and 5)
· Apply Style to Element(s)
· Copy Style from Element
· Style list for selecting saved styles
· Save style (see below).
If you click on the drop-down arrow for the Save Style (pencil) button, you can select an option from the

© 1998-2010 Sparx Systems Pty Ltd

 86 Getting Started | User Interface Guide

following list:

The Fill Color button can be used in conjunction with the Project Custom Colors menu options to enable
users to have access to custom-defined project colors. To activate this feature select the Tools | Options |
Standard Colors menu option and ensure that the Show Project Custom Colors in Element Format
checkbox is selected. To define a set of custom colors see the Get and Set Project Colors 540 topic.
You can move this toolbar to any dockable position and it retains that position in subsequent sessions. You
can hide or show the toolbar by clicking on the View | Toolbars | Format Tool menu option.

2.4.6.9 Workspace Layouts

The Workspace Layouts toolbar provides a range of facilities for changing the content and layout of the
Enterprise Architect workspace.
You can move this toolbar to any dockable position and it retains that position in subsequent sessions. You
can hide or show the toolbar by clicking on the View | Toolbars | Workspace Layouts menu option.
The facilities on the toolbar, from left to right, are described in the following paragraphs.

Save Workspace Layout As

If you have manually created or adjusted an arrangement of windows and toolbars to suit your work
requirements, you can capture that layout for future use.
Click on the toolbar icon and, in the Custom Workspace Layout Name field at the bottom of the Save
Custom Workspace Layout dialog, type a name for the layout. Click on the Save button. The layout is added
to the Available Custom Workspace Layouts list.
You can also select an existing workspace layout from the list and save the new layout under the existing
name.

Manage Workspace Layouts

The Manage Workspace Layouts icon displays the Workspace Layout dialog, which lists the currently-
available user-defined and system layouts.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 87

In the Existing Workspace Layout panel at the bottom of the dialog, the Based On: field identifies the defined
layout that the current workspace layout was derived from - you might have moved or closed windows since
applying that layout. The highlighted (Copy of existing Workspace Layout) at the top of the Workspace Layout
dialog is a capture of the workspace layout immediately before you opened the dialog.

Change Layout
You can now change the layout in the Existing Workspace Layout panel to:
· The original layout (as identified by the Based On: field), discarding any changes you might have made
· The Copy of existing Workspace Layout, preparatory to saving the changes in a new named layout
· One of the other named layouts.
To change the layout in use, either:
· Double-click on the required layout name
· Click on the layout name and click on the Apply button or OK button, or
· Right-click on the layout name and select the Apply context menu option.
When the layout in use changes, the layout name in the toolbar Workplace Layout Selection field also
changes.

Copy Layout
To copy a layout (such as the one at the top of the list), either:
· Change the layout in use to the required layout (as above) and click on the Save As button, or
· Right-click on the layout name and select the Save As context menu option.
The Save Custom Workspace Layout dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 88 Getting Started | User Interface Guide

In the Custom Workspace Layout Name field, type a name for the layout. Again, by selecting an existing
name you can change an existing layout to something different. Click on the Save button.
If you already have tailored windows or views that you want to include in your selected layout, select the
Include active custom views checkbox.

Delete Layout
To delete a workspace layout, right-click on the layout name and select the Delete context menu option.
Enterprise Architect prompts you to confirm or cancel the deletion.

Workspace Layout Selection

Enterprise Architect provides a number of layouts of windows and toolbars to suit particular areas of work,
such as Requirements Management, Code Engineering and Debugging. As described above, you can also
add your own layouts to the drop-down list; these custom layout names have a preceding asterisk in the drop-
down list for the field (the system-provided layouts are not marked with an asterisk).
To switch to another layout, click on the drop-down arrow and click on the required layout.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 89

Note:
When you upgrade your system to a new edition of Enterprise Architect, the new edition might contain
window or toolbar layout changes made by Sparx Systems. These changes might impact your previously-
customized workspace layouts. In such cases, when you select each of your customized layouts in the
Selection field, the following prompt displays:

Click on the OK button to ensure that your customized layout contains the system upgrades.

Views
Clicking on the drop-down arrow for the Views icon lists options for displaying various views of information on
model content, such as the Element List 1255 , Model Search 1231 and Relationship Matrix 1261 . Click on the
appropriate option to display the required view screen.

Windows
Clicking on the drop-down arrow for the Windows icon lists options for opening each of the Enterprise
Architect windows (as on the View 58 menu options). Click on the appropriate option to open the required
window, or to transfer control to the window if it is already open.

Toolbars
Clicking on the drop-down arrow for the Toolbars icon lists options for opening or hiding each of the nine
Enterprise Architect main toolbars 79 and the diagram Status Bar 89 . Click on the appropriate option to hide
or display the required toolbar.

Full Screen
Click on this icon to switch the Enterprise Architect display to Full Screen 74 mode. A small dialog displays to
enable you to switch back to normal mode. Alternatively, click on the Window | Full Screen menu option.

2.4.6.10 Status Bar

The Status bar displays at the bottom of the Enterprise Architect workspace. It provides feedback on current
operations and other status information, and enables you to enlarge the scale of the diagram.

In particular the Status bar:

· Identifies the type and name of the currently selected element in a diagram (or the status of a Model
Search)
· Identifies the name of the currently-selected feature, if one is selected
· Provides the current coordinates of the top left corner of the selected element, and its width and height

© 1998-2010 Sparx Systems Pty Ltd

 90 Getting Started | User Interface Guide

· Provides a zoom slider that enables you to enlarge the scale of the current diagram by up to 50%
Note:
This facility has no impact on other users who might view the diagram. It has the same function as the
Scale view by field on the Diagram Appearance 356 page of the Options dialog; changes in the 'zoomed'
display scale of a diagram update this field and are applied to any other diagrams that you open.
This also has no impact any other diagram Zoom facility in Enterprise Architect.

· Indicates the status of [Caps Lock], [Num Lock], [ScrLk] (scroll lock) and the WAN Optimizer (bold
indicates 'in use', pale indicates 'off')
· Indicates, by the presence of a triangle in the bottom right corner, that the screen is not maximized; you
can drag the screen corner to increase the size of the window.
If you right-click on the Status bar, a context menu displays that enables you to hide or show the element
name, element coordinates, zoom slider or status indicators.
You can hide or show the Status bar from the View | Toolbars | Status Bar menu option, but you cannot dock
it in any other position.

2.4.7 Customization
You can configure various settings using the Options 350 dialog, which you display by selecting the Tools |
Options menu option. In addition, there are several options to change the overall look and feel of Enterprise
Architect 101 in the View | Visual Style submenu. Those settings and options are explored in this topic.
On occasion, you might want to use Enterprise Architect for two distinct types of operation at the same time.
You can do this by adding the following command line argument when you run Enterprise Architect:
/regkey:<regkeyname>
This stores registry settings - such as window layouts - to a different path in the registry.

See Also
· Workspace Layouts 86

2.4.7.1 The Customize Dialog

The Customize dialog enables you to customize Commands 91 , Toolbars 92 , Tools 94 , Keyboard
Keystrokes 98 , Menus 100 and Options 101 within Enterprise Architect. To display this dialog, either:
· Select the Tools | Customize 70 menu option, or
· At the far right of any toolbar 79 , click on the drop-down arrow (if it is enabled 60 ) and on the Add or
Remove buttons option, then select the Customize option.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 91

Note:
If a documented toolbar icon, keyboard combination or menu option does not appear to be available, select
the appropriate tab and click on the Reset or Reset All button. This restores the toolbar, menu or key
settings to the defaults.
However:
Be aware that this also removes any customized icons, options or combinations you might have set, because
it is possible that the customization itself has displaced or affected the default setting.

2.4.7.1.1 Customize Commands

The Customize dialog Commands tab provides access to many of Enterprise Architect's functions, enabling
you to place them into a toolbar.

To add a command to a toolbar, click on the category in the Categories: panel and select the command from
the list for that category in the Commands: panel. Drag the command on top of the toolbar to add it to.
If you right-click on the command icon in the toolbar while the Customize dialog is open, a context-sensitive
menu displays. This menu offers options for deleting commands from a toolbar, and for changing the
appearance of commands.

To remove a command from the toolbar, right-click on the command graphic or text and select the Delete
menu option.
To change the appearance of a command graphic, right-click on the command graphic or text and select the

© 1998-2010 Sparx Systems Pty Ltd

 92 Getting Started | User Interface Guide

Button Appearance context menu option. The Button Appearance dialog displays, which you can use to add
graphical icons to commands that do not have them by default.

Note:
Some commands do not come with a convenient icon, which results in an empty toolbar button. Either avoid
placing these commands on toolbars or use the context-sensitive menu to select an appropriate icon for the
command.

Tip:
Read the Create a New Toolbar and Populate it with Commands 92 procedure of the Customize Toolbars
topic.

2.4.7.1.2 Customize Toolbars

The Toolbars tab on the Customize dialog enables you to:
· Hide or show toolbars by selecting the appropriate checkbox
· Rename toolbars
· Create new toolbars
· Delete toolbars
· Modify toolbar contents by dragging commands from the Commands 91 tab onto a visible toolbar
· Reset a toolbar (or all toolbars) to the default contents and position, and
· Display text labels under the toolbar icons (perhaps temporarily, just to check what the icons do).

Create a New Toolbar and Populate it with Commands

To create a new toolbar and populate it with commands:
1. Select the Tools | Customize menu option. The Customize dialog displays.
2. Click on the Toolbars tab.
3. Click on the New button. The Toolbar Name dialog displays.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 93

4. In the Toolbar Name field, type a name for your new toolbar and click on the OK button. Your new
toolbar is created.

Note:
You can select the Show text labels checkbox to display textual descriptions of toolbar items.

5. Now add commands to your toolbar. Click on the Commands tab. This forces the new toolbar behind
the Customize dialog, so you might have to drag the Customize dialog to the side to find your new
toolbar.

© 1998-2010 Sparx Systems Pty Ltd

 94 Getting Started | User Interface Guide

7. Find the command to add to your toolbar in the Commands list. The Categories list on the left
represents the Enterprise Architect menu structure and the Commands list updates each time you click
on a different category.
8. Drag the selected command from the list into the new toolbar. If you selected the Show text labels
checkbox, your toolbar should now look like this:

If you did not select the Show text labels checkbox, your toolbar should look like this:

You can add as many commands to your toolbar as required. Your new toolbar behaves the same way as
other toolbars; you can position it next to the other toolbars at the top of the application workspace, dock it to
the side of the workspace or close it.

2.4.7.1.3 Custom Tools

The Tools tab on the Customize dialog provides a means of extending the power of the Enterprise Architect
desktop.
From this toolbar you can configure custom tools and make them accessible from the Main Menu. You can
create menu options that hyperlink to different applications, compilers, batch scripts, automation scripts, URLs
or documentation.

Add and Configure Custom Tools

1. Select the Tools | Customize menu option. The Customize dialog displays.
2. Click on the Tools tab.

3. Click on the New icon (left of the red X ). A blank field displays in the Menu contents list.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 95

4. Type in the name of the tool as it should appear in the menu.

5. In the Command field, type the name of the tool .exe file to use; the tool must be a valid filename.

Note:
Programs installed with your operating system (such as Notepad, Wordpad) do not require a full file
path. Programs installed separately (such as Microsoft Visual Studio) require the full file path in the
Command field. If necessary, use the [ ... ] (Browse) button to locate the tool in the file system.

6. Add any arguments required by the tool (see Opening External Tools 96 and Passing Parameters to
External Applications 97 ), and specify an initial directory if required.
7. Close the Customize dialog. Your tool should have now been added to the Tools menu as shown
below.

© 1998-2010 Sparx Systems Pty Ltd

 96 Getting Started | User Interface Guide

2.4.7.1.3.1 Open External Tools

When configuring custom tools in Enterprise Architect, you can specify a file to be opened by the external
application.
Select the Tools | Customize menu option. The Customize dialog displays; click on the Tools tab. Now you
can:
· Specify a custom tool 94 (application) using the Command field
· Define a file to open or parameters to pass 97 to this application, using the Arguments field.

Example 1
This example opens the file c:\Temp\Customer Account.cls using Wordpad. If you save from within Wordpad the
initial directory is c:\Temp.

Tip:
If there are any spaces in the paths in the Command, Arguments or Initial Directory fields, you must
enclose the whole path in double quotes. For example: "c:\Temp\Customer Account.cls" must have quotes but c:
\Temp\CustomerAccount.cls does not have to have quotes.

Example 2
This example opens the file c:\Temp\Customer Account.cls using VB. As VB is not installed with the operating
system, the whole file path for VB must be included in the Command field; you can select this using the [ ... ]
(Browse) button to locate the VB executable. If you save from within VB the initial directory is c:\Temp.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 97

2.4.7.1.3.2 Pass Parameters to Applications

When configuring custom tools in Enterprise Architect, you can pass parameters to the application.
Select the Tools | Customize menu option. The Customize dialog displays; click on the Tools tab. Now you
can:
· Specify a custom tool 94 (application) using the Command field
· Define a file to open 96 or parameters to pass to this application using the Arguments field.

The available parameters for passing information to external applications are:

© 1998-2010 Sparx Systems Pty Ltd

 98 Getting Started | User Interface Guide

Parameter Description Notes

$f Project Name For example, C:\projects\EAexample.eap.

$F Calling Application (Enterprise Architect) Enterprise Architect.

$p Current Package ID For example, 144.

$P Package GUID GUID for accessing this package.

$d Diagram ID ID for accessing associated diagram.

$D Diagram GUID GUID for accessing associated diagram.

$e Comma separated list of element IDs All elements selected in the current diagram.

$E Comma separated list of element GUIDs All elements selected in the current diagram.

Tip:
For more information on using the Automation Interface, visit www.sparxsystems.com/AutIntVB.htm.

2.4.7.1.4 Customize Keyboard

The Keyboard tab on the Customize dialog enables you to configure shortcuts used to access main menu
options. This is convenient for creating additional shortcut keys or for changing the current configuration to
match your work habits or other applications.

Modify Keyboard Shortcuts

To modify a keyboard shortcut, follow the steps below:
1. Select the Tools | Customize menu option. The Customize dialog displays.
2. Click on the Keyboard tab, and in the Category field click on the drop-down arrow and select the menu
containing the command to modify.
3. In the Command field, click on the drop-down arrow and select the command. The current shortcut key
(if any) for the command is displayed in the Current Keys field.
4. Move the cursor to the Press New Shortcut Key field and press the required shortcut key(s) for this

Enterprise Architect User Guide

 Getting Started | User Interface Guide 99

command.

Note:
Press the actual keys to use. For example, to use [F5] press the [F5] key, don't type F then 5.

Note:
In the example above, the Assign button is disabled. This is because [F5] is already a shortcut to view
diagram properties. If this occurs you must select a different shortcut key.

5. Once you have selected an available shortcut, click on the Assign button to apply the change. In the
example below, the new shortcut is [N].

© 1998-2010 Sparx Systems Pty Ltd

 100 Getting Started | User Interface Guide

6. This has added a new shortcut so that both [N] and [Ctrl]+[N] create a new Enterprise Architect project.

If you intend [N] to be the only shortcut for this action, select [Ctrl]+[N] in the Current Keys list and
click on the Remove button.

Tip:
Remember that you can always revert to the default shortcut keys by clicking on the Reset All button.

Note:
Modified shortcut keys are stored in the registry, so they only affect the current user.

2.4.7.1.5 Customize Menu

The Menu tab on the Customize dialog enables you to customize the appearance of your menus.

Application Frame Menus

Currently the Show Menus For feature is disabled as Enterprise Architect is not an MDI application.

Context Menus
Currently this feature is disabled.

Menu Animations
The following menu animations can be selected from the Menu animations drop-down list:

Menu Shadows
Menu shadows can be toggled on or off by selecting or clearing the Menu shadows checkbox.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 101

Remove Menu Options

Some menu options might not be of relevance to you. If you prefer not to display such options, follow the steps
below:
1. Whilst the Menu tab of the Customize dialog is displayed, click on the appropriate chain of options in
the main menu bar to display the option to delete.
2. Right-click on the option and select the Delete option from the context menu.

Note:
When you perform a major upgrade of Enterprise Architect (such as from release 7.1 to 8.0) the menus are
reset and deleted options are replaced.

2.4.7.1.6 Customize Options

The Options tab on the Customize dialog enables you to customize the appearance of toolbar items.

You can toggle the following options by selecting or clearing the checkboxes:
· Show Screen Tips on toolbars
· Show shortcut keys in Screen Tips
· Use Large Icons.

2.4.7.2 Visual Styles

You can configure the overall look and feel of Enterprise Architect to suit your working environment. Options
include various Microsoft Office and Visual Studio styles, or themes.
To reset the appearance of Enterprise Architect, follow the steps below:
1. Select the View | Visual Style | Select Visual Style menu option. The Application Look dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 102 Getting Started | User Interface Guide

2. Select the required style from the list. If you select the Microsoft Office 2007 radio button, you can also
select from a number of base-color options.
3. To try out styles, click on the Apply button. To set the style and resume work, click on the OK button.
You can also enable customization 100 of toolbars and menus, and animate auto-hidden 78 windows.

2.4.8 Other Windows

Most of the windows in Enterprise Architect have a specific, task oriented purpose. Two windows have broader
functions:
· The Output 102 window displays data that Enterprise Architect generates during each of a range of
processes
· The Web Browser 103 enables you to search for and use internet facilities within your Enterprise Architect
work area.

2.4.8.1 The Output Window

Access: View | System Output.
The Output window is used to display data that is either system generated or Add-In generated.
Examples of situations where Enterprise Architect generates items include:
· Validation Items
· Launch of external processes
· Command line output from Build and Test
· Parse errors generated during import
· (Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of Enterprise
Architect) In the Audit History 278 tab, a history of changes to any element or connector selected from the
Audit View, the Element List, the Project Browser or the current diagram (Auditing 270 must be turned on)
· Re-docking the Model Search 1231 results into the Output window.
You can drag suitable items out of the Output window and add them to diagrams.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 103

Double-click on model validation errors or parsing errors to display the source of the error.
You can also right-click on an item and select context menu options to:
· Copy the selected item to the clipboard
· Copy all items to the clipboard
· Save the output to an external file
· Clear the output from the window.
The Output window can also be used by Add-Ins 1776 , if they are configured to do so via the Automation
Interface 1666 .

2.4.8.2 The Web Browser

The Web Browser displays as a tab of the central work area, like the Start Page, Model Search, Element List
and Diagram View. It provides access within Enterprise Architect to internet facilities such as email, websites
and search engines.
To access the Web Browser:
· Press [Ctrl]+[Alt]+[W], or
· Select the View | Other Project Tools | Internal Web Browser menu option.
The Web Browser opens at the default home web site; you define the default home website, search engine
and email exchange address on the General page of the Options 351 dialog.

© 1998-2010 Sparx Systems Pty Ltd

 104 Getting Started | User Interface Guide

To access the:
· Email exchange server, click on the 'envelope' icon in the toolbar; the email login window displays
· Web search engine (such as Google), click on the 'spyglass' icon in the toolbar; the search engine screen
displays
· Home web site, after displaying other web pages, click on the 'house' icon in the toolbar.
To go directly to another website or email server (your internet security permitting), in the Address field type
or select the website http address and click on the Go button.

2.4.9 Keyboard Shortcuts

The table below lists the default keyboard shortcut functions within Enterprise Architect. You can also display
the key combinations on the Help Keyboard dialog (or Keyboard Accelerator Map 108 ).
There are some additional shortcuts using the keyboard and mouse in combination; see the Keyboard-Mouse
Shortcuts 109 topic.
If necessary, you can change these keyboard shortcuts using the Keyboard tab of the Customize 98 dialog.

Function Shortcut Category

Create a new Enterprise Architect project [Ctrl]+[N] File

Open an Enterprise Architect project [Ctrl]+[O] File

Open Source File [Ctrl]+[Alt]+[O] File

Reload the current project 267 [Ctrl]+[Shift]+[F11] File

Print the active diagram [Ctrl]+[P] File

Enterprise Architect User Guide

 Getting Started | User Interface Guide 105

Function Shortcut Category

Undo Change [Ctrl]+[Z] Edit

Redo Change [Ctrl]+[Y] Edit

Add a single element to the clipboard list [Ctrl]+[Space] Edit

Paste element as metafile from clipboard [Ctrl]+[Shift]+[Insert] Edit

Paste element as new [Ctrl]+[Shift]+[V] Edit

Paste element(s) from the clipboard [Shift]+[Insert] Edit

Bookmark current element with red marker [Shift]+[Space] Edit

Delete selected element(s) in diagram [Delete] or Edit

[Ctrl]+[D]

Delete selected element(s) from model [Ctrl]+[Delete] Edit

(through diagram OR Project Browser)

Search for items in the project [Ctrl]+[F] Edit

Set focus to current window [Ctrl]+[Shift]+[0] Window

Autohide the current window [Ctrl]+[Shift]+[F4] Window

Hide the current window [Ctrl]+[F4] Window

View Project Browser [Alt]+[0] View

View Properties window [Alt]+[1] View

View System window [Alt]+[2] View

View Testing window [Alt]+[3] View

View Maintenance window [Alt]+[4] View

Display Toolbox [Alt]+[5] View

View Resources window [Alt]+[6] View

View Source Code window [Alt]+[7] View

View Debug Workbench [Alt]+[8] View

View Notes window [Ctrl]+[Shift]+[1] View

View Element Relationships window [Ctrl]+[Shift]+[2] View

View Rules and Scenarios (Requirements and [Ctrl]+[Shift]+[3] View

Constraints) window

View Traceability window [Ctrl]+[Shift]+[4] View

View Tagged Values window [Ctrl]+[Shift]+[6] View

View Project Management window [Ctrl]+[Shift]+[7] View

View Output window [Ctrl]+[Shift]+[8] View

View Tasks Pane [Ctrl]+[Shift]+[9] View

View Pan & Zoom Window [Ctrl]+[Shift]+[N] View

© 1998-2010 Sparx Systems Pty Ltd

 106 Getting Started | User Interface Guide

Function Shortcut Category

View Model Search [Ctrl]+[Alt]+[A] View

View Element List [Ctrl]+[Alt]+[R] View

Open Team Review [Ctrl]+[Alt]+[U] View

Display Web Browser [Ctrl]+[Alt]+[W] View

View Element Browser [Alt]+[9] View

Add new package to project [Ctrl]+[W] Project

Add new diagram to package [Ctrl]+[Insert] Project

Add new element to package [Ctrl]+[M] Project

Create RTF documentation [F8] Project

Generate HTML Report [Shift]+[F8] Project

Generate Diagrams-only Report [Ctrl]+[Shift]+[F8] Project

Generate package source code [Ctrl]+[Alt]+[K] Project

Synchronize package contents [Ctrl]+[Alt]+[M] Project

Import source directory [Ctrl]+[Shift]+[U] Project

Package Build Scripts [Shift]+[F12] Project

Build [Ctrl]+[Shift]+[F12] Project

Test [Ctrl]+[Alt]+[T] Project

Run [Ctrl]+[Alt]+[N] Project

Deploy [Ctrl]+[Shift]+[Alt]+[F12] Project

Debug Run [F6] Project

Step Into [Shift]+[F6] Project

Step Over [Alt]+[F6] Project

Step Out [Ctrl]+[F6] Project

Debug Stop [Ctrl]+[Alt]+[F6] Project

Transform selected elements [Ctrl]+[H] or Project

[Ctrl]+[Alt]+[F]

Transform current package [Ctrl]+[Shift]+[H] Project

Validate Selected [Ctrl]+[Alt]+[V] Project

Manage locks applied by current user [Ctrl]+[Shift]+[L] Project

Configure package control [Ctrl]+[Alt]+[P] Project

Import package from XMI [Ctrl]+[Alt]+[I] Project

Export package to XMI [Ctrl]+[Alt]+[E] Project

Import and export to CSV files [Ctrl]+[Alt]+[C] Project

Enterprise Architect User Guide

 Getting Started | User Interface Guide 107

Function Shortcut Category

Manage Baselines [Ctrl]+[Alt]+[B] Project

Diagram properties [F5] Diagram

Save [Ctrl]+[S] Diagram

Save image to file [Ctrl]+[T] Diagram

Save image to clipboard [Ctrl]+[B] Diagram

Visible Relations [Ctrl]+[Shift]+[I] Diagram

Locate in Project Browser [Shift]+[Alt]+[G] Diagram

Repeat last element [Shift]+[F3] Diagram

Repeat last connector [F3] Diagram

Element Properties [Alt]+[Enter] Element

Add Tagged Value [Ctrl]+[Shift]+[T] Element

Linked Document [Ctrl]+[Alt]+[D] Element

Display Attribute Properties dialog [F9] Element

Display Operation Properties dialog [F10] Element

Space elements evenly horizontally [Alt]+[-] Element

Space elements evenly vertically [Alt]+[=] Element

Add attribute [Ctrl]+[Shift]+[F9] Element

Add operation [Ctrl]+[Shift]+[F10] Element

Add other type [Ctrl]+[F11] Element

Auto-size selected elements [Alt]+[Z] Element

Generate code from element [Ctrl]+[G] or [F11] Element

Move element by increments [Shift]+[á], [â], [à] or Element

[ß]

Resize selected element [Ctrl]+[á], [â], [ß] or [à] Element

Align bottom edges of selected elements [Ctrl]+[Alt]+[Down] Element

Align top edges of selected elements [Ctrl]+[Alt]+[Up] Element

Align selected elements on left boundaries [Ctrl]+[Alt]+[Left] Element

Align selected elements on right boundaries [Ctrl]+[Alt]+[Right] Element

Configure element default appearance [Ctrl]+[Shift]+[E] or [F4] Element

Edit selected [F2] Element

Manage embedded elements [Ctrl]+[Shift]+[B] Element

Insert new feature after current selection [Insert] Element

Locate in browser [Alt]+[G] Element

© 1998-2010 Sparx Systems Pty Ltd

 108 Getting Started | User Interface Guide

Function Shortcut Category

New element [Ctrl]+[M] Element

View source code 1441 in default editor [Ctrl]+[E] or [F12] Element

Operation [F10] Element

Override inherited features [Ctrl]+[Shift]+[O] Element

Configure element properties [Alt]+[ Enter] Element

Select alternative image [Ctrl]+[Shift]+[W] Element

Specify which element features are visible on a [Ctrl]+[Shift]+[Y] Element

diagram

Set element parent or implement interface(s) [Ctrl]+[I] Element

Set references to other elements and diagrams [Ctrl]+[J] Element

Create Workbench Instance [Ctrl]+[Shift]+[J] Element

Locate diagrams where element is used [Ctrl]+[U] Element

View Properties dialog [Enter] Element

Check project data integrity [Shift]+[F9] Tools

Configure system options [Ctrl]+[F9] Tools

Spell check current package [Ctrl]+[Shift]+[F7] Tools

Spell check model [Ctrl]+[F7] Tools

Edit code generation templates [Ctrl]+[Shift]+[P] Settings

Edit transformation templates [Ctrl]+[Alt]+[H] Settings

Make text bullet list item [Ctrl]+[.] (full stop) Element notes

Make text numbered list item [Ctrl]+[1] Element notes

Make text bold [Ctrl]+[B] Element notes

Make text italic [Ctrl]+[I] Element notes

Make text underlined [Ctrl]+[U] Element notes

Copy text [Ctrl]+[C] Everywhere

Paste text [Ctrl]+[V] Everywhere

Cut text, or element in diagram [Ctrl]+[X] Everywhere

Display Keyboard Accelerator Map

To display the key combinations for the menu functions within Enterprise Architect, select the Help |
Keyboard Accelerator Map menu option. The Help Keyboard dialog displays.

Enterprise Architect User Guide

 Getting Started | User Interface Guide 109

To list the shortcuts in a particular category (see the Command column in the above table), click on the drop-
down arrow in the Category field and select the appropriate category.

2.4.9.1 Keyboard-Mouse Shortcuts

The following table lists certain operations you can perform quickly using a combination of keyboard keys and
the computer mouse.

Function Shortcut

Create element of same type as last created on [Ctrl]+click

diagram

Display element Properties dialog for element in [Ctrl]+click

scenario Context References tab

Select a number of individual objects for an [Ctrl]+click each object

operation

Select a range of objects for an operation [Shift]+click the first and last object
in the range

Move elements along horizontal axis or vertical [Shift]+hold left mouse button and
axis drag

Create bend in and change direction of connector [Shift]+hold left mouse button and
line drag

Move elements in any direction, including [Alt]+hold left mouse button and
diagonally drag

Zoom in or zoom out of diagram [Ctrl]+mouse scroll wheel

Pan diagram horizontally or vertically [Ctrl]+[Shift]+hold left mouse button

and drag

© 1998-2010 Sparx Systems Pty Ltd

Part

III
 Projects and Teams | 111

3 Projects and Teams

Enterprise Architect helps you to create projects for development under a range of work conditions 112 , from
single user/local access through to multiple-role teams working in a distributed environment.
You both protect and manage the model data itself, and communicate information on the data in the form of
documentation and reports, using facilities such as:
· Creating the project in a local, file-based repository 120 (a Microsoft JET database)
· Creating the project in one of a range of DBMS repositories 122 (Corporate and extended editions
· Tools for enabling team development 182 in the project
· Tools for managing changes 228
· Tools for managing project activities 312
· Maintaining the integrity of the project 344
· Sharing 223 the reference data 644 used across the project, and between models and projects
· Enabling each user to configure 350 how project tools display and behave on their workstation.
You can also have recorded discussion and communication of decisions using the Team Review 208 .

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 the Report Generation 1568 topic.

© 1998-2010 Sparx Systems Pty Ltd

 112 Projects and Teams | Introduction

3.1 Introduction

An Enterprise Architect project 113 is stored in a data repository. In Enterprise Architect Desktop and
Professional editions, you work with a single file having a .EAP extension.
In Enterprise Architect Corporate, Business and Software Engineering, Systems Engineering and Ultimate
editions you can also use a suitable DBMS database for project files.

Project Files
.EAP Files
In Enterprise Architect Desktop and Professional editions, a single file with a .EAP extension is used to store
projects. A .EAP file is a Microsoft JET database, so you can also open it using MS Access 97, 2000 or 2003,
or any other reporting tool that can work with JET databases.

DBMS Repositories
In Enterprise Architect Corporate Business and Software Engineering, Systems Engineering and Ultimate
editions, you can use a suitable DBMS database for project files. DBMS project files have the same logical
structure as .EAP files, but must be connected to using ADO/ODBC. See Connect to a Data Repository,
below.
Whenever you launch Enterprise Architect, the first thing displayed is the Start Page 50 . From here, you can
create a new project, open a project and (Corporate, Business and Software Engineering, System Engineering
and Ultimate editions) connect to a data repository.

Create a New Project File

On creating a new project 120 , the Model Wizard 372 enables you to create a model containing various Model
Packages.
You can also add Model Packages to a project from the Project Browser by:
· Right-clicking on an existing model and selecting the New Model or Add a New Model using Wizard
context menu options
· Right-clicking on a package and selecting the Add | Add a New Model using Wizard context menu option
· Clicking on an existing model, pressing [Insert] and selecting the New Model or Add a New Model using
Wizard context menu options
· Clicking on a package, pressing [Insert] and selecting the Add a New Model using Wizard context menu
option.

Open an Existing Project

There are various ways to open a project 114 in Enterprise Architect. New users are advised to explore the
EAExample file 114 supplied with Enterprise Architect.

Connect to a Data Repository

Note:
This feature is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions.

Enterprise Architect enables you to connect to 147 any of the following data repositories:
· MS Access 97, 2000 and 2003 (in all editions - .EAP files are stored in Microsoft JET databases)
· Access 2007

Enterprise Architect User Guide

 Projects and Teams | Introduction 113

· SQL Server 2000, 2005 and 2008

· MySQL
· Oracle 9i, 10g or 11g
· PostgreSQL
· MSDE
· Adaptive Server Anywhere
· Progress OpenEdge
To create a new data repository, you must first create a new database with the DBMS management software,
then run supplied scripts to create the logical structure. You should then use Enterprise Architect data transfer
functions to move a project from a .EAP or DBMS model into the new project.

3.1.1 What is a Project?

An Enterprise Architect project is a mechanism for storing and managing the components of one or more UML
models.
A project can be a .EAP file 112 in an MS Access database or (in the Enterprise Architect Corporate, Business
and Software Engineering, System Engineering and Ultimate editions) a structure of files in a database
management system 112 such as MySQL or Oracle.
A project can contain a single model, or a number of models, each of which defines a particular system or
process. A model contains the diagrams, elements, relationships and associated metadata that define the
structure and function of the system or process. These components are organized into a hierarchy of
packages, which help to group and manage related components.
Different aspects of the process or system - or their development - are defined by Model Packages, which you
generate 372 from templates 373 specifically structured to support the aspects that the Model Packages
represent, such as requirements or deployment. You can generate these templated packages at any level of
the hierarchy, but as they are created with their own content they are more useful at the top levels.
The top-level packages in a model can also be Views 383 , which represent partitions of the model that you
define yourself. You can start with standard Views such as Class or Component, or create whatever partitions
are appropriate to your model.
So a typical project could have a structure something like the following:

The project Condor contains two models:

· Development Model and
· Requirements Model.
Requirements Model contains:

© 1998-2010 Sparx Systems Pty Ltd

 114 Projects and Teams | Introduction

· Requirements View and

· Use Case Model Package.
Each View or Model Package contains packages. Use Case Model Package contains:
· Actors and
· Primary Use Cases.
It also contains the diagram Use Case Diagram, which could be an overview of the package structure or
function. Each package itself can contain one or more diagrams, one or more packages, and several
elements. The Primary Use Cases package contains the:
· Primary UCDiagram
· Customer Setup package
· Use Case 1 element
· Use Case 2 element.
Each subordinate package also contains diagrams, elements and (if necessary) further packages. The
elements are related by connectors created in the diagrams, and each element and connector has properties,
attributes, operations and extensions defined in the respective Properties dialogs.

3.1.2 Open a Project

Enterprise Architect supports several different methods of opening an Enterprise Architect project file.

From the Main Menu

Select the File | Open Project menu option. From the Open Project dialog, select the path for the file to open
and click on the Open button.

From the Default Tools 80 Toolbar

Click on the folder icon to display the Open Project dialog, or the drop-down arrow to display a list of recently-
opened projects.

From the Start Page 50

1. Click on Open a Project File. The Open Project dialog displays.

2. Use the file browser ([ ... ]) to navigate to the project to open, which has a .EAP file extension (*.EAP).
Select the project and click on the Open button.

Recently Opened Projects

Enterprise Architect keeps a list of recently opened projects and displays them on the Start Page for easy
selection. If the project to open is in the Recent list, simply click once on the name of the project to open it.

Enterprise Architect User Guide

 Projects and Teams | Introduction 115

Note:
If you already have a project open, Enterprise Architect prompts you to save changes before loading.

Enterprise Architect Example Project File

New Enterprise Architect users in particular should start by exploring the EAExample file supplied with
Enterprise Architect. The example model file is stored in your Enterprise Architect installation directory. The
default installation directories, depending on which version you have installed, are:
· Registered version: C:\Program Files\Sparx Systems\EA
· Trial version: C:\Program Files\Sparx Systems\EA Trial
· Lite version: C:\Program Files\Sparx Systems\EA Lite

Connect to a Data Repository 147

Note:
This feature is available in the Corporate, Business and Software Engineering, Systems Engineering and
Ultimate editions.

You also have the option to connect to SQL Server 126 , MySQL 123 , Oracle 9i, 10g or 11g 129 , Postgre SQL
160 , ASA 162 , MSDE Server 165 and Progress OpenEdge 165 data repositories.

3.1.3 Model Shortcuts

Enterprise Architect enables you to create a desktop shortcut (or Proxy file) to your model or (for a .EAP file) a
direct copy of your model. You cannot create a copy of a DBMS model.
If you are using a database repository other than MS Access 97, 2000 or 2003, you can configure the shortcut
to encrypt the password 119 used to set up the connection between Enterprise Architect and the repository.
The Enterprise Architect user does not have the real password, thereby preventing them from accessing the
repository using other tools such as Query Analyzer or SQLPlus.
Each shortcut is a file containing the connection string for the model. However, the shortcut also defines views
that Enterprise Architect should open as it opens the model, such as:
· The Model Search 1231 with a specific text string and search type
Notes:
· For searches operating on the current tree selection, a diagram in the target package must be opened
first.
· If you use a custom SQL search, the SQL must include 1239 ea_guid AS CLASSGUID and the object
type.

· A specific diagram
· The Relationship Matrix 1261 with a saved profile
· The default Team Review 208 .
You can define more than one diagram to open (but not more than one search, Team Review or Relationship
Matrix profile). Enterprise Architect opens the appropriate windows in the sequence in which you list the
options, displaying the last view in the list. For example, you might create your shortcut to open, in sequence:
· A Development module
· The Model Search for a simple search on the term Issue
· The module Issues diagram
· The module Changes diagram.
The project would then open with the Enterprise Architect work area showing the two diagram tabs and the
Model Search tab, and with the Changes diagram displayed in the Diagram View 396 .

© 1998-2010 Sparx Systems Pty Ltd

 116 Projects and Teams | Introduction

Notes:
· These options are not valid for a copy of the model.
· If specified, the shortcut views override any default diagram 65 defined for the model or current user.
· A shortcut does not affect the original Enterprise Architect .exe file or icon, or any other shortcut you might
have defined. You can use all of these independently.
· When you use a shortcut to access a project that you have recently opened in Enterprise Architect, the
Recent list on the Enterprise Architect Start Page has two entries for the project - one created when you
opened the project in Enterprise Architect and one created when you used the desktop shortcut.

To create a copy of your model or a shortcut to your model, you have two options:
· Define each view 116 to open (for example, if you are specifying a working environment in advance,
perhaps for other users)
· Capture the current Enterprise Architect work environment 117 to access the model at exactly the same
point in exactly the same environment when you resume work.

3.1.3.1 Create Copy Or Shortcut

You can specifically define each view that your model shortcut should open; for example, if you are specifying
a working environment in advance, perhaps for other users.
You can also capture the current Enterprise Architect work environment 117 , which is useful if you want to
access the model at exactly the same point in exactly the same environment when you resume work.
To specifically set up your start-up shortcut or take a copy of the model, follow the steps below:
1. On the Start Page, open the required project.
2. Select the File | Save Project As menu option. The Save As dialog displays.

3. Click on the [ ... ] (Browse) button at the end of the Target File field. The Save Project As dialog
displays.
4. Browse for the appropriate file location (such as C:\Documents and Settings\<username>\Desktop) and, in
the File name field, type an appropriate filename. All shortcuts are .EAP files, regardless of whether the
model itself is a .EAP file or a DBMS model.
5. Click on the Save button to return to the Save As dialog.
6. Click on one of the following:
· The Copy radio button to create a direct copy of the model, and click on the OK button to save the
copy and end the procedure
· The Shortcut radio button to create a desktop shortcut for the model

Enterprise Architect User Guide

 Projects and Teams | Introduction 117

Note:
These radio buttons display only if the model is a .EAP file. If the model is a DBMS file, the target file
can only be a shortcut. See the Encrypt Repository Password 119 topic.

7. Click on the Add Other button and select the required option to define:
· A diagram to open
· A Relationship Matrix profile to open
· The Team Review
· A Model Search to perform.
The appropriate browser or dialog displays to define the view to display. Enter the details and click on
the OK button.
8. Repeat step 7 for as many views as you require. Each entry is automatically selected, with a tick in the
checkbox.

To delete an entry, click on the checkbox to remove the tick. The entry is deleted when you save the
shortcut.

9. To change the sequence and/or make a different view display first in the Diagram View, click on the
appropriate entry and click on the 'Up Hand' or 'Down Hand' buttons.
10. Click on the OK button to save the shortcut.
When you subsequently open the Save As dialog, it lists the currently-opened views in the order in which they
were opened. You can add further views or remove them from the shortcut.

3.1.3.2 Capture Current Work Environment

You can capture the current Enterprise Architect work environment, so that you can access the model at
exactly the same point in exactly the same environment when you resume work.
To do this, follow the steps below:
1. Open Enterprise Architect (perhaps by using an existing shortcut).
2. On the Start Page, open the required project.
3. Perform the work you need to do.
4. When you decide to capture your work environment in a shortcut, ensure that you have opened all
diagrams you require and, if necessary, the Team Review, Model Search (with appropriate search term
and type) and/or Relationship Matrix (at the appropriate profile). Ensure that the view you want to
resume work on is the last one opened.
5. Select the File | Save Project As menu option. The Save As dialog displays, showing a list of actions
derived from the views you currently have opened.

© 1998-2010 Sparx Systems Pty Ltd

 118 Projects and Teams | Introduction

6. If you accessed Enterprise Architect via a shortcut, the Target File field displays the file location of that
shortcut. If you intend to update the shortcut, go to step 10.
7. Otherwise, click on the [ ... ] (Browse) button at the end of the Target File field. The Save Project As
dialog displays.
8. Browse for the appropriate file location (such as C:\Documents and Settings\<username>\Desktop) and, in
the File name field, type an appropriate filename. All shortcuts are .EAP files, regardless of whether the
model itself is a .EAP file or a DBMS model.
9. Click on the Save button to return to the Save As dialog.
10. Click on one of the following:
· The Copy radio button to create a direct copy of the model, and click on the OK button to save the
copy and end the procedure.
· The Shortcut radio button to create a desktop shortcut for the model.

Note:
These radio buttons display only if the model is a .EAP file. If the model is a DBMS file, the target file
can only be a shortcut. See the Encrypt Repository Password 119 topic.

11. If you decide not to have a view in the shortcut, click on the checkbox to remove the tick. The entry is
deleted when you save the shortcut.
12. If you decide to change the sequence and/or make a different view display first in the Diagram View,
click on the appropriate entry and click on the 'Up Hand' or 'Down Hand' buttons.
11. Click on the OK button to save the shortcut.

Note:
If you open the Save As dialog when no views are open, the Actions when model is opened field is empty.
You can save the shortcut like this to totally clear it. Alternatively, if views are listed that you do not want to
use again, click on the Include None button and save the shortcut.

Enterprise Architect User Guide

 Projects and Teams | Introduction 119

3.1.3.3 Encrypt Repository Password

If your model is developed on a DBMS repository, the Save As dialog has an Encrypt Connection String
check box instead of the radio buttons, as shown below:

You can create the shortcut actions as described in the Create Copy or Shortcut 116 topic and, if necessary,
select the checkbox to encrypt the database connection string. You distribute the shortcut file to the database
users who are to access the model. The users then have an encrypted string such as:

EAConnectString: ora10_db --- DBType=3;ConnectEx=+wkIE;B?e

52+H`"e?r-pb_ZyAI3a]Vsfh8p];Co\d/bnX$5<(;'US"^GxvbbRsK{*%AwL4y1{P<je.%R1
?AY;y'!7pw$X%)_EwLXWpKg7tzLF=T

© 1998-2010 Sparx Systems Pty Ltd

 120 Projects and Teams | File Based Repositories

3.2 File Based Repositories

Enterprise Architect projects can be created as .eap files via the File | New Project menu option, which
displays the Save New Enterprise Architect Project dialog.
Select a directory and enter a file name for your project, then click on the Save button. Once the project has
been saved, the Select Model(s) 372 dialog displays, which makes a selection of Model Packages available.
Select the Model Packages to include and click on the OK button. Enterprise Architect adds a model
containing the selected Model Packages to the Project Browser.
You can also add Model Packages to the project using the New Model From Pattern icon in the Project
Browser toolbar 1212 . Alternatively, new projects can be created from the Start Page 50 ; select the Create a
New Project option.

The Model Wizard

The Model Wizard is used to add a selection of Model Packages to the project, through the Select Model(s)
dialog.

The EABase Project File

The default project file (EABase.EAP) is supplied when you install Enterprise Architect and is stored in your
Enterprise Architect installation directory (or anywhere else you might redirect it to). The default installation
directories, depending on which version you have installed, are:
· Registered version: C:\Program Files\Sparx Systems\EA
· Trial version: C:\Program Files\Sparx Systems\EA Trial
· Lite version: C:\Program Files\Sparx Systems\EA Lite
Having copied the base project as a template for your own project, you can rename 348 it - or any other
project you own.

Design a Custom Template

You can customize any Enterprise Architect project and use it as the base for the new project. This enables
you or your organization to build a default project with company standards, tutorials, frameworks or any other
common piece of modeling already in-built. A default project is no different from an ordinary project; Enterprise
Architect simply copies and renames it as a starter for your new project. With careful planning you can save
yourself many hours of work at project start-up.

Configure Project
Having created your project, you can set a range of project parameters to define defaults, tailor the project to
particular coding languages, and ensure consistent development and use of the project. See the following
topics:
· The Settings Menu 73
· Defaults and User Settings 90

Enterprise Architect User Guide

 Projects and Teams | File Based Repositories 121

3.2.1 Copy a Base Project

To copy an existing project as a base for a new project, from the Start Page 50 select the Copy a Base
Project option. The Create New Enterprise Architect Project dialog displays.

You must first select the project that is to be the base template. When you install Enterprise Architect a default
base project is installed called EABase.eap.
· The Model Project field defaults to EABase.eap, as the base file for your project; however you can select
any existing project file as a Custom Template 120 - click on the Browse button after the Model Project
field and locate the custom project file
· To select the file path for saving your project, click on the Browse button after the New Project field; if this
is to be a shared project, store the file on a shared network resource such as a Network Server or
Workgroup Server
· To replace all GUIDs in the source model with fresh GUIDs, select the Reset New Projects GUIDs
checkbox.
Note:
If the new project is based on one that is already under version control, it is recommended that the Reset
New Projects GUIDs checkbox be deselected. This prevents duplication of packages when the Get
Latest facility is used.

When you have entered the filenames, click on the Create Project button to create your project. Click on the
Cancel button to close the dialog without creating a new project.

Tip:
You can also copy any Enterprise Architect project using Windows Explorer, and open the copied project as a
new project.

© 1998-2010 Sparx Systems Pty Ltd

 122 Projects and Teams | Server Based Repositories

3.3 Server Based Repositories

Introduction
The Desktop and Professional versions of Enterprise Architect use an MS JET database as the model
repository.
If you purchase the Corporate, Business and Software Engineering, Systems Engineering or Ultimate edition,
you can also create and use any of the following data repositories:
· SQL Server 126 2000, 2005 or 2008
· MySQL 123 4 or 5
· PostgreSQL 129 7 or 8
· Adaptive Server Anywhere 8 or 9, or SQL Anywhere 10 or 11 132

· Access 2007 123

· Progress OpenEdge 134
· MSDE 134 or
· Oracle 9i, 10g or 11g 129 .
You upsize the Enterprise Architect models (either existing or template) to use your selected DBMS. The
process of upsizing a model is straightforward and comprises the following steps:
1. Install the DBMS software and create a database. Ensure that the collation is set to the alphabet you
use, such as Latin or Cyrillic.
2. Run a script supplied by Sparx Systems (
http://www.sparxsystems.com/resources/corporate/index.html#sql_scripts) to create the required tables.
3. Open Enterprise Architect and use the Project Data Transfer 306 function (select the Tools | Data
Management | Project Transfer menu option) to move a model from a .EAP file to the DBMS
repository.

Note:
You cannot move a model from a source .EAP file of a version earlier than 3.5.0.

Setting up a database repository is a two- or three-stage process: firstly, you set up an ODBC driver for your
database; secondly, you create the repository tables using scripts downloaded from the Sparx Systems web
site; and finally, you connect to the repository. Full instructions on all three stages are provided below.

Set Up an ODBC Driver

Setting up an ODBC driver is only necessary for MySQL, PostgreSQL, Progress OpenEdge and Adaptive
Server Anywhere. These database management systems require specific set-up in order to operate as a
repository. Other database management systems connect through OLE DB and do not require a driver, so this
stage can be skipped.

Note:
For Oracle, the Microsoft OLE DB Provider for Oracle is not appropriate. You use the Oracle Provider for OLE
DB 153 instead.

To find out how to set up an ODBC driver, go to:

· Set Up a MySQL ODBC Driver 135
· Set Up a PostgreSQL ODBC Driver 138
· Set Up an Adaptive Server Anywhere ODBC Driver 141

· Set Up a Progress OpenEdge ODBC Driver 145 .

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 123

Create a Repository
To find out how to download the scripts and create the data repository tables, go to:
· Create a MySQL Data Repository 123
· Create an Access 2007 Repository 123
· Create a SQL Server Data Repository 126
· Create an Oracle Data Repository 129
· Create a PostgreSQL Data Repository 129
· Create an Adaptive Server Anywhere Data Repository 132

· Create an MSDE Server Data Repository 134

· Create a Progress OpenEdge Data Repository 134

Connect to a Repository
Once the repository is created, you can connect to it.

Note:
To connect to a repository, you must have the usual SELECT, UPDATE, INSERT and DELETE permissions.

To find out how to connect to your repository, see one of the following topics:
· Connect to a MySQL Data Repository 148
· Connect to a SQL Server Data Repository 150
· Connect to an Oracle Data Repository 153
· Connect to a PostgreSQL Data Repository 160
· Connect to an Adaptive Server Anywhere Data Repository 162

· Connect to an MSDE Server Data Repository 165

· Connect to a Progress OpenEdge Data Repository. 165

3.3.1 Create a Repository

This topic details how to create the following data repositories:
· Access 2007 123
· MySQL 123
· SQL Server 126
· Oracle 9i, 10g or 11g 129
· PostgreSQL 129
· Adaptive Server Anywhere (ASA) 132

· MSDE Server 134 .

3.3.1.1 Access 2007

Note:
This feature is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions.

Using Access 2007, open a .EAP file and allow Access to convert it to a .ACCDB file. This forms the Access
2007 repository.

3.3.1.2 MySQL Repository

Note:
This feature is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions.

Before creating a MySQL data repository in Enterprise Architect, you must set up the MySQL and MySQL
ODBC drivers. For further information on setting these up, see MySQL ODBC Driver 135 .

© 1998-2010 Sparx Systems Pty Ltd

 124 Projects and Teams | Server Based Repositories

To create a new MySQL repository, you must first create a database into which to import the table definitions
for Enterprise Architect. Sparx Systems provide SQL scripts to create the required tables; how you create the
database and execute that script are up to you.
· Registered users can obtain the scripts from the Registered Corporate edition Resources page of the
Sparx Systems website at http://www.sparxsystems.com/registered/reg_ea_corp_ed.html
· Trial users can obtain the scripts from the Corporate edition Resources page of the Sparx Systems website
at http://www.sparxsystems.com/resources/corporate/.

Create the Data Repository

Once you have created the database and executed the script, you should have an empty Enterprise Architect
project to begin working with. You can transfer data from an existing .EAP file or simply start from scratch.

Third Party Tools

If you are unfamiliar with MySQL and DBMS systems in general, you might want to consider a suitable front
end tool.
MySQL Administrator, available from http://dev.mysql.com/downloads/gui-tools/5.0.html, is one such tool. It
provides a convenient graphical user interface to enable the creation of databases, execution of scripts,
backups and restores.
To get started, follow the steps below:
1. Run MySQL Administrator and create a new database.

2. Run MySQL Query Browser, and open and execute the MySQL repository script.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 125

3. Below is an example showing the tables created in the MySQL repository after running the script in
MySQL Query Browser.

© 1998-2010 Sparx Systems Pty Ltd

 126 Projects and Teams | Server Based Repositories

3.3.1.3 SQL Server Repository

Note:
This feature is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions.

Before creating a SQL Server data repository, you must have SQL Server and MDAC 2.6 or higher installed,
and access permission to create a new database. Please note that setting up SQL Server and the issues
involved are beyond the scope of this user guide. Consult your program's documentation for a guide to this.
Sparx Systems provide SQL scripts to create the required tables; how you create the database and execute
that script are up to you.
· Registered users can obtain the scripts from the Registered Corporate edition Resources page of the
Sparx Systems website at http://www.sparxsystems.com/registered/reg_ea_corp_ed.html
· Trial users can obtain the scripts from the Corporate edition Resources page of the Sparx Systems website
at http://www.sparxsystems.com/resources/corporate/.

Create a SQL Server Repository

SQL Server repositories are created without any data, so you must perform a project data transfer 306 in
Enterprise Architect to copy a suitable starter project. If you are starting from scratch, EABase.EAP 120 is a
good starting point. If you are using an existing .EAP model, you can upsize 122 it.
To use SQL Enterprise Manager to create a SQL Server repository, follow the steps below:

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 127

1. In SQL Enterprise Manager, locate the server on which to create your new Enterprise Architect model;
in the example below this is DBSERVER02\SQLEXPRESS.

2. Right-click and choose the New Database context menu option.

3. Enter a suitable name for the database. Set any file options as required.

Note:
Ensure that the database collation is case-insensitive.

4. Click on the database to select it, then select the New Query menu option.

© 1998-2010 Sparx Systems Pty Ltd

 128 Projects and Teams | Server Based Repositories

5. In the Query window, use the Open File dialog to locate the supplied Enterprise Architect SQL Server
Model script file.

6. Click on the Open button. Check that you have selected the correct database to run the script in. In this
example the tables are being added to the ea_sqlserver database as shown in the drop-down menu
below.

7. Click on the Execute button; SQL Server executes the script, which creates the base model for an
Enterprise Architect project.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 129

3.3.1.4 Oracle Server Repository

Note:
This feature is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions.

Before creating an Oracle data repository, you must have the appropriate version of Oracle (9i, 10g or 11g)
and MDAC 2.6 or higher installed, and access permission to create a new database. Please note that setting
up Oracle and the issues involved are beyond the scope of this manual. Consult your program documentation
for guidance.
Sparx Systems provide SQL scripts to create the required tables; how you create the database and execute
that script are up to you.
· Registered users can obtain the scripts from the Registered Corporate edition Resources page of the
Sparx Systems website at http://www.sparxsystems.com/registered/reg_ea_oracle_instructions.html
· Trial users can obtain the scripts from the Corporate edition Resources page of the Sparx Systems website
at http://www.sparxsystems.com/resources/corporate/.

Create the Data Repository

Oracle repositories are created without any data, so you must perform a project data transfer 306 in Enterprise
Architect to copy a suitable starter project. If you are starting from scratch, EABase.EAP 120 is a good starting
point. If you want to use an existing .EAP model, you can upsize 175 it; follow the steps below:
1. Create a new database on the Oracle server.
2. Connect to the newly created database with a program such as Oracle SQL*Plus or SQL Plus
Worksheet.
3. Execute the script Oracle_BaseModel.sql, which creates the base model tables and indexes for an
Enterprise Architect Project.

3.3.1.5 PostgreSQL Repository

Note:
This feature is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions.

Before creating a PostgreSQL data repository in Enterprise Architect, you must set up PostgreSQL and
PostgreSQL ODBC drivers. For further information on setting these up, see Set up a PostgreSQL ODBC
Driver 138 .
To create a new PostgreSQL repository, you must first create a database into which to import the table
definitions for Enterprise Architect. Sparx Systems provide SQL scripts to create the required tables; how you
create the database and execute that script are up to you.
· Registered users can obtain the scripts from the Registered Corporate edition Resources page of the
Sparx Systems website at http://www.sparxsystems.com/registered/reg_ea_corp_ed.html
· Trial users can obtain the scripts from the Corporate edition Resources page of the Sparx Systems website
at http://www.sparxsystems.com/resources/corporate/.

Create the Data Repository

After you create the database and execute the script, the result should be an empty Enterprise Architect
project to begin working with. You can transfer data from an existing .EAP file or simply start from scratch.

Third Party Tools

If you are unfamiliar with PostgreSQL and DBMS systems in general, you might want to consider a suitable
front end tool.
One such tool is pgAdminIII, which is available at http://www.pgadmin.org/download/. It provides a convenient
graphical user interface to enable creation of databases, execution of scripts and restores.
To get started with pgAdminIII, follow the steps below:
1. Create a new database.

© 1998-2010 Sparx Systems Pty Ltd

 130 Projects and Teams | Server Based Repositories

2. Open and execute the PostgreSQL SQL script.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 131

3. Below is an example showing the tables created in the PostgreSQL repository after running the script
in pgAdminIII.

© 1998-2010 Sparx Systems Pty Ltd

 132 Projects and Teams | Server Based Repositories

3.3.1.6 Adaptive Server Anywhere Repository

Note:
This feature is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions.

Before creating an ASA data repository in Enterprise Architect, you must set up ASA and ASA ODBC drivers.
For further information on setting these up, see Setup an Adaptive Server Anywhere ODBC Driver 141 .
To create a new ASA repository, you must first create a database into which to import the table definitions for
Enterprise Architect. Sparx Systems provide SQL scripts to create the required tables - how you create the
database and execute that script are up to you.
· Registered users can obtain the scripts from the Registered Corporate edition Resources page of the
Sparx Systems website at http://www.sparxsystems.com/registered/reg_ea_corp_ed.html
· Trial users can obtain the scripts from the Corporate edition Resources page of the Sparx Systems website
at http://www.sparxsystems.com/resources/corporate/.

Create the Data Repository

After you create the database and execute the script, the result should be an empty Enterprise Architect
project to begin working with. You can transfer data from an existing .EAP file or simply start from scratch.

Third Party Tools

If you are unfamiliar with ASA and DBMS systems in general, you might want to consider a suitable front end
tool.
Sybase Central is one such tool, that can be installed along with the DBMS. It provides a convenient graphical
user interface to enable creation of databases, execution of scripts and restores.
To get started with Sybase Central, follow the steps below:

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 133

1. Create a new database.

2. Open Interactive SQL and execute the AS SQL script.

The following example shows the tables created in the ASA repository after running the script in EMS ASA
Manager.

© 1998-2010 Sparx Systems Pty Ltd

 134 Projects and Teams | Server Based Repositories

3.3.1.7 MSDE Server Repository

Note:
This feature is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions.

Before creating a SQL Server MSDE data repository, you must have MSDE Server and MDAC 2.6 or higher
installed. Please note that setting up MSDE Server and the issues involved are beyond the scope of this user
guide. Consult your program documentation for guidance.
Sparx Systems provide SQL scripts to create the required tables; how you create the database and execute
that script are up to you.
· Registered users can obtain the scripts from the Registered Corporate edition Resources page of the
Sparx Systems website at http://www.sparxsystems.com/registered/reg_ea_corp_ed.html
· Trial users can obtain the scripts from the Corporate edition Resources page of the Sparx Systems website
at http://www.sparxsystems.com/resources/corporate/.
Use the SQL Server 2000, 2005 or 2008 script for MSDE, and follow the steps to Create a New SQL Server
Data Repository 126 .

3.3.1.8 Progress OpenEdge Repository

Notes:
· This feature is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions.
· The OpenEdge database must be either version 10.0B03 or version 10.1B01, or later.

Before creating a Progress OpenEdge data repository, you must have OpenEdge and MDAC 2.6 or higher
installed, and access permission to create a new database. Please note that setting up OpenEdge and the
issues involved are beyond the scope of this manual. Consult your OpenEdge documentation for guidance.
Sparx Systems provide SQL scripts to create the required tables; how you create the database and execute

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 135

that script is up to you.

· Registered users can obtain the scripts from the Registered Corporate edition Resources page of the
Sparx Systems website at http://www.sparxsystems.com/registered/reg_ea_openedge_instructions.html
· Trial users can obtain the scripts from the Corporate edition Resources page of the Sparx Systems website
at http://www.sparxsystems.com/resources/corporate/.

Create the Data Repository

OpenEdge repositories are created without any data, so you must perform a project data transfer 306 in
Enterprise Architect to copy a suitable starter project. If you are starting from scratch, EABase.EAP 120 is a
good starting point. If you want to use an existing .EAP model, you can upsize 171 it.
1. Run proenv from the OpenEdge menu: Start->Programs->OpenEdge->proenv.
2. Create database: prodb <database_name> empty.
3. Start database server: proserve <database_name> -S <port_number>
4. Open Data Administration to add a user:
prowin32 -db <database_name> -S <port_number> -p _admin -rx

5. Open Admin->Security->Edit User List.

6. Close Data Administration.
7. Open SQL Explorer Tool, connect as 'sysprogress'.
8. Add user:
create user 'user','password';
commit;

9. Grant privileges:
grant dba, resource to <user>;
commit;

3.3.2 Set Up an ODBC Driver for a Connection to a Repository

This topic details how to set up the following ODBC drivers, to enable connection to an Enterprise Architect
data repository:
· MySQL ODBC Driver 135
· PostgreSQL ODBC Driver 138
· Adaptive Server Anywhere ODBC Driver 141

· Progress OpenEdge ODBC Driver 145

MySQL, PostgreSQL, Sybase Adaptive Server Anywhere and Progress OpenEdge require specific set-up in
order to operate as a repository. Other database management systems connect through OLE DB and do not
require a driver.

3.3.2.1 MySQL ODBC Driver

Before you can connect to a MySQL data repository, you must first set up a MySQL ODBC driver for which, in
turn, you must first have installed Microsoft MDAC components, a MySQL DBMS system and a MySQL ODBC
driver.

Note:
The recommended MySQL ODBC driver version is 5.1.5. (Version 3.51.14 creates problems in incorporating
tests in elements.)

To set up your MySQL ODBC Driver, follow the steps below:

1. Select the WindowsTM Control Panel | Administrative Tools | Data Sources (ODBC) option. The
ODBC Data Source Administrator window displays.

© 1998-2010 Sparx Systems Pty Ltd

 136 Projects and Teams | Server Based Repositories

2. Click on the Add button. The Create New Data Source dialog displays, enabling you to add a new DSN.

3. Select MySQL ODBC 5.1 Driver from the list.

4. Click on the Finish button. The MySQL Connector/ODBC dialog displays.
5. Enter the following configuration details:
· A data source name for the connection
· A description (optional)
· The host address of the DBMS server
· User name and password
· The database name on the selected server.
See the example below:

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 137

6. Click on the Details>> button and Flags 1 tab to set the advanced options.

7. Select the Return matched rows instead of affected rows and Allow big result sets checkboxes.
8. Click on the Test button to confirm that the details are correct.
9. If the test succeeds, click on the OK button to complete the configuration.
10. If the test does not succeed, review your settings.
Your MySQL connection is now available to use in Enterprise Architect.

© 1998-2010 Sparx Systems Pty Ltd

 138 Projects and Teams | Server Based Repositories

3.3.2.2 PostgreSQL ODBC Driver

Before you can connect to a PostgreSQL data repository, you must first set up a PostgreSQL ODBC driver. To
do this, you must have Microsoft MDAC components, a PostgreSQL DBMS system and a PostgreSQL ODBC
driver (version 7.03.01.00 minimum) installed.

Note:
Do not use version 8.4.1 of the PostgreSQL ODBC Driver; it presents difficulties in transferring a project to a
PostgreSQL repository.

To set up your PostgreSQL ODBC driver, follow the steps below:

1. Select the WindowsTM Control Panel | Administrative Tools | Data Sources (ODBC) option. The
ODBC Data Sources Administrator window displays.

2. Click on the Add button. The Create New Data Source dialog displays, enabling you to add a new DSN.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 139

3. Select PostgreSQL from the list.

4. Click on the Finish button.
5. Enter the following configuration details:
· A name for the connection
· The actual name of the database.
· Description (optional)
· The host address of the PostgreSQL server.
· User name and password.

6. Click on the Datasource button and set the options on Page 1 and Page 2 as shown on the examples
below:

© 1998-2010 Sparx Systems Pty Ltd

 140 Projects and Teams | Server Based Repositories

Note:
On Page 2, For PostgreSQL version 8+ select the Disallow Premature checkbox and, in the Protocol
panel, select the 7.4+ radio button.

7. Click on the OK button to complete the configuration.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 141

Your PostgreSQL connection is now available to use in Enterprise Architect.

3.3.2.3 ASA ODBC Driver

Before you can connect to an Adaptive Server Anywhere (ASA) data repository, you must first set up an ASA
ODBC driver. To do this, you must have Microsoft MDAC components, the ASA DBMS system and the ASA
ODBC driver (installed with the ASA DBMS) installed.
To set up your ASA ODBC Driver, follow the steps below:
1. Select the WindowsTM Control Panel | Administrative Tools | Data Sources (ODBC) option. The
ODBC Data Sources Administrator window displays.

2. Click on the Add button. The Create New Data Source dialog displays, enabling you to add a new DSN.

© 1998-2010 Sparx Systems Pty Ltd

 142 Projects and Teams | Server Based Repositories

3. Select Adaptive Server Anywhere or SQL Anywhere from the list.

4. Click on the Finish button.
5. Enter the following configuration details:
· A name for the connection on the ODBC tab.

· The username and password on the Login tab (dba, sql are the defaults when ASA is installed).

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 143

· The server name and the path to the database, on the Database tab.

© 1998-2010 Sparx Systems Pty Ltd

 144 Projects and Teams | Server Based Repositories

· The network protocol on the Network tab (if the database is on a network location).

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 145

6. You can now return to the ODBC tab and test the connection.
7. Click on the OK button to complete the configuration.
Your Adaptive Server Anywhere connection is now available to use in Enterprise Architect.

3.3.2.4 Progress OpenEdge ODBC Driver

Before you can connect to an OpenEdge data repository, you must first set up an OpenEdge ODBC driver. To
do this, you must have Microsoft MDAC components, OpenEdge DBMS system and DataDirect ODBC driver
for OpenEdge (version 4.20 minimum) installed.
To set up the ODBC Driver, follow the steps below:
1. Select the WindowsTM Control Panel | Administrative Tools | Data Sources (ODBC) option. The
ODBC Data Sources Administrator window displays.

© 1998-2010 Sparx Systems Pty Ltd

 146 Projects and Teams | Server Based Repositories

2. Click on the Add button. The Create New Data Source dialog displays, enabling you to add a new DSN.

3. Select the DataDirect/OpenEdge SQL driver from the list.

4. Click on the Finish button. The DSN Configuration dialog displays.
5. Enter the following configuration details:
· The Data Source Name
· The Description (optional)
· The Host Name and Port Number of the DBMS server
· The Database Name on the selected server
· The User ID.
See the example below:

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 147

6. Click on the Test Connect button to confirm that the details are correct.
7. If the test succeeds, click on the OK button to complete the configuration.
8. If the test does not succeed, review your settings.
Your OpenEdge connection is now available to use in Enterprise Architect.

3.3.3 Connect to a Data Repository

This topic describes how to connect to a range of data repositories, to access an existing Enterprise Architect
mode.
In Enterprise Architect you connect to a data repository for one of two reasons:
· To access an existing Enterprise Architect model in the repository
· To reverse engineer a database schema into a model using ODBC 1363 .

Note:
To connect to a repository, you must have the usual SELECT, UPDATE, INSERT and DELETE permissions.

For information on how to connect to your database repository, click on the appropriate link below:
· MySQL Data Repository 148
· SQL Server Data Repository 150
· Oracle Data Repository 153
· PostgreSQL Data Repository 160
· Adaptive Server Anywhere Data Repository 162

· MSDE Server Data Repository 165

· Progress OpenEdge 165 .

© 1998-2010 Sparx Systems Pty Ltd

 148 Projects and Teams | Server Based Repositories

3.3.3.1 MySQL Data Repository

Note:
This feature is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions.

In order to use a MySQL data repository, you must connect to it in Enterprise Architect first. Before connecting
to the repository, you must set up a MySQL ODBC driver 135 .
To connect to a MySQL data repository in Enterprise Architect, follow the steps below:
1. In the Open Project 114 dialog, select the Connect to Server checkbox.
2. Click on the [ ... ] (Browse) button, as you normally would to browse for a project. As you have selected
the Connect to Server checkbox, the Data Link Properties dialog displays instead of the Browse
Directories dialog.

3. Select Microsoft OLE DB Provider for ODBC Drivers from the list.
4. Click on the Next button. The Connection tab displays.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 149

5. Click on the Use data source name radio button and on the drop-down arrow in its field. Select the
ODBC driver you have set up to connect to your MySQL repository from the list. In the setup example
135 the driver title is Changes.

6. If required, type in a User name and Password.

7. If required, type in an initial catalog.
8. Click on the Test Connection button to confirm that the details are correct.
9. If the test succeeds, click on the OK button.
10. If the test does not succeed, revise your settings.
11. After you have clicked on the OK button, the Connection Name & Type dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 150 Projects and Teams | Server Based Repositories

12. Give the connection a suitable name so that you can recognize it in the Recent Projects panel on the
Open Project dialog.
13. If required, select the Encrypt Connection String checkbox. This encrypts and hides the connection
details of the database from the users that the connection string is given to.
14. If required, select the Lazy Load checkbox to not load the full project view when the model is loaded.
Instead, only the parts that are necessary to display the visible portion of the tree are loaded. This
means that a model loads faster and users can begin work sooner, but at the expense of later small
delays as Enterprise Architect loads specific portions of the model.
15. If required, select the Use WAN Optimization 180 checkbox. (To improve performance over a Wide
Area Network, remote database calls can be routed through a WAN Optimizer that compresses the
data returned from the repository, reducing transfer time.)

If you select this checkbox, complete the next three fields (see your administrator for the correct
values). Otherwise go to step 19.
16. In the Server field, type the network name or address of the optimizer server.
17. In the Port field, type the port on which the server is running on the remote machine.
18. In the DSN field, type the data source name of the database as it appears on the remote machine.
19. Click on the OK button to complete the configuration.

3.3.3.2 SQL Server Data Repository

Note:
This feature is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions.

Before you can use a SQL Server data repository, you must connect to it in Enterprise Architect. To connect to
your SQL Server data repository in Enterprise Architect, follow the steps below:
1. In the Open Project dialog 114 , select the Connect to Server checkbox.
2. Click on the [ ... ] (Browse) button, as you normally would to browse for a project. As you have selected
the Connect to Server checkbox, the Data Link Properties dialog displays instead of the Select
Enterprise Architect Project to Open dialog.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 151

3. Select Microsoft OLE DB Provider for SQL Server from the list.
4. Click on the Next>> button. The Connection tab displays.

© 1998-2010 Sparx Systems Pty Ltd

 152 Projects and Teams | Server Based Repositories

5. Type in the server details, including Server Name, User Name and Password.
6. Click on the Select the database on the server option and on the drop-down arrow. From the list,
select the model to connect to.
7. Click on the Test Connection button to confirm that the details are correct.
8. If the test succeeds, click on the OK button. If the test does not succeed, revise your settings.
9. When you click on the OK button, the Connection Name & Type dialog displays.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 153

10. In the Name field, type a suitable name for the connection so that you can recognize it in the Recent
Projects panel on the Open Project dialog.
11. If required, select the Encrypt Connection String checkbox. This encrypts and hides the connection
details of the database from the users that the connection string is given to.
12. If required, select the Lazy Load checkbox to not load the full project view when the model is loaded.
Instead, only the parts that are necessary to display the visible portion of the tree are loaded. This
means that a model loads faster and users can begin work sooner, but at the expense of later small
delays as Enterprise Architect loads specific portions of the model.
13. If required, select the Use WAN Optimization 180 checkbox. (To improve performance over a Wide
Area Network, remote database calls can be routed through a WAN Optimizer that compresses the
data returned from the repository, reducing transfer time.)

If you select this checkbox, complete the next two fields (see your administrator for the correct values).
Otherwise go to step 16.
14. In the Server field, type the network name or address of the optimizer server.
15. In the Port field, type the port on which the server is running on the remote machine.
16. Click on the OK button to complete the configuration.

3.3.3.3 Oracle Data Repository

Note:
This feature is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions.

In order to use an Oracle 9i, 10g or 11g data repository, you must connect to it in Enterprise Architect first.
You can connect using either OLE DB 153 or ODBC 156 .

Using Oracle OLE DB Provider

To connect to your Oracle data repository using the Oracle OLE DB Provider, follow the steps below:
1. In the Open Project dialog 114 , select the Connect to Server checkbox.
2. Click on the [ ... ] (Browse) button, as you normally would to browse for a project. As you have selected
the Connect to Server checkbox, the Data Link Properties dialog displays instead of the Browse
Directories dialog.

© 1998-2010 Sparx Systems Pty Ltd

 154 Projects and Teams | Server Based Repositories

3. Select Oracle Provider for OLE DB from the list.

Note:
Do not select Microsoft OLE DB Provider for Oracle; Enterprise Architect might not work as
expected.

4. Click on the Next button. The Connection tab displays.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 155

5. Enter the Data Source name (the service name of the Oracle database), the database User Name and
the Password. The Location field is not required.
6. Click on the Test Connection button to confirm that the details are correct.
7. If your test succeeded, click on the OK button.
8. If your test did not succeed, revise your settings.
9. After you have clicked on the OK button, the Connection Name and Type dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 156 Projects and Teams | Server Based Repositories

10. Give the connection a suitable name so that you can recognize it in the Recent Projects panel on the
Open Project dialog.
11. If required, select the Encrypt Connection String checkbox. This encrypts and hides the connection
details of the database from the users that the connection string is given to.
12. If required, select the Lazy Load checkbox to not load the full project view when the model is loaded.
Instead, only the parts that are necessary to display the visible portion of the tree are loaded. This
means that a model loads faster and users can begin work sooner, but at the expense of later small
delays as Enterprise Architect loads specific portions of the model.
13. If required, select the Use WAN Optimization 180 checkbox. (To improve performance over a Wide
Area Network, remote database calls can be routed through a WAN Optimizer that compresses the
data returned from the repository, reducing transfer time.)

If you select this checkbox, complete the next two fields (see your administrator for the correct values).
Otherwise go to step 16.
14. In the Server field, type the network name or address of the optimizer server.
15. In the Port field, type the port on which the server is running on the remote machine.
16. Click on the OK button to complete the configuration.

Using Oracle ODBC Driver

This process has two stages:
· Create ODBC Driver connection in Windows
· Connect to Repository in Enterprise Architect.

Create ODBC Driver Connection

1. Select the WindowsTM Control Panel | Administrative Tools | Data Sources (ODBC) option. The
ODBC Data Source Administrator window displays.

2. Click on the Add button. The Create New Data Source dialog displays, enabling you to add a new DSN.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 157

3. Select Oracle in OraDB11g_home1 (or similar, depending on the ODBC installation).

4. Click on the Finish button. The Oracle ODBC Driver Configuration dialog displays.

5. Enter the following configuration details:

· A data source name for the connection
· A description (optional)
· The TNS Service Name (click on the drop-down arrow and select from the list)
· The User ID.
6. Click on the Test Connection button and enter the Oracle user password to confirm that the details are
correct.
7. Click on the OK button to complete the ODBC connection.

© 1998-2010 Sparx Systems Pty Ltd

 158 Projects and Teams | Server Based Repositories

Connect To Repository
1. In Enterprise Architect, select the File | Open Project menu option. The Open Project dialog displays.

2. Select the Connect to Server checkbox.

3. Click on the [ ... ] (Browse) button, as you normally would to browse for a project. As you have selected
the Connect to Server checkbox, the Data Link Properties dialog displays instead of the Browse
Directories dialog.

4. Select Microsoft OLE DB Provider for ODBC Drivers from the list.
5. Click on the Next button. The Connection tab displays.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 159

6. Select the Data Source name from the drop-down list, and type in the database User Name and
Password.
7. Click on the Test Connection button to confirm that the details are correct.
8. If your test succeeded, click on the OK button; if your test did not succeed, revise your settings.
9. After you have clicked on the OK button, Oracle prompts you for the password. Enter this. The
Connection Name and Type dialog displays.

10. Give the connection a suitable name so that you can recognize it in the Recent Projects panel on the
Open Project dialog 114 .
11. If required, select the Encrypt Connection String checkbox. This encrypts and hides the connection

© 1998-2010 Sparx Systems Pty Ltd

 160 Projects and Teams | Server Based Repositories

details of the database from the users that the connection string is given to.
12. If required, select the Lazy Load checkbox to not load the full project view when the model is loaded.
Instead, only the parts that are necessary to display the visible portion of the tree are loaded. This
means that a model loads faster and users can begin work sooner, but at the expense of later small
delays as Enterprise Architect loads specific portions of the model.
13. If required, select the Use WAN Optimization 180 checkbox. (To improve performance over a Wide
Area Network, remote database calls can be routed through a WAN Optimizer that compresses the
data returned from the repository, reducing transfer time.)

If you select this checkbox, complete the next two fields (see your administrator for the correct values).
Otherwise go to step 16.
14. In the Server field, type the network name or address of the optimizer server.
15. In the Port field, type the port on which the server is running on the remote machine.
16. Click on the OK button to complete the configuration.

3.3.3.4 PostgreSQL Data Repository

Note:
This feature is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions.

In order to use a PostgreSQL data repository, you must connect to it in Enterprise Architect first. Before
connecting to the repository, you must have set up a PostgreSQL ODBC driver 138 . To connect to a
PostgreSQL data repository in Enterprise Architect, follow the steps below:
1. In the Open Project dialog 114 , select the Connect to Server checkbox, or on the Start Page, click on
the Connect to Server link.
2. Click on the [ ... ] (Browse) button, as you normally would to browse for a project. As you have selected
the Connect to Server checkbox, the Data Link Properties dialog displays instead of the Browse
Directories dialog.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 161

3. Select Microsoft OLE DB Provider for ODBC Drivers from the list.
4. Click on the Next button. The Connection tab displays.

5. Click on the Use data source name drop-down arrow and, from the list, select the ODBC driver you
have set up to connect to your PostgreSQL repository.
6. Click on the Test Connection button to confirm that the details are correct.
7. If your test succeeded, click on the OK button.
8. If your test did not succeed, revise your settings.
9. After you have clicked on the OK button, the Connection Name & Type dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 162 Projects and Teams | Server Based Repositories

10. Give the connection a suitable name so that you can recognize it in the Recent Projects panel on the
Open Project dialog.
11. If required, select the Encrypt Connection String checkbox. This encrypts and hides the connection
details of the database from the users that the connection string is given to.
12. If required, select the Lazy Load checkbox to not load the full project view when the model is loaded.
Instead, only the parts that are necessary to display the visible portion of the tree are loaded. This
means that a model loads faster and users can begin work sooner, but at the expense of later small
delays as Enterprise Architect loads specific portions of the model.
13. If required, select the Use WAN Optimization 180 checkbox. (To improve performance over a Wide
Area Network, remote database calls can be routed through a WAN Optimizer that compresses the
data returned from the repository, reducing transfer time.)

If you select this checkbox, complete the next three fields (see your administrator for the correct
values). Otherwise go to step 17.
14. In the Server field, type the network name or address of the optimizer server.
15. In the Port field, type the port on which the server is running on the remote machine.
16. In the DSN field, type the data source name of the database as it appears on the remote machine.
17. Click on the OK button to complete the configuration.

3.3.3.5 ASA Data Repository

Note:
This feature is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions.

In order to use an ASA data repository, you must connect to it in Enterprise Architect first. Before connecting
to the repository, you must have set up an ASA ODBC driver 141 . To connect to an ASA data repository in
Enterprise Architect, follow the steps below:
1. In the Open Project 114 dialog, select the Connect to Server checkbox or, on the Start Page, click on
the Connect to Server link.
2. Click on the [ ... ] (Browse) button, as you normally would to browse for a project. As you have selected
the Connect to Server checkbox, the Data Link Properties dialog displays instead of the browse
directories dialog.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 163

3. Select Microsoft OLE DB Provider for ODBC Drivers from the list.
4. Click on the Next button. The Connection tab displays.

© 1998-2010 Sparx Systems Pty Ltd

 164 Projects and Teams | Server Based Repositories

5. In the Use data source name field, click on the drop-down arrow and select the ODBC driver you set
up to connect to your ASA repository.
6. Click on the Test Connection button to confirm that the details are correct.
7. If your test succeeded, click on the OK button.
8. If your test did not succeed, revise your settings.
9. After you have clicked on the OK button, the Connection Name & Type dialog displays.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 165

10. Give the connection a suitable name so you can recognize it in the Recent Projects panel on the Open
Project dialog.
11. If required, select the Encrypt Connection String checkbox. This encrypts and hides the connection
details of the database from the users that the connection string is given to.
12. If required, select the Lazy Load checkbox to not load the full project view when the model is loaded.
Instead, only the parts that are necessary to display the visible portion of the tree are loaded. This
means that a model loads faster and users can begin work sooner, but at the expense of later small
delays as Enterprise Architect loads specific portions of the model.
13. If required, select the Use WAN Optimization 180 checkbox. (To improve performance over a Wide
Area Network, remote database calls can be routed through a WAN Optimizer that compresses the
data returned from the repository, reducing transfer time.)

If you select this checkbox, complete the next three fields (see your administrator for the correct
values). Otherwise go to step 17.
14. In the Server field, type the network name or address of the optimizer server.
15. In the Port field, type the port on which the server is running on the remote machine.
16. In the DSN field, type the data source name of the database as it appears on the remote machine.
17. Click on the OK button to complete the configuration.

3.3.3.6 MSDE Server Data Repository

Follow the steps in Connect to an SQL Server Repository 150 .

3.3.3.7 Progress OpenEdge Repository

Note:
This feature is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions.

In order to use an OpenEdge data repository, you must connect to it in Enterprise Architect first; follow the
steps below:
1. In the Open Project dialog 114 , select the Connect to Server checkbox.
2. Click on the [ ... ] (Browse) button, as you normally would to browse for a project. As you have selected
Connect to Server, the Data Link Properties dialog displays instead of the Browse Directories dialog.

© 1998-2010 Sparx Systems Pty Ltd

 166 Projects and Teams | Server Based Repositories

3. Select Microsoft OLE DB Provider for ODBC Drivers from the list.
4. Click on the Next button. The Connection tab displays.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 167

5. In the Use data source name field, click on the drop-down arrow and select the ODBC driver you have
set up to connect to your OpenEdge repository. In the setup example 145 the driver title is
openedge_ea.
6. Enter the User name and Password.
7. Enter the initial catalog.
8. Click on the All tab, and double-click on Extended Properties.
9. In the Property Value field, edit the value to: DefaultSchema=PUB.

10. Click on the Connection tab again, and click on the Test Connection button to confirm that the details
are correct.
11. If the test succeeds, click on the OK button. If the test does not succeed, revise your settings.
12. After you have clicked on the OK button, the Logon to Progress dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 168 Projects and Teams | Server Based Repositories

13. Check the details, and click on the OK button. The Connection Name & Type dialog displays.

14. Give the connection a suitable name so you can recognize it in the Recent Projects panel on the Open
Project dialog 114 .
15. If required, select the Encrypt Connection String checkbox. This encrypts and hides the connection
details of the database from the users that the connection string is given to.
16. If required, select the Lazy Load checkbox to not load the full project view when the model is loaded.
Instead, only the parts that are necessary to display the visible portion of the tree are loaded. This
means that a model loads faster and users can begin work sooner, but at the expense of later small
delays as Enterprise Architect loads specific portions of the model.
17. If required, select the Use WAN Optimization 180 checkbox. (To improve performance over a Wide
Area Network, remote database calls can be routed through a WAN Optimizer that compresses the
data returned from the repository, reducing transfer time.)

If you select this checkbox, complete the next three fields (see your administrator for the correct
values). Otherwise go to step 21.
18. In the Server field, type the network name or address of the optimizer server.
19. In the Port field, type the port on which the server is running on the remote machine.
20. In the DSN field, type the data source name of the database as it appears on the remote machine.
21. Click on the OK button to complete the configuration.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 169

3.3.4 Upsize to Access 2007

Before you set up Enterprise Architect for use with Access 2007, it is recommended that you run the project
integrity check tool 344 (select the Tools | Data Management | Project Integrity Check menu option) on the
base project to upsize to Access 2007. This ensures the project data is 'clean' before uploading.

Note:
You cannot move a model from a source .EAP file of a version earlier than 3.5.0.

Upsizing your Database

You upsize your database in two stages, as follows:

Stage One: Create the Repository

Using Access 2007, open a .EAP file and allow Access to convert it to a .ACCDB file. This forms the Access
2007 repository.

Note:
If you do not have Access 2007, you can connect by downloading the Access Database Engine from:
http://www.microsoft.com/downloads/details.aspx?FamilyID=7554F536-8C28-4598-9B72-
EF94E038C891&displaylang=en

Stage Two: Transfer the Data

1. Open Enterprise Architect. Click on the Cancel button on the Open Project screen to open with no
project loaded.
2. Select the Tools | Data Management | Project Transfer menu option. The Project Transfer dialog
displays:

3. In the Transfer Type panel, select .EAP to DBMS.

4. In the Source Project field, type the name of the .EAP file to upsize to Access 2007.

© 1998-2010 Sparx Systems Pty Ltd

 170 Projects and Teams | Server Based Repositories

5. At the right of the Target Project field, click on the [ ... ] (Browse) button. The Datalink Properties dialog
displays.
6. Select Microsoft Office 12.0 Access Database Engine OLE DB Provider from the list, then click on
the Next button.
7. On the Data Source Details page of the Connection dialog, type in the full path to the Access 2007 .
ACCDB file.
8. Click on the OK button to return to the Project Transfer dialog.
9. If required, select the Logfile checkbox and type in a path and filename for the data transfer log file.
10. Click on the Transfer button to begin the data transfer process.
When the process is complete, you have upsized your model to Access 2007 and can now open it from
Enterprise Architect.

3.3.5 Upsize to Sybase ASA

Before you set up Enterprise Architect for use with Sybase Adaptive Server Anywhere (ASA), it is recommend
that you run the project integrity check tool (select the Tools | Data Management | Project Integrity Check
344 menu option) on the base project to upsize to ASA. This ensures the data is 'clean' before uploading.

Note:
You cannot move a model from a source .EAP file of a version earlier than 3.5.0.

Warning:
Before proceeding, ensure MDAC 2.6 or higher is installed on your system.

Upsizing Your Database

You upsize your database for ASA in three stages, as follows:

Stage One: Install ASA Components

1. Install Adaptive Server Anywhere - SQL Anywhere Studio 8 or higher. This also installs the ASA ODBC
driver.
2. Create a new database for the Enterprise Architect repository using Sybase Central.
3. Create a suitable ODBC Data Source to point to your new database.

Note:
See Set up an Adaptive Server Anywhere ODBC Driver 141 .

Stage Two: Configure the Database

From Sybase Central:
1. Right-click on the newly created database.
2. Open Interactive SQL and load the ASA_BaseModel.sql file. This is available to registered users on the
Corporate edition Resources page of the Sparx website at http://www.sparxsystems.com/registered/
reg_ea_corp_ed.html.
3. Run the script to create all required data structures.

Note:
See Create a New Adaptive Server Anywhere Repository 132 .

You now have an empty database, and can transfer an existing model into the server.

Stage Three: Transfer the Data

1. Open Enterprise Architect (click on the Cancel button on the Open Project screen to open with no
project loaded).
2. Select the Tools | Data Management | Project Transfer menu option. The Project Transfer dialog
displays.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 171

3. In the Transfer Type panel, select .EAP to DBMS.

4. In the Source Project field, type the name of the .EAP file to upsize to ASA.
5. At the right of the Target Project field, click on the [ ... ] (Browse) button. The Datalink Properties dialog
displays.
6. Select Microsoft OLE DB Provider for ODBC Drivers from the list, then click on the Next button.
7. In the Use Data source name field, click on the drop-down arrow and select the ODBC Data Source
you configured to point to your new database.

Note:
See Connect to an Adaptive Server Anywhere Data Repository 162 for more information.

8. Click on the OK button.

9. If required, select the Logfile checkbox and enter a path for the data transfer log file.
10. Click on the Transfer button to begin the data transfer process.
When the process is complete, you have upsized your model to Adaptive Server Anywhere and can now open
it from Enterprise Architect.

3.3.6 Upsize to Progress OpenEdge

Before you set up Enterprise Architect for use with OpenEdge, it is recommended that you run the project
integrity check tool (select the Tools | Data Management | Project Integrity Check 344 menu option) on the
base project to upsize to OpenEdge. This ensures the data is clean before uploading.

Note:
You cannot move a model from a source .EAP file of a version earlier than 3.5.0.

Warning:
Before proceeding, ensure MDAC 2.6 or higher is installed on your system.

Upsizing Your Database

You upsize your database for OpenEdge in three stages, as follows:

© 1998-2010 Sparx Systems Pty Ltd

 172 Projects and Teams | Server Based Repositories

Stage One: Install OpenEdge Components

1. Install OpenEdge, version 10.0B3 or higher.
2. Install OpenEdge ODBC 10.0B or higher driver.
3. Create a suitable ODBC Data Source to point to your new database.

Note:
See Setup a Progress OpenEdge ODBC Driver 145 .

Stage Two: Configure the Database

1. Create an empty OpenEdge database, using the scripts OpenEdge_BaseModel.sql file. This is
available to registered users on the Corporate edition Resources page of the Sparx website at http://
www.sparxsystems.com/registered/reg_ea_corp_ed.html.
2. Make sure the new database is selected as the current database.
3. Run the script to create all required data structures.

Note:
See Create a New Progress OpenEdge Repository 134 .

Stage Three: Transfer the Data

1. Open Enterprise Architect (click on the Cancel button on the Open Project screen to open with no
project loaded).
2. Select the Tools | Data Management | Project Transfer menu option. The Project Transfer dialog
displays:

3. In the Transfer Type panel, select .EAP to DBMS.

4. In the Source Project field, type the name of the .EAP file to upsize to OpenEdge.
5. At the right of the Target Project field, click on the [ ... ] (Browse) button. The Datalink Properties dialog
displays.
6. Select Microsoft OLE DB Provider for ODBC Drivers from the list, then click on the Next button.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 173

7. In the Use Data source name field, click on the drop-down arrow and select the ODBC Data Source
you configured to point to your new database.

Note:
See Connect to a Progress OpenEdge Data Repository 165 for more information.

8. Click on the OK button.

9. If required, select the Logfile checkbox and enter a path and filename for the data transfer log file.
10. Click on the Transfer button to begin the data transfer process.
When the process is complete, you have upsized your model to OpenEdge and can now open it from
Enterprise Architect.

3.3.7 Upsize to MSDE

Before you set up Enterprise Architect for use with SQL Server Desktop Engine (MSDE), it is recommended
that you run the project integrity check tool (select the Tools | Data Management | Project Integrity Check
344 menu option) on the base project to upsize to MSDE. This ensures the data is 'clean' before uploading.

Note:
You cannot move a model from a source .EAP file of a version earlier than 3.5.0.

Warning:
Before proceeding, ensure MDAC 2.6 or higher is installed on your system.

Upsizing Your Database

Follow the steps in Upsize to SQL Server 176 to upsize your model to MSDE.

3.3.8 Upsize to PostgreSQL

Before you set up Enterprise Architect for use with PostgreSQL, it is recommend that you run the project
integrity check tool (select the Tools | Data Management | Project Integrity Check 344 menu option) on the
base project to upsize to PostgreSQL. This ensures your data is clean before uploading.

Note:
You cannot move a model from a source .EAP file of a version earlier than 3.5.0.

Warning:
Before proceeding, ensure MDAC 2.6 or higher is installed on your system.

Upsizing Your Database

You upsize your database for PostgreSQL in three stages, as follows:

Stage One: Install PostgreSQL Components

1. Install PostgreSQL, version 7.3.2 or higher.
2. Install psqlODBC, version 7.03.01.00 or higher (but do not use version 8.4.1).
3. Create a suitable ODBC Data Source to point to your new database.

Note:
See Set up a PostgreSQL ODBC Driver 138 .

Stage Two: Configure the Database

1. From the PSQL command line, or using a tool such as the PostgreSQL command line, pgAdminIII or
EMS PostgreSQL Manager, load the Postgres_Basemodel.sql file. This is available to registered users
on the Corporate edition Resources page of the Sparx Systems website.
2. Run the script to create all required data structures.

© 1998-2010 Sparx Systems Pty Ltd

 174 Projects and Teams | Server Based Repositories

Note:
See Create a New PostgreSQL Repository 129 .

You now have an empty database and can transfer an existing model into the server.

Stage Three: Transfer the Data

1. Open Enterprise Architect (click on the Cancel button on the Open Project screen to open with no
project loaded).
2. Select the Tools | Data Management | Project Transfer menu option. The Project Transfer dialog
displays.

3. In the Transfer Type panel, select .EAP to DBMS.

4. In the Source Project field, type or select the name of the .EAP file to upsize to PostgreSQL.
5. At the right of the Target Project field, click on the [ ... ] (Browse) button. The Datalink Properties dialog
displays.
6. Select Microsoft OLE DB Provider for ODBC Drivers from the list, then click on the Next button.
7. In the Use data source name field, click on the drop-down arrow and select the ODBC Data Source
you configured to point to your new database.

Note:
See Connect to a PostgreSQL Data Repository 160 for more information.

8. Click on the OK button.

9. If required, select the Logfile checkbox and type a path and filename for the data transfer log file.
10. Click on the Transfer button to begin the data transfer process.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 175

Note:
If an error message displays reporting '...nonstandard use of \\ in a string literal...', set the server variable in
the postgresql.conf file to:
escape_string_warning = off

When the process is complete, you have upsized your model to PostgreSQL and can now open it from
Enterprise Architect.

3.3.9 Upsize to Oracle 9i, 10g or 11g

Before you set up Enterprise Architect for use with Oracle, it is recommended that you run the project integrity
check tool (select the Tools | Data Management | Project Integrity Check 344 menu option) on the base
project to upsize to Oracle. This ensures your data is clean before uploading.

Note:
You cannot move a model from a source .EAP file of a version earlier than 3.5.0.

Warning:
Before proceeding, ensure MDAC 2.6 or higher is installed on your system.

Upsizing Your Database

You upsize your database for Oracle in three stages, as follows:

Stage One: Create an Empty Database

1. Install Oracle.
2. Create an empty database.

Note:
See Create a New Oracle Repository 129 .

Stage Two: Configure the Database

1. Using a tool such as the SQL*Plus or SQL Plus Worksheet, load the Oracle_BaseModel.sql file. This is
available to registered users on the Corporate edition Resources page of the Sparx Systems website.
2. Make sure the new database is selected as the current database.
3. Run the script to create all required data structures.

Note:
See Create a New Oracle Repository 129 .

You now have an empty database and can transfer an existing model into the server.

Stage Three: Transfer the Data

Note:
When transferring a project you must have permission to execute the CREATE SEQUENCE command.

1. Open Enterprise Architect (click on the Cancel button on the Open Project screen to open with no
project loaded).
2. Select the Tools | Data Management | Project Transfer menu option. The Project Transfer dialog
displays:

© 1998-2010 Sparx Systems Pty Ltd

 176 Projects and Teams | Server Based Repositories

3. In the Transfer Type panel, select .EAP to DBMS.

4. In the Source Project field, type the name of the .EAP file to upsize to Oracle.
5. At the right of the Target Project field, click on the [ ... ] (Browse) button. The Datalink Properties dialog
displays.
6. Select Oracle Provider for OLE DB from the list, then click on the Next button.
7. On the Connection page of the Data Link Properties dialog, enter the Oracle service name in the Data
Source field, and the user name and password as required.

Note:
See Connect to an Oracle Data Repository 153 for more information.

8. Click on the OK button.

9. If required, on the Project Transfer dialog, select the Logfile checkbox and type a path and file name for
the data transfer log file.
10. Click on the Transfer button to begin the data transfer process.
Once the process is complete, you have upsized your model to Oracle and can now open it from Enterprise
Architect.

3.3.10 Upsize to SQL Server

Before you set up Enterprise Architect for use with SQL Server, it is recommended that you run the project
integrity check tool (select the Tools | Data Management | Project Integrity Check 344 menu option) on the
base project to upsize to SQL Server. This ensure the project data is 'clean' before uploading.

Note:
You cannot move a model from a source .EAP file of a version earlier than 3.5.0.

Warning:
Before proceeding, ensure MDAC 2.6 or higher is installed on your system.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 177

Upsizing Your Database

You upsize your database for SQL Server in three stages, as follows:

Stage One: Create an Empty Database

1. Install SQL Server.
2. Create an empty database.

Note:
See Create a New SQL Server Repository 126 .

Stage Two: Configure the Database

1. Using a tool such as the SQL Query Analyser, load the SQL Server - Base Model.sql file. This is
available to registered users on the Corporate edition Resources page of the Sparx Systems Website.
2. Make sure the new database is the currently active database.
3. Run the script to create all required data structures.

Note:
See Create a New SQL Server Repository 126 .

You now have an empty database, and can transfer an existing model into the server.

Stage Three: Transfer the Data

Note:
When transferring a project you must have db_ddladmin permission in order to execute the SET
IDENTITY_INSERT [table] {ON | OFF} command.

1. Open Enterprise Architect (click on the Cancel button on the Open Project screen to open with no
project loaded).
2. Select the Tools | Data Management | Project Transfer menu option. The Project Transfer dialog
displays.

© 1998-2010 Sparx Systems Pty Ltd

 178 Projects and Teams | Server Based Repositories

3. In the Transfer Type panel, select .EAP to DBMS.

4. In the Source Project field, type the name of the .EAP file to upsize to SQL Server.
5. At the right of the Target Project field, click on the [ ... ] (Browse) button. The Datalink Properties dialog
displays.
6. Select Microsoft OLE DB Provider for SQL Server from the list, then click on the Next button.
7. On the Data Source Details page of the Connection dialog, type in the server name, database name
and security details as required.

Note:
See Connect to a SQL Server Data Repository 150 for more information.

8. Click on the OK button.

9. If required, select the Logfile checkbox and type in a path and filename for the data transfer log file.
10. Click on the Transfer button to begin the data transfer process.
When the process is complete, you have upsized your model to SQL Server and can now open it from
Enterprise Architect.

3.3.11 Upsize to MySQL

Before you set up Enterprise Architect for use with MySQL, it is recommended that you run the project integrity
check tool (the Tools | Data Management | Project Integrity Check 344 menu option) on the base project to
upsize to MySQL. This ensures data is 'clean' before uploading.

Note:
You cannot move a model from a source .EAP file of a version earlier than 3.5.0.

Warning:
Before proceeding, ensure MDAC 2.6 or higher is installed on your system.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 179

Upsizing Your Database

You upsize your database for MySQL in four stages, as follows:

Stage One: Install MySQL Components

1. Install MySQL version 4.0.3 or higher.
2. Install MySQL ODBC 3.51 or higher.
3. Create a suitable ODBC Data Source to point to your new database.

Note:
There are two critical non-default settings required; see Set up a MySQL ODBC Driver 135 and ensure
you select the checkboxes in step 7.

Stage Two: Select Table Type

1. If you are using InnoDB tables, set up the MySQL .ini file as required and run the MySQL - InnoDB
BaseModel script.
2. If you are using MyISAM tables, set up the MySQL .ini file as required and run the MySQL - MyISAM
BaseModel script.

Note:
If MyISAM table types are used (default), transactional support is disabled. To enable transactions you
must set up MySQL to use InnoDB tables and create the database tables as InnoDB type. Sparx
provide a suitable script to create InnoDB based repository tables, as well as the more common
MyISAM. These are available to registered users on the Corporate edition Resources page of the
Sparx website at www.sparxsystems.com/registered/reg_ea_corp_ed.html.

Stage Three: Create the Database

1. Create an empty database.

Note:
See Create a New MySQL Repository 123 .

You now have an empty database, and can transfer an existing model into the server as described below.

Stage Four: Transfer the Data

1. Open Enterprise Architect (click on the Cancel button on the Open Project screen to open with no
project loaded).
2. Select the Tools | Data Management | Project Transfer menu option. The Project Transfer dialog
displays:

© 1998-2010 Sparx Systems Pty Ltd

 180 Projects and Teams | Server Based Repositories

3. In the Transfer Type panel, select .EAP to DBMS.

4. In the Source Project field, type the name of the .EAP file to upsize to MySQL.
5. At the right of the Target Project field, click on the [...] (Browse) button. The Datalink Properties dialog
displays.
6. Select Microsoft OLE DB Provider for ODBC Drivers from the list, then click on the Next button.
7. In the Use Data source name field, click on the drop-down arrow and select the ODBC Data Source
you configured to point to your new database.

Note:
See Connect to a MySQL Data Repository 148 for more information.

8. Click on the OK button.

9. If required, select the Logfile checkbox and type a path and filename for the data transfer log file.
10. Click on the Transfer button to begin the data transfer process.
When the process is complete, you have upsized your model to MySQL and can now open it from Enterprise
Architect.

3.3.12 The WAN Optimizer

The Sparx Wide Area Network (WAN) Optimizer is a lightweight server installed on a Local Area Network
(LAN) connection to a Database Management System (DBMS) that hosts an Enterprise Architect repository.
You can configure the server to listen for client connections on a particular port; it acts as a local proxy to
execute queries and return the results in a compressed format to the client.
The WAN Optimizer significantly improves Enterprise Architect's performance in a WAN by reducing the
amount of data transmitted and, in turn, the number of network calls made.
In the following diagram, transmission between Enterprise Architect and a DBMS is depicted first without and
then with the WAN Optimizer.

Enterprise Architect User Guide

 Projects and Teams | Server Based Repositories 181

You can download the WAN Optimizer installer from the Downloads page of the Registered Users section of
the Sparx Systems website. The Wan Optimizer Service installer package provides two installable features for
the target machine:
· WAN Optimizer Service - the installer also helps register and start the service on the target machine, and
add it to the Windows Startup folder.
· WAN Optimizer Admin Client - to enable an administrator to administer and configure the service from a
remote client.
The Optimizer has its own Sparx WAN Optimizer User Guide. See that User Guide for more information on:
· WAN Optimizer Components
· Installing and Starting the WAN Optimizer Service
· Configuring the Service
· Troubleshooting.

© 1998-2010 Sparx Systems Pty Ltd

 182 Projects and Teams | Team Development

3.4 Team Development

This section describes how Enterprise Architect enables you to develop a project across a team of people, so
that each person can access the latest data without the risk of damaging or losing that data.
Topics discussed include:
· Making project data available in a distributed environment 182

· User Security 188

· The Team Review facility 208
· Workflow scripting 220
· Sharing reference data 223 .

3.4.1 Project Sharing

Enterprise Architect offers a diverse set of functionality designed specifically for sharing projects 183 in team-
based and distributed development 183 environments.
Project sharing can be achieved through network deployment of model repositories, replication, XMI Import/
Export and User Security.
Network deployment is possible under two different schemas:
· .EAP based repositories or
· DBMS server based repositories.
DBMS server based repositories offer better response times than .EAP files on networks due to the inherent
structure of the DBMS. DBMS also offers a better solution when networking problems are encountered, as
they have the ability to backtrack transactions caused by external breakdowns.

Replication
Replication 184 is a simple process that enables data interchange between .EAP based repositories and is
suitable for use in situations where many different users work independently in parallel development. Modelers
merge their changes into a Design Master only as required. It is recommended that a backup is carried out
prior to replication.
Replication cannot be performed on repositories stored on a DBMS server.

XMI Import Export

XMI Import/Export 288 can be used to model discrete packages that can be exported and shared between
developers. XMI enables the export of packages into XML files which can then be imported into any model.
Package control can be used to set up packages for version control and to enable batch export of packages
using XMI. Version Control enables a repository to be maintained by a third-party source code control
application that is used to control access and record revisions.

Security
User security 188 is used to limit the update access to model elements. It provides control over who in a
project can make changes to model elements.

Further Information
For more information regarding the use of Enterprise Architect with shared models and team deployment
please see the Deployment of Enterprise Architect white paper available from:
www.sparxsystems.com/downloads/whitepapers/EA_Deployment.pdf.

Enterprise Architect User Guide

 Projects and Teams | Team Development 183

Note:
DBMS Repository support and User Security are available with the Corporate, Business and Software
Engineering, System Engineering and Ultimate editions of Enterprise Architect.

3.4.1.1 Share Enterprise Architect Projects

Note:
Project Sharing and Replication are only enabled in the Professional, Corporate, Business and Software
Engineering, System Engineering and Ultimate editions of Enterprise Architect.

The most efficient way of using Enterprise Architect to manage a team development is to share a project
amongst a team of designers, developers and analysts.
By sharing a project, many people can work on the model at the same time and contribute their particular skill.
Team members can always see what the latest changes are, keeping the team informed and up to date with
the project status.
You can share an Enterprise Architect project in three ways:
1. Place the project in a shared network directory 183 .

2. Use replication 184 .

3. Use a shared DBMS-based repository 122 (Corporate, Business and Software Engineering, System
Engineering and Ultimate editions).

3.4.1.2 Share Projects on Network Drive

The easiest way to share a project amongst a work group of developers and analysts is to place the project file
on a shared network drive and have people connect from their workstations. Individual developers and
analysts can then open and work on the project concurrently.

Note:
Enterprise Architect accepts a number of concurrent connections without issue, although there can be
occasional 'lock-outs' when one user tries to access or update something another user is in the process of
modifying.

Network Issues
The main issues with shared network access are:
· Changes to the Project Browser (and other project views) are not automatically updated; to compensate for
this, users must occasionally reload 267 their project to see changes made by other users.
· If two or more people work on the same diagram concurrently, unexpected results can occur; it is best to
enable only one analyst to work on a diagram at a time.
· If a user's machine crashes, the network suffers an outage or a machine is turned off unexpectedly, the
project file might require repair to compensate for the sudden inconsistency; a repair 348 facility is provided
(select the Tools | Manage .EAP File | Repair .EAP File menu option) to carry out this task. This only
applies to the file-based version of Enterprise Architect; the DBMS-based version does not suffer this
problem.

3.4.1.3 Distributed Development

Enterprise Architect supports distributed development using two different techniques, as described below.

Replication
Use the Replication features to enable geographically separated analysts to update and modify parts of the
model in replicas, then merge these back together at a central location. For further information see the
Replication 184 topic.

XMI Import/Export
Use the XMI-based Import/Export 288 facility to model discrete packages, export to XML and share among the
development team. This approach has several benefits over replication:

© 1998-2010 Sparx Systems Pty Ltd

 184 Projects and Teams | Team Development

1. You can assemble a model from only the parts necessary to get your job done.
2. You can assemble a full model if required.
3. You can assemble a model from different package versions for different purposes (such as customer
visible, internal release only).
4. You can roll-back parts of a model as required.
5. There is less chance of 'collisions' between developers if each works on a discrete package.
6. The process is controllable using a version control 228 system.
Use the Import/Export context menu options 65 (below) to access this feature; they are available through
the Project | Import/Export submenu.

The Controlled Package 293 feature can also be used to assist in the process.

Note:
XMI based import/export is UML1.3 / XMI1.1 compliant. You can also write XML based tools to manipulate
and extract information from XML files to enhance the development process.

3.4.1.4 Replication
Apart from sharing Enterprise Architect projects in real time over a network, you can also share projects using
replication.
Replication is a powerful means of sharing projects between isolated or mobile users. In this scenario a
project is converted to a design master, then replicas are made of the master. Users take the replicas away,
modify the project, then bring their replicas back to be synchronized with the master file. Replication enables
different users to work independently of one another, and to merge their changes at a later time.

Note:
To avoid difficulties in this inevitably hazardous process, please read all sections of this topic carefully.

Enterprise Architect Merge Rules

Enterprise Architect follows these rules in merging:
· Additions are cumulative; that is, two replicas each creating three new Classes result in six new Classes
after merging.
· Deletions prevail over modifications; if one replica changes a Class name and other deletes the Class,
performing a merge results in both files losing the Class.
Conflicting modifications appear in the Resolve Replication Conflicts dialog (Tools | Manage EAP File |
Resolve Replication Conflicts menu option). See Resolve Conflicts 187 for details on how to deal with
conflicting modifications.

Use Replication
To use replication, follow the steps below:
1. Convert the base project to a design master 185 using the Tools | Manage .EAP File | Make Design
Master menu option.
2. Create replicas 185 from the design master using the Tools | Manage .EAP File | Create New Replica
menu option.

Enterprise Architect User Guide

 Projects and Teams | Team Development 185

3. Take the replica away and work on it as required, then bring it back for synchronization with the design
master.
4. Synchronize the replicas 186 . During synchronization, all changes to both the master and the replica are
propagated in both directions, so at the end they both contain the same information.

Upgrades and Replicas

When you upgrade your version of Enterprise Architect, you must not open a replica until you have opened
the design master and then synchronized the replicas with the master. You cannot directly upgrade a replica
186 .

Avoid Change Collisions

If two or more people make changes to the same element - for example, a Class - Enterprise Architect
arbitrarily overwrites one person's change with another's. To avoid this, different users should work on different
packages.
However, since Enterprise Architect does not enforce this rule, it is possible for users' work to conflict. To
minimize the difficulties this causes, please note the following guidelines:
· If users are likely to have worked in the same area of the model, they should both witness the
synchronization and confirm that they are happy with the net result.
· If small pieces of information have been lost, they should be typed into one of the merged models after
synchronization.
· If a large piece of information has been lost (for example, a large Class note that was overwritten by
another user who had made a minor change to the same Class) use the Resolve Replication Conflicts 187
dialog.

Disable or Remove Replication Features

If you have converted a project to a design master but now want to disable the replication 186 features, use
the Tools | Manage .EAP File | Remove Replication menu option. Make sure you back up all your files first!

3.4.1.4.1 Design Masters

A design master is the first converted Enterprise Architect project that supports replication. From the design
master you create replicas that can be modified independently of the master project and re-merged later.

Create a Design Master

To create a design master, follow the steps below:
1. Take a back-up of the required Enterprise Architect project.
2. Select the project in the Project Browser.
3. Select the Tools | Manage .EAP File | Make Design Master menu option and follow the on-screen
instructions.

3.4.1.4.2 Create Replicas

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Manage Replicas 198 permission to create a
replica.

To create a replica, follow the steps below:

1. First create a design master 185 , then select the Tools | Manage .EAP File | Create New Replica
menu option and follow the on-screen instructions.
2. This process creates a replica of the current project which can then be modified independently, and
afterwards re-merged with the main project.

© 1998-2010 Sparx Systems Pty Ltd

 186 Projects and Teams | Team Development

3.4.1.4.3 Synchronize Replicas

To copy changes from one member of the replica set to another, use the Synchronize Replicas menu option.

Notes:
· In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Manage Replicas 198 permission to synchronize
a replica.
· Information is copied both ways, including deletes, updates and inserts.

Synchronize a Replica
To synchronize a replica and a design master, follow the steps below:
1. Open the design master project file.
2. Select the Tools | Manage .EAP File | Synchronize Replicas menu option.
3. Locate and select the required replica to merge the open project and the replica.

Note:
When you synchronize, both projects end up containing identical information.

Change Collisions
Note that if two or more people work on the same element (or package or diagram) then the replication engine
has problems in resolving which change is the master. To avoid this, always work on separate areas in the
model when you are using replicas. You can also use the Tools | Manage .EAP File | Resolve Replication
Conflicts 187 menu option.

3.4.1.4.4 Remove Replication

Replication makes many changes to the database structure of your model. As a consequence the model file
becomes considerably larger with additional information.
If you no longer require a model to be replicable, you can remove all replication features.

Remove Replication
To remove replication, follow the steps below:
1. If a repository is not open, the menu option for removing replication is not enabled. A temporary
repository (not the one having replication removed) must be open at the time. Ensure you have a
repository open at the time of creation.
2. Select the Tools | Manage .EAP File | Remove Replication menu option, to open the Remove
Replication Wizard.
3. Enter the full path and file name of the project to have replication removed. Click on the Next button.
4. Enter the full path and file name of the base Enterprise Architect model (with no replication) to act as
template. Click on the Next button.
5. Enter the full path and required file name for the output file. Click on the Next button.
6. Select whether to have a log file created, and enter a file name for the log file.
7. Click on the Run button to begin removing replication. Enterprise Architect creates a new project
containing all the model information.
Your model has now had replication removed, and should be considerably smaller.

3.4.1.4.5 Upgrade Replicas

With new releases of Enterprise Architect there could be changes to the underlying project structure, such as
more tables or changed queries.
If you are using replicas to share and work with Enterprise Architect projects, it is very important that you open
the design master 185 before opening any of the replicas with an updated version of Enterprise Architect.

Enterprise Architect User Guide

 Projects and Teams | Team Development 187

Warning:
Upgrading Replicas takes special care!

Changes to the database design in a replica set can ONLY be done to the design master. Next time the
replicas are synchronized 186 with the master, the design changes are propagated through to the replicas.
Trying to update a replica first at best does nothing, and at worst causes the update of the master to fail.
One other strategy is to remove 186 replication from a copy of the replica set, upgrade that project and convert
it into a new design master from which new replicas are created.

3.4.1.4.6 Resolve Conflicts

When two or more people have changed the same element between synchronization points, Enterprise
Architect has trouble resolving which change to accept and which to discard.
A choice is made based on rules within the JET replication manager, but the discarded changes are also
stored so that you can manually override that choice.
After synchronizing replicas, open the Resolve Conflicts dialog and check that there were any conflicts. Select
whether to accept each change or use one of the discarded changes instead.

Recommendations for Resolving Conflicts

Enterprise Architect stores model information in database records. When two records have been modified in
different ways by different users, they appear in this dialog.
Normally it is not necessary or desirable to examine conflicts, since they represent relatively inconsequential
pieces of information that can very easily be modified through the normal Enterprise Architect interface; for
example, by moving a diagram element.
The only case in which this dialog should be used is where a substantial piece of information has been
overridden by another user, and you want to retrieve it. Follow the steps below:
1. In the Table with Conflicts list, click on the entry that is likely to contain the lost information.
2. Click on each entry in the Conflicting Records list.
3. When the lost information appears in the Conflict Details list, click on the Overwrite with Conflict
button.

© 1998-2010 Sparx Systems Pty Ltd

 188 Projects and Teams | Team Development

3.4.2 Configure User Security

What is User Security in Enterprise Architect?

User security in Enterprise Architect can be used to limit the access to update functions within the model.
Security in Enterprise Architect is not designed to prevent unauthorized access; rather it is intended as a
means of improving collaborative design and development by preventing concurrent editing and limiting the
possibility of inadvertent model changes by users not designated as model authors. Where user security is
enabled a password is required to log in to the model. Elements can be locked per user or per group.
With workflow administration permissions 198 , you can also develop workflow scripts 220 (using the Scripter
1660 window). Workflow scripts validate and control 220 user input.

User Security Basics

User security is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions of Enterprise Architect. It offers two policies: the standard security mode and the rigorous
security mode.
· In the standard security mode all elements are unlocked and, as necessary, a user can set a user or group
lock on any element or set of elements in order to make changes and protect those changes.
· Under the rigorous security mode an Enterprise Architect model is read-only and nothing in the model can
be edited until explicitly checked out with a user lock.
For more detailed information on the security policies see the Security Policy 190 topic.

User Security Tasks

A number of security tasks can only be performed by users with Administrative rights to the model. These
tasks include:
· Set Security Policy 190
· Enable Security 189
· Maintain Users 191
· Import User IDs From Active Directory 192
· Change User Passwords 202
· Assign User To Groups 194
· View All User Permissions 196
· Maintain Groups 197
· View and Manage Locks 200
· Password Encryption 200 (for the third-party DBMS connection password; only available for Oracle and
SQL Server Repositories for Enterprise Architect releases prior to 7.1)
· Create Workflow Scripts. 220
Other Security tasks can be performed by users who do not have Administrative rights. These tasks include:
· Lock Model Elements 204
· Lock Packages 205
· Apply a User Lock 205
· Identify Who Has Locked An Object 207

· Locked Element Indicators 206

· Manage Your Own Locks 207
· Change Your Own Password 202

Notes:
· User security is not enabled by default in Enterprise Architect; you must enable it 189 first.
· For a number of operations in Enterprise Architect, if security is enabled a user must have the appropriate
user or group access permission to perform the operation. However, if security is not enabled, the user
does not have to have access permissions. See the List of Available Permissions 198 topic.

Enterprise Architect User Guide

 Projects and Teams | Team Development 189

3.4.2.1 Enable Security

User security is not enabled by default in Enterprise Architect. To enable security for a project in Enterprise
Architect for the first time, follow the steps below.
1. Access the Registered Users section of the Sparx Systems website (
http://www.sparxsystems.com/registered/reg_ea_corp_ed.html), and obtain the Authorization Key. (You
must have the Registered Users login and password to access this web site.)
2. In Enterprise Architect, select the Project | Security | Enable Security menu option. The Enter
authorization dialog displays

3. In the Enter authorization key field, type the authorization key from the Sparx Systems website.
4. If required, select the Automatically apply Exclusive Edit Locks to diagrams checkbox.

Note:
In standard (User/Group Locking) security mode 190 , this option blocks multiple users from
simultaneously attempting to modify the same diagram. As a user modifies a diagram, Enterprise
Architect automatically applies a User Lock to the diagram, preventing any other user from modifying it.
It is creating difference between the database and buffer versions of the diagram that triggers the
temporary lock, and elimination of difference that releases the lock. Therefore, Enterprise Architect
releases the lock when:
· The user saves the changes to the diagram, with the Save icon or keyboard keys
· The user undoes the last remaining action in the Undo list
· The user saves or discards changes via the system prompt when they close the diagram.
If the diagram already has a User Lock or Group Lock that does not exclude the current user, this lock
is set aside and saved when the temporary User Lock is applied. When the temporary User Lock is
released, the pre-existing lock is restored.
The option is ignored in Require User Lock security mode.

5. Click on the OK button. Security is enabled, and an Admin user and user group are created with full
permissions (all access rights listed in List of Available Permissions 198 ) and a password of password.

6. Select the Project | Security | Login as Another User menu option, and log in as Admin with the
initial password of password.

Note:
To change the Admin password, see the Change Password 202 topic.

© 1998-2010 Sparx Systems Pty Ltd

 190 Projects and Teams | Team Development

7. Set up users and permissions as required.

Note:
Once security has been enabled, you must have the Security - Enable/Disable 198 access right to
turn it off. The initial administrator automatically has this access right.

8. To disable security, click on the Enable Security menu option, and again type the authorization key in
the Authorization dialog. Click on the OK button. Security is disabled.

Notes:
· The system prompts you to log off the project and log on again, but this is not strictly necessary.
· To re-enable security, follow the procedure above, but be aware that any changes you have made to
the admin user (password and reduced access rights) are reset to password and full access.
· The Automatically apply Exclusive Edit Locks to diagrams option is not displayed when
disabling security. Therefore, to toggle the setting whilst security is enabled you must disable
security and re-enable it. Security settings (users, groups and permissions) and locks on elements,
are NOT affected by this action.

3.4.2.2 Security Policy

There are two possible security policies in Enterprise Architect:
1. In the User/Group Locking mode, all elements and diagrams are considered unlocked and anyone can
edit any part of the project. However, when you edit a diagram, package or element, you lock the
element or set of elements at either the user level or group level. This mode is good for cooperative
work groups where there is a solid understanding of who is working on which part of the model, and
locking is used mainly to prevent further changes or to limit who has access to a part of the model.
2. The Require User Lock mode is more rigorous. The Enterprise Architect model is read-only - everything
is locked so that nobody can edit anything unless they explicitly check out the object with a user lock. A
single 'check out' function operates on a diagram to check out the diagram and all contained elements
in one go. There are also functions on the context (right-click) menus of packages, diagrams and
elements in the Project Browser to apply a user lock when this mode is in use. You would use this mode
when there is a strict requirement to ensure only one person can edit a resource at one time. This is
suitable for much larger projects where there might be less communication between users.
Toggle between these modes using the Project | Security | Require User Lock to Edit menu option -
deselected for User/Group Locking mode, and selected for Require User Lock mode.

Notes:
· When you add new elements in Mode 1 (Require User Lock to Edit deselected, elements editable by
default), no user lock is created automatically for the newly created element.
· When you add new elements in Mode 2 (Require User Lock to Edit selected, elements locked by
default), a user lock is created on the new element to enable instant editing.

Enterprise Architect User Guide

 Projects and Teams | Team Development 191

3.4.2.3 Maintain Users

If you enable security you have access to the Security Users dialog, which you can use to set up more users
for your model.

Note:
You must have Security - Manage Users 198 permission to maintain users, and Change Password 198
permission to change the password of the current user; the initial Admin administrator automatically has
these permissions.

Set Up a User
To set up a user for your model, follow the steps below:
1. Select the Project | Security | Manage Users menu option. The Security Users dialog displays.

2. You can use the Security Users dialog to set up new users by providing their name and other details.
You can also import user IDs from a Windows Active Directory 192 , assign User IDs to groups 194 , set
up Single Permissions 195 or View All 196 permissions for the currently selected user.
3. To identify a new user on this dialog, click on the New button and type in the user's login ID, first name
and last name. If required, also provide the user's department name.
4. To set the user's password, click on the Change Password button. The Change Password dialog
displays.

© 1998-2010 Sparx Systems Pty Ltd

 192 Projects and Teams | Team Development

5. In the New password field, type the user's password. This must be 12 characters or less in length.
6. In the Retype new field, type the user's password again, for confirmation.
7. Click on the OK button.
8. A 'Password Changed' message displays. Click on the OK button.
9. When you have entered the details for the user, click on the Save button. Either click on the New button
to add another user, or the Close button to exit the Security Users dialog.

Notes:
· You can transport the user definitions between models, using the Export Reference Data 223 and Import
Reference Data 225 options on the Tools menu.
· If you select the Accept Windows Authentication checkbox, when a user opens the model Enterprise
Architect checks the users database for their Windows ID and, if it matches, automatically logs the user in
without prompting for a password.
· The Accept Windows Authentication checkbox enables the Import button, which you can select to
import user IDs from a Windows Active Directory.
· As a security measure, the Accept Windows Authentication checkbox is automatically deselected if the
project .eap file is moved to a different location. Once the file has been relocated, you can select the
checkbox again to apply Windows authentication from the new database.

3.4.2.4 Import User IDs From Active Directory

You can import your Enterprise Architect security user IDs from Windows Active Directory.
When you import the user IDs, you should create an appropriate user group 197 and assign the user IDs to
that group. You can then assign appropriate permissions to the group. When a user logs in to Enterprise
Architect under their Windows login ID, they do not have to enter a password; Enterprise Architect
automatically generates a random password. However, you can assign a new password to an imported user
ID if required.
To import user IDs from a Windows Active Directory, follow the steps below:
1. On the Security Users dialog select the Accept Windows Authentication checkbox and click on the
Import button. The Import Users dialog displays.

2. On the Import Users dialog, click on the down arrow in the Security Group field and select the
appropriate security group for the imported user IDs.
3. Click on the Add button. The Select Users screen displays.

Enterprise Architect User Guide

 Projects and Teams | Team Development 193

4. Click on the Object Types button, and on the Object Types dialog select the checkbox for the type of
object to import from the Active Directory. Click on the OK button to return to the Select Users dialog.
5. Click on the Locations button, and on the Locations dialog browse for and select the checkbox for the
location to import from within the Active Directory. Click on the OK button to return to the Select Users
dialog.
6. In the Enter the object names to select field, either:
· type in the user IDs individually (click on the examples link to see examples of the correct formats)
or
· click on the Advance button to search for IDs; the Select Users dialog redisplays with a Common
Queries tab.

© 1998-2010 Sparx Systems Pty Ltd

 194 Projects and Teams | Team Development

7. In the Name and Description fields, type any characters or text that helps identify the IDs you are
searching for. Click on the drop-down arrow of the Starts with field and select the appropriate qualifier.
8. If required, select the Disabled accounts or Non-expiring password checkboxes, and/or select a
value in the Days since last logon field, to further filter the IDs to search for.
9. Click on the Find Now button to initiate the search, and to display a list of IDs in the bottom panel of the
dialog. You can vary the types of information shown here by clicking on the Columns button and
selecting the column headings to display.
10. When you have identified the IDs to import, click on a required ID (or press [Ctrl] or [Shift] while you
click to select several) and click on the OK button. The Select Users dialog redisplays, with the selected
ID or IDs listed in the Enter the object names to select field.
11. Click on the OK button to redisplay the Import Users dialog with the selected users' names listed in the
Users panel.
12. Click on the Import button to add the user IDs to the Security Users dialog. Click on a user ID to
populate the dialog fields with the user ID details, and set group permissions 197 as required.

3.4.2.5 Assign User To Groups

To set up user groups follow the steps below:
1. Select the Project | Security | Manage Users menu option. The Security Users dialog displays.
2. Click on the Group Membership button. The User Groups dialog displays.
3. Select the checkbox against each group this user belongs to.

Enterprise Architect User Guide

 Projects and Teams | Team Development 195

4. Click on the OK button to assign the user to each group.

Notes:
· You must have Security - Manage Users 198 permission to assign users to groups; the initial Admin
administrator automatically has this permission.
· To create new user groups, see the Maintain Groups 197 topic.
· You can transport these user groups between models, using the Export Reference Data 223 and Import
Reference Data 225 options on the Tools menu.

3.4.2.6 Set Up Single Permissions

You can set specific user permissions from the User Permissions dialog.
Specific user permissions are added to permissions from group membership to provide an overall permission
set.

Note:
You must have Security - Manage Users 198 permission to assign permissions to users; the initial Admin
administrator automatically has this permission.

To set up single permissions for a user follow the steps below:

1. Select the Project | Security | Manage Users menu option. The Security Users dialog displays.
2. Click on the Single Permissions button. The User Permissions dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 196 Projects and Teams | Team Development

3. Select the checkbox against each specific permission to apply to this user. Click on the Select All
button to select all permissions for the user, or click on the Deselect All button to clear all selected
permissions.
4. Click on the OK button to assign the selected permissions to the user.

Notes:
· A user's total permissions are those granted by Group Membership plus those granted by specific
permission assignment.
· You can transport these user permissions between models, using the Export Reference Data 223 and
Import Reference Data 225 options on the Tools menu.

3.4.2.7 View All User Permissions

The All user permissions dialog shows a list of all permissions a user has, derived from their individual profile
and from their membership of security groups.
To display the dialog, select the Project | Security | Manage Users menu option, then select the required
user and click on the View All button.

Enterprise Architect User Guide

 Projects and Teams | Team Development 197

3.4.2.8 Maintain Groups

Security groups make it easy to configure sets of permissions and apply them to a number of users in one
action.

Notes:
· You must have Security - Manage Users 198 permission to manage user groups; the initial Admin
administrator automatically has this permission.
· You do not define groups as group logins with passwords. If you intend to use a group login, you can
define a single-user login and password 191 that all group members use (that is, Enterprise Architect allows
multiple logins under one user ID).

Set Up a Security Group

To set up a security group, follow the steps below:
1. Select the Project | Security | Manage Groups menu option. The Security Groups dialog displays.

2. In the Group Name and Description fields, type the security group name and a description of the
group.
3. Click on the Save button.

Note:
You can transport these security group definitions between models, using the Export Reference Data 223
and Import Reference Data 225 options on the Tools menu.

3.4.2.9 Set Group Permissions

Note:
You must have Security - Manage Users 198 permission to assign permissions to user groups; the initial
Admin administrator automatically has this permission.

To set up permissions to apply to a security group, follow the steps below:

1. Select the Project | Security | Manage Groups menu option. The Security Groups dialog displays.
2. Click on the Set Group Permissions button. The Group Permissions dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 198 Projects and Teams | Team Development

3. Select the checkbox against each required permission. Click on the Select All button to select all
permissions for the user, or click on the Deselect All button to clear all selected permissions.
4. Click on the OK button to assign the permissions. All of the users assigned to this group share in this
set of permissions.

Note:
You can transport these group permission definitions between models, using the Export Reference Data 223
and Import Reference Data 225 options on the Tools menu.

3.4.2.10 List of Available Permissions

The following table lists the available permissions in the Corporate, Business and Software Engineering,
System Engineering and Ultimate editions of Enterprise Architect.
These permissions are required for the corresponding operations if security is enabled.

Note:
Some permissions take precedence over others. For example, if you set Use Version Control permission for
a user, that user can modify model elements on import even if they do not have Update Element permission.

Permission Enables the user to

Administer Database Compact 348 and repair 348 a project database.

Admin Workflow Develop and manage workflow scripts 220 .

Audit Settings Change the audit settings in the Audit Settings 271 dialog.

Audit View Enable auditing and display data in the Audit View 276 and Audit History 278
tab.

Baselines - Manage Create, delete, import and export Baselines 279 .

Baselines - Restore Merge data 279 into the project model from a Baseline or XML file.

Change Password Change your own password 202 or (Administrator) another user's password.

Check Data Integrity Check and repair project integrity 344 .

Configure Datatypes Add, modify and delete datatypes 666 .

Enterprise Architect User Guide

 Projects and Teams | Team Development 199

Permission Enables the user to

Configure Images Configure alternative element images 447 .

Configure Packages Configure controlled packages 295 and package properties.

Configure Resources Create and manage Resources 667 window items: RTF templates, patterns,
profiles, favorites.

Configure Stereotypes Add, modify and delete Stereotypes 662 .

Configure Version Control Set up version control options 234 for the current model.

Export XMI Export 289 a model to XMI.

Generate Documents Generate RTF 1569 and HTML 1647 documents from model packages.

Generate Source Code and Generate source code 1308 and DDL 1367 from a model element. Synchronize
DDL 1327 code against model elements if it already exists.

Import XMI Import 290 a model from XMI.

Lock Objects Lock an element 204 or package 205 .

Manage Diagrams Create 422 new diagrams, copy existing 436 and delete 434 diagrams. Also
save a diagram as a UML Pattern 902 .

Manage Issues Update and delete Issues 332 .

Manage Project Information Update and manage resources 313 , metrics and risks.

Manage Reference Data - Update and delete reference items 644 .

Update

Manage Replicas Create 185 and synchronize 186 replicas.

Manage Tests Update and delete Test records 1537 .

Reverse Engineer from DDL Reverse engineer 1328 from source code or ODBC, and synchronize model
and Source Code elements against code.

Security - Enable/Disable Disable 189 user security in Enterprise Architect.

Security - Manage Locks View and delete 200 element locks.

Security - Manage Users Maintain users 191 , groups 194 and assigned permissions 195 .

Spell Check Spell check 1552 package and set spell check language.

Transfer Data Transfer model 307 between different repositories.

Transform Package Perform transformations 1385 of packages and elements.

Update Diagrams Update diagram appearance, properties 423 and layout, including the Page
Setup 455 dialog 455 .

Update Element Save model changes (including delete) for elements 522 , packages 387 ,
and relationships 609 .

Use Version Control Check files in and out 261 using version control.

© 1998-2010 Sparx Systems Pty Ltd

 200 Projects and Teams | Team Development

3.4.2.11 View and Manage Locks

From time to time it might be necessary to examine or delete locks placed on elements by users. Enterprise
Architect provides a function to view and manage active locks.

Notes:
· You must have Security - Manage Locks 198 permission to view and delete user locks; the initial Admin
administrator automatically has this permission.
· If an element is locked, connectors attached to it are also locked. To unlock the connector, you must
unlock the element. However, under certain circumstances you can add new connectors to a locked
element 204 .

Delete a Lock
To view locks and, if necessary, delete them, follow the steps below:
1. Select the Project | Security | Manage Locks menu option. The Active Locks dialog displays.

2. In the View Locks For panel, click on the radio button for the type of lock to view: All, Groups Only or
Users Only. Locks of the appropriate type are listed in the Active Locks panel. If you want to display the
resulting information in a more readable layout, you can resize the dialog and its columns.
3. To remove a lock, click on it and click on the Unlock Selected button.
4. When finished, click on the Close button to close the dialog.

3.4.2.12 Password Encryption

Note:
This topic is retained to support regression to releases of Enterprise Architect prior to version 7.1. For
password encryption for all repositories at and beyond release 7.1, see the Model Shortcuts 115 topic.

Enterprise Architect User Guide

 Projects and Teams | Team Development 201

Users of SQL Server or Oracle repositories have the option of encrypting the password used to set up the
connection between Enterprise Architect and the repository.
The Enterprise Architect user does not have the real password, thereby preventing them from accessing the
repository using other tools such as Query Analyzer or SQLPlus. Once security is enabled, the administrator
must log on to access the dialog to create encrypted passwords.
To encrypt a password, follow the steps below:
1. Select the Project | Security | Encrypt Password menu option. The following dialog displays:

2. In the example above, the password password123 is used to access the repository.
3. To connect Enterprise Architect to the repository, the user enters the encrypted password prefixed with
$$, so the encrypted password becomes $$qcvtyrsf435.
For more information relating to connecting to Oracle and SQL Server, see the Connect to Oracle Data
Repository 153 and Connect to SQL Server Data Repository 150 topics respectively.

Notes:
· Do not use the Test Connection button as it can cause an error with encrypted passwords.
· For SQL Server repositories, you must enter the Initial Catalog details from the All tab of the Data Link
Properties dialog.

© 1998-2010 Sparx Systems Pty Ltd

 202 Projects and Teams | Team Development

3.4.2.13 Change Password

There are two ways in which a user's password can be changed, when security is set:
· A user can select the Change Password menu option and change their own password
· The Administrator can set or change any user's password, on the Maintain Users dialog.

Note:
A user must have Change Password 198 permission to change a password; the initial Admin administrator
automatically has this permission.

User Change
If security is set and you want to change your own password, follow the steps below:
1. Select the Project | Security | Change Password menu option. The Change Password dialog displays.

2. In the Enter old password field, type your current password.

3. In the New password field, type your new password (this must be 12 characters or less in length).
4. In the Retype new field, type your new password again, for confirmation.
5. Click on the OK button.
Enterprise Architect User Guide
 Projects and Teams | Team Development 203

6. A 'Password Changed' message displays. Click on the OK button to clear the message.
Your new password is effective next time you log in.

Administrator Change
To set or change any user's password, follow the steps below:
1. Select the Project | Security | Manage Users menu option. The Security Users dialog displays.

2. Click on the user name in the Users: panel, to display the user details in the dialog fields.
3. Click on the Change Password button. The Change Password dialog displays.

4. In the New password field, type the user's password; this must be 12 characters or less in length.

Note:
You do not have to enter the user's current password, as they might have forgotten it and therefore it is
possible that nobody can provide that value.

5. In the Retype new field, type the user's password again, for confirmation.
6. Click on the OK button.
7. A 'Password Changed' message displays. Click on the OK button.

© 1998-2010 Sparx Systems Pty Ltd

 204 Projects and Teams | Team Development

3.4.2.14 Lock Model Elements

Note:
When security is enabled, you must have Lock Objects 198 permission to lock an element.

You can lock:

· A package, element or diagram using the corresponding Lock context menu option in the Project Browser,
and
· An element or diagram using the corresponding Lock context menu option in the diagram.
Under the standard security policy (Require User Lock to Edit deselected), when you select the Lock option
the Element Lock dialog displays:

The four lock options available are:

· No lock - do not lock this element; clear any existing lock
· Full lock - lock this element so that no-one can edit it
· User lock - lock this element so that only the locking user can make further edits
· Group lock - lock this element so that any member of the specified group (in the GroupID field) can
update the element, but others are excluded.
Select the appropriate lock and click on the OK button.

If the item is already locked, only the appropriate lock option and No lock are available. You have to release
the lock in order to set a different type of lock.
Under the rigorous security policy, a different dialog displays. See the Apply a User Lock 205 topic.
If a diagram is locked and you select an object on it, the object border displays in red. This indicates that you
cannot change the object.

3.4.2.15 Add Connectors To Locked Elements

When working with locked elements, the ability to add connectors depends on the locked status of the source
and target elements. The rules are:
· Source unlocked, target unlocked: any kind of connector can be added
· Source unlocked, target locked: allowed, except for composition connectors
· Source locked, target unlocked: prohibited, except for composition connectors
· Source locked, target locked: prohibited for all connectors.
That is, a connector can be added if its source is unlocked, regardless of the locking state of the destination
(think of it as modifying what the source can see). The exception is composition connectors, where the target
(that is, parent) must be unlocked (think of it as modifying the parent by adding children).
Connectors with locked source or target elements are also locked. To unlock the connector, you must unlock
200 the source and/or target element.

Enterprise Architect User Guide

 Projects and Teams | Team Development 205

3.4.2.16 Lock Packages

Note:
If security is enabled you must have Lock Objects 198 permission to lock a package.

You can lock all the contents of a package (and optionally all contents in child packages) in one step, using
the Lock Package function.
The locks are automatically applied to elements and to diagrams, as if they had been individually set or
cleared. Lock types and details are the same as for locking a single element 204 .

Lock a Package
To lock a package, follow the steps below:
1. Deselect the Project | Security | Require User Lock to Edit menu option.
2. In the Project Browser, right-click on the package to lock. The context menu displays.
3. Select the Lock Package menu option. The Lock/Unlock Package(s) dialog displays.

4. In the Lock Type panel, select the appropriate radio button for the lock to apply.
5. As required, select the checkboxes to lock elements and/or diagrams, and to process child packages
(that is, lock the whole branch).
6. Click on the OK button to apply the lock.

3.4.2.17 Apply a User Lock

In the Require User Lock to Edit 190 security mode, where a User Lock is required before any edit can occur,
you can set or release the lock in either a diagram or the Project Browser.
Enterprise Architect adjusts the lock for the element, or for the diagram and any elements contained in the
diagram.
In a diagram, you right-click on the element or diagram; in the Project Browser, you right-click on the package,
diagram or element. In each case, select the Apply/Release User Lock context menu option for the selected
item. The following dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 206 Projects and Teams | Team Development

Select the appropriate radio button to apply or release a user lock on the selected item.

Note:
For a package, you can elect to also lock all child packages at the same time. If any elements in the package
tree are locked by other users, a list of elements that couldn't be locked displays at the end of the process.

3.4.2.18 Locked Element Indicators

When an item is locked through Project Security, the lock is indicated in the Project Browser by a marker
against the item, as shown below.

The meaning of the marker depends on the security mode.

If you are using the Require User Lock to Edit 190 security mode:
· No marker - there is no lock, the item is not editable, but any user can now apply a user lock 205 to edit the
item

Enterprise Architect User Guide

 Projects and Teams | Team Development 207

· Blue exclamation mark - the current user has applied a user lock and can edit the item; no other user can
edit the item
· Red exclamation mark - another user has applied a user lock, and the current user cannot edit the item.
If you are using the standard 190 security mode:
· No marker - there is no lock, the item is editable, but any user can now apply a user or group lock 205
· Blue exclamation mark - the item has a lock set by the current user or a group having the current user as a
member, and the user can edit the item
· Red exclamation mark - the item has a lock set by another user, or a group of which the current user is not
a member; the current user cannot edit the item.
If another user has locked an item, you can identify who has locked it 207 .

Note:
If a diagram is locked and you select an object on it, the object border displays in red. This indicates that you
cannot change the object.

3.4.2.19 Identify Who Has Locked An Object

If you find that a diagram, package or element is locked, you can find out which group or user currently holds
the lock on that item.
To do this, follow the steps below:
1. In the Project Browser, right-click on the diagram, package or element that is locked by another user or
user group. The context menu displays.
2. Select the Lock menu option.

A message box displays showing which group or user currently holds the lock on that item.

3.4.2.20 Manage Your Own Locks

You can view and delete your own user-level locks in Enterprise Architect. This is especially useful when
working in Mode 2 security 190 (user locks required to edit).
To manage your locks select the Project | Security | My Locks menu option. The My Locks dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 208 Projects and Teams | Team Development

In the My Locks dialog you can select one or more locks and delete them (that is, unlock the object) by
clicking on the Unlock Selected button.

3.4.3 Team Review Tools

The Enterprise Architect Project Team Review facility can be used to discuss the development and progress
of a project.
To access the Team Review, either:
· Select the View | Team Review menu option, or
· Press [Ctrl]+[Alt]+[U].

The Team Review facility has three main displays:

· The Team Review window is used to create new Categories 211 and Topics 212 and to delete 215
messages, using a context menu 209 . This is a dockable 75 window. Each item in the hierarchy displays a
mouse-over tooltip, showing the item title, the author's name and the date and time the item was created.
· The Team Review tab, in the main work area, is used to view, print, create 213 , edit 215 , and reply to 214

Enterprise Architect User Guide

 Projects and Teams | Team Development 209

review Posts. This tab has a status bar that shows the item author's name, the date and time the item was
created, and the date and time the item was last modified.
· The linked objects panel, located at the bottom of the Team Review tab, is used to associate model
elements 216 , diagrams, external files and other postings, with a review posting.
You can create text to explain Categories and Topics, and you can create and respond to Posts and replies.
To display or edit the text on the Team Review tab, click on the item name in the Team Review window.
Using the Search icon in the Team Review toolbar, you can also search for text strings in the item titles 217 , to
enable you to locate posts on a specific topic.
As well as linking elements and diagrams to a Post, you can also add resources 217 to a Category, Topic or
Post. Such resources, which include diagram images and XMI files of packages, are held in a Resources
folder under the selected Team Review item.

The icons beside the review items have the following meanings:

Post read

Post unread

Reply read

Reply unread

Category (name in bold indicates category is unread)

Topic read

Topic unread

Resources folder for a Category, Topic or Post

Diagram or clipboard image within Resources folder

XMI File of package, within Resources folder.

3.4.3.1 Context Menu

The Team Review context menu enables you to access the following functions.

Option Use to

New Category Add a new Category 211 , new Topic 212 or new Post 213 to the Team Review.
New Topic
Alternatively, for a Topic or Post, click on the New icon in the window toolbar.
New Post

New Category From Add a new Category 211 , new Topic 212 or new Post 213 , based on a defined
Template template.
New Topic from
Template
New Post from Template

Post Reply Create a reply 214 to the selected Post.

Alternatively, click on the New icon in the window toolbar.

Rename [F2] Edit the name, in situ, of the currently-selected item.

Copy Path to Clipboard Copy the path 218 of the currently-selected item to the clipboard.

Show Contents Display the description or text of the selected item in the Team Review window,
if the Team Review tab is not yet open.

Share Resource (If anything other than a Resources 217 folder is selected.)

© 1998-2010 Sparx Systems Pty Ltd

 210 Projects and Teams | Team Development

Option Use to

Add a package from the current model, or an image of the currently-displayed

diagram, or an image from the clipboard, to the Resources folder under the
selected Category, Topic or Post. If the Resources folder does not exist, this
option creates it.

Add Package From (If a Resources 217 folder is selected.)

Current Model
Export a package as an XMI file from the current model as a resource of the
selected Category, Topic or Post.
You browse for and select the required package using the Select <item> 515
dialog.

Import to Current Model (If a package XMI file resource is selected.)

Import the resource package to the current model.
You browse for and select the required target package using the Select <item>
515 dialog. The resource is imported as a child of that package.

This is a useful option for transferring relevant packages from the Team Review
of one model into another model.

Add Image of Active (If a Resources 217 folder is selected.)

Diagram
Add an image of the currently-displayed diagram as a resource of the selected
Category, Topic or Post.
You are prompted to provide a reference name for this image.

Add Active Profiler (If a Resources 217 folder is selected.)

Report
Add an active Profiler Report 1519 as a resource of the selected Category, Topic
or Post.
You are prompted to browse for and select the appropriate active report.

Image From Clipboard (If a Resources 217 folder is selected.)

Add an image held on the clipboard as a resource of the selected Category,
Topic or Post.

View Image (If a diagram image resource 217 is selected.)

Open the View Image window, containing an image of the selected diagram.
Alternatively, double-click on the image name.

Copy Image To (If an image resource 217 is selected.)

Clipboard
Copy the image or diagram image to the clipboard.

Refresh Category 'xyz' Refresh the currently-open Category, Topic or Post, getting new replies, Posts
Refresh Topic 'xyz' and Topics that other users might have created. However, if you open another
Refresh Post 'xyz' Category, Topic or Post the Team Review always displays the latest information
from the database.
Alternatively, click on the Refresh icon in the window toolbar.

Reload Current Reload the entire Team Review connection, getting new Categories, Posts and
Connection Topics.

Review Status Assign or clear a status marker against the selected Category, Topic or Post.
You can mark the item as:
· Awaiting Approval
· Approved
· Rejected
Or clear the marker (None).

Enterprise Architect User Guide

 Projects and Teams | Team Development 211

Option Use to

Mark See the Mark submenu, below.

Connections... Access other Team Reviews 218 from other Enterprise Architect models or
models located on servers.
Alternatively, click on the drop-down arrow in the Connection Options field in
the window toolbar, and select one of the listed models. The <Configure
Connections> option enables you to add and connect to additional Team
Reviews.

Options... Change the loading behavior 218 of the Team Review.

Delete Category <xyz> Delete 215 this Category, Topic, Post or reply and all sub-topics and sub-posts,
Delete Topic <xyz> or delete the resource attached to the item.
Delete Post <xyz>
Delete Resource <xyz>

The Mark Submenu

All items as Read Mark the entire contents of the Team Review as read 209 .

All items as Unread Mark the entire contents of the Team Review as unread 209 .

Branch as Read Mark this item and all its contents as read.

Branch as Unread Mark this item and all its contents as unread.

'xyz' as Unread Mark only this item as unread.

3.4.3.2 Add a New Category

To create a new Category, follow the steps below:

1. Right-click on a blank area in the Team Review window and select the New Category context menu 209
option. A new Category icon displays in the hierarchy.

2. Type the name of the Category in the field just after the icon, and click off the name. The Category
description is displayed in the Team Review tab. Type the appropriate Category description as required.

Alternatively:

1. Right-click on a blank area in the Team Review window and select the New Category from template
context menu 209 option. A new Category icon displays in the hierarchy.
2. Type the name of the Category in the field just after the icon, and click off the name. The Create New
Category dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 212 Projects and Teams | Team Development

3. Click on the Copy template drop-down arrow and select a predefined template for the Category
description.
4. Click on the OK button.
5. The Category description is displayed in the Team Review tab. Amend the Category description within
the template, as required.
The Category is now available to add new topics 212 .

3.4.3.3 Add a New Topic

To create a new Topic, follow the steps below:
1. Either:
· Right-click on the appropriate Category name in the Team Review window and select the New Topic
context menu 209 option, or
· Click on the Category name and on the New icon in the Team Review toolbar, or
· Click on the Category name and press [Ctrl]+[N].
A new Topic icon displays in the hierarchy.

2. Type the name of the Topic in the field just after the icon, and click off the name. The Topic description
is displayed in the Team Review tab. Type the appropriate Topic description as required.

Alternatively:

1. Right-click on the appropriate Category name in the Team Review window and select the New Topic
from template context menu 209 option. A new Topic icon displays in the hierarchy.
2. Type the name of the Topic in the field just after the icon, and click off the name. The Create New Topic
dialog displays.

Enterprise Architect User Guide

 Projects and Teams | Team Development 213

3. Click on the Copy template drop-down arrow and select a predefined template for the Topic
description.
4. Click on the OK button.
5. The Topic description is displayed in the Team Review tab. Amend the Topic description within the
template, as required.
The topic is now available for you or any other user to create Posts 213 concerning the Topic, in the Team
Review window.

3.4.3.4 Add a New Post

To create a new Post on a Topic in the Team Review, you have three options:
· Create a blank Post
· Create a Post based on a predefined template
· Create a Post from a file link.
When you have created the Post you can create and edit text in it. You can also create links 216 to elements
and diagrams from the Project Browser, Model Search 1231 dialog, Model Views 1222 window and Element List
1255 , or you can link to related Team Review Categories, Topics or Posts. You can also insert links to external

files, either in the text of the Post or in the links panel.

When you have saved the Post, other users can then reply to it 214 .

Blank Post
To create a blank message into which you can type text exactly as you require, follow the steps below:
1. Either:
· Right-click on the appropriate Topic name in the Team Review window and select the New Post
context menu 209 option, or
· Click on the Topic name and on the New icon in the Team Review toolbar, or
· Click on the Topic name and press [Ctrl]+[N].
A new Post icon displays in the hierarchy.

2. Type the name of the Post in the field just after the icon, and click off the name. The Post text is
displayed in the Team Review tab.

© 1998-2010 Sparx Systems Pty Ltd

 214 Projects and Teams | Team Development

Post Based On Template

To create a structured Post based on a predefined template, follow the steps below:
1. Right-click on the appropriate Topic name in the Team Review window and select the New Post from
template context menu 209 option. A new Post icon displays in the hierarchy.
2. Type the name of the Post in the field just after the icon, and click off the name. The Create New Post
dialog displays.

3. Click on the Copy template drop-down arrow and select a predefined template for the Post contents.
4. Click on the OK button.
5. The template structure is displayed in the Team Review tab.

Post From External File Link

To create a Post based on a link to an external file, follow the steps below:
1. Open a file browser (such as Windows Explorer) and locate the file.
2. Click on the file name and drag it onto the appropriate Topic name in the Team Review window.
A 'New Post' item is created underneath the selected Topic, and the body of the Post is created in the Team
Review tab. A link to the source file is created at the start of the message.
You can create and edit text around the file link, and add further links if required. You should also rename the
'New Post' item, by clicking twice on it.

3.4.3.5 Reply to a Post

To reply to a post, follow the steps below:
1. Either:
· Right-click on the Post name in the Team Review window and select the Post Reply context menu
209 option, or

· Click on the Post name and on the New icon in the Team Review toolbar, or
· Click on the Post name and press [Ctrl]+[N].
A 'Re:<Postname>' entry displays in the Team Review hierarchy, underneath the Post you are replying
to, and the cursor becomes active in the Team Review tab to enable you to create and edit 215 your
response.
2. Type in, format and save the contents of the reply.

Alternatively:
1. Open a file browser and locate the required file.
2. Drag the file name onto the Post to which you are replying. A 'Re:<Postname>' entry displays in the
Team Review window underneath the Post, and the body of the reply is created in the Team Review
tab. A link to the source file is created at the start of the message.
3. You can create and edit text around the file link, and add further links if required.

You can also create links to 216 elements and diagrams in the Project Browser, Model Search 1231 dialog,
Model Views 1222 window and Element List 1255 , or you can add related Team Review Categories, Topics or
Posts. You can also insert other links to external files, either in the text of the Post or in the links panel.
Other users can reply to the Post and to your response.

Enterprise Architect User Guide

 Projects and Teams | Team Development 215

3.4.3.6 Edit an Item

To edit a Category, Topic, Post or reply, simply click on the item text in the Team Review tab.
The cursor becomes active in the Team Review tab to enable you to edit 215 your response. Modify any
relevant details.
If it is just the name of the item that requires changing, click on the name and press [F2]. You can now retype
the name in place.

Delete Team Review Items

To delete a Category, Topic, Post or reply, right-click on the item in the Team Review window and select
Delete <item> <name> from the context menu 209 .
Alternatively, click on the item and press [Delete].

A confirmation dialog displays. Click on the Yes button; the item and any dependent items are removed from
the Team Review.

3.4.3.7 Team Review Editor

The Team Review Editor provides the means for creating and editing explanatory text for Categories 211 and
Topics 212 , and message text for Posts 213 and Replies 214 .

The editor provides a set of standard functions that you access by right-clicking on the text, to display a
hierarchy of context menus. The following topics provide assistance on using the Team Review Editor.
· Scroll Through Text 1588
· File and Print Options 1588
· Cut and Paste Options 1589
· Image and Object Imports 1591
· Character Formatting 1592
· Paragraph Formatting 1593

© 1998-2010 Sparx Systems Pty Ltd

 216 Projects and Teams | Team Development

· Tab Support 1595

· Page Breaks and Repagination 1595
· Insert Headers and Footers 1596
· Insert Bookmarks 1596
· Table Commands 1597
· Sections and Columns 1599
· Stylesheets and Table of Contents 1600
· Text/Picture Frame and Drawing Objects 1604
· Search/Replace Commands 1605
· Hyperlink From Linked Document 601
· Create Elements From Linked Documents 602

When you have completed your editing, select the File | Save menu option and then click on another item in
the Team Review window to exit the message.
The text is saved in the Team Review item. To display the text in the Team Review tab, click on the item once.

3.4.3.8 Add Object Links

In the Team Review tab you can create hyperlinks to elements and diagrams that are associated with a Post.
This enables rapid navigation to the objects in the Project Browser, access to the element properties and, with
diagrams, the ability to open the diagram directly from the Team Review. You can also create links to:
· Other Categories, Topics and Posts in the Team Review window
· External files from a file browser.
To associate an element, diagram or Team Review item with the message, drag the object from the Project
Browser, Element List, Model Views window, Model Search dialog or Team Review window into the linked
elements panel at the bottom of the Team Review tab.
To associate an external file with the message, click on and drag the file name from any browser into either
the linked elements panel or the text of the message itself (although they behave in exactly the same way).
The filename becomes a link to the file; click on it to display the contents of the file.
The external file name also becomes a link to the file within the message when you drag the filename onto a
Topic to create a post 213 .

To access the navigation options of each object in the linked elements section, right-click on the object to
display the navigation context menu. The options are outlined in the table below.

Enterprise Architect User Guide

 Projects and Teams | Team Development 217

Option Use to

Open Open the diagram or external file.

Properties Display the element properties for the selected element.

Find in all Diagrams Open the diagram in which the element is used, or display a list of several diagrams
in which the element has been used.

Delete Link Delete the association between the message and the object.

3.4.3.9 Team Review Resources

You can add resources to a Category, Topic or Post within the Team Review window. These resources
include:
· XMI files of packages within the current project
· Active Profiler reports
· Images of currently-active diagrams.
The resources are created in a Resources folder underneath the selected Category, Topic or Post, as
illustrated below:

You create the Resources folder by creating a resource underneath the selected Category, Topic or Post.
Similarly, you delete the Resources folder by deleting the last resource within it. Having added a resource, you
can reimport the package XMI files to the model or display the diagram images
All Team Review resource management tasks are performed using options on the Team Review context
menu 209 .

3.4.3.10 Search Team Review

The Team Review provides the facility to search the titles of all Team Review items, to enable you to locate
items referring to a specific subject.
To do this, follow the steps below:

1. In the Team Review window toolbar, click on the Search icon ( ). The search panel displays
underneath the toolbar.

© 1998-2010 Sparx Systems Pty Ltd

 218 Projects and Teams | Team Development

2. In the blank field, type the text string to search for.

3. If required, select the Match Case checkbox to locate text with the same case as the search string.
4. If required, select the Match Whole Word checkbox to locate only complete words that match the
search string.
5. Click on the Find button. The search locates the first instance of the search string in the title of a
Category, Topic, Post or Reply item, and displays the contents of that item in the Team Review tab.
6. To locate further instances of the text string, click on the Find button again.
7. To close the search panel, click on the Search icon in the toolbar again.

3.4.3.11 Copy Path to Clipboard

To copy the current path in the Team Review window to the clipboard, right-click on the appropriate item in the
window and select the Copy Path To Clipboard context menu 209 option. Alternatively, press [Ctrl]+[C].
The clipboard now contains the path to the selected item in the Team Review. You can paste the path into a
document or file to add the discussion to any text concerning the item.

3.4.3.12 Team Review Options

To change the loading behavior of the Team Review, right-click on the Team Review window and select the
Options context menu option. The Team Review Server Options dialog displays.

From here you can:

· Mark All Unread - Resets all posts you have read to 'unread' (bolds all items in the Team Review)
· Load item data when required - The fastest loading option; Team Review data is only loaded on demand
- for example, when you read a post
· Preload all data - Caches the entire contents of the Team Review on load; this takes longer to load but,
once completed, navigating the Team Review is faster.

3.4.3.13 Team Review Connections

The Connections option enables you to access other Team Reviews from other Enterprise Architect models,
including models located on servers.
There are two methods of accessing other Team Reviews:
· Through the Team Review Toolbar
· From the Team Review context menu options.

Toolbar
To switch to another Team Review via the toolbar, follow the steps below:
1. Click on the drop-down arrow in the Connection Options field in the toolbar.
2. Select the appropriate model name from the list to connect to the Team Review for that model.
3. If the required model is not listed, click on the <Configure Connections> option. The Team Review
Server Connections dialog displays.
4. Go to step 4 219 of the procedure below.

Context Menu Option

To switch to another Team Review via the Team Review context menu, follow the steps below:

1. Right-click anywhere in the Team Review window and select the Connections context menu option.
The Team Review Server Connections dialog displays.

Enterprise Architect User Guide

 Projects and Teams | Team Development 219

2. In the list in the Connections panel, select the check box against the appropriate model name to
connect to the Team Review for that model.
3. Click on the Open button. The connection now switches to the Team Review in the selected model.
4. If the required model is not listed, select the appropriate Connection Type radio button and click on the
New button.
· For a .eap file, a browser dialog displays through which you can search for and select the
appropriate model.
· For a model in a DBMS data repository, the Microsoft Data Link dialogs display, which enable you to
locate and connect to the repository.
5. When you have selected and opened or connected to the required Enterprise Architect model, and
returned to the Team Review Server Connections dialog, the model name displays in the Connection
Name field and in the Connections panel.
6. Select the check box against the model name and click on the Open button to connect to the Team
Review for that model.
The Team Review now shows the discussion in the selected model.
For further details of the fields and buttons on the Team Review Server Connections dialog, refer to the table
below.

Option Use To

Connection Name Verify the name of the selected model.

Connection Type Specify the type of Enterprise Architect model: a local .EAP file (as above) or a
model on a remote server 147 .

Target Model Verify the path to the selected model.

New Create a new Team Review connection.

Delete Delete the currently selected connection from the Connections list.

Connections List all Team Review connections created. Click on the checkbox against the
required connection.

Open Switch the Team Review to the one selected in the Connections list.

© 1998-2010 Sparx Systems Pty Ltd

 220 Projects and Teams | Team Development

3.4.4 Workflow Scripts

Enterprise Architect enables you to create workflow scripts 220 that provide a robust approach to applying
company policy and strengthening project development guidelines, by validating against the policy and
procedures within the model itself.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Admin Workflow 198 permission to develop and
manage workflow scripts.

Project Governance
Good corporate governance relies on well written and transparent project development guidelines and
company policy. A project might be compromised if the appropriate policies and procedures are poorly
understood and not followed correctly - effective governance can be hampered by human error and the costs
of recovering from the inadequate compliance of developers.
Company policy and procedures can be integrated with the development process to manage work flows,
determine access rights, extend role based security permissions and respond to property change events. This
approach reduces compliance costs, enhances collaborative development and gives you confidence that
projects are being developed correctly the first time around. Development teams can adhere to best practice
guidelines that govern model validation, change management, access controls and general development
principles.
Project administrators can write scripts to manage the way users interact with a model, such as managing
security, staff compliance and model access, and monitoring changes made by users. Administrators can
also use workflow scripts to control a user's capacity to change a model element, taking into account factors
such as access rights, group membership and even the value of a proposed change.
When a model is launched, the Workflow Engine is initialized with the current user and group memberships.
This information determines who can access and modify parts of a given model. When a selected event
occurs, the script engine is initialized with values including the author's name and access rights, and the
element name and version details. The workflow script implements rules governing change management,
access control and model validation. If a user attempts to make changes in violation of company policy, the
script denies the update. The user is notified why the validation failed and the activity is logged. These
reminders help to reinforce company policy, reduce human error and provide management with valuable
project feedback.

3.4.4.1 Workflow Script Functions

Workflow scripts are executed by the Enterprise Architect workflow engine, to manage user input. You write
the scripts in the Scripter 1660 window, in VBScript, under the Workflow group type 1663 .

Note:
If you make changes to a workflow script listed in the Scripter window, click on the Refresh Scripts button in
the Scripter window toolbar to reload the script with the changes.

Functions Enterprise Architect Calls to Validate and Control User Input

For each of the following functions that Enterprise Architect calls, a set of objects 221 are filled.

Function Use to... Return Value

AllowPhaseUpdate(OldValue, Validate a change a user has

NewValue) made to a phase.
· True to allow this user to make this
AllowStatusUpdate(OldValue, Validate a change a user has change.
NewValue) made to a status. · False to disallow the change and
revert to the previous value.
AllowTagUpdate(TagName, Validate a change a user has
OldValue, NewValue) made to a Tagged Value.

AllowVersionUpdate(OldValue Validate a change a user has

Enterprise Architect User Guide

 Projects and Teams | Team Development 221

Function Use to... Return Value

, NewValue) made to a version.

CanEditPhase() Enable or disable the control for

editing a phase.
· True to allow this user to make
CanEditStatus() Enable or disable the control for changes by enabling the control.
editing a status.
· False to completely disable edit of
Enable or disable the control for this property by disabling the control.
CanEditTag(TagName)
editing a Tagged Value.

CanEditVersion() Enable or disable the control for

editing a version.

PreAllowPhaseUpdate(OldVal
ue, NewValue)
Determine what information is Semi-colon separated list of additional
required to validate this change. data required in order to validate this
PreAllowStatusUpdate(OldVal
change. See the list of supported data
ue, NewValue) types 221 .
PreAllowTagUpdate(TagName
, OldValue, NewValue)

PreAllowVersionUpdate(OldV
alue, NewValue)

Functions Enterprise Architect Calls to Create a Search With User Tasks

Function Use to... Return Value

GetWorkflowTasks Describe the searches that Ignored

this user must run.

Supported Data Types

Tests - fill the Tests array in the WorkflowContext object.

Workflow Data Structures - Objects Enterprise Architect Fills

WorkflowUser
This object provides information about the user currently logged in to the model. It is filled by Enterprise
Architect before any function is called by Enterprise Architect. It has the following properties:
· Username - the username for login to the system (if using Windows Authentication, this matches the
Windows username)
· Firstname - as found in the Security Users 191 dialog
· Surname - as found in the Security Users dialog
· Fullname - the combination <Firstname> <Surname> (the form Enterprise Architect uses for Author
fields and similar).
This object also calls the following function:

Function Use to... Return Value

IsMemberOf(GroupName) Check group membership of True if the current user is a member of the
the current user. group with the specified name.

WorkflowContext
This object provides information about the object currently in context. It is filled by Enterprise Architect before
any searches except GetWorkflowTasks 221 are run. It has the following properties:

© 1998-2010 Sparx Systems Pty Ltd

 222 Projects and Teams | Team Development

· MetaType - the type of the current object, either an Enterprise Architect core type or a profile-specified
metatype
· Name - as found in the object Properties dialog
· Status - as found in the object Properties dialog
· Phase - as found in the object Properties dialog
· Version - as found in the object Properties dialog
· GUID - the GUID of the object
· Stereotypes - an array of strings for the stereotypes applied to this object
· Tags - an array of Tagged Values, providing:
· Name - the Tagged Value name
· Value - the Tagged Value value
· Tests - an array of tests; only filled during an Allow* call after the PreAllow* call has specified that tests are
required. Provides the following details, as found in the Testing 1537 window:
· Name
· Status
· RunBy
· CheckedBy
· TestClass
· TestType
The WorkflowContext object also calls the following function:

Function Use to... Return Value

TagValue(TagName) Get the value from a named Returns the value of the first Tagged Value
tag. with that name, or an empty string if no
Tagged Value with that name exists.

Workflow Data Structures - Objects You Can Fill

WorkflowStatus
Use this to provide information on the status of the object.
· LogEntry - set to True or False, to indicate whether a log item should be recorded
· Reason - indicate what reason should be recorded in the log
· Action - indicate how to display the log message; valid values are: MessageBox, StatusBar, Output
(default).

WorkflowSearches
Provides an array of searches. Use Redim WorkflowSearches(x) to specify the number of searches being
provided. Each search has the following attributes:
· Name - the name of this search
· Group - the name of the group that this search should appear under in the Search combo box
· ID - the unique GUID for this search
· Tasks - the array of tasks that this search looks for; an entry describes how to find all objects required to
meet a particular task:
· Name - the name of the task, as displayed in the Search view; workflow searches are grouped by this
field by default
· Conditions - an array of conditions, all of which must be matched for an object to be included in this
task; a condition is a comparison of a single field to a value:
· Column - the name of the field
· Operator - operator types, either = (provide matching values only) or <> (provide non-matching
values only)
· Value - if this contains a comma, the string is treated as a comma separated list of values to
compare against; otherwise the string is a single value to compare against.

Enterprise Architect User Guide

 Projects and Teams | Team Development 223

Functions Enterprise Architect Provides For You to Call

Enterprise Architect provides the subfunction SetLastError( message, outputMethod ) for you to call, to log
and/or report the provided message to the user.
You can also call the following functions:

Function Use to... Return Value

NewSearch(name, group, guid, Create a new search object to be The created search.
taskcount) included in WorkflowSearches.
Initializes each member.

NewTask(name, conditioncount) Create a new task object to be The created task.

included in a search. Initializes each
member.

NewCondition(column, operator, Create a new condition object to be The created condition.

value) included in a task. Initializes each
member.

3.4.5 Sharing Reference Data

Reference data 644 (including Glossary and Issue information) can be exported to and imported from .XML
files for convenient update of models.
You can automatically 226 or manually 225 import data into the model from a reference data .XML file, exported
223 from another model or an iteration of the current model. The automatic import is conditional on there
being changes to the source file since the last import, but you can also configure Enterprise Architect to
display a prompt for you to allow or cancel the import.
Examples of where exporting and importing reference data can be useful include:
· Copying glossaries from one model to another
· Adding additional stereotype profiles by merging new stereotypes into the model
· Updating reference data from files supplied by Sparx Systems as a maintenance release
· Copying resources, clients and so on from one model to another.

3.4.5.1 Export Reference Data

When reference and project data is exported, Enterprise Architect writes it out to a custom XML file. This
includes table information, filter information, rows and columns.

Procedure
To export data, follow the steps below:
1. Select the Tools | Export Reference Data menu option. The Data Exporter dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 224 Projects and Teams | Team Development

2. From the Name list, select the table to export. You can select one or more tables for a single file.
3. Click on the Export button.
4. When prompted to do so, enter a valid file name with a .XML extension.
This exports the data to the file. You can use any text or XML viewer to examine this file.
The data exported includes all instances of the data type in the project; for example, all defined cardinality
values, or all RTF Style Templates.

Note:
If there are no instances of a selected data type in the project, the export does not generate any output for
that data type in the XML file.

For information on each category of data you can export, refer to the following topics:
· ActionScript Code Templates 1302 ; entries for code templates are listed only if templates for a particular
language exist in the model. The list entry has the format <language_name>_Code_Templates.
· Automation Scripts 1660 (JavaScript, JScript and VBScript)
· Cardinality Types 665
· Constraint Status Types 656
· CSV 300 Specifications
· Defined Metric Types 320
· Defined Problem Types 660
· Diagram Matrix Profiles 444 (Model Profiles)
· Estimation - Environment Complexity Factor Values 337
· Estimation - Technical Complexity Factor Values 336
· General Constraint Types 655
· General Effort Types 319
· Import Component Types 1337
· Linked Document Templates 603
· Macro List 1344 (Preprocessor macros)
· Maintenance Types 660 (both Problem Types and Test Types)
· Model Authors 645
· Model Data Types - Code 666 and DDL 1367
· Model Images 447
· Project Clients 651
· Project Glossary 323
· Project Issues 331

Enterprise Architect User Guide

 Projects and Teams | Team Development 225

· Project Resources 650

· Project Roles 648
· Project Tasks 329
· Property Types 1166 (Tagged Value Types)
· Risk Types 322
· Scenario Types 658
· Security - Group Permission 197
· Security - Groups 197
· Security User Groups 194
· Security - User Permissions 195
· Security - Users 191
· Standard Complexity Types - currently, these cannot be directly edited and are therefore effectively
standard for all models; they can be listed using the Predefined Reference Data Tagged Value type 1169
ComplexityTypes.
· Status Colors 653 (the colors defined for status types)
· Status Types 653
· Status - Applies To 653 (elements to which the status can be applied)
· Stereotypes 1093 (all those listed on the Stereotypes page of the UML Types dialog)
· Templates - HTML Style (exports the web templates 1649 listed in the Templates folder of the Resources
window)
· Templates - HTML Style Detail (exports the content of the HTML report templates)
· Templates - RTF Document (exports the Extended RTF Style templates 1578 in the Templates folder of the
Resources window)
· Templates - RTF Style (exports the Legacy RTF Style templates 1634 in the Templates folder of the
Resources window)
· Templates - RTF Style Detail (exports the content of the RTF templates)
· Templates - RTF Tag and Language Options (exports RTF word substitution 1637 templates)
· Test Types 661

3.4.5.2 Import Reference Data

You can import reference data into your model in Enterprise Architect, from a reference data .xml file exported
from another model or from an iteration of the current model, either:
· Manually 225 , as required, whenever you know there is new or changed data to apply, or
· Automatically 226 whenever the model is reloaded into Enterprise Architect (if the file has changed since
the previous import).
When you import data into Enterprise Architect, the system merges the incoming data with the existing data. If
a record already exists it is updated to the new values. If the record does not exist, Enterprise Architect adds a
new record. Enterprise Architect never deletes records.
For a list and explanation of the data types you could import, see the Export Reference Data 223 topic.

Import Data Manually

To import data manually, follow the steps below:
1. Select the Tools | Import Reference Data menu option. The Import Reference Data dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 226 Projects and Teams | Team Development

2. Click on the Import File tab and on the Select File button, then select the filename to import data from.
This must be an XML file produced by the Enterprise Architect Data Exporter 223 .
3. If you have entered the name of a valid file, a list of available tables to import displays in the Select
Datasets to Import panel.
4. Click on one or more of the tables to import (press [Ctrl] or [Shift] to click on multiple tables).
5. Click on the Import button to start the process. A message displays when the import is complete.
Generally the process is quite fast.

Import Data Automatically

The automatic import checks if the source file has changed since the last import; if the file has not changed,
the import does not proceed. If the file has changed the changed data is imported; however, you can configure
Enterprise Architect to display a prompt for you to allow or cancel the import.
To set up the system to check and import reference data automatically whenever your model is reloaded into
Enterprise Architect, follow the steps below:
1. Select the Tools | Import Reference Data menu option. The Import Reference Data dialog displays.
Click on the Shared File tab.

Enterprise Architect User Guide

 Projects and Teams | Team Development 227

2. If you are changing an existing configuration to import from a different .XML file, click on the Clear
button to clear the dialog fields.
3. Click on the Select File button and browse for the filename to import data from. This must be an XML
file produced by the Enterprise Architect Data Exporter 223 .
4. If you have entered the name of a valid file, a list of tables to import displays in the Datasets in File
panel.
5. If you prefer to control whether or not the automatic import takes place, select the Always prompt
before import checkbox.
6. Click on the Import button to import the reference data now, and to enable the automatic check and
import for subsequent reloads.

© 1998-2010 Sparx Systems Pty Ltd

 228 Projects and Teams | Change Management

3.5 Change Management

This section describes the tools and facilities for controlling and monitoring changes to the data in a project.
In Change Management, you configure and maintain:
· Version Control of packages
· Tracking changes
· The transfer of data between projects in similar or different databases

Version Control For Models

Enterprise Architect Model version control 228 enables you to:
· Coordinate sharing of packages between users, with either read-only access or update access, ensuring
that work on different areas of the model is coordinated and synchronous rather than conflicting
· Save and retrieve a history of changes to packages.
To use version control in Enterprise Architect, you require a third-party source-code control application such
as Subversion, CVS, or any other version control product that complies with the Microsoft Common Source
Code Control standard.

Tracking Changes
Enterprise Architect provides two separate but complementary facilities for tracking changes 269 to data
across the project:
· Auditing of model changes
· Baselining and differencing to capture and roll back changes

Project Data Transfer

Enterprise Architect enables you to transfer project data 306 between project data repositories, row by row,
table by table.

Note:
This feature is available in the Corporate, Business and Software Engineering, Systems Engineering and
Ultimate editions.

See Also
· Project Data Integrity 344
· Model Maintenance 344
· Team Development 182
· Spell Checking 1552
· Reference Data 644
· Upgrading Projects 346

3.5.1 Version Control

Enterprise Architect supports version control of packages and their component sub-packages to a central
version control repository. You can place any individual packages, View nodes or model root nodes under
version control.
To read a discussion on why you would use Version Control in Enterprise Architect, the benefits it brings and
how you might apply it, see the Version Control Best Practices for Enterprise Architect white paper.

Enterprise Architect User Guide

 Projects and Teams | Change Management 229

Features
Version Control provides two key facilities:
· Coordinating sharing of packages between users
· Saving a history of changes to Enterprise Architect packages, including the ability to retrieve previous
versions.

See Also
· Introduction 229
· Version Control Setup 233
· Use Version Control 256

3.5.1.1 Introduction
This section discusses some factors you should consider when setting up and using version control in your
model development, including:
· System Requirements and Configuration 229

· Version Control Usage 230

· Version Control Basics 230
· Version Control and Reference Data 231
· Applying Version Control to Models 231
· Version Control & Team Deployment 232
· Project Browser Indicators 233

3.5.1.1.1 System Requirements and Configuration

Version controlled packages are packages that have been configured for use with version control software.
To use version control in Enterprise Architect, a third-party source-code control application is required that
controls access to and stores revisions of the controlled packages. Enterprise Architect supports the following
version control applications:
· Subversion, which is available from http://www.subversion.tigris.org/
· CVS, which is available from http://www.march-hare.com/cvspro/
· Microsoft Team Foundation Server
· SCC-compatible products; all version control products that provide a client that complies with the Microsoft
Common Source Code Control standard, version 1.1 or higher.

The following products are SCC-compatible and are known to successfully integrate with Enterprise
Architect:

- Accurev Tested by Sparx

- Borland Star Teams Users report success
- ClearCase Users report success
- MS Visual Source Safe Tested by Sparx
- MS TFS-SCC Tested by Sparx
- MKS Source Integrity Tested by Sparx
- Perforce Tested by Sparx
- Serena Dimensions Users report success
- Serena Change Manager Users report success
- Snapshot CM Tested by Sparx
- SourceGear Vault Tested by Sparx
- Source Offsite Tested by Sparx

Products that do not appear in the list should still integrate successfully with Enterprise Architect, if there is
a client available for that product that complies with the MS SCC API specification.

© 1998-2010 Sparx Systems Pty Ltd

 230 Projects and Teams | Change Management

Configuration
Before using Enterprise Architect's version control facility, your version control software must be installed on
each machine on which it is intended to be used.
Typically there are:
· A server component that manages a version control repository, and
· Client components on the workstations that Enterprise Architect uses to communicate with the server.
A version control client must be installed on every machine where you run Enterprise Architect and want to
access your version control system. Once the version control software has been installed and configured, you
must define a Version Control Configuration within Enterprise Architect, to use your installed version control
product.

Note:
Sparx Systems strongly urge you not to manipulate version controlled package files outside of Enterprise
Architect. It is possible to leave the package files in a state that Enterprise Architect cannot recognize.

3.5.1.1.2 Version Control Usage

There are four basic ways in which the version control facility might be used:

Use Description

Single Shared model Users share an Enterprise Architect model, stored in a central .EAP file or DBMS
repository. This configuration enables you to view changes to other users' packages
without explicitly having to check them out, but by simply refreshing your view of the
model.
· Version control regulates access to packages, and maintains package revision
history.
Multiple Private An Enterprise Architect model is created by a single user who configures it for
models version control. The model file is then distributed to other users, with each user
storing their own private copy of the model.
· Users update their model's packages through version control
· Version control regulates access to packages, and maintains package revision
history
· Other users' new packages are retrieved using the Get Package menu option.
Shared packages Individual users create separate Enterprise Architect models but share one or more
packages.
· Users share packages through version control.
Standard packages A company might have a standard set of packages which are broadly shared (on a
read-only basis).
· Individual users retrieve packages with the Get Package menu option.

For a discussion of how each of these arrangements might be used, see the Version Control Best Practices
for Enterprise Architect white paper.

3.5.1.1.3 Version Control Basics

The Lock-Modify-Unlock Solution

Many version control systems use a lock-modify-unlock model to address the problem of different authors in a
shared source overwriting each other's work.
In this model, the version control repository allows only one person to change a file at a time, and access is
managed using locks. Harry must lock a file before he can begin making changes to it. If Harry has locked a
file, Sally cannot also lock it, and therefore cannot make any changes to that file. All she can do is read the
file, and wait for Harry to finish his changes and release the lock. After Harry unlocks the file, Sally can take
her turn in locking and editing the file.

Enterprise Architect User Guide

 Projects and Teams | Change Management 231

The Copy-Modify-Merge Solution

Subversion, CVS and a number of other version control systems use a copy-modify-merge model as an
alternative to locking.
In this model, each user's client contacts the project repository and creates a personal working copy—a local
reflection of the repository's files and directories. Users then work simultaneously and independently,
modifying their private copies. In due course, the private copies are merged together into a new, final version.
The version control system often assists with the merging, but ultimately a person is responsible for making it
happen correctly.

When Locking is Necessary

While the lock-modify-unlock model is generally considered a hindrance to collaboration, there are still times
when locking is necessary.
The copy-modify-merge model is based on the assumption that files are contextually merge-able: that is, the
files in the repository are line-based text files (such as program source code). But for files with binary formats,
such as artwork or sound, it is often impossible to merge conflicting changes. In these situations, it really is
necessary for users to take strict turns in changing the file. Without serialized access, somebody ends up
wasting time on changes that are ultimately discarded.

3.5.1.1.4 Version Control and Reference Data

Reference data 644 is data that is used across a model or project; it is not package-specific.
Version control in Enterprise Architect operates at package level, and therefore does not capture changes in
reference data. Where version control is used in a shared packages 230 or multiple private model 230 set up,
changes in reference data are not brought into the model when the package is checked in.
To ensure that changes in reference data are shared between users in a version-controlled project, you should
periodically export 223 the reference data from the model where the changes were made, and import 225 it into
the other models maintained by the team.

Note:
Reference data is exported and imported as an XMI file, which contains whatever types of reference data you
want to transfer (see the list of data types in the Export Reference Data 223 topic).
It might be useful to include, in your project management processes, version-control of this XMI file through
your version control software, external to Enterprise Architect.

3.5.1.1.5 Apply Version Control To Models

All Enterprise Architect models are stored in databases - even the .EAP file is an MS Jet database.
In simple, version control terms, the model is a single entity of binary data. It is not practical to apply version
control to the database as a whole. Being binary data, it would require the use of the lock-modify-unlock model
230 of version control, which would mean that only a single user at a time could work on any given (version
controlled) model.
To overcome this limitation, Enterprise Architect exports discreet units of the model - the packages - as XMI
package files, and it is these XMI files, not the .EAP file, that are placed under version control. The XMI file
format used by Enterprise Architect dictates that they too be treated as binary files (therefore it is not possible
to merge the XMI files either); however, by splitting the model into much smaller parts, this approach enables
many users to work on separate parts of the model simultaneously.
When a user checks-out 261 a package, Enterprise Architect sends a command to the version control system
to check-out the equivalent XMI file. The version control system then puts the latest revision of the file into the
user's working copy directory, overwriting any previous revision of the file in that directory. Enterprise Architect
then imports the package file into the model, updating the contents of the existing package in the model.
When checking-in 261 , Enterprise Architect exports the package as an XMI file, overwriting the existing local
working copy of the file. The new file is then checked-in to the version control system.

Nested Version Controlled Packages

Nested version controlled packages result in much smaller XMI files being exported for parent packages, as
the parent packages' XMI files do not contain any content for the version controlled child packages.

© 1998-2010 Sparx Systems Pty Ltd

 232 Projects and Teams | Change Management

Version Control of nested packages 236 together with a model structure having small individual packages also
provides greater scope for multiple users to work concurrently, as individual users are locking much smaller
parts of the model.

Notes:
· Do not place your .EAP files under version control, as this creates problems for you.
· Most version control systems mark their controlled files as read only, unless they are specifically
checked-out to you.
· The .EAP file is an MS Jet database, and Enterprise Architect must be able to open this file for read/write
access when you load your model. (Enterprise Architect displays an error message and fails to load the
model if it is read-only.)

3.5.1.1.6 Version Control & Team Deployment

Team deployment and the use of version control is discussed in two Sparx Systems white papers, available on
the Sparx Systems web site:
· Version Control Best Practices for Enterprise Architect
· Deployment of Enterprise Architect
A brief summary of the process is provided below:
1. Install your version control product.
2. Create a version control repository.
3. Create a version control project to be used with your Enterprise Architect project, and check-out a
working copy of the project into a local folder. (You must do this for every team member that is
accessing the version controlled packages, whether you are using a single shared model or each team
member stores his own private copy of the model.)
4. Within Enterprise Architect, define a version control configuration 233 to provide access to the working
copy files. Again, each user must do this on their own workstation, as the details are stored within the
Windows registry.
5. Configure packages 259 within the Enterprise Architect model for version control. That is, apply version
control to individual packages.
6. Check-out and check-in packages 261 as required.

Note:
The name of the version control configuration must be the same across all machines. That is, all version
control access to a given Enterprise Architect package must be through version control configurations with
the same name, across all models and all users. (It is possible to use multiple version control configurations
within the same model, so different packages can still use different version control configurations within the
same model, as long as any given package is always accessed via the same version control configuration.)

The easiest way to perform step 4, (throughout the team), is to have one user set up version control on the
model and then share that model with the rest of the team.
· In Shared Model deployment, all users connect to a single instance of the model database, so the model is
shared automatically.
· In Private Model deployment, it is easiest to distribute copies of the original model (after version control has
been set up) to all other members of the team.
Whenever you open a model (Private or Shared 230 ) that uses a version control configuration that is not yet
defined on your workstation, Enterprise Architect prompts you to complete the definition for that configuration.
This typically means specifying the local working copy directory and maybe choosing the version control
project associated with this Enterprise Architect project.
Once this has been done, the version controlled packages that already exist in the model are ready for use.

Version Control Branching

Currently, Enterprise Architect does not support Version Control Branching. Work-arounds to achieve similar
results might be possible for certain version-control products; contact Sparx Support for advice:
· Registered users - http://www.sparxsystems.com/registered/reg_support.html
· Trial users - [email protected].

Enterprise Architect User Guide

 Projects and Teams | Change Management 233

3.5.1.1.7 Project Browser Indicators

Packages under version control are identified in the Project Browser by icons that indicate the current status of
the package.

Icon Indicates that...

This package is controlled 293 and is represented by an XMI file on disk. Version
control either is not being used or is not available. You can edit the package.

This package is version controlled and checked out 261 to you, therefore you can
edit the package.

This package is version controlled and not checked out to you, therefore you cannot
edit the package (unless you check the package out).

This package is version controlled, but you checked it out whilst not connected to
the version control 268 server. You can edit the package but there could be version
conflicts when you check the package in again.

For example, below, CVSOO and CVSPackage are configured for version control. CVSOO is checked out to
you, and CVSPackage is not.

3.5.1.2 Version Control Setup

Before using Enterprise Architect's version control facility, your version control product must be installed on
each machine where it is intended to be used.
Version Control products supported by Enterprise Architect include MS Team Foundation Server, Subversion,
CVS or any other version control product that provides an MS SCC-compliant interface.
· Subversion is available from http://www.subversion.tigris.org/
· CVS is available from http://www.wincvs.org/.

Note:
If you are using the Corporate, Business and Software Engineering, System Engineering or Ultimate editions
of Enterprise Architect with security enabled, you must also set up permissions to configure and use version
control. See the List of Available Permissions 199 topic for further information.

Typically there should be:

· A server component that manages a version control repository
· Client components on the workstations that Enterprise Architect uses to communicate with the server.
A version control client must be installed on every machine where you run Enterprise Architect and want to
access your version control system. Once the version control software has been installed and configured, to
use your installed version control product you must define a Version Control Configuration within Enterprise
Architect.
Version control can be assigned to individual packages, view nodes or root nodes in Enterprise Architect.
Each package can only be linked to one Version Control Configuration at a time, although it is possible to
connect multiple control configurations for each model. You can use the Version Control Settings dialog to set
up a connection to your version control application.
To set the Version Control Configuration, select the Project | Version Control | Version Control Settings
menu option, and see the Version Control Settings Dialog 234 topic.

See Also
· Version Control with SCC 236
· Version Control with CVS 240

© 1998-2010 Sparx Systems Pty Ltd

 234 Projects and Teams | Change Management

· Version Control with Subversion 247

· Version Control with TFS 253

3.5.1.2.1 Version Control Settings Dialog

The Version Control Settings dialog enables you to specify the information required to create a Version
Control Configuration, which can then be used to establish a connection to a version control provider.
Enterprise Architect supports version control through MS Team Foundation Server, Subversion, CVS or any
SCC-compliant version control product.
It is possible to use multiple version control configurations in the same Enterprise Architect model. It is also
possible to use the same version control configuration across different models, to facilitate sharing 'standard'
packages between those models, through the version control system.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Configure Version Control 198 permission to set
up version control options for the current model.

Setting Up Version Control

When you display the Version Control Settings dialog for the first time in any given model, it appears as shown
below:

Enterprise Architect User Guide

 Projects and Teams | Change Management 235

To begin defining a new version control configuration, follow the steps below:
1. Click on the New button.
2. In the Unique ID field, type a suitable name.
3. Against the Type field, click on the radio button for the version control product to connect to.

At this point, the middle section of the dialog changes to display a collection of fields relating to the type
of Version Control Configuration you are defining. Go to the relevant topic below:
· Version Control with SCC 236
· Version Control with CVS 240
· Version Control with Subversion 247
· Version Control with TFS 253
To import a previously defined configuration for use in the current model, follow the steps below:

© 1998-2010 Sparx Systems Pty Ltd

 236 Projects and Teams | Change Management

1. Click on the New button.

2. In the Unique ID field, click on the drop-down arrow and select one of the previously defined version
control configurations.
3. Click on the Save button to save the selected version control configuration in this model.

See Also
· Version Control Nested Packages 236

3.5.1.2.1.1 Version Control Nested Packages

In releases of Enterprise Architect later than version 4.5, when you save a package to the version control
system only stub information is exported for any nested packages. This ensures that information in a nested
package is not inadvertently over-written by a top level package.
When checking out a package, Enterprise Architect does not modify or delete nested packages; only the top
level package is modified.
As a consequence of this behavior, if you check out or get a version controlled package with nested packages
not already in your model, you see stubs in the model for the nested packages only. If you select the Get All
Latest option from the version control menu, Enterprise Architect populates these new stubs from the version
control system.
Using the above technique you can populate a large and complex model from only the root packages, using
Get All Latest to recursively iterate through the attached and nested packages.
This is a powerful and efficient means of managing your project and simplifies handling very large models,
even in a distributed environment.
It is recommended you do not mix versions of Enterprise Architect later than version 4.5 with earlier versions
when sharing a version controlled model. If this is necessary it is best to go to the Version Control Settings 234
dialog and deselect the Save nested version controlled packages to stubs only checkbox, setting
Enterprise Architect to the pre-version 4.5 behavior (for the current model only).

3.5.1.2.2 Version Control with SCC

To set up an SCC version control configuration, you must:
· Set up the source code control provider with SCC, and
· Connect the Enterprise Architect model to version control with SCC.
See also, the topic on version control with SCC when Upgrading at Enterprise Architect 4.5 239 .

Set Up the Source Code Control Provider with SCC

To set up the third-party source code control provider, see the documentation provided with that application. A
repository must be set up using the SCC provider and access to that repository must be available to all
intended users.

Connect an Enterprise Architect Model to Version Control with SCC

To connect an Enterprise Architect model to version control, follow the steps below:
1. Open or create the Enterprise Architect model to place under version control.
2. Select the Project | Version Control | Version Control Settings menu option. The Version Control
Settings dialog displays.

Enterprise Architect User Guide

 Projects and Teams | Change Management 237

3. Click on the New button.

4. In the Unique ID field, type a suitable name. Click on the SCC radio button.
5. To the right of the Local Project path field, click on the Select Path... button. The Browse for Folder
dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 238 Projects and Teams | Change Management

6. Locate and click on the local folder in which to keep local working copies of the XML files to be stored in
the Version Control repository.
7. Click on the OK button. The Select SCC Provider dialog displays.

Note:
All users of the shared database must specify the same SCC provider.

8. Click on an SCC provider, and click on the OK button to return to the Version Control Settings dialog.
9. Click on the Save button to save the configuration you have defined.

The SCC provider is likely to prompt you for various details including the name of the project to connect
to, and perhaps the user name to use when you log in.
10. The new configuration is added to the list in the Defined Configurations panel.

Enterprise Architect User Guide

 Projects and Teams | Change Management 239

Note:
A new entry is also created in the Local Paths 1343 list, with the same ID as the new version control
configuration. The Local Path entry records the Local Project path, for use in subsequent path
substitutions.

11. When you have finished defining your version control configurations, click on the Close button.
For further information on the fields on the Version Control Settings dialog, see the following table.

Field Use to

This model is Specify whether all users connect to a single shared copy of the model (for example, a
private DBMS) or each user connects to their own private copy of the model.
When unselected (for shared models), the option disables the File History - Retrieve
functionality when the selected package is checked out by another user. This prevents
modifications that might have been made by the other user from being discarded
through importing a prior revision from version control.

Save nested Set nested version controlled packages to stubs or fully expanded trees. Defaults to
version controlled selected.
packages to stubs
For a full explanation of this option, see Version Control Nested Packages 236 .
only

Unique ID Specify a configuration name that readily distinguishes this configuration from other
configurations. The unique ID is displayed as a selection in the list of Version Control
configurations a package can connect to.
You can also click on the drop-down arrow and select a previous version control
configuration, providing the configuration is not in the current model.

Local Project Path Specify the folder in which the XML files representing the packages are stored. This
folder should already exist before it is specified here.
Every PC using version control should have its own local SCC project folder, and this
should not be a shared network folder. Particularly bear this in mind if you are creating
a .EAP file that is to be shared (such as a SQL database).

Current User Read only. Shows your user name as the user currently logged into the SCC provider.

SCC Provider Read only. Shows the name of the provider specified in the database.

SCC Project Read only. Shows the project selected during the initial setup of the connection to the
SCC provider.

Note:
Sparx Systems strongly urge you not to manipulate version controlled package files outside of Enterprise
Architect. It is possible to leave the package files in a state that Enterprise Architect cannot recognize.

3.5.1.2.2.1 Upgrade at Enterprise Architect 4.5

When a version-controlled project created under a release of Enterprise Architect earlier than 4.5 is opened in
Enterprise Architect release 4.5 or later, you must identify the SCC connection with a new unique ID. You can
assign a name to the existing SCC configuration or associate the project with a configuration that has
previously been assigned a unique ID.
By having a unique ID for Version Control Configurations, you can assign a configuration quickly and
efficiently using configurations that have been created previously for other version controlled repositories. This
enables you to configure the many packages to use an existing version control repository; this can apply to
packages created for more than just one model enabling a great deal of flexibility.
To upgrade an existing SCC version control project created before release 4.5, in Enterprise Architect release
4.5 or later, follow the steps below.
1. Open the project that has an SCC Version Control Configuration created in Enterprise Architect earlier
than version 4.5.
2. The Select or Create Unique ID for Version Control dialog prompts you to create an ID for an existing

© 1998-2010 Sparx Systems Pty Ltd

 240 Projects and Teams | Change Management

configuration or to choose a previously created one from the Unique ID drop-down list.
3. The existing SCC configuration is the initial value, represented by SCC-XXXXX; this number is not
especially meaningful, therefore it is recommended that the configuration be given a meaningful name.

4. You can associate the version controlled package with a previously-defined configuration by selecting
an existing configuration from the Unique ID drop-down list (if one exists).

5. After you have assigned the unique ID, click on the OK button to load the model.

3.5.1.2.3 Version Control with CVS

CVS is an open source, version control system, used to manage files and directories.
In order to use CVS version control with Enterprise Architect, you must install version control software on your
local machine. Also, you must create a working directory (using your version control software) before you can
configure Enterprise Architect. You can have as many working directories as you like on your local machine.
You must also connect to a repository, which can be either a remote repository 240 or local 244 to your
machine. If your repository is local, it must be created with your version control software.
Each working folder you create contains information on connection to a repository. This connection information
includes the path to the local or remote repository, the user name and password in order to make a
connection.

Note:
To see a video demonstration of setting up a CVS repository for version control, go to
http://www.sparxsystems.com.au/resources/demos/settingupCVS/CVS_Final_1.htm.

3.5.1.2.3.1 CVS with Remote Repositories

Before you can connect to a remote repository, you must:
· Have version control setup on your local machine
· Have version control setup on a remote server
· Have a working directory on your local machine that points to the repository on the server.
To set up CVS version control with a remote repository, follow the steps below:
1. Ask your system administrator to install CVS and create a remote repository with a module that you can
use to control your Enterprise Architect package files. Your administrator must create a username and
Enterprise Architect User Guide
 Projects and Teams | Change Management 241

password for you before you can make a connection.

2. Open a command prompt window and navigate to, or create, a suitable directory to hold your CVS
working copy directory; for example:
C:\> cd myCVSWorkSpace
3. Connect to the remote CVS repository. An example connection command is:
C:\myCVSWorkSpace> cvs -d:pserver:myUserID@ServerName:/repositoryFolder login

Note:
Replace myUserID with your CVS username, replace ServerName with the name of your CVS server and
replace repositoryFolder with the path to the repository on the server.

4. Create a local CVS workspace, derived from the remote repository. An example command is:
C:\myCVSWorkSpace> cvs -d:pserver:myUserID@ServerName:/cvs checkout moduleName

Note:
The above command creates a subdirectory in your current working directory, called moduleName.
(Replace moduleName with the name of the module created by your system administrator). It creates
local copies of all files contained in the CVS module found at ServerName:/cvs.
It also creates a subdirectory beneath moduleName, called CVS. This subdirectory contains a file called
Root, that contains your CVS connection information. Enterprise Architect uses this file to obtain your
CVS user ID.

5. Verify that your CVS installation is working correctly.

6. Change directory to the one you specified as the working copy, in the cvs checkout command above; that
is, C:\myCVSWorkSpace\moduleName
7. Now create a test file, such as Test.txt, containing the text CVS Test. You can do this with the
command:
echo CVS Test > Test.txt
8. Execute the following CVS commands:
· cvs add Test.txt
· cvs commit -m"Commit comment" Test.txt
· cvs update Test.txt
· cvs edit Test.txt
· cvs editors Test.txt
9. The editors command should produce output resembling the following:
Test1.txt myUserID Tue Aug 9 10:08:43 2009 GMT myComputer C:\myCVSWorkSpace\moduleName
10. Take note of the userID that follows the filename. Enterprise Architect must find and use this user ID
when you create your version control configuration. (See the example dialog below.)
11. Launch Enterprise Architect and open or create the model containing the packages to place under
version control.
12. Select the Project | Version Control | Version Control Settings menu option. The Version Control
Settings dialog displays.
13. Click on the New button, enter a suitable name in the Unique ID 243 field, then click on the CVS radio
button in the Type field.

© 1998-2010 Sparx Systems Pty Ltd

 242 Projects and Teams | Change Management

14. To specify the Working Copy path 243 value, click on the Select Path button. Select the local folder in
which to keep local working copies of the XML files to be stored in the Version Control repository.

Enterprise Architect User Guide

 Projects and Teams | Change Management 243

15. Click on the OK button to return to the Version Control Settings dialog.
16. The Current User 244 field should display the user name used to log into the remote CVS repository. If
this does not happen, it indicates that Enterprise Architect cannot extract the user name from the file .
..\WorkingCopyPath\CVS\Root and the configuration does not work correctly.
17. If necessary, set the CVS Exe Path 244 by clicking on the Select Path... button and browsing to the file
path for the for file cvs.exe, the CVS executable.
18. Click on the Save button to save the configuration you have defined. The new configuration is added to
the list of Defined Configurations.

Note:
A new entry is also created in the Local Paths 1343 list, with the same ID as the new version control
configuration. The Local Path entry records the Local Project path, for use in subsequent path substitutions.

Options Use to

This model is Private Specify whether all users connect to a single shared copy of the model (such as
a DBMS) or each user connects to their own private copy of the model.
When unselected (for shared models), the option disables the File History -
Retrieve functionality when the selected package is checked out by another
user. This prevents modifications that might have been made by the other user
from being discarded through importing a prior revision from version control.

Save nested version Set nested version controlled packages to stubs or fully expanded trees.
controlled packages to Defaults to selected.
stubs only For a full explanation of this option, see the Version Control Nested Packages
236 topic.

Unique ID Specify a configuration name that readily distinguishes it from other

configurations. The unique ID displays as a selection in a list of Version Control
configurations a package can connect to. In addition it is possible to select a
previous version control configuration from this drop-down menu providing the
configuration is not in use in the current model.

Working Copy path Specify the folder where the XML files representing the packages are stored.
This folder should already exist before it is specified here.

© 1998-2010 Sparx Systems Pty Ltd

 244 Projects and Teams | Change Management

Options Use to

Every version control configuration you define in Enterprise Architect, should

have its own local working copy folder in which to store working copies of the
XMI package files; this should not be a shared network folder. Particularly bear
this in mind if you are creating an Enterprise Architect project that is to be
shared (e.g. a SQL database).

Current User Specify the CVS user name associated with all CVS commands that are issued.
This name is used by Enterprise Architect, to determine who has a package
'checked-out'.

CVS EXE Path Specify the full path of the CVS client's executable file.

Note:
Sparx Systems strongly urge you not to manipulate version controlled package files outside of Enterprise
Architect. It is possible to leave the package files in a state that Enterprise Architect cannot recognize.

3.5.1.2.3.2 CVS with Local Repositories

Before you can set up Enterprise Architect, you must have a working directory that points to a local repository;
that is, one that is installed on your local machine. See your version control software help files for more
information.
To set up CVS version control follow the steps below:
1. Launch Enterprise Architect and open or create the Enterprise Architect model for which packages are
to be placed under version control.
2. Select the Project | Version Control | Version Control Settings menu option. The Version Control
Settings dialog displays.
3. Click on the New button.
4. In the Unique ID field, type a suitable name for the configuration.
5. Against the Type field, click on the CVS radio button.

Enterprise Architect User Guide

 Projects and Teams | Change Management 245

6. Click on the Select Path... button to the right of the Working Copy path field and browse for and select
the local folder in which to keep local working copies of the XML files to be stored in the Version Control
repository.
7. If necessary, click on the Select Path... button to the right of the CVS Exe Path field and browse to the
file path for the file cvs.exe, the CVS executable.

© 1998-2010 Sparx Systems Pty Ltd

 246 Projects and Teams | Change Management

8. Click on the Save button to save the configuration you have defined.
9. The new configuration is added to the list in the Defined Configurations panel.

Note:
A new entry is also created in the Local Paths 1343 list, with the same ID as the new version control
configuration. The Local Path entry records the Local Project path, for use in subsequent path substitutions.

For further information on the fields in the Version Control Settings dialog, see the following table.

Field Use to

This model is Private Specify whether all users connect to a single shared copy of the model (e.g. a
DBMS) or each user connects to their own private copy of the model.
When unselected (for shared models), the option disables the File History -
Retrieve functionality when the selected package is checked out by another
user. This prevents modifications that might have been made by the other user
from being discarded through importing a prior revision from version control.

Save nested version Set nested version controlled packages to stubs or fully expanded trees.
controlled packages to Defaults to selected.
stubs only
For a full explanation of this option, see Version Control Nested Packages 236 .

Unique ID Specify a name that readily distinguishes the configuration from other
configurations. The Unique ID is displayed as a selection in the list of Version
Control configurations a package can connect to. In addition it is possible to
select a previous version control configuration from the drop-down menu
providing the configuration is not in use in the current model.

Working Copy path The folder where the XML files representing the packages are stored. This folder
should already exist before it is specified here.
Every version control configuration you define in Enterprise Architect, should
have its own local Working Copy Folder in which to store working copies of the
XMI package files - this should not be a shared network folder. Particularly bear
this in mind if you are creating an Enterprise Architect project that is to be
shared (for example, a SQL database).

Enterprise Architect User Guide

 Projects and Teams | Change Management 247

Field Use to

Current User The CVS user name associated with all CVS commands that are issued. This
name is used by Enterprise Architect, to determine who has a package
'checked-out'.

CVS EXE Path The full path name of the CVS client's executable file.

Note:
Sparx Systems strongly urge you not to manipulate version controlled package files outside of Enterprise
Architect. It is possible to leave the package files in a state that Enterprise Architect cannot recognize.

3.5.1.2.4 Version Control with Subversion

Subversion is an open source version control system, used to manage files and directories.
To make use of Subversion control you must have Enterprise Architect version 6.0 or greater.
Tasks in setting up version control with Subversion include:
· Set up Subversion 247
· Create a new Repository Sub-Tree 248
· Create a Local Working Copy 249
· Subversion Under WINE-Crossover 249
· Version Control Configuration 250
· TortoiseSVN 252

Note:
To see a video demonstration of setting up a Subversion repository for version control, go to
http://www.sparxsystems.com.au/resources/demos/settingupsubversion/svn_final.htm.

3.5.1.2.4.1 Set up Subversion

Obtain and Install Subversion

Note:
Enterprise Architect relies on exclusive file locking when applying version control to its packages. File locking
was not introduced into Subversion until version 1.2. Enterprise Architect does not work with Subversion
releases earlier than Subversion 1.2.

Before Enterprise Architect can be used with Subversion, the appropriate software must be installed by a
Subversion administrator. Ask your system administrator to obtain and install the Subversion server and client
applications.
Enterprise Architect must use the Subversion command line client to communicate with the Subversion server;
it cannot use other clients such as TortoiseSVN 252 .

Important:
Before you attempt to use Subversion through Enterprise Architect, you must first verify that you can use the
Subversion command line client to access and operate on files within the working copy folder that Enterprise
Architect will use. Your environment must be set up such that you can perform these operations without ever
being prompted for user ID or password. For further information, please see the topic Caching Client
Credentials in the official Subversion documentation.
The official Subversion documentation can be found at: http://www.svnbook.red-bean.com/en/1.4/index.html,
while executable files for Subversion can be obtained from: http://www.subversion.tigris.org/
project_packages.html#binary-packages.

You require the Windows executables for your client machines running Enterprise Architect in the windows
environment. If you plan to run your Subversion server on a non-windows platform, you must download a
binary suitable for that platform as well.

© 1998-2010 Sparx Systems Pty Ltd

 248 Projects and Teams | Change Management

Chapter 6 in the Subversion documentation provides guidance on how to configure the server for different
methods of access by the client. Secure connection methods are also covered in this chapter.
Your administrator should set up user IDs and passwords for every person who is to access the repository.
Your administrator should then provide all users with the path to the repository, and ensure that they can all
connect.
Before users can make use of Subversion, they must create local working copies 249 from the repository by
checking-out a repository sub-tree 248 .
Steps for setting up a repository and creating a local working copy can be found at:
http://www.svnbook.red-bean.com/en/1.4/svn.basic.in-action.html#svn.advanced.reposurls.

Note:
Sparx Systems recommend that each new Enterprise Architect model being added to version control with
Subversion should have a separate repository sub-tree created for it, and users should create a new local
working copy from the sub-tree to be used with that model.

Repository URLs
Subversion repositories can be accessed using many different methods, on local disk or through various
network protocols. A repository location, however, is always a URL. The table below describes how different
URL schemas map to the available access methods.

Schema Access Method

file:/// Direct repository access (on local disk).

http:// Access via WebDAV protocol to a Subversion-aware Apache server.

https:// Same as http://, but with SSL encryption.

svn:// Access via custom protocol to an svnserve server.

svn+ssh:// Same as svn://, but through an SSH tunnel.

For more information on how Subversion parses URLs, see

http://www.svnbook.red-bean.com/en/1.4/svn.basic.in-action.html#svn.advanced.reposurls.

See Also
· Configure Version Control with Subversion 250

3.5.1.2.4.2 Create a new Repository Sub-tree

If a repository sub-tree has already been created for your Enterprise Architect model, skip this topic and see
the Create a Local Working Copy 249 topic. If your Enterprise Architect model has not previously been added
to version control, create a sub-tree for it in your SVN repository by following the steps below:
1. Create a temporary directory structure to import into the SVN repository, which initializes the repository
sub-tree for this Enterprise Architect model. The directory structure should look like this:

tempDir
|
+--<EA_Model_Name>
|
+--trunk
|
+--branches
|
+--tags

2. Open a command prompt, navigate to tempDir and issue the command:

svn import. <repositoryURL> --message "A Comment of your choice"

Enterprise Architect User Guide

 Projects and Teams | Change Management 249

Note:
After the import is finished, the original tree is not converted into a working copy. To start working, you
must still svn checkout a fresh working copy of the tree.

3. Delete the directory tempDir and all its contents.

For further information see http://www.svnbook.red-bean.com/en/1.4/svn.reposadmin.basics.html.

3.5.1.2.4.3 Create a Local Working Copy

Once you have created a sub-tree in the repository for this model, or if one already exists, you are ready to
create the local Working Copy for use with this model.
To create the local Working Copy, follow the steps below:
1. Choose a suitable directory on your system, in which to create your Subversion Working Copy. The
directory that contains your model's .EAP file is probably a good choice.
2. Open a command line window, navigate to the directory to hold your Working Copy directory and check-
out the model's sub-tree from the repository, with the following command:

svn checkout <repositoryURL>/<EA_Model_Name>,

where <EA_Model_Name> is the directory name that you used in setting up the repository sub-tree
above.

After you have created your working copy, you should verify everything is working correctly before you attempt
to use it from within Enterprise Architect. You must be able to commit files to the repository, without being
prompted for ID or passwords.
Enterprise Architect interacts with Subversion using its command line client. Firstly, create a file in your
working copy folder then, from a command prompt, add and commit the file to the repository. Use the following
commands:
svn add <fileName>
svn commit <fileName> -m"A meaningful comment."
Now, update the file from the repository, lock the file, edit it and commit once more. Use the following
commands:
svn update <fileName>
svn lock <fileName>
Then edit and save the file using your preferred editor:
svn commit <fileName> -m"A meaningful comment."

3.5.1.2.4.4 Subversion Under WINE-Crossover

When running Enterprise Architect under WINE/CrossOver, you can use either a Windows-based Subversion
client or a Linux-based Subversion client.
If you intend to use the HTTP or HTTPS protocols you must use the Unix-like client, as the Windows client
cannot access the libraries necessary to create the required network connections. It is also easier to set up
your working copy folder using the native Unix-like Subversion client and then continue using that same client
from within Enterprise Architect.
However, to make use of the Unix-like client under CrossOver, you must also download and install a bridging
utility called SVN_gate, which is available from the CodeWeavers' (CrossOver) web site:
http://www.codeweavers.com/support/wiki/EAsvn
When using the Windows Subversion client, you simply install the Win32 Subversion client under CrossOver.
Once you have set up your working copy directory, you are ready to use Subversion with Enterprise Architect.
However, setting up your working copy is more difficult when using Win32 Subversion under CrossOver.
Because you cannot see any output from Subversion commands run under CrossOver, the best way to run the
commands is to create a Windows batch file containing the command to run, and to run that batch file as a
Windows command under CrossOver. (See the example batch file 250 below.)
If you are running directly under WINE, launch the Windows batch file from a Unix shell script such as follows;

/home/user/cxoffice/bin/wine --bottle "ea" --untrusted

© 1998-2010 Sparx Systems Pty Ltd
 250 Projects and Teams | Change Management

--workdir "/home/user/.cxoffice/ea""/drive_c"
-- "/home/user/.cxoffice/ea/drive_c/batfile.bat"

Enterprise Architect uses the Subversion command line client to communicate with your Subversion server. In
order for Enterprise Architect to work successfully with Subversion, your Subversion working copy
environment must be set up such that you can issue commands to Subversion from the command line, without
ever being prompted for user input such as username or password.
By default, whenever the Subversion command-line client successfully responds to a server's authentication
challenge, it saves the credentials in the user's private runtime configuration area, which is:
· ~/.subversion/auth/ on Unix-like systems or
· %APPDATA%/Subversion/auth/ on Windows (which translates to .../drive_c/windows/profiles/crossover/Application
Data/Subversion/auth/ under CrossOver).
For this reason, Sparx Systems recommend that when you checkout a working copy from the Subversion
repository, you specify your username and password on the command line, such that your credentials are
cached from the outset. Use a Subversion command such as:
· Using a Unix-like client (run the command from the command line):

svn checkout --username "UserName" --password "myPassword" "svn://myServerName:3690/myProject"

"/.../drive_c/workingCopyDirectory"

· Using a Win32 client (run the command within a batch file run under CrossOver):

"C:\Program Files\Subversion\bin\svn.exe" checkout --username "UserName" --password "myPassword"

"svn://myServerName:3690/myProject" "C:\SVN-test\workcopy" >"C:\SVN-test\stdout.txt" &2>"C:\SVN-test\stderr.txt"

It is a good idea to checkout your Subversion working copy into a folder within the WINE bottle where
Enterprise Architect is to run. In this way, the pathnames used for your version controlled package files are
much shorter.
If you intend to use the Win32 Subversion client with Enterprise Architect, you should create the local working
copy that Enterprise Architect is to use, by performing a Subversion checkout command using the Win32
client under WINE/CrossOver. Similarly, if you plan to use the Unix-like Subversion client with Enterprise
Architect, you should perform the initial checkout using that client. In this way, your user credentials are
cached in the correct location for the client that Enterprise Architect is using.
It is important to verify that your command line client for Subversion is working correctly before attempting to
connect from Enterprise Architect. For guidance on verifying your set up, see the Create a Local Working
Copy 249 topic.

The following is an example of a Windows batch file that can be used under CrossOver to run Subversion
commands. Simply uncomment the command to execute. Each command should be a single line - the '\' is
intended as a continuation character.

rem "C:\Program Files\Subversion\bin\svn.exe" checkout --username "UserName" --password "myPassword" \

"svn://myServerName:3690/myProject" "C:\SVN-test\workcopy"
>"C:\SVN-test\stdout.txt" &2>"C:\SVN-test\stderr.txt"

rem "C:\Program Files\Subversion\bin\svn.exe" add "C:\SVN-test\workcopy\myTestFile.xml" \

>"C:\SVN-test\stdout.txt" &2>"C:\SVN-test\stderr.txt"

rem "C:\Program Files\Subversion\bin\svn.exe" commit -m"a message" "C:\SVN-test\workcopy\myTestFile.xml" \

>"C:\SVN-test\stdout.txt" &2>"C:\SVN-test\stderr.txt"

rem "C:\Program Files\Subversion\bin\svn.exe" lock "C:\SVN-test\workcopy\myTestFile.xml" \

>"C:\SVN-test\stdout.txt" &2>"C:\SVN-test\stderr.txt"

3.5.1.2.4.5 Version Control Configuration

This topic assumes that you have already installed Subversion (both the server and the client parts), and that
you have a local working copy 249 , derived from a repository sub-tree 248 , already set up for use with your
Enterprise Architect model.
If this is not the case, please see the Set up Subversion 247 topic.
Once you have set up and tested the Local Working Copy, you are ready to define a Version Control
configuration for use with the Enterprise Architect model to place under version control.
To apply version control to your Enterprise Architect model using the Subversion working copy that you have

Enterprise Architect User Guide

 Projects and Teams | Change Management 251

set up, follow the steps below:

1. Launch Enterprise Architect and open the model for which this Working Copy was created.
2. Select the Project | Version Control | Version Control Settings menu option.
3. Click on the New button, enter a suitable name in the Unique ID field, then click on the Type:
Subversion radio button.

4. To the right of the Working Copy path field, click on the Select Path button and select the local folder
in which to keep local working copies of the XML files to be stored in the Version Control repository.
5. In the Workstation Settings panel, click on the Select Path button to specify the path for your
Subversion client executable.
6. Click on the Save button to save the configuration you have defined; the new configuration is added to
the Defined Configurations list.

© 1998-2010 Sparx Systems Pty Ltd

 252 Projects and Teams | Change Management

Note:
A new entry is also created in the Local Paths 1343 list, with the same ID as the new version control
configuration. The Local Path entry records the Local Project path, for use in subsequent path
substitutions.

7. When you have finished defining your version control configurations, click on the Close button.

Additional Information on the dialog fields:

Option Use to

This model is private Specify whether all users connect to a single shared copy of the model (such as a
DBMS) or each user connects to their own private copy of the model.
When unselected (for shared models), the option disables the File History -
Retrieve functionality when the selected package is checked out by another user.
This prevents modifications that might have been made by the other user from
being discarded through importing a prior revision from version control.

Save nested version Set nested version controlled packages to stubs or fully expanded trees. Defaults
controlled packages to selected.
to stubs only For a full explanation of this option, see the Using Nested Version Control
Packages 236 topic.

Unique ID Specify a configuration name that readily distinguish this configuration from other
configurations. The Unique ID displays as a selection in the list of Version Control
configurations a package can connect to. In addition you can select a previous
version control configuration from this drop-down menu, providing the
configuration is not in the current model.

Working Copy path Specify the folder where the XML files representing the packages are stored. This
folder should already exist before it is specified here.
Every PC using Subversion version control should have its own Subversion
working copy folder in which to store working copies of the XMI package files; this
should not be a shared network folder. Particularly bear this in mind if you are
creating a .EAP file that is to be shared (for example, a SQL database).

Subversion Exe Path Specify the full path name of the Subversion client executable file.

Note:
Sparx Systems strongly urge you not to manipulate version controlled package files outside of Enterprise
Architect. It is possible to leave the package files in a state that Enterprise Architect cannot recognize.

3.5.1.2.4.6 TortoiseSVN
TortoiseSVN is a Windows shell extension for Subversion.
Enterprise Architect cannot use TortoiseSVN to communicate with the Subversion server; it must use the
Subversion command line client.
TortoiseSVN provides icon overlays in Windows Explorer that are useful as a tool for observing the status of
your Subversion controlled files. It enables you to create your repository sub-trees and check out local working
copies from within Windows Explorer using simple menu commands.

Note:
· Sparx Systems recommend that you test your local working copies, by adding and committing a dummy file
from the command prompt window.
· Manipulating Enterprise Architect's package files, using tools that are external to Enterprise Architect,
could leave those files in a state that Enterprise Architect cannot use.

You can download TortoiseSVN from: http://www.tortoisesvn.tigris.org/.

Enterprise Architect User Guide

 Projects and Teams | Change Management 253

3.5.1.2.5 Version Control with TFS

In order to use Team Foundation Server (TFS) for version control with Enterprise Architect, all users must
have either the TFS command line client (tf.exe) or Microsoft's Team Foundation Server MSSCCI installed on
their local machine. Each intended user must also have an account that provides read/write access to a
workspace on the server.
This topic covers configuring version control using the TFS command line client. To configure version control
with the TFS MSSCCI client, please follow the instructions in the Version Control with SCC 236 topic.
The following preliminary steps should be performed within TFS on each PC and for each user, before making
any attempt to define a Version Control Configuration within Enterprise Architect 253 that uses TFS.
When initializing the connection to TFS, Enterprise Architect issues the command tf get. If the Local Working
Copy path specified in Enterprise Architect's version control configuration is mapped through a TFS
workspace that also maps many other working folders to their corresponding Source Control folders, TFS can
take a long time as it proceeds to update the files in all of those folders. Enterprise Architect might appear to
freeze when it initializes the connection to TFS, whilst it waits for TFS to complete the tf_get command and
hand back program control.
Therefore, each user must set up a separate workspace for use in version control in Enterprise Architect,
containing a single local working folder on their own machine that is mapped to a Source Control folder on the
server. This separate workspace can be in addition to any other workspaces that might already exist.

Note:
To see a video demonstration of setting up a TFS project for version control, go to
http://www.sparxsystems.com.au/resources/demos/settinguptfs/TFS%20Project-Workspace%20Setup.htm.

3.5.1.2.5.1 Connect an Enterprise Architect Model to Version Control using TFS

Having set up TFS and created or otherwise opened your model, you can configure the model for version
control under TFS.
To configure the model for version control, follow the steps below:
1. Open or create the Enterprise Architect model to place under version control.
2. Select the Project | Version Control | Version Control Settings menu option. The Version Control
Settings dialog displays.
3. Click on the New button, in the Unique ID field enter a suitable name, then select the TFS radio button.

© 1998-2010 Sparx Systems Pty Ltd

 254 Projects and Teams | Change Management

4. Click on the Select Path... button to the right of the Working Copy path field, and select the local folder
in which to keep local working copies of the XML files to be stored in the Version Control repository.

Note:
Enterprise Architect queries TFS to retrieve the Server and Workspace names associated with this
folder, when attempting to save the configuration data.

5. In the User Name and Password fields, type values that enable access to the TFS workspace
associated with the Working Copy path specified above.

Note:
Users who automatically log in to TFS through means external to Enterprise Architect (for example,
through MS Integrated Security) can leave the User Name and Password fields blank. If the
Password field is blank, Enterprise Architect retrieves the current user's Windows username and uses
that value when determining whether a package is checked out to them or to some other user.

Enterprise Architect User Guide

 Projects and Teams | Change Management 255

6. The TFS Exe Path field displays the default installation path; for example:

C:\Program Files\Microsoft Visual Studio 8\Common7\IDE\tf.exe.

Click on the Select Path... button if it is necessary to modify this field.

7. Click on the Save button to save the configuration you have defined.
8. The new configuration is added to the list in the Defined Configurations panel.

Note:
A new entry is also created in the Local Paths 1343 list, with the same ID as the new version control
configuration. The Local Path entry records the Local Project path, for use in subsequent path
substitutions.

9. When you have finished defining your version control configurations, click on the Close button.

Additional Information on the Dialog Fields

Option Use to

This model is private Specify whether all users connect to a single shared copy of the model (such
as a DBMS) or each user connects to their own private copy of the model.
When unselected (for shared models), the option disables the File History -
Retrieve functionality when the selected package is checked out by another
user. This prevents modifications that might have been made by the other
user from being discarded through importing a prior revision from version
control.

Save nested version Set nested version controlled packages to stubs or fully expanded trees.
controlled packages to Defaults to selected.
stubs only For a full explanation of this option, see Use Nested Version Control
Packages 236 .

Unique ID Specify a configuration name that readily distinguishes it from other

configurations.
The Unique ID is added to the list of Version Control configurations a
package can connect to. In addition it is possible to select a previous version
control configuration from this drop-down menu providing the configuration is
not in the current model.

Working Copy Path Specify the folder where the XML files representing the packages are stored.
This folder should already exist before it is specified.
Every PC using TFS version control should have its own TFS Local Folder in
which to store working copies of the XMI package files - this should not be a
shared network folder. Particularly bear this in mind if you are creating a
.EAP file which is to be shared (for example, a SQL database).

Server Name Specify the name of the Team Foundation Server to connect to.

Workspace Name Specify the name of a pre-defined TFS workspace that you are using.

User Name Specify the user name that you use to connect to the Team Foundation
Server. The user name that you specify should give you read/write
permissions in the specified workspace.

Password Specify the password associated with the user name you specify. Enterprise
Architect stores this password, in encrypted form, as part of the version
control configuration data.

TFS Exe Path Browse to and select the full path name of the TFS command line client's
executable file.

© 1998-2010 Sparx Systems Pty Ltd

 256 Projects and Teams | Change Management

Notes:
· Sparx Systems strongly urge you not to manipulate version controlled package files outside of Enterprise
Architect. It is possible to leave the package files in a state that Enterprise Architect cannot recognize.
· Visual Studio Integration (MDG Integration for Visual Studio 2005 or 2008) enhances TFS support by
providing access to, for example, work items and bugs within both Enterprise Architect and the MDG
Integration product.

3.5.1.3 Use Version Control

The following topics describe the most common activities using the version control features of Enterprise
Architect, accessed through the Package Version Control Menu 257 :
· Configure Controlled Package 259
· Use Existing Configuration 260
· Validate Package Configurations 260 (Project | Version Control menu 256 )

· Check In and Check out Packages 261

· Include Other Users' Packages 263
· Apply Version Control to Branches 264
· Export Controlled Model Branch 264
· Import Controlled Model Branch 265
· Review Package History 266
· Refresh View of Shared Project 267

General Notes
· The export/import facility is not fast and submitting packages containing many sub-nodes to version control
should be avoided. It is recommended version control is applied to individual packages. See the Version
Control Nested Packages 236 topic for more information.
· Replication 184 should not be combined with version controlled packages.
· Sparx Systems strongly urge you not to manipulate version controlled package files outside of Enterprise
Architect. It is possible to leave the package files in a state that Enterprise Architect cannot recognize.

3.5.1.3.1 Project Version Control Menu

You access the Version Control menu through the Project | Version Control menu option. It provides the
following options:

Menu Option & Function Use to

Keys

Configure Current Display the Package Control Options 259 dialog, which enables you to specify
Package whether this package (and its children) is version controlled, and which version
[Ctrl]+[Alt]+[P] control configuration applies.

Version Control Settings Display the Version Control Settings dialog 234 .

Validate Package Test the validity 260 of the version control settings associated with each version
Configurations controlled package within your current model.

Re-Synch Statuses of All Resynchronize the version control status of packages 267 as recorded in your
Packages Enterprise Architect project when they are out of synchronization with the
version control status reported by your version control provider.
The function acts on all version controlled packages within the Enterprise
Architect project, updating the values recorded in the project to match the
values reported by the version control provider, without performing any XMI
import or export.

Work Offline Work independently of the version control server 268 , if it is unavailable to you.

Enterprise Architect User Guide

 Projects and Teams | Change Management 257

3.5.1.3.2 Package Version Control Menu

To display the Version Control menu, right-click on a version controlled package in the Project Browser and
select the Package Control context menu option.
If the selected package is not under version control, this menu displays a number of different options - see the
Controlled Package Menu 294 topic.

Menu Option & Use to

Function Keys

Configure Display the Package Control Options 259 dialog which enables you to specify
[Ctrl]+[Alt]+[P] whether this package (and its children) is controlled, which file it is controlled
through, and which version control configuration to use.

Manage Baselines Create a Baseline 281 of the current package, or compare the current package
[Ctrl]+[Alt]+[B] with a previous Baseline.

Check In Branch For the selected branch of the model, (that is, the selected package and all of its
child packages) display the Select Packages to Check In 262 dialog, listing all
version controlled packages within that branch that are checked out to you. You
can then select packages in the displayed list, to be submitted for check-in.

Check Out Branch For the selected package, check out the package and recursively check out all of
its contained sub-packages 263 . Retrieves the latest version of the packages
from the central repository, overwriting the current packages. After check out, the
packages are available for editing.

Check In Submit the currently selected package to the central repository. Enterprise

© 1998-2010 Sparx Systems Pty Ltd

 258 Projects and Teams | Change Management

Menu Option & Use to

Function Keys

Architect prompts you to enter optional comments describing changes to the

packages.

Check Out Retrieve the latest version of the currently selected package from the central
repository, overwriting the current packages. After check out the packages are
available for editing.

Undo Check Out Cancel all changes you have made to the currently selected package. This
restores the model to the state it was in before the package was checked out,
leaving the select package and sub-packages locked.

Get Latest Retrieve the latest revision of the package from the repository. Available only for
packages that are checked in.

Get All Latest Retrieve the latest revision of all version controlled packages in the project. Only
retrieves packages that are checked in.

Put Latest Update the central repository with the currently selected package (which you
have checked out), while retaining checkout status on the package. This is
equivalent to checking a package in and immediately checking it back out again.

File Properties Ask the version control provider to show the version control properties associated
with the XML export file pertaining to the currently selected package. This also
identifies who has checked out the package.

File History Where the controlling package has been configured by an SCC provider, this
provider shows a change history for the package. See your provider's
documentation for details on how to use the control. Otherwise, if the version
control is CVS, the history is shown via Enterprise Architect's internal CVS history
menu.

Compare with version Compare the current package with the XMI version on disk.
on disk

Add Branch to Version Apply version control to all packages within a selected model branch, in a single
Control operation. In this context, a model branch is a package that is currently selected
in the Project Browser, and all of the packages contained within it.

Export as Model Export 264 a newly created model branch from your own private copy of a model.
Branch

Import a Model Branch Retrieve 265 a model branch and import it into either the source model or another
model.

Get Package Access packages in the version control repository that are not currently available
in your model.

Re-synch Status With Update the version control status value recorded for the selected package in the
VC Provider Enterprise Architect project to match the value reported by the version control
provider 267 , without performing an XMI import or export.
Use this function when the package's version control status recorded in your
Enterprise Architect project is out of synchrony with the version control status
reported by your version control provider.

Version Control Display the Version Control Settings dialog 234 .

Settings

Update Package Status Provide a bulk update on the status of a package, including status options such
as Proposed, Validate and Mandatory.

Note:
This option is a generic package option not specific to version control.

Enterprise Architect User Guide

 Projects and Teams | Change Management 259

3.5.1.3.3 Configure Controlled Package

Before working on a package under version control, you must define it as a controlled package and specify the
version control configuration to use.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Configure Packages 198 permission to configure
packages for version control.

Configure a Version Controlled Package

To configure a version controlled package, follow the steps below:
1. In the Project Browser, right-click on the package to place under version control. The context menu
displays.
2. Click on the Package Control | Configure menu option. The Package Control Options dialog displays.

3. Select the Control Package checkbox to indicate that this is a controlled package.
4. Click on the Version Control drop-down arrow and select the version control repository; this connects
the package to a specific version control configuration.

The XMI Filename field then displays the version control configuration default path.
5. The Version ID field defaults to 1.0; if necessary, change this to the appropriate reference.
6. The Owner field defaults to your user name; if necessary, type or select the name of the user who owns
the package.
7. Click on the OK button to set the version control options. The Add Package to Version Control dialog
displays.

© 1998-2010 Sparx Systems Pty Ltd

 260 Projects and Teams | Change Management

8. If you do not want to check-out the package immediately, clear the Keep checked out checkbox.
9. Click on the OK button. The Add Comment window displays.

This window displays the date and time at which the package was put under version control.
10. If required, type any further comments in the window. Click on the OK button.
Enterprise Architect places the package under the version control configuration you selected, and marks the
package in the Project Browser with the version controlled checked out or not checked out 233 icons, as
appropriate.

3.5.1.3.4 Use Existing Configuration

Once a version control configuration has been defined in one model it is possible to add the configuration to
other models.
To use an existing configuration in another model, follow the steps below:
1. Open the model that is to have the predefined version control configuration added to it.
2. Right-click on any package in the Project Browser and select the Package Control | Version Control
Settings context menu option. The Version Control Settings 234 dialog displays.
3. Click on the New button.
4. In the Unique ID field, click on the drop-down arrow and select one of the previously-defined version
control configurations.
5. Click on the Save button to confirm the version control configuration.

3.5.1.3.5 Validate Package Configurations

You can test the validity of the version control settings associated with each version controlled package within
your current model. To do this, select:
Project | Version Control | Validate Package Configurations
The validation process scans the model database and verifies that the version control configuration associated
with each version controlled package is fully specified in the current model. It also queries the corresponding
version control provider to find the status of the package file associated with each version controlled package.
The results of the validation process are sent to the Enterprise Architect Output window, as shown below:

Enterprise Architect User Guide

 Projects and Teams | Change Management 261

Depending on the results, you can then complete the definition of any invalid or missing version control
configurations, or correct problems with individual packages or their associated package files.
Click on an error message to highlight, in the Project Browser, the package that is in error.

3.5.1.3.6 Check In and Check Out Packages

To work on a version controlled package you must have the package checked out. When a package is
checked out to a specific user, a write lock is set on the package and other users cannot make changes to it
until it has been checked in again.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Use Version Control 198 permission to check files
in and out using version control.

Check In/Check Out

1. In the Project Browser, right-click on the package icon.
2. Select the Package Control | Check In, Check Out or Undo Checkout context menu options, as
appropriate.
3. If required, enter a comment when prompted to do so.
If you are working in a private 230 model and you select the Check Out menu option, the Import Package
dialog displays (in shared models, this dialog only has default values and therefore does not display).

Option Use to

Force reload from XMI Reload the package content from the XMI file in the central repository, even
though the package and XMI file are synchronized. This ensures that links and
dependencies that might not have been refreshed are updated as well.

Accept current (The default.) Leave the package content in its current state.
package

Refresh model view Refresh the model view to show any changes from other checked out packages.

© 1998-2010 Sparx Systems Pty Ltd

 262 Projects and Teams | Change Management

Option Use to

Always apply above Apply the settings in the above three fields every time you check out a package
settings that is found to be up to date, and therefore do not display this dialog again.

Note:
To display the dialog if, for example, you want to change the settings, press [Ctrl]
while you select the Package Control | Check Out menu option.

The package icon in the Project Browser should change. When you check out a package this is represented
by a figure 8 to the left of the package icon. When you check in a package the package icon is overlaid with a
colored rectangle and key. In the example below, the upper package is checked out whilst the lower package
is checked in.

Notes:
· If you check out a version controlled package whilst offline, the package icon has a red figure 8 in front of
it. See Offline Version Control 268 .
· If the packages under version control contain any alternative images 447 and those images are subject to
frequent change, you can set the Export alternate images option on the Options 367 dialog to export the
images to the version control repository when you check in the packages. If the images are not subject to
frequent change, do not select this option and instead use Export/Import Reference Data 223 to manage
alternative images.

Check In Branch
1. In the Project Browser, right-click on the package icon at the root of the model branch that is to be
checked in and select the Package Control | Check In Branch context menu option. The Select
Packages to Check-in dialog displays, listing all version controlled packages within the branch that you
have checked out.

Enterprise Architect User Guide

 Projects and Teams | Change Management 263

2. Click on the package to check in, or use:

· [Ctrl]+click to add or remove several individual packages
· [Shift]+click to select a range of packages
· All to select all packages listed
· None to clear all selected packages.
3. Click on the OK button to check-in the selected packages.
4. If required, enter a comment when prompted to do so. (This comment applies to all packages that you
have checked in.)
5. Each package icon changes to indicate that the packages have been checked-in.

Check Out Branch

1. In the Project Browser, right-click on the name of the root package of the model branch to be checked
out and select the Package Control | Check Out Branch context menu option. The selected package
and all of its contained sub-packages are recursively checked out.
2. Any packages that cannot be checked-out are listed in a message box, with a brief description of the
problem. For example: The package is already checked out by user 'Fred'.
3. When Project Security is enabled in Lock to Edit mode, Enterprise Architect prompts you to apply a
User Lock throughout the selected model branch before proceeding.

3.5.1.3.7 Include Other Users' Packages

You can retrieve packages that have been created by other users, or by you in another model, from version
control and import them into your current model.
Other users might be creating packages to use in your model. If you are not sharing a SQL database or .eap
file, those packages do not automatically become part of your model. If the packages have been placed into
version control, you can retrieve them and import them into your model as children of an existing package,
using the Get Package command.
1. You must have access to the package files through the version control system and you must define a
Version Control Configuration through which to access those files. The version control configuration
must use the same unique ID that was originally used to add the package to version control.
2. In the Project Browser, right-click on the package to use as the parent of the incoming package.
3. Select the Package Control | Get Package context menu option. The Get Shared File dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 264 Projects and Teams | Change Management

4. In the Select a Version Control Configuration field, click on the drop-down arrow and select the
version control configuration associated with the package to retrieve. The file list is populated with the
names of files available through that configuration, for retrieval and import into your model.
5. Select the package file to import into your model and click on the OK button.

3.5.1.3.8 Apply Version Control To Branches

Enterprise Architect enables you to apply version control to all packages within a selected model branch, in a
single operation.
In this context, a model branch is a package that is currently selected in the Project Browser, and all of the
packages contained within it.
The Version Control Configuration 234 to be used in this operation must be defined within the model before
selecting this command.
To apply version control to a model branch, follow the steps below:
1. Right-click on the required package and select the Add Branch to Version Control 257 context menu
option. The Apply VC to Branch dialog displays.

2. In the Select a Version Control Configuration field, click on the drop-down arrow and select the
Version Control Configuration to use.
3. If required, select the Export as Model Branch checkbox to export the selected package (and
sub-packages) as a Model Branch 264 .
4. Click on the OK button. Enterprise Architect creates a number of sub-folders within the version control
working copy folder, before exporting all of the packages within the selected model branch. Enterprise
Architect generates package filenames using the package GUIDs, before adding the resulting files to
version control.
If you have selected the Export as Model Branch checkbox, once the version control operation is complete
Enterprise Architect also creates a Model Branch file (.EAB file). You can subsequently import the
version-controlled Model Branch 265 .

3.5.1.3.9 Export Controlled Model Branch

You might want to export a newly created model branch from your own private copy of a model so that, for
example:
· Another user can import that branch into their own private copy of the same model, or
· It can be imported for inclusion as a common branch in a number of different models.
Applying version control to an Enterprise Architect model can result in many XMI files placed under version
control. It could then be hard to locate and import the file corresponding to the root of a particular model
branch. Enterprise Architect's Model Branch Files (.EAB files) overcome this problem by simplifying the
retrieval of model hierarchies for use in other models.
The facility is only enabled for packages that are already under version control. The exported Model Branch
File is also placed under version control, using the same version control configuration that is controlling the
selected package.
To export a model branch, follow the steps below:
1. Right-click on the version controlled package to export as a model branch.
2. Select the Package Control | Export as Model Branch context menu option. The Export as Model
Branch dialog displays.

Enterprise Architect User Guide

 Projects and Teams | Change Management 265

3. In the EAB Filename field, type a name for your Model Branch File. Alternatively, click on [ ... ] and
browse for the file location.
Note that the package name is supplied as a default.
You can specify any file name, including sub-folder names, as long as the file is contained in or below the
working folder of your version control configuration.

3.5.1.3.10 Import Controlled Model Branch

It might be necessary to either:
· Retrieve a model branch created by another user in a private copy of a model, to import it into your own
private copy of the same model or
· Retrieve a model branch that is common in many models, for inclusion in a new model.
Applying version control to an Enterprise Architect model can result in many XMI files placed under version
control. It could then be hard to locate and import the file corresponding to the root of a particular model
branch. Enterprise Architect's Model Branch files overcome this problem by simplifying the retrieval of model
hierarchies for use in other models.
The Import a Model Branch context menu option uses Enterprise Architect's Model Branch Files, of which
there are few, to retrieve information about the root package file and import the model branch. The Model
Branch File records information such as the name and type of the version control configuration for the
selected package, and the relative filename of the version controlled XMI file associated with the package.
Before attempting to import a model branch, you must have access to the version controlled XMI files that
represent the model branch to be imported. That is, there must be a working copy folder, accessible from the
machine on which Enterprise Architect is running, that is associated with the Version Control repository
containing those XMI files.
It is not necessary to have the relevant Version Control Configuration set up within Enterprise Architect before
issuing this command - Enterprise Architect prompts you to complete specification of the configuration if
necessary.
The Import a Model Branch context menu option is only enabled for packages that you (the current user) are
able to edit, as the imported model branch is inserted into the model under the selected package.
To import a model branch, follow the steps below:
1. Right-click on the package into which the model branch is to be imported.
2. Select the Package Control | Import a Model Branch context menu option. The Import VC Model
Branch dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 266 Projects and Teams | Change Management

3. Either:
· Click on the Find a Model Branch (.EAB) file button and browse for the Model Branch File. If the
version control configuration used by the file has not been fully set up, Enterprise Architect prompts
you to complete and save the configuration. The model branch import then proceeds. OR
· If the version control configuration used by the file has been fully set up in the current model, click on
the drop-down arrow in the Select a Version Control Configuration field and select the
configuration, then select the Model Branch File from the Select a Model Branch (.EAB) file list.
Click on the OK button to import the model branch.
Enterprise Architect imports the root package specified in the Model Branch File and recursively imports and
populates all the sub-packages contained in the root package.

3.5.1.3.11 Review Package History

Reviewing package history enables you to view the history of checked in package revisions. It also enables
you to import selected prior revisions of the package into your model.
The package revision is retrieved in read-only form, enabling you to view the package contents but not make
any changes to the package.
To review package history follow the steps below:
1. In the Project Browser, right-click on the package configured for version control. The context menu
displays.
2. Select the Package Control | File History menu option.
· If the package has been configured through SCC, you access the history through the mechanism
offered by the third party SCC provider.
· If the package has been configured for CVS, Subversion or TFS, Enterprise Architect's File Version
History dialog displays and the following steps apply.

Enterprise Architect User Guide

 Projects and Teams | Change Management 267

3. In the Revisions field, click on a revision number to view the log entries for that revision.
4. To view the package history select a revision and then click on the Retrieve button. A warning dialog
displays, indicating that the package is being opened in read-only mode.
5. Click on the Yes button to continue or the No button to cancel the action. The package is retrieved in
read only mode, enabling you to view the history of the package at the specified version.
6. To go back to the latest version, in the Project Browser right-click on the package and select either the
Package Control | Check Out.. context menu option or the Package Control | Get Latest context
menu option.

3.5.1.3.12 Refresh View of Shared Project

When a user of a shared model checks out a package and makes changes, other users can see those
changes by refreshing their view of the package or the changed diagram within the package.
You can refresh your view of the Project Browser in the following ways:
· Right-click on the package name in the Project Browser and select the Contents | Reload Current
Package 1218 context menu option
· Select the File | Reload Current Project 56 menu option (or select the Reload Project icon in the Project
81 toolbar, or press [Ctrl]+[Shift]+[F11])

· Close the project and reopen it.

You can refresh the current diagram in the following ways:
· Select the Window | Reload Current View 74 menu option
· Right-click on the opened diagram tab 397 in the diagram view, and select the Reload <diagram name>
context menu option.

3.5.1.3.13 Resynchronize the Status of Version Controlled Packages

Enterprise Architect enables you to re-synchronize the version control status of version controlled packages
within your project with the status reported by your version control provider. This can be useful when you give
a copy of a .EAP file configured for version control to a new team member.
You can resynchronize either a single version controlled package or all version controlled packages within
your project:
· For a single package, right-click on the package name in the Project Browser and select the Package
Control | Re-synch Status With VC Provider menu option.
· For all version controlled packages within the project, click on the Project | Version Control | Re-synch
Statuses of All Packages menu option.
For a given package, the re-synchronization process queries the corresponding version control provider to find
the status of the package file associated with the version-controlled package. If necessary, the process then
updates the package flags within the model database, to synchronize the package status recorded in the
model with the value reported by the version control provider.

© 1998-2010 Sparx Systems Pty Ltd

 268 Projects and Teams | Change Management

The results of the re-synchronization process are sent to the Enterprise Architect Output window, as shown
below:

Double-click on any result message to select, in the Project Browser, the corresponding package.

Note:
This process does not cause any package data to be:
· exported from your model to the associated package file, or
· imported from a package file into your model's package data.
If a package has been checked-out and modified with Enterprise Architect, but your version control provider
reports the package file as checked-in, running this process marks the package within Enterprise Architect as
being checked-in, without exporting and committing the pending changes. Subsequently checking-out the
package imports the latest revision of the package file from version control, effectively discarding the
uncommitted modifications from the model.
Similarly, if a package file is checked-out in the version control system, but not in the Enterprise Architect
model, running this process marks the package within the model as checked-out, but it does not import the
associated package file from the version control system. Consequently, it is possible to check-in a package
from Enterprise Architect that is potentially out of date, compared to the latest revision of the package file
within the version control system.

3.5.1.3.14 Offline Version Control

When loading a model that uses version control, Enterprise Architect normally initializes a connection to the
version control system for each Version Control Configuration defined in the model.
If Enterprise Architect is unable to connect a Version Control Configuration for any reason, it displays warning
messages to notify you and provides 'offline' version control functionality for all packages associated with the
failed connection.
You can prevent Enterprise Architect from attempting to make any version control connections by selecting
the Project | Version Control | Work Offline menu option before loading a model. This is useful if you know
that Enterprise Architect cannot connect to your version control system. For example, if you are working on a
laptop computer that is disconnected from your network and you have an Enterprise Architect model that uses
a large number of Version Control Configurations, choosing to work offline before you load the model enables
you to avoid all the error messages that Enterprise Architect would normally display as each version control
connection attempt fails.
You can switch between working offline and working online at any time, either before or after a model is
loaded. Toggle the Project | Version Control | Work Offline menu option. Enterprise Architect disconnects or
reconnects version control (depending on connection availability) according to your selection.

Use Version Control Whilst Disconnected From Your Version Control Server
Enterprise Architect 'remembers' the status of a model’s version controlled packages. Packages that were
checked out 261 to you prior to disconnecting from the server are still shown as checked out to you, even
though you are no longer connected to the server. You can still edit these packages as you normally would.
Packages that were not checked out to you prior to disconnecting from the server are shown as version

Enterprise Architect User Guide

 Projects and Teams | Change Management 269

controlled and locked. You cannot edit these packages until you check them out.

Offline Check Out

In releases of Enterprise Architect from release 6.0 onwards, you can 'check-out' and edit a version controlled
package even when your machine is disconnected from the version control server. In the example below, the
colored 'figure 8' icon 233 for DFD indicates that you have checked it out whilst offline (the gray 'figure 8' icon
shown against Logical View indicates that you have checked out a version-controlled package online).

Important:
You should be aware that the version control system - and therefore other users - have no way of knowing
that you have 'checked-out' a package whilst offline. It is not possible to merge changes to an XMI file that
result from two users editing the same package at the same time. If an offline checkout leads to two people
editing the same package at the same time, when the changes are brought back online the first-saved set of
changes is lost.

Check in a Package That Was Checked Out Offline

Once you reconnect your machine to the version control server, if the package you checked out offline is not
currently checked out by another user, you can check in that package. However, before Enterprise Architect
checks in such a package, it compares the local working copy of the package file with the latest revision in the
repository. (These package files remain unchanged in your work area until Enterprise Architect exports the
package again before checking in.) If the repository version remains unchanged from when you last updated
your local copy, Enterprise Architect exports and checks in your package without further prompting.
On the other hand, if the repository now contains a file that has changed since you last updated your local
copy, checking in your package overwrites whatever those changes might be. Enterprise Architect displays a
message warning you of the pending data loss and giving you the opportunity to abort the check in. At this
point, you must decide whether to discard your own changes, using the Undo Check Out command, or
continue with your check in and overwrite the changes that have been committed to the repository since you
last updated your local copy from the repository.
You can use the File Properties command to determine who checked in the last changes to this package.
This might help you to discover what changes have been uploaded and decide whose changes take
precedence.

Update Before You Disconnect

Whenever you are connected to the version control server, you are always working with the latest version of a
package. This is because you cannot modify a package until you check it out from version control, and
checking it out loads the latest revision from the repository into your model.
These rules do not apply when you are disconnected from the version control server. You are working on
whatever versions you have on your machine, dating back to the last time you updated your local copy of each
version controlled package. So, if you are planning to work on a model whilst disconnected from version
control, it is a very good idea to make sure that you have the latest versions of all packages before you
disconnect. The Get All Latest 257 option makes this a simple task.

3.5.2 Tracking Changes

Enterprise Architect provides two separate but complementary facilities for tracking changes to data across
the project:
· Auditing of model changes
· Baselining and differencing to capture and roll back changes

Audit Models
Auditing 270 is a project-level feature, available in the Corporate, Business and Software Engineering, System
Engineering and Ultimate editions, that enables you to record model changes in Enterprise Architect.

© 1998-2010 Sparx Systems Pty Ltd

 270 Projects and Teams | Change Management

By enabling this option, model administrators can view a range of information regarding changes, such as:
· Who changed an element
· How many elements they changed
· When they changed the data
· What the previous values were, and
· What type of elements they changed.

Baselines and Differences

The Enterprise Architect Corporate, Business and Software Engineering, System Engineering and Ultimate
editions provide a facility to 'Baseline 279 ' or snapshot a model branch in XMI format at a particular point in
time, and store it within the model in compressed format.
More than one baseline can be stored against a single Enterprise Architect package. Using Baselines, you
can compare packages at the current and earlier stages of development, using the Compare (Diff) 283 utility.
The Compare utility is available in the Professional, Corporate, Business and Software Engineering, System
Engineering and Ultimate editions of Enterprise Architect. It enables you to compare the current model with
either an exported or a version-controlled Enterprise Architect XMI file on disk, as well as with a Baseline.

3.5.2.1 Auditing
Auditing is a project-level feature that enables model administrators to record model changes in Enterprise
Architect.
By enabling this option, you can view information on changes such as:
· Who changed an element
· How many elements they changed
· When they changed the data
· What the previous values were, and
· What type of elements they changed.
Auditing does not record changes to RTF Templates, Model Documents, Baselines or Profiles.
The Auditing facility is available in the Corporate, Business and Software Engineering, System Engineering
and Ultimate editions.

Warning:
If your site runs separate editions of Enterprise Architect, when Auditing is turned on in a project any Desktop
or Professional edition users are locked out of the project. To restore access, turn Auditing off in the project
from a Corporate, Business and Software Engineering, Systems Engineering or Ultimate edition instance of
Enterprise Architect.

Auditing Quickstart
To quickly enable auditing and see it in action, see Auditing Quickstart 271 .

Audit Settings
Once auditing is enabled within a project, you have a variety of options available for customizing what is
recorded by the audit. See Audit Settings 271 for more information on the different settings available.

The Audit View

To view what has been recorded by the audit, use the Audit View 274 , which provides an interface to
everything recorded by auditing.

Note:
If security is enabled, you must have Audit View 198 permission to display data in the Audit View.

You can also obtain a snapshot of selected items in the model, using the Model View 1222 facility. In the
Corporate, Business and Software Engineering, Systems Engineering or Ultimate editions of Enterprise
Architect, this facility enables you to automatically generate this snapshot at intervals and, if there are changes
in the items collected by the defined search, to trigger a notification to you of such changes. This enables you

Enterprise Architect User Guide

 Projects and Teams | Change Management 271

to monitor work flow 342 and other events of concern to you.

RTF Report
You can generate an RTF report that includes the audit history information for the selected element or
package, by choosing the basic + audit RTF template 1573 .

Audit History
Using Auditing, you can track changes to an element or connector over time. However, enabling Auditing also
enables an Audit History 278 tab in the system Output window, which summarizes all changes made to the
selected element or connector.

Performance Issues
By enabling auditing on a project, you increase the time taken for most actions. For most modeling tasks, this
increase is insignificant. However, there are some instances where the difference is more substantial. See
Performance Issues 279 for more information.

3.5.2.1.1 Auditing Quickstart

To quickly enable auditing and see it in action, follow the instructions below.

Enable Auditing
To enable Auditing:
1. Select the View | Other Project Tools | Audit View menu option to open the Audit View 274 .

2. Click on the Audit Settings button. The Audit Settings 271 dialog displays.
3. Select the Enable Auditing checkbox.
4. Click on the OK button to close the Audit Settings dialog.
5. Close the Audit View dialog.

Make Changes
Change and save your project; for example:
· Add a new package
· Add a new Class
· Add a new connector
· Change the name of an element
· Delete an element.

View Changes in the Audit View

Open the Audit View again (View | Other Project Tools | Audit View), and click on the Refresh (or Load)
button to display a record of the changes you made.

3.5.2.1.2 Auditing Settings

The Audit Settings dialog enables you to change what is recorded by the Auditing facility.

Note:
If security is enabled, you must have Audit View permission to turn Auditing on, and Audit Settings 198
permission to change Audit settings.

To open the Audit Settings dialog:

1. Select the View | Other Project Tools | Audit View menu option to open the Audit View.
2. Click on the Audit Settings button. The Audit Settings dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 272 Projects and Teams | Change Management

The settings on this dialog are described in the following topics:

· Audit Scope 272
· Audit Logs 272
· Auditing Level 273
· Audit Options 273

3.5.2.1.2.1 Audit Scope

The Audit Settings dialog provides checkbox options for turning Auditing on, and for including or excluding
areas of processing in Enterprise Architecture.
· Enable Auditing - select this checkbox to turn the Auditing facility on
· Audit XMI Import - select this checkbox to include XMI importing in the audit
· Audit XMI Export - select this checkbox to include XMI exporting in the audit
Note:
As version control uses XMI, these options must be selected to record changes from checking out
packages.

· Audit Reverse Engineering - select this checkbox to include reverse engineering in the audit
· Use Database Timestamp - select this checkbox to use the database server's timestamp instead of each
user's local timestamp; this improves security.
Note:
The Use Database Timestamp option is not available for projects stored in .EAP Files.

3.5.2.1.2.2 Audit Logs

The Audit Settings dialog enables you to administer your audit records.
As the number of records increases, the performance of the Audit View 274 reduces. It is recommended that
audit records that are not regularly required are saved to file, then cleared from the project. This helps ensure
high performance.
· Clear Logs - removes all log data from the current project; all data is permanently deleted. To keep the
audit records outside the project, click on the Save Logs button to save the records before clearing them
from the project
· Save Logs - saves a copy of the log items currently held in the database; these items remain in the
database. To remove the items after saving the copy, click on the Clear Logs button
· Load Logs - enables you to load a previously saved set of logs back into the project. The file is not deleted
by this operation. If duplicate logs exist in both the project and the file, these are skipped.

Enterprise Architect User Guide

 Projects and Teams | Change Management 273

Note:
Some of these functions can be accessed through the Automation Interface. For more information, see the
Repository 1680 topic.

If you save or clear the log items, Enterprise Architect prompts you to specify whether to save or clear the
items covering a specific period of time.
· If you click on the No button, you save or clear all log items currently held in the database.
· If you click on the Yes button, the Time Filter dialog displays, on which you select a standard time period or
define your own.

3.5.2.1.2.3 Auditing Level

The Auditing Level panel provides three options that determine what kind of model changes are recorded:
· Core - select this radio button to record changes to elements (including attributes and operations),
packages, connectors and some model-level information
· Standard - select this radio button to record the same changes as the Core option, plus changes to
diagrams
· Extended - select this radio button to record the same changes as the Standard option, plus changes to
security.

3.5.2.1.2.4 Audit Options

The following elements are always audited:
· Packages
· Notes
· Boundary
· Text
· Diagrams (if on Standard 273 level)
· Security (if on Extended 273 level)
The audit options enable you to configure auditing to record changes to only certain types of elements.
· Maintenance - select this radio button to audit maintenance elements; that is:
· Package
· Requirement
· Feature
· Use Case
· Actor
· Note
· Issue
· Change

© 1998-2010 Sparx Systems Pty Ltd

 274 Projects and Teams | Change Management

· Core Structural - select this radio button to audit maintenance elements plus some structural elements;
that is:
· Package
· Class
· Interface
· Signal
· Node
· Component
· Artifact
· Part
· Port
· Device
· All - select this radio button to audit all elements
· Custom - select this radio button to audit element types that you specify.
If you select the Custom option, the Customize button is made available. Click on this button to display a list
of element types, and select the checkbox against each element type to include in the audit (or click on the
Select All button to select every element type). Click on the OK button to save the selection.

Note:
Connectors are audited when they are connected to an element that is included in the Audit Options.

3.5.2.1.3 The Audit View

The Audit View provides an interface to the information that has been recorded by auditing. Open the Audit
View by clicking on the:
· View | Other Project Tools | Audit View menu option.

Note:
If security is enabled, you must have Audit View 198 permission to display data in the Audit View.

The Audit View is divided into three main areas:

· View controls
· Audit tree
· Record display.
The data in the Audit tree and Record display is determined by the view controls and mode 277 and, if
synchronizing 277 with the Project Browser, by the package, diagram or element you have selected.

View Controls
The view controls provide a variety of settings for controlling auditing and the display of audit records.

For information on these controls, see Audit View Controls 276 .

Audit Tree
The audit tree displays the logs that have been recorded by auditing. What is displayed in the tree is affected
by the settings of the View Controls section, such as:
· Sorting
· Filter (by time)

Enterprise Architect User Guide

 Projects and Teams | Change Management 275

· Mode
· Auditing settings 271 (what was actually recorded).

In the audit tree:

· The green tick indicates a creation
· The yellow pencil indicates an edit
· The red cross indicates a deletion.
If you right-click on an element in the audit tree (such as MyClass) a context menu displays. This menu
enables you to locate the selected element in:
· The Project Browser
· Any diagrams in which it exists.

Record Display
The record display is in two parts: the identity of the selected change, and the actual change made.

Identity
The identity of a change consists of:
· The Windows username of the user that made the change
Note:
If security is enabled, the name is of the format: WindowsUsername(SecurityUser).

· When the change was made

· The path of the change (for example, Class Class1 - Attribute Att1 - Attribute Constraint Constraint).

Changes
The changes are displayed in a table format, showing the Property (or data item) name, its original value
before the change and its value after the change.
If you double-click on an item in the list of changes (or right-click and select the Show Differences context
menu option) the Difference dialog displays. This shows the specific changes that have been made,
highlighting the edited, created or deleted characters.

© 1998-2010 Sparx Systems Pty Ltd

 276 Projects and Teams | Change Management

3.5.2.1.3.1 Audit View Controls

The Audit View controls provide a variety of settings for controlling auditing and the display of audit records.

· The Load (Advanced, Deleted or Raw 277 modes) or Refresh (Standard 277 mode) button reloads the
Audit Tree, updated with any new audit results.
· The Search button enables you to search through log items for a particular area. Log Items can be
searched by Name, Type or GUID. The items are loaded and filtered with the current Sort By, Time Filter
and Mode settings. If you refresh the Audit View, you must run the search again.
· The Audit Settings button opens the Audit Settings 271 dialog.

Sort-by Panel
The Sort By panel enables you to select one of three display settings:
· Type - changes are grouped under element type (such as Class or Requirement), and then grouped under
the changed element.

· User - changes are grouped under user name. The number of changes for each user is also displayed.
Under each user name, changes are grouped as for the Type sort.

· Deletions - displays only deletions, shown in chronological order. If used with the Search button, this can
be useful for recovering information on missing elements.

Enterprise Architect User Guide

 Projects and Teams | Change Management 277

Filter by
The Filter By Date/Time checkbox enables filtering by time periods, which you set using the Time Filter
dialog; click on the Filter Settings button to display this dialog.

Select:
· Today - to display changes occurring today
· Previous Hour - to display changes occurring in the last 60 minutes
· Previous 24 Hours - to display changes occurring in the last 24 hours
· Previous Week - to display changes occurring in the last 7 days
· Previous 30 Days - to display changes occurring in the last 30 days
· Previous Year - to display changes occurring in the last 365 days
· Custom - to define your own time period, using the From and To fields.

Note:
The six pre-configured time periods automatically update when you click on the Refresh button. Custom
periods are static and do not automatically update.

Changes that occur outside the filter period you select are not shown in the Audit View. Once you have set a
filter period, it remains set if you deselect the Filter By Date/Time checkbox. The Custom time period, too, is
retained so that you can re-use it or modify it later if required.

Status Text
Beneath the Filter By Date/Time checkbox, status text displays to show which mode has been selected (see
below), and which time filter 277 is being applied to the data.

Mode Button
The Mode button enables you to change the mode of the Audit View. The button displays a drop-down menu
from which you can select:
· Standard - to interact with the Project Browser
· Advanced - to load large sets of log items
Note:
When in Advanced mode, a special Audit Settings group can be displayed in the Audit Tree 274 . This
records when Auditing has been enabled and disabled, along with who made the change, and the date
and time of the change.

· Raw - to display all audit records without sorting (although any search and filtering you define still apply).
Additional database information is displayed; this additional information might be unimportant.

Standard Mode
In Standard mode, Auditing is automatically synchronized with the Project Browser.

© 1998-2010 Sparx Systems Pty Ltd

 278 Projects and Teams | Change Management

When synchronized, and where changes have been made, the Audit View reflects your selection from the
Project Browser. If you click on:
· An element, the Audit View displays the history for that element
· A package, the Audit View displays the history for that package and its immediate children (but not the
contents of nested packages)
· A diagram, the Audit View displays the history for that diagram and its contents (which could be drawn from
a wide area of the Project Browser).

Advanced Mode
In Advanced mode, you can load sets of audit data independent of the Project Browser. These sets of data
display all significant changes, but you can reduce the selection by filtering by time or by running a search.
Advanced mode also displays:
· Changes to the Audit Settings
· When Audit Operations are executed
· Security changes (which can be browsed in the same way as other changes).

Raw Mode
In Raw mode, all data recorded by auditing is displayed in chronological order. This enables you to see a
progression of changes, which can be especially useful in determining date-time inconsistencies. Search and
filters can still be applied, enabling you to view all of today’s changes in order, or all changes for a particular
element in order, or both.

Note:
Some information displayed in Raw mode might be insignificant or only in machine-readable format.

3.5.2.1.4 Audit History Tab

When Auditing is turned on, an Auditing History tab is enabled in the Output 102 window. To see this tab, you
must have the Auditing 270 View open (however, the tab continues to display if you subsequently close the
Auditing View).

Note:
If security is enabled, you must have Audit View 198 permission to display data on the Audit History tab.

The information in the Audit History tab provides a history of changes to whichever element or connector you
have selected in the:
· current diagram
· Project Browser
· Audit View, or
· Element List.
As you select different elements or connectors, the Audit History automatically updates to reflect your current
selection. The information shows, for each change made to the element or connector:
· Who made the change
· When the change was made

Enterprise Architect User Guide

 Projects and Teams | Change Management 279

· Where the change was made

· The value of the characteristic before the change
· The value of the characteristic after the change.

3.5.2.1.5 Auditing Performance Issues

Impact of Auditing on Other Facilities

Enabling auditing on a project increases the time taken for most actions. For most modeling tasks, this
increase is insignificant; however, there are some situations where the difference is more substantial.

Large Deletions
Deleting large packages or package structures, or large numbers of elements, takes significantly longer with
auditing on. You might disable auditing 271 before performing such a deletion.

XMI Imports
Importing XMI 290 takes longer with auditing enabled. A project-level option 271 is provided for disabling
auditing of XMI Imports.

Reverse Engineering
Reverse engineering 1328 code takes longer with auditing enabled. A project-level option 271 is provided for
disabling auditing of reverse engineering.

3.5.2.1.6 Audit View Performance Issues

Most operations in the Audit View are affected by the volume of use of the database - both by other facilities
and by auditing itself. Some potential problems and their solutions are outlined below.

Navigating the Project Browser Within Auditing is Slow

· Try setting the time filter 277 to a period in the immediate past, such as Today, Previous 24 Hours or
Previous Week. This time period updates each time you open or refresh the Audit View.
· Save log items 272 outside the project with the Save Logs button. If you then clear the logs you have just
saved, the load time of the Audit View is reduced. You can reload logs into the project at any time, using
the Load Logs button.

Navigating the Audit Tree is Slow

· Close the Audit History 278 tab in the Output window.

The Audit View is Slow in Loading and Changing Modes

· Try setting the time filter 277 to a period in the immediate past, such as Today, Previous 24 Hours or
Previous Week. This time period updates each time you open or refresh the Audit View.
· Save log items 272 outside the project with the Save Logs button. If you then clear the logs you have just
saved, the load time of the Audit View is reduced. You can reload logs into the project at any time, using
the Load Logs button.

3.5.2.2 Package Baselines

Enterprise Architect includes tools to help you manage and review changes to your models over time. These
tools apply the concepts of Baselines, Differencing and Merges.
You can also obtain a snapshot of selected items in the model, using the Model Views 1222 facility. This facility
enables you to automatically generate the snapshot at intervals and, if there are changes in the items
collected by the defined search, to trigger a notification to you of such changes. This enables you to monitor
work flow 342 and other events of concern to you.
Both of these facilities are available in the Corporate, Business and Software Engineering, Systems
Engineering and Ultimate editions of Enterprise Architect.

Baselines
Enterprise Architect (Corporate, Business and Software Engineering, System Engineering and Ultimate
editions) provides a facility to create a Baseline 280 or snapshot of the contents of a selected package and its
child packages at a particular point in time. This enables you to later compare that branch of the model at that
time with the current state of the branch.

© 1998-2010 Sparx Systems Pty Ltd

 280 Projects and Teams | Change Management

Baselines are stored in the same XML format as is used for version control, but are stored within the project in
compressed format. You can also have parallel copies of parts of your model for team development, and
create Baselines within each copy to merge changes into the project master.

Differencing
Differencing (Diff, or Compare 283 ) enables you to explore the differences between the current state of a
specific part of your project, and previous or parallel versions captured in a Baseline or an XMI 1.1 file on disk.

Merges
Once Differencing is complete, you can merge information from the Baseline into the current project; it is not
possible to go the other way.
You can merge information manually, change by change, or automatically by electing to merge in all changes
in one batch procedure. You can also revert completely to the original Baseline by importing the stored XMI
directly, and merge in information and elements from a Baseline in a different project, making it possible to
keep multiple versions of a single model in synch.
The merge options 285 are available on the Compare Utility tab, which shows the results of a comparison. The
options are available through the toolbar, context menus and the keyboard.

Notes:
· You use Baselines, Differencing and Merges essentially to compare two snapshots of a specific part of
your project, to capture the differences between them and either roll back or incorporate selected changes
or all changes. Enterprise Architect Corporate, Business and Software Engineering, System Engineering
and Ultimate editions have another facility, Auditing 270 , which you can switch on to perform continuous
monitoring of changes across the project. You can dovetail your use of each facility to meet the range of
your change management requirements.
· If a package under version control forms part of a Baseline, and that package is checked in to the model,
you cannot merge the original data from the Baseline into that package.
· If security is enabled you must have Baselines - Manage 198 permission to create, import and delete
Baselines, and Baselines - Restore permission to merge data from a Baseline. Security permissions are
not required to select an existing Baseline and perform a comparison with the model.

3.5.2.2.1 Baselines
Enterprise Architect provides a facility to 'Baseline' (snapshot) a model branch at a particular point in time for
later comparison with the current package state.

Note:
This facility is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions of Enterprise Architect.

Baseline comparison is most useful for determining changes made to the model during development
compared to some Baseline saved at a crucial point - for example the completion of a phase or version
iteration. More than one Baseline can be stored against a single Enterprise Architect package. Baselines are
particularly useful during requirements management to check for changes, additions and deletions that have
occurred since the start of the current work phase. Knowing how a model has changed is an important part of
managing change and the overall development process.
Baselines are stored within the model in compressed XML format. You can save a Baseline to an external
XML file for storage or archive, or for distributing to other users working on models derived from a master
project.
Baselines are generally used in conjunction with the Compare utility (diff 283 ), which is built into the
Professional, Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect.
A typical scenario for using Baselines 281 would be to:
1. Create 282 the base model branch to a sufficient point to create a Baseline (checkpoint). Create and
store the Baseline as Version 0.1a.
2. As work continues on development, managers and developers can check the current model branch
against the Baseline for important modifications, additions and deletions. The Compare (diff) tool can be

Enterprise Architect User Guide

 Projects and Teams | Change Management 281

invoked from the Baseline dialog to check the current model branch against the stored version.
3. As required, minor Baselines can be created to check recent progress. These 'temporary Baselines' are
useful for managing change when a lot of work is being done and it is important to only see what has
changed in, for example, the last 24 hours.
4. At sign-off or the move to a new version/phase, a major Baseline can be created to capture the new
state of the model. Minor Baselines created earlier can be deleted if required to save space.

Important Considerations
· Baselines are based on the GUID or unique ID of a particular package. Enterprise Architect checks for that
ID as the root element within the XML document being used as a Baseline. When you export a package to
XML, the package you export is the root element. Likewise when you create a Baseline, the current
package is the root package of the XML Baseline. When you save information in a version control system,
the current version controlled package is again the root package of the document.
· It is not useful to create a Baseline by importing an XMI package file created by version controlling a
package that itself contains version-controlled child packages. That type of XMI package file contains stubs
for the child packages, not full information on the child packages and elements.
· XML files must be in the same format used by the Baseline engine - currently the UML 1.3 XMI 1.1 format
(plus Enterprise Architect extensions), which contains all the information necessary to reconstruct a UML
model, even a UML 2.x model.

3.5.2.2.1.1 Manage Baselines

Enterprise Architect provides a range of facilities for working with and managing Baselines, through the
Manage Baselines dialog.
To open this dialog, right-click on the package at the head of the appropriate model branch and select the
Package Control | Manage Baselines context menu option.

Option Use to

Current Baselines Review the baselines for the current model branch, listed by version reference 282 with

© 1998-2010 Sparx Systems Pty Ltd

 282 Projects and Teams | Change Management

Option Use to

For Package: the highest alphabetical/numerical value at the top.

<Name>
If an entry is longer than the display area, a horizontal scroll bar displays at the bottom
of the panel. Use this to scroll to the text that is not shown.

Show Differences Run the Compare 283 utility on the selected Baseline and the current model branch,
and to display the differences 284 between the two.

Restore to Completely restore the model branch from the selected Baseline.
Baseline

New Baseline Create a new Baseline 282 .

Delete Selected Delete the selected Baseline.

Load Other Display a drop-down menu that enables you to load Baselines from another model, in
Baselines either a .EAP file or a DBMS file.
· For .EAP files, a browser displays; locate the required project file
· For DBMS files, the Windows Data Link Properties dialog displays; select the
data provider and click on the OK button to display the Select Data Source
dialog, from which you select the required project.
In either case, the Connected To: message at the bottom of the Manage Baselines
dialog changes to the name of the alternative model. To return the dialog to the
original project, select the third option on the drop down list: Load From Selected
Package.

Import File Import an XML 1.1 file from the file system as a new Baseline for this current model
branch.

Export File Export the selected Baseline to an XML file on disk.

Compare Model to Compare the selected model branch with an XML 1.1 file on disk. A browser displays,
File which you use to locate the file.

Options Set filters 284 to make the comparison more specific.

3.5.2.2.1.2 Create Baselines

Open the New Baseline dialog by clicking on the New Baseline button on the Manage Baselines 281 dialog.

Option Use to

Name Display the package name of the currently selected model branch.

Version Type a unique version reference for this Baseline. This can consist of any alphanumeric
characters.
The Manage Baselines dialog sorts the Baselines according to the value of this field.

Enterprise Architect User Guide

 Projects and Teams | Change Management 283

Option Use to

Include Include the entire sub-package hierarchy of this branch in the Baseline. Defaults to selected.
sub-
If you deselect the checkbox, only the immediate contents (XMI stubs) of the package are
packages included in the Baseline.

Note Edit the default current time and date to any other value. The field is a single-line entry, for
display on the Manage Baselines dialog (a one-line-per-entry list).

Click on the OK button to create a new Baseline and return to the Manage Baselines dialog.

3.5.2.2.1.3 The Compare Utility (Diff)

Notes:
· This utility is available in the Professional, Corporate, Business and Software Engineering, System
Engineering and Ultimate editions of Enterprise Architect.
· You cannot compare the current model with an XMI 2.1 file; the utility can only compare with an XMI 1.1
file.

Enterprise Architect has a comprehensive and powerful differencing utility built in. This utility enables you to
compare a model branch in Enterprise Architect with:
· A Baseline created using the Baseline functionality (Corporate, Business and Software Engineering,
System Engineering and Ultimate editions)
· A Baseline stored in a different model
· An XML 1.1 file on disk created previously using the Enterprise Architect XML export facility (user selects
file), or
· The current version-controlled XMI 1.1 file on disk as created when using Version Control in Enterprise
Architect (file automatically selected).
Compare (diff) lets you explore what has changed within a model over time and how previous versions of a
model branch differ from what is currently in the model. It is even possible to do a full model comparison by
exporting all of Model A to XMI, then using Compare Model to File from within the current model (Model B).
Comparing and checking model development at various points in the process is an important aspect of
managing change and development, keeping track of what is being modified and ensuring the development
and design process is on track.
Access to the Compare utility is available from:

1. The Baseline 281 dialog 281 ; from the Project Browser context menu, select the Package Control |
Manage Baselines option.
2. The Project Browser context menu; select Package Control | Compare with XMI File (for a package
not under version control).
3. The Project Browser context menu; select Package Control | Compare with Controlled Version (for a
package under version control).

Differencing With Baselines

As a Baseline is stored within a model and contains all the information, elements and connections for a
package at a point in time, it can be used within Enterprise Architect to track changes to model elements over
time. The Differencing engine first builds a representation of the current package in memory, based on what is
currently in the model. It then compares this with the stored Baseline, highlighting changes, new elements,
missing elements and elements that have been moved to other packages. It is possible to filter the resultant
output 284 to display only one particular kind of change: for example, additions to the model.
If a Baseline has been created to ignore child package content 282 , a comparison between that Baseline and
the model does not include any child package content in the model.
See Example Comparison 284 for an example of a model comparison.

© 1998-2010 Sparx Systems Pty Ltd

 284 Projects and Teams | Change Management

3.5.2.2.1.4 Compare Options

The Compare Options dialog enables you to refine the output of the Compare utility when it compares the
current model with a Baseline. To display the dialog, either:
· Click on the Options button on the Manage Baselines dialog, or
· Click on the Compare Options icon 285 on the Compare Utility tab toolbar.

Option Use to

Always Expand to Always display the list of elements fully expanded to show changes.
Differences
If you deselect the checkbox, when the Compare Utility tab is first opened it lists the
package contents to element level, and you expand each element as required to show
the changed items.
For large branches of the model, it is better to leave the checkbox unselected.

Show Elements List elements that:

that are
· Have been changed since the Baseline was created
· Are in the Baseline only (that is, have been deleted from the model since the
Baseline was created)
· Are in the model only (that is, have been created since the Baseline was created)
· Have not changed since the Baseline was created (you might generally leave this
checkbox unselected).
Suppress these Exclude:
Changes
· Changes to diagrams
· Changes to the Date Modified field for an item
· Changes to the Date Created field for an item
· Child items of a deleted item
· Changes to advanced properties (defaults to selected).

If the Compare Utility tab shows the results of a Baseline comparison, when you click on the OK button the
display refreshes to refine the information according to the options you have selected.

3.5.2.2.2 Example Comparison

The diagram below shows the result of a comparison between a package (Business Process Model) in the
current project and that package in a Baseline (version 0.1) captured at an earlier date. Notice that:
· The results are displayed on the Compare Utility tab.
· A hierarchy of model elements is displayed in the left-hand pane. It is clearly visible, from the Status
column and from the triangular icons, which items in the hierarchy have been changed (Status Changed),
deleted from the model (Baseline only), added to the model (Model only) and switched to different
packages (Moved) since the Baseline was captured.

Enterprise Architect User Guide

 Projects and Teams | Change Management 285

· If you click on an item with a Status entry in the left hand pane, the right-hand pane displays a table of
properties showing the values of those properties in the current model and in the Baseline. For each
property where there is a difference between the model and the Baseline, the row is highlighted. This
example shows that the Class element named Application was moved from the Business Process Model
package (as shown in the Baseline) to the Business Rules Model package on 5 June 2009 (as shown in
the Model).

The Compare Utility tab enables you to perform operations (such as merging or rolling back changes) on the
reported information, using the toolbar, context menu and keyboard 285 .

Higher Level of Detail

The right panel of the Compare Utility tab might, for some fields, display only part of the value (such as
Advanced Properties, above). It might also not be immediately obvious what a change is. In either case, you
can double-click on the property to display full details and to highlight the exact differences. The following
example shows the highlighted changes to Parent Package.

3.5.2.2.2.1 Compare Utility Tab Options

The Compare Utility tab enables you to perform operations on the reported information, using the toolbar,
context menu and certain keyboard keys.

Note:
If a package under version control forms part of a Baseline, and that package is checked in to the model, you
cannot merge the original data from the Baseline into that package.

Toolbar
The toolbar is at the top of the left-hand panel. The icons operate either on the comparison as a whole or on

© 1998-2010 Sparx Systems Pty Ltd

 286 Projects and Teams | Change Management

the currently-selected item in the left hand panel.

The toolbar icon names and functions are, from left to right:

Option Use to

Refresh Re-run the comparison to refresh the current display.

Merge To Model Merge the values of the currently-selected item in the Baseline back into the model.

Next Change Highlight the next changed item (skips Moved items).

Previous Change Highlight the previously-changed item.

Expand All Fully expand the selected item.

Collapse All Collapse the changed items in the selected item.

Expand To Changed Expand the selected item to show changed items only (in the event that you have
Items selected to also show 284 unchanged items in the comparison).

Find in Project Highlight the item in the Project Browser.

Browser

Log To XML Log the changes to an XML file. A browser displays, on which you specify the file
name and location.

Compare Options Display the Compare Options 284 dialog.

Manage Baselines Display the Manage Baselines 281 dialog.

Help Display the Help topic Baselines, Differencing and Merges 279 .

Context Menu
Each item in the hierarchy has a context menu, which you display by right-clicking on the item. The options
displayed depend on the level of the item in the hierarchy, but include some or all of the following:

Option Use to

Merge from Baseline Restore the item in the model to the Baseline state, or restore a deleted item from
the Baseline.
Add from Baseline

Delete from Model Remove a recently-created item from the model.

Merge From Baseline (For the root node of the hierarchy on the Compare Utility tab.)
(with Options)
Display the Merge dialog (see below) which enables you to specify options for
rolling back the whole model branch to the Baseline state.

Refresh (Object-level items).

Re-run the comparison to refresh the current display.

Find in Project Locate and highlight the item in the Project Browser.
Browser

Expand All Fully expand the selected item.

Expand To Changed Expand the selected item to show changed items only.
Items

Enterprise Architect User Guide

 Projects and Teams | Change Management 287

Option Use to

Collapse All Collapse the changed items in the selected item.

Log To XML Log the changes to an XML file. A browser displays, on which you specify the file
name and location.

Compare Options Display the Compare Options 284 dialog.

Select the appropriate checkbox against each type of difference to roll back in the model from the Baseline.

Option Use to

Changed Restore all changed items in the model branch to the Baseline state.

In Baseline Only Restore all deleted items to the model branch from the Baseline.

In Model Only Remove all recently-created items from the model branch.

Moved Restore all moved items to their original locations, as identified in the Baseline.

Full Restore from Completely restore the model branch to the version held in the Baseline XMI 1.1
XMI file, (using the XMI Import function).
(Automatically selects all the other options.)

Keyboard
You can also use the following keyboard keys to move up and down the hierarchy, or to roll back changes:
· [Ctrl]+[$] - expand and highlight the next changed item
· [Ctrl]+[#] - expand and highlight the previous changed item
· [Ctrl]+[!] - undo the changes for a selected item (roll back to the Baseline values).

3.5.3 Model Transfer

Enterprise Architect enables you to transfer data between projects.
The mechanisms available include:
· XMI Import and Export 288 of sections of the model
· CSV Import and Export 300 of sections of the model
· Data Transfer 306 of the whole model between files, and between files and repositories.

© 1998-2010 Sparx Systems Pty Ltd

 288 Projects and Teams | Change Management

3.5.3.1 XMI Import and Export

What is XMI?
XML Metadata Interchange (XMI) is an open standard file format that enables the interchange of model
information between models and tools.
XMI is based on XML, and is defined by the OMG. Enterprise Architect uses XMI as a method of importing and
exporting model specifications between different UML packages, Enterprise Architect projects and other tools
that support XMI.
Enterprise Architect supports the XMI 1.1, 1.2 and 2.1 specifications, but does not fully support the older 1.0
specification. When importing or exporting to XMI 1.0, some loss of data occurs due to the limitations of XMI
1.0. XMI 1.1 has support for UML 1.3, whereas XMI 2.1 has support for UML 2.0 and UML 2.1.
With XMI, model details can be exchanged between different UML tools and other tools that are capable of
using XMI. Limited support for export to Rational Rose is provided using the Rose version of the XMI 1.1
specification, as implemented by Unisys for Rational products.
Packages can be exported from and imported into Enterprise Architect models. This greatly improves the
flexibility and robustness of Enterprise Architect models by enabling Analysts and Modelers to externalize
model elements in XMI for version control, distributed development, post processing and transferring
packages between models. When performing Enterprise Architect-to-Enterprise Architect transfers, ensure
that the XMI version selected is 1.1 or 2.1.

XMI Tasks
Tasks you might perform in importing and exporting XMI include:
· Setting XML Options 367 : XMI import, export and package control all rely on saving and loading XML files;
you can set a number of options to streamline this process
· Exporting a package 289 to XMI in XMI 2.1 (and earlier)
· Importing from XMI 290 with support for XMI 2.1 (and earlier)
· Setting up controlled packages 293
· Manually controlling a package 299 by linking it to an XMI file
· Batch exporting 298 controlled packages
· Batch importing 298 controlled packages
· Factoring in the limitations of XMI 293
· Applying a UML Data Type Definition 293 (DTD)
For further information on XMI, including specifications, see the OMG XML/XMI Technology topic.

Important:
When you import an XML file over an existing package, ALL information in the current package is deleted
first. Before you import the XML file, please make sure you do not have important changes that you do not
want to lose.

Notes:
· XMI 2.1 exported by Enterprise Architect 7.0 (or later) might not be correctly imported into earlier versions
of Enterprise Architect.
· When you select to apply a DTD during an XMI 1.1 export, the UML_EA.DTD file is written to the output
directory into which the XML files are written (unless the UML_EA.DTD file is already present in the
directory). No error is generated if the UML_EA.DTD file is not present in this directory during the XMI
export.

However, an error does occur if you are importing an XMI 1.1 file that has been exported with the UML_EA.
DTD file, and the UML_EA.DTD file is not present in the same directory as the XMI file.

Enterprise Architect User Guide

 Projects and Teams | Change Management 289

3.5.3.1.1 Export to XMI

You can export a package to an XMI (XML-based) file.
This enables you to move Enterprise Architect model elements between models, for distributed development
183 , manual version control 299 and other benefits. It also enables limited export of Enterprise Architect model
elements to Rational Rose and other tools that implement the:
· UML 2.1 XMI 2.1 standard
· UML1.4 XMI 1.2 standard, or
· UML 1.3 XMI 1.1 / XMI 1.0 standard.
For more information regarding the limitations of XMI exporting, read the Limitations of XMI 293 topic.

Notes:
· In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Export XMI 198 permission to export to XMI.
· You can post-process the XMI content before saving the package to file, using a style sheet to convert the
output to HTML, XSL, code, or other versions of XMI. If you want to do this, you must import the required
style sheet into the project through the Resources 667 window.

Export a Package to XMI

To export a package to XMI, follow the steps below:
1. In the Project Browser window, select the package to export.
2. Either:
· Right-click and select the Import/Export | Export Package to XMI context menu option, or
· Select the Project | Import/Export | Export Package to XMI menu option.
The Export Package to XMI dialog displays.

3. In the Filename field, type the directory path and filename into which to output the XMI file.
4. If required, in the Stylesheet field click on the drop-down arrow and select a stylesheet to post-process
XMI content before saving to the file.
5. Select the Export Diagrams checkbox to export diagrams in the file.

© 1998-2010 Sparx Systems Pty Ltd

 290 Projects and Teams | Change Management

6. Select the Export Alternate Images checkbox to export the alternative images used in the diagrams.
7. Select the Format XMI Output checkbox to format output into readable XML (this takes a few more
seconds at the end of the run).
8. Select the Write Log file checkbox to write a log of export activity (recommended); the log file is saved
to the directory into which you export the XMI file.
9. If using XMI 1.1, select the Use DTD checkbox to use the UML1.3 DTD (recommended). Setting this
option validates the correctness of the model and checks that no syntactical errors have occurred. For
more information regarding the use of DTDs, see the UML DTD 293 topic.
10. Leave the Enable full EA Roundtrip checkbox selected to keep data specific to Enterprise Architect in
the XMI file.
11. In the XMI Type: field, click on the drop-down arrow and select the appropriate XMI format:
· XMI 1.1, to generate output in XMI 1.1 format (necessary if you intend to use this file in a comparison
with the model 283 at a later time)
· XMI 2.1, to generate output in XMI 2.1 format.
10. Select the Unisys/Rose Format checkbox to export in Rose UML 1.3, XMI 1.1 format.
11. Select the Exclude EA Tagged Values checkbox to exclude Enterprise Architect-specific information
from the export to other tools.
12. Click on the Export button.

Important:
When exporting and importing with XMI 1.0 with Enterprise Architect, some loss of data occurs due to the
limitations of XMI 1.0.

Notes:
· XMI 2.1 exported by Enterprise Architect 7.0 (or later) might not be correctly imported into earlier versions
of Enterprise Architect.
· When you select to apply a Data Type Definition (DTD) during an XMI 1.1 export, the UML_EA.DTD file is
written to the output directory into which the XML files are written (unless the UML_EA.DTD file is already
present in the directory). No error is generated if the UML_EA.DTD file is not present in this directory
during the XMI export.

3.5.3.1.2 Import from XMI

You can import a package from an XMI (XML-based) file. This enables you to move Enterprise Architect Model
elements between models, for distributed development, manual version control 299 and other benefits.

Important:
· When you import an XML file over an existing package, ALL information in the current package is deleted
first. Before you import the XML file, please make sure you do not have important changes that you do not
want to lose.
· If you are importing an XMI 1.1 file that was previously exported with a UML_EA.DTD file, the UML_EA.
DTD file must be present in the directory into which the XMI file is being written. An error occurs if the
UML_EA.DTD file is absent.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Import XMI 198 permission to import packages from
XMI.

You can import the following formats:

· UML 1.3 (XMI 1.0)
· UML 1.3 (XMI 1.1)
· UML 1.4 (XMI 1.2)
· UML 2.0 (XMI 2.1)
· UML 2.1 (XMI 2.1)

Enterprise Architect User Guide

 Projects and Teams | Change Management 291

· MOF 1.3 (XMI 1.1)

· MOF 1.4 (XMI 1.2)
Enterprise Architect can also import the *.emx and *.uml2 files 291 generated by tools such as Rational
Software Architect (RSA) and Rational Software Modeler (RSM).

Import From XMI

To import a package from XMI, follow the steps below:
1. In the Project Browser window, select the package into which to import the file.
2. Either:
· Right-click and select the Import/Export | Import Package from XMI context menu option, or
· Select the Project | Import/Export | Import Package from XMI menu option.
The Import Package from XMI dialog displays.

3. In the Filename field, type the directory path and filename from which to import the XMI file.
4. Select the Import diagrams checkbox to import diagrams.
5. Select the Strip GUIDs checkbox to remove Universal Identifier information from the file on import. This
enables the import of a package twice into the same model; the second import requires new GUIDs to
avoid element collisions.
6. Select the Write log file checkbox to write a log of import activity (recommended); the log file is saved
in the directory from which the file is being imported.
7. Import using single transaction defaults to selected; if the import encounters locking issues, or if you
are importing a large XMI file, deselect the checkbox to import the data items separately and identify
problem items without blocking the whole import.
8. If you are importing from Rose XMI 1.1, click on the Treat Imported Datatypes drop-down arrow and
select the datatypes to add to the model.
9. Click on the Import button.

3.5.3.1.3 Import EMX/UML2 Files

Rational Software Architect (RSA) enables you to add many UML models under a single root.
These models can have cross references between them. However, RSA cannot save the entire root as one
file; it saves each UML model as a separate EMX file. This means that an EMX file with cross-references is not
self-contained as it references elements in another EMX file.
In releases earlier than release 7.0, Enterprise Architect treats each EMX file as a separate model and hence
does not allow for cross-references between them. From release 7.0, Enterprise Architect enables these

© 1998-2010 Sparx Systems Pty Ltd

 292 Projects and Teams | Change Management

cross-references. You therefore have the option of importing a single EMX/UML2 file or a group of EMX/UML2
files. This option enables you to select a group of related files and import them together, thereby retaining the
cross-references between the different files.
To import single or multiple *.emx /*.uml2 files into Enterprise Architect, follow the steps below:
1. In the Project Browser window, select the package into which to import the file.
2. Either:
· Right-click and select the Import/Export | Import Package from XMI context menu option, or
· Select the Project | Import/Export | Import Package from XMI menu option.
The Import Package from XMI dialog displays.

3. Click on the Import EMX / UML2 Files button. The Import Package from XMI dialog redisplays,
formatted for .EMX/.UML2 file imports.

4. Click on the [ ... ] (Browse) button next to the Directory field. The Select Import EMX / UML2 File(s)
dialog displays, which enables you to select multiple files.

Enterprise Architect User Guide

 Projects and Teams | Change Management 293

5. Select the file or files (use [Ctrl]+click or [Shift]+click to select several files) and click on the Open
button. The Import Package from XMI dialog redisplays; the Selected File(s) panel lists the selected
files.
6. Select the Write Log File checkbox to write a log of import activity (recommended); the log file is saved
in the directory from which the file is being imported, with the name import.log.
7. Click on the Import button. Enterprise Architect indicates the progress of the import in the Import
Progress field.

3.5.3.1.4 Limitations of XMI

Whilst XMI is a valuable means of specifying a UML model in a common format, it is relatively limited in the
amount of additional information it can tolerate using the standard syntax. A lot of information from an
Enterprise Architect Model must be converted to Tagged Values, which import into other modeling systems as
additional information or are ignored completely.
Enterprise Architect can both generate and read XMI 1.0 and 1.1 using UML 1.3 format, XMI 1.2 using UML
1.4 format, and XMI 2.1 using UML 2.0 and UML 2.1 format. Note that round-tripping model elements using
XMI (for example, to version control or for controlled package) is only possible using XMI 1.1/UML 1.3 -
Enterprise Architect format, which uses the additional Tagged Values to store the UML 2.0 information.

Notes for Exporting to Rose and Other Tools

· There are also discrepancies in the Unisys/Rose implementation with regard to spelling mistakes and
slightly different syntax to the official XMI 1.1 specification, so problems might occur.
· The way packages are arranged in different models can impact successful import into other systems.
Experimentation is the only work around for this problem.
· Some parts of the XMI import/export process do not work as expected in products like Rational Rose; for
example, Note Links are not supported, and State Operations import but do not appear in diagrams. In
addition, Rational Rose only supports import of a full project, not a single package.
· For best results, it is recommended that you keep the model elements to export to Rose simple and
conforming as closely as possible to the UML 1.3 specification.

3.5.3.1.5 The UML DTD

When you import or export Enterprise Architect packages to XMI, the import or export process can be
validated using a Data Type Definition (DTD).
The XML parser uses the DTD to validate the correctness of the model and to check that no syntactical errors
have occurred. It is always best to use a DTD when moving packages between Enterprise Architect models as
it ensures correctness of the XMI output, and prevents attempted imports of incorrect XML.
Several DTDs for XMI/UML exist. The OMG defines a standard UML1.3 DTD for use in XMI 1.1. Enterprise
Architect uses an extension of this with some additional element extensions for non-standard UML types, such
as testing details.
Whenever you read an XML file, the XML parser looks in the current directory for the DTD - if specified - using
the DOCTYPE element in the XML file. If the parser cannot find the DTD, it records an error and aborts
processing. You must ensure the UML_EA.DTD file is in the current XML output path (generated by default).

3.5.3.1.6 Controlled Packages

Controlled packages are a powerful means of 'externalizing' parts of an Enterprise Architect model. Using
controlled packages you can:
· Support widely distributed development by having team members submit packages in the form of XML for
import into a central Enterprise Architect repository.
· Support version control 228 , by writing model elements in XML text files suitable for version control using
standard version control software. Using XMI this way enables you to manually connect to third-party
version control software outside the Enterprise Architect environment. Enterprise Architect internally
supports the configuration of version control through SCC and CVS.
· Support import and export of model elements between different models; for example, a Class library can be
re-used in many models and kept up to date in target models using controlled packages, reloading
packages as required when new versions of the Class model become available.
Package XML is standard XMI-compliant output that can be loaded into any XML viewer, or used by any XML-
based tool to perform manipulations and extracts, such as document or code generators.
Controlled packages appear in the Project Browser with a small colored rectangle to the left of the package

© 1998-2010 Sparx Systems Pty Ltd

 294 Projects and Teams | Change Management

icon, as shown below for the CIM package:

A controlled package is a package configured to save and load in XML format to a named file. The XML output
is UML1.3 compliant XMI, with Enterprise Architect extensions to support diagrams and additional model
elements.

Important
If you are importing an XMI 1.1 file that was previously exported with a UML_EA.DTD (Data Type Definition)
file, the UML_EA.DTD file must be present in the directory into which the XMI file is being written. An error
occurs if the UML_EA.DTD file is absent.

Note:
When you select to apply a DTD during an XMI 1.1 export, the UML_EA.DTD file is written to the output
directory into which the XML files are written (unless the UML_EA.DTD file is already present in the directory).
No error is generated if the UML_EA.DTD file is not present in this directory during the XMI export.

3.5.3.1.6.1 Controlled Package Menu

The Package Control sub-menu is available from the Project Browser Package context menu.
This menu is for a package that itself is not under version control (but that might contain child packages that
are under version control). For a package that is directly under version control, see the Package Version
Control Menu 257 topic.

Menu Option & Function Keys Use to

Configure (various settings for the Display the Package Control Options 295 dialog, which enables
package) you to specify whether this package (and its child packages) is
[Ctrl]+[Alt]+[P] controlled and which file it is controlled through.

Manage Baselines [Ctrl]+[Alt]+[B] Create a Baseline 281 of the current package, or compare the
current package with a previous Baseline.

Check In Branch For the selected branch of the model, (that is, the selected
package and all of its child packages) display the Select Packages
to Check In 262 dialog, listing all version controlled packages
within that branch that are checked out to you. You can then select
packages in the displayed list, to be submitted for check-in.

Check Out Branch For the selected package, check out the package and recursively
check out all of its contained sub-packages 263 . Retrieves the
latest version of the packages from the central repository,
overwriting the current packages. After check out, the packages
are available for editing.

Save package to file [Ctrl]+[Alt]+[S] Save a controlled package 297 to an XMI file.

Load package from file [Ctrl]+[Alt] Load 297 a previously-saved XMI file.
+[L]

View package XMI [Ctrl]+[Alt]+[X] Display the package XMI after the package has been exported to
XMI.

Compare with XMI file (Package not under version control.) Compare 283 the current
package with a previously-saved XMI file of the package.

Add Branch to Version Control Apply version control to all packages within a selected model
branch 264 , in a single operation.

Enterprise Architect User Guide

 Projects and Teams | Change Management 295

Menu Option & Function Keys Use to

Export as Model Branch Export 264 a newly created model branch from your own private
copy of a model.

Import a Model Branch Retrieve 265 a model branch and import it into either the source
model or another model.

Get package (for version control) Enables you to gain access from packages in the
version-controlled 228 repository that is currently available in your
model.

Get All Latest (for version control) Retrieve the latest version 228 of the package from the repository.
Available only for packages that are checked in.
The alternative option Get Latest - if displayed - is not intended for
sharing .EAP files and should only be used when users have their
own individual databases.

Re-synch Status With VC Provider (Version controlled package.) Update the version control status
value recorded for the selected package in the Enterprise Architect
project to match the value reported by the version control provider
267 , without performing an XMI import or export.

Version Control Settings Display the Version Control Settings 234 dialog.

Update Package Status Provide a bulk update on the status of a package 340 . This
includes status options such as Proposed, Validate and
Mandatory.

3.5.3.1.6.2 Configure Packages

Before you can use a controlled package, you must configure it with options such as the filename to save to/
load from, the type of export and the version number.
Once a package is configured and marked as controlled, it is displayed in the Project Browser with a small
colored rectangle next to the package icon, indicating it is a controlled package. In the example below, the
RQ01: Formal Requirements package is a controlled package.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Configure Packages 198 permission to configure
controlled packages and package properties.

Configure a Controlled Package

To configure a controlled package, follow the steps below:
1. In the Project Browser, right-click on the package to control or configure. The context menu displays.
2. Click on the Package Control | Configure menu option. The Package Control Options dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 296 Projects and Teams | Change Management

3. Set the required options, as follows:

· Select the Control Package checkbox to indicate that this is a controlled package
· Click on the Version Control drop-down arrow and select the version control repositories; this
connects the package to a specific version control configuration
· In the XMI Filename field, type or browse for the path and XMI file for importing and exporting XMI
files. The field accepts Local Path Substitution strings; for example, use an XMI local path definition
where:

myLocalPath="C:\Documents and Settings\John\Desktop\EA Models"

Then %myLocalPath%\CIM.xml is equivalent to C:\Documents and Settings\John\Desktop\EA Models\CIM.xml

· In the UML/XMI Type field, click on the drop-down arrow and select the type of XMI generated;
options include Enterprise Architect XMI/UML 1.3, Rational Rose/Unisys UML 1.3 and Generic XMI
1.0/UML 1.3 - currently only Enterprise Architect UML 1.3 is supported for complete import/export
round tripping of packages
· In the Version ID field, type the version ID number
· In the Owner field, type or select the name of the package owner
· If required, click on the Use DTD checkbox to use a Data Type Definition (DTD)
· If required, click on the Log Import/Export checkbox to log import and export activity to a log file
· If required, click on the Batch Import checkbox to mark the package as a Batch Import package
· If required, click on the Batch Export checkbox to mark the package as a Batch Export package
· If required, click on the Include sub-package checkbox to deselect it, to include only the immediate
contents of the package in an XMI export (XMI stubs); this is available only for an XMI 1.1/UML 1.3
export. If you leave the checkbox selected, the entire sub-package hierarchy of this branch is
included in the export.
4. Click on the OK button to set the Package Control options.

Note:
For batch import, the file date of the XMI file is stored. You can bypass the batch import if the file date of the
last import matches that of the current file (that is, there is no change).

3.5.3.1.6.3 Remove Package from Control

If required, you can remove the control from a package. Before removing the package control, you must check
in 261 the package if it is being used for version control.
To remove control from a package:
1. In the Project Browser window, right-click on the controlled package. The context menu displays.

Enterprise Architect User Guide

 Projects and Teams | Change Management 297

2. Select the Package Control | Configure menu option, or press [Ctrl]+[Alt]+[P]. The Package Control
Options dialog displays.
3. Deselect the Control Package checkbox. If the package is under version control, this sets the Version
Control field to (None).

4. Click on the OK button to remove package control.

Package control for the selected package has now been removed.

Note:
When disconnecting a package from version control, the association between the package and the exported
XML file is removed from your model. However, the XML file itself is not removed from version control, nor is
it deleted from your local version control working copy folder. This is because it is possible for another model
to be using the version controlled package and still referencing the associated version controlled XML file.

3.5.3.1.6.4 Save a Package

You can save a controlled package to an XMI file. Once you have correctly configured 295 the package, follow
the steps below:
1. In the Project Browser window, right-click on the package to save. The context menu displays.
2. Select the Package Control | Save Package to File menu option.
3. The export process executes automatically according to your configured preferences, overwriting any
existing file.

Note:
If you are using a version control package in conjunction with the exported package files, you must check out
the XMI file first to enable Enterprise Architect to overwrite the existing version.

3.5.3.1.6.5 Load a Package

Using the Controlled Packages facility, you can save and load packages to a named file.
If a package has been marked for control it is displayed in the Project Browser with a red rectangle to the left
of the package icon. If you have previously saved a controlled package, you can reload it using the Load
package from file menu option.
To load a controlled package, follow the steps below:
1. In the Project Browser window, right-click on the package to load. The context menu displays.
2. Select the Package Control | Load package from file menu option.

© 1998-2010 Sparx Systems Pty Ltd

 298 Projects and Teams | Change Management

3. If you have configured the package control details, Enterprise Architect prompts you to confirm the
import.

Warning:
Importing deletes the current package entirely from the model, and the action cannot be undone. You
must be careful not to lose any current changes or information.

4. Click on the Yes button to confirm the import. The current package is deleted and the saved package is
imported.

3.5.3.1.6.6 Batch XMI Export

You can export a group of controlled packages in one step, using the Batch XMI Export facility.
To export a group of controlled packages, follow the steps below:
1. Select the Project | Import/Export | Batch XMI Export menu option. The Batch XMI Export dialog
displays.

2. Select the checkbox against each package to include in this export run. Select the Select All checkbox
to select all packages in the list.
3. To save this configuration as the default, click on the Save Settings button.
4. Click on the Run Export button.
Enterprise Architect cycles through each checked package and exports it using the options specified in the
Package Control Options 295 dialog. As long as a valid filename exists, Enterprise Architect exports the
package to XML and proceeds to the next package.

3.5.3.1.6.7 Batch XMI Import

You can import a group of controlled packages in one step, using the Batch XMI Import facility.
To import a group of controlled packages, follow the steps below:
1. Select the Project | Import/Export | Batch XMI Import menu option. The Batch XMI Import dialog
displays.

Enterprise Architect User Guide

 Projects and Teams | Change Management 299

2. Select the checkbox against each package to include in the import. Select the Select All checkbox to
select all packages in the list.

Tip:
To avoid re-importing the same module multiple times, select the Check file date before import
checkbox. Enterprise Architect then does not import a file if the last import file date matches that of the
one currently on disk.

3. To save this configuration as the default, click on the Save Settings button.
4. Click on the Run Import button. Enterprise Architect cycles through the packages and imports each
selected package.
As Enterprise Architect processes each package, it updates the Status column against each package name
on the Batch XMI Import dialog.
· If the import is successful, Enterprise Architect updates the package status to Imported.
· If the import is unsuccessful, Enterprise Architect updates the package status to Not Imported.
Common reasons for an import to fail include:
· The package not being correctly configured
· The last import file date matches the import date of the file currently on disk.

3.5.3.1.6.8 Manual Version Control with XMI

You can use XMI to support version control by writing model elements in XML text files suitable for use with
standard version control software.
Using XMI in this manner enables you to manually connect to third-party version control software outside the
Enterprise Architect environment. Enterprise Architect internally supports the configuration of version control
through SCC and CVS configurations.
To use XMI for version control, you must first:
1. Select suitable packages in the Project Browser window, to be marked as controlled packages.
2. Configure these with filenames that are visible to a version control system of your choice.
3. Save the controlled packages to establish a model base and check these into the version control
system.

When Versioning is Required

Continue working on a package until versioning is required then follow the steps below:

© 1998-2010 Sparx Systems Pty Ltd

 300 Projects and Teams | Change Management

1. Check out the package XMI file from the version control system.
2. Save the relevant package using the controlled package support.
3. Check the package back into the version control system.

Recover an Earlier Version

To recover an earlier version, follow the steps below:
1. Save the current version first (this is important, because the package is completely deleted during the
import process) and manually update the version control system if necessary.
2. Get the required package version from the version control system.
3. Select the package to reload.
4. Select the Package Control | Load package from file menu option to import the previous version.
Enterprise Architect deletes the controlled package and restores the previous version.

3.5.3.2 CSV Import and Export

You can import 305 and export 303 information about Enterprise Architect elements in CSV format.
You must define CSV specifications 300 to do this, because the specification defines what types of value from
the spreadsheet are to be imported, and how the information is translated between the spreadsheet and
Enterprise Architect.

3.5.3.2.1 CSV Specifications

To import 305 and export 303 element data from Enterprise Architect using CSV files, you must first set up one
or more file specifications.
A file specification lists the fields from the spreadsheet in the order they are imported or exported, the filename
(optional) and the delimiter between columns. Once you have defined one or more specifications, one can be
selected in the CSV Import/Export dialog as the current specification to apply during an import or export
action.
CSV only imports and exports elements (within packages) and their properties; items such as Class attributes
cannot be imported or exported through this mechanism. XMI 288 import/export provides a solution to this
limitation, as does use of the Automation Interface 1666 (Object Model).
To define a specification, select the Project | Import/Export | CSV Import/Export Specifications menu
option. The CSV Import/Export Specification dialog displays.

Enterprise Architect User Guide

 Projects and Teams | Change Management 301

The CSV Import/Export File Specification dialog provides the following functionality:

Option Use to

Specification Name Select the unique name for this specification.

Delimiter Specify the character delimiter to use between record fields.

Note:
If a field contains an instance of the delimiter, the field is exported wrapped in "
(quotation marks) and all instances of " in the field are doubled (that is, " becomes
"").

Notes Record a brief description of the specification.

Default Filename Select the default filename.

Default Direction Set the default action - Import or Export. A specification can be used in either
direction, but this enables you to set the default type.

Default Types Limit the element types being exported, by entering a comma-separated list: for
example, class,requirement,component,node,object.

© 1998-2010 Sparx Systems Pty Ltd

 302 Projects and Teams | Change Management

Option Use to

Note:
If you specify element types, ONLY elements of those types are exported or
imported. Therefore, in order to enable the Preserve Hierarchy option to operate
(if selected) you must include Package as an element type. Otherwise there are
no packages in which to preserve the hierarchy.
If you do not specify any default element types, all elements including Packages
are exported or imported and the hierarchy can be preserved.

Preserve Hierarchy Include fields generated by Enterprise Architect to embed/reconstruct the package
hierarchy. See the Using Preserve Hierarchy 302 section for more details.

Available Fields Select from a list of possible record fields, not yet allocated.

File Specification List the record fields (in the order they are plotted across the spreadsheet) already
assigned.

Add Field Move all selected fields in the top list to the bottom list.

Remove Field Move all selected fields in the bottom list back to the available list.

New Create a new specification.

Save Save changes to the currently selected specification.

Save As Save the current specification with a new name.

Delete Delete the current specification.

Close Close this dialog.

Note:
In Available Fields and File Specification, the record fields Created Date and Modified Date are not set
when imported from CSV.

Using Preserve Hierarchy

When selected, the Preserve Hierarchy option inserts two fields into the CSV specification that are:
· automatically populated by Enterprise Architect on export and
· used to reconstruct the exported package's hierarchy upon import.

Field Description

CSV_KEY A unique identifier for the current element.

Note:
This key is unique per export; subsequent exports produce different keys for the
same set of elements.

CSV_PARENT_KEY The corresponding CSV_KEY of the current element's parent. If the field is left
blank or references a non-existent CSV_KEY, the element is added to the top level
of the package.

However, if you intend to import hierarchical information from a spreadsheet that was not populated by
exporting data from Enterprise Architect, you must add these two fields to your spreadsheet as the last two
columns, and populate the columns yourself. For example:

Enterprise Architect User Guide

 Projects and Teams | Change Management 303

Note:
It is highly recommended that you do not change these fields by hand if they have been automatically
generated by Enterprise Architect's CSV exporter.

3.5.3.2.2 CSV Export

It is possible to export information about Enterprise Architect elements in CSV format. Once you have defined
a CSV export specification 300 it is possible to write out major element characteristics to a CSV text file.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have both Export XMI 198 and Import XMI 198
permissions to use the CSV Import/Export option.

Export Data in CSV Format

To export data in CSV format, follow the steps below:
1. In the Project Browser, right-click on the package containing the elements to export.
2. Select the Import/Export | CSV Import/Export context menu option. The CSV Import/Export dialog
displays.

© 1998-2010 Sparx Systems Pty Ltd

 304 Projects and Teams | Change Management

3. Set the required options, as outlined below:

Option Use to

Package Confirm the name of the current selected package.

Specification Specify the name of the export specification 300 to use.

Edit/New Edit the export specification or create a new one.

File Specify the filename to export to.

Types List the element types to export: leave blank for all, or enter a comma-separated list
of types.

Note:
If you specify element types, ONLY elements of those types are exported.
Therefore, in order to enable the Preserve Hierarchy option in the specification to
operate (if selected) you must include Package as an element type. Otherwise no
Packages are exported in which to preserve the hierarchy.
If you do not specify any element types, all elements including Packages are
exported and the hierarchy can be preserved.

Action Select the Export radio button to export to file.

Print Results Print out the result list.

View File View the resultant CSV file with the default Windows application for CSV files.

Run Perform the export.

Close Exit this dialog.

Enterprise Architect User Guide

 Projects and Teams | Change Management 305

3.5.3.2.3 CSV Import

It is possible to import information about Enterprise Architect elements in CSV format. Once you have defined
a CSV import specification 300 you can read in major element characteristics from a CSV text file.

Notes:
· In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have both Export XMI 198 and Import XMI 198
permissions to use the CSV Import/Export option.
· You import the CSV file into a selected package; if this package or any element within the package has a
lock on it, you cannot import the CSV file into it. The Import option on the dialog is grayed out.

When importing, Enterprise Architect checks the specification to see if there is an EAGUID field included. If
there is, Enterprise Architect attempts to locate the element identified by the EAGUID and, if successful,
updates the current element rather than creating a new one. If no EAGUID field is defined, or Enterprise
Architect cannot locate the identified element, a new element is created and placed in the current package.
Note that during import, Type is a mandatory field in the source file and must match one or more of the legal
Enterprise Architect element types 1715 . For example: requirement, or class.
The format and content of the source data file should resemble the following:

Import Data in CSV Format

To import data in CSV format, follow the steps below:
1. In the Project Browser, right-click on the package to import into.
2. Select the Import/Export | CSV Import/Export context menu option. The CSV Import/Export dialog
displays.

© 1998-2010 Sparx Systems Pty Ltd

 306 Projects and Teams | Change Management

3. Set the required options; as outlined below:

Option Use to

Package Confirm the name of the current selected package.

Specification Specify the name of the import specification 300 to use.

Edit/New Edit the import specification or create a new one.

File Specify the spreadsheet filename to import from.

Types Not used for import.

Action Select the Import radio button to import from the file. (Grayed-out if the
package or a child item in the package is locked.)

Print Results Print out the result list.

View File View the source CSV file with the default Windows application for CSV files.

Run Perform the import.

Close Exit this dialog.

3.5.3.3 Project Data Transfer

The Corporate, Business and Software Engineering, System Engineering and Ultimate editions of Enterprise
Architect support SQL Server 126 , MySQL 123 and Oracle 9i, 10g and 11g 129 data repositories. At some point,
it might become necessary to move a complete model from one repository to another, row by row, table by
table.
The project data transfer function enables you to perform the following tasks:
· Upload an existing .EAP file to a SQL Server or MySQL repository
· Download a repository in MySQL or SQL Server to a .EAP file

Enterprise Architect User Guide

 Projects and Teams | Change Management 307

· Move a repository from SQL Server to MySQL or from one server to another
· Move all records from a .EAP file with replication to a model with none (Remove Replication)
· Copy all records from a .EAP file to another (recommended after serious network crash or repeated
database corruption)
· Copy all records from a JET 3.5 to JET 4 (Access 2000 or XP) repository - or back the other way.
See the Perform a Project Data Transfer 307 topic for instructions.

Warning:
All records in the target repository are overwritten.

Note:
You cannot move a model from a source .EAP file of a version earlier than 3.5.0.

3.5.3.3.1 Perform a Project Data Transfer

Warning:
During a project data transfer, all records in the target project are overwritten. Before performing the transfer,
take a backup of the target project to ensure that you can recover any important information it contains.

Notes:
· In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Transfer Data 198 permission to transfer project
data between repositories.
· You cannot move a model from a source .EAP file of a version earlier than 3.5.0.
· You must transfer data into a repository (where scripts have been run to set up tables), not just a database.
If necessary, follow the steps below:

· Install the DBMS software and create a database. Ensure that the collation is set to the alphabet you
use, such as Latin or Cyrillic.
· Run a script supplied by Sparx Systems (
http://www.sparxsystems.com/resources/corporate/index.html#sql_scripts) to create the required
tables.

To perform a project data transfer, follow the steps below:

1. Select the Tools | Data Management | Project Transfer menu option. The Project Transfer dialog
displays.

© 1998-2010 Sparx Systems Pty Ltd

 308 Projects and Teams | Change Management

2. Click on the option for the required transfer type. You can choose from:
· .EAP to .EAP
· DBMS to .EAP
· .EAP to DBMS
· DBMS to DBMS
3. In the Source Project and Target Project fields, type or select the name or connection string for the
Source and Target projects.
4. If you want to capture the transfer in a log file, select the Logfile checkbox and browse for the
appropriate log file location.
5. Click on the Transfer button.
It is good practise to do a Project Compare 308 after this process to verify that all records are written.

3.5.3.3.2 Why Compare Projects?

It is sometimes useful to compare the size and row counts of two projects; for example, after a database
crash, after import from XMI or after performing a deletion of model elements.
You can compare .EAP files to other .EAP files or to DBMS based repositories, or compare two DBMS
repositories. Enterprise Architect examines the number of rows in each database and produces a report
indicating the total records in each and the difference between the two. No examination is made of the data in
the table, just the record count.
Comparing projects this way is a convenient 'sanity check' after restoring a backup or doing a project data
transfer. If discrepancies are found, you must investigate further manually.
See the Compare Projects 308 topic for instructions.

3.5.3.3.3 Compare Projects

To compare projects, follow the steps below:
1. Select the Tools | Data Management | Project Compare menu option. The Project Compare dialog
displays:

Enterprise Architect User Guide

 Projects and Teams | Change Management 309

2. Select the option for the required comparison type. You can choose from:
· .EAP to .EAP
· DBMS to .EAP
· .EAP to DBMS
· DBMS to DBMS
3. In the Source Project and Target Project fields, type the name or connection string for the Source and
Target projects.
4. Click on the Compare Projects button. The results of the comparison display in the panel at the bottom
of the dialog.
5. If required, click on the Print List button to print the results.

3.5.3.3.4 Copy Packages Between Projects

Using the XML import/export capabilities of Enterprise Architect, you can copy and move packages between
Enterprise Architect projects. This gives you a high level of flexibility in building a project from re-usable parts
and from elements produced in widely-dispersed geographic regions.
This procedure, with the Strip GUID's checkbox selected (see step 8, below) is effectively the same as
copying packages 388 within or between models. You would tend to use this export/import procedure for
duplicating larger structures, such as complete models or projects, although exporting and importing individual
child packages within the same model is just as feasible. You cannot export and import specific elements
using this procedure, but the process of copying elements 531 within or between packages, models and
projects is derived from it.

Procedure
To copy a package from one Enterprise Architect project to another, follow the steps below:
1. Open the Enterprise Architect project to copy from.
2. In the Project Browser, right-click on the package to copy. The context menu displays.
3. Select the Import/Export | Export package to XMI file menu option. The Export Package to XMI dialog
displays.

© 1998-2010 Sparx Systems Pty Ltd

 310 Projects and Teams | Change Management

4. Select the appropriate options and filename (see the Export to XMI 289 topic for further information).
5. Click on the Export button to begin the export process.
6. When the export is complete, open the recipient Enterprise Architect project. In the Project Browser,
navigate to the location to import the package into.
7. Right-click to display the context menu, and select the Import/Export | Import package from XMI file
menu option. The Import Package from XMI dialog displays.

8. Select the appropriate options and filename (see the Import from XMI 290 topic for further information).
9. Click on the Import button. The package is copied from the source project to the destination project.

Enterprise Architect User Guide

 Projects and Teams | Change Management 311

Note:
If the package you are importing already exists in the target project (that is, it has been imported previously),
you must either import over the existing package or select the Strip GUIDs option, in which case Enterprise
Architect creates a replica of the original package.

© 1998-2010 Sparx Systems Pty Ltd

 312 Projects and Teams | Project Management

3.6 Project Management

Enterprise Architect provides strong support for Project Management, in estimating project size, measuring
risk and effort, and assigning resources to elements. Enterprise Architect also provides support for change
control and maintenance.

Metrics and Estimation

Project estimation 335 is working out how much time and effort is required to build and deploy a solution.
Enterprise Architect provides the Use Case metrics facility as a means of measuring the complexity of a
system and getting an indication of the effort required to implement the model, and the project timescale. You
base these estimates on carefully-calibrated metrics.

Resource Management
Resources 313 are the people who work on a project. You can assign roles to them and allocate tasks on
specific model elements, which enables tracking of effort and estimation of time to complete.

Project Maintenance
During a project you monitor and manage the development and progress of individual model elements. You
can record problems, changes, issues and tasks 1558 that affect these individual elements as they arise, and
document the solution and associated details.
Similarly, Enterprise Architect helps you to manage changes and issues 1563 that apply to the whole system.

Project Tasks and Issues

In the course of a project, there are various non-technical tasks 329 that are vital to the successful
management and completion of the project, such as meetings. Enterprise Architect helps you to record and
monitor these, and to manage non-technical project issues 331 as they arise.

See Also
· The Project Management Window 312

· The System Window 323

· Project Glossary 323
· Update Package Status 340
· Manage Bookmarks 341
· Monitor Events 342

3.6.1 The Project Management Window

Access: View | Other Element Tools | Project Management.
The Project Management window enables you to input the resources 314 , effort 315 , risks 316 and metrics 317
that can be added to elements contained in the model.

Enterprise Architect User Guide

 Projects and Teams | Project Management 313

Click on an element in the Project Browser 1209 to display project management information for that element in
the Project Management window.
Right-click on the list to view the context menu, which enables you to add and delete list items 330 .

Toolbar

These buttons have the following functions (in order as shown on the toolbar):
· New: Create new item
· Save: Save changes to an item
· Save As New: Enables you to duplicate an existing entry. You must change an item's Role for this to
become enabled
· Delete: Delete an item from the list
· Sort: Sort Items in the list into alphabetical order
· Print: Print item data from the list
· Browse Element: Display the Element Browser 510 window for the selected element, to list and select the
project management items for the element
· Show/Hide Details: Swap between detailed and summary new window styles
· Help: Show help contents for this window.

3.6.2 Project Resources

What is a Resource?
Resources are the people who work on a project. They can be assigned roles and allocated tasks, which
enables tracking of effort and estimation of time to complete.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Manage Project Information 198 permission to
update and manage project resources, effort, metrics and risks.

Project Management Window

Resources are added, modified and deleted from the Project Management window. To access this window,
select the View | Other Element Tools | Project Management menu option, or press [Ctrl]+[Shift]+[7].
The window has two formats, as illustrated below - Item mode and List mode respectively.

© 1998-2010 Sparx Systems Pty Ltd

 314 Projects and Teams | Project Management

Toggle between these modes using the Show/Hide Properties button in the window toolbar. The tabs toggle
between Item mode and List mode independently.
The asterisk on a tab indicates that the tab contains saved information. If there is no information for a category
of item, or the information has not yet been saved, its tab has no asterisk.

What to Do?
To find out more information about Project Resource Management tasks, use the following guide:
· To allocate a resource to an element, see the Resource Allocation 314 topic
· To record additional project management information for an element, see:
· the Effort Management 315 topic (record effort expended on the element)
· the Risk Management 316 topic (record risk associated with the element)
· the Metrics 317 topic (record metrics measured for an element)
· To obtain a report of resource allocation details, see the Resource Report 318 topic
· To configure Project Management data and populate the drop-down lists used on the Project Management
dialog tabs, see the following topics:
· Roles 648
· Clients 651
· Effort Types 319
· Metric Types 320
· Risk Types 322
· To find out about the functions of the Project Management toolbar, see the Project Management Window
312 topic.

3.6.2.1 Resource Allocation

Enterprise Architect enables you to connect a named resource in a named role to a given model element. This
enables the Project Manager to track how far development of required components and Classes has
progressed (provided the team members keep their figures up to date).
To enter resource allocation details for an element, follow the steps below:
1. Select the element in the Project Browser.

Enterprise Architect User Guide

 Projects and Teams | Project Management 315

2. Select the View | Other Element Tools | Project Management menu option. The Project Management
window displays, showing the Resource Allocation tab.
3. Click on the New icon on the Project Management window toolbar.

The Resource Allocation tab enables you to enter the following data:
· The name of the resource (click on the drop-down arrow and select, or type the name in)
· The role of the resource (click on the drop-down arrow and select, or type the name in)
· The start and end date for the availability of the resource
· The time allocated to the resource
· The percentage of the task the resource has completed
· The expected time allocated to the resource
· The actual time expended by the resource
· A description of the work being done by the resource (this text is also displayed in the Notes 641 window
641 ; it cannot be edited in that window)

· Notes on the activity history of the resource (this text is also displayed in the Notes 641 window 641 ; it
cannot be edited in that window).
To edit existing Resource Allocation items for this element, click on the required item in the:
· list panel to the left of the window, in Item mode
· list, in List mode, or
· Project Management folder in the Element Browser 510 window; if this window is not displayed, click on the

icon in the Project Management window toolbar. Resource Allocation item icons have an R in the
bottom right corner.
To change the element to which to allocate resources, select the required element in the Project Browser.

3.6.2.2 Effort Management

To enter effort details for an element, follow the steps below:
1. Select the element in the Project Browser.
2. Select the View | Other Element Tools | Project Management menu option. The Project Management
window displays, showing the Resource Allocation tab.
3. Click on the Effort tab.
4. Click on the New icon on the Project Management window toolbar.

© 1998-2010 Sparx Systems Pty Ltd

 316 Projects and Teams | Project Management

The Effort tab enables you to enter the following data:

· A name for the effort (short description)
· The type of effort (click on the drop-down arrow and select, or type the name in; typed names are not
added to the global effort type 319 list)
· The time the effort will expend
· Some notes on the effort (this text is also displayed in the Notes 641 window 641 ; it cannot be edited in that
window).
To edit existing Effort items for this element, click on the required item in the:
· list panel to the left of the window, in Item mode
· list, in List mode, or
· Project Management folder in the Element Browser 510 window; if this window is not displayed, click on the

icon in the Project Management window toolbar. Effort item icons have an E in the bottom right
corner.
To change the element to which to assign effort, select the required element in the Project Browser.

Notes:
· The drop-down arrow on the Type field displays a list of effort types as defined on the Effort tab of the
Metric and Estimation Types dialog. If required, you can type in alternative effort types, but these are not
added to the drop-down list of defined types.
· Although Enterprise Architect does not currently provide detailed reports on effort within a model, you can
use the Automation Interface 1666 or similar tools to create your own custom reports based on effort
information you enter.

3.6.2.3 Risk Management

To enter risk details for an element, follow the steps below:
1. Select the element in the Project Browser.
2. Select the View | Other Element Tools | Project Management menu option. The Project Management
window displays, showing the Resource Allocation tab.
3. Click on the Risks tab.
4. Click on the New icon on the Project Management window toolbar.

Enterprise Architect User Guide

 Projects and Teams | Project Management 317

The Risks tab enables you to enter the following data:

· A name for the risk (short description)
· The type of risk (click on the drop-down arrow and select, or type the name in; typed names are not added
to the global risk type 322 list)
· A weighting for the risk
· Some notes on the risk (this text is also displayed in the Notes 641 window 641 ; it cannot be edited in that
window).
To edit existing risk items for this element, click on the required item in the:
· list panel to the left of the window, in Item mode
· list, in List mode, or
· Project Management folder in the Element Browser 510 window; if this window is not displayed, click on the

icon in the Project Management window toolbar. Risk item icons have an Ri in the bottom right
corner.
To change the element to which to allocate resources, select the required element in the Project Browser.

Note:
Although Enterprise Architect does not currently provide detailed reports on risks within a model, you can use
the Automation Interface 1666 or similar tools to create your own custom reports based on risk information you
enter.

3.6.2.4 Metrics
To enter metrics for an element, follow the steps below:
1. Select the element from the Project Browser.
2. Select the View | Other Element Tools | Project Management menu option. The Project Management
window displays, showing the Resource Allocation tab.
3. Click on the Metrics tab.
4. Click on the New icon on the Project Management window toolbar.

© 1998-2010 Sparx Systems Pty Ltd

 318 Projects and Teams | Project Management

The Metrics tab enables you to enter the following data:

· A name for the metric (short description)
· The type of metric (click on the drop-down arrow and select, or type the name in; type names are not
added to the global metric type 320 list)
· A weighting for the metric
· Some notes on the metric (this text is also displayed in the Notes 641 window 641 ; it cannot be edited in that
window).
To edit existing Metrics items for this element, click on the required item in the:
· list panel to the left of the window, in Item mode
· list, in List mode, or
· Project Management folder in the Element Browser 510 window; if this window is not displayed, click on the

icon in the Project Management window toolbar. Metric item icons have an M in the bottom right
corner.
To change the element to which to allocate resources, select the required element in the Project Browser.
To edit existing metric items for this element, click on the required item in the:
· list panel to the left of the window, in Item mode
· list, in List mode, or
· Project Management folder in the Element Browser 510 window (Metric item icons have an M in the bottom

right corner). If this window is not displayed, click on the icon in the Project Management window
toolbar.
To change the element to which to assign metrics, select the required element in the Project Browser.

Note:
Although Enterprise Architect does not currently provide detailed reports on metrics within a model, you can
use the Automation Interface 1666 or similar tools to create your own custom reports based on metric
information you enter.

3.6.2.5 Resource Report

To generate a resource report on a package, either:
· In the Project Browser, right-click on the package to create a report for and, from the context menu, select
the Documentation | Resource Allocation option, or
· If the diagram currently active belongs to the package to create a report for, select the Project |
Documentation | Resource and Tasking Details menu option.
The Resource and Tasking Details dialog displays a list of all elements that have resources allocated to them.
The result list includes the resource allocated, the start and end dates, the percentage complete and other

Enterprise Architect User Guide

 Projects and Teams | Project Management 319

relevant information. You can print out the results if required.

Option Use to

Root Package Confirm the name of the root package for which resourcing is being determined.

Resource Change the (optional) name of a specific resource assigned to the project.

As At Date Select the date to run the resource report for.

Cut Off Set the percentage complete limit to include or exclude resource details; see Show
Where.

Show Where Show resourcing where percentage complete is Complete, Above the cut-off,
Below the cut-off, or any of these three.

Refresh Refresh the form.

Locate Object (Click on an entry in the report.) Find the selected element from the results list in
the Project Browser.

Print Print the report.

Resourcing Details Review the list of resources that meet the search criteria.

3.6.2.6 Effort Types

To specify the effort types used when assigning effort to an element, use the Effort tab of the Project
Indicators dialog.
Creating an effort type using this dialog adds to a global list of effort types that can be added to any element in
the model. This list of types displays in the Type field drop-down list on the Effort tab of the Project
Management 312 window.
To open the Project Indicators dialog, select the Settings | Project Indicators menu option. Click on the Effort
tab.

© 1998-2010 Sparx Systems Pty Ltd

 320 Projects and Teams | Project Management

To create a new effort type, click on the New button, or to edit an existing effort type, click on the effort type
name in the Defined Effort Types list. Complete the fields as follows:
· In the Effort field type the name of the effort type
· In the Description field type a short description of the effort type
· In the Weight field type the weighting to apply to the effort type
· In the Note field, type any additional information on the effort type
· Click on the Save button.

Notes:
· Although Enterprise Architect does not currently provide detailed reports on effort within a model, you can
use the Automation Interface 1666 or similar tools to create your own custom reports based on effort
information you enter.
· You can transport effort types between models, using the Export Reference Data 223 and Import
Reference Data 225 options on the Tools menu.

3.6.2.7 Metric Types

To specify the metric types used when assigning metrics to an element, use the Metric tab of the Project
Indicators dialog.
Creating a metric using this dialog creates a global list of metrics that can be added to any element in the
model. You can define a metric on other screens, such as the Metrics 317 tab of the Project Management
window, but such metrics are not added to the global list.

Enterprise Architect User Guide

 Projects and Teams | Project Management 321

Select the Settings | Project Indicators menu option. On the Project Indicators dialog, click on the Metric tab.

To create a new metric type, click on the New button, or to edit an existing metric type, click on the metric type
name in the Defined Metrics list. Complete the fields as follows:
· In the Metric Type field type the name of the metric type
· In the Description field type a short description of the metric type
· In the Weight field type the weighting to apply to the metric type
· In the Note field, type any additional information on the metric type
· Click on the Save button.

Notes:
· Although Enterprise Architect does not currently provide detailed reports on metrics within a model, you
can use the Automation Interface 1666 or similar tools to create your own custom reports based on metrics
information you enter.
· You can transport metric types between models, using the Export Reference Data 223 and Import
Reference Data 225 options on the Tools menu.

© 1998-2010 Sparx Systems Pty Ltd

 322 Projects and Teams | Project Management

3.6.2.8 Risk Types

To specify the risk types used when assigning risk to an element, use the Risk tab of the Project Indicators
dialog.
Creating a risk type using this dialog creates a global list of risk types that can be added to any element in the
model. You can define a risk type on other screens, such as the Risks 316 tab of the Project Management
window, but such risks are not added to the global list.
Select the Settings | Project Indicators menu option. On the Project Indicators dialog, click on the Risk tab.

To create a new risk type, click on the New button, or to edit an existing risk type, click on the risk type name
in the Defined Risks list. Complete the fields as follows:
· In the Risk Type field type the name of the risk type
· In the Description field type a short description of the risk type
· In the Weight field type the weighting to apply to the risk type
· In the Note field, type any additional information on the risk type
· Click on the Save button.

Enterprise Architect User Guide

 Projects and Teams | Project Management 323

Notes:
· Although Enterprise Architect does not currently provide detailed reports on risks within a model, you can
use the Automation Interface 1666 or similar tools to create your own custom reports based on risk
information you enter.
· You can transport risk types between models, using the Export Reference Data 223 and Import
Reference Data 225 options on the Tools menu.

3.6.3 The System Window

Access: View | Other Project Tools | System.
The System window documents tasks and issues that relate directly to the current project. It has three tabs:
· Project Tasks 329 - a list of major project tasks that require attention; you can filter tasks based on their
current status - right-click for a popup menu, or double-click on a line item to modify details
· Project Issues 332 - a list of events, occurrences and situations that impact on project development and
delivery; you can review Issues using the right-click context menu or by double-clicking on selected issues
· Project Glossary 325 - a list of all the technical and business terms already defined for a model; you can
add to the list, delete or change items and filter the list to exclude by type.

Note:
Right-clicking in the System window displays a context menu that has options for filtering tasks/issues by
status, and glossary by term. You can also rearrange the sort-order by clicking in the title bar of the column
that the items are to be indexed on.

3.6.4 Project Glossary

The glossary enables you to set up a list of defined terms for your project.
You can divide the glossary items by category; for example, Business terms and Technical terms. The
glossary can be saved in Rich Text format for inclusion as part of a larger project document.
You can add, delete and modify the project glossary entries through the Glossary 324 dialog or through the
Project Glossary 325 tab on the System window. You can also create glossary terms and definitions from text
in the Notes 641 window or from any Notes or Description fields that have the Notes toolbar. Once these
terms exist, you can insert them into any of those same fields by pressing [Ctrl]+[Space] and selecting them

© 1998-2010 Sparx Systems Pty Ltd

 324 Projects and Teams | Project Management

from an autocompletion 641 box.

Tip:
Include a Glossary Report 328 in your project requirements or functional specifications documents.

Note:
You can transport these glossary definitions between models, using the Export Reference Data 223 and
Import Reference Data 225 options on the Tools menu.

3.6.4.1 The Glossary Dialog

To open the Glossary dialog, select the Project | Documentation | Glossary menu option. Use this dialog to
add 325 , modify 325 and delete 325 glossary entries.
You can also limit the display 325 to list entries of a specific type for editing or deletion.

Option Use to

Glossary Term Type the term to include in the glossary.

Glossary Type Select either Technical or Business.

If you require a different glossary type, click on the [ ... ] (browse) button
and specify the name of the new type.
This field applies the type only to the selected term. You can rename a
type for all terms of that type 325 , using the Project Glossary tab of the
System window.

Enterprise Architect User Guide

 Projects and Teams | Project Management 325

Option Use to

Description Type the definition or description of the term.

You can format the text of this description using the Notes 642 toolbar at
the top of the field.

Limit Display To Select the appropriate type to filter the Type | Term list to show entries of
a specific type for editing or deletion.

Type | Term Review the list of defined glossary terms.

Report Print a glossary report 328 .

Add a Glossary Entry

To add an entry to the glossary, follow the steps below:
1. Enter the details for the glossary item: the Glossary Term, the Glossary Type and the Description.

Note:
A glossary term must have a defined type and description. You cannot save a new term without both of
these values.

2. Click on the Save button.

3. To enter another item, click on the New button.

Modify a Glossary Entry

To modify a glossary entry, follow the steps below:
1. Select the entry to modify from the bottom panel of the dialog. The details of the entry display in the
fields in the top half of the window.

Note:
A glossary term must have a defined type and description. You cannot save an edited term without
both of these values.

2. Change the details as required.

3. Click on the Save button.

Delete a Glossary Entry

To delete a glossary entry, follow the steps below:
1. Select the entry to delete from the bottom panel of the dialog. The details of the entry display in the
fields in the top half of the window.
2. Click on the Delete button.

Limit the Display

You can select which entry categories are displayed in the list. To:
· View all glossary entries, select the All value in the Limit Display To field.
· View entries of a specific type only, select the appropriate value in the Limit Display To field.

3.6.4.2 Project Glossary Tab

The Project Glossary tab in the System window shows all of the glossary terms already defined for your
model. You can add to the list, delete or change items, change a definition type for all terms of that type, and
filter the list to exclude by type.
Access this tab by opening the System window; select the View | Other Project Tools | System menu option
or press [Alt]+[2]. Select the Project Glossary tab.

© 1998-2010 Sparx Systems Pty Ltd

 326 Projects and Teams | Project Management

Tip:
To print out all of the currently listed items, right-click on the list and select the Print List context menu
option.

Right-click on an entry and use the context menu to add 326 , modify 327 , reclassify 327 , filter 327 and delete 327
glossary entries (as below). Alternatively, select the Project | Documentation | Glossary menu option and
use the Glossary 324 dialog.

Tip:
Include a Glossary Report 328 in your project requirements or functional specifications documents.

Add a Glossary Entry

To add an entry to the glossary, follow the steps below:
1. Double-click on the Project Glossary tab, or right-click on the tab and select the Add New context menu
option. The Glossary Detail dialog displays.

Enterprise Architect User Guide

 Projects and Teams | Project Management 327

2. Enter the details for the glossary item: the Term, Type and Meaning. You can, if necessary, format the
Meaning text using the Notes 642 toolbar at the top of the field.

If the Type values are not appropriate for the term, click on the [ ... ] button and enter another type
name.

Note:
A glossary term must have a defined type and description. You cannot apply a new term without both
of these values.

3. Click on the Apply button.

4. To create another entry, click on the New button.
5. To close, click on the OK button.

Modify a Glossary Entry

To modify a glossary entry, either:
1. Double-click on the entry to modify in the list on the Project Glossary tab, or
2. Right-click on the entry to modify in the list on the Project Glossary tab and select the Modify Selected
context menu option.
The Glossary Detail dialog displays; edit the fields as required.

Delete a Glossary Entry

To delete a glossary entry, follow the steps below:
1. Right-click on the entry to modify in the list on the Project Glossary tab. The context menu displays.
2. Select the Delete menu option.

Redefine Type
If a glossary term type is no longer appropriate for all terms of that type, you can redefine the type for all terms
at once. To do this, follow the steps below:
1. On the Project Glossary tab, right-click on a term of the type to be changed and select the Rename
Type context menu option. The Rename Glossary Type dialog displays.
2. In the New Type Name field type a different type name, either an existing type or a new type.
3. Click on the OK button. On the Project Glossary tab, all entries of the original type are now redefined as
being of the new type.

Note:
To reclassify a single term 324 , use the Glossary Type field on the Glossary dialog.

Filter List
To filter the Project Glossary tab display so that only terms of a specific type are listed, follow the steps below:
1. Right-click on the list and select the Set term filter context menu option. The Term Type Filter dialog
displays.
2. In the Term field, click on the drop-down arrow and select the term type for which to list Glossary terms.
3. Click on the OK button. The list of Glossary terms is filtered to the selected type.
To remove the filter, either:
· Follow the steps above and select the value <All> in the Term field, or
· Right-click on the list and select the Remove term filter context menu option.

© 1998-2010 Sparx Systems Pty Ltd

 328 Projects and Teams | Project Management

3.6.4.3 Generate a Report

To generate a report of your model's glossary, follow the steps below:
1. Select the Project | Documentation | Glossary menu option. The Glossary dialog displays.
2. Click on the Report button. The Glossary Report dialog displays.

3. In the Filename field, type or select a filename for the glossary.

4. In the Heading field, type a suitable heading for the glossary.
5. In the Include Glossary Items panel, select the checkbox for each type of glossary entry to include. Click
on the Select All button to select all types of entry.
6. If necessary, click on the Page Setup and/or Language buttons to define the page setup and language
for the report.
7. To include page breaks, select the Page break between sections checkbox.
8. Click on the Generate button to generate the report.
9. Click on the View button to open the report.

Note:
You can view sample report output in the Glossary Report Output Sample 328 topic.

3.6.4.4 Glossary Report Output Sample

An example of the output from a Glossary report is shown below:

Glossary
Business Terms
Accounting Periods
A defined period of time whereby performance reports can be extracted. (normally 4
week periods).

Customer
A person or a company that requests An entity to transport goods on their behalf.

Enterprise Architect User Guide

 Projects and Teams | Project Management 329

Technical Terms
Association
A relationship between two or more entities. Implies a connection of some type - for
example one entity uses the services of another, or one entity is connected to another
over a network link.

Component Model
The component model provides a detailed view of the various hardware and software
components that make up the proposed system. It shows both where these components
reside and how they inter-relate with other components. Component requirements
detail what responsibilities a component has to supply functionality or behavior within
the system.

Deployment Model
A model of the system as it is physically deployed.

Extends Relationship
A relationship between two Use Cases in which one Use Case 'extends' the behavior of
another. Typically this represents optional behavior in a Use Case scenario - for
example a user might optionally request a list or report at some point in a performing a
business Use Case.

3.6.5 Project Tasks

The Project Tasks List is a convenient 'To Do' list of major project work items that are not recorded elsewhere.
It can also be used to track things like requests or meetings.
The Project Tasks List is available as a tab on the System window. To open the System window, select the
View | Other Project Tools | System menu option, or press [Alt]+[2]. Select the Project Tasks tab.

Right-click on the list to view the context menu, and select to add, modify or delete list items, or to set a status
filter. To set the sort order, click the title-bar of the column on which to index the tasks.
For more information see the Add, Modify and Delete Tasks 330 topic.

Tip:
Select the Print List menu option to print out the currently displayed items.

Note:
You can transport these task definitions between models, using the Export Reference Data 223 and Import
Reference Data 225 options on the Tools menu.

© 1998-2010 Sparx Systems Pty Ltd

 330 Projects and Teams | Project Management

3.6.5.1 Add, Modify and Delete Tasks

From the Project Tasks tab on the System window, display the Task Detail dialog to Add 330 , Modify 331 and
Delete 331 tasks.

Add a Task
To add a task, follow the steps below:
1. Double-click in a blank area of the Project Tasks tab, or right-click and select the Add New context
menu option. The Task Detail dialog displays.

2. Enter the details for the task. You can define the following:
· The task name
· Auto counters 525 - if you have configured these, click on the Auto button
· The task type
· The task owner
· The expected start and end date for the task
· The current status of the task
· The person this task has been assigned to

Enterprise Architect User Guide

 Projects and Teams | Project Management 331

· The task priority: high, medium or low

· The expected total time for the task and the actual time expended
· The percent complete
· The phase associated with this task.
3. Click on the Apply button.
4. To create another entry, click on the New button, or to close, click on the OK button.

Modify a Task
To modify a task, on the Project Tasks tab, either:
· Double-click on the task to modify, or
· Right-click on the task to modify and, from the context menu, select the Modify Selected menu option.
The Task Detail dialog displays, and you can edit the task data.

Delete a Task
To delete a task, follow the steps below:
1. On the Project Tasks tab, right-click on the task to delete. The context menu displays.
2. Select the Delete menu option.

3.6.6 Project Issues

Any identified issues can be recorded against the current project. Issues are raised with a description, date,
owner and status.

Notes:
· You can transport these issue definitions between models, using the Export Reference Data 223 and
Import Reference Data 225 options on the Tools menu.
· In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Manage Issues 198 permission to update and
delete Issues records.

You can add, delete and modify 334 Issues using either the Project Issues 331 dialog, or the Issue Detail 333
dialog from the Project Issues tab of the System window. You can also generate and view an RTF report of
your issue list, using either the Project Issues 334 dialog or the Project Issues 334 tab.

Tip:
You can view sample report output in the Report Output Sample 335 topic.

3.6.6.1 Project Issues Dialog

The Project Issues dialog is accessed from the Project | Documentation | Issues menu option. This dialog
enables you to record a description, date, owner and status of any identified issues against the current
project.
You can add, modify and delete issues 334 , and generate a report 334 of your project issues in Rich Text
Format.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Manage Issues 198 permission to update and
delete Issues records.

© 1998-2010 Sparx Systems Pty Ltd

 332 Projects and Teams | Project Management

3.6.6.2 Project Issues Tab

The Project Issues tab in the System window enables any identified issues to be recorded against the current
project. Issues are raised with a description, date, owner and status.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Manage Issues 198 permission to update and
delete Issues records.

To access this tab, select the View | Other Project Tools | System menu option or press [Alt]+[2] to display
the System window, and click on the Project Issues tab.

Tip:
You can right-click on the list and select the Print List context menu option to print out the currently displayed
items.

Enterprise Architect User Guide

 Projects and Teams | Project Management 333

To add 334 a new issue, double-click on an empty row of the Project Issues tab. To modify 334 an issue,
double-click on the required item in the list. In each case, the Issue Detail dialog displays.

You can also delete 334 an issue and generate a report 334 of your issues in Rich Text Format.

© 1998-2010 Sparx Systems Pty Ltd

 334 Projects and Teams | Project Management

3.6.6.3 Add, Delete and Modify Issues

Issues can be added, deleted and modified using either the Project Issues 331 dialog, or the Issue Detail 333
dialog from the Project Issues tab of the System window.
To add an issue, click on the New button and complete the following fields:

Component Description

Issue The name of the issue.

Auto Click on the Auto button if you have auto counters 525
configured.

Priority The priority of this issue: low, medium or high.

Date The date the issue arose.

Status The issue's current status.

Owner The person owning the issue.

Description Description of the issue.

Resolution Notes on the resolution of the issue.

Date The date the issue was resolved.

Resolved By Person who resolved the issue.

Comments Any comments regarding the resolution of the issue.

Close Issue Click on this button to close the issue.

Apply Save and apply the issue.

To modify an issue, double-click on it in the Project Issues tab or Project Issues & Discussion list, then edit the
fields as indicated in the above table.
To delete an issue, click on it in the Project Issues tab or Project Issues & Discussion list, then:
· Click on the Delete button (Project Issues dialog) or
· Right-click on the issue and select the Delete option from the context menu.

3.6.6.4 Report From Project Issues Dialog

To generate an RTF document of your issue log using the Project Issues dialog, follow the steps below:
1. Select the Project | Documentation | Issues menu option. The Project issues dialog displays.
2. Click on the Report button. The Save As dialog displays.
3. Browse for the appropriate file location and, in the File name field, type the file name for the report.
4. Click on the Save button.
5. To view the report, click on the View RTF button.

Tip:
For information on viewing sample report output, see the Report Output Sample 335 topic.

3.6.6.5 Report From Project Issues Tab

To generate an RTF document of your issue log using the Project Issues tab of the System window, follow the
steps below:
1. Select the View | Other Project Tools | System menu option, or press [Alt]+[2]. The System window
displays.
2. Click on the Project Issues tab.
Enterprise Architect User Guide
 Projects and Teams | Project Management 335

3. Right-click on a blank line of the Project Issues tab and select the Create RTF Report context menu
option. The Save As dialog displays.
4. Enter the directory location and file name to save your report to and click on the Save button. Enterprise
Architect generates the report. This should only take a few moments to complete.

Tip:
For information on viewing sample report output, see the Report Output Sample 335 topic.

3.6.6.6 Report Output Sample

An example of the output from an Issues report is shown below:

List of Project Issues: 24-Jul-2007 9:47:00 AM

Issue Date/Owner Description Resolution

Test servers will be 24/07/2007 Eloise The test server builds have Closed: 24/07/2007
delayed Norman been delayed because the Geoffrey Sparks The
particular (unusual) memory machines will be built
requirements to match the and delivered using
customer's site are not standard memory and
available on shore. They are the proprietary memory
being sourced from Singapore will be added later. All
but it will delay the builds and performance tests will
delivery of the machines. be delayed until the
memory is available.
Public Holidays 24/07/2007 Joanna The schedule includes staff Open: 24/07/2007
Stoat working on public holidays. A
number of staff have indicated
that contrary to what they
stated earlier they are not
available.
Compiler Version 24/07/2007 Eloise A number of the developers Under Review:
disparity Norman have downloaded different 24/07/2007
versions of a number of the
compilers. This has lead to
unpredictable builds
impacting on testing.

3.6.7 Use Case Estimation

Metrics and Estimation

Project estimation is the task of working out how much time and effort is required to build and deploy a
solution.
The Use Case metrics facility in Enterprise Architect provides a starting point for estimating project effort.
Using this facility you can get a rough measure of the complexity of a system and some indication of the effort
required to implement the model. Like all estimation techniques, this one requires some experience with
previous projects to 'calibrate' the process.
There is additional information available on Use Case metrics at www.sparxsystems.com/UCMetrics.htm.

Calibrating
The following values must be carefully calibrated in order to gain the best possible estimates:

© 1998-2010 Sparx Systems Pty Ltd

 336 Projects and Teams | Project Management

· Technical Complexity Factors 336 , which are values that attempt to quantify the difficulty and complexity of
the work in hand
· Environment Complexity Factors 337 , which are values that attempt to quantify non-technical complexities
such as team experience and knowledge
· Default Hour Rate 340 , which sets the number of hours per Use Case point.

Estimating
Once you have entered all the calibration values, you can estimate the project timescale through the Use
Case Metrics dialog 338 .

3.6.7.1 Technical Complexity Factors

Technical Complexity Factors are used in the Use Case Metrics estimation technique. You can add or modify
these factors using the Estimation Factors dialog.
To open this dialog, select the Settings | Estimation Factors menu option. Click on the Technical Complexity
Factors tab.

Defined Technical Types

This editable list should contain all factors that could affect the technical complexity of the project environment.
These configured factors, whose summed Ex Values yield the Unadjusted TCF value, work together with the
Environment Complexity Factors 337 to skew the overall complexity up or down, depending on the level of
technical complexity and the corresponding level of environmental support.

Enterprise Architect User Guide

 Projects and Teams | Project Management 337

Note:
You can transport the Technical Complexity Factors between models, using the Export Reference Data 223
and Import Reference Data 225 options on the Tools menu.

Weight
The TCF Weight indicates how much technical complexity you assign to a factor. For example, 'the system is
to be developed in ADA' might warrant a higher weight than 'the system is to be a shell script'. A weight
evaluates its respective factor, but is irrelevant to a project; the Value field assesses each factor's role within a
project. The supplied factors and their associated weights are defined by the Use Case Points Method,
although they can be adjusted to suit a project's specific requirements.

Value
For most purposes, the only table column requiring adjustment is Value, which indicates the degree of
influence a particular factor has on the project. As a suggested gauge, a value of 0 indicates no influence, 3
indicates average influence and 5 indicates strong influence.

3.6.7.2 Environment Complexity Factors

Environment Complexity Factors are used in the Use Case Metrics estimation technique. You can add or
modify these using the Estimation Factors dialog.
To open this dialog, select the Settings | Estimation Factors menu option. Click on the Environment
Complexity Factors tab.

© 1998-2010 Sparx Systems Pty Ltd

 338 Projects and Teams | Project Management

Defined Environment Types

This editable list should contain all factors affecting the general design and development environment,
including team experience and knowledge, team size, expertise and other non-functional environmental
factors.
These configured factors, whose summed Ex Values yield the Unadjusted ECF value, work together with the
Technical Complexity Factors 336 (TCFs) to skew the overall complexity up or down, depending on the level of
technical complexity and the corresponding level of environmental support.

Note:
You can transport the Environment Complexity Factors between models, using the Export Reference Data
223 and Import Reference Data 225 options on the Tools menu.

Weight
A Weight evaluates its respective factor's complexity in comparison to other factors, but is irrelevant to a
project; the Value field assesses each factor's role within a project. The supplied factors and their associated
weights are defined by the Use Case Points Method, although they can be adjusted to suit a project's specific
requirements.

Value
For most purposes, the only table column requiring adjustment is Value, which indicates the degree of
influence a particular factor has over the project. As a suggested gauge, a value of 0 indicates no influence, 3
indicates average influence and 5 indicates strong influence.

3.6.7.3 Estimating Project Size

Enterprise Architect uses a simple estimation technique based on the number of Use Cases to be built, the
difficulty level of those Use Cases, some project environment factors and some build parameters.

Note:
This technique is of value only once you have developed a couple of known projects to use as a baseline.
Please DO NOT use the provided 'guesstimates' as a real world measure until you have some real world
base lines to measure against.

Once the parameters are set up and the Use Cases defined, open the Use Case Metrics dialog by:
· Navigating to the package of interest and selecting the Project | Use Case Metrics menu option, or
· Right-clicking on the package of interest in the Project Browser and selecting the Documentation |
Package Metrics context menu option.

Enterprise Architect User Guide

 Projects and Teams | Project Management 339

Option Use to

Root Package Confirm the root package in the hierarchy. All Use Cases under here could
potentially be included in the report.

Reload Re-run the search, usually after you change the filter criteria.

Phase like Include Use Cases with a phase that matches the wildcard value in the field (use * to
match any characters, for example 1.* for 1.1 and 1.2).

Keyword like Include Use Cases with a keyword that matches the wildcard value in the field (use *
to match any characters).

Use Cases Check the total count of Use Cases in estimate.

Technical Complexity Review the parameters that describe the degree of technical complexity of the
Factor project. While the unadjusted TCF value comes from theTechnical Complexity
Factor 336 tab of the Metrics and Estimation Types dialog, the other values compose
the Use Case Points Method formula. Modify these fields with caution. The final
project estimate is directly proportional to the TCF.

Environment Review the parameters that calculate the degree of environmental complexity of the
Complexity Factor project, from factors such as programmer motivation or experience. The listed
parameters compose the formula calculating the ECF, defined by the Use Case
Points Method; the only parameter affected by the project is the unadjusted ECF
value, derived from the Environment Complexity Factors 337 tab of the Metrics and
Estimation Types dialog. The final project estimate is directly proportional to the
ECF.

Unadjusted Use Check the sum of the Use Case complexity numbers.
Case Points (UUCP)

Ave Hours per Use Check the average of the number of hours assigned to easy, medium and difficult
Case Use Cases; for information purposes only.

Total Estimate Review the detailed breakdown of the final figure. Note that you must tailor the hours

© 1998-2010 Sparx Systems Pty Ltd

 340 Projects and Teams | Project Management

Option Use to

per Use Case point figure to the level that matches your type of project and
capability based on known previous project outcomes.

Default Rate Set the default hours 340 fed into the final calculation.

Re-Calculate Re-run the estimate, usually after you change the hours or Use Case point number.

Report Produce a rich text formatted report from the current estimate.

3.6.7.4 Default Hours

To set the default hour rate per adjusted Use Case point, use the Default Hour Rate tab of the Estimation
Factors dialog.
To access this tab:
· Click on the Default Rate button on the Use Case Metrics 338 dialog 338 (displays the tab as the only tab of
the Settings dialog), or
· Select the Settings | Estimation Factors menu option and click on the Default Hour Rate tab.

Type values in the Duration and Hourly Rate fields; click on the OK button to save the current values.

Notes:
· The values you enter are stored as local settings on your computer only.
· This option is also active in the 'Lite', read-only version of Enterprise Architect.

Setting an hourly rate is the most difficult factor in an accurate estimation. Typical ranges can vary from 10 to
30 hours per Use Case point. Studying the Use Case Points Method, from which this variable is defined, can
help you to understand its role in the estimation and facilitate selection of a suitable initial value. The best way
to estimate this value is through analysis of previous completed projects. By calculating the project estimation
on a completed project for which the Use Cases and environment are configured within Enterprise Architect,
you can adjust the hour rate to render an appropriate value for your unique work environment.

3.6.8 Update Package Status

Elements in Enterprise Architect can be assigned a current status, such as Proposed, Validated or Mandatory
.
Often a complete package structure is updated from one status to another (or released) at the same time. To
help facilitate this, Enterprise Architect supports a 'bulk' update of element status at the same time.

Update Element Status for a Complete Package Structure

To update element status for a complete package structure, follow the steps below:
1. In the Project Browser, right-click on the package to update. The context menu displays.
2. Select the Package Control | Update Package Status menu option. The Status Update dialog
displays.

Enterprise Architect User Guide

 Projects and Teams | Project Management 341

3. Select:
· The new status
· Whether to recursively descend the package tree
· Whether to include elements
· Whether to include element requirements
· Whether to include element constraints
4. Click on the OK button. Enterprise Architect updates all required elements to the new status.

3.6.9 Manage Bookmarks

A bookmark is a visual clue that something is different about an element; you can assign whatever meaning to
the bookmark as is appropriate to your model.
You bookmark a selected element in a diagram by pressing [Shift]+[Spacebar], or by selecting the Edit |
Bookmark Selected menu option. The bookmark is represented by a small red triangle that displays above
the element in the diagram.

You clear the bookmark by clicking on the element and pressing [Shift]+[Spacebar] again, or by selecting
the Edit | Bookmark Selected menu option again.

Tip:
The Model Search window 1235 also enables searching based on bookmarked elements.

Bookmark Multiple Elements

You can also bookmark all elements in a folder (and their children) using the Manage Bookmarks dialog.
Right-click on the parent package in the Project Browser and select the Bookmarks context menu option.

© 1998-2010 Sparx Systems Pty Ltd

 342 Projects and Teams | Project Management

This dialog enables you to automatically bookmark elements that have new changes or defects defined in the
Maintenance 1558 window, or test scripts defined in the Testing 1537 window. This is useful to highlight elements
that have additional project information.
To clear all elements of bookmarks:
· In the current package tree, click on the Clear All button on the Manage Bookmarks dialog
· In the current diagram, select the Edit | Clear All Bookmarks menu option.
You should reload the project 267 to show the new or cleared bookmarks ([Ctrl]+[Shift]+[F11]).

3.6.10 Monitor Events

In the Enterprise Architect Corporate, Business and Software Engineering, Systems Engineering and Ultimate
editions, the Model Views 1226 facility enables you to:
· automatically refresh the search in a View at an interval that you define
· notify you if the results of the search change between two consecutive searches.

You can therefore use the Model Views facility to monitor various events in the development project,
depending on how you set up the search in a View. You could, for example, set up a search to detect:
· Change items, or Issue items, so that Enterprise Architect would notify you as new items were created
· Element Status, Type, Phase, Version, Priority and/or date of last update, so that Enterprise Architect
would notify you as items were progressed to fall in to the level of work represented by the search
categories, and to move out of the categories into the next level of work.
· Tagged Values, so that - again - as items were changed to satisfy the criteria of a sequence of searches,
the progression of items through a set of stages could be checked and managed.
People responsible for different stages in a process could have their own Model View searches so that as a

Enterprise Architect User Guide

 Projects and Teams | Project Management 343

development, validation or authorization task falls due the responsible person is automatically notified, and
when the work is complete both the next person in line and the overseeing manager are notified.

© 1998-2010 Sparx Systems Pty Ltd

 344 Projects and Teams | Maintenance

3.7 Maintenance

This topic highlights some administrative functions you might have to carry out to maintain your model:
· Check Project Data Integrity 344

· Upgrade Projects 346

· Rename a Project 348
· Compact a Project 348
· Repair a Project 348
Note that you only rename, compact and repair models created as .EAP files. These processes are not
required for models stored in a DBMS.

3.7.1 Project Data Integrity

If you have a failed XMI import, network crash or other unforeseen event that could disrupt the integrity of
information in the model, it is recommended to run the Project Integrity Check function 344 .
The integrity check examines all database records and ensures there are no 'orphaned' records or inaccurate
or unset identifiers. You can run the integrity checker first in report mode to discover if anything should be
corrected, and then run it again in repair mode.
When Enterprise Architect checks the model, it attempts to recover lost packages and elements, and
generates a new package at the model root level called _recovered_. Check through any elements that are
found and, if required, drag them into the model proper. If they are not required, delete them.

Note:
This function does NOT check UML conformance, only the data relationships and repository structure.

You can select a variety of items to check, and select either to just report on the state of your model, or to try
and repair any inconsistencies. The recovery process tries to restore elements where possible, but in some
cases simply deletes the lost records.

See Also
· Run SQL Patches 346

3.7.1.1 Check Project Data Integrity

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Check Data Integrity 198 permission to perform a
data integrity check.

To check the data integrity of your project, follow the steps below:
1. Select the Tools | Data Management | Project Integrity Check menu option. The Project Integrity
Check dialog displays.

Enterprise Architect User Guide

 Projects and Teams | Maintenance 345

2. Select the checks to run; the basic checks available are:

· Package Structure
· Object Structure
· Object Features
· All GUIDs
· Cross References
· Connectors
· UML 2.0 Migration.
3. Select either:
· the Report Only option to just view a report on the state of your model, or
· the Recover/Clean option to attempt to recover and clean your project.

Warning:
If you intend to select the Recover/Clean option, you should back up your project file first.

4. To write a log of the integrity check, click on the Save Results button and select a log file.
5. Click on the Go button to run the check. If you want to display the resulting information in a more
readable layout, you can resize the dialog and its columns.

© 1998-2010 Sparx Systems Pty Ltd

 346 Projects and Teams | Maintenance

UML 2.0 Migration

The UML 2.0 Migration check enables you to migrate the project from UML 1.3 semantics to UML 2.0
semantics. The migration process currently converts activities that are invocations of operations into called
operation actions as per the UML 2.0 specification. The UML 2.0 Migration option is an exclusive process that
does not enable any of the other checks to be selected. To perform the UML 2.0 migration follow the steps
below:
1. Select the Tools | Data Management | Project Integrity Check menu option. The Project Integrity
Check dialog displays.
2. Select the UML 2.0 Migration checkbox and click on the Go button. The following message box
displays:

3. To proceed, click on the OK button, or to cancel the migration click on the Cancel button.
4. If you are proceeding, click on the Go button on the Project Integrity Check dialog to perform the
migration.

3.7.1.2 Run SQL Patches

Occasionally, Sparx Systems might release a patch to correct a model fault.
To load such patches and run them, select the Tools | Run Patch menu option. The patch generally checks
how many records are to be updated, and reports on what is to be done.

3.7.2 Project Upgrade

The structure of Enterprise Architect project files is occasionally changed to support more features. When this
happens, existing project files must be upgraded to the new format to ensure correct operation and to take
advantage of all the new features.
When you try to load a project that was created in an early release of Enterprise Architect (for example, an
archived project) using a recent release of Enterprise Architect, the system determines whether the project
should be upgraded and, if the upgrade is necessary, displays the Upgrade Wizard 347 , which takes you

Enterprise Architect User Guide

 Projects and Teams | Maintenance 347

through the upgrade process.

Upgrading is a simple and quick process that brings your project to the current level to support all the latest
Enterprise Architect features.

3.7.2.1 The Upgrade Wizard

When you first try to load an old project in a new version of Enterprise Architect, the system determines
whether the project should be upgraded and, if the upgrade is necessary, displays the Upgrade Project Wizard
.

The Upgrade Project Wizard:

· Advises you of the necessity to upgrade
· Advises you to back up the current project; it is essential to back up before any changes are made
· Checks which upgrade path is required
· Guides you through the steps to perform the upgrade
· Opens the newly converted project.

Notes:
· For replicated models: If the wizard detects the project you are opening is a replica and not a Design
Master, a different upgrade path 347 is required.
· Once upgraded, the project cannot be opened with the version of Enterprise Architect in which it was
created.

3.7.2.2 Upgrade Replicas

Models that have replication features added might have to be upgraded differently from regular projects.
If the model is a Design Master 185 (the root model of all other replicas) then you can upgrade the model to
suit the current version of Enterprise Architect. After upgrading a Design Master you should re-create the
replicas, rather than synchronizing.
If the model is not a Design Master, Enterprise Architect must first remove the replication features, then
upgrade the project in the normal manner. The Upgrade Wizard 347 guides you through the steps.

© 1998-2010 Sparx Systems Pty Ltd

 348 Projects and Teams | Maintenance

3.7.3 Rename a Project

Important:
The only way to rename an Enterprise Architect project is at the Windows file system level.

To rename an Enterprise Architect project .EAP file, follow these steps.

1. If you have the project open, shut it down.
2. Ensure no other users have the file open.
3. Open Windows Explorer and navigate to the project.
4. Rename the project file using Windows Explorer.
5. You should keep the .EAP extension the same to preserve compatibility with the default project type, as
installed in the registry at installation time.

3.7.4 Compact a Project

After some time, a project .EAP file might benefit from compacting to conserve space.

Notes:
· Compacting shuffles the contents of the model around, eliminating unused space and generally reducing
the size of your model file.
· In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Administer Database 198 permission to compact
a project.

Warning:
Always compact and repair projects on a local drive, never on a network drive.

To compact a project, follow the steps below:

1. Ensure that no users have the target project open.
2. Select the Tools | Manage .EAP File | Compact .EAP File menu option.
3. Follow the on-screen instructions to complete the process.

3.7.5 Repair a Project

If a project has not been closed properly, such as during system or network outages, on rare occasions the .
EAP file does not open correctly. In this case a message displays informing you the project is of an unknown
database format or is not a database file.

Warning:
Never attempt to repair a project over a network connection; copy it to a local drive first.

Notes:
· Poor network connections can also cause this symptom.
· In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Administer Database 198 permission to repair a
project.

Repair a Project That Has Not Closed Correctly

To repair a project that was not closed properly, follow the steps below:

Note:
All users must be logged off the project you are attempting to repair.

1. Copy the project file to a local drive on your PC.

Enterprise Architect User Guide

 Projects and Teams | Maintenance 349

2. In Enterprise Architect, select the Tools | Options menu option and on the General page deselect the
Use Jet 4.0 - requires restart checkbox.
3. Close and restart Enterprise Architect and open a place holder project to enable access to the Repair
.EAP File facility.

Note:
This is NOT the project you intend to repair, it is a copy of it.

4. Select the Tools | Manage .EAP File | Repair .EAP File menu option.
5. Follow the on-screen instructions.

Ensure Integrity of the Repaired Project

An additional step you can use to ensure the integrity of your project is to use the Remove Replication
feature.
1. Open Enterprise Architect, but when you are prompted to open a project, click on the Cancel button.
2. Select the Tools | Manage .EAP File | Remove Replication menu option.
3. Follow the prompts. When you are prompted for the Replica Project Browser window for your problem
project, you might be given a warning about the project not being the Design Master; accept this
warning. Click on the Next button.
4. Browse for the clean project (for example, EABase.eap). Click on the Next button.
5. Enter the path and name of the new project to be created, then click on the Next button.
6. Click on the Run button to run the removal process.
7. Once the removal process has been completed, open the project and do a check of the project
contents. If the data is intact, backup the old project and replace it with the new version.

© 1998-2010 Sparx Systems Pty Ltd

 350 Projects and Teams | Local Options

3.8 Local Options

There are several options to customize how Enterprise Architect displays and works with models and model
elements. This topic describes those settings that are local to a particular user and machine.
Select the Tools | Options menu option to display the Options dialog.

Most of these settings are stored in your registry so they are set for your use only. For a networked workplace,
registry settings can be copied down to any network workstation you log in to. Otherwise, the settings are valid
for the current machine only.
You select the required page of options by clicking on the appropriate category name in the left hand list on
the dialog. For information on the options on a specific page, select the appropriate page title below.

· General 351 · Source Code Engineering · Python 1356

1336
· Standard Colors 353 · Visual Basic 1360
· Code Editors 1337
· Diagram 355 · VB.Net 1358
· Object Lifetimes 1340
· Diagram Appearance 356
· Attribute/Operations 1341
· Diagram Behavior 359
· ActionScript 1348
· Diagram Sequence 360
· C 1349
· Objects 362
· C# 1350
· Links 364
· C++ 1351
· Communication Message
Colors 366 · Delphi 1352

Enterprise Architect User Guide

 Projects and Teams | Local Options 351

· XML Specifications 367 · Java 1355

· PHP 1356

Note:
The options in the second and third columns above, and additional defaults and settings, are discussed
under the various code generation and import/export topics in this User Guide.

3.8.1 General
The General page of the Options dialog is shown below:

Option Use to

Author Set the default author when new elements are created and modifications
made.

Clipboard Format Set the graphic format in which to save image to the clipboard; Metafile
has the best detail.

Double-click on Browser Configure the Project Browser behavior 1210 .

Use Jet 4.0 - requires restart Set JET 4.0 as the database engine; this ensures compatibility with .EAP
files that are in turn compatible with versions of MS Access later than
Access 97, and that support unicode character sets.
If your project is not in a Jet 4.0 database, you should also download a
copy of the Jet 4.0 EABase Model from the Sparx Systems website, and
do an EAP to EAP transfer 307 of your model into the Jet 4.0 file.

Use extended « and » Apply the guillemet characters to stereotypes. For some double byte
characters character sets, it is best to select this checkbox.

© 1998-2010 Sparx Systems Pty Ltd

 352 Projects and Teams | Local Options

Option Use to

Allow custom RTF tags in Enable you to use customized rich text format code in report templates
reports when generating reports with the Legacy RTF Report Generator 1628 .
From release 7.0 of Enterprise Architect, with the Notes 642 formatting
facility, this option is not really necessary.

Project Directory Specify the default location of Enterprise Architect projects.

File Directory Specify the default location for files.

Web Home Specify the default home page to open when you click on the Home
button in the internal web browser 103 .

Web Search Specify the default web page to open when clicking on the Web Search
button in the internal web browser 103 .

Web Mail Specify the email server address (http://xxxxx/exchange/) for accessing
email through the web browser 103 within Enterprise Architect.

Confirm Deletes Use or bypass the Confirm Delete dialog; only clear this checkbox if you
are an experienced user!

Allow Free Sorting Enable you to re-order elements within a package regardless of element
type, in the Project Browser.

Show Stereotypes Show element and feature stereotypes in the Project Browser.

Always open maximized Ensure that Enterprise Architect always starts up in a maximized window.

Hide Properties Info Section Hide or show the properties information status bar on the Properties
window.

Docked Windows Tabs on Display the docked window tabs at the bottom of the window (default).
Bottom (requires restart) Clear the checkbox to show the tabs at the top of the windows.

Main Diagram Tabs at Bottom Display the diagram tabs at the bottom of the main view (default). Clear
(requires restart) the checkbox to show the tabs at the top of the main view.

Model Loading Strategy Select the Enterprise Architect model loading behavior; choose either:
· Load on Demand (Lazy Load)
· Preload Entire Model
Load on Demand does not load the full project view when the model is
loaded. Instead, only the parts that are necessary to display the visible
portion of the tree are loaded. This means that a model loads faster and
users can begin work sooner, but at the expense of later small delays as
Enterprise Architect loads specific portions of the model.

Enterprise Architect User Guide

 Projects and Teams | Local Options 353

3.8.2 Standard Colors

The Standard Colors page of the Options dialog enables you to set the display color of a range of objects and
their backgrounds. On first use, the page displays the system default colors, as shown below:

To display the range of colors available for an item, or define a new color, click on the down arrow at the end
of the appropriate field. The selection pallet displays.

Click on the required color. This sets the field on the Standard Colors page to the selected color.
If you require a wider selection of colors, click on the Other button and select from the color chart, or
customize a color using RBG/HSL codes.
If you decide to reset the color to the system default, click on the Default button.

Option Use to

Paper Define the paper (background) color in diagrams.

Element Fill Define the fill color of elements.

Element Line Define the line color of elements.

Shadow Define the color of element outline shadows.

Attribute Define the color of attribute text.

© 1998-2010 Sparx Systems Pty Ltd

 354 Projects and Teams | Local Options

Option Use to

Method Define the color of method (operation) text.

Note Color Define the note background color.

Note Compartment Text Define the color of text in the element Note compartment.

Screen Define the screen (element) color.

Connector Line Define the connector line color.

Behavior Define the color for behaviors in Activity diagrams.

Show Project Custom Enable use of project custom colors; for more information on setting and
Colors in Element Format getting the custom colors see the Get and Set Project Custom Colors 540
toolbar topic.

Notes:
· Using this page of the Options dialog, you can set the background of all diagrams to be a specific color.
You can also use the Diagram Appearance 356 page to set all diagram backgrounds to be either a uniform
color or to have a fade gradient from top to bottom. Alternatively, you can create a background image for
the diagram; see the Create Custom Diagram Background 448 topic.
· To override the default appearance of a specific element on all diagrams on which it is found, right-click on
the element and select the Appearance | Default Appearance context menu option. The Default
Appearance 538 dialog displays.
· To change the appearance of a specific element on the current diagram only, use the Format 85 toolbar
85 . If the Format toolbar is not displayed, select the View | Toolbars | Format Tool menu option.

Enterprise Architect User Guide

 Projects and Teams | Local Options 355

3.8.3 Diagram
The New Diagram Defaults page of the Options dialog enables you to configure overall options for new
diagrams and general diagram behavior.

Option Use to

Default Page Size Show the default page size for new diagrams, which you set by clicking on
the Page Setup button to display the Page Setup dialog.

Print with Border Print pages with a border.

Landscape Print pages in landscape orientation. This checkbox is controlled from the
Page Setup dialog.

Show Public Features Set the default visibility of Class features.

Show Protected Features
Show Private Features

Show Diagram Notes Display the diagram details in the top left corner of all diagrams in the model.
Details include diagram name, package, version and author.

Use Opaque Diagram Specify where opaque diagram labels should display. Screen and Printing
Labels are best, Clipboard and Files might not be desirable.

Strict UML Syntax Enforce compliance with UML syntax when adding new connectors and other
structures.

Disable fully scoped Disable fully scoped object names, when an element is in a diagram; don't
object names use when the element is in its home package. A scoped name is of the
format MyClasses::foo, the :: character indicating that the Class is within
another namespace.

Allow change of Created Enable the creation date on the Diagram Properties dialog to be altered.
Date

© 1998-2010 Sparx Systems Pty Ltd

 356 Projects and Teams | Local Options

Option Use to

Zoom to best scale Resize diagrams to neatly fit the screen.

Auto-pan with middle Turn on auto-panning using the middle mouse button. With this option off, the
mouse button middle mouse button causes a different type of panning.

Scale Saved Bitmaps to Enable Enterprise Architect to save bitmaps at a higher resolution, suitable for
using in published works.

Image Memory Limit Set an image memory limit when generating images for RTF or HTML and
when saving images to file. It is important when you have very large diagrams,
as it affects the point at which Enterprise Architect starts to scale down the
image; a low memory setting means it scales the image sooner.

Diagram Frames Select whether diagram frames are to be automatically added to images of
diagrams in files saved to disk, print-outs, and the default Enterprise Architect
clipboard.
A diagram frame 766 is a labeled outline around the diagram image, providing
both a border and a reference.

3.8.3.1 Appearance
The Diagram Appearance page of the Options dialog enables you to define how diagrams and their contents
appear on display.

Option Use to

Configure Default Element Set the default model and user text fonts 357 .
Fonts

Renderer Render smooth curves and diagonal lines in diagrams, so that staggered
vertical or horizontal pixels are less obvious. Select the type of renderer you
prefer to use:

Enterprise Architect User Guide

 Projects and Teams | Local Options 357

Option Use to

· Basic is GDI32; it does not provide anti-aliasing and gradient fills

· Enhanced-1 is parallel to Windows GDI+ but internal to Enterprise
Architect; it provides anti-aliasing and gradient fills, and operates well
across different platforms
· Enhanced-2 is Windows GDI+; this can vary across different platforms,
performing better than Enhanced-1 in some environments, and less well
in others.
Experiment with these options and see which works best for your system
and requirements.

Default Element Border Set the default element border width (in pixels).
Width

Scale view by Automatically increase the size of all objects on a diagram by up to 50%,
without affecting other users reading that diagram.
You can perform the same function with the Zoom Slider on the Status 89
bar; changes in the 'zoomed' display scale of a diagram update this field
and affect any other diagrams that you open.
This has no impact any other diagram Zoom facility in Enterprise Architect.

Print in Color Print your diagrams in color. Deselect the checkbox to print the diagrams in
black and white.

Anti-aliased text Force text anti-aliasing in diagrams.

If you deselect the checkbox, Enterprise Architect applies the MS Windows
default setting. Therefore, if you do not want to use anti-aliasing, ensure that
the Windows anti-aliasing default is also set to OFF.

Compress text to fit within Determine the behavior of Enterprise Architect when text at zoom levels
Element other than 100% would not fit inside the boundary of an element. Enterprise
Architect either compresses the text to fit within the boundary, or expands
the element.

Bold Element Names Display element names in bold text.

Element Shadows On Display a shadow around the bottom and right edges of each element in a
diagram.

Invert rotated text for Use different text format when external metafile readers are causing issues.
metafiles

Use Watermark Add a watermark to any diagrams you print.

Text Define the watermark text, if a watermark is to be used.

Show Gradient Fill for Paper Switch between having a color gradient in the diagram background, or
Color having a solid, uniform background color.

Gradient Fill Direction For Select the direction for the color gradient within element boxes, or <none>
an Element for no color gradient.

3.8.3.1.1 Set Default Fonts

Enterprise Architect enables you to define a standard font to apply across the model, or a font to apply to any
diagrams you create personally.
You can define both, but the model font overrides any user font, to ensure that all members of a project team
have a consistent and coherent view of the model. This avoids the problem of one user creating a diagram in a
small font, and another user trying to view it in a larger font, which distorts the diagram.
It is recommended that a project authority sets the model default, and all project members abide by it and do

© 1998-2010 Sparx Systems Pty Ltd

 358 Projects and Teams | Local Options

not change it without project approval.

To set the default fonts, follow the steps below:
1. On the Appearance page of the Options dialog, click on the Configure Default Element Fonts button.
The Configure Default Fonts dialog displays.

2. To set a model font, in the Font Face field of the Model Font panel, click on the drop-down arrow and
select the appropriate typeface.
3. In the Font Size field, click on the drop-down arrow and select the required font size.
4. To clear a model font so that the user font takes effect, click on the Clear button. (Ensure that this is
acceptable to all other team members.)
5. To set a user font, in the Font Face field of the User Font panel, click on the drop-down arrow and
select the appropriate typeface.
6. In the Font Size field, click on the drop-down arrow and select the required font size.
7. To return the user font to the Enterprise Architect default (Arial 8), click on the Restore Defaults button.
8. To save the changes, click on the OK button.
Both model and user fonts are overridden by specifically-defined element fonts, so that the element is viewed
as designed regardless of the model or user defaults. To define the font for a specific element, right-click on
the element in a diagram and select the Appearance | Set Font 556 context menu option.
If you cannot read the diagrams because the default font makes the objects and text too small, you can scale
up all objects (that is, all diagram displays) to a more readable size for you only; the objects are not scaled up
for other users. Everything on the diagram is enlarged to the same extent, so it remains in proportion and
readable. To do this, return to the Diagram Appearance page of the Options dialog and enter a suitable
percentage value in the Scale view by 357 field.

Enterprise Architect User Guide

 Projects and Teams | Local Options 359

3.8.3.2 Behavior
The Diagram Behavior page of the Options dialog enables you to define how a diagram responds to actions
taken on it.

Option Use to

Auto Instance Automatically create object instances when dragging certain element types -
such as Class and Component - from the Project Browser, with the dragged
element as the classifier.

Instance has Classifier Automatically apply the classifier style of the element an instance is
style instantiated from when the instance is created.

Show Life Lines Show life lines for Sequence elements in non-Sequence diagrams.

Layout uses all relations Show all relationships in a diagram layout; deselect the checkbox to show
only Generalizations and Associations.

Auto Save Changes Automatically save your changes as you work, without having to confirm
prompts to do so.

Show 'Hidden' Parents Display any parents of elements in the diagram that are not part of the
diagram.

Auto Group Elements Also move visually composed elements when moving diagram nodes. A node
is considered composed if it is contained by the moved element and has a
higher z-order. Press and hold [Alt] whilst moving an element to toggle this
option.

Show Linked Items in Display connected items on packages.

Package

Show Package Item Display the + and - indicators representing the scope of the items.
Scope

© 1998-2010 Sparx Systems Pty Ltd

 360 Projects and Teams | Local Options

Option Use to

Shift-Mouse Autoscroll Enable you to press and hold [Shift] and use the mouse to autoscroll around
diagrams.

Use Automatic Generate a new Structured Activity linked to the diagram from a Structured
SubActivities Activity diagram dragged from the Project Browser.

Always Highlight Context Show a hatch border 543 around a selected element.
Element

Objects Snap to Grid Snap all elements to the grid lines.

Show Grid Display the grid.

Grid Size Specify the grid size, if you have selected Objects Snap to Grid.

Auto Tidy Automatically tidy line angles 617 for custom connectors. This 'nudges' the
custom line into horizontal and vertical increments.

Tidy line gap Specify the amount Enterprise Architect should enable you to move a line
away from horizontal and vertical when you are tidying lines 617 for custom
connectors. (See Auto Tidy above).

Alias only Display the alias instead of the element name on elements with aliases.

Alias and Name Display both the element name and the Alias in the format (Alias) name.

Use alias field for role Replace the Alias property of instances with a Role property.

3.8.3.3 Sequence
The Sequence page of the Options dialog enables you to configure various font settings and the focus of the
control indicator for Sequence diagrams.

Enterprise Architect User Guide

 Projects and Teams | Local Options 361

Option Use to

Message Spacing Specify the vertical gap (in points) between Sequence messages (can be
overridden manually by dragging a message up or down).

Default page layout is Set the default orientation of Sequence diagrams to landscape.
Landscape

Show Sequence Show sequence numbers on Sequence messages.

Numbering

Assume right to left Automatically generate return messages.

messages are Return

Default concurrency is Set the default concurrency for Sequence Messages 868 to Asynchronous;
Asynchronous deselect to set the default concurrency to Synchronous.

Width Select the line width (in points) of the 'focus of control' rectangle (thick part of
lifeline).

Assume message returns Assume implicit returns when none are explicitly drawn (recommended).

GarbageCollect Automatically truncate lifelines for created elements after the last message
(that is, assume garbage collect rather than explicit delete).

Name Display the MS Windows Font dialog (click on [ ... ]) and define the font of the
caption bar heading (above your diagram); this is particularly useful for non-
English character sets.

Size Specify the size of the heading font (this overrides the font size in the Font
dialog, above).

Use System Apply the Enterprise Architect system default heading font.

© 1998-2010 Sparx Systems Pty Ltd

 362 Projects and Teams | Local Options

3.8.4 Objects
The Objects page of the Options dialog enables you to configure how elements look and respond in diagrams.

Option Use to

Version Set the default version for new elements.

Phase Set the default phase for new elements.

Highlight References Highlight parameters in operations that are passed by reference rather than
value.

Reference Char(s) Specify a character to use for the reference.

Prefix/Suffix Indicate whether to use the Reference Char(s) value as a prefix (before) or a
suffix (after).

Warn about spaces in Enable or hide the warning message that a Class, operation or attribute name
class names has embedded spaces (which can cause coding problems).

Classes honor analysis Show Classes as their stereotype; for example, if a Class is stereotyped as a
stereotypes Boundary, it appears as a Boundary rather than a Class.

Show stereotype icon for Show or hide a code letter in the top right corner of Requirement (E, for
requirements external), Change (C) and Issue (I) elements.

Support for Composite Enable you to drag child elements onto parent elements in a diagram 529 , and
Objects automatically embed them (and drag embedded child elements out of parent
elements, breaking the child-parent relationship).

Auto-resize marks Ensure that auto-resizing of elements (such as Classes) marks the current
diagram 'dirty' diagram as changed (asterisk on the diagram name tab), so it should be
saved.

Enterprise Architect User Guide

 Projects and Teams | Local Options 363

Option Use to

Highlight {abstract} Highlight abstract elements with a suitable tag {abstract} in the top right of the
elements Class.

Allow elongated Use Stretch Use Cases or Use Case extension points with long names to enable
Cases space for the name. If you deselect the checkbox, Use Case re-sizing is
proportional.

Show status colors on Enable color coding 653 for Requirements and similar elements.
diagrams

Copy inheritance links on Duplicate Inheritance and Realization connectors when an edit/copy is
duplicate performed.

Port and Part type visible Enable Port and Part types to be shown by default.
by default

Show buttons for selected Display the floating toolbar buttons to the left of the selected object. For
Object on diagram example:

Edit Object on New Automatically show the element Properties dialog when a new element is
added.

Show «column» Hide or show the «column» stereotype used when data modeling.
stereotype

Extend Complexity Extend levels of complexity to five levels in the Complexity option in the
Properties window. Otherwise only three levels are available.

UML 1.5 Components Use UML 1.5 components (Enterprise Architect versions 4.0 and later support
UML 2.x).

Show State Compartment Show or hide the State Compartment divider under the state name.

Show Duplicate Tags Enable duplicate tags to be shown.

Group Operations by Group an element's operations by their stereotype on the diagram.

Stereotype

Group Attributes by Group an element's attributes by their stereotype on the diagram.

Stereotype

Sort Features Sort element features alphabetically. Features include Attributes, Operations,
Alphabetically Tags, Constraints and Test Cases.

Disable spelling Turn off automatic spell checking.

Deselect to resume automatic spell checking.

Advanced Set the visibility 363 of certain elements in reports and in diagram packages.

3.8.4.1 Element Visibility

Some elements do not appear in packages and in RTF output by default. Click on the Advanced button on
the Objects 362 page of the Options dialog to specify which elements should be visible.
See the topic on customizing element visibility 535 for more details.

© 1998-2010 Sparx Systems Pty Ltd

 364 Projects and Teams | Local Options

3.8.5 Links
The Links page of the Options dialog shown below provides options for the creation, behavior and notation for
connectors.

Option Use to

General

Edit Connector on New Automatically show the connector Properties dialog when a new
connector is added.

Association default = source --> Set the direction of new Associations to source->target (that is, with an
target arrow head at the target).

Generalization link style Default = Show Generalizations as tree style hierarchies.

Tree

Shade Qualifier boxes Lightly shade all Qualifier boxes.

Enterprise Architect User Guide

 Projects and Teams | Local Options 365

Option Use to

Draw Aggregations Reversed Draw Aggregate and Composite connectors from target element to
source element. When deselected (the default), these connectors are
drawn from source to target.

Note:
All tools have the parent as the target and the child as the source of
the connector, that is a requirement of UML; only the direction in
which you drag the mouse to draw the connector is changed.

Prompt on connector deletes Display a prompt before deleting connectors 619 , offering the choice of
hiding the connector on the diagram or deleting it completely.
If you deselect this option, the delete operation defaults to the last
setting on the dialog.

Suppress Link Constraints Suppress connector constraints in diagrams.

Suppress Qualifier boxes Suppress boxes when displaying qualifiers.

Show Uses arrowheads Show an arrowhead on Actor->Use Case Associations.

Show Override Operation dialog Show the Override Operation dialog automatically when adding
on new connector generalizations and realizations between Classes and Interfaces, if the
target element has features that can be overridden.

Suppress ' + ' Role Scope Ensure that the role and scope are not displayed on the diagram.

Default Style

Pen Width Set the default connector width.

Routing Set the default connector style for new connectors.

Quick Linker

Enable Enable the Quick Linker 474 .

Show Help Add a 'help' menu option to the end of the Quick Linker menu.

New Connector End-Points

Center to center
Change the position of the dashed guide line for new connectors.
Exact placement

Force perpendicular line

© 1998-2010 Sparx Systems Pty Ltd

 366 Projects and Teams | Local Options

3.8.6 Communication Message Colors

The Communication Message Coloring page in the Options dialog enables you to configure the colors used in
Communication diagrams.

Select the Use Communication Message Coloring checkbox to turn on colored messages. When you
enable this option, Communication messages appear in different colors depending on the sequence group
they belong to on a diagram; for example, 1.n are black, 2.n are red, 3.n are green.
Click on the down arrow in each color field, and click on the appropriate color for the message group. Set the
color sequence as required; the pattern repeats after 8 sequence groups.

Enterprise Architect User Guide

 Projects and Teams | Local Options 367

3.8.7 XML Specifications

The XML Specifications page of the Options dialog enables you to configure various settings for working with
XML.

Option Use to

Editor Set the default editor for any XML documents you open within Enterprise
Architect.

Format XMI Output Set whether or not formatting is applied to your XMI output.

Write Log Set whether or not to write to a log file when you import or export XML.

Use DTD Set whether or not to use a Data Type Definition.

Export Diagrams Set whether or not to export diagrams when you export XML.

Export Alternate Images Set whether or not to export the alternative images 447 used in the model when
you export to XML.

Note:
If this option is set, and you have packages in your model under version
control, then any alternative images used in those packages are also exported
to the version control repository when you check in 261 the packages.
In this case, you would only select the checkbox if the alternative images are
subject to frequent change. Otherwise, do not select this option and instead
use Export/Import Reference Data 223 to manage alternative images.

Default XMI Version Set the XMI version to use: Enterprise Architect or Rose.

Code Page Set the Code Page to use; setting a NULL encoding string results in the
encoding tag being entirely omitted from the XML output. Click on the Default
button to restore the setting to the default Code Page.

© 1998-2010 Sparx Systems Pty Ltd

 368 Projects and Teams | Local Options

Option Use to

Export Diagram Images Set whether or not to export diagrams as images when you export XML.

Image Type Define the format of the image to export to if Export Diagram Images is
selected.

Prefix EA Tagged Values Set whether or not to prefix any Enterprise Architect Tagged Values within any
in XMI 1.0 with ea$ XMI 1.0 you create, with ea$.

Update Last Save Time Set whether to update the timestamp of the last time controlled packages were
in Controlled Packages saved.

Default XML Directory Define the default XML directory to use when importing and exporting XML.

Enterprise Architect User Guide

Part

IV
 370 Modeling Fundamentals |

4 Modeling Fundamentals

Modeling can be described as 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, document
and communicate its detail. A study of such a model can enable insight or understanding of the system.

The Enterprise Architect Modeling Platform

Enterprise Architect's modeling platform is based on the Unified Modeling Language (UML), a standard that
defines rules and notations for specifying business and software systems.
For information on UML, see the Standard UML Models 672 topic.
For examples of the UML models that Enterprise Architect can help you build, see the Model Templates 373
topic.

Building a Model
Using Enterprise Architect, you can quickly build a model using a hierarchy of packages to represent the
structure and organization of the model. Each package can contain:
· Other packages
· Diagrams that represent various aspects of the equipment, environment and business processes of the
system
· Elements that represent the objects and actions within the system or process, arranged in an organization
defined by relationships represented by UML connectors.
The Quick Start Tutorial 28 topic briefly shows you how to create a diagram within a package, containing
elements and connectors. Sparx Systems also provide a demonstration of quickly developing a Use Case
model.
For specific details of configuring and combining the components of a model, see:
· Packages 387
· Diagrams 391
· Elements 478
· Connectors 606 .

Relationship Matrix
The Relationship Matrix enables you to display and manage the relationships between the elements within
selected packages. You can refine the display to show specific types of relationship between specific types of
element. The Relationship Matrix 1261 is an effective and convenient method of visualizing relationships quickly
and definitively.

Enterprise Architect User Guide

 Modeling Fundamentals | Modeling 371

4.1 Modeling

Enterprise Architect is a comprehensive UML analysis and design tool. It provides a library of UML data
structures that you can use and extend to develop your models.
For an explanation of how Enterprise Architect interprets the UML standards and specifications, see the
Standard UML Models 672 topic.
· You create your projects and models using the Start Page 50 or File Menu 56 , which provide templates
373 on which to base your models

· You initially create your packages and diagrams using the Toolbars 79 and Menus 54 , and the elements
and connectors using the Diagram Toolbox 399
· You can also create new structures through the Project Browser 1209 , and re-use existing structures using
the Project Browser, Model Views 1222 , Element List 1255 and Model Search 1231 .
Building models requires the use of various UML data structures and Enterprise Architect tools, as above, to
graphically represent 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.
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 the Modeling Fundamentals 370 , Build Your Own Modeling Language 1092 and
Requirements 917 topics.

© 1998-2010 Sparx Systems Pty Ltd

 372 Modeling Fundamentals | Models

4.2 Models

In Enterprise Architect a model is a special type of package, being the top level entry point to an Enterprise
Architect project file.
You can develop a project with one model, or with several. Each model is a root node of a hierarchy of Model
Packages and Views and, below them, packages. A model contains the diagrams, elements, relationships and
associated metadata that define the structure and function of a system or process. These components are
organized through the package hierarchy, which helps to group and manage related components. By iterating
through all models, you can access all the elements within the project.
You can create the model or models when you first create the project, or you can add and develop new
models later. You can also delete a model, but be aware that everything contained in the model is deleted as
well.

4.2.1 Model Wizard

The Model Wizard is available on creating a new project. Once you have created a project, you can also
access the Model Wizard from the Project Browser.
Right-click on a root node, View or other top-level package and select the Add a New Model using Wizard
context menu option. The Select Model(s) dialog displays.

Enterprise Architect User Guide

 Modeling Fundamentals | Models 373

Option Use to

Select From Select the category containing the types of Model Package to create.

Technology (If you have advanced Add-Ins and MDG Technologies, this panel lists them). Select
the appropriate technology to list the associated templates in the Name panel.
To list the standard Enterprise Architect model templates 373 , select <default>.

All Select all of the models.

None Clear all models selected.

OK Create the Model Packages for your project.

Cancel Abort the creation of model packages.

Help Display this Help topic.

If you are a Technology Developer, you can also create and distribute custom templates 1146 as part of your
own MDG Technology 1118 . The name of your technology displays in the Technology panel and, when you
select the technology, the model template names display in the Name panel. If you have defined a filter in your
Model Technology File, you can select that from the Select from: drop-down list.

4.2.2 Model Templates

The model templates contained in Enterprise Architect are designed to assist in the creation of projects and
models for both new and experienced users.
Each template provides a framework on which you can create a model appropriate to your purpose, using the
Model Wizard 372 .

Template Format
All the model templates provided with Enterprise Architect follow the format described below.

Note
The note introduces you to the model template and outlines its purpose.
Help Links
Help hyperlinks provide further information on how to use the model. Depending on the model template, links
to examples and other useful information are also provided.
Template

© 1998-2010 Sparx Systems Pty Ltd

 374 Modeling Fundamentals | Models

The Template section in the model template provides a framework for creating your own model.
The topics listed below provide an introduction to the terminology and icons used in the model templates, and
give you a quick guide to the UML concepts important to the templates and how they are applied in Enterprise
Architect.
· Business Process Model Template 374

· Requirements Model Template 374

· Use Case Model Template 375
· Domain Model Template 376
· Class Model Template 376
· Database Model Template 377
· Component Model Template 378
· Deployment Model Template 378
· Testing Model Template 380 .
If you are a Technology Developer, you can also create and distribute custom templates 1146 as part of your
own MDG Technology.

4.2.2.1 Business Process Model Template

The Business Process model describes both the behavior and the information flows within an organization or
system. As a model of business activity, it captures the significant events, inputs, resources, processing and
outputs associated with relevant business processes.

Online Resources
· The Business Process Model

See Also
· Business Models 930
· Analysis Diagram 733
· Business Modeling/Interaction 739 Diagrams

4.2.2.2 Requirements Model Template

The Requirements model is a structured catalogue of end-user requirements and the relationships between
them.
The Requirements Management 917 facilities built into Enterprise Architect can be used to define Requirement
elements, connect Requirements to other model elements, connect Requirements into a hierarchy and report
on Requirements.

Enterprise Architect User Guide

 Modeling Fundamentals | Models 375

Online Resources
· Requirements Management in Enterprise Architect

See Also
· Packages 387

4.2.2.3 Use Case Model Template

The Use Case model describes a system's functionality in terms of Use Cases.
Each Use Case represents a single repeatable interaction that a user or 'actor' experiences when using the
system, emphasizing the user's perspective of the system and interactions. See the Use Case 806 and Use
Case Diagram 676 topics for more information.

Online Resources
· The Use Case Model

© 1998-2010 Sparx Systems Pty Ltd

 376 Modeling Fundamentals | Models

4.2.2.4 Domain Model Template

A Domain model is a high-level conceptual model, defining physical and abstract objects in an area of interest
to the Project.
The Domain model can be used to document relationships between and responsibilities of conceptual classes
(that is, classes that represent the concept of a group of things rather than Classes that define a programming
object). It is also useful for defining the terms of a domain.

A Domain model shows:

· The physical and organizational units of the domain; for example, Employee and Flight
· The relationships between these units; for example, Employee is assigned to Flight
· The multiplicity 630 of those relationships; for example, one employee can be assigned to no flights, one
flight or many flights (represented by the 1 and the * at the ends of that relationship).

4.2.2.5 Class Model Template

The Class model is a rigorous, logical model of the software system under construction.
Classes 811 generally have a direct relationship to source code or other software artifacts that can be grouped
together into executable components.

Enterprise Architect User Guide

 Modeling Fundamentals | Models 377

Online Resources
· The Logical Model

See Also
· Class Diagram 721

4.2.2.6 Database Model Template

The Database model describes the data that must be stored and retrieved as part of the overall system
design. Typically this means relational database models that describe the tables and data in detail and enable
generation of DDL scripts to create and set up databases.

© 1998-2010 Sparx Systems Pty Ltd

 378 Modeling Fundamentals | Models

Online Resources
· UML Database Modeling

See Also
· Data Models 1011

4.2.2.7 Component Model Template

The Component model defines how Classes, Artifacts and other low level elements are collected into high
level components 816 , and describes the interfaces and connections between them.
Components are compiled software artifacts that work together to provide the required behavior within the
operating constraints defined in the Requirements model 374 .

Online Resources
· The Component Model

See Also
· Component Diagram 730

4.2.2.8 Deployment Model Template

The Deployment model describes how and where a system is to be deployed.
Physical machines and processors are represented by Nodes 822 , and the internal construction can be
depicted by embedding Nodes or Artifacts 810 . As Artifacts are allocated to Nodes to model the system's
deployment and roll out 45 , the allocation is guided by the use of deployment specifications.

Enterprise Architect User Guide

 Modeling Fundamentals | Models 379

Online Resources
· The Physical Model

See Also
· Deployment Diagram 727
· Compartments - Tagged Values 521

© 1998-2010 Sparx Systems Pty Ltd

 380 Modeling Fundamentals | Models

4.2.2.9 Testing Model Template

The Test model describes and maintains a catalogue of tests, test plans and results that are executed against
the current model.

Online Resources
· Testing Support in Enterprise Architect

See Also
· Testing 1536
· Test Case 848 element
· Show Test Script Compartments 1549

Enterprise Architect User Guide

 Modeling Fundamentals | Models 381

4.2.2.10 Maintenance Model Template

The Maintenance model enables visual representation of issues arising during and after development 1558 of a
software product. The model can be enhanced with the integration of change elements and testing.

See Also
· Color Code External Requirements 920

4.2.2.11 Project Model Template

The Project model details the overall project plan, phases, milestones and resourcing requirements for the
current project.
Project Managers can use Enterprise Architect to assign resources to elements, measure risk and effort and
to estimate project size. Change control and maintenance are also supported.

© 1998-2010 Sparx Systems Pty Ltd

 382 Modeling Fundamentals | Models

Online Resources
· Project Manager

See Also
· Project Management 312

Enterprise Architect User Guide

 Modeling Fundamentals | Views 383

4.3 Views

The top level packages in a model (below the project root nodes) can be created as Views.
Views are used simply to subdivide the model into partitions such as Business Process, Logical View or
Dynamic View. Unlike Model Packages, they do not have automatically-generated components and can be
created only under a root node. They are a good way to extend the model depending on specific requirements
and modeling techniques.
There are six main types of View, each with their own package icon:
· Use Case View - containing, for example, Use Case diagrams 676 , Analysis diagrams 733
· Dynamic View - containing, for example, Activity diagrams 674 , Communication diagrams 715 , Sequence
diagrams 706 , State Machine diagrams 678
· Class View - containing, for example, Class diagrams 721 , Code Engineering 1281 , Data Models 739
· Component View - containing, for example, Component diagrams 730
· Deployment View - containing, for example, Deployment diagrams 727
· Simple View - to customize your own type of view.
You can use the first five categories, or devise your own based on the Simple View. You can create 383 Views,
rename 384 them, move them into a different order, or delete 385 them. Do this by right-clicking the mouse on
the selected View to open the context menu, and choose the appropriate option.

4.3.1 Add Views

The example below shows a customized view called Java Code View, which has been appended to the end of
the Views list.

Create a View
To create a View, follow the steps below:
1. Right-click on the model root node in the Project Browser. The context menu displays.
2. Select the New View menu option. The Create New View dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 384 Modeling Fundamentals | Views

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 required View icon.
5. If the model root node is under version control 228 , the Add to Version Control checkbox displays,
defaulted to selected. If you do not want the new View to also be under version control, deselect the
checkbox.
6. Click on the OK button.

4.3.2 Rename Views

If required, you can rename a view.

Procedure
To rename a view, follow the steps below:
1. Right-click on the View in the Project Browser. The context menu displays.
2. Select the Properties menu option. The Package Properties dialog displays.

Enterprise Architect User Guide

 Modeling Fundamentals | Views 385

3. In the Name field, type the new name and click on the OK button.

4.3.3 Delete Views

If necessary, you can delete a view.

Warning:
If you delete a view, all its contents are deleted at the same time. It CANNOT be restored.

Procedure
To delete a view, follow the steps below:
1. In the Project Browser, right-click on the view to delete. The context menu displays.
2. Select the Delete <viewname> option. The following warning displays:

© 1998-2010 Sparx Systems Pty Ltd

 386 Modeling Fundamentals | Views

3. To delete the view and its contents, click on the Yes button. To cancel the deletion, click on the No
button.

Enterprise Architect User Guide

 Modeling Fundamentals | Packages 387

4.4 Packages

A package is a container of model elements. It is represented in the Project Browser by the 'folder' icon
familiar to Windows users.
This topic explores the tasks you can perform with packages, including:
· Open a package 438
· Add a package 387
· Rename a package 388
· Copy a package 388
· Drag a package onto a diagram 389

· Show or hide a package 389

· Delete a package 390 .

Note:
In the Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Update Element 198 permission to update or delete
a package.

4.4.1 Open Package in the Project Browser

To open a package from the Project Browser, follow the steps below:
1. Double-click on a package; the contents display in the Project Browser.
2. Click on the + and - symbols next to the folder icon to open or close the package respectively.

Tip:
Package contents are arranged alphabetically and elements can be dragged from one package to another
using the mouse.

4.4.2 Add a Package

To create a new package:
1. In the Project Browser, select the package or view under which to add a new package.
2. Right-click on the folder icon within the Project Browser. The context menu displays.
3. Select the Add | Add Package menu option. The New Model Package dialog displays.

4. In the Package Name field type the name of the new package.
5. To immediately create a diagram for the package, leave the Automatically add new diagram
checkbox selected. To avoid creating a diagram, deselect the checkbox.

© 1998-2010 Sparx Systems Pty Ltd

 388 Modeling Fundamentals | Packages

6. If you are adding a package to a parent package that is under version control 228 , the Add to Version
Control option displays, with the checkbox selected. Deselect the checkbox to exclude the new
package from version control, otherwise leave it selected.
7. Click on the OK button. The new package is inserted into the tree at the current location and, if you left
the Automatically add new diagram checkbox selected, the New Diagram dialog 422 displays.
8. If you have selected to put the package under version control, the Package Control Options dialog
displays. Complete this dialog 295 as required.

Tip:
You can also add a new package element by dragging the Package icon from the Toolbox into a diagram. In
this case the package is created under the diagram's owning package, and is created with a default diagram
of the same type as that in which the package is created.

Note:
In a multi-user environment, other users do not see the change until they reload their project 267 .

4.4.3 Rename a Package

To rename a package, follow the steps below:
1. Select the package to rename in the Project Browser.
2. Right-click to display the context menu.
3. Click on the Package Properties option.
4. In the Name field, type the new name.
5. Click on the OK button.
Alternatively, highlight the package to rename, and press [F2].

Note:
In a multi-user environment, other users do not see the change until they reload their project 267 .

4.4.4 Copy a Package

Enterprise Architect enables you to quickly duplicate a complete package, including its child packages,
elements and diagrams.
You can insert the copy of a package:
· Under the same parent
· Under one or more other packages in the same model or project, or
· Under one or more other packages in any other model or project.
This procedure is effectively the same as exporting and importing the package XMI file 309 , with the Strip
GUIDs checkbox selected. You would tend to use this procedure for copying sections of a model within the
project rather than reproducing an entire model or project, although copying these larger structures is equally
feasible.

Notes:
· A copy of a package does not have the external cross references of the source package; that is, the
following connectors are discarded:

· Connectors coming from packages and elements outside the package being copied, into the
package being copied
· Connectors going to packages and elements outside the package being copied, from the
package being copied.
· You cannot paste a package into a parent package that is locked 205 by another user or that is checked in
261 . The Paste... option is grayed out in the context menu.

To copy a package, follow the step below:

1. In the Project Browser, right-click on the required package and select the Copy Package to Clipboard

Enterprise Architect User Guide

 Modeling Fundamentals | Packages 389

context menu option (or click on the package and press [Ctrl]+[C]). The Copy Package to Clipboard
dialog briefly displays until the copy operation completes.

To paste a package, follow the step below:

1. In the Project Browser, right-click on the package into which to paste the copied package, and select
the Paste Package from Clipboard context menu option (or click on the package and press [Ctrl]+[V]
). The Paste Package from Clipboard dialog briefly displays until the paste operation completes.
The target package is expanded to expose the pasted package in the Project Browser. If you are pasting the
package within the same model as the copied source, the source parent package is also collapsed.
If the target package already contains:
· a package with the same name as the pasted package, the pasted package name has the suffix - Copy
· a package with the same name as the pasted package including the - Copy suffix, the suffix becomes -
Copy1 (or - Copy 2, - Copy3 and so on, as copies of the package accumulate in the target parent
package).
You can keep the same package name as the source, or you can rename the package either by clicking twice
on it and editing the name in the Project Browser, or by double-clicking on it and editing the name in the
Properties dialog.

4.4.5 Drag a Package Onto a Diagram

You can drag a package element from the Project Browser onto the current diagram, as an icon of the
package listing its contents. This is a useful feature to help organize the display and documentation of models.
The following illustration shows how a package is displayed in a diagram; note the child Actor and Use Case
icons.

See Also
· Show or Hide Package Contents 389

4.4.6 Show or Hide Package Contents

To show or hide the contents of packages in a diagram, follow the steps below:
1. Load a diagram.
2. Double-click in the background area to open the Diagram Properties dialog.
3. Click on the Elements tab.

© 1998-2010 Sparx Systems Pty Ltd

 390 Modeling Fundamentals | Packages

4. Select or clear the Package Contents checkbox as required.

5. Click on the OK button.

4.4.7 Delete a Package

To delete a package, follow the steps below:
1. Highlight the package in the Project Browser.
2. Right-click to open the context menu.
3. Click on the Delete option. A confirmation prompt displays.
4. Click on the OK button.

Warning:
Deleting a package also deletes all contents of the package, including sub-packages and elements. Make
very sure that you really want to do this before proceeding.

Note:
In a multi-user environment, other users do not see the change until they reload their project 267 .

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 391

4.5 Diagrams

Diagrams are collections of project elements laid out and inter-connected as required.
Enterprise Architect supports all of the UML diagrams, as well as several custom extensions. Together with
the Enterprise Architect elements and connectors, these form the basis of the model. Diagrams are stored in
packages and can have a parent object (optional). Diagrams can be moved from package to package.
The basic elements used in each type of diagram are shown below. After you have reviewed these
illustrations, go to the following topics:
· Diagram Context Menu 394

· Diagram Tasks 421

Tip:
If the diagram display is too small to read comfortably, click on the diagram, press and hold [Ctrl] and use the
mouse wheel to temporarily expand or reduce the display magnification.

© 1998-2010 Sparx Systems Pty Ltd

 392 Modeling Fundamentals | Diagrams

Enterprise Architect User Guide

Modeling Fundamentals | Diagrams 393

© 1998-2010 Sparx Systems Pty Ltd

 394 Modeling Fundamentals | Diagrams

4.5.1 Diagram Context Menu

To open the diagram context menu, open the required diagram and right-click on the diagram background.
Not all the menu options shown below appear on all diagram context menus.

The diagram context menu enables you to:

· View the Diagram Properties 423 dialog
· Add Swimlanes 450 or a Swimlanes Matrix 444 to the diagram
· Protect a diagram from inadvertent changes (Lock Diagram 457 )
Note:
This does not apply if security is enabled in the Corporate, Business and Software Engineering, Systems
Engineering and Ultimate editions. In that case, see the Lock Model Elements 204 topic.

· Display the diagram contents as an Element List 1255 instead of as a diagram

· Insert 395 various elements and connectors into a diagram
· Paste copied element 433 (s) as a link or as new elements
· Paste an image 58 held on the clipboard into the diagram
· Make all the elements on the diagram selectable. If an element is selectable, you can move it around the
diagram and perform right-click context-menu operations. If an element is unselectable, you cannot move it
around the diagram and the only right-click operation available is to make the element selectable. This
option has no effect on double-click operations on the element, such as displaying child diagrams.
· Save the current diagram as a Profile 1106
· Import, or reverse engineer, source code 1329 (not available in the Desktop edition)
· Import database tables from an ODBC data source 1363 (not available in the Desktop edition)
· Save any changes to the current diagram
· View the Enterprise Architect Help on the type of diagram currently displayed.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 395

4.5.1.1 Insert Elements and Connectors

When you click on the New Element or Connector option on the Diagram context menu, a list of elements
and connectors displays, as shown below for a Class diagram:

The structure of this list is as follows:

· Other - expands to offer options to select elements and connectors from diagram types other than either
the current diagram type or pinned Toolbox pages
· The expanded list of elements and connectors for the current diagram type
· Collapsed lists of elements and connectors for pages that have been pinned in the Toolbox; if an MDG
Technology:
· is active
· automatically pins Toolbox pages, and
· has pages that redefine UML or Extended pages
the MDG Technology pages override the UML or Extended pages, which are not shown
· (At the end) Common - expands to display a list of the common elements and connectors.

4.5.2 Print Preview

When you select the File | Print Preview menu option, the display initially shows the first two pages on one
screen, with no scroll bar. To toggle between this two-page display and a single-page display, click on the
icon in the preview screen toolbar. In either mode, you can use the forward and back arrows to scroll through
the pages of the diagram.
To display more than two pages on one screen, up to a maximum of ten pages, click on the Zoom Out button
in the preview screen toolbar. The screen now includes the vertical scroll bar, which you can also use to scroll
through the pages of the diagram.

© 1998-2010 Sparx Systems Pty Ltd

 396 Modeling Fundamentals | Diagrams

4.5.3 Diagram View

The Diagram View is the main workspace window that enables you to create and display diagrams.
You open a diagram by double-clicking on the diagram name in the Project Browser. You can then open
further diagrams in the same way, or from within an open diagram by clicking on hyperlinks or elements that
contain other diagrams. You can open many diagrams, but you can view only one at a time.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 397

Across the top of a diagram is the diagram caption bar, containing the diagram statistics.

This caption bar also enables you to switch or close the diagram. The caption bar provides the:
· Icon and text label for the diagram type
· Diagram name
· Date and time the diagram was created
· Date and time the diagram was last modified
· The current magnification (zoom) of the diagram
· The diagram page size, in pixels
· A drop-down arrow that lists the currently-open diagrams; click on a diagram name to switch to that
diagram
· The Window 'close cross'; click on this to close the displayed diagram.
Use the Diagram View to build model relationships and elements. Within the diagram, you can create new
elements, drag in existing elements and generally organize the elements and relationships. Most work is
carried out on elements in the Diagram View, so understanding how it works and how to manipulate elements
is essential. Use the example project supplied with Enterprise Architect to explore the capabilities and
behavior of the Diagram View.

Tip:
You can also use the Element List 1255 to manipulate elements.

4.5.4 Diagram Tabs

Diagram Tabs are located, by default, at the bottom of the Diagram View. (You can also move them to the top
of the Diagram View, above the Status Bar; see the Configure Local Options | General 351 topic.)
Each time you open a diagram, the diagram name and diagram type symbol are shown in the tab for easy
identification and access.

© 1998-2010 Sparx Systems Pty Ltd

 398 Modeling Fundamentals | Diagrams

Notes:
· The Component View tab is white with bold text; this means that the Component View diagram is the
diagram currently displayed in the Diagram View.
· The Use Case View tab has an asterisk. This means that there are unsaved changes in the Use Case View
diagram. To save the changes see below 398 .
· There are also tabs for other types of view, such as the Start Page (as shown), RTF reports, code editors,
the Model Search and the Relationship Matrix.

The Diagram Tabs Menu

To access the Diagram Tabs context menu, right-click on an appropriate tab. In the example below, the *Use
Case View tab was right-clicked.

The table below explains each menu option.

Menu Option Use to

Save Changes to '<tab Save the changes made to the diagram.

name>'

Save All Save the model.

Reload '<tab name>' 1. Reopen the diagram without the unsaved changes; that is, revert to the
state before any changes were made.
2. Refresh the diagram 267 from the repository, to show any changes
made by other users in a shared model.
Close '<tab name>' Close the diagram; Enterprise Architect prompts you to save changes to the
diagram.

Close All Close all open diagrams; Enterprise Architect prompts you to save any
diagrams with unsaved changes.

Close All Except '<tab Close all diagrams except for '<tab name>'; Enterprise Architect prompts you to
name>' save any diagrams with unsaved changes.

Close All <view type> (Where several views of the same type can be opened at the same time, such
as diagrams, RTF documents, or text editors.)
Close all views of the same type as the selected tab, leaving views of other
types still open.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 399

4.5.5 Diagram Toolbox

What is the Toolbox?

The Enterprise Architect Toolbox is a panel of icons that you use to create elements and connectors on a
diagram.
Within the Toolbox, related elements and connectors are organized into pages, each page containing the
elements or connectors used for a particular type of diagram. The diagrams include standard UML diagrams,
Enterprise Architect Extended diagrams, and any MDG Technologies and Profiles that you have added to
Enterprise Architect. When you open a diagram, the Toolbox automatically provides the element and
relationship pages corresponding to the diagram type. This does not prevent you using elements and
connectors from other pages in a given diagram, though some combinations might not represent valid UML.

Display the Toolbox

To display the Toolbox, select the View | Diagram Toolbox menu option, or press [Alt]+[5].
The Toolbox can be docked on either side of the diagram, or free floated on top of the diagram to expose
more surface for editing.

Tip:

You can also hide and show the whole Toolbox using the Show Element Toolbox button on the
Workspace Views toolbar.

To display specific pages in the Toolbox, select the More Tools option at the top of the Toolbox and select the
appropriate UML, Extended or customized diagram type from the menu.
In most cases, three pages display: <type> elements, <type> Relationships and Common. If you select the
<default> option, you display only the Common page.

© 1998-2010 Sparx Systems Pty Ltd

 400 Modeling Fundamentals | Diagrams

Create Elements and Connectors:

1. In the Project Browser, double-click on the icon against the
required diagram. The diagram opens with the appropriate
Toolbox pages for that diagram type. (If you want a different set
of elements and connectors, click on More tools and select
the appropriate diagram type as explained above).
2. Click on the required item; for example, the Class element or
Associate relationship.
3. For element items, click anywhere on the diagram to place the
new element.
4. For connector items, drag the cursor between the source and
target elements on the diagram. The solid border of the
elements changes to a hatched border as you pass the cursor
over them, indicating the source and potential target elements.
To add bends to the connector, press [Shift] as you change
the drag direction of the cursor.

Alternatively, drag from the source element to an empty area of

the diagram; the Quick-linker 475 enables you to create the
target element.
5. Edit the element properties 481 or connector properties 626 , as
required.

Note:
Dropping a Package element from the Toolbox into a diagram
creates a new package in the Project Browser, and a default
diagram of the same type as the current diagram.

Tips:
· 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. For connectors, click on the source element
and press [F3] to create another connector of the same type.
· You can change an unstereotyped element to one of its
stereotyped 895 elements by dragging the stereotyped element
from the Toolbox onto the unstereotyped element in the diagram.
For example, you can stereotype a Class by dragging a Table
element or a Profiled Class element onto it.
· If the diagram element already has the stereotype, you can also
drag the Toolbox element onto it to synchronize the element's
stereotype Tagged Values 910 .

Customize The Toolbox

You can customize the Toolbox pages by pinning them 401 within the Toolbox, or by adding MDG
Technologies 1069 and UML Profiles 906 to the Toolbox.

Note:
Enterprise Architect provides Toolbox pages for a wide range of MDG Technologies, such as Archimate 1073 ,
BPEL, 958 BPMN 952 , Data Flow Diagrams 1076 , ICONIX 1084 and Mind Mapping 1087 , as part of the initial install.

You can also change other features of the Toolbox appearance - see Toolbox Appearance Options 401 .

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 401

4.5.5.1 Toolbox Appearance Options

You can modify the appearance of the Toolbox pages in several ways, through the context menu.
To display the context menu, right-click on the Toolbox page.

Note:
On a Toolbox page for an MDG Technology or UML Profile, if you right-click directly on a profile element an
additional option - Synchronize Stereotype - is available at the end of the context menu. This enables you
to synchronize 910 the Tagged Values and constraints for all elements created from the selected profile
element.

· To hide the element or relationship labels (and subsequently redisplay them), select the Hide Labels (or
Show Labels) context menu option. The icons in the page then 'wrap' within the page, without text labels.

When you hide the labels, you can display the label of an individual element or relationship by moving the
cursor over the icon.
· To 'pin' the page so that it displays for any group in the Toolbox, select the Pin in Toolbox menu option.
(This is not available on the Common page, which displays in all groups anyway.)

For example, if you 'pinned' the Class elements page, and switched to the Communication pages, the
Toolbox would include a collapsed Class elements page underneath the Communication pages.
· To unpin the page so that it displays only in its own Toolbox group, right-click on it and select the Unpin
from Toolbox context menu option.
· To collapse a page to just show the heading (<type> elements, <type> Relationships or Common), click on
the 'minus' box at the left of the page heading. To expand the page again, click on the heading.
Alternatively, collapse the page by right-clicking on the page and selecting the Collapse context menu
option.

Set Toolbox Visibility

To tailor the Toolbox to list all pages you require at the same time, follow the steps below:
1. Click on the Set Toolbox Visibility context menu option. The Visible Toolbox Pages dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 402 Modeling Fundamentals | Diagrams

2. By default, the dialog lists the element pages only, in the order: UML pages, Extended pages, MDG
Technology pages. To include the corresponding relationship pages, select the Show Relationship
Pages checkbox at the bottom of the dialog.
3. For each page to display on the Toolbox, select the Visible checkbox. Deselect the checkbox if you no
longer require a page to be displayed.
4. When you have defined the list of pages to display, click on the OK button. The pages you have
selected are pinned to the Toolbox in a collapsed state, underneath the current diagram-type pages.

5. To expand a page, click on the heading. You can remove a page individually by expanding it, right-
clicking on it and selecting the Unpin from Toolbox context menu option.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 403

Note:
MDG Technologies can impose their own Toolbox page visibility. For example, if ICONIX is the active
technology, all six ICONIX pages are automatically exposed in the Toolbox.
If the active Technology pages duplicate UML or Extended pages (as the ICONIX pages do) then the pinned
Technology pages override and replace the pinned UML and Extended pages.
For example, if ICONIX is active and you have pinned the Extended Analysis page, the Analysis page in the
list is the ICONIX-defined page, not the Extended Analysis page.

4.5.5.2 Toolbox Shortcut Menu

To add elements and connectors into a diagram, you can access the Toolbox shortcut menu instead of
employing the full graphical Toolbox.
The menu provides options to select:
· Elements specific to the current diagram type (Use Case in the example shown below)
· Relationships specific to the current diagram type
· Elements and relationships from any pages pinned in the Toolbox
· Common elements and relationships
· Elements and connectors for other diagram types.

© 1998-2010 Sparx Systems Pty Ltd

 404 Modeling Fundamentals | Diagrams

The advantage of using the Toolbox shortcut menu is that it provides an increased amount of the workspace
to be used for diagramming rather than to display fixed (instead of pop-up) menus.
To use the Toolbox shortcut menu, follow the steps below:
1. Open a diagram.
2. Either:

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 405

· Click on the diagram background and press [Insert] or [Spacebar]

· Press and hold [Ctrl] and right-click on the diagram background.
The shortcut menu displays, listing the current diagram-type elements and connectors.
3. If necessary, select the Other option or a pinned Toolbox page option to list elements and connectors
for a different diagram type.
4. Select the element or connector to include in the diagram. The object is added to the diagram.
If you select the Other context menu option, the final menu in the sequence offers the Activate <Type>
Toolbox option. This opens and activates the corresponding page in the Toolbox, if the Toolbox is visible.

Note:
As with the Toolbox itself, if an MDG Technology:
· is active
· automatically pins Toolbox pages and
· duplicates UML or Extended pages
the pinned Technology pages override and replace the pinned UML or Extended pages in the initial Toolbox
shortcut menu.

4.5.5.3 Common Group

The Common page of elements and relationships is displayed at the bottom of every other set of pages. It
contains the elements and relationships that can be used on any diagram.

Toolbox Elements and Connectors

Note:
Click on the elements and connectors below for information.

© 1998-2010 Sparx Systems Pty Ltd

 406 Modeling Fundamentals | Diagrams

Common Elements Common Connectors

4.5.5.4 Use Case Group

Use Case elements are used to build Use Case models 676 . These describe the functionality of the system to
be built, the requirements, the constraints and how the user interacts with the system.
Often, Sequence diagrams are associated with Use Cases to capture work flow and system behavior.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 407

The Use Case group is used to model the system functionality from the
perspective of a system user. The user is called an Actor and is drawn as a
stick figure, although the user could be another computer system or similar.
A Use Case is a discrete piece of functionality the system provides that
enables the user to perform some piece of work or something of value using
the system.
Examples of Use Cases are: login, open account, transfer funds, check
balance and logout; each of these implies some purposeful and discrete
functionality the system is to provide to a user.
A Test Case 848 describes what must be set up in order to test a particular
feature.
The connectors available include: associate (an actor uses a Use Case),
extend (one Use Case can extend another), include (one Use Case can
include another) and realize (this Use Case might realize some business
requirement).
To add an element to the current diagram, click on the required icon and
drag it into position on the diagram. Set an element name and other
properties as prompted.
To add a relationship, click on the required icon, then click on the start
element in the diagram and drag to the end element.

Note:
Invokes and Precedes relationships are defined by the Open Modeling
Language (OML). They are stereotyped Dependency relationships; Invokes
indicates that Use Case A, at some point, causes Use Case B to happen,
whilst Precedes indicates that Use Case C must complete before Use Case
D can begin.

4.5.5.5 Class Group

The Class group can be used for Package diagrams 720 , Class diagrams 721 and Object diagrams 723 : those
that usually display elements concerned with the logical structure of the system, such as Objects, Classes and
Interfaces.
Logical models can include domain models (high level business driven object model) through to strict
development Class models (define inheritance, attributes, operations).

© 1998-2010 Sparx Systems Pty Ltd

 408 Modeling Fundamentals | Diagrams

The Class group is used for creating Class models and database models. Class
modeling is done using the Class and Interface elements, as well as occasional
use of the Object element to model Class instances. You can add Association
or Aggregation relationships. See the Class 376 model template for an example
of this.
Use the Table element to insert a stereotyped Class for use in database
modeling. See the Data Modeling 1011 topic for more details.
To add an element to the current diagram, click on the required icon and drag it
into position on the diagram. Set an element name and other properties as
prompted.
To add a relationship, click on the required icon, click on the start element in
the diagram and drag to the end element.

4.5.5.6 Object Group

The Object group is used to create Object diagrams 723 .

Object diagrams reflect multiplicity and the roles instantiated Classes could serve. They are useful in creating
different cases in which relationships and Classes are applied.

The user is called an Actor 757 and is drawn as a stick figure, although the
user could be another computer system or similar.
An Object 823 is an instance of a Class.
To add an element to the current diagram, click on the required icon, and
drag it into position on the diagram. Set an element name and other
properties as prompted.
To add a relationship, click on the required icon, then click on the start
element in the diagram and drag to the end element.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 409

4.5.5.7 Composite Group

The Composite group is used for Composite Structure diagrams 724 .

These reflect the internal collaboration of Classes, Interfaces or Components to describe a functionality or to
express run-time architectures, usage patterns and the participating elements' relationships, which static
diagrams might not show.

To add an element to the current diagram, click on the required icon,

and drag it into position on the diagram. Set an element name and other
properties as prompted.
To add a relationship, click on the required icon, then click on the start
element in the diagram and drag to the end element.

4.5.5.8 Communication Group

The Communication group is used to model dynamic interactions between elements at run-time.
The Actor element models a user of the system, while the other elements model things within the system,
including standard elements (rectangular element), user interface component (circle with left positioned
vertical bar), controller (circle with arrow head in top most position) and entity (circle with bar at bottom).

Communication diagrams 715 are used to model work flow and

sequential passing of messages between elements in real time.
They are often placed beneath Use Case elements to further
expand on Use Case behavior over time.
To add an element to the current diagram, click on the required
icon, and drag it into position on the diagram. Set an element name
and other properties as prompted.
To add a relationship, click on the required icon, then click on the
start element in the diagram and drag to the end element.

Note:
Communication diagrams were know as Collaboration diagrams in
UML 1.4.

© 1998-2010 Sparx Systems Pty Ltd

 410 Modeling Fundamentals | Diagrams

4.5.5.9 Interaction Group

The Interaction group is used for Interaction diagrams (Sequence 706 , Timing 690 , Communication 715 or
Interaction Overview 717 ), which are used to model work flow and sequential passing of messages between
elements in real time.
Interaction diagrams are often placed beneath Use Case elements to further expand on Use Case behavior
over time.

The Interaction group is used to model dynamic interactions

between elements at run-time. The Actor element models a user of
the system, while the other elements model things within the
system, including standard elements (Lifeline), user interface
component (Boundary), controller and Entity. The meaning of the
element symbols is discussed further in the Sequence diagram 706
topic. The Message (sequence) relationship is used to model the
flow of information and processing between elements.

Note:
Messages can be simple or recursive calls.

To add an element to the current diagram, click on the required

icon, and drag it into position on the diagram. Set an element name
and other properties as prompted.
To add a relationship, click on the required icon, then click on the
start element in the diagram and drag to the end element.

4.5.5.10 Timing Group

The Timing group is used solely for Timing diagrams 690 , which use a time-scale to define the behavior of
objects. The time-scale visualizes how the objects change state and interact over time.
Timing diagrams can be used for defining hardware-driven or embedded software components, and time-
driven business processes.

A Lifeline is the path an object takes across a measure of time, indicated by

the x-axis.
A State Lifeline 794 follows discrete transitions between states, which are
defined along the y-axis of the timeline. Any transition has optional attributes
of timing constraints, duration constraints and observations.
A Value Lifeline 808 shows the lifeline's state across the diagram, within
parallel lines indicating a steady state. A cross between the lines indicates a
transition or change in state.
To add an element to the current diagram, click on the required icon, and drag
it into position on the diagram. Set an element name and other properties as
prompted.
To add a relationship, click on the required icon, then click on the start
element in the diagram and drag to the end element.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 411

4.5.5.11 State Group

The State group is used by State Machine diagrams 678 to show the enableable states a Class or element
might be in and the transitions from one state to another. These diagrams are often placed under a Class
element in the Project Browser to illustrate how a particular element changes over time.

The State group provides elements common to State Machine diagrams;

basically the State, start and end nodes and the Object Flow relation. State
Machine diagrams are used to model the states or conditions that elements
might be in at runtime, such as active, inactive, idle, accelerating or braking.
States can have substates; for example, accelerate or brake might be
substates of active.
To add an element to the current diagram, click on the required icon and drag
it into position on the diagram. Set an element name and other properties as
prompted.
To add a relationship, click on the required icon, then click on the start
element in the diagram and drag to the end element.

© 1998-2010 Sparx Systems Pty Ltd

 412 Modeling Fundamentals | Diagrams

4.5.5.12 Activity Group

The Activity group is used to model system dynamics from a number of viewpoints in Activity diagrams 674 and
Interaction Overview diagrams 717 .

Activity elements enable you to describe the dynamics of the system from the
point of view of activities and flows between them. Activities can be
stereotyped as a process to display a business process icon. An Activity is
some work that is carried out; it might overlap several Use Cases or form only
a part of one Use Case.
Send and Receive events are included as triggers.
A Decision element marks a point where processing might split based on
some outcome or value.
The Flow relation models an active transition and synch points are used to
split and rejoin periods of parallel processing.
To add an element to the current diagram, click on the required icon, and drag
it into position on the diagram. Set an element name and other properties as
prompted.
To add a relationship, click on the required icon, then click on the start
element in the diagram and drag to the end element.

4.5.5.13 Component Group

The Component group enables you to model the physical components of your system in a Component
diagram 730 .
A component is a piece of hardware or software that makes up the system; for example, a DLL or Web Server
are Components that might be deployed on a Windows 2000 Server (Node). See the Deployment Diagram 727
topic for an example of this.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 413

The Component group contains elements related to the actual building

of the system: the components that make up the system (such as
ActiveX DLL's or Java beans), the Interfaces they expose and the
dependencies between those elements.
To add an element to the current diagram, click on the required icon and
drag it into position on the diagram. Set an element name and other
properties as prompted.
To add a relationship, click on the required icon, then click on the start
element in the diagram and drag to the end element.

4.5.5.14 Deployment Group

The Deployment group enables you to model the physical components and deployment structure of your
system in a Deployment diagram.
A Component is a piece of hardware or software that makes up the system, and a Node is a physical platform
on which the component is to exist. For example, DLLs or Web Servers are Components that could be
deployed on a Windows 2000 Server (Node). See the Deployment Diagram 727 topic for an example of this.

© 1998-2010 Sparx Systems Pty Ltd

 414 Modeling Fundamentals | Diagrams

The Deployment group contains elements related to the actual building

of the system; the components that make up the system (such as
ActiveX DLLs or Java beans) and the nodes those components run on,
including the physical connections between nodes.
To add an element to the current diagram, click on the required icon,
and drag it into position on the diagram. Set an element name and other
properties as prompted.
To add a relationship, click on the required icon, then click on the start
element in the diagram and drag to the end element.

4.5.5.15 Profile Group

The Profile group contains extended UML elements and connectors that can be used to create and modify
Profiles 906 , for rapidly creating stereotypes and Tagged Values that can be applied to structures such as
elements, attributes, methods and connectors.

A Profile is used to provide a generic extension mechanism for building

UML models in particular domains. They are based on additional
Stereotypes and Tagged Values that are applied to structures such as
elements, attributes, methods, connectors and connector ends.
A Stereotype provides a mechanism for varying the behavior and type of
a model element.
A Metaclass is used to create a Class whose instances are Classes; a
metaclass is typically used to construct metamodels.
An Enumeration creates a Class stereotyped as enumeration, which is
used to provide a list of named values as the range of a particular type.
An Extension relationship shows that a stereotype extends one or more
metaclasses. All stereotypes must extend either one or more
Metaclasses, or another stereotype that extends a stereotype (that itself
extends a stereotype, and so on).
A Generalize relationship shows that one stereotype specializes a more
general stereotype. The more general stereotype must still extend a
metaclass.
A Tagged Value relationship defines a reference-type (that is, RefGUID)
Tagged Value owned by the source stereotype. The Tagged Value is
named for the target role of this association, and is limited to
referencing elements with the stereotype by the association target
element.
The Application and Redefinition relationships are deprecated.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 415

To add an element to the current diagram, click on the required icon, and drag it into position on the diagram.
Set an element name and other properties as prompted.
To add a relationship, click on the required icon, then click on the start element in the diagram and drag to the
end element.

4.5.5.16 Metamodel Group

The Metamodel group enables you to create metamodel diagrams with support for MOF 1380 diagrams.

A Package 825 is a namespace as well as an element that can be

contained in other package's namespaces.
A Class 811 is a representation of objects, that reflects their structure
and behavior within the system.
An Enumeration 819 is a Class with an enumeration stereotype.
A Primitive supports the MOF specification (deprecated - use the UML
Primitive in the Class 407 group).
To add an element to the current diagram, click on the required icon and
drag it into position on the diagram. Set an element name and other
properties as prompted.
To add a relationship, click on the required icon, then click on the start
element in the diagram and drag to the end element.

© 1998-2010 Sparx Systems Pty Ltd

 416 Modeling Fundamentals | Diagrams

4.5.5.17 Analysis Group

Analysis-type elements are used early in modeling to capture business processes, activities and general
domain information. They are generally used in Analysis diagrams 733 .

The elements and relationships in the Analysis group are used for early
modeling of business processes, activities and collaborations. You can
use stereotyped activities to model business processes, or stereotyped
elements to capture standard UML business process modeling
extensions such as worker, case worker, entity, and controller.
To add an element to the current diagram, click on the required icon and
drag it into position on the diagram. Set an element name and other
properties as prompted.
To add a relationship, click on the required icon, click on the start
element in the diagram and drag to the end element.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 417

4.5.5.18 Custom Group

The Custom group contains a few extended UML elements that might be of use in modeling or designing your
system in a Custom diagram 734 .

A Package 825 is a namespace as well as an element that can be contained

in other package's namespaces.
A Requirement 846 is a custom element used to capture requirements
outside of standard UML elements. A Requirement expresses required
system behavior that can cross several Use Cases. You can connect
Requirements to other elements using the Realize connector to express the
implementation of a requirement and hence the traceability 1245 from user
requirements to what is being built.
An Issue element is a structured comment that contains information about
defects and issues relating to the system/model (see the Defects (Issues)
1563 topic). Affected elements are connected by Trace 892 connectors.

A Change element is a structured comment that contains information about

changes requested to the system/model (see the Changes and Defects 1563
topic). Affected elements are connected by Trace 892 connectors.
A Screen 847 provides a stereotyped Class element that displays a GUI type
screen; this can be used to express application GUI elements and flows
between them.
A UI control 849 likewise can be used to express GUI controls.
A Test Case 848 element defines what must be set up in order to test a
particular feature (see the Testing Workspace 1537 topic). It enables you to
define a set of tests once for a number of elements, and provides greater
visibility for tests.
An Entity is a stereotyped element that represents any general thing not
captured by the element or Class type elements (for example a trading
partner). Use of this element is deprecated: it was originally intended to
take the role now occupied by a Table 849 element.
To add an element to the current diagram, click on the required icon and
drag it into position on the diagram. Set an element name and other
properties as prompted.
To add a relationship, click on the required icon, then click on the start
element in the diagram and drag to the end element.

© 1998-2010 Sparx Systems Pty Ltd

 418 Modeling Fundamentals | Diagrams

4.5.5.19 Requirement Group

As an analysis step, often it is desirable to capture simple system requirements. These are eventually realized
by Use Cases.

A Package 825 is a namespace as well as an element that can be

contained in other package's namespaces.
Specify the Requirement 846 of a system. Note that there are a few
different requirement types, such as.
· Display
· Functional
· Performance
· Printing
· Report
· Testing
· Validate.
A Feature 840 is a small client-valued function expressed as a
requirement. Features are the primary requirements-gathering artifact
of the Feature-Driven Design (FDD) methodology.
An Object 823 is an instance of a Class.
To add an element to the current diagram, click on the required icon,
and drag it into position on the diagram. Set an element name and
other properties as prompted.
To add a relationship, click on the required icon, then click on the start
element in the diagram and drag to the end element.

4.5.5.20 Maintenance Group

The Maintenance 1558 elements are defects, changes, issues and tasks.

A Package 825 is a namespace as well as an element that can be

contained in other package's namespaces.
An Issue element is a structured comment that contains information
about defects and issues 1563 relating to the system/model. Affected
elements are connected by Trace 892 connectors.
A Change 1563 element is a structured comment that contains
information about changes requested to the system/model. Affected
elements are connected by Trace 892 connectors.
A Test Case 848 describes what must be set up in order to test a
particular feature.
An Entity is a stereotyped element that represents any general thing
not captured by the element or Class type elements (for example a
trading partner). Use of this element is deprecated: it was originally
intended to take the role now occupied by a Table 849 element.
To add an element to the current diagram, click on the required icon,
and drag it into position on the diagram. Set an element name and
other properties as prompted.
To add a relationship, click on the required icon, then click on the start
element in the diagram and drag to the end element.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 419

4.5.5.21 User Interface Group

The User Interface group enables you to create graphical user interface diagrams.

A Package 825 is a namespace as well as an element that can be

contained in other packages' namespaces.
A Screen 847 element represents a graphical user interface. You can
place GUI elements onto the screen element.
UI Control 849 elements are placed onto the screen element to build up
a graphical user interface diagram. There are different stereotyped
elements such as buttons and combo boxes.
An Object 823 is an instance of a Class.
To add an element to the current diagram, click on the required icon,
and drag it into position on the diagram. Set an element name and
other properties as prompted.
To add a relationship, click on the required icon, then click on the start
element in the diagram and drag to the end element.

The following diagram illustrates the GUI elements from the Toolbox, within a Screen element.

© 1998-2010 Sparx Systems Pty Ltd

 420 Modeling Fundamentals | Diagrams

4.5.5.22 WSDL Group

The WSDL group gives you the ability to rapidly model 1050 and automatically generate 1379 W3C Web Service
Definition Language (WSDL) documents.

A Namespace 1051 represents the top-level container for the WSDL

model. Drag this element onto an open diagram to create the
necessary model structure for WSDL documents.
A physical WSDL document 1053 is represented as a UML component.
Its interfaces represent the WSDL services 1054 .
A WSDL Port Type 1056 is modeled as a UML interface. Its Port Type
Operations 1059 are realized by Binding 1057 elements. Each of the
operation parameters is derived from the Message elements defined in
the Messages 1056 package.
To add an element to the current diagram, click on the required icon
and drag it into position on the diagram. Set an element name and
other properties as prompted.
To add a relationship, click on the required icon, click on the start
element in the diagram and drag to the end element.

4.5.5.23 XML Schema Group

The XML Schema group provides the ability to model 1040 and automatically generate 1376 W3C XSD schema
files. This group implements the constructs provided by the UML profile for XML Schema 1041 .

A Schema corresponds to a UML package, which contains the type

and element definitions for a particular targetNamespace. Drag this
item onto an open diagram to create the package to contain your
schema model elements. The package is stereotyped as XSDschema.
Open the logical diagram created under the XSDschema package and
add additional schema elements as required.
To add an element to the current diagram, click on the required icon
and drag it into position on the diagram. Set the name and other
properties as prompted.
To add a relationship, click on the required icon, then click on the start
element in the diagram and drag to the end element.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 421

4.5.5.24 Data Modeling Group

This group is used for database modeling 1011 and database design, in conjunction with the UML Data
Modeling Profile.

The Table 849 element defines a table on the data model.

The View element represents database views 1032 in the data model.
The Procedure element represents stored procedures 1030 in the data
model.
To add an element to the current diagram, click on the required icon
and drag it into position on the diagram. Set an element name and
other properties as prompted.
To add a relationship, click on the required icon, click on the start
element in the diagram and drag to the end element.

4.5.6 Diagram Tasks

This topic describes many of the common tasks associated with managing diagrams.

Note:
In the Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Update Element 198 permission to update or delete
items on a diagram, and Manage Diagram permission to create, copy or delete diagrams.

· Add New Diagrams 422

· Set Diagram Properties 423
· Add Elements and Connectors From Toolbox 399
· Paste from the Project Browser 430
· Copy And Paste Diagram Element 433
· Place Related Elements on Current Diagram 433
· Delete a Diagram 434
· Rename a Diagram 434
· Change Diagram Type 434
· Diagram Navigation Hotkeys 435
· Copy Image to Disk 435
· Copy Image to Clipboard 436
· Duplicate a Diagram 436
· Z Order Elements 437
· Set Default Diagram 437
· Open a Package 438
· Feature Visibility 438
· Insert Diagram Properties Note 440
· Manage Legend Elements 441
· Autosize Elements 444
· Swimlanes 450
· Swimlanes Matrix 444
· Using the Image Manager 447
· Show Realized Interfaces for a Class 452
· Label Menu Section 452
· Pan and Zoom a Diagram 453
· Move Diagram Sections 454
· View Last and Next Diagram 455
· Set Diagram Page Size 455
· Scale Image to Page Size 456

© 1998-2010 Sparx Systems Pty Ltd

 422 Modeling Fundamentals | Diagrams

· Lock Diagram 457

· Lay Out a Diagram 467
· Undo Last Action 458
· Redo Last Action 458
· Present Diagrams in a Model Views Slideshow 1228

4.5.6.1 Add New Diagrams

This topic explains how to add a UML diagram, Extended diagram or MDG Technology diagram to a model in
Enterprise Architect.

Note:
In the Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Manage Diagrams 198 permission to create new
diagrams.

To add a new diagram to an existing package or element, follow the steps below:
1. In the Project Browser, select the appropriate package or element under which to place the diagram.
2. Do one of the following:
· In the Project Browser toolbar click on the New Diagram icon
· Right-click to open the context menu and select the Add | Add Diagram or Add | Add <type>
Diagram menu option
· Press [Insert] and select the Add | Add Diagram or Add | Add <type> Diagram menu option, or
· Select the Project | Add Diagram menu option.

The New Diagram dialog displays.

3. The Name field defaults to the name of the selected package or element; if necessary, type a different
name for the new diagram.
4. In the Select From panel, click on the appropriate diagram category 673 for the diagram. The Diagram
Types panel displays a list of the diagram types within the selected category.
5. In the Diagram Types panel, click on the type of diagram to create.
6. Click on the OK button to create your new diagram.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 423

Note:
The diagram type determines the default toolbar associated with the diagram and whether it can be set as a
child of another element in the Project Browser (for example, a Sequence diagram under a Use Case).

4.5.6.2 Diagram Properties

You can set several properties of a diagram using the diagram Properties dialog. Some properties influence
the display and some are logical attributes that appear in the documentation.

Note:
· In the Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Update Diagrams 198 permission to change
diagram properties.
· You can also set the default diagram background color and the element fill color on the Standard Colors
353 page of the Options dialog. You can set color gradients for both diagram background and element fill
color on the Diagram Appearance 356 page of the dialog..

There are several options for opening the diagram Properties dialog for a given diagram:
· Select the Diagram | Properties menu option to open the Properties dialog for the currently active diagram
· Right-click on the required diagram in the Project Browser and select the Properties context menu option
· Right-click on the background of the open diagram and select the Properties context menu option
· Double-click in the background of the open diagram.

In the Diagram Properties dialog you can set properties including name, author and version information, zoom
factor, paper size and layout, diagram notes and various appearance attributes. Once you have made any
necessary changes, click on the OK button to save and exit.
See the following topics:
· General Tab 424
· Diagram Tab 425
· Elements Tab 426

© 1998-2010 Sparx Systems Pty Ltd

 424 Modeling Fundamentals | Diagrams

· Features Tab 427

· Connectors Tab 428

4.5.6.2.1 General Tab

The General tab of the diagram Properties dialog enables you to define characteristics of the overall diagram,
such as its title, version and modification date.

Note:
In the Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Update Diagrams 198 permission to update
diagram properties.

Field Use to

Name Type the name of the diagram (defaults to the name of the parent package).

Author Type or select the name of the person who owns the diagram (defaults to the
name of the person who created the diagram).

Version Type the version number of the diagram (defaults to 1.0).

Stereotype Type or select the name of the stereotype for the diagram. You can define
stereotypes to select here using the Settings | UML menu option, selecting the
Stereotypes 1093 tab and creating stereotypes with a Base Class of Diagram.

Created Automatically display the date the diagram was created.

Modified Type the date and time on which the diagram was last modified (defaults to the
current date and time).

Notes Type any additional notes about the diagram. You can format the notes using the
Notes 642 toolbar at the top of the field.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 425

4.5.6.2.2 Diagram Tab

The Diagram tab of the diagram Properties dialog enables you to define the representation of the diagram.

Field Use to

Use Alias if Available Display the element alias as the name if the alias is specified.

Show Additional Parents Show the name of all parents not in the current diagram for all Classes
and interfaces.

Show Page Border Show a page border to align elements with.

Show Diagram Details Show diagram details in a note in the top left corner of the diagram.
(Deselect to hide the diagram details.)

Show Sequence Notes Show the Sequence Notes on the current diagram.

Show Namespace Show the namespace of each element on the diagram, under the
element; that is, PackageName::ElementName.

Always Open as Element List Always display the diagram contents as an Element List 1255 rather than
as a diagram.

Page Setup See Scale Image to Page Size 456 .

Print Page Header and Page Add page headers and footers to a print-out of the diagram. The headers
Footer and footers are generated from the diagram characteristics, such as the
name of the creator and the date of modification.

RTF Document Options Options 1571 for generating RTF reports for a particular diagram.

Exclude image from RTF Exclude this diagram image from any RTF document generated on the
documents parent package or element.

Document each contained Include documentation on each element in the diagram, in any RTF

© 1998-2010 Sparx Systems Pty Ltd

 426 Modeling Fundamentals | Diagrams

Field Use to

element in RTF document generated on the parent package or element.

See also the Generate RTF Documentation 1571 dialog.

Divide Diagram into Multiple Divide each large diagram into separate pages in the RTF document.
Pages
Note:
This option is only effective when the Scaled Printing option 456 is set to
None on the Print Advanced dialog.

Rotate Images Rotate each diagram image by 90 degrees in the RTF document.

Note:
Only valid for bitmap (.bmp) images.

4.5.6.2.3 Elements Tab

The Elements tab of the diagram Properties dialog enables you to define what components of the elements
should be displayed on the diagram.

Field Use to

Use Stereotype Icons For elements that have whole shapes drawn by Enterprise Architect (such
as Analysis stereotypes 835 ), draw the alternative shape (if defined).
For elements that have an icon displayed in the top right corner, (such as
an Artifact 810 element) if Show Element Stereotypes is selected, display
the stereotype icon instead of the stereotype text.

Show Element Stereotypes For elements that have whole shapes drawn by Enterprise Architect, if Use
Stereotype Icons is deselected, display any stereotype on the element.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 427

Field Use to

For elements that have an icon displayed in the top right corner, indicate
that a stereotype is present (icon if Use Stereotype Icons is selected, text
if not).

Show Table Owner Display the Table Owner. For more information, see the Set Table Owner
1016 topic.

Show Element Property Show the advanced property string for all elements; for example, {leaf}.
String

Show Compartments Enable the following compartments to be shown or hidden for any element
using rectangle notation:
· Attributes
· Operations
· Tags (Tagged Values)
· Requirements
· Constraints
· Testing (Testing Scripts 1549 )
· Maintenance (Maintenance Scripts) 1561

· Package Contents
· Notes.

4.5.6.2.4 Features Tab

The Features tab of the diagram Properties dialog enables you to define how features (attributes and
operations) are displayed on the diagram.

Field Use to

Show Qualifiers and Visibility Show or hide the qualifiers and visibility indicators on the diagram.

© 1998-2010 Sparx Systems Pty Ltd

 428 Modeling Fundamentals | Diagrams

Field Use to

Indicators Qualifiers include such things as the 'derived' symbol (/) and the public
key symbol (PK).
Visibility indicators 1282 include such things as +, -, # and ~, which
indicate the scope of access of the item (such as an attribute, operation
or role).

Show Stereotypes Show the stereotypes on all features.

Show Property String Show the advanced property string for all element features, for example,
{readOnly}.

Show Operation Return Type Display the return data type of operations.

Suppress Brackets for Suppress brackets on operations that have no parameters; that is, Opn;
Operations Without Parameters rather than Opn();.

Visible Class Members Hide Class members according to their scope and methods that specify
properties. See the Visible Class Members 429 topic.

Show Attribute Detail Select whether to show both the attribute name and type or the attribute
name only.

Show Parameter Detail Control the display of method parameters. See the Visible Class
Members 429 topic.

4.5.6.2.5 Connectors Tab

The Connectors tab of the diagram Properties dialog enables you to define the appearance of the connectors
on the diagram.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 429

Field Use to

Show Relationships Show relationships in the current diagram.

Show Collaboration Numbers Show numbering in Communication diagrams.

Show Non-Navigable Ends Indicate when an Association end is not navigable; a cross is presented
at the Association connector.

Show Connector Property Show the property string for connectors.

String

Suppress All Connector Hide all connector labels.

Labels

Connector Notation Display the required connector notation:

· UML 2.1 - use the standard UML 2.1 notation for connectors
· Information Engineering - use the Information Engineering (IE)
connection style; for more information see the http://www.agiledata.
org/essays/dataModeling101 page
· IDEFX1 - use the Integrated Definition Methods IDEFX1 connection
style; for more information see the http://www.idef.com/IDEF1X.html
page.

4.5.6.2.6 Visible Class Members

On the Features tab of the diagram Properties dialog, the Visible Class Members panel enables you to hide
Class members by their scope and methods that specify properties. Use the checkboxes to define the visibility
of Class members.

Show Parameter Detail

The Show Parameter Detail field enables you to control the display of method parameters with the following
options:

Option Effect

None No details shown.

Type Only Shows the type of parameter only.

Full Details Shows all of the details for parameters.

Name Only Shows the name of the parameter only.

© 1998-2010 Sparx Systems Pty Ltd

 430 Modeling Fundamentals | Diagrams

4.5.6.3 Paste from Project Browser

As well as creating new elements in a diagram, you can drag existing elements from the Project Browser into
the current diagram.
When you drag an existing element into the diagram, the Paste Element dialog displays to prompt you to
select the type of paste action to carry out. (If the dialog does not display, press and hold [Ctrl] while dragging
the element onto the diagram.)

Three paste options are available:

1. Paste the element as a simple link. In this case the original element exists both in the current diagram
and in the original source diagram. Changes to the element are reflected in all diagrams in which it is
shown.
2. Paste as an instance 519 of the element. If the element can have instances such as an Object,
Sequence instance or Node instance, you can drop the element in as an instance of the source
element, with the classifier pre-set to the original source. This is useful when creating multiple instances
of a Class in a Sequence diagram or Communication diagram.

If you select this option, the Copy connectors checkbox is enabled. If you select this checkbox, any
connectors between the original element and any other elements that have also been pasted to this
diagram are reproduced as connectors between the instances.
3. Create as a child of the source element. This automatically creates a new Class - which you are
prompted to name - with a Generalization connector back to the source. This is very useful when you
have a Class library or framework from which you inherit new forms; for example, you can paste a
Hashtable as "MyHashtable" which automatically becomes a child of the original Hashtable. Used with
the Override parent operations 578 feature, this is a quick way to create new structures based on
frameworks such as the Java SDK and the .NET SDK.
You can make your selection on this dialog the default for:
· all drag and drop operations, or
· only those where you display this Paste Element dialog.
If you select the This Dialog checkbox, you should then select the Only show this dialog when [Ctrl]
+Mouse drag is used checkbox and, on the Diagram Behavior 359 page of the Options dialog, the Auto
Instance checkbox.
The effect of these selections is to give you two default paste options:
· Just drag the element onto the diagram and automatically create an instance
· Press [Ctrl] while you drag the element from the Project Browser, displaying the Paste Element dialog, and
click on the OK button to automatically paste the element according to whatever option you last selected
from the dialog.
If you select the All Drag and Drop checkbox on the Paste Element dialog, this deselects the Auto Instance
checkbox on the Options dialog and enables you to add existing elements to the diagram according to the
paste option you selected, without pressing [Ctrl] and without displaying a dialog. (If you want to change the
default paste option, press [Ctrl] as you drag to display the dialog again and make your changes.)

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 431

See Also
· Connect Requirements 921
· Create Object From Attribute 568
· Make Linked Element A Local Copy 544

4.5.6.3.1 Paste Multiple Items

You can paste multiple elements from the Project Browser into the current diagram.
To select multiple elements, click on the selected items from the Project Browser while pressing and holding:
· [Ctrl] to add single items to the selection of multiple elements, or
· [Shift] to select all the elements between the first and last selected items in the Project Browser.

You can then drag the selected elements from the Project Browser onto the current diagram, pressing and
holding [Ctrl]; for each element you have selected, the Paste Element dialog displays, prompting you to select
the type of paste action 430 to carry out.

4.5.6.3.2 Paste Composite Elements

When you drag a Composite element from the Project Browser onto the current diagram, Enterprise Architect
prompts you to select the type of paste action to carry out with the Composite element.
(If the dialog does not display, press and hold [Ctrl] while dragging the element onto the diagram.)

© 1998-2010 Sparx Systems Pty Ltd

 432 Modeling Fundamentals | Diagrams

Two advanced options are available for pasting Composite elements; these require the include Embedded
Elements checkbox to be selected:

1. The All Embedded Elements option, which pastes all of the Composite element's embedded elements.
2. The Based on instance option, which pastes only the elements contained in a specific instance of the
Composite element, maintaining the layout of the embedded elements.
Click on the drop-down arrow and select the appropriate instance.
For details of the other options on this dialog, see the Paste from Project Browser 430 topic.

4.5.6.3.3 Paste Activities

You can paste an Activity 753 from the Project Browser into the current diagram.
When you drag an Activity from the Project Browser onto the current diagram, The Paste Element dialog
displays, prompting you to select the type of paste action to carry out. (If the dialog does not display, press
and hold [Ctrl] while dragging the element onto the diagram.)

Two options are available:

· Paste the Activity as a link: in this case the Activity appears in the current diagram as a simple reference to
the original source Activity. Changes to the Activity in the diagram affect all other links to this Activity.
· Paste as an invocation of the Activity; if you select this option, the Copy connectors checkbox is enabled.
Enterprise Architect User Guide
 Modeling Fundamentals | Diagrams 433

If you select this checkbox, any connectors between the original Activity and any other elements that have
also been pasted to this diagram are reproduced as connectors between the instances.
For details of the other options on this dialog, see the Paste from Project Browser 430 topic.

4.5.6.4 Copy And Paste Diagram Element

To copy a diagram element, follow the steps below:
1. Select the element(s) to copy.
2. For multiple elements, right-click to open the context menu and select the Copy menu option.
Alternatively, press [Ctrl]+[C].
3. For single elements, select the Edit | Copy menu option or alternatively press [Ctrl]+[C].

Paste Diagram Elements

To paste diagram elements, follow the steps below:
1. Open the diagram to paste into.
2. Right-click on the diagram background to open the diagram context menu.
3. Select either the Paste Object(s) as New menu option (completely new element) or the Paste Object
(s) as Link menu option (reference to the existing element).

Note:
The Date Created and Time Created parameters of a pasted-as-new element are set to the current date and
time; the parameters for a linked element remain the same as the copied element.

4.5.6.5 Place Related Elements on Diagram

To find and place related elements on the current diagram, use the Relationships window (View | Other
Element Tools | Relationships).

Right-click on any connector in the list to open the context menu.

© 1998-2010 Sparx Systems Pty Ltd

 434 Modeling Fundamentals | Diagrams

If an element is not present in the current diagram, the context menu contains the Place Target Element in
Diagram option. This is useful when you are building up a picture of what an element interacts with, especially
when reverse engineering an existing code base.
Select the Place Target Element in Diagram option. Move the cursor to the required position in the diagram
and click to place the element. Alternatively, press [Esc] to cancel the action.

4.5.6.6 Delete Diagram

Warning:
In Enterprise Architect there is no Undo feature for deleting diagrams, so be certain that you want to delete a
diagram before you do so.

Notes:
· When you delete a diagram, you do not delete the elements in the diagram from the model.
· In the Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Manage Diagrams 198 permission to create new
diagrams.

To delete a diagram from your model, follow the steps below:

1. In the Project Browser, right-click on the diagram to delete. The context menu displays.
2. Select the Delete '<diagram name>' menu option. A confirmation prompt displays.
3. Click on the OK button to confirm the delete.
You can also delete multiple diagrams from the Project Browser, by holding [Ctrl] or [Shift] while you select
them, then right-clicking on one of them and selecting the Delete selected items context menu option.

4.5.6.7 Rename Diagram

To rename a diagram, follow the steps below:
1. Open the Diagram Properties dialog by double-clicking on the diagram background, or by selecting the
Diagram | Properties menu option.
2. In the Name field on the General tab, type the new name for your diagram.
3. Click on the OK button to save changes.

4.5.6.8 Change Diagram Type

If necessary, you can change one type of diagram to another type.
This is useful if you have either made a mistake in selecting the diagram type to begin with, or if the purpose
and nature of a diagram changes during analysis.

Note:
Some diagram types do not transfer to others; for example you cannot change a Class diagram into a
Sequence diagram.

To change a diagram type, follow the steps below:

1. Open the diagram to change.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 435

2. Select the Diagram | Change Type menu option. The Change Diagram Type dialog displays.

3. Select the required diagram type.

4. Click on the OK button to save changes.

4.5.6.9 Diagram Navigation Hotkeys

The diagram hotkeys enable you to quickly navigate to and select elements within a diagram.
The following table details the key combinations and their functionality.

Hotkey Command Use To

[Shift]+[Arrow], Element(s)
Move the selected element(s) by increments.
selected

[Arrow], No element selected Scroll around the diagram.

[Esc] Clear the current selection.

[Tab] Select the first element in the diagram if none currently selected.

[Shift]+click Add the clicked element to the current selection.

[Ctrl]+click Add the clicked element to the current selection.

[Ctrl]+[Shift]+drag Pan the diagram.

[Alt]+[G] Select the item in the Project Browser and give it focus.

4.5.6.10 Copy Image to Disk

You can copy a diagram image to a disk file in the following formats:
· Windows bitmap (256 color bitmap)
· GIF image
· Windows Enhanced Metafile (standard metafile)
· Windows Placeable Metafile (older style metafile)

© 1998-2010 Sparx Systems Pty Ltd

 436 Modeling Fundamentals | Diagrams

· PNG format
· JPG
· TGA.
To copy a diagram image to file, follow the steps below:
1. Open the diagram to save.
2. Select the Diagram | Save Image menu option, or press [Ctrl]+[T].
3. When prompted, enter a name for the file and select an image format.
4. Click on the OK button.

Note:
Enterprise Architect clips the image size to the smallest bounding rectangle that encompasses all
diagram elements.

4.5.6.11 Copy Image to Clipboard

You can copy diagram images onto the MS Windows clipboard and paste them directly into MS Word or other
applications.
To copy an image to the clipboard, follow the steps below:
1. Open the diagram to copy.
2. Select the Diagram | Copy Image menu option, or press [Ctrl]+[B].
3. Click on the OK button.
The diagram has been copied to the clipboard and can now be pasted into compatible applications or into
another diagram. You can set the clipboard format on the Options 351 dialog (Tools | Options menu option,
General page). Enterprise Architect supports bitmap or metafile format.

4.5.6.12 Copy (Duplicate) Diagram

Enterprise Architect makes it easy to duplicate a complete diagram, either with:
· Links back to the original diagram elements (shallow mode), or
· Complete copies of all elements in the diagram (deep mode).

Note:
In the Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Manage Diagrams 198 permission to copy
diagrams.

When you copy a diagram in shallow mode, the elements in the new diagram are linked to the originals, so if
you change the properties of one, the other reflects those changes. If you copy the diagram in deep mode,
then all elements are duplicated completely, so that changing an element on one does not affect the other.
Element position and size should be independent in both copy modes.
You can also paste a copied diagram as a child of a composite 837 element.

Procedure
To duplicate a diagram, follow the steps below:
1. In the Project Browser, select the diagram to copy.
2. Right-click to display the context menu and select the Copy Diagram menu option.
3. Navigate to the package to host the new diagram, and right-click to open the context menu.
4. Select the Paste Diagram menu option. The Copy Diagram dialog displays.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 437

5. In the Name field, type the name for the new diagram.
6. In the Type of copy panel, click on the radio button for the type of copy you require; either linked
elements (shallow copy) or complete copies of the originals (deep copy).
7. Click on the OK button.
Enterprise Architect automatically creates the new diagram, links or creates new elements and arranges them
as in the original diagram. All links are also copied between diagram elements where appropriate.

4.5.6.13 Z Order Elements

Z Order refers to an element's depth in the diagram perspective, and thus influences which elements appear
in front of others and which appear behind.
To set the Z Order of an element, follow the steps below:
1. Right-click on the element in the Diagram View.
2. Select the Z order menu option. The following submenu displays:

3. Select the operation to perform. The element is moved to the new position in the diagram perspective.

4.5.6.14 Set the Default Diagram

A project might have a default diagram. If set, this diagram loads when Enterprise Architect first opens the
model.
It is often convenient to place hyperlinks to other diagrams and resources on the default diagram, thus
creating a Home Page for your model.
To set the currently active diagram as the model default, select the Diagram | Make Model Default 65 menu
option. (Also use this option to cancel the default setting.)

Tip:
Once you have specified a default diagram, the Home icon on the Diagram toolbar takes you back to that
diagram from your current location in the model.

© 1998-2010 Sparx Systems Pty Ltd

 438 Modeling Fundamentals | Diagrams

4.5.6.15 Open Package From Diagram

To open a package from within a diagram follow the steps below:
1. Open a diagram that shows the package to open.
2. Right-click on the package element to open the context menu.
3. Select the Open Package option. Alternatively, press [Ctrl]+[K].

Note:
Enterprise Architect finds the package default diagram and opens it for you. This is the first available diagram
in the package, selected in alphabetical order; for example, a diagram called Alpha in a child package or
element several levels down opens before a diagram called Beta immediately under the selected package.

4.5.6.16 Feature Visibility

Enterprise Architect enables you to set the visibility of attributes and operations - where shown - for selected
elements on a specific diagram only.
You can hide or show attributes and operations by scope, or you can hide attributes and operations
individually. The visibility you set applies only to the current diagram, so a Class can appear in one diagram
with all features displayed, and in another with features hidden. For example, you can hide all protected
attributes, all private operations or any other combination of attributes and operations.
It is possible to show inherited attributes, operations, requirements, constraints and Tagged Values for
elements that support those features. When Enterprise Architect displays inherited features, it creates a
merged list from all generalized parents and from all realized interfaces. If a child Class redefines something
found in a parent, the parent feature is omitted from the Merge List.

Tip:
To show features for element types that do not have visible compartments, such as Use Cases and Actors,
right-click on the diagram object to display the context menu and select the Advanced Settings | Use
Rectangle Notation option.

Customize Feature Visibility

To customize feature visibility, follow the steps below:
1. Either:
· Click on the element in the diagram and either click on the Element | Feature Visibility menu option
or press [Ctrl]+[Shift]+[Y], or
· Right-click on the element in the diagram to display the context menu and click on the Feature
Visibility option.
The Feature Visibility dialog displays.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 439

2. To filter display of attributes or operations by scope, select the checkbox against each scope that
should be visible and clear the checkbox against each scope that should not.

Note:
The Show checkbox, if selected, overrides these selections to display all attributes or operations in the
element, except those specifically deselected in the Show Features in Diagram 440 dialog (below).

3. In the Show Element Compartments panel, select the compartments to display for the element on the
diagram.

The Fully Qualified Tags checkbox enables you to display the full provenance of a Tagged Value,
where the same Tagged Value can be used several times in different contexts with different values. The
description in the Tagged Value compartment reads:

<Profile>::<Stereotype>::<Tagged Value name>=<Value> for example: BPMN::Activity::Activity

Type = Task.

(Only for Tagged Values created in Enterprise Architect release 7.1 or later.)

If you select the Notes checkbox, the Notes compartment on the element in the diagram displays the
text that has been typed into the Notes field of the Element Properties dialog. This checkbox also
enables the maximum chars field, which defaults to 1000 as the number of characters of notes text
displayed. Overtype this value to display less text or more text.

The change only applies to the selected elements on the diagram, so you can display full notes for a
selected element whilst the other elements on the diagram have no notes text.

Note:
If you have selected the Notes checkbox, you can select the Render Formatted Notes checkbox to
display the text on the diagram, formatted using the Notes 642 toolbar.

4. In the When Resizing Elements panel, select the appropriate option for resizing the Class, object or
table to prevent very wide diagram objects.

© 1998-2010 Sparx Systems Pty Ltd

 440 Modeling Fundamentals | Diagrams

The selected option defaults to Resize to longest Feature, so that the minimum width for a diagram
object is determined by its longest displayed attribute, method or other compartment value. If
necessary, you can change the option to Wrap Features (so that any longer features are wrapped onto
multiple lines) or Truncate Features (so that longer features are not displayed in full).
5. If required, in the Inherited Features panel, select one or both checkboxes to set whether Enterprise
Architect should display inherited features as well as directly owned ones.
6. Click on the OK button to save changes. Enterprise Architect redraws the diagram with the appropriate
level of feature visibility.

Suppress or Show Specific Features

The Custom button in the Attribute Visibility and Operation Visibility panels enables you to show or hide
specific operations and attributes. If you select the Show checkbox, the Custom button displays the Show
Features in Diagram dialog; if you deselect the checkbox, the button displays the Suppress Features in
Diagram dialog.

The two dialogs are identical, but in the first you select the checkboxes of specific features to show, and in the
second you select the checkboxes of specific features to hide.
You can also use the Filter by Scope button in this dialog to, for example, list only operations that are
Protected and select, say, two of them to hide, so that on the diagram the element displays all but two of the
Protected operations and all operations of other scopes.

4.5.6.17 Insert Diagram Properties Note

Properties of a diagram can be displayed on screen within a custom text box.

You can move this text box around and change its appearance 538 . You cannot change what the text box

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 441

says.
To create the note, drag the Diagram Notes element from the Common page of the Toolbox onto the diagram.
Alternatively, select the Diagram | Property Note menu option, or click on the Diagram Properties Note
button on the UML Elements toolbar and click on the diagram.

Note:
This is not the same as the diagram details note, which displays in the top left corner of the diagram if the
Show Diagram Details checkbox is selected on the Diagram Properties 425 dialog. You cannot move the
diagram details, nor change the appearance. To hide the diagram details, deselect the checkbox.

4.5.6.18 Create Legends

A Legend shape identifies colors and styles you have used to group other elements on the diagram.
You can use the Legend to assist in distinguishing different elements, connectors or systems on the diagram.
For example, the Legend could show that all elements concerned with the management system are shaded in
blue, and all outcomes connectors are shown in red. The Legend displays as a key to the diagram, with the
filled shape styles first and the lines and connector styles underneath.

You add a Legend to the diagram, then edit it to add Legend elements, which define the colors and styles
used in the diagram.

Add a Legend
To add a Legend to a diagram, drag the Diagram Legend element from the Common page of the Toolbox
onto the diagram (or click on the New Diagram Legend icon ( ) on the UML Elements toolbar, and click
on the diagram).
The Legend dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 442 Modeling Fundamentals | Diagrams

Click on the OK button. The Legend displays on the diagram as a simple rectangle.

Edit a Legend
To edit the Legend follow the steps below:
1. Either:
· Double-click on the Legend, or
· Right-click on the Legend and select the Properties context menu option.
The Legend dialog displays.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 443

Note:
The Legend dialog enables you to add, delete, modify or re-sequence Legend elements. Use the Fill
tab to define the Legend elements for shapes, then click on the Line tab to define Legend elements for
lines and connectors.

2. In the Name field, type the name of the Legend element; for example, Management System or Help.
3. Use the drop-down arrows to select the fill color, line color and line thickness for the Legend element.
4. Click on the Save button to save the Legend element. The element displays in the Fill or Line tab, as
appropriate.
5. Click on the New button to add another Legend element.

Style Options
Click on the Style Options button [ ... ] to display the Style Options dialog, on which you can modify a Legend
title, font size, background color and border color. If you choose default options for the colors, the Legend
automatically assumes colors based on the diagram background color.

Click on the OK button on the Style Options dialog and again on the Legend dialog. The Legend displays on

© 1998-2010 Sparx Systems Pty Ltd

 444 Modeling Fundamentals | Diagrams

the diagram.

4.5.6.19 Autosize Elements

You can autosize an element or group of elements in a diagram to the default size for the element type.
As an example, the default size for a Class is 90 x 70 pixels at 100% zoom. However, if the element contains
more information than the default size can show (such as a long name, long attributes or additional
compartments) the autosize option resizes the element to the minimum size for revealing the information.
The size change effectively operates around the mid point of each element, so the layout and size of the
diagram do not change. To automatically change the layout of a diagram, see the Lay Out a Diagram
Automatically 471 topic.
To autosize elements, follow the steps below:
1. Select the elements to resize (press [Ctrl]+[A] to select all).
2. Either:
· Right-click on any of the elements and, on the context menu, select the Autosize menu option, or
· Press [Alt]+[Z].

Notes:
· Not all elements resize: elements such as Events remain the same; Timing and Sequence diagrams
(where position is crucial) are unchanged; and elements added from a profile or Shape Script maintain any
size definitions imposed by the profile.
· With an element image created with a Shape Script that contains a defSize command 1154 , Autosize
returns the element to the defSize value and not the element default size.

4.5.6.20 Swimlanes Matrix

Enterprise Architect diagrams support a Swimlanes Matrix for all diagram types, based on the Zachman
Framework.

The Swimlanes Matrix divides the diagram into cells of vertical columns and horizontal rows. The cell in the top
left corner of the Swimlanes Matrix contains the heading of the matrix. The first cell at the top of each column
contains the column title text. The first cell at the left of each row contains the row title text.

Set up Swimlanes Matrix

To set up and manage the Swimlanes Matrix, select the Diagram | Swimlanes and Matrix menu option to
display the Swimlanes and Matrix dialog. Click on the Matrix tab.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 445

Activate the Matrix

To activate the Swimlanes Matrix, select the Active check box.

At the same time, you can define the line width for all lines on the matrix; in the Line Widths field, click on the
drop-down arrow and select the appropriate width.

Create the Heading of the Swimlanes Matrix

To define the heading for the matrix, follow the steps below.
1. Click on the New button.
2. In the Type field in the Details of New Column panel, click on the drop-down arrow and select Heading.
3. In one or more of the Title fields, type the heading name. You can enter up to three text strings as
heading text.
4. If necessary, click on the Color, Font and Back options and select the heading text font, color and
background color.
5. Click on the Save button in the Operations panel. The Heading cell displays on the diagram.

Note:
The heading is the first item in the list; you create only one heading.

Create Columns and Rows:

To define the column and row headings for the matrix, follow the steps below.
1. Click on the New button.
2. In the Type field, in the Details of New Column panel, click on the drop-down arrow and select either
Column or Row as appropriate.
3. In one or more of the Title fields, type the column or row name. You can enter up to three text strings as
title text.
4. If necessary, click on the Color, Font and Back options and select the title text font, color and
background color.
5. Click on the Save button in the Operations panel. The column or row heading cell and column or row

© 1998-2010 Sparx Systems Pty Ltd

 446 Modeling Fundamentals | Diagrams

lines display on the diagram.

Note:
When you define columns and rows, you define the header or title cells. The properties of these cells
do not reflect on the matrix cells themselves. For example, the intersection cell of a column and row
has a transparent background and therefore takes the color and shading effect of the diagram
background.

Lock the Matrix

To lock the matrix so that it cannot be edited on the diagram, on the Swimlanes and Matrix dialog select the
Lock checkbox.

Edit items in the list:

As you create the heading, column and row title cells, they are added to the list in the bottom of the dialog. To
edit an item, follow the steps below.
1. Click on the required item in the list.
2. Make the relevant changes in the Edit Selected ... panel.
3. Click on the Save button in the Operations panel.

Delete items from the list:

To delete the heading or a column or row from the matrix, follow the steps below.
1. Click on an item in the list.
2. Click on the Delete button in the Operations panel.

Model Profiles:
After creating a Swimlane Matrix, you can save it into a Model Profile and apply it to other diagrams. Model
Profiles are available on any diagram in your model.

Save a Model Profile:

To save a Model Profile, follow the steps below.
1. In the Model Profiles panel, click on the Save button. The Save Model Profile dialog displays.
2. In the Name field, type the name of your profile.
3. Click on the OK button.
The profile is now visible in the profile name drop-down list here and on other diagrams.

Note:
You can also transport all the matrix profiles between models (as Diagram Matrix Profiles), using the Export
Reference Data 223 and Import Reference Data 225 options on the Tools menu.

Apply a Model Profile:

Note:
By applying a Model Profile, you replace the current profile. Save the current profile to avoid losing it.

To apply a Model Profile to a diagram, follow the steps below.

1. In the Model Profiles panel, click on the drop-down arrow of the profile name field, and select the
required profile from the list.
The list contains a predefined Zachman profile, as well as an empty profile should you want to replace
the current profile with one that you create on the spot.
2. A confirmatory prompt displays. Click on the OK button to display the profile details on the Swimlanes
and Matrix dialog.
3. Click on the OK button at the bottom of the Swimlanes and Matrix dialog to apply the profile to the
matrix on the diagram.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 447

Size the Matrix

To size the rows and columns, drag the row and column borders on the diagram.
Elements placed inside each cell are shifted when sizing. To prevent the elements shifting, press and hold
[Ctrl] while sizing.

See Also
· Swimlanes 450

4.5.6.21 Using the Image Manager

The Image Manager dialog enables you to insert alternative images in diagrams, rather than inserting
standard UML elements. For example, you might want to place a custom background image 448 on a diagram,
or display a custom image such as a Router or PC on a UML element.

Notes:
· For elements with lifelines, such as those used on Sequence diagrams, the Lifeline must remain intact to
enable messages to be created between the elements. Therefore such elements cannot have alternative
images.
· In the Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Configure Images 198 permission to configure
alternative element images.

To display the Image Manager dialog, either:

· Right-click on the element within the diagram and, from the context menu, select the Appearance | Select
Alternate Image option, or
· Select the element in the diagram and press [Ctrl]+[Shift]+[W].

To locate and display an image, click on individual image filenames, or press [#] and [$] to scroll through the
list of images. As you highlight each image filename, the Preview panel changes to reflect the image. Double-
click on the required image filename to display the image in full size.

© 1998-2010 Sparx Systems Pty Ltd

 448 Modeling Fundamentals | Diagrams

On the Image Manager dialog, the following buttons are available:

Option & Function Use to

Keys

View [Alt]+[V] Display the selected image in full size.

Add New [Alt]+[A] Browse appropriate directories to search for and import new images.
You can import images in .BMP, .PNG, .EMF, .WMF, .TGA, .PCX or .JPG format.
Internally, Enterprise Architect stores the images in .PNG or metafile format to
conserve space.
Update Selected [Alt] Refresh the selected image; for example, after it has been modified.
+[U]
Delete [Alt]+[D] Delete the selected image.
A message displays to indicate how many elements use the image. Click on the
Continue button to delete information about the image from those elements, which
then revert to their previous appearance.
Close Close the Image Manager dialog.
OK [Alt]+[O] Confirm selection of the alternative image for the element selected in the diagram.

Notes:
· If you are creating many elements of the same type that have a particular image, you should use a custom
stereotype 895 with an associated metafile.
· You can transport image files between models, using the Export Reference Data 223 and Import
Reference Data 225 options on the Tools menu.

4.5.6.21.1 Create Custom Diagram Background

Enterprise Architect diagrams have a single-color 'wash' background that you can set to a solid color or a fade
gradient down the screen.
You set the color on the Standard Colors 353 page of the Options dialog, and whether to have a fade gradient
on the Diagram Appearance 356 page. Alternatively, using the Image Manager dialog, you can create a non-
tiled background for diagrams.
To set a background using the Image Manager, follow the steps below:
1. Create a Boundary object 802 from the Use Case Elements page of the Toolbox 399 . Do not use the
Boundary element from any other section of the Toolbox.
2. Stretch the Boundary to a size that can contain all of the elements you intend to place on the diagram,
and drag it to the edges of the diagram workspace.
3. Right-click on the Boundary element. The context menu displays.
4. Select the Z-Order | Send to Bottom menu option. This ensures that the Boundary is not displayed in
front of any other element in the diagram.
5. Either:
· Press [Ctrl]+[Shift]+[W], or
· Right-click on the Boundary to display the context menu, and select the Appearance | Alternate
Image menu option.
6. On the Image Manager 447 dialog, select an appropriate image as the diagram background and ensure
that the image size is large enough to span the required size of the diagram background.
7. When you have selected the required image, click on the OK button.
Alternatively, you can copy an image from another source onto the Windows clipboard, right-click on the
Boundary element in the Enterprise Architect diagram, and select the Appearance | Apply Image From
Clipboard context menu option.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 449

4.5.6.21.2 Import Image Library

The Image Library enables you to create attractive diagrams with custom images.
A bundled clip art collection of UML-based images is available as an Imported Image Library, from www.
sparxsystems.com/resources/image_library.html. Image libraries enable you to import a collection of images
into the Image Manager in one process.

Note:
Images contained within the Image Library are copyright of Sparx Systems, are only available for use in
conjunction with Enterprise Architect, and are supplied on the understanding that they are not used under any
other circumstance.

Import an Image Library

To import an Image Library you must have a suitable Image Library file. To import the Image Library, follow the
steps below:
1. Download the Image Library from www.sparxsystems.com/resources/image_library.html.
2. Select the Tools | Import Reference Data menu option. The Import Reference Data dialog displays.
3. Locate the XML Image Library file to import using the Select File button. The file name is ImageLibrary.
xml in the directory in which you saved the file.
4. Select the data set containing the Image Library. Then click on the Import button.

Use the Image Library

To use the images contained within the Image Library, follow the steps below:
1. Create a diagram to associate with the images contained in the Image Library.
2. Select the element to change from the default appearance to one of the images contained within the
library.
3. Press [Ctrl]+[Shift]+[W], or right-click on the selected element to display its context menu and then
select the Appearance | Select Alternate Image option.
4. On the Image Manager dialog, in the Name field highlight the appropriate image name and then click on
the OK button.

© 1998-2010 Sparx Systems Pty Ltd

 450 Modeling Fundamentals | Diagrams

4.5.6.21.3 Swimlanes
Enterprise Architect diagrams support Swimlanes for all diagram types.
Swimlanes are vertical or horizontal bands in a diagram that divide the diagram into logical areas or partitions.
In the example below the activities relating to particular entities within the model (such as the User, or the back
end Repository) are placed within a containing swim lane to indicate their association.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 451

To manage swimlanes, select the Diagram | Swimlanes and Matrix menu option to display the Swimlanes
and Matrix dialog. The dialog defaults to the Swimlanes tab.

This dialog enables you to set the orientation (vertical or horizontal), line color and width of the swimlanes, and

© 1998-2010 Sparx Systems Pty Ltd

 452 Modeling Fundamentals | Diagrams

lock the swimlanes to prevent further movement. You can also specify the font color and bold font, hide
names, hide the classifier and show the name in the title bar. Use the New, Modify and Delete buttons to

change aspects of the selected swimlane. Use the and (up and down) buttons to change the order
of swimlanes within the diagram.
If you set a background color for a swimlane, it takes on the same shading profile as the main diagram
background.

See Also
· Swimlanes Matrix 444

4.5.6.22 Show Realized Interfaces of Class

You can display each interface directly realized by a Class as a 'lollipop' style interface node, which protrudes
from the left-hand side of the Class.
Connectors can be directly attached to the node, indicating usage of the interface part of the Class or
component. See the example below:

In this example, Class2 realizes Interface1 and Interface2 as represented by the interface nodes protruding
from the Class. Class1 is dependent on these two interfaces, which is shown by the Dependency connectors
linking to the nodes.
To show nodes for the interfaces a Class realizes, as in the above diagram, right-click on the Class and select
the Embedded Elements | Show Realized Interfaces context menu option. This setting applies only to the
selected Class, and can be changed at any time.

4.5.6.23 Label Menu Section

You can add labels to both connectors and elements, using the element or connector context menu as follows:
· Element:
· Select the Embedded Elements 552 menu option and either the Add <element> option or the
Embedded Elements option; the label is the embedded element name
· Apply an alternative image 447 to an element (that might also have a run state 824 ; the run state,
attributes and operations of the element are then displayed as a label of the element.
· Connector - Select the Properties 626 option and define the connector name, stereotype, constraints and/
or source and target roles.
Once you have these labels, you can edit and format them using the Labels context menu.

To display the Labels context menu, right-click on a label.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 453

Note:
As labels can be concentrated on and around the element or connector, make sure that you click on a
section of the required label that is clear of any other label or structure.

Element Labels
The Labels menu associated with embedded elements provides the following options:

Menu Option Use to

Set Label Color Specify a color for the label.

Hide Label Hide the label; to unhide the label, right-click on the element and select the
Appearance | Show labels 555 context menu option.

Bold Set the label font to bold.

Text Alignment Align the text within the label text area. The options available from the submenu
enable you to specify left, center and right alignment.

Label Rotation Orient the label in the horizontal or vertical planes, with the vertical plane offering the
option of clockwise or anti-clockwise position.

Default Position Move the label to the initial default location.

Default Color Set the label color to the default color.

Connector Labels
The Labels menu associated with connectors provides the following options:

Menu Option Use to

Set Label Color Specify a color for the label.

Hide Label Hide the label; to unhide the label use the Visibility | Set Label Visibility 622 option
on the connector context menu.

Bold Set the label font to bold.

Text Alignment Align the text within the label text area. The options available from the submenu
enable you to specify left, center and right alignment.

Label Rotation Orientate the label horizontally or vertically and, if vertically, in a clockwise or anti-
clockwise position.

Direction Set a small arrow at the end of the label pointing to either the label source or the
destination dependent upon selection from the available options.

This is part of the label, so if there is no label there is no direction indicator.

Default Position Move the label to the default location.

Default Color Set the label color to the initial default color.

4.5.6.24 Pan and Zoom a Diagram

Pan
Pan the Diagram View in the following ways:
· Use [!], ["], [#], [$], [Page Up], [Page Down], [Home] and [End] when the Diagram View is selected

© 1998-2010 Sparx Systems Pty Ltd

 454 Modeling Fundamentals | Diagrams

· Use the scrollbars

· Use the middle mouse button
· Use the Pan & Zoom 1275 window.

Zoom
Zoom into and out from a diagram using the zoom buttons on the diagram toolbar, or using the Diagram |
Zoom submenu.

Change the zoom level by 10% by clicking on either the Zoom In (+) or Zoom Out (-) buttons. Alternatively,
select the Zoom In or Zoom Out options from the Diagram | Zoom submenu.

There are three ways to return the diagram to 100%:

· Click on the button

· Select Zoom to 100% from the Diagram | Zoom submenu
· [Ctrl]+middle-click the mouse.

Tip:
You can zoom in and out of the main window dynamically by holding [Ctrl] and rolling the mouse wheel.

Note:
· Changes in diagram magnification through the zoom options can be saved as permanent changes to the
diagram.
· At high levels of zoom, element features cease to display. This is because of the difficulty the Windows
font mapper has in choosing a font for extreme conditions, and the result can look odd.

4.5.6.25 Move Elements In Diagram Sections

As you build up a diagram, you might find that you need to move part of the diagram up, down or to one side.
You can move a section of a diagram in one of two ways:
· Hold the left mouse button down and drag over a group of elements to move (creating an outline around
the elements), then click on an element in the outline and move the group as required
· Press [Alt] and click on the diagram, then drag the cursor to move everything beyond the cursor in the
direction of the movement.
The first method enables you to reposition groups of elements within the larger diagram. The second method
enables you to create space within the diagram without pushing some elements into others, as might happen
if you cannot see the whole diagram on one screen.
When you press [Alt] and click on the diagram, as you move the cursor a line displays on the diagram just
behind the cursor. If you are moving the cursor left, everything to the left of the line moves with the cursor. If
you move the cursor up, everything above the line moves up.
However, if you move the cursor diagonally, two lines display to create a quadrant, and everything within the
quadrant moves. For example, if you move the cursor left and down, everything below and left of the cursor
moves.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 455

Fine Movement
To adjust (or 'nudge') the position of a single element or a selected group of elements, press [Shift]+["], [!],
[#] or [$].

4.5.6.26 View Last and Next Diagram

Enterprise Architect enables you to step backwards and forwards through the currently-open diagrams,
including the Start Page.

To view the previous or next diagram use the Previous or Next buttons on the Diagram toolbar.

Use the Home button to display the default project diagram 437 (if one has been specified).

4.5.6.27 Set Diagram Page Size

You can change the size of the diagram area (or scrollable/printable area) using the Diagram Properties
dialog.

Note:
In the Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Update Diagrams 198 permission to change
diagram page setup.

To set the page size, follow the steps below:

1. Load a diagram.
2. Double-click on the background to open the Diagram Properties dialog.
3. Click on the Diagram tab and, in the Appearance panel ensure that the Show Page Border checkbox is
selected.
4. On the Page Setup panel, click on the Advanced button. The Print Advanced dialog displays.
5. Click on the Page Setup button. The Page Setup dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 456 Modeling Fundamentals | Diagrams

Note:
As you adjust the settings on this dialog, the page icon at the top illustrates the effects of your
changes.

6. In the Size field, click on the drop-down arrow and select an appropriate page size.
7. In the Orientation panel click on the radio button for the orientation of the page to print.
8. In the Margins panel, type the required left, right, top and bottom page margins for the diagram, in
inches.
9. Click on the OK button on the Page Setup dialog, the Print Advanced dialog, and the Diagram
Properties dialog.
The area within the page boundary lines on your diagram is expanded or reduced accordingly. When you print
or print preview, the output is cropped to these boundary lines and the diagram divided between the necessary
number of pages.

Setting the Default Paper Size for New Diagrams

You can set the default paper size for new diagrams on the Diagram page of the Options dialog (select the
Tools | Options | Diagram menu option). Once the paper size is set there, all new diagrams have that as the
default size.
See the Configure Local Options - Diagram 355 topic.

4.5.6.28 Scale Image to Page Size

When you print 56 a diagram, by default the image is scaled to fit the size of the printer paper defined in the
page set-up.
The image is not scaled up to fill the page, but it is scaled down if it exceeds the current page boundary. The
image retains its current proportions; that is, it is scaled down equally in the X and Y dimensions. For a large
diagram, this can mean that the components of the diagram are small and hard to read.
Alternatively, you can print a multi-page image; that is:
· allow the diagram image to print on as many printer pages as it naturally occupies, (no scaling), or
· scale the diagram image to exactly fit a specified number of pages.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 457

In all three cases you also define the paper size and orientation.

Scale Images
To turn off or customize image scaling options, follow the steps below:
1. Select the diagram to scale.
2. Double-click on the diagram background to display the <type> Diagram: <name> dialog, or right-click
on the background and select the Properties context menu option.
3. Click on the Diagram tab and, in the Page Setup panel click on the Advanced button.

The Print Advanced dialog displays.

From the Print Advanced dialog the following options are available:
· None: select to print on as many pages as the diagram image covers
· Scale to 1 page: select to scale the diagram image to fit on the currently selected page
· Custom: select to specify the width and height of the diagram images across a specified number of pages
· Page Setup: click to select the page size and alignment 455 .

Note:
Before printing, make sure you have selected the required page layout using the Page Setup button.

4.5.6.29 Lock Diagram

You can lock a diagram against inadvertent changes, such as moving or sizing elements.
To lock a diagram, follow the steps below:
1. Open the diagram to lock.
2. Right-click on the background to open the diagram context menu.
3. Click on the Lock Diagram option to prevent further changes.
4. Click on the OK button.
If a user selects an item on a locked diagram, the object border or outline displays in red.

Note:
This does not apply in the Corporate, Business and Software Engineering, Systems Engineering and Ultimate
editions if security is enabled. In that case, see the Lock Model Elements 204 topic.

© 1998-2010 Sparx Systems Pty Ltd

 458 Modeling Fundamentals | Diagrams

4.5.6.30 Undo Last Action

When editing diagrams, Enterprise Architect supports multiple undo levels for moving, re-sizing and deleting
elements, and for deleting connectors.
There are three ways to undo the last action:
· Press [Ctrl]+[Z]
· Select the Edit | Undo menu option
· Click on the Undo button in the Default Tools toolbar.

Warning:
Currently you cannot undo element additions or connector moves.

4.5.6.31 Redo Last Action

When editing diagrams, Enterprise Architect supports multiple undo levels for moving, re-sizing and deleting
elements, and for deleting connectors. If an Undo action is in error, you can redo the action to reverse the
Undo.
There are three ways to redo the last action:
· Press [Ctrl]+[Y]
· Select the Edit | Redo menu option
· Click on the Redo button in the Default Tools toolbar.

4.5.7 Layout Diagrams

Enterprise Architect provides a Layout Tools window to enable you to lay out the elements in a diagram.
Unless the diagram is very simple, this facility does not lay out the entire diagram; it consists of a set of tools
to set out different areas or sets of elements in the diagram.
To start to lay out a diagram, follow the steps below:
1. Open the Layout Tools window; either:
· Select the View | Layout Tools menu option, or
· Right-click on the main toolbar and select the Layout Tools context menu option.

2. Select the elements to lay out on the currently-active diagram - hold [Shift] or [Control] while you click
on each required element, or hold the mouse button down while you sweep over the area containing the
required elements.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 459

Note:
If no elements are selected on the active diagram, then all elements on the diagram are laid out
(except where otherwise documented).

3. Click on the drop-down arrow on the top left field of the Layout Tools window, and select the required
layout type.
4. The layout type determines the fields presented in the window, therefore the appropriate fields are
described in the topic for each layout type.
· Circle/Ellipse 459
· Box 463
· Per Page 464
· Digraph 465
· Spring 466
· Neaten 467
· Converge/Diverge 467
· Fan Relations 469
· Auto Route 470

5. When you have completed the fields, click on the button.

Enterprise Architect sets out the selected elements according to the options you have selected.

6. If you do not want to work with the new layout, click on the Undo button in the toolbar ( ).

Enterprise Architect also provides a facility for automatically laying out a diagram 471 . If necessary, you can
manually adjust the final result of this automatic process.

4.5.7.1 Circular/Elliptical Layout

The Circle and Ellipse layouts arrange the selected elements in a circle or elliptical pattern, using the largest
horizontal and vertical element edge in the set of elements when calculating the radius of the layout arc.

© 1998-2010 Sparx Systems Pty Ltd

 460 Modeling Fundamentals | Diagrams

To invoke these layouts, follow the steps below:

1. Follow the general Layout Diagrams 458 procedure, and at step 3 select either Circle or Ellipse as
required.
2. Click on the drop-down arrow in the Sort By: field and select the required sort parameter. The options
are:
· None - Elements are passed to the specified layout in the order in which they appear on the original
diagram (left to right, top to bottom)
· Area (Ascending) - Elements are passed to the specified layout in order of the screen space they
occupy, smallest to largest

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 461

· Area (Descending) - Elements are passed to the specified layout in order of the screen space they
occupy, largest to smallest
· Name (Ascending) - Elements are passed to the specified layout in alphanumeric order, based on
the element name
· Name (Descending) - Elements are passed to the specified layout in reverse alphanumeric order,
based on the element name
· Element Type - Elements are grouped by type (for example, Class, Use Case) and in alphanumeric
order within the group by name.
3. Under the Placement option, select either:
· Top to Bottom (the elements are positioned in the required order, zig-zagged across the perimeter
of the circle or ellipse - see Diagram A)
· Circular (the elements are placed in the required order, clockwise around the perimeter of the circle
or ellipse - see Diagram B)
4. Select the Center focused element checkbox to put the last-selected element (the one with the hashed
border) in the center of the circle or ellipse - see Diagram C.

Diagram A - Top To Bottom Layout

© 1998-2010 Sparx Systems Pty Ltd

 462 Modeling Fundamentals | Diagrams

Diagram B - Circular Layout

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 463

Diagram C - Center Focused Element

4.5.7.2 Box Layout

The Box layout arranges the set of selected elements into a square grid.

The dimensions of the box are determined by the square root of the number of selected elements (for
example, 16 elements create a 4x4 box).
To invoke this layout, follow the steps below:

© 1998-2010 Sparx Systems Pty Ltd

 464 Modeling Fundamentals | Diagrams

1. Follow the general Layout Diagrams 458 procedure, and at step 3 select Box.
2. Click on the drop-down arrow in the Sort By: field and select the required sort parameter. The options
are:
· None - Elements are passed to the specified layout in the order in which they appear on the original
diagram (left to right, top to bottom)
· Area (Ascending) - Elements are passed to the specified layout in order of the screen space they
occupy, smallest to largest
· Area (Descending) - Elements are passed to the specified layout in order of the screen space they
occupy, largest to smallest
· Name (Ascending) - Elements are passed to the specified layout in alphanumeric order, based on
the element name
· Name (Descending) - Elements are passed to the specified layout in reverse alphanumeric order,
based on the element name
· Element Type - Elements are grouped by type (for example, Class, Use Case) and in alphanumeric
order within the group by name.
3. In the Padding (px) field, type the vertical and horizontal distance between elements, in pixels.
4. Select the appropriate element distribution option:
· Automatically distribute: Automatically calculate the dimensions of the box (the square root of the
number of selected elements; for example,16 elements create a 4x4 box)
· Specify distribution: Manually define the width of the box, in columns.
5. If you selected Specify Distribution, in the Columns field type the required number of columns.

4.5.7.3 Per Page Layout

The Per Page layout divides each diagram page into a number of cells, which house the selected elements.
The number of cells per page is determined by the page distribution parameter, as explained below.

To invoke this layout, follow the steps below:

1. Follow the general Layout Diagrams 458 procedure, and at step 3 select Per Page.
2. Click on the drop-down arrow in the Sort By: field and select the required sort parameter. The options
are:
· None - Elements are passed to the specified layout in the order in which they appear on the original
diagram (left to right, top to bottom)

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 465

· Area (Ascending) - Elements are passed to the specified layout in order of the screen space they
occupy, smallest to largest
· Area (Descending) - Elements are passed to the specified layout in order of the screen space they
occupy, largest to smallest
· Name (Ascending) - Elements are passed to the specified layout in alphanumeric order, based on
the element name
· Name (Descending) - Elements are passed to the specified layout in reverse alphanumeric order,
based on the element name
· Element Type - Elements are grouped by type (for example, Class, Use Case) and in alphanumeric
order within the group by name.
3. In the Padding (px) field, type the vertical and horizontal distance between cells, in pixels.
4. Select the appropriate page distribution option:
· Automatically distribute: Automatically calculate the optimum number of cells, taking into
consideration the largest horizontal and vertical element edges
· Specify distribution: Manually enter the per page grid dimensions.
5. If you selected Specify Distribution, in the Rows and Columns fields type the required number of
rows and columns.
6. Select the Center Elements checkbox to place each element in the center of its cell. Otherwise the
element placement defaults to the top left corner of the cell.
7. In the Start Page field, type the number from which to start page numbering. Pages begin at the top left
and continue horizontally to the right.

4.5.7.4 Digraph Layout

The Digraph layout arranges the selected elements into a directed graph (digraph for short).
The Digraph attempts to highlight the hierarchy of the elements while keeping the direction of all connectors
pointing to the same edge of the diagram.

The Digraph layout provides the same behaviour as the Automatic Diagram layout. For information on how to
apply this layout, see the Layout Diagrams 458 topic and, for details of the layout parameters, the Lay out a
Diagram Automatically 471 topic.

© 1998-2010 Sparx Systems Pty Ltd

 466 Modeling Fundamentals | Diagrams

4.5.7.5 Spring Layout

The Spring layout uses a force-directed approach to arrange the selected elements organically.

The Spring layout employs a physical analogy to lay out elements. Each element is treated as a particle with a
like electrical charge that repels other elements. Connectors act as springs (hence the term Spring layout) that
draw connected elements back together. The layout is good for highlighting clusters of related objects and
identifying symmetry in the graph.
To invoke this layout, follow the steps below:
1. Follow the general Layout Diagrams 458 procedure, and at step 3 select Spring.
2. In the Iterations field, type the number of iterations, or rounds, to perform to reach the final layout.

The layout is developed over several iterations. Depending on the complexity of the graph, increasing
the number of iterations produces a better result but takes longer to calculate.
3. If the diagram contains elements that significantly vary in size, and that might overlap in the final layout,
select the Scale to prevent overlap checkbox to scale up the positions of the selected elements
(preserving size) until no elements overlap.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 467

4.5.7.6 Neaten Layout

The Neaten layout attempts to arrange the selected elements into a grid based on their horizontal and vertical
proximity to each other. Elements that share the same row or column are aligned based on the Column Snap
and Row Snap parameters.

To invoke this layout, follow the steps below:

1. Follow the general Layout Diagrams 458 procedure, and at step 3 select Neaten.
2. In the Threshold (px) field, type the height or width distance, in pixels, at which elements should be
considered to be in the same row or column. A lower threshold value produces a tighter result, with only
elements that are extremely similar - vertically or horizontally - considered to be in the same row or
column.
3. In the Column Snap field, click on the drop-down arrow and select the appropriate alignment for
elements in the same column.
· Left - elements are aligned with the left edge of the left-most element in the column
· Center - elements are aligned with the vertical center of the center-most element in the column
· Right - elements are aligned with the right edge of the right-most element in the column.
4. In the Row Snap field, click on the drop-down arrow and select the appropriate alignment for elements
in the same row.
· Top - elements are aligned with the top edge of the highest element in the row
· Center - elements are aligned with the horizontal center of the center-most element in the row
· Bottom - elements are aligned with the bottom edge of the lowest element in the column.

4.5.7.7 Converge/Diverge Layout

The Converge layout attracts the set of selected elements towards the center of their bounding rectangle.
Conversely, the Diverge layout repels the set of selected elements away from the center of their bounding
rectangle.
The Converge/Diverge layout also tries to maintain connector angles if an element in the set contains a
connector with waypoints.

© 1998-2010 Sparx Systems Pty Ltd

 468 Modeling Fundamentals | Diagrams

To invoke this layout, follow the steps below:

1. Follow the general Layout Diagrams 458 procedure, and at step 3 select Converge/Diverge.
2. For Direction, select the required layout:
· Converge - attracts the set of selected elements to the center point
· Diverge - repels the set of selected elements from the center point
3. The Amount (%) slider determines how far the elements are moved towards or away from the center
point. The movement is the element's current distance from the center point multiplied by the
percentage value set on the slider. In the Converge layout, the element moves towards the center point;
in the Diverge layout the element moves further away from the center point.

Set the slider to the required percentage.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 469

4.5.7.8 Fan Relations Layout

The Fan Relations layout arranges the immediate relations of an element around a specified edge.
This layout requires a single element to be selected on the diagram, to be used as the context for the layout.

To invoke this layout, follow the steps below:

1. Open the Layout Tools window; either:
· Select the View | Layout Tools menu option, or
· Right-click on the main toolbar and select the Layout Tools context menu option.

2. Select the single element around which to lay out related elements on the currently-active diagram.
3. Click on the drop-down arrow on the top left button of the Layout Tools window, and select Fan
Relations.
4. Click on the drop-down arrow in the Sort By: field and select the required sort parameter. The options
are:
· None - Elements are passed to the specified layout in the order in which they appear on the original

© 1998-2010 Sparx Systems Pty Ltd

 470 Modeling Fundamentals | Diagrams

diagram (left to right, top to bottom)

· Area (Ascending) - Elements are passed to the specified layout in order of the screen space they
occupy, smallest to largest
· Area (Descending) - Elements are passed to the specified layout in order of the screen space they
occupy, largest to smallest
· Name (Ascending) - Elements are passed to the specified layout in alphanumeric order, based on
the element name
· Name (Descending) - Elements are passed to the specified layout in reverse alphanumeric order,
based on the element name
· Element Type - Elements are grouped by type (for example, Class, Use Case) and in alphanumeric
order within the group by name.
5. In the Padding (px) field, type the separation required between the selected element and its related
elements, in pixels.
6. Select the connector direction to use in determining the related elements to lay out. Either:
· Incoming Nodes - to lay out related elements that have the selected element as the target
· Outgoing Nodes - to lay out related elements that have the selected element as the source.
7. In the Fan Edge field, click on the drop-down arrow and specify the edge of the selected element from
which to lay out the related elements.
· Left - to arrange related elements to the left of the selected element
· Right - to arrange related elements to the right of the selected element
· Top - to arrange related elements from the top of the selected element
· Bottom - to arrange related elements from the bottom of the selected element.

4.5.7.9 Auto Route Layout

The Auto Route layout orthogonally routes connectors between the selected elements.
The layout attempts to find the shortest path between the two connected elements while minimizing crossings.
In the following layout, the original connectors are shown in red.

To invoke this layout, follow the steps below:

1. Follow the general Layout Diagrams 458 procedure, and at step 3 select Auto Route.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 471

2. When calculating connector routes, the algorithm divides the diagram into cells of a size determined by
the Cell Size value. A smaller cell size results in connectors being placed closer together.

In this Cell Size (px) field, type the value in pixels.

3. In the Element Margin field, type the preferred separation between connector segments and element
borders, in pixels.

4.5.7.10 Lay Out a Diagram Automatically

Enterprise Architect provides the facility to layout diagrams automatically.
This creates a tree-based structure from the diagram elements and relationships in a diagram. Owing to the
complexity of many diagrams, you might then have to do some manual 'tweaking'.

Notes:
· This facility is available for Structural diagrams and Extended diagrams, but not for Behavioral diagrams
(see the UML Diagrams 673 topic for a description of the diagram types). However, the facility is also
available for Sequence diagrams generated by the Enterprise Architect Debugger.
· Dynamic and Analysis diagrams are NOT suited to this form of layout - please ensure first that the diagram
type you are laying out benefits from the action.
· If you dislike the autolayout, you can reverse it before saving the diagram. Click [Ctrl]+[Z].

Layout a Diagram
To layout a diagram, follow the steps below:
1. Select a diagram.
2. Click on either:
· The Diagram | Layout Diagram option, or
· The Auto Layout button on the diagram toolbar.

Access the Diagram Layout Options Dialog

For a fine degree of control of the elements in your diagram, you can use the Diagram Layout Options dialog.
Generally the default layout parameters provide adequate layouts for a wide range of diagrams, but there are
times when more specific settings are required. To access the Diagram Layout Options dialog, follow the steps
below:
1. Double-click on the background of the diagram to display the Diagram Properties dialog.
2. Click on the Diagram tab, then click on the Set Layout Style button. The Diagram Layout Options
dialog displays.
3. When you have made the required changes, click on the OK button to save the changes.

© 1998-2010 Sparx Systems Pty Ltd

 472 Modeling Fundamentals | Diagrams

You can alter any of the following settings on the Diagram Layout Options dialog to refine your layout:
· Cycle Remove Options panel - these settings remove cycles in the element organization (where element X
is the source of a path but also becomes the target of a branch of the path), by reversing the connectors
that impose the cycling and then reorganizing the diagram and reinstating the reversed relationships. This
identifies the primary source element in the diagram.
· Greedy - Select to use the Greedy Cycle Removal algorithm, which minimizes the number of
connectors reversed.
· Depth First Search - Select to use the Depth First Search Cycle Removal algorithm, which establishes
the longest linear sequence possible, before establishing parallel sequences and branches. This
algorithm is less effective in large and/or complex diagrams, but produces a more natural layout than
the Greedy algorithm.
· Crossing Reduction Options panel - these options determine how long the routine should look for ways of
reorganizing the layout to avoid crossed relationships:
· Iterations - Type the number of iterations to be used during cycle removal (more than 8 does not
usually provide any improvement).
· Aggressive - Select to use an aggressive (detailed and time-consuming) crossing reduction step.
· Layering Options panel - these settings determine how elements are organized in layers during layout:
· Longest Path Sink - Select to use the Longest Path Sink Layering algorithm, where the final target
elements (sinks, which have no relationships issuing from them) are arranged in a layer at the top of the
diagram, and the relationship paths built downwards from there in as many layers as there are nodes in
the longest path.
· Longest Path Source - Select to use the Longest Path Source Layering algorithm, where the original
source elements (those with no relationships entering them) are arranged in a layer at the bottom of the
diagram and the relationship paths built up from there in as many layers as there are nodes in the
longest path.
· Optimal Link Length - Select to use the Optimal Link Length Layering algorithm, which organizes the
elements into whichever layers minimize the total source-to-sink relationship chain; in this layout you
can have both source elements and sink elements at various levels of the diagram.
· Layout Options panel
· Layer Spacing - Type the default number of logical units between layers of elements (vertical spacing).
· Column Spacing - Type the default number of logical units between elements within a layer (horizontal
spacing).
· Up, Down, Left, Right - Select the direction in which directed connectors should point, to set the
position of the primary source element and the overall flow of the diagram.
· Initialize Options panel - the autolayout routine inserts line waypoints and connectors into relationship

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 473

paths to help plot the direction of relationships. The routine then assigns an index number to every node,
such that nodes in the same layer are numbered left to right. The settings in this panel determine how
those index numbers are assigned.
· Naive - Select to use the Naive Initialize Indices algorithm, which assigns index numbers to nodes as
they are encountered in a sweep and tends to place all waypoints to the right of real nodes (and
therefore long relationships between a small number of elements to the right of chains of short
relationships between several elements).
· Depth First Search Outward - Select to use the Depth First Out Initialize Indices algorithm, which
assigns index numbers to nodes as they are encountered in a depth first search from source nodes
outwards (and would therefore place longer relationship chains to the left of shorter chains, with the
primary source node at the start of the diagram flow).
· Depth First Search Inward - Select to use the Depth First In Initialize Indices algorithm, which also
assigns index numbers to nodes as they are encountered in a depth first search, but from sink nodes
inwards (and would therefore place longer relationship chains to the left of shorter chains, with the
ultimate target node at the end of the diagram flow).
· Set as Project Default checkbox
· Select this checkbox to apply the diagram layout settings to all diagrams in the project. If you later
check this box and click on the OK button for a different diagram, the new settings override the settings
saved earlier.
The following is an example of an automatically laid out diagram, with the following options set:
· Depth First Search
· Optimal Link Length
· Depth First Search Outward
· Direction - Up.

© 1998-2010 Sparx Systems Pty Ltd

 474 Modeling Fundamentals | Diagrams

4.5.8 The Quick Linker

The Quick Linker provides a simple and fast way to create new elements and connectors on a diagram.
When an element is selected in a diagram, the Quick Linker arrow is displayed at the upper right corner of
the element, as shown below:

Simply clicking and dragging the icon enables you to create new connectors and elements on the diagram, as
explained in the following topics:

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 475

· Create New Elements 475

· Create Connectors 476
The connectors and elements suggested by the Quick Linker are the commonest objects appropriate to the
context. You can select others from the Toolbox pages. Also, a Technology Developer can edit the lists of
elements and connectors, and create new combinations.

4.5.8.1 Create New Elements

To create new elements using the Quick Linker, follow the steps below:
1. Select a start element on the current diagram.

2. Drag the Quick Linker arrow onto an empty area of the diagram.

3. Use the Quick Linker context menu to select the type of element and connector to create.

Tips:
· Press and hold [Shift] while selecting the type of connector to select an existing classifier as the target.
· For rapid modeling, you can suppress the Properties dialog when creating new elements. See the option
Tools | Options | Objects | Edit Object on New.

© 1998-2010 Sparx Systems Pty Ltd

 476 Modeling Fundamentals | Diagrams

Note:
The available Quick Linker options depend on the type of element selected. For example, the Quick Linker
options for a Class (above) differ from those of an Actor (below). These are the most appropriate, commonly
used elements and connectors for the source element; you can create other target elements and connectors
by selecting them from the appropriate Toolbox page.

4.5.8.2 Create Connectors

To create new connectors between existing elements using the Quick Linker, follow the steps below:
1. Select the source element on the current diagram.

2. Drag the Quick Linker arrow onto another element in the diagram.
3. Release the mouse button and use the Quick Linker context menu to select the type of connector.

Enterprise Architect User Guide

 Modeling Fundamentals | Diagrams 477

Notes:
· The list of connectors provides the most appropriate, commonly-used connectors for the source and target
element types. If you want to use a different connector, select the appropriate Toolbox page, click on the
required connector and then on the source element, and drag across to the target element.
· The connector does not actually establish until you release the mouse button over the target element.
However, a dotted line shows where the connector would be at any point, and the solid outline of the
nearest element or extension changes to a hatched outline as you move the cursor onto it; this helps you
identify where the connector will connector to, if there are many closely-arranged elements, Parts, Ports
and other extensions.
· You can also bend the connector, pressing [Shift] as you drag the cursor in a new direction.

© 1998-2010 Sparx Systems Pty Ltd

 478 Modeling Fundamentals | Elements

4.6 Elements

Models are constructed from elements, each of which has its own meaning, rules and notation.
The properties and features of an element can be defined and displayed through a set of windows and dialogs
480 .

Elements can be used at different stages of the design process for different purposes. The basic elements for
UML 2.3 are depicted in the following diagrams:

Enterprise Architect User Guide

Modeling Fundamentals | Elements 479

© 1998-2010 Sparx Systems Pty Ltd

 480 Modeling Fundamentals | Elements

4.6.1 Element Property Displays

To define, assign and review the properties and features of elements, you can use the following:
· Properties Dialog 481
· Properties Docked Window 508
· Element Browser 510
· Scenarios & Requirements Window 514

· Select <Item> Dialog 515 .

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 481

4.6.1.1 Properties Dialog

This topic area describes element: properties and their settings; object files and classifiers; responsibilities;
constraints; connectors; scenarios; Tagged Values; associated files and boundary element settings.
To display the element Properties dialog, use any of the following methods:
· Select an element in the Diagram View and select the Element | Properties menu option
· Right-click on an element in the Diagram View, and select the Properties context menu option
· Select an element in the Diagram View, and press [Alt]+[Enter]
· Double-click on an element in the Diagram View
· Right-click on an element in the Project Browser, and select the Properties context menu option.
To suppress display of the Properties dialogue when placing a new element, uncheck the Edit Object on New
option on the Objects page of the Options dialog (Tools | Options | Objects).

Note:
There are several variations of the Properties dialog:
· The dialog for a Table or Stored Procedure element has slight differences on the General tab, and a Table
(Stored Procedure) Details tab instead of a Details tab; see the Working With Tables 1014 topic.
· The dialog for a Class element of a stereotype other than Table is as shown in General Settings 482 .

· The dialog for an element of any other type does not have a Details tab.
· Port 826 and Part 825 elements have a Property 829 tab.
· Activity elements have a Behavior 581 tab, and Action and Invocation elements (depending on their type)
have other tabs such as Effect 743 , Trigger 804 and Call 581 tabs.
· Action Pins 749 have a Pin tab.
In all cases, the Properties dialog is an expandable window, which you can stretch to enable longer entry and
clearer inspection of the text field values.

The following topics describe each of the tabs in the Class Properties dialog in detail.
· General 482
· Details 484
· Requirements 485
· Constraints 488
· Links 489
· Scenarios 490
· Files 507
· Tagged Values 508
Follow the links for information on Tagged Values 632 , Object files and Classifiers 519 , and the Boundary
element 803 appearance.

© 1998-2010 Sparx Systems Pty Ltd

 482 Modeling Fundamentals | Elements

4.6.1.1.1 General Settings

The General tab of the element Properties dialog enables you to record information on the element as a
container, such as the name, status, or scope.
The tab is illustrated below:

To define the element, complete the following fields:

Field Use to

Name Change the element's name.

Stereotype (Optional) Type the name of a stereotype for the element, or click on the drop-down arrow
and select one.

Abstract Indicate that the element is abstract.

Author Enter or select the name of the original author.

Status Indicate the current status of the element (such as Approved, Proposed).

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 483

Field Use to

Scope Indicate the element's scope (public, private, protected, package).

Complexity Indicate the complexity of the element (used for project estimation). Assign Easy, Medium
or Hard.

Alias Enter an alias (alternative display name) for the object.

Language Select the programming language for the object.

Keywords Enter free-text items such as keywords or context information. This can be filtered in Use
Case Metrics and Search dialogs.

Phase Indicate the phase this element is to be implemented in (for example, 1, 1.1, 2.0 ...).

Version Enter the version of the current element.

Notes Enter any notes text associated with the element, as described for the Notes 641 window.
You can format the notes text using the Notes 642 toolbar at the top of the field.

Further facilities are made available by pressing the Advanced button. See Advanced Settings 483 for details.

4.6.1.1.1.1 Advanced Settings

Some elements support additional attributes. These are Generalizable elements; click on the Advanced
button on the element Properties dialog to set:
· IsRoot - the element is a root element and cannot be descended from another
· IsLeaf - the element is final and cannot be a parent for other elements
· IsSpecification - the element is a specification
· IsActive - the element is active; for example, an Active Class 812
· Multiplicity - the number of instances of the element that can exist. The value displays on the element in a
diagram, in the Name compartment. Use the format defined in the Cardinality 665 tab.

© 1998-2010 Sparx Systems Pty Ltd

 484 Modeling Fundamentals | Elements

4.6.1.1.2 Details
The Details tab of the element Properties dialog enables you to define the structural and processing details for
the selected Class element.

Note:
When launched from MDG Integration, the Attributes and Operations buttons are not available.

Field/Button Use to

Cardinality Note:
Cardinality and Multiplicity are effectively the same. It is recommended that you
define the value in the Multiplicity field of the Advanced dialog 483 ; this ensures
that the value displays on the element in a diagram.

Select the number of elements in a set for the Class.

Visibility Select the visibility of the Class.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 485

Field/Button Use to

Attributes Define attributes for the Class. The Attributes Properties 558 dialog displays.

Operations Define operations for the Class. The Operations Properties 570 dialog displays.

Concurrency Specify how concurrent activities should be processed.

Collection Classes Define Collection Classes (for generating code from Association connectors) that
apply to this Class. The Collection Classes for Association Roles 1345 dialog
displays.

Type Select the type of Class template parameter to add or list. You can also edit or
delete parameters. See the Parameterised Classes 813 topic.

Arguments Select a parameter and type any required argument for that parameter.

4.6.1.1.3 Requirements
The Requirements tab of the element Properties dialog enables you to define the requirements that this
element is designed to meet.
Requirements are of two types: internal requirements 925 (responsibilities) and external requirements 487
(system requirements, elements connected to this element by a Realize connector). The Requirements tab
lists both types, but you can only edit the internal type on this tab.

© 1998-2010 Sparx Systems Pty Ltd

 486 Modeling Fundamentals | Elements

You can show the requirements for an element on the diagram directly, using the Feature Visibility 438
function. (It is also possible to show inherited requirements in this way).

Field/Button Use to

Requirement Enter the name and high level detail of the requirement.

Type Specify the type; for example, Functional or Non-functional.

Functional requirements are things that the system must do, such as identify
franked, unfranked and total credit for a dividend; non-functional requirements are
things that the system must be, such as reliable, cost effective.

Last update Specify the date of the last requirement update.

Status Specify the current status of the requirement.

Difficulty Identify the complexity of implementing the current requirement.

Priority Specify how urgent the requirement is.

Stability Specify the estimated stability of the requirement.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 487

Field/Button Use to

This is an indication of the probability of the requirement - or understanding of the

requirement - changing. High stability indicates a low probability of the
requirement changing.

Notes Record details of the requirement. As for the Notes 641 window, you can format
the notes text using the Notes 642 toolbar at the top of the field.

Move External Make an internal responsibility into an external requirement 926 .

New Create a new requirement.

Save Save changes to requirements.

Delete Delete a selected requirement.

Defined List the defined requirements associated with this element.

4.6.1.1.3.1 External Requirements

External requirements are those Requirement elements that have been connected to the current element
using a Realize connector.
By creating a connector from an element to a requirement, you create an expectation that the element must
implement the requirement as part of the system solution.
In Enterprise Architect, linked requirements are shown in the Requirements tab of the element Properties
dialog, but they are marked external and cannot be directly edited (on selection, the tab fields are grayed out).
Double-click an external requirement in the list to activate the Properties dialog for the associated
requirement, where you can view and modify the requirement details and check the requirement hierarchy
details.

© 1998-2010 Sparx Systems Pty Ltd

 488 Modeling Fundamentals | Elements

See Also
· Create Requirements 918
· Make Internal Requirement External 926

4.6.1.1.4 Constraints
Elements can have associated constraints placed on them. These are the conditions under which the element
must exist and function.
Typical constraints are pre- and post- conditions, which indicate things that must be true before the element is
created or accessed and things that must be true after the element is destroyed or its action complete.
Use the Feature Visibility 438 function to show constraints for an element directly on the diagram (it is also
possible to show inherited constraints in this way).

Add Constraints to a Model Element

To add constraints to a model element, follow the steps below:
1. Open the element Properties dialog.
2. Select the Constraints tab.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 489

3. In the Constraint field, type the name of the constraint.

4. In the Type and Status fields, click on the drop-down arrow and select the constraint type (Pre-
condition, Post-condition or Invariant) and status.
5. In the larger text field, type any additional notes required.
6. Click on the Save button.
Constraints are used in conjunction with responsibilities 485 to define the conditions and rules under which an
element operates and exists.

4.6.1.1.5 Links
The Links tab of the element Properties dialog displays a list of all relationships (connectors) active for the
current element.

The Relationships panel lists the relationships this element has. The:
· Element column identifies the elements this element is related to
· Element Stereotype column identifies the stereotype (if any) of the element
· Type column identifies the element type of the related element
· Connection column identifies the type of relationship
· Stereotype column identifies the stereotype (if any) of the relationship.
From the Links tab you can perform operations on a relationship, by right-clicking on the relationship to display
the context menu.

© 1998-2010 Sparx Systems Pty Ltd

 490 Modeling Fundamentals | Elements

To:
· Hide the relationship on the diagram, click on the Hide Relation menu option; the option then changes to
Show Relation, which you select to redisplay the relationship on the diagram
· Display the relationship Properties 626 dialog, click on the Relationship Properties menu option
· Highlight the related element in the Project Browser, click on the Locate Related Object menu option
· Delete the relationship from the model and all diagrams, click on the Delete Relationship menu option; the
system prompts you to confirm the deletion.

4.6.1.1.6 Scenarios
A scenario is a real-world sequence of operations that you create to describe how an element works in real-
time; for example, its functional behavior, business work flows and end-to-end business processes.
You can create scenarios in most types of element, but they are generally most applicable to Use Cases.
The Scenario tab of the element Properties dialog has two internal tabs:
· The Description tab, which enables you to create scenarios and provide a simple text description either of
each scenario, or of the structure of each scenario.
· The Structured Specification 493 tab, which enables you to create scenarios or select those you have
created elsewhere and, for each scenario:
· Create a series of steps for each part of the scenario
· Structure the scenario to show how the basic path diverges into the alternate paths and exception paths
· Generate a number of types of diagram 499 from the structure
· Generate a structured scenario from an Activity diagram 513
· Generate a structured scenario from text on the clipboard 496 ; this option has a variation in the
Description tab that enables you to translate scenario descriptions 491 created prior to release 8.0 of
Enterprise Architect, into structured scenarios in the latest release.

Notes:
· The Scenarios tab does not prevent you from creating more than one basic path, but it would be unusual to
define more than one.
· All the functions available on the Scenarios tabs are also available through the Scenarios & Requirements
514 window/view. Use the Browse Element icon in the window toolbar to list and select the scenarios for
the element.

Description Tab
When you first select the Scenarios tab, it defaults to the Description tab and sets both the Scenario (name)
field and the Type field to Basic Path, to enable you to define the basic path first. You can overtype the
scenario name with more appropriate text if required. As you go on to create other scenarios, you set the type
to Alternate or Exception as appropriate.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 491

Complete the fields as described below.

Field Use to

Scenario Type in the name of the scenario (or, for existing scenarios, click on the drop-down arrow
and select one from the list).

Type Specify the type of scenario; the options are:

· Basic Path - the direct set of steps for the scenario
· Alternate - an alternative set of steps, in parallel with part of the basic path
· Exception - the path the scenario follows if a step of the basic path does not
produce an appropriate result.
Description Record a textual description of how the user uses the current element.
As for the Notes 641 window, you can format the notes text using the Notes 642 toolbar at
the top of the field.
As well as the Notes window facilities, you can also generate a structured specification
from the text in this field. Highlight the text, right-click on it and select the Create
Structure from Notes context menu option.

© 1998-2010 Sparx Systems Pty Ltd

 492 Modeling Fundamentals | Elements

Field Use to

The text is copied to the Structured Specification 493 tab for the current scenario, either as
a new specification or as the continuation of an existing specification, with a new step
created at each carriage return. Subsequent changes to the text on the Structured
Specification tab are not reflected on the Description tab.

New Clear the data fields so that you can enter data in them to create a new scenario.

Save Save a new scenario, or changes to an existing scenario.

Delete Delete a scenario selected from the Scenarios panel, below.

Scenarios Display a list of defined scenarios for this element.

You can change the order in which the scenarios are listed, using the and
buttons.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 493

4.6.1.1.6.1 Structured Specification Tab

The Structured Specification tab, encompassing the Structured Scenario Editor, enables you to define the
structure, actions and interactions of the scenarios 490 defined for an element such as a Use Case. These
scenarios can be the main (basic) path, alternate paths, or exception paths.

When you open the Structured Specification tab it defaults to the basic path (as shown above) so that if it does
not already exist, you can create it. You can create alternate paths and exception paths as part of the process
of adding them to steps of the basic path.
You can also create all three types of scenario paths on the Description 490 tab, or in the Scenarios &
Requirements 514 window.
The Structured Specification tab offers a wide range of facilities for generating and modifying scenario
specifications. These are available through the:
· Structured Specification Toolbar 495

· Item context menu 496

· Selected Text context menu 497
· Entry Points context menu 498
· Floating Toolbar. 499

© 1998-2010 Sparx Systems Pty Ltd

 494 Modeling Fundamentals | Elements

You can create a specification for a scenario in one of several ways:

· Enter the specification yourself, as described below
· Generate a specification from an Activity diagram 513 created under a Use Case element
· Generate a specification from the notes text 490 of the scenario in the Description tab
· Generate a specification from text held on the clipboard 496 .
To enter the specification yourself, starting with the basic path, follow the steps below:
1. In the Scenario field, click on the drop-down arrow and select the Basic Path scenario.
2. In the new step field in the Action column, type the text of the first step or action.

Notes:
· By default, the steps begin with a user step (indicated by an actor icon) and alternate between user
and system (indicated by a screen icon) steps. However, you can control the responsible entity
assigned to a step by typing a keyword within the first 15 characters of the text in the Action column;
either 'User' or 'Actor' for a user step, or 'System' for a system step.

Once a step has been saved, you can change the responsible entity by either double-clicking on the
icon or right-clicking on the step, and selecting the Set Step as 'System' or Set Step as 'User'
context menu option as required.

· An entry for the basic path displays in the Entry Points tab, as Step 0 with no value in the Join
column (the basic path does not rejoin itself).

3. Tab to the Uses column and, if necessary, type the name of each element used in this step.

Note:
The values in the Uses, Results and State columns, whilst optional, are significant if you want to
generate a diagram 499 from the specification. If you type the name of an element linked to the current
element (and listed in the Context References 506 tab), the element name is highlighted and
underlined.

4. Tab to the Results column and, if necessary, type the outcome of completing this step.
5. Tab to the State column and, if necessary, type the name of the state into which the step moves the
action.
6. When you move out of the Action column, the next new step field displays underneath. Repeat steps 2
to 5 as many times as is necessary.
The Structured Specification tab should now resemble the following illustration:

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 495

As you develop the scenario, you can move steps 495 to different positions in the scenario, and insert 497 new
step lines within the body of the scenario.
You can also create constraints 507 on the element that have an impact on the scenarios.
Repeat the Scenario Steps procedure for each scenario you have created. You can now adapt, enhance and
interrelate the scenario specifications using the facilities of the Structured Specification tab:
· Structured Specification Toolbar 495

· Item context menu 496

· Selected Text context menu 497
· Entry Points context menu 498
· Floating Toolbar 499 .
The icons on the Structured Specification toolbar offer the following facilities:

Icon Use to

Save changes to the scenario specification.

Return to the basic path specification (if another specification is currently displayed).

(Only enabled when the basic path is displayed - you cannot add an alternate path to another
alternate path or an exception path.)
Create a branch from the selected step to an alternate path scenario - select the path from the
displayed list. If the appropriate scenario does not yet exist, double-click on the new path line and
type the scenario name, then click off the line and back on to it. Click on the OK button.

© 1998-2010 Sparx Systems Pty Ltd

 496 Modeling Fundamentals | Elements

Icon Use to

Note:
An entry for this alternate path displays in the Entry Points tab, as Step a of the basic path step it
branches from; in the Join column, click on the drop-down arrow and select the number of the
step at which action flows back to the basic path, or select End if the path terminates separately
from the basic path.

(Only enabled when the basic path is displayed - you cannot add an exception path to another
exception path or an alternate path.)
Create a branch from the selected step to an exception path scenario - select the path from the
displayed list. If the appropriate scenario does not yet exist, double-click on the new path line and
type the scenario name, then click off the line and back on to it. Click on the OK button.

Note:
An entry for this exception path displays in the Entry Points tab, as Step a of the basic path step it
branches from; in the Join column, click on the drop-down arrow and select the number of the
step at which action flows back to the basic path, or select End if the path terminates separately
from the basic path.

Move the currently-selected step one place up (including any new step ... entry).

Move the currently-selected step one place down (including any new step ... entry).

Display a list of diagrams that you can generate from the scenario 499 ; select the type of diagram
that you want to generate.

Generate Test Cases 505 based on this Use Case scenario; you can generate either internal Test
Cases or External Test Cases.

Delete the selected step from the scenario.

Display the Help topic for this tab.

To display this context menu, right-click on a step or blank line on the Structured Specification tab. The
following options are available:

Option Use to

Create Structure From Generate a set of steps from a text description or list captured on the
Clipboard Text - New clipboard. A new step is generated:
Line Delimited
· after each carriage return in the captured text (New Lines), or
Create Structure From
Clipboard Text - · for each sentence in the text; that is, after each full stop/space/capital letter
Sentence Delimited combination (Sentences).
If a set of steps is already displayed, it is overwritten by the generated steps.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 497

Option Use to

Create Structure From Generate a set of steps from an Activity Diagram 513 created for a Use Case.
Generated Activity
If a set of steps is already displayed, it is overwritten by the generated steps.
Diagram

Add Alternate Path Create a branch from the selected basic path step to an alternate path (see
previously).

Add Exception Path Create a branch from the selected basic path step to an exception path (see
previously).

Insert Step Above Insert a new step... line above the currently-selected step. (Press [Esc] to return
[Shift]+[Insert] this new line to the end of the scenario.)

Insert Step Below Insert a new step... line below the currently-selected step. (Press [Esc] to return
[Insert] this new line to the end of the scenario.)

Insert End Step Insert a new step... line at the end of the scenario.
[Ctrl]+[n]

Set Step As 'User' Switch the entity responsible for performing the action of the selected step
Set Step As 'System' between user and system.

Link Step to Use Case Either include the actions of an existing Use Case element, extend an existing
Use Case element, or invoke a Use Case as the action of the selected step.
Selecting the appropriate sub-option displays the Select Use Case 515 dialog,
which you use to browse for and select the required Use Case element.
The appropriate includes, extends or invokes stereotyped connector is created
between the current element and the selected Use Case.
For the include and extend actions, any text in the Action field is overwritten by
the link to the Use Case. For the invoke action, the following link is added to the
end of the Action text:
[Invokes: <Use Case Name>]

Merge With Step Merge the selected step with another. A list of the other steps in the scenario
displays; click on the step to merge with the selected step.

Move After Step Move the selected step to another position in the scenario. A list of the other
steps in the scenario displays; click on the step after which to position the
selected step.

Delete Delete the selected step. A prompt displays to confirm the deletion. Any
subsequent steps are moved up one place.

To display this context menu, highlight the text in a user-editable field within a step on the Structured
Specification tab. The following options are available:

Option Use to

Create Create a glossary definition 641 or a new element 524 based on the highlighted
text.

Link Step to Use Case Either incorporate the actions of an existing Use Case element, extend an
existing Use Case element or invoke a Use Case element, as the action of the
selected step. Selecting the appropriate sub-option displays the Select Use
Case 515 dialog, which you use to browse for and select the required Use Case
element.
Any text in the Action field is overwritten by the link to the Use Case, except for
the invoke action where the following link is added to the end of the Action text:
[Invokes: <Use Case Name>]

© 1998-2010 Sparx Systems Pty Ltd

 498 Modeling Fundamentals | Elements

Option Use to

Link to existing Element (Uses and Results fields only.) Create a Realization or Dependency
relationship to a Requirement, Feature or other element elsewhere in the
model.
You select the element and connector types from submenu options, which then
display the Select Element 515 dialog, which you use to browse for and select
the required element.

Insert context reference Add a reference to an element stored elsewhere in the model, and create an
entry for the element in the Context References 506 tab.
Selecting this option displays the Select Element 515 dialog, which you use to
browse for and select the required reference element.
See also the Structured Specification Floating Toolbar 499 topic.

Insert glossary Insert an existing glossary term at the cursor position. To select the term,
definition double-click on it in the displayed list.
When you select the term it is inserted into the field as highlighted and
underlined text, which displays the definition when you move the cursor over it. If
you highlighted part of the original text, the term overwrites that text.

Split Step Splits the selected step into two consecutive steps.
The option is available only if you highlight a portion of the text in the selected
field. The new step takes the highlighted text as its Action text.

Search for <text> Displays a sub-menu of options for locating the selected text in a number of
locations 1437 .

Undo Undo any unsaved changes you have just made in the step.

Cut

Copy
Perform simple editing operations on the highlighted text.
Paste

Delete

Select All

The Entry Points tab shows how the basic path, alternate path and exception path scenarios for the element
are organized and interrelated.
If an alternate path or exception path has been defined but has not yet been added to the basic path, it is not
listed on this tab.
You can switch focus between the Entry Points tab and the Structured Specification tab by pressing [Alt]+[Q].
To display the context menu for this tab, highlight an entry and right-click on it. The following options are
available:

Option Use to

Edit Path Display the steps of the scenario in the Structured Specification tab, with the first
step highlighted.

Join with Step (Available only if the basic path scenario is displayed in the Structured
Specification tab. Not available to edit the basic path scenario.)
Highlight the Join field and its drop-down arrow. Click on the drop-down to
define or change the step number at which the alternate or exception path
rejoins the basic path. Select End if the path does not rejoin the basic path
steps.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 499

Option Use to

Remove Entry Point (Available only if the basic path scenario is displayed in the Structured
Specification tab. Not available to delete the basic path.)
Delete the relationship between the selected path and the basic path, and
remove the entry from the Entry Points tab.

Wherever a reference to another element exists on the Scenario tab (that is, where the text is highlighted and
underlined), if you hover the cursor over the element name a short floating toolbar displays, which you can use
to:
· display the element Properties dialog
· locate the element in its parent diagram
· locate the element in the Project Browser.

4.6.1.1.6.2 Generate Diagrams

If you have created a structured scenario, you can generate any of the following diagrams from that scenario:
· Activity 500
· With ActivityParameter 500

· With Action 500

· With Action Pin 500
· Rule Flow 501
· State Machine 501
· Sequence 503
· Robustness 504
To generate the required diagram, follow the steps below:
1. Create the scenario structure on the Structured Specification 493 tab.

2. Click on the Generate Diagram icon ( ) in the toolbar on the tab.

3. Click on the type of diagram to generate.
Enterprise Architect generates the diagram and notifies you that generation is complete. Close the Properties
dialog to review the diagram.

If the diagram being generated already exists under the selected element, the following prompt displays:

Select the appropriate radio button to:

· Overwrite the existing diagram (delete the existing diagram and elements, and create a new diagram and
elements) or
· Synchronize the elements in the existing diagram with the scenario steps (however, Sequence and
Robustness diagrams cannot be synchronized).

© 1998-2010 Sparx Systems Pty Ltd

 500 Modeling Fundamentals | Elements

Note:
The Synchronize elements in existing diagram option enables the Preserve Diagram Layout checkbox,
which you can select to preserve the existing arrangement of elements and connectors on the diagram. Any
new elements are added to the diagram in the default position, and you manually position them in the
diagram as required. If you do not select the checkbox, the diagram is recast in the default layout.
It is recommended that you uncheck the Preserve Diagram Layout checkbox if you are synchronizing
elements with scenario steps:
· When new steps have been added or existing steps have been deleted or moved within the Use Case
· For the first time in a Use Case that has been imported from XMI 290 with the Strip GUIDs option selected
· For the first time in a Use Case that has been copied and pasted 531 in the Project Browser, or
· For the first time in a Use Case whose containing package has been copied and pasted 388 in the Project
Browser.

An Activity is generated as a child of the selected element, to act as a container for the diagram.
· The scenario steps are modeled as Activities
· The values of the Uses, Results and State columns for each step are added as Tagged Values of the
corresponding Activity.

Activity with ActivityParameter

· The values of the Uses and Results columns are modeled as ActivityParameters
· The value of the State column is added as a Tagged Value of the Activities.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 501

Note:
ActivityParameters are added to the Project Browser and not to the diagram.

Activity with Action

· The scenario steps are modeled as Actions
· The values of the Uses, Results and State columns are added as Tagged Values of the Actions.

Activity with ActionPin

· The scenario steps are modeled as Actions
· The values of the Uses and Results columns are modeled as Input Pins and Output Pins respectively
· The value of the State column is added as a Tagged Value of the Actions.

Note:
ActionPins are added to the Project Browser and not to the diagram.

A Rule Flow Activity is created as a child of the selected element, to act as a container for the diagram.
· The scenario steps are modeled as RuleTasks.
· The values of the Uses, Results and State columns are added as Tagged Values of the RuleTasks.

A StateMachine is created as a child of the selected element, to act as a container for the diagram.
· Each value in the State column is modeled as a State.
· The scenario steps become the Transition connectors between the States
· The values of the Uses and Results columns are added as Tagged Values of the Transitions.

© 1998-2010 Sparx Systems Pty Ltd

 502 Modeling Fundamentals | Elements

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 503

An Interaction is created as a child of the selected element, to act as a container for the diagrams - the Basic,
Alternate and Exception paths are modeled as separate Sequence diagrams under the Interaction.

Note:
All the elements involved in the scenario should be identified in the Context Reference 506 tab. That is,
relationships must already exist between the scenario parent element and the other elements named in the
scenario.

· Each Context Reference element named in a scenario step is modeled as a Lifeline

· The step itself becomes the Message between an originator and its destination(s)
· The first Context Reference element in a step is treated as the originator
· The subsequent Context Reference element(s) become the destination(s).

Note:
Because the diagram generator acts on element names in the step, you should take care to avoid using the
element names as normal text. For example, in step 1 in the dialog below, the term ATM-Card is interpreted
as a reference to the ATM element, and two Customer inserts ATM-Card into ATM Messages are generated
for the step. (To avoid confusion, in the diagram the first Message has been deleted.)

· The values of the Uses, Results and State columns are added as Tagged Values of the Message.

© 1998-2010 Sparx Systems Pty Ltd

 504 Modeling Fundamentals | Elements

A Collaboration 814 is created as a child of the selected element, to act as a container for the Robustness 835
diagram.

Notes:
· All the elements involved in the scenario should be identified in the Context Reference 506 tab. That is,
relationships must already exist between the scenario parent element and the other elements named in the
scenario.
· Any values in the Uses, Results and State columns are ignored and not represented in the diagram.
· Each UI element 849 in a step becomes a Boundary 836 element. A Dependency 861 relationship is
created from this Boundary element to the UI element (this connector is not shown on the diagram).
· Each Actor referenced in a step is dropped into the Robustness diagram as a simple link.
· Each Class referenced in a step is dropped into the Robustness diagram as a simple link, and is given the
stereotype entity.
· Each step with a System trigger becomes a Controller 838 . Alternate/exception path Controllers are
displayed with a red background color.
· Each step with a User trigger becomes the name of the Association 855 between Controllers.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 505

4.6.1.1.6.3 Generate Test Cases

When you select a scenario and click on the Test Case Generation icon in the window toolbar, Enterprise
Architect prompts you to select to generate either an Internal Test Case or an External Test Case.

Internal Test Case

A test is generated for the basic path and each alternate and exception path in the scenario, and added to the
selected element. In addition, for each step in the basic, alternate and exception paths that has a value in the
Results column, a test is generated and added to the selected element.

© 1998-2010 Sparx Systems Pty Ltd

 506 Modeling Fundamentals | Elements

A diagram is created under the selected element, to which the selected element and a Note (showing the
element's Structured Specification) is added. The created tests are displayed in the Test Scripts compartment
1549 of the selected element on the diagram.

Another way to view these tests is to click on the element and display the Testing 1537 window (View | Testing
).

Note:
These generated tests are written to the Scenario test tab of the Testing window. You can move 1544 the tests
to another test-type tab if required.

External Test Case

A Test Case 848 element is created, linked to the selected element using the Trace 892 connector. A diagram
is created under this Test Case element, to which the selected element, the Test Case element and a Note
(showing the element's Structured Specification) is added. The created tests are displayed in the Test Scripts
compartment 1549 of the Test Case element on the diagram.
A test case is generated and added to the Test Case element for the basic path, and for each alternate and
exception path. In addition, for each step in the basic, alternate and exception paths that has a value in the
Results column, a test is generated and added to the Test Case element.

Note:
You can review the tests within the Test Case element using the Testing window, as for Internal Test Cases.

4.6.1.1.6.4 Context References Tab

On the Scenarios tab of the element Properties dialog, the Context References tab displays a list of all
elements that are either:
· connected to the current element by any connector, on the current diagram or another, or
· defined as a cross reference (or custom reference 527 ) on the current element.

This tab enables you to add custom references - right-click anywhere in the list and select the Add Reference
context menu option. The Select Element 515 dialog displays, in which you can locate and select the required
cross reference element or elements. For each cross reference you can also use context menu options to
delete the entry in the list, or to open the Comment field so that you can add or edit comment text.
For each element in the Context References list, wherever the name of that element appears in the structured
specification, the name is highlighted and underlined. You can press [Ctrl]+click on the highlighted name to
view the element Properties dialog.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 507

4.6.1.1.6.5 Scenario Constraints Tab

The Structured Specification Constraints tab is a simple link to the Constraints 488 tab of the element overall. It
lists existing constraints; if you select the toolbar icons to add or edit a constraint, control switches to the
element Constraints tab.

4.6.1.1.7 Associated Files

An element can be linked to files held in the database, using the Files tab of the element's Properties dialog.

Note:
Linked files are a good way to link elements to additional documentation and/or source code.

You can also insert hyperlinks 840 in diagrams to other files, and launch them directly from the diagram. This is
an alternative method to that described here.

Field/Button Use to

File Path Type in or browse for the directory path and name of the file.

Type Display the local file or web address.

Last Write Display the date and time the file was last updated.

Size Display the size of the file.

Notes Type in free text about the file.

Files Display the list of linked files.

Launch Open the selected file. Local files open with their default application and
web files open in the default browser.

© 1998-2010 Sparx Systems Pty Ltd

 508 Modeling Fundamentals | Elements

4.6.1.1.8 Tagged Values Tab

The Tagged Values tab of the element Properties dialog simply provides the Tagged Values 632 window within
the frame of the Properties dialog.

4.6.1.2 Properties Docked Window

Access: View | Element Properties.
The Properties window provides a convenient way to view (and in some cases edit) common properties of
elements. When an element is selected, the Properties window shows the element's name, stereotype,
version, author, dates and other pertinent information.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 509

Tip:
The Properties window can be a quick method of setting a single property (such as Phase or Status). To
access and edit all properties of an element, double-click on the element in a diagram or in the Project
Browser.

Properties Sections
The Properties window is divided into three expandable sections:
· <Element type> Settings - for the basic element details
· Project - for general housekeeping settings
· Advanced - only active for generalizable elements.

Notes:
· When you click on a field name, a brief explanation of that field displays at the bottom of the Properties
window, unless you have selected the Hide Properties Info Section 352 checkbox on the General page of
the Options dialog (as for the above screen illustration).
· If you click on the field value for an editable field, a drop-down arrow displays that enables you to select a
different value.

© 1998-2010 Sparx Systems Pty Ltd

 510 Modeling Fundamentals | Elements

4.6.1.3 The Element Browser

Access: View | Element Browser, or right-click on the Main Menu bar and select the Element Browser
context menu option.
The Element Browser window lists a range of added-on properties of the selected element, as shown below
both collapsed and fully expanded.

Enterprise Architect User Guide

Modeling Fundamentals | Elements 511

© 1998-2010 Sparx Systems Pty Ltd

 512 Modeling Fundamentals | Elements

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 513

The following properties are listed, where they are present in the element:
· Operations 569
· Attributes 558
· Linked Features (Linked Operations and Attributes) 611

· Tagged Values 632

· Constraints 488
· Internal Requirements 485 (Responsibilities)
· Attached Files 507
· Relationships 489
· Scenarios 490
· Maintenance Items 1558
· Testing Items 1537
· Project Management Items 312 . 313

Notes:
· If you double-click on the element name at the top of the dialog (the root node) the Properties dialog for the
element displays, at the General tab.
· If you right-click on a folder name, the Edit <object> context menu option displays. When you select this
option, the appropriate window or dialog displays, or the element Properties dialog displays the appropriate
tab, to enable you to update the items in the folder.
· If you double-click on an item within the Requirements, Scenarios or Constraints folders, the docked
window or view 514 displays with the focus on the selected item.
· If you double-click on an item within the Relationships folder, the relationship Properties 626 dialog displays
for that relationship.
· If you double-click on an item within the Files folder, the file opens either on a separate tab in the Diagram
View workspace (if the file can be opened within Enterprise Architect) or in the default Windows viewer/
editor for the file type (if the file cannot be opened within Enterprise Architect).
· If you double-click on an operation or attribute in the Operations or Attributes folders, the appropriate
Properties dialog displays.
· If you right-click on an attribute or operation, whether in the Attributes or Operations folder or in the Linked
Features folder, a context menu displays that enables you to display the source code; alternatively, click on
the attribute or operation and press [Ctrl]+[E], or - in the Linked Features folder - double-click on the
attribute or operation.
· The source code viewer in which the source code displays depends on which editor you select as the
default 1337 , either for the project as a whole or for a specific programming language. If you select the
Enterprise Architect internal editor, the code displays in the Source Code Viewer 1441 with the cursor
positioned on the selected feature.
· The right-click context menu for an operation also provides options to set a number of types of recording
marker 1499 .

4.6.1.3.1 Generate Scenario From Activity Diagram

You can generate a range of diagrams 499 from a scenario in an element.
Conversely, you can also generate a structured scenario within an element from an Activity diagram, reverse
engineering the steps from the diagram elements (effectively either regenerating the scenario within the Use
Case, or transferring a scenario into another Use Case).

Notes:
· The source Activity diagram must be generated from another Use Case Scenario.
· Any existing scenario steps are deleted and replaced by the generated scenario.
· This facility does not operate on the enhanced Activity diagrams generated from a Use Case - those
generated with ActivityParameters, Actions and Action Pins.

To generate the scenario from the Activity diagram, follow the steps below:

© 1998-2010 Sparx Systems Pty Ltd

 514 Modeling Fundamentals | Elements

1. Open the element Properties dialog, select the Scenarios tab, and select the Structured Specification
tab.
2. Right-click in the empty space within the tab, and select the Create Structure From Generated
Activity Diagram context menu option. The Select an Activity 515 (generated from a UseCase
Scenario) containing the Diagram dialog displays.
3. Search for and select the Activity containing the required diagram. Enterprise Architect validates the
diagram (displaying the results in the Output 102 window) and, if the diagram is valid, generates the
scenario steps in the Structured Specification tab (replacing any existing scenario steps).

4.6.1.4 The Scenarios & Requirements Window

Access: View | Scenarios & Requirements.
The Scenarios & Requirements window provides a convenient way to quickly add, view, edit and delete rules
applied to an element.
The window shows details of the entities that impose such rules or restrictions on the element, namely:
· The element's internal responsibilities or requirements
· The element's internal constraints (not external Constraint 785 notes)
· The element's scenarios.
The Scenarios & Requirements window is typically used to examine Use Case and Test Case elements, and
any other elements that realize an external Requirement.
For convenience, you can display the window as either a dockable window around the edge of your
workspace, or as a view in the center of your workspace (in which the Scenarios, Constraints and

Requirements are shown on separate tabs). Use the icon in the window toolbar to toggle between these
display options.
To review an internal requirement, constraint or scenario for an element:
1. Select the element in the Project Browser or diagram and either press [Ctrl]+[Shift]+[3] or select the
View | Scenarios & Requirements menu option; the Scenarios & Requirements window displays.

2. Either:
· Click on the required item in the list panel on the left of the window, or

· If the Element Browser 510 is not already displayed, click on the icon and select the required
item from the Constraints, Requirements or Scenarios folder.
The appropriate screen displays, with the details of the selected item in the fields.
3. The toolbar icons, from left to right, enable you to :

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 515

· Add a new rule to the current screen (click on the appropriate folder to create an item of a different
type)
· Save the new or edited item
· Save the current (edited) item as a new item
· Delete the current item
· Sort the contents of the selected folder into alphabetical order
· (Print icon unavailable)
· Display the Element Browser window, or highlight the current item in the Element Browser window
· Switch between a docked window display and a workspace view display.
You can also add or edit formatted notes in the Notes field, using the Notes 642 toolbar at the top of the
field.
The list panel also provides a context menu that provides options for adding a new item to a folder, deleting
the selected item or, for a requirement, converting an internal responsibility into an external Requirement 926
element.
Click on these links for information on the fields of the Scenarios 490 , Constraints 488 and Requirements 485
tabs.

4.6.1.5 Select <Item> Dialog

The Select <Item> dialog is a multi-purpose browser and search tool for locating model items such as
Classifier elements, properties, attributes and behaviors.
The <Item> in the dialog title changes to represent the type of item the original operation is working on. The
dialog is called in a range of operations; for example, setting:
· The base type or classifier 520 for an Object 823 , Swimlane 450 or Lifeline 783

· Classifiers for the return types 570 for operations

· Classifiers for generalization sets 620
· The associated behavior for a behavior call 582
· The type and return type for operation parameters 593
· Activities for State transitions 892
· Activities from which to generate Use Case Scenarios 513
· Pattern element defaults 904
· The values of Tagged Values 635 .

To select a required item, follow the steps below:

1. During an operation, when it is necessary to locate an element or feature, you click on the [ ... ]
(browse) button. The Select <Item> dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 516 Modeling Fundamentals | Elements

2. If required, in the Go To Namespace field select a namespace to reduce the scope of the displayed
hierarchy. The dialog opens the section of the hierarchy associated with that namespace, and closes all
previously-open sections associated with other namespaces.
3. You can either:
· expand the selected area of the hierarchy on the Browse tab, or any other package, and locate the
required item (go to step 5) or
· click on the Search tab and, in the Find field, type a partial or complete text string to search for the
item.

4. On the Search tab, you can filter the search further by selecting the Whole Word and Match Case
checkboxes.

Each list entry shows the name of the item, the type, any stereotype the item has, the immediate
package in which the item is held, and any successive parent packages (the package path). You can
either:
· Select the item immediately on the Search tab or

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 517

· Right-click on one item or a group of items and select the Locate item(s) in tree context menu
option; this redisplays the Browse tab and highlights each selected item in the <namespace>
hierarchy.
5. Click on the required item.
6. Click on the OK button.

Note:
When you have selected an item, the Select <Item> dialog retains the context and item. Next time you
display the dialog, if the context is similar the dialog opens to the same Namespace and item. For example, if
you have selected an activity for a State transition and you start to do the same for another transition, the
dialog opens to the activity you previously selected.
If the context is totally dissimilar, the dialog opens with the Namespace <any> and a collapsed model
hierarchy.

If the available items do not meet your requirements, you can create a new item and define the appropriate
properties. Click on the Add New button. The appropriate Add <Item> dialog displays, on which you define the
required item.

Note:
The Add New button is not always available, depending on the context and the type of item being searched
for.

Multiple Selection
Where an operation permits the selection of multiple items, the Select <Item> dialog is automatically enabled
to support this. To select the items, press [Ctrl] as you click on each item. Having selected an item, you can
continue to expand and browse the hierarchy, and/or search for items; the dialog retains the existing
selections until you click on the OK button.

4.6.1.5.1 Select Property Dialog

The Select Property dialog is a specific instance of the Select <Item> 515 dialog; it is used to select Ports,
Parts, Attributes and Association Ends as redefined or subsetted properties, from a hierarchical list of Classes
and their contained properties in the model.
For example, consider the section of the model below:

© 1998-2010 Sparx Systems Pty Ltd

 518 Modeling Fundamentals | Elements

This would be represented in the dialog as follows:

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 519

Note:
Association ends should be owned by the Class to be listed in the dialog.

Locate and click on the required object to select it, then click on the OK button. (To select several objects at
once, press and hold [Ctrl] while you click on each object.)

4.6.2 Object Classifiers

Many elements model classifications (such as Classes and Actors), whilst other elements model instances of
such classifications (such as Objects, Actors again, and Sequence diagram objects). These instance elements
represent real things in a run-time scenario; for example, a Person element named Joe Smith. In UML this is
written as Joe Smith: Person.
You can define a classifier first, and then instances of that classifier. Alternatively, as a model develops from a
rough sketch to a detailed design, many objects become examples of a defined Class, so in the early analysis
phase you might model a Joe Smith and a Jane Smith, and later a Person Class from which Joe and Jane are
instantiated.
Enterprise Architect enables you to associate an Object with its template element (its classifier), such as a
Class. Doing this greatly increases the descriptive power of the model in capturing the functionality and
responsibility of Objects at run-time and their associated state. For example, if you describe a Person Class
with attributes such as Age, Name, Address and Sex, and functions such as GetAge and GetName, then when
you associate your Object with the Person Class it is seen to have all the Person Class behavior and state (as
well as inherited state and behavior from Person's ancestors).

© 1998-2010 Sparx Systems Pty Ltd

 520 Modeling Fundamentals | Elements

Tip:
This is a powerful means of moving your model from the analysis phase into detailed design.

Elements that are classifiers and support instances of themselves at runtime can be dropped from the Project
Browser as a link to the classifier itself, or a new instance of the classifier. The example below shows a linked
Node element on the left and an instance of the Node on the right. Note that the instance is drawn like a
simple element with the : <ElementName> displayed. If you name your instance it displays <InstanceName> :
<ElementName>.

4.6.2.1 Using Classifiers

If you right-click on an Object in a diagram, the element context menu displays the Advanced | Instance
Classifier menu option. Select this option to choose a single element (generally a Class) as the classifier or
template for this Object.
The Select <Item> 515 dialog displays. Use this to set the instance classifier.
The Object name is then displayed as Object: Classifier; for example a Person object named Joe Smith is
displayed as Joe Smith: Person.

Several Changes Occur if an Object has a Classifier

It is important to remember that an Object is only an instance of a classifier at runtime, so the appropriate
attributes and operations are those of the classifier, not the Object. Therefore, in the context menu for the
Object, if you select the Attributes or Operations menu options, the Attributes or Operations dialog displays
for the classifier, not the Object.
If you set the classifier for an Object in a Sequence diagram, when you add a message the drop-down list of
available messages derived from the target Object come from the classifier, not the Object selected. This
enables you to associate Sequence diagram objects with Classes and use the defined behavior of the Class
to model actual behavior at run time.
You can also select a message for a State Flow connector. The same rules apply as for Sequence diagram
objects.
Note that in the Message dialog you can also select to include messages defined in the target classifier's
inheritance hierarchy.

4.6.3 Visual Representation

Each UML element has a default representation. However, you can:
· Change the appearance 521 , features, position and - for some elements - orientation through a number of
toolbars
· Display or hide various types of information held in the element, in compartments 521 .

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 521

4.6.3.1 Element Icons

When you add an element to a diagram, or select an existing element, a number of small icons display off the
right hand side of the element, underneath the Quicklinker arrow. For example:

or

These icons display small versions of the diagram toolbars or perform specific actions, to enable you to
quickly edit the element you have highlighted.

Icon Description

Rotates a Fork/Join element from vertical to horizontal and vice-versa.

Displays the Format 85 toolbar, for changing element appearance.

Displays the Current Element 84 toolbar, to edit the element's properties and features.

When multiple elements are selected, displays the Diagram 83 Toolbar for changing or aligning the
elements together.

Toggles an Activity Partition 756 between vertical and horizontal.

4.6.3.2 Compartments
In addition to the attributes and operations compartments shown in a Class element, Enterprise Architect also
supports other compartments that can optionally be displayed.
To set the visibility of the various compartments, see Feature Visibility 438 .

Tags Compartment
The tags compartment lists all Tagged Values for an element as entered in the Tagged Values 632 window.

Or, in the fully qualified 438 , expanded format:

Note:
The fully-qualified option operates only on those Tagged Values that were created in Enterprise Architect
release 7.1 or later. It does not expand Tagged Values created in earlier releases.

© 1998-2010 Sparx Systems Pty Ltd

 522 Modeling Fundamentals | Elements

Responsibility Compartment
The responsibility compartment shows a list of responsibilities as entered on the Requirements 485 tab of the
element Properties dialog.

Constraint Compartment
The constraint compartment shows a list of element constraints as entered in the Constraints 488 tab of the
element Properties dialog.

Testing Compartment
The testing compartment lists all of the tests associated with an element as listed in the Testing 1537 window
(select the View | Testing menu option).

Maintenance Compartment
The maintenance compartment lists all of the defects, changes, issues and tasks associated with an element,
as listed in the Maintenance 1558 window (select the View | Other Element Tools | Maintenance menu
option).

4.6.4 Element Tasks

This topic describes the following common tasks that you can perform on elements in Enterprise Architect:
· Create Elements 523
· Add Elements Directly to Packages 524
· Use Auto Naming and Auto Counters 525
· Set Element Parent 526
· Show Element Use 526
· Set Up Cross References 527
· Move Elements Between Packages 530
· Move Elements Within Diagrams 529
· Copy Elements Between Packages 531
· Change Element Type 532
· Align Elements 532
· Resize Elements 533
· Delete Elements 534
· Customize Visibility of Elements 535
· Create Notes and Text 536
· Link Note to Internal Documentation 537

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 523

· Set an Element's Default Appearance 538

· Get/Set Project Custom Colors 540
· Use Element Templates 542
· Highlight Context Element 543
· Make Linked Element a Local Copy 544
· Copy Features (Attributes and Operations) Between Elements 544

· Move Features Between Elements 545

Note:
In the Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Update Element 198 permission to update element
properties or delete an element.

4.6.4.1 Create Elements

Elements within a model are typically arranged on diagrams to visually communicate the relationships
between a given set of elements. Enterprise Architect provides simple mechanisms for creating elements in
the model, using diagrams or the Project Browser.

Create Elements on a Diagram

The fastest and simplest way to create elements directly on a diagram is to press [Spacebar] or [Insert] on
the diagram. This displays a list of elements and connectors that mirrors the current Toolbox pages; usually
these are the most appropriate elements and connectors for the diagram.

You can display and select from a longer list of elements by clicking on the Other option.
The following topics describe other approaches for creating elements on a diagram:
· Create Elements In Place Using the Quick Linker 475

· Create Elements Using the Toolbox 399

© 1998-2010 Sparx Systems Pty Ltd

 524 Modeling Fundamentals | Elements

· Create Elements Using the Diagram Context Menu 394

· Create a Group of Elements Using UML Patterns 901
· Create Domain Specific Elements from UML Profiles 907 .

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

Re-Use Existing Elements

Be aware that once you have created elements, you can re-use them by dragging them 430 from the Project
Browser and dropping them onto your diagrams.

Add Elements Directly to a Package

Sometimes it is useful to add elements to a package, without a diagrammatic representation. This can be
accomplished via the Project Browser window and is explained in the following topic:
· Add Elements Directly to a Package 524 .

See Also
· Behavioral Diagram Elements 742 - summary of all elements used in Behavioral diagrams
· Structural Diagram Elements 809 - summary of all elements used in Structural diagrams

4.6.4.2 Add Elements Directly To Packages

You can quickly add new elements to a package without the necessity of adding a diagram element at the
same time. This is particularly useful in defining a group of Requirements, Changes, Issues, base Classes or
other element types that might not require diagrammatic representation in the model.
To add a new element to a package, follow the steps below:
1. In the Project Browser, right-click on the appropriate package. The context menu displays.
2. Select the Add | Add Element menu option. The New Element dialog displays.

3. In the Name field, type the name of the element.

4. In the Type field, click on the drop-down arrow and select the element type.

Note:
The drop-down list is populated from one of the Toolbox page groups (including profile, Add-In and
MDG Technology groups). If the list does not represent the group containing the element you require,
click on the Select Group button and, from the list, select the appropriate Toolbox page group. The
drop-down list then shows the elements from that group.
The <default> group in the list contains a basic set of elements drawn from across the UML Behavioral
and Structural groups, and the Enterprise Architect Extended groups.

5. If required, in the Stereotype field either type the stereotype name or click on the drop-down arrow and

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 525

select the stereotype.

6. Select the Open Properties Dialog on Creation checkbox if the Properties dialog is to open
immediately after the element is created.
7. Deselect the Close Dialog on OK checkbox to add multiple elements in one session.
8. Click on the OK button to create the element.

Note:
If you have a diagram open, the Add to Current Diagram checkbox is available and defaulted to selected to
add the new element to the diagram. If you do not want the element in that diagram, deselect the checkbox.

4.6.4.3 Use Auto Naming and Auto Counters

The Auto Element Naming dialog enables you to configure automatic naming for any element type. Each
element can have separately configured automatic names and aliases.
To set up auto naming, follow the steps below:
1. Select the Settings | Auto Name Counters option from the main menu. The Auto Name Counters
dialog displays.

2. In the Type field, click on the drop-down arrow and select the element type (for example, Activity).
3. In the Name panel:
· In the Prefix field, type a prefix for the new name (optional).
· In Counter field, type the counter value; use as many 0's as required to pad the name.
· In the Suffix field, type a suffix for the new name (optional).
· If required, click on the Active checkbox to turn auto naming on for this element type.
4. In the Alias panel:
· In the Prefix field, type a prefix for the new alias (optional).
· In Counter field, type the counter value; use as many 0's as required to pad the alias.
· In the Suffix field, type a suffix for the new alias (optional).
· If required, click on the Active checkbox to turn alias auto naming on for this element type.
5. Click on the Save button.
New elements of this type now have an automatically-generated name and/or alias with an incrementing
counter value.

Note:
If an Alias is active then auto naming applies; however, to view the Alias in a diagram requires that the option
Use Alias if Available is selected in Diagram Properties. 425

© 1998-2010 Sparx Systems Pty Ltd

 526 Modeling Fundamentals | Elements

4.6.4.4 Set Element Parent

You can manually set an element's parent or an interface it realizes, using the Type Hierarchy dialog.
To set the element parent, follow the steps below:
1. Select a generalizable element in a diagram.
2. Select the Element | Advanced | Set Parents and Interfaces menu option. Alternatively:
· Press [Ctrl]+[I] or
· Right-click and select the Advanced | Parent context menu option.
The Set Parents and Interfaces dialog displays.

3. You can elect to enter a parent or interface name by either manually typing it in, or clicking on the
Choose button to locate the element within the current model.
4. Set the Type of relationship (Implements or Generalizes) from the drop-down list.
5. Click on the Add button to add the relationship.
6. Click on the Delete Selected button to remove the current selected relationship.

Note:
If Parents are not in the same diagram as their corresponding related element, the parentage is shown
in the top right corner of the child element, as shown below:

4.6.4.5 Show Element Use

You can display the use of an element using the Element Usage dialog. This lists all occurrences of the
element throughout the model, and enables you to easily navigate to any occurrence.
To show element usage, follow the steps below:
1. Select an element in a diagram.
2. Select the Element | Find in Diagrams menu option. Alternatively, press [Ctrl]+[U]. If the element
exists in other diagrams, the Element Usage dialog displays, listing all occurrences of the current
Enterprise Architect User Guide
 Modeling Fundamentals | Elements 527

element in diagrams in the model.

3. If you want to display the usage information in a more readable layout, you can resize the dialog and its
columns.

Either:
· Double-click on a line item to open the relevant diagram and display the selected element (the
Element Usage dialog remains open), or
· Click on the Open button to display the selected diagram and close the Element Usage dialog.

Note:
You can also access this feature from the Project Browser; select an element in the tree and select the
Element | Find in Diagrams menu option. If there is only one instance of the element in any diagram, that
diagram displays instead.

4.6.4.6 Set Up Cross References

It is possible to set up a cross reference (or Custom Reference) from one element in Enterprise Architect to
another. You can also view existing cross references on an element, using the Context References 506 tab on
the element's Properties dialog, or the Traceability 1253 window.
To set up a cross reference, follow the steps below:
1. In the Project Browser, locate the target element or diagram (that is, the object of the cross reference).
2. Open a diagram that contains the elements that are to have the currently selected element as a
reference.
3. Right-click on the element in the Project Browser. The context menu displays.
4. Select the Add custom reference menu option.
5. In the Set up references dialog, select the checkbox against each element to that is to have the target
element as a reference.
6. Optionally, in the Comment field, type some text to describe the purpose of the reference.

© 1998-2010 Sparx Systems Pty Ltd

 528 Modeling Fundamentals | Elements

7. Click on the OK button.

Use the Cross Reference

To use the cross reference, follow the steps below:
1. Select an element in a diagram.
2. Select the Element | Custom References menu option. Alternatively, either press [Ctrl]+[J], or right-
click on the element and select the Find | Custom References context menu option.
3. The Custom References dialog displays, showing a list of elements that have been set as cross
references for the selected element.

4. You can open the Properties dialog for an element by highlighting it and clicking on the Open button.
5. If you have a diagram cross reference, you can open that diagram.
6. If you have a string of diagram links, click on the Home button to return to the original diagram.

Note:
You can delete a cross reference by selecting it on the Custom References dialog and clicking on the Delete
button. Cross references are also automatically deleted if the source or target element in the reference is
deleted.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 529

4.6.4.7 Move Elements Within Diagrams

Any one of the following options enables you to move an element within a diagram. Select an element or
group of elements in the diagram view, then:
· Use the mouse to drag the element to the required position (the cursor switches to the four-arrow icon as
shown below)

· Hold down [Shift] and use the arrow keys to move the element by increments to the required position
· Use the Left, Right, Up and Down options in the Element | Move submenu
· Align multiple elements using the Element | Alignment submenu, the Alignment options in the right-click
context menu, or the Alignment buttons on the Diagram toolbar.

Confirm Possible Parent Elements

As you organize the elements within a diagram, you can drag any element over another and, provided the
dragged element is within and on top of the possible parent, it is always encapsulated by the lower element
and moved within the lower element. However, the lower element might not be a valid parent.
You can confirm that a possible parent element is able to accept a selected child element. When you drag the
child element over the potential parent, the target element border changes to a dashed line if it can accept the
selected element as a child. If the border does not change, the selected element cannot be a child to the
target element.

© 1998-2010 Sparx Systems Pty Ltd

 530 Modeling Fundamentals | Elements

Notes:
· The Support for Composite Objects checkbox must be selected on the Objects 362 page of the Options
dialog (select the Tools | Options | Objects option). If this option is not selected, the dashed border does
not show and the child element cannot be embedded on the parent in the diagram.
· Both elements must already exist on the diagram; an element border does not change if you drag a
potential child element over it from the Toolbox or Project Browser.
· The child element must have equal or higher z-order placement than the parent; that is, the parent element
must be level with or behind the child.
· The child element borders must be completely within the parent element borders.

For example, if you drag a Signal over a Class, the Class border changes; a Class element can be a parent to
a Signal. If you drag a Class element over a Signal element, the Signal border does not change. A Signal
cannot be a parent to a Class.
When you embed a child element on its parent, the child element becomes part of the parent element
hierarchy in the Project Browser. Similarly, if you drag the child element out of the parent, the child element
becomes independent and is no longer embedded in the parent element hierarchy.

4.6.4.8 Move Elements Between Packages

Elements and packages can be moved from one package to another by dragging and dropping the element to
the target destination in the Project Browser. Note that if you move a package, ALL the child packages and
their contents are moved to the new location also.
To move an element between packages, follow the steps below:
1. Click on the element in the Project Browser. (See Customer in the diagram below.)
2. Drag the element so that the cursor is over the target package icon. The element symbol (and, in some
operating systems, the element name) displays at the moving cursor position.)

3. Release the mouse button. The element is moved into the target package.

Tip:
You can also drag the element under a host element in the new package; for example, drag an element
under a Class.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 531

Notes:
· Moving an element has no effect on any relationships that the element might have.
· Moving an element in the Project Browser has no effect on the use of that element in any diagram.
· Moving a diagram generally does not affect the location of elements in packages. If you move a diagram
out of one package into another, all the elements in the diagram remain in the original package. However,
certain elements (such as Decision, Initial and Final elements) are used only within one diagram, have no
meaning outside that diagram, and are never re-used in any other diagram. Therefore, if you move a
diagram containing these elements, they are moved to the new parent package with the diagram.

Warning:
In a multi-user environment, if one person moves or updates the Project Browser structure, other users must
reload their project 267 to see the latest changes in the Project Browser. Although this is true of any addition
or modification to the tree, it is most important when big changes are made, such as dragging a package to a
different location.

4.6.4.9 Copy Elements Between Packages

Enterprise Architect enables you to quickly and easily duplicate one or more elements, including their child
elements and diagrams. You can insert a copy of an element under one or more other packages, in the same
.eap file or any other .eap file.

Notes:
· A copy of an element does not have the external cross references of the source element; that is:

· if one element is copied it has no connectors

· if more than one element is copied, only the connectors between the copied elements are retained
· however, if those elements come from a Sequence or Communication diagram and the diagram
itself is not copied, the message connectors between the copied elements are not retained.
· You cannot paste an element into a package that is locked 205 by another user or that is checked in 261 .
The Paste... option is grayed out in the context menu.

To copy elements, follow the step below :

1. In the Project Browser, select each required element, right-click on one of them and select the Copy
Element(s) to Clipboard context menu option (or click on a selected element and press [Ctrl]+[C]).
The Copy Element(s) to Clipboard dialog briefly displays until the copy operation completes.
To paste the copied elements, follow the step below:
1. In the Project Browser, right-click on the package into which to paste the copied elements, and select
the Paste Element(s) from Clipboard context menu option (or click on the package and press
[Ctrl]+[V]). The Paste Element(s) from Clipboard dialog briefly displays until the paste operation
completes.
The target package is expanded and the pasted elements are exposed in the Project Browser. If you are
pasting the elements within the same model as the copied source, the source parent package is also
collapsed.
If the target package already contains:
· an element of the same type with the same name as a pasted element, the pasted element name has the
suffix - Copy
· an element with the same name as the pasted element including the - Copy suffix, the suffix becomes -
Copy1 (or - Copy 2, - Copy3 and so on, as copies of the element accumulate in the target package)
You can keep the same element names as the source, or you can rename each element either by clicking
twice on it and editing the name in the Project Browser, or by double-clicking on it and editing the name in the
Properties dialog.

© 1998-2010 Sparx Systems Pty Ltd

 532 Modeling Fundamentals | Elements

4.6.4.10 Change Element Type

To change an element type, follow the steps below:
1. In the Diagram View, click on the element to change.
2. Select the Element | Advanced | Change Type menu option. The Select Element Type dialog displays.

3. In the Element Type field, click on the drop-down arrow and select the required element type.
4. Click on the OK button.
The target is transformed into the required type.

4.6.4.11 Align Elements

To align multiple elements, follow the steps below:
1. Select a group of elements by drawing a selection box around them all. (Or select them one by one by
holding down [Ctrl] and clicking on each element).
2. Right-click on the element in the group to align others to. The context menu displays.
3. Select the alignment function you require.
All selected elements are aligned to the one beneath the cursor.

Tip:
You can also use the Diagram toolbar.

The first four buttons are used to align elements, and are made available when more than one element is
selected in a diagram.
You can also select the Element | Alignment menu option.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 533

4.6.4.12 Resize Elements

Any one of the following options enables you to resize an element. Select an element or group of elements in
the diagram view, then:
· Use the resize handles that appear at each corner and side to resize the element(s) by dragging with the
mouse (the cursor switches to the double-ended arrow as shown below)

· Press and hold [Ctrl] and use the arrow keys to resize by increments as required
· Use the Wider, Narrower, Taller and Shorter options in the Element | Move submenu
· Autosize selected element(s) using the option in the Element | Appearance submenu, or by pressing [Alt]
+[Z]. (With multiple elements selected, Autosize also appears in the right-click context menu)
· Set multiple elements to the same height, width or both, using these options in the Element | Make Same
submenu, or the options in the right-click context menu.

Resize a Set of Objects to a Specific Size

If you right-click a selected set of objects, you can resize them to the same dimensions (height, width or both)
using the context menu. When you select multiple elements using [Ctrl]+click, then resize the dimensions, the
dimensions of the selected hatched object are used to set the dimensions of the other selected objects.
For example, in the diagram below, the Message Class height and width are used to set the height and width
of the Account and Message Folder Classes. The aim is to make the Account and Message Folder elements
the same height and width as the Message element.

To do this follow the steps below:

© 1998-2010 Sparx Systems Pty Ltd

 534 Modeling Fundamentals | Elements

1. Set one element to the required size (for example, Message as above).
2. Select all other elements (for example, Account and Message Folder as above).
3. Right-click on the pre-sized element (for example, Message).
4. Select your resizing option (such as same height, width) from the context menu.

See Also
· Highlight Context Element 543

4.6.4.13 Delete Elements

Delete an Element From a Diagram

Follow the steps below:
1. In the active diagram, click on the element to delete.
2. Either:
· Press [Delete], or
· Right-click to display the context menu and select the Delete <element name> option.

Note:
This does not delete the element from the model, only from the current diagram.

Delete an Element From the Model

Follow the steps below:
1. In the Project Browser, right-click on the element to delete. The context menu displays.
2. Select the Delete <element name> option. A confirmation prompt displays.
3. Click on the Yes button.
Alternatively:
1. Click on the element in the Project Browser and press [Ctrl]+[Delete].
The element is completely removed from the model.

Delete Multiple Elements From a Diagram

Follow the steps below:
1. In the active diagram, [Ctrl]+click on each element to delete.
2. Either:
· Press [Delete], or
· Right-click to display the context menu and select the Delete selected elements option.

Delete Multiple Elements From a Diagram and Model

Follow the steps below:
1. Open the diagram containing the elements to remove from the model.
2. Press [Ctrl]+[A] to select all of the elements in the diagram, or use [Ctrl]+click to select specific
elements.
3. Press [Ctrl]+[Delete] to completely remove the elements from the model.

Delete Multiple Elements from the Project Browser and Model

Follow the steps below:
1. In the Project Browser, press and hold either [Shift] or [Ctrl] and click on the required items.
2. To completely remove the elements from the model, either:
· Press [Ctrl]+[Delete], or
· Right-click on the selected items and select the Delete selected item(s) context menu option.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 535

Note:
If you delete an element in this way, you delete all its properties and connectors as well.

4.6.4.14 Customize Visibility of Elements

Some elements are hidden from view in packages and in RTF documents by default. These include Events,
Decisions, Sequence elements and Associations. You have the option of turning these elements back on.
For example, some Events and Decisions contained in a package do not appear in the package view, as in the
example below.

To show additional elements, follow the steps below:

1. Select the Tools | Options | Objects menu option. The Objects page of the Options dialog displays.
2. Click on the Advanced button. The Advanced Settings dialog displays.

3. Select the checkbox for each type of element to show in packages and in RTF documents.
4. Click on the Close button on each dialog.
5. Reload 267 the current diagram if required.
The package from the example above now shows the Event and Decision elements it contains:

© 1998-2010 Sparx Systems Pty Ltd

 536 Modeling Fundamentals | Elements

4.6.4.15 Create Notes and Text

You can create both notes and text on a diagram; the two are slightly different.

Create a Note
To create a note, follow the steps below:
1. Drag the Note icon from the Common page of the Toolbox onto the diagram.
· If you have the Edit Object On New 362 checkbox deselected on the Objects page of the Options
dialog (Tools | Options | Objects), the Note element displays on your diagram; type your note text
directly within the Note element

· If you have the checkbox selected, the Notes 641 window displays; type your text in that window. If
you want to display the Notes information in a more readable layout, you can resize the dialog.

You can format the text if necessary, using the Notes 642 toolbar at the top of the window. When you
have completed the text, click on the OK button to save it.

The Note text displays in the Note element.

Note:
You can also create a note by clicking on the New Note icon (the text page) on the UML Elements 83 toolbar
and clicking on the diagram.

Create Text
To create text, follow the steps below:
1. Drag the Text Element icon from the Common page of the Toolbox onto the diagram. The Notes 641
window displays.

2. Type your text in the window. If you want to display the Notes information in more readable layout, you
can resize the dialog.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 537

You can format the text if necessary, using the Notes 642 toolbar at the top of the window. When you
have completed the text, click on the OK button to save it.
Your text displays on the diagram in the following format, with no border:

4.6.4.16 Link Note to Internal Documentation

It is possible to connect a Note element to another element's internal documentation. This enables you to
externalize model documentation to the diagram level, and as Enterprise Architect keeps the note and the
internal structure in synch, you do not have to worry about updating the note contents; this is done
automatically.
In the example below, two notes are connected into an element's internal structures. One is connected to an
attribute, and displays the attribute name and notes. The other is connected to a constraint, showing the
constraint name and documentation.

Procedure
To connect a Note element to a feature of another design element, follow the steps below:
1. Click on the element and then click on the feature to link the note to.
2. Select the Element | Inline Features | Create Linked Note context menu option. This creates a Note
element linked to the selected feature, reflecting the content of that feature.
Alternatively:
1. Insert the target element into a diagram.
2. Drag the Note icon from the Common page of the Toolbox onto the diagram, next to the target element.
The Notes dialog displays. Do not type any text, just click on the OK button.
3. Click on the Note Link icon from the Common page of the Toolbox, click on the Note, and drag across
to the target element to create the connector.
4. Right-click on the Note Link to display the context menu.
5. Select the Link this Note to an Element Feature menu option. The Link note to element feature dialog
displays.

© 1998-2010 Sparx Systems Pty Ltd

 538 Modeling Fundamentals | Elements

6. In the Feature Type field, click on the drop-down arrow and select the type of feature to link to.
7. In the Feature list, click on the specific feature to link to.
8. Click on the OK button.
The note now automatically derives its contents from the target element.

4.6.4.17 Set an Element's Default Appearance

You can set the global appearance of all elements throughout a model, using the Options dialog. Select the
Tools | Options menu option, then select Standard Colors 353 and Diagram | Appearance 356 from the
options tree.
To override the global appearance and define a default appearance for a specific element on all diagrams on
which it is found, right-click on the element and select the Appearance | Default Appearance context menu
option. The Default Appearance dialog displays.
To change the appearance of an element on the current diagram only, use the Format 85 toolbar. If the
Format toolbar is not displayed, select the View | Toolbars | Format Tool menu option.

Note:
You can adjust several elements at the same time. Select all of the required elements, right-click on one of
them and select the Default Appearance context menu option, or use the Format toolbar.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 539

Change a Background, Font or Border Color

To reset the background color, font color or border color, follow the steps below:
1. On the Default Appearance dialog, select the Background Color, Font Color or Border Color radio
button as appropriate.

Note:
You have further options for changing the font of element text in the Set Font 556 menu option.

2. Deselect the Use Default Color checkbox, to enable the Select button.
3. Click on the Select button. The Color dialog displays.

4. Select the required color (click on the Define Custom Colors>> button and define a specific color if
necessary) and click on the OK button. You return to the Default Appearance dialog, on which the
Preview panel indicates the selected color for the element.

Note:
To change to a different color, click on the Select button again, or to return to the default color, select
the Use Default Color checkbox.

5. Click on the OK button. The new color is applied to the selected element or elements.

© 1998-2010 Sparx Systems Pty Ltd

 540 Modeling Fundamentals | Elements

Change the Border Thickness

To change the border thickness, follow the steps below:
1. On the Default Appearance dialog, in the Border Thickness field, type the number of points to apply.
Alternatively, click on the scroll arrows to increase or decrease the number.

The Preview panel indicates the effect of the change in border thickness.

2. Click on the OK button. The new border thickness is applied to the selected element or elements.

4.6.4.18 Get/Set Project Custom Colors

If more than one person is working on a project, each person might want to use specific colors for elements
within the project. The Settings | Colors | Set Project Custom Colors and Get Project Custom Colors
options enable you to set specific colors and subsequently get the colors in a different session, without having
to remember RGB values.

Set a Project Custom Color

Follow the steps below to set your project's custom colors:
1. Select an element to be colored.
2. Select the Element | Appearance | Default Appearance... menu option. The Default Appearance
dialog displays.

3. Deselect the Use Default Color checkbox to enable the Select button.
4. Click on the Select button. The Color dialog displays.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 541

5. Click on the Define Custom Colors » button.

6. Create the color in the color mixer panel on the right of the dialog.

7. Click on the Add to Custom Colors button to add the color to the Custom colors blocks on the left
hand side of the dialog.

8. Click on the OK button to close the Color dialog, then click on the OK button to close the Default
Appearance dialog.
9. Select the Settings | Colors | Set Project Custom Colors menu option to save the custom color you
have created.

© 1998-2010 Sparx Systems Pty Ltd

 542 Modeling Fundamentals | Elements

Get a Project Custom Color

To get your project's custom colors, follow the steps below.
1. Select the Settings | Colors | Get Project Custom Colors menu option. This applies any saved
custom colors to this project.
2. Click on an element to be colored and select the Element | Appearance | Default Appearance menu
option. The Default Appearance dialog displays.
3. Deselect the Use Default Color checkbox to enable the Select button.
4. Click on the Select button to view the applied custom colors (as listed at step 7, above).
5. Click on the required color and click on the OK button to close the Color dialog, then click on the OK
button to close the Appearance dialog. The element changes to the selected color.

4.6.4.19 Set Element Templates Package

In building up a model, you might want to represent or emphasize certain characteristics of elements in the
appearance of those elements, or select particular display options as standard. For example, you could make
new Interface elements a different default color to new Class elements, ensure all new Activity Partitions are
vertical rather than horizontal, or set a specific group of display options for new diagrams. You could also
define a set of characteristics to use for each development stage of a project.
To do all this, you create a diagram with all the characteristics you require, and store it in an element
Templates package. Enterprise Architect then checks this folder whenever you start to create an element in a
diagram and, if it finds a template for that diagram type, applies the settings in that template to the new
element or to the display options of the diagram. For example, you could save a diagram under the name
ClassTemplate, to apply a set of display characteristics to all new Class elements.
You should create the Templates package in an administrative View of the project file, rather than in any work
area. This prevents the package from being changed or lost in any project development work.
There are two other ways in which you can modify the appearance of elements in diagrams:
· You can define the default appearance of elements (and other structures) grouped in a diagram by using
UML Profiles 906 . These provide a means of extending the UML Language, which enables you to build UML
models in particular domains. They are based on additional stereotypes and Tagged Values that are
applied to elements, attributes, methods, connectors, connector ends and so on.
· You can modify the appearance of elements (and connectors) of a specific type using stereotypes 895 .
Stereotypes take precedence over templates; if you drop an unstereotyped element - a Class, for example
- onto a diagram, Enterprise Architect searches the Templates package for a Class diagram that defines an
unstereotyped Class, and applies that definition to the new Class. If you drop a stereotyped Class onto a
diagram, the stereotype defines the Class appearance so the template is not accessed. Stereotypes are
much more flexible for defining the appearance of an element under different scenarios.

Procedure
To set up the element Templates package, follow the steps below:
1. Create a new package in the appropriate administration View. You can give this package any name;
Templates is an unambiguous option.
2. Within the Templates package create new diagrams, one for each type of diagram to template. Give
them easily recognized names; for example ClassTemplate for the template for Class diagrams.
3. Add new elements to the template diagrams from the Toolbox and configure the size, appearance,
notes, version and other properties.
4. Select the Settings | Template Package menu option to set the templates as the default element
templates. The Browse Project window displays.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 543

5. Locate and click on the Templates package, and click on the OK button to set the package as the
default element template.
Now each new element you add to your project is created with the settings from the appropriate Template
diagram.

Note:
If you decide not to use the default element template, set the default element template to <none> in the
Browse Project window. The <none> package is at the bottom of the hierarchy shown in the Browse Project
window.

4.6.4.20 Highlight Context Element

You can show a hatched border around a selected element by selecting the Always Highlight Context
Element checkbox on the Diagram Behavior page of the Options dialog (select the Tools | Options |
Diagram | Behavior menu option). If you have selected this checkbox, the selected element displays similarly
to the following example:

If you have not selected the Always Highlight Context Element checkbox, the selected element does not
have a hatched border around it.

Multiple Selections
Whether you have selected the Always Highlight Context Element checkbox or not, if you select multiple
elements one of the elements you select always has a hatched border. If you align the elements, this element
is the one used to align the other elements against.
For example, if the elements in the diagram below are aligned, the top element aligns to the bottom element
(the element showing a hatched border).

© 1998-2010 Sparx Systems Pty Ltd

 544 Modeling Fundamentals | Elements

Change the Element to Align Against

To change which element has a hatched border in a selected group (and thus the element that is aligned with)
click on the element that the other elements are to align with.

4.6.4.21 Make Linked Element a Local Copy

To convert a linked element to a local copy, follow the steps detailed below:
1. Open the diagram with the linked element.
2. Select the linked element and right-click on it to display its context menu.
3. Select the Convert Linked Element to Local Copy menu option.
The element changes to a local copy and is placed in the appropriate package.

4.6.4.22 Copy Features Between Elements

Using drag and drop, you can copy attributes 558 and/or operations 569 from an element in the Project Browser
on to another element in a diagram.
To move attributes and operations, see Move Features Between Elements 545 .

Copy an Element Feature

To copy an element feature, follow the steps below:
1. Open a diagram that contains the target element (in the example below, the AccountItem Class is the
target and Customer element is the donor).
2. Click on the attribute or operation and drag to the target element.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 545

3. Release the mouse button.

The image below shows AccountItem after the attribute Account has been dropped from the browser on to it.

Copy Multiple Element Features

To copy multiple element features, follow the steps below:
1. Open a diagram that contains the target element (in the example above, the AccountItem Class is the
target and Customer element is the donor).
2. Hold down [Ctrl] (separate features) or [Shift] (select a range) and click on the attributes and/or
operations to copy, then drag the selected features to the target element.
3. Release the mouse button.

4.6.4.23 Move Features Between Elements

Using drag and drop, you can move attributes 558 and/or operations 569 from an element in the Project
Browser on to another element within the Project Browser.
To copy attributes and operations, see Copy Features Between Elements 544 .

To move element features, follow the steps below:

1. In the Project Browser, locate the attributes and/or operations to move from the target element and
select them while holding down [Ctrl] (single item select) or [Shift] (multiple item select).

© 1998-2010 Sparx Systems Pty Ltd

 546 Modeling Fundamentals | Elements

2. Holding down the mouse button, drag the attributes and/or operations to the target element. A single
feature symbol (and, under some operating systems, the feature name) displays during the move;
however all of the selected features are moved.

3. Release the mouse button. The image below shows the final stage of the attribute and operations move
between the Class element and the Account element.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 547

4.6.5 Element Context Menu

Right-click on a single element in a diagram to open the element context menu. If two or more elements are
selected, a different, multiple selection context menu 557 is displayed.
The element context menu is split into a number of sections and submenus:
· Properties 548
· Add 550
· Find 552
· Transform [Ctrl]+[H] - Transform 1387 the selected element from one domain to another
· Embedded Elements 552
· Features 554
· Generate DDL - Generate DDL 1367 for a table, procedure or view Class
· Code Engineering 554
· Appearance 555
· UML Help - display the Enterprise Architect Help topic for the UML element type
· Delete [Ctrl]+[D] - delete the element.

Note:
Context menus vary between element types. The Code Engineering options won't display for a Use Case
element, for example.

Example Context Menu for a Class: Example Context Menu for an Activity:

© 1998-2010 Sparx Systems Pty Ltd

 548 Modeling Fundamentals | Elements

4.6.5.1 Properties Menu Section

The Properties section of the element context menu can contain the following options:

Menu Option & Function Keys Use to

Properties [Ctrl]+[Enter] Open the Properties dialog 481 for the selected element.
For State Lifeline and Value Lifeline elements, display the Configure
Timeline 697 dialog.

Advanced Open the Advanced 549 sub-menu.

Rule Composer For a Rule Task element, invoke the Rule Composer 945 tab in Business
Rule Modeling.

Other Properties For State Lifeline and Value Lifeline elements, display the Properties
dialog 481 for the selected element.

Create (or Edit) Linked (Corporate, Business and Software Engineering, Systems Engineering
Document [Ctrl]+[Alt]+[D] and Ultimate editions) Create 599 an RTF document linked to the
element.

Delete Linked Document Delete an existing linked document for the element.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 549

4.6.5.1.1 Advanced Submenu

The Advanced submenu on an element context menu can contain the options listed in the table below.

Notes:
· Context menus vary between element types. Not all menu options shown here are present on all element
context menus; for example, the Partition Activity option only displays for an Activity element.
· If an element appearance is overridden by a Shape Script 1147 , several of the appearance options are
disabled; for example, Use Rectangle (Circle) Notation.

Menu Option & Function Use to

Keys

Custom Properties Open the Custom Properties 550 dialog.

[Ctrl]+[Shift]+[Enter]

Parent [Ctrl]+[I] Set the element parent 526 .

Instance Classifier [Ctrl]+[L] Set the instance classifier 515 for the element, on the Select <Item> dialog.

Classifier Properties Open the Properties 481 dialog for the classifier of the selected element.
[Ctrl]+[Alt]+[Enter]

Make Composite Set the element as a Composite element 837 .

Change to State (Value) Switch one type of Lifeline element to the other.
Lifeline

Show Composite Diagram Display a mini-picture of the contents of a composite element within that
element.

Multiplicity Define the multiplicity for the element, using the format defined on the
Cardinality 665 tab.
This is the number of instances of the element that can exist in a set. The
value displays on the element in a diagram, in the Name compartment.

Edit Extension Points For an extended Use Case, display the Use Case Extension Points 807
dialog, which you use to insert the point at which the behavior should be
inserted.

Association Class Connect the Class to a new Association 857 (if the element is a Class).

Use Rectangle (Circle) Use rectangle notation 808 for the element.
Notation

Partition Activity Define an Activity Partition 756 .

Set Run State Add a new instance variable to the element using the Define Run State 824
dialog.

Set Property Value (Part elements) Set the property value for the Part, using the Set Property
Values dialog.

Override Attribute Pre-define initial values for attributes that can be used to override existing
Initializers defaults.
[Ctrl]+[Shift]+[R]

Convert to Instance Convert this classifier to an instance or a property, depending on the type of
(Property) classifier selected (for example, SysML classifiers are always converted to
properties).

Convert Linked Element To Convert the occurrence of the element on this diagram from a link to the
Local Copy original element to a local copy of the element.

© 1998-2010 Sparx Systems Pty Ltd

 550 Modeling Fundamentals | Elements

Menu Option & Function Use to

Keys

Make Sender/Receiver Toggle the element from a sender to a receiver and vice versa.

Accept Time Event Change the notation for an Accept Event action to an Accept Time Event
action.

Set Object State [Ctrl] Set the state of an object 824 /instance based on the child states of its
+[Shift]+[S] classifier.

Define Concurrent Define a set of substates 681 that can be held simultaneously within that
Substates composite state.

Use State Label Notation Display State Label Notation for a State object (the element name is
displayed on a box on top of the element rather than inside it).

Deep History Change the type of a shallow History pseudo-state to a deep History.
Applies only when right-clicking on a History 777 pseudo-state.

Set Attached Links Attach the selected Note element 612 to a connector, or several connectors.

Link to Diagram Note Display the diagram notes as the Note element text. The option simply
deletes any current text and blocks the Note from being edited other than
through the Notes field in the diagram Properties dialog.

4.6.5.1.2 Custom Properties Dialog

Certain elements and connectors feature the Custom Properties option in their context menu. The following
example shows the Custom Properties dialog for an Activity element. Properties differ between the various
types of element or connector.

As shown above, you can change the values of properties either by selecting the value from the property's
drop-down list or by typing the value in the field to the right of the property.

4.6.5.2 Add Submenu

The Add submenu enables you to add supporting elements and diagrams to the selected element.

Menu Option Use to

Tagged Value Add a Tagged Value 634 .

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 551

Menu Option Use to

Related Elements Open the Insert Related Elements 551 dialog.

Note Create and attach a blank Note 536 element to the current element.

Constraint Create and attach a blank Constraint 785 element to the current element.

Activity Add an Activity 753 element as a child of the current Classifier 519 element,
with either an Activity diagram or an Interaction Overview diagram.

Interaction Add an Interaction 779 element as a child of the current Classifier element,
with either a Sequence diagram, a Communication diagram or a Timing
diagram.

State Machine Add a State Machine 796 element as a child of the current Classifier element,
with a State Machine diagram.

RuleFlow activity For a Class element, create a Rule Flow Activity 939 element with a child
Rule Flow diagram, as a behavior for the Class.

Add Diagram Add a child diagram to the Classifier element, using the New Diagram 422
dialog.

Note:
Not all menu options shown here are present on all element context menus. Context menus vary between
element types. The options relating to Classifiers, for example, are not available for Object elements.

4.6.5.2.1 Insert Related Elements

The Insert Related Elements dialog can be accessed from the Add | Related Elements option on most
element context menus. This dialog enables you to insert connected elements from elsewhere in the model
into the current diagram.

You can specify the following details:

Option Use to

Insert elements to: «x» Select the level down to which to insert connected elements, between levels
levels 1 and 5.
You can select levels 4 or 5 to see how far the element/relationship
hierarchy extends, but as this can produce a complicated and tangled
diagram, it is better to use level 1 or 2 on selected elements in turn.

© 1998-2010 Sparx Systems Pty Ltd

 552 Modeling Fundamentals | Elements

Option Use to

For Link Type Select a type of connector to limit the inserted elements to those connected
by that relationship type.

With Link Direction Select whether the connectors are to be a single direction or bi-directional.

Limit to Element Type Select a type of element to limit the inserted elements to those of that
element type.

Layout Diagram When Select whether Enterprise Architect should layout the diagram after the
Complete elements have been inserted. The layout applied is the Digraph 465 layout.

Note:
If no elements have been added, this option has no effect. Elements have
to be added for Enterprise Architect to adjust the layout.

Limit to this Namespace Select a specific namespace from which the inserted elements are to come.

4.6.5.3 Find Submenu

The Find submenu on the element context menu can contain the following options:

Menu Option & Function Keys Use to

In Project Browser [Alt]+[G] Highlight the currently selected element in the Project Browser.

Locate Classifier In Project Highlight the classifier for the currently-selected object, in the Project
Browser [Ctrl]+[Alt]+[G] Browser.

Locate Operation in Project Highlight the call operation for the currently-selected Activity 744 , in the
Browser [Ctrl]+[Alt]+[G] Project Browser.

In Diagrams [Ctrl]+[U] Open the Element Usage 526 dialog.

Custom References [Ctrl]+[J] Set up Cross References 527 .

Add to Favorites Add the element to the Favorites folder 669 in the Resources window.

4.6.5.4 Embedded Elements Submenu

The Embedded Elements submenu on the element context menu can contain the following options:

Menu Option Use to

Add Port Add an embedded Port to the element.

Add Required Interface Add an embedded Required Interface to the element.

Add Provided Interface Add an embedded Provided Interface to the element.

Add Action Pin Add an embedded Action Pin to the element.

Add Expansion Node Add an embedded Expansion Node to the element.

Add Object Node Add an embedded Object Node to the element.

Add Activity Parameter Add an embedded Activity Parameter to the element.

Add Entry Point Add an embedded Entry Point to the element.

Add Exit Point Add an embedded Exit Point to the element.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 553

Menu Option Use to

Embedded Elements Open the Embedded Elements 553 window.

Show Realized Interfaces Display each interface directly realized 452 by a Class.

Show Dependent Interfaces Display each dependency relationship for that model element as a
lollipop style node attached to its left-hand side.

Note:
Not all menu options shown here are present on all element context menus. Context menus vary slightly
between element types. Of the Add options, only Add Port displays for a Class element, for example.

4.6.5.4.1 Embedded Elements Window

The Embedded Elements dialog enables you to embed particular elements into other elements. For example,
a Port can be embedded into a Class. The Embedded Elements option is available on the context menu of
some elements.

In the Embedded Elements dialog, click on the New button to create a new embedded element. Enter details
such as type, name and stereotype, and click on the OK button. The embedded element now shows on the
primary element as shown below.

© 1998-2010 Sparx Systems Pty Ltd

 554 Modeling Fundamentals | Elements

You can add as many embedded elements as necessary. Modify or delete embedded elements using the
Embedded Elements dialog.
To incorporate inherited or owner properties, select the Show Owned/Inherited checkbox.

The name of the embedded element is a label, which you can edit using the Labels 452 context menu.

4.6.5.5 Features Menu Section

The Features section of the element context menu can contain the following options:

Menu Option & Function Keys Use to

Attributes Open the Attributes 558 dialog.

Operations Open the Operations 570 dialog.

Feature Visibility Open the Feature Visibility 438

[Ctrl]+[Shift]+[Y] dialog.

Note:
Not all menu options shown here are present on all element context menus. Context menus vary slightly
between element types. The Attributes and Operations options won't display for an Action element, for
example.

4.6.5.6 Code Engineering Menu Section

The Code Engineering submenu on the element context menu can contain the following options:

Menu Option & Function Keys Use to

Generate Code [F11] Generate source code 1309 for the selected element (forward
engineer).

Synchronize With Code [F7] Reverse engineer source code 1328 for the selected element.

View Source Code [F12] Open the source editor 1441 if a file exists for that selected element.

Create Workbench Instance Create a workbench instance 1521 for the Debug Workbench (if a
[Ctrl]+[Shift]+[J] debug command has been configured for the parent package).

Note:
Not all menu options shown here are present on all element context menus. Context menus vary slightly
between element types. These Code Engineering options won't appear for a Use Case element, for example.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 555

4.6.5.7 Appearance Menu Section

The Appearance section of the element context menu can contain the following options:

Menu Option Use to

Lock Element Lock the element so it can't be edited. To unlock the element, select Lock
Element again.

Note:
This does not apply in the Corporate, Business and Software Engineering,
Systems Engineering and Ultimate editions when security is enabled; in that
situation, see the Lock model elements 204 topic.

Selectable Toggle whether the element is selectable or not. If an element is selectable, you
can move it around the diagram and perform right-click context menu
operations.
If an element is unselectable, you cannot move it around the diagram and the
only right-click operation available is to make the element selectable.
This option has no effect on double-click operations on the element, such as
displaying child diagrams or Properties dialogs.
Note that an element on a locked diagram is also unselectable - if you click on
it, the element outline displays in red.

Dockable Align and join two elements either vertically or horizontally, on the current
diagram only.
Both elements must have the Dockable option selected, and must have the
joining edges parallel. As the distance between the elements narrows, the
moving element snaps to the edge of the other element. For Activity Partitions
786 , the option is selected by default.

Deselecting the Dockable option does not separate the elements; if necessary,
you can simply move the elements apart again.

Appearance Display the Appearance submenu; see the table below.

Z-Order Set the Z-Order 437 of the element.

Note:
You can also change the appearance (and other aspects) of several selected elements at once 557 .

Appearance Sub-Menu
Menu Option & Use to
Function Keys

Default Appearance Override the global default appearance of all elements (which you set on the
[F4] Options dialog, Standard Colors 353 page and Diagram Appearance 356 page)
with a different default for just the selected element 538 on all diagrams in which
it is found.
To change the appearance of the selected element on the current diagram only,
use the Format toolbar 85 .

Apply Image From Paste the image held on the clipboard onto the selected element.
Clipboard

Select Alternate Image Select an alternative image using the image manager 447 .
[Ctrl]+[Shift]+[W]

Hide/Show Name Under Hides or redisplays the name label under an element with an alternative image.

© 1998-2010 Sparx Systems Pty Ltd

 556 Modeling Fundamentals | Elements

Menu Option & Use to

Function Keys

Image

Set Font Change the font 556 type, size, color and effects for the text in an element.

Show Labels Reveal any hidden labels on the element.

Copy Appearance to Copy the default element appearance (set using the Default Appearance option,
Painter above) to the painter. You then paste the default appearance using the Paste
Appearance option on the Diagram toolbar 83 .

Copy Image to Copy the element image to the clipboard.

Clipboard

Note:
Not all menu options shown here are present on all element context menus. Context menus vary slightly
between element types. The Alternate Image option won't display for a Lifeline element, for example.

4.6.5.7.1 Set Element Font

You can change the appearance of the text within an element, for one or more selected elements, by either:
· Selecting the Appearance | Set Font context menu option, or
· Selecting the Font icon on the Format 85 toolbar.
The Font dialog displays.

Select the font, style, size, color and effects, and (if necessary) the script type. Click on the OK button to save
your changes.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 557

4.6.5.8 Element Multiple Selection Menu

You can perform operations on two or more elements on a diagram at once. To select the required elements,
either click and drag the cursor over the group to highlight them, or press [Shift] and click on each element.
Right-click on an element to display the following context menu:

This menu enables you to do the following:

Note:
Where elements are made the same, they are matched to the element you right-clicked on.

· Align elements (by left edge, right edge, top, bottom, center in a column or center in a row)
· Space elements evenly (across or down)
· Standardize the dimensions of the selected elements
· Specify the visibility of features 438 for all selected elements
· Add the same Tagged Value 635 to all selected elements
· Automatically resize elements to match (element content permitting)
· Turn the Dockable 555 option on or off for all selected elements on a diagram
· Set the default appearance 538 and font 556 for multiple elements at once
· Make the selected elements on the diagram non-selectable 555 ; to make them selectable again, right-click
on the diagram and select the Make All Elements Selectable context menu option
· Generate code for all selected elements at once, or synchronize the code against the selected elements

© 1998-2010 Sparx Systems Pty Ltd

 558 Modeling Fundamentals | Elements

· Transform 1387 the selected elements

· Copy all selected elements to the clipboard
· Automatically adjust the layout of the selected elements on the diagram
· Delete all selected elements.

Tip:
It is much faster to assign an appearance or characteristic to a group of elements than to one element at a
time.

4.6.6 Attributes
Attributes are features of an element that represent the properties or internal data elements of that element.
Not all element types support attributes, and others have restrictions - for example, attributes of Interfaces
must have Public scope.
Elements with attributes (typically Classes) display their features in diagrams in the manner shown below.
Attributes display in the first compartment of properties in colored text - the default color is red (for example,
Age : int).

For a Customer Class, CustomerName and CustomerAddress can be attributes. Attributes have several
important characteristics, such as type, scope (visibility), static, derived and notes.

Create and Modify Element Attributes

Note:
This facility is only available if the element supports attributes.

In the Project Browser, Classes with attributes have their features collected beneath them, each preceded by
a blue box ( ).

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 559

1. In the Diagram view, either:

· Right-click on the element to be edited, and from the context menu select the Attributes menu
option
· Click on the element and press [F9], or
· Drag the attribute from the Project Browser onto the element.
2. The <Element name> Attributes dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 560 Modeling Fundamentals | Elements

Notes:
· If you make changes and do not save them, the Cancel button prompts you to save or cancel the changes,
whilst the Close button closes the dialog immediately and does not save the changes.
· If you are creating many attributes, go to the Attribute/Operations page of the Options dialog (Tools |
Options | Source Code Engineering | Attribute/Operations) and select the After save, re-select edited
item checkbox. Now, when you create an attribute and click on the Save button, the dialog fields clear
ready for you to enter the details of the next attribute. This helps you when you want to create attributes
quickly and might not necessarily want to fully define each one as you create it.

See the topics on the Attributes dialog General 560 , Detail 562 and Constraints 563 tabs.

Note:
If the parent element provides source or target roles for a connector, the connector can be attached to a
specific attribute. See the Connect to Element Feature 611 topic.

See Also
· Attribute Tagged Values 564
· Create Properties 565
· Display Inherited Attributes 567
· Create Object From Attribute 568

4.6.6.1 Attributes Dialog - General Tab

The General tab of the Attributes dialog is shown below:

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 561

To review an existing attribute, click on the attribute name in the Attributes panel.
To delete an existing attribute, click on the attribute name in the Attributes panel and click on the Delete
button.
To create a new attribute, either:
· Click on the New button, or
· Click on an existing attribute name in the Attributes panel, and click on the Copy button.
Review, edit or complete the fields as indicated in the following table.

Field Use to

Name Display the name of the attribute. For a new attribute, type the name (with no spaces).

Alias Display an optional alias for the attribute. If necessary, type in a new alias.

Type Display the attribute's type. If necessary, click on the drop-down arrow and select a
different type.
The type can be defined by the code language (data type) or by a classifier element.
When you click on the drop-down arrow, the first set of values in the list provides the
data types, and the second (longer) set provides the possible classifiers.
To add new code language data types that can be displayed in this list, see the Data
Types 666 topic.

[ ... ] (Select) Open the Select <Item> 515 dialog, which you use to select or define a different attribute
button classifier type that might not be in the Type drop-down list.

Scope Define the attribute as Public, Protected, Private or Package. If necessary, click on the
drop-down arrow and select a different scope.

Stereotype Define the optional stereotype of the attribute. If necessary, either type a different
stereotype name or click on the drop-down arrow and select a stereotype.

Containment Define the containment type (by reference, by value or not specified). If necessary, click
on the drop-down arrow and select a different containment type.

Derived Indicate that the attribute is a calculated value. If you select this checkbox, the attribute
name in the element attributes compartment has the derived symbol (/) as a prefix.

Static Indicate that the attribute is a static member.

Property Indicate that the attribute has automatic property creation 565 .

Const Indicate that the attribute is a constant.

Is Literal (For Enumeration elements.) Defaults to selected, to define the attribute as an

enumeration literal. Deselect to define the attribute as a normal element attribute.
In the Attributes compartment on the diagram, the enumeration literals are listed
separately, above the normal attributes. (Ensure that the Stereotype field for the normal
attribute is not set to enum.)

Initial Display an optional initial value. If necessary, type in a new initial value.

Notes Enter any free text notes associated with the attribute. You can format the notes text
using the Notes 642 toolbar at the top of the field.

To change the position of an attribute in the list in the Attributes panel, click on the Scroll Up or Scroll Down
(hand) buttons.

Note:
By default, the attributes are listed in alphabetical order. Before changing this sequence, you must deselect
the Sort Features Alphabetically checkbox on the Objects page of the Options dialog (Tools | Options |
Objects).

© 1998-2010 Sparx Systems Pty Ltd

 562 Modeling Fundamentals | Elements

If you have changed the attribute details, click on the Save button to save the changes.

4.6.6.2 Attributes Dialog - Detail

To define additional details relating to collections, click on the Detail tab of the Attributes dialog.

Field Use to

Multiplicity

Lower bound Define a lower limit to the number of elements allowed in the
collection.

Upper bound Define an upper limit to the number of elements allowed in the
collection.

Allow Duplicates Indicate that duplicates are allowed.

Maps to the UML property isUnique, value FALSE).

Ordered Multiplicity Indicate that the collection is ordered.

Redefined Property Review the redefined properties for the attribute.

Add redefined properties by clicking on the Add button to
display the Select Property 517 dialog.

Subsetted Property Review the subsetted properties for the attribute.

Add subsetted properties by clicking on the Add button to
display the Select Property 517 dialog.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 563

Field Use to

Collection Code the attribute as an array, so that it can contain multiple

concurrent values rather than a single value.

Attribute is a Collection Indicate that the attribute is a collection (array).

Container Type Enter the name of the container type.

Other

Transient (For Java code) indicate that the attribute can change
regardless of what the code is performing.

Qualifiers Click on this button to add Qualifiers 830 to the attribute, The
Qualifiers 832 dialog displays.

When you have completed these fields, click on the Save button.

4.6.6.3 Attributes Dialog - Constraints

Attributes can also have constraints associated with them. Typically these indicate such things as maximum
value, minimum value and length of field.
Select the Constraints tab of the Attributes dialog to define these constraints.

To review an existing constraint, click on the constraint name in the panel at the bottom of the dialog.
To delete an existing constraint, click on the constraint name in the panel and click on the Delete button.

© 1998-2010 Sparx Systems Pty Ltd

 564 Modeling Fundamentals | Elements

To create a new constraint, click on the New button.

Review, edit or complete the fields as indicated in the following table.

Field Use to

Constraint Type the constraint name.

Type Click on the drop-down arrow and select the constraint type.

(Notes) Type any comments or notes concerning the constraint.

If you have created or edited the data, click on the Save button to save the changes.

4.6.6.4 Attribute Tagged Values

You can define Tagged Values for an attribute. Tagged Values are a convenient means of extending the
properties a model element supports. This in turn can be used by code generators and other utilities to
transform UML models into other forms.

Note:
Tagged Values are supported for attributes, operations, objects and connectors.

Add a Tagged Value

To add a Tagged Value to an attribute, follow the steps below:
1. Click on the Tagged Values tab of the Attribute Properties dialog.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 565

2. Click on the New tag button ( ). The Tagged Value dialog displays.

3. In the Tag field, type the tag name or click on the drop-down arrow and select a defined tag.
4. If appropriate, in the Value field type a specific value for the tag.
5. Click on the OK button to confirm the operation. The tag name and value are displayed under the
attribute in the Tagged Values tab.

Note:
You can define custom tags by creating a Custom Tagged Value Type 1171 .

4.6.6.5 Create Properties

Enterprise Architect has capabilities for automatically creating properties in various languages. Property
creation is controlled from the General tab of the Attribute dialog.

Select the Property checkbox. The Create Property Implementation dialog immediately displays.

The Language panel defaults to the Class language; however, you can change this and generate the

© 1998-2010 Sparx Systems Pty Ltd

 566 Modeling Fundamentals | Elements

properties for any language. Each language has slightly different syntax and generates slightly different
results. For example:
· Java and C++ generate get and set functions
· C# and VB.Net create property functions
· Delphi creates get and set functions as well as a specialized Delphi property Tagged Value.
Type in the required details and click on the OK button. Enterprise Architect generates the required operations
and properties to comply with the selected language.
Note that get and set functions are stereotypes with «property get» «property set» making it easy to recognize
property functions. You can also hide these specialized functions by deselecting the Property Methods
checkbox in the Features tab of the Diagram Properties dialog for a specific diagram (select the Diagram |
Properties menu option). This makes it easier to view a Class, uncluttered by many get and set methods.

Note that for Delphi you must enable the Tagged Values compartment to see the generated properties. See
Compartments 521 for the steps for doing this.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 567

4.6.6.6 Display Inherited Attributes

When displaying a Class with attributes in a diagram, you can also show the inherited attributes from all
parents in the elements type hierarchy (ancestors).
To show inherited attributes, use the Feature Visibility 438 dialog.

Note that for elements that have attributes, you can also override an inherited attribute's initial value, using the
element context menu option Advanced | Override Attribute Initializers. This displays the Override Attribute
Initializers dialog.

© 1998-2010 Sparx Systems Pty Ltd

 568 Modeling Fundamentals | Elements

In the Override Attribute Initializers dialog, select the variable name and enter a new initial value. If required,
you can type a note in the Note field. When you display inherited attributes, Enterprise Architect merges the
list of attributes from all ancestors and merges the attribute initializers, so that the final child Class displays the
correct attribute set and initial values.

4.6.6.7 Create Object From Attribute

If you drag an attribute from the Project Browser onto an Activity diagram, the attribute generates an Object
element of the same name. This is very useful for creating connectors between elements and specific
attributes. For example, a Class element of stereotype table defines its fields as attributes; Requirement
elements that define requirements for those fields can then be linked to the appropriate table fields via the
attribute Object elements.

Note:
From Enterprise Architect release 7.5, you can create this relationship more directly by linking an attribute in
an element to another element, or linking two attributes in different elements. See the Connect to Element
Feature 611 topic.

In the following diagram, the billingAddress Object was generated by dragging the billingAddress attribute from
the Account Class in the Project Browser onto the diagram. The user then created Realize relationships
between the Account element and the billingAddress element, and between the billingAddress element and
the REQ028 Requirement element.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 569

4.6.7 Behavior
Enterprise Architect enables you to define an element's behavior through the element's operations and
parameters. You can also define the behavior of more specific behavioral elements such as Activities,
Interactions, Actions and Interaction Occurrences, through the Behavior and Call tabs of the element
Properties dialogs. For further details, see the following topics:
· Operations 569
· Interactions and Activities 581
· Behavior Calls 581 (Actions and Interaction Occurrences)
· Behavior Parameters 583
· Behavior Call Arguments 582 .

4.6.7.1 Operations
Operations are features of a Class or other element that represent the behavior or services an element
supports. For a Customer Class, UpdateCustomerName and GetCustomerAddress can be operations.
Operations have several important characteristics, such as type, scope (visibility), static, abstract and notes.

How to Access Operations

If an element supports operations (typically Classes and Interfaces), the right-click context menu contains the
Operations menu item. Select this to open the Operations dialog 570 . Alternatively, press [F10].

How Operations Appear in Diagrams

Elements with operations (typically Classes) display their features in diagrams in the manner shown below.
Operations display in the second compartment of properties in colored text - the default color is dark green (for
example, Finalize() : void). Some characteristics display in shorthand form; for example, static displays as $,
abstract as *.

Note:
If the parent element provides source or target roles for a connector, the connector can be attached to a
specific operation. See the Connect to Element Feature 611 topic.

Operations in the Project Browser

In the Project Browser, Classes with operations have their features collected beneath them, each preceded by

© 1998-2010 Sparx Systems Pty Ltd

 570 Modeling Fundamentals | Elements

a pink box ( ). Right-click on an operation and select the Operation Properties context menu option to open
the Operations dialog and edit details for the feature.
From the Project Browser, you can drag operations onto new elements to give them the same operations.

See Also
· Behavior Parameters 583

4.6.7.1.1 Operations Dialog - General

The Operations dialog has five tabs:
· General, from which you can also define operation parameters 583

· Behavior 573
· Pre-conditions and Post conditions (that is, Constraints 577 )
· Tagged Values.
The General tab of the Operations dialog enables you to define new operations and set the most common
properties, including name, access type and return.

Note:
The General tab can vary according to the type of element you are adding an operation to. If defining
operations for a data modeling table, see the Index, Trigger, Check Constraint 1033 topic. The following
illustrations are for the operations of an Object element and a State element.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 571

Field/Button Use to

Name Display the selected operation name.

Parameters Display the parameter list. See Parameters Dialog 583 for information regarding what
this string can contain.

Edit Parameters Open the Parameters dialog.

© 1998-2010 Sparx Systems Pty Ltd

 572 Modeling Fundamentals | Elements

Field/Button Use to

Return Type (Not shown for State or State Machine elements.)

Display the data type returned by the operation.
The type can be defined by the code language (data type) or by a classifier element.
When you click on the drop-down arrow, the set of values in the list provides the
appropriate data types.
To select or define possible classifiers, either click on the Select Type option in the
list, or click on the [ ... ] (Select) button to display the Select <Item> 515 dialog.
To add new code language data types that can be displayed in this list, see the Data
Types 666 topic.

[ ... ] (Return Type Open the Select <Item> 515 dialog to select the operation return type.
Browse button)
(Not shown for State or State Machine elements.)

Action Define the action of the operation: do, exit or entry.

(For State 789 or State Machine 796 elements.)

Scope Select Public/Protected/Private/Package.

Stereotype Specify an optional stereotype for this operation.

Concurrency Set the concurrency of the operation.

Alias Define an optional alias for the operation.

Notes Enter free text notes. You can format this text if necessary, using the Notes toolbar
642 at the top of the field.

Virtual/Abstract If the operation's language is set to C++, map to the C++ Virtual keyword. Otherwise
this option is Abstract, pertaining to an abstract function.
(Not shown for State or State Machine elements.)

Return Array Indicate that the return value is an array.

(Not shown for State or State Machine elements.)

Synchronized Specify a code engineering flag that relates to multi threading in Java.
(Not shown for State or State Machine elements.)

Static Indicate that the operation is a static member.

(Not shown for State or State Machine elements.)

Const Indicate that the return type of this method is constant.

(Not shown for State or State Machine elements.)

Pure Indicate that C++ is pure virtual syntax - for example:

virtual void myFunction( ) = 0;
(Not shown for State or State Machine elements.)

IsQuery Indicate that this method does not modify the object.
(Not shown for State or State Machine elements.)

Operations List the defined operations.

Up/Down Buttons Change the order of operations in the list.

New Create a new operation.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 573

Field/Button Use to

Copy Copy the currently selected operation.

Save Save a new operation, or save modified details for existing operation.

Delete Delete the currently selected operation.

Note:
· If you make changes and do not save them, the Cancel button prompts you to confirm or cancel the
changes, whilst the Close button closes the dialog immediately and does not save the changes.
· If you are creating many operations, go to the Attribute/Operations page of the Options dialog (Tools |
Options | Source Code Engineering | Attribute/Operations) and select the After save, re-select edited
item checkbox. Now, when you create an operation and click on the Save button, the dialog fields clear
ready for you to enter the details of the next operation. This helps you when you want to create operations
quickly and might not necessarily want to fully define each one as you create it.

4.6.7.1.1.1 Operations Dialog - Behavior

This topic illustrates how to elaborate a method's function in a diagram.
The Behavior tab of the Operations dialog enables you to enter free text to describe the functionality of an
operation. Use pseudo-code, structured English or just a brief description.
You can also use the Behavior tab to formally describe a method or State action and have the text appear
under the method/action name in a diagram.

State Operations - Behavior

A State's do, entry and exit operations optionally refer to other behaviors such as Activities, Interactions or
Operations. Use the [ ... ] (browse) button to invoke the Select <Item> 515 dialog, and locate and select the
required behavior.

Show Behavior in a Diagram

To show behavior in a diagram, follow the steps below:
1. Create or locate the required operation.
2. Click on the Behavior tab of the Operations dialog.

© 1998-2010 Sparx Systems Pty Ltd

 574 Modeling Fundamentals | Elements

3. Select the Show Behavior in Diagram checkbox.

4. Click on the Save button.

Associate With Behavior

A Class operation can be associated with a behavior elsewhere in the model. Display the operation's
Properties dialog, select the Behavior tab, click on the [ ... ] (browse) button and select the required behavior
from the Select Element 515 dialog. The behavior is set in the Behavior field, and the operation is then set as
the specification of the associated behavior. For example:

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 575

In behavioral code generation, the behavior of the associated behavioral element is generated as the
operation's code. In the following illustration, Op1 is associated with the Activity Activity.

The generated code for Op1 is as follows:

package Package;
public class Container {
public Container(){
}

public void finalize() throws Throwable {

}

public void op1(){

/*Activity element(Activity1)'s behavior rendered as operation(op1)'s code*/
//Action1;
if (cond1)
{
//Action2;
}
else
{
//Action3;
}
//Action4;
}

© 1998-2010 Sparx Systems Pty Ltd

 576 Modeling Fundamentals | Elements

/*Activity element(Activity1)not rendered*/

public void Activity2()
{
// behavior is a Activity
}

public void Interaction()

{
// behavior is a Interaction
}
}//end Container

See Also
· Initial Code 576

On the Behavior tab of the Operations dialog, you can use the Initial Code field to enter code to be inserted
into an operation body when the operation is first generated to file. After this point, forward code generation
and synchronization do not replace the existing operation code with the Initial Code field.

By default, the Initial Code field also is not imported into the model during reverse engineering, but you can
select to import the field by selecting the Include method bodies in model when reverse engineering
checkbox on the Options 1341 dialog.
This field is most useful when combined with UML Patterns 901 . Elements within a pattern often require the
same stub code. Notice that the language specific patterns available from www.sparxsystems.com/resources/
developers/uml_patterns.html include initial code for some of the defined operations. This helps speed up the
process of applying patterns from model to implementation. The Initial Code section is also useful for
ensuring that the generated code is directly compilable.
This example shows the contents of the Initial Code field for the Instance() operation of the Singleton element
in the C# Singleton pattern:

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 577

4.6.7.1.1.2 Operations Dialog - Constraints

Operations can have pre- and post- conditions defined. For each type, give the condition a name, a type and
enter notes.
Constraints define the contractual behavior of an operation, what must be true before they are called and what
is true after. In this respect they are related to the state model of a Class and can also relate to the guard
conditions that apply to a transition.

4.6.7.1.2 Operation Tagged Values

Operations can have Tagged Values associated with them. Tagged Values offer a convenient extension
mechanism for UML elements, so you can define any tags you like and then assign values to them using this
form.
Tagged Values are written to the XMI output, and can be input to other third party tools for code generation or
other activities.

Tip:
Tagged Values are supported for attributes, operations, objects and connectors.

Add a Tagged Value

To add a Tagged Value for an operation, follow the steps below:
1. Click on the Tagged Values tab of the operation Properties dialog.

© 1998-2010 Sparx Systems Pty Ltd

 578 Modeling Fundamentals | Elements

2. Click on the New Tags button. The Tagged Value dialog displays.

3. In the Tag field, type the tag name (or select a defined tag from the drop-down list), then in the Value
field type the initial tag value.
4. Click on the OK button to confirm the operation.

Note:
You can define custom tags using a predefined Tagged Value Type. For more information see Create a
Custom Tagged Value 1171 .

4.6.7.1.3 Override Parent Operations

In Enterprise Architect, you can automatically override methods from parent Classes and from realized
Interfaces.
Select a Class that has a parent or realized interface and select the Element | Advanced | Overrides &
Implementations menu option.
In the Override Operations/Interfaces dialog, check the operations/interfaces to automatically override and
click on the OK button. Enterprise Architect generates the equivalent function definitions in your child Class.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 579

You can configure Enterprise Architect to display this dialog each time you add a Generalization or Realization
connector between Classes, and review their possible operations/interfaces to override/implement. Do this
from the Links page of the Options dialog (select the Tools | Options | Links menu option).

4.6.7.1.4 Display Inherited Operations

You can configure an element in a diagram to display the complete operation set obtained from all ancestors
in the element's type hierarchy, as well as those directly owned. To do this, use the Element | Feature
Visibility 438 function from the main menu, or press [Ctrl]+[Shift]+[Y].
The following diagram illustrates this behavior when enabled for each element in a simple hierarchy.

© 1998-2010 Sparx Systems Pty Ltd

 580 Modeling Fundamentals | Elements

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 581

4.6.7.2 Interactions and Activities

The behavioral aspects of Interactions and Activities are modeled using the Behavior tab of the element
Properties dialog, which enables you to assign parameters and return types to the elements.
Use the Edit Parameters button to edit an element's parameters 583 . When you create a new parameter
using the dialog, it internally creates an Activity Parameter Node 755 for an Activity or an Interaction Parameter
for an Interaction. In the Return field, click on the drop-down arrow and select the return type of the element.

The specification field is populated automatically when an operation is associated with the activity as a
behavior 573 .

4.6.7.3 Behavior Calls

A behavior call is the invocation of a behavior. You can represent an invocation with a Call Operation Action
(Operation), Call Behavior Action (Activity) 745 or Interaction Occurrence (Interaction) 780 element. You model
the properties of the behavior call using the Call tab of the element Properties dialog, on which you:
· Edit Arguments 582
· Re-associate the call with a different behavior 582
· Synchronize the arguments 582 with the parameters in the associated behavior.

Click on the Edit button to create and delete arguments, and relate them to a corresponding parameter in the
associated behavior.
Click on the [ ... ] (Select Behavior) button to re-associate the invocation with a different behavior or to

© 1998-2010 Sparx Systems Pty Ltd

 582 Modeling Fundamentals | Elements

remove any association with the current behavior.

The Interaction Occurrence panel is displayed only for Interaction Occurrence elements. It enables you to
enter the return value and attribute of the behavior call.

4.6.7.3.1 Associate with Different Behaviors

On the Call tab of the Behavior Call Properties dialog, when you click on the [ ... ] (Select Behavior) button
the Select <Item> 515 dialog displays, listing all available behaviors in the model.
Select <none> to remove any existing association between an invocation and a behavior, or select another
classifier to re-associate the invocation with a different behavior.
The Synchronize with Parameters button is enabled only if a valid behavior is identified in the Behavior
field.

4.6.7.3.2 Synchronize Arguments

On the Call tab of the element Properties dialog, click on the Synchronize with Parameters button to
synchronize the number of arguments in the invocation element with the number of parameters in the
associated behavior. This automatically creates or deletes arguments based on the number of parameters in
the behavior. If any arguments are to be deleted, Enterprise Architect prompts you to confirm the operation.
Click on the Yes button to confirm.

Note:
The Synchronize with Parameters button is enabled only if the invocation is associated with a valid
behavior, as identified in the Behavior field.

4.6.7.4 Behavior Call Arguments

You define the arguments of a Behavior Call 581 using the Arguments dialog, which you display by clicking on
the Edit button on the Call tab of the element Properties dialog.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 583

1. In the Name field, type the name of an argument to map to the behavior.
2. In the Parameters field, click on the drop-down arrow and select a behaviors parameter from the list of
parameters associated with the behavior.
3. In the Value field, set any required value.
4. If a diagram is displayed, and if required, select the Show in current diagram checkbox to add an
Action Pin 749 on the diagram.
5. Click on the Save button.
6. If appropriate, click on the New button and repeat steps 1 to 5 for another argument:parameter
mapping.
If you attempt to map a newly created argument to a parameter that is already associated with a different
argument, Enterprise Architect identifies the mapping and prompts you to confirm that you intend to change
the association.

4.6.7.5 Behavior Parameters

This topic area describes the facilities for defining, editing and extending the parameters of behavioral
operations, Activities and Interactions. See:
· Parameters Dialog 583
· Parameter Tagged Values 585
· Operation Parameters By Reference 586

4.6.7.5.1 Parameters Dialog

The Parameters dialog enables you to define the parameters of an operation, Activity or Interaction. The
parameter list is reproduced in code in the order the parameters appear in the parameters list, so use the Up
and Down buttons to move parameters into their required positions. Additionally, you can select the Add new
to end checkbox to force new parameters to appear at the end of the list instead of the top.

Tip:
Set the amount of parameter detail to display in a specific diagram using the Show Parameter Detail 429
drop-down list on the Diagram Properties dialog. The setting applies only to the current diagram. The default
is to show the type only.

© 1998-2010 Sparx Systems Pty Ltd

 584 Modeling Fundamentals | Elements

Option Use to

Name Type the parameter name.

Type Select the data type of the parameter.

Alternatively, click on the [ ... ] button and select the element classifier to define
the type.

Default Type an optional default value for the parameter.

Stereotype Type a stereotype name, or click on the drop-down arrow and select a stereotype
for the parameter.

Kind Indicate the way a parameter is passed to a function:

· In = By Value
· InOut = By Reference
· Out is passed by Reference, but only the return value is significant.
Fixed Set the parameter to const, even if passed by reference.

Alias Type an optional alias for the parameter.

Add new to end Place new parameters at the end of the list instead of the start.

Multiplicity Display the Multiplicity dialog, to specify the multiplicity of the parameters.

Notes Type any additional notes on the parameter.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 585

Multiplicity Dialog
Field Use to

Lower bound Define a lower limit to the number of elements allowed in the collection.

Upper bound Define an upper limit to the number of elements allowed in the collection.

Allow Duplicates Indicate that duplicates are allowed.

Maps to the UML property isUnique, value FALSE).

Multiplicity is Ordered Indicate that the collection is ordered.

See Also
· Parameter Tagged Values 585
· Operation Parameters by Reference 586

4.6.7.5.2 Parameter Tagged Values

Behavioral parameters can have Tagged Values associated with them. Tagged Values offer a convenient
extension mechanism for UML elements; you can define any tags you like and then assign values to them
using this form.
Tagged Values are written to the XMI output, and can be input to other third party tools for code generation or
other activities.

Tip:
Tagged Values are supported for attributes, operations, objects and connectors.

Add a Tagged Value

To add a Tagged Value for a parameter, follow the steps below:
1. Double-click on the operation, Activity or Interaction containing the parameter in a diagram or in the
Project Browser. The Properties dialog displays.
2. Click on the Tagged Values tab, which shows the Tagged Values for the selected object and its
parameters.
3. Click on the required parameter in the Parameters compartment of the Tagged Values tab, and click on
the New Tags button. The Tagged Value dialog displays.

4. In the Tag field, type the tag name (or select a defined tag from the drop-down list), then in the Value
field type the initial tag value .
5. Click on the OK button to confirm the Tagged Value.

Tip:
Custom tags can be created using a predefined Tagged Value Type. For more information see Create a
Custom Tagged Value 1171 .

© 1998-2010 Sparx Systems Pty Ltd

 586 Modeling Fundamentals | Elements

4.6.7.5.3 Operation Parameters by Reference

Note:
This facility currently applies to operations only.

You can select to highlight parameters declared as 'Kind: inout' or 'Kind: out' with an additional user-defined
prefix or suffix. On the Objects 362 page of the Options dialog (select the Tools | Options | Objects menu
option), the Feature reference indicator panel enables you to set whether references are highlighted or not.

If you select the Highlight References checkbox, you can also indicate whether a prefix or suffix should be
used, and the actual reference character to use. In the example above, the & character has been set as a
prefix.
When you declare a parameter of type inout, it is assumed you are passing the parameter by reference rather
than by value. If you have elected to highlight references, then this is displayed in the Diagram View.
The example below shows that, in the getName operation, the parameter strName is a string reference, and is
highlighted using the chosen character and position.

4.6.8 In-place Editing Options

This topic explores the tasks that can be performed using in-place editing of elements on a diagram in
Enterprise Architect. The tasks include:
· View Properties 587
· Edit Element Item Name 588
· Edit Feature Stereotype 588
· Edit Feature Scope 589
· Edit Attribute Keyword 590
· Edit Operation Parameter Keyword 591
· Insert Operation Parameter 593
· Edit Parameter Kind 592
· Insert New Feature 592 (Attribute or Operation)
· Insert Maintenance Feature 594
· Insert Testing Features 595
· Delete Selected from Model 587

4.6.8.1 In-place Editing Tasks

To use the options that are available through the in-place editing menu, follow the steps below:
1. Open the diagram containing the element.
2. Click on the element, and on the item to manipulate within the element. The item line is highlighted in a
lighter shade (the default is white), to indicate that it has been selected.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 587

3. Edit and manipulate the items in the element, either by pressing the appropriate keyboard keys or by
right-clicking on the highlighted item and choosing a task from the Element Items context menu. The
following commands are available:

To... Select menu option... Or press...

Change the name, scope or stereotype of the Edit Selected [F2]

element or element item

Display the dialog containing details of the element View Properties [Enter]

Insert a new item in the element Insert New After Selected [Insert]

Locate the item in the Project Browser Find in Project Browser

Add an attribute to the element Add Attribute [Ctrl]+[Shift]+[F9]

Add an operation to the element Add Operation [Ctrl]+[Shift]+[F10]

Insert a feature on the specific element item, such Add Other [Ctrl]+[F11]
as Maintenance features and Testing features

Delete the selected item from the model Delete Selected from [Delete]
Model

Display the source code for the element. View Source code [F12]

Set a breakpoint on a highlighted operation Set Breakpoint

(including a breakpoint 1468 , start recording marker,
end recording marker or stack auto-capture marker)
1499 .

Navigate Diagram Selection, to navigate the [Ctrl]+[Shift]+[arrow key

diagram between elements without having to use ]
the mouse

Toggle element highlight option on and off [Shift]+[Enter]

Other options that are available while editing element attributes or operations in a diagram include:

To... Press...

Accept current changes [Enter]

Accept current changes and open a new slot to add a new [Ctrl]+[Enter]
item

Abort the edit, without save [Esc]

Display the context menu for in-place editing [Shift]+[F10]

© 1998-2010 Sparx Systems Pty Ltd

 588 Modeling Fundamentals | Elements

To... Press...

Invoke the Select <Item> dialog [Ctrl]+[Shift]+[Space]

Note:
Most of the in-place editing menu commands have keyboard alternatives. For many of them, if the selected
item happens to be off-screen when you press the appropriate keys, the diagram automatically scrolls to
show the whole element, so that you can see what you are changing.

4.6.8.2 Edit Element Item Name

The in-place editing feature enables you to change the name of the element, or the name of an operation or
attribute, directly from the diagram. To use this feature follow the steps below:
1. Open the diagram containing the element.
2. Click on the element and on the name to change within the element. The item line is highlighted in a
lighter shade (the default is white), to indicate that it has been selected.

3. Right-click on the item. The context menu displays.

4. Select the Edit Selected menu option (or press [F2]) to enable you to edit the item directly from the
diagram. The name of the attribute or operation is highlighted.

5. Delete or type over the name.

6. Press [Enter] to accept the change, or [Esc] to cancel the change.

4.6.8.3 Edit Feature Stereotype

You can use the in-place editing feature to change the stereotype of an operation or attribute directly from the
diagram. To use this feature, follow the steps below:
1. Open the diagram containing the element.
2. Click on the element, and on the item to edit within the element. The item line is highlighted in a lighter
shade (the default is white), to indicate that it has been selected.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 589

3. Right-click on the item. The context menu displays.

4. Select the Edit Selected menu option (or press [F2]) to enable you to edit the attribute or operation
directly from the diagram. The name of the item is highlighted.
5. Move the cursor to the position before the name or within the existing attribute or operation stereotype
(denoted by «stereotype name»).

6. Delete or type over the previous name to change the stereotype name of the attribute or operation.
7. Press [Enter] to accept the change or [Esc] to cancel the change.
You can assign multiple stereotypes by including a comma-separated list inside the stereotype markers.

4.6.8.4 Edit Feature Scope

The in-place editing feature enables you to rapidly change the scope of an attribute or operation directly from
the diagram. To use this feature follow the steps below:
1. Open the diagram containing the element.
2. Click on the element and on the item to edit within the element. The item line is highlighted in a lighter
shade (the default is white), to indicate that it has been selected.

3. Right-click on the item. The context menu displays.

© 1998-2010 Sparx Systems Pty Ltd

 590 Modeling Fundamentals | Elements

4. Select the Edit Selected menu option (or press [F2]) to enable you to edit the attribute or operation
directly from the diagram. The name of the item is highlighted.
5. Move the cursor to the scope of the item and delete the previous entry.

6. Reassign the entry by typing in one of the following symbols:

· + indicates that the scope is Public
· - indicates that the scope is Private
· ~ indicates that the scope is Package
· # indicates that the scope is Protected.
7. Press [Enter] to save the change, or [Esc] to cancel the change. The diagram is updated to reflect the
changes. (Also see the catalogNumber attribute in the above screen illustrations.)

4.6.8.5 Edit Attribute Keyword

You can add features such as attribute keywords and classifiers directly to an element, using the Element
Keywords and Classifiers menu. This enables you to rapidly assign details element item by element item,
directly from a diagram. To use this feature, follow the steps below:
1. In Enterprise Architect, open the diagram containing the element.
2. Click on the element, and on the attribute to edit within the element. The item line is highlighted in a
lighter shade (the default is white), to indicate that it has been selected.

3. Right-click on the item. The context menu displays.

4. Select the Edit Selected menu option (or press [F2]) to enable you to edit the attribute directly from the
diagram. The name of the attribute is highlighted.
5. Right-click on the attribute name to display the context menu.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 591

6. From the context menu, you can:

· Change the attribute classifier to static or fixed - select the static or fixed menu options as
appropriate; the diagram is updated to reflect the changes.
· Display the Class properties - click on the Goto Definition menu option; Enterprise Architect locates
the Class in the Project Browser and opens its Properties 481 dialog.

If the data type is a raw data type, Enterprise Architect displays the message: The data type is a raw
data type.

4.6.8.6 Edit Operation Parameter Keyword

You can directly edit operation classifiers by element, using the in-place editing menu. This enables you to
rapidly assign parameter keywords. To use this feature, follow the steps below:
1. Open the diagram containing the element.
2. Click on the element, and on the operation to edit within the element. The item line is highlighted in a
lighter shade (the default is white), to indicate that it has been selected.

3. Right-click on the item. The context menu displays.

4. Select the Edit Selected menu option (or press [F2]) to enable you to edit the operation directly from
the diagram. The name of the operation is highlighted.
5. Right-click on the data type of a parameter to display the context menu.

6. From the context menu you can:

· Change the operation classifier by clicking on the appropriate menu option - static, isquery,
abstract or fixed. The diagram is updated to reflect the changes.
· Display the Class properties - click on the Goto Definition menu option.

If the data type is Class, Enterprise Architect locates the Class in the Project Browser and opens its
Properties 481 dialog.

If the data type is a raw data type, Enterprise Architect displays the message This data type is a raw
data type.

If the data type is not defined in the model, the message is: The data type is not defined in the
model.

© 1998-2010 Sparx Systems Pty Ltd

 592 Modeling Fundamentals | Elements

4.6.8.7 Edit Parameter Kind

You can edit operation parameter kinds such as [in], [inout] and [out] directly from a diagram element by
element, using the Element Keywords and Classifiers menu. This enables you to rapidly assign the
parameter directly from a diagram. To use this feature follow the steps below:
1. In Enterprise Architect, open the diagram containing the element.
2. Click on the element, and on the operation to edit within the element. The item line is highlighted in a
lighter shade (the default is white), to indicate that it has been selected.

3. Right-click on the item. The context menu displays.

4. Select the Edit Selected menu option (or press [F2]) to enable you to edit the item directly from the
diagram. The name of the item is highlighted.
5. Right-click on the item name to display the context menu.

6. Select the appropriate menu option for the parameter kind value: [in], [inout] and [out]. The diagram is
updated to reflect the change.

4.6.8.8 Insert New Feature

You can add attributes and operations to an element using the in-place editing options. To add attributes and
operations to a Class diagram element, follow the steps below:
1. Open the diagram containing the element to which you are adding an attribute or operation.
2. Click on the element and, within the element, on the item after which to insert the operation or attribute.
The item line is highlighted in a lighter shade (the default is white), to indicate that it has been selected.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 593

3. Press [Insert]. Alternatively, right-click on the selected element item to display the context menu and
select the Insert New After Selected menu option. Enterprise Architect inserts a new data line in the
diagram, underneath the selected item.
4. Type in the relevant information for the attribute or operation.
5. Press [Enter] to accept the change or [Esc] to cancel the change. The diagram is updated to reflect the
changes.

4.6.8.9 Insert Operation Parameter

You can add operation parameters to an operation through the in-place editing options, using hotkey
commands or menu shortcuts. To add parameters to operations in a Class diagram element, follow the steps
below:
1. Open the diagram containing the element.
2. Click on the element, and on the operation to update within the element. The item line is highlighted in a
lighter shade (the default is white), to indicate that it has been selected.

3. Press [F2], or right-click on the selected item to display the context menu and select the Edit Selected
option.
4. Move the cursor inside the parameter brackets and type the parameter name followed by a colon (for
example, bks: for a vector containing books).
5. Give the parameter a type. Place the cursor after the colon at the end of the name and right-click the
mouse to display the inline editing options context menu; select the Insert Classifier option.

© 1998-2010 Sparx Systems Pty Ltd

 594 Modeling Fundamentals | Elements

The Select <Item> 515 dialog displays. Select the required classifier.
6. Press [Enter] to accept the change or [Esc] to cancel the change. The diagram is updated to reflect the
changes.

4.6.8.10 Insert Maintenance Feature

You can rapidly assign maintenance details such as Defects, Changes, Issues and Tasks directly to an
element from a diagram, using the Element Items menu. To use this feature follow the steps below:
1. Open the diagram containing the element.
2. Click on the element name. The name is highlighted in a lighter shade (the default is white), to indicate
that it has been selected.

3. Either:
· Press [Ctrl]+[F11] or
· Right-click on the highlighted name to display the context menu, and select the Add Other option.

The Insert Feature dialog displays.

4. Click on the appropriate radio button option to associate the required maintenance feature with the
element item.
5. Click on the OK button. The <Maintenance Feature> details for <element> dialog displays.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 595

6. Complete the fields to define the maintenance activity, and then click on the Apply button. To create a
subsequent maintenance activity of this type, click on the New button.
7. When you have defined all of the maintenance activities of this type, click on the OK button. The
maintenance details are added to the element.
To ensure that the maintenance items are visible in the diagram element, as shown in the example below,
select the Maintenance checkbox on the Elements tab of the Diagram Properties dialog. For more information
on diagram appearance options, see the Show Maintenance Script in Diagram 1561 topic.

4.6.8.11 Insert Testing Features

You can rapidly add testing features such as Unit, Integration, System, Acceptance and Scenario tests to an
element directly from a diagram, using the Element Items menu. To use this feature follow the steps below:
1. Open the diagram containing the element.
2. Click on the element. The element name is highlighted in a lighter shade (the default is white), to
indicate that it has been selected.

© 1998-2010 Sparx Systems Pty Ltd

 596 Modeling Fundamentals | Elements

3. Either:
· Press [Ctrl]+[F11] or
· Right-click on the highlighted name to display the context menu and select the Add Other option.

The Insert Feature dialog displays.

4. Click on the appropriate radio button option to associate the required testing feature with the element.
5. Click on the OK button. The Testing window opens, showing the appropriate panel for the type of test
selected.

6. Complete the fields 1537 to define the test activity, and then click on the Save icon in the window toolbar.
The test is added to the element.
7. To create a subsequent test activity of this type, click on the New icon, or to add items for other types of
test, click on the appropriate tab.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 597

To ensure that the test items are visible in the diagram element, as shown in the example below, select the
Testing checkbox on the Elements tab of the Diagram Properties dialog. For more information on diagram
appearance options, see the Show Test Script Compartments 1549 topic.

4.6.9 Linked Documents

In the Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of
Enterprise Architect, you can link an RTF document to any UML element in the model.
All editions of Enterprise Architect provide an additional UML Artifact - Document Artifact 819 - that can contain
an RTF document internally.
You create linked documents from Linked Document Templates, which you define with the Document
Template Editor; see the Create Linked Document Templates 603 and Edit Linked Document Templates 604
topics.
The Document Artifact and the Document Editor are illustrated below:

© 1998-2010 Sparx Systems Pty Ltd

 598 Modeling Fundamentals | Elements

Note:
When you have saved the document, an A symbol displays in the bottom right corner of the element.

Documents created via the Document Artifact element are rendered into RTF Documentation by selecting the
Linked Document checkbox in the RTF Style Template Editor. See the Select Components For
Documentation 1579 topic.

The Linked Document checkbox is within the Element hierarchy, towards the end. Remember that
checkboxes can be moved up and down the hierarchy (as has been done above) to position information in the
generated document as you require. In some templates, the Linked Document checkbox is only available as
a child of the External Requirements checkbox.
The linked document is rendered into the RTF documentation at:

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 599

linked document >

<linked document

See Also
· Create Document Artifact 599
· Link Document to UML Element 599
· Edit Linked Documents 600
· Hyperlink From Linked Document 601
· Create Element From Document 602
· Replace or Delete Documents 602
· Generate RTF Documentation Dialog 1573

4.6.9.1 Create Document Artifact

You create a Document Artifact element In a Component 730 or Deployment 727 diagram.
Drag and drop the Document Artifact element from the Toolbox into your diagram.

Double-click on the Document Artifact element. The Linked Document Editor 600 opens, with the New Linked
Document dialog.

In the Copy template field, click on the drop-down arrow and select a previously-created Linked Document
Template. Click on the OK button.
For more information on how to create and edit Linked Document Templates, see Create Linked Document
Templates 603 and Edit Linked Document Templates 604 .

4.6.9.2 Link Document to UML Element

Note:
This operation is available in the Corporate, Business and Software Engineering, System Engineering and
Ultimate editions.

© 1998-2010 Sparx Systems Pty Ltd

 600 Modeling Fundamentals | Elements

Click on an element in the Project Browser, Element List, Model Search or diagram, and:
· select the Element | Linked Document menu option
· in the Notes window, click on the Linked Document icon in the toolbar
· press [Ctrl]+[Alt]+[D] or
· right-click and select the (Create) Linked Document option from the context menu.
Alternatively, open the element Properties dialog and click on the Linked Document icon in the toolbar in the
Notes field.
The following dialog displays.

Select the previously-created template from which to create the document.

Click on the OK button.
The Linked Document editor 600 displays, in which you enter the text of the document.

Note:
When you have saved the document, an A symbol displays in the bottom right corner of the element.

For more information on how to create Linked Document Templates, see Create Linked Document Templates
603 and Edit Linked Document Templates 604 .

4.6.9.3 Edit Linked Documents

Enterprise Architect provides a Windows-like word processor to help you edit Linked Documents. This is a
simplified version of the RTF Style Template Editor, and it provides the same convenient features.
The main difference between the two editors is that you access the RTF Style Template Editor features
through a menu bar at the top of the screen, whilst you access the Linked Document Editor features through a
context menu. To access the context menu, just right-click anywhere on the document.

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 601

You can format and edit the document in a number of ways, and add links from and references to the content
of the document. For example, you can highlight a word or term in the linked document and select Create |
Glossary Definition to create a glossary definition 326 for that term. Anyone reading the document can, if they
check for the term in the Project Glossary, read the definition 324 .
The following topics provide assistance on using the Document Editor.
· Scroll Through Text 1588
· File and Print Options 1588
· Cut and Paste Options 1589
· Image and Object Imports 1591
· Character Formatting 1592
· Paragraph Formatting 1593
· Tab Support 1595
· Page Breaks and Repagination 1595
· Insert Headers and Footers 1596
· Insert Bookmarks 1597
· Table Commands 1597
· Sections and Columns 1599
· Stylesheets and Table of Contents 1600
· Text/Picture Frame and Drawing Objects 1604
· Search/Replace Commands 1605
· Hyperlink From Linked Document 601
· Create Elements From Linked Documents 602

4.6.9.4 Hyperlink From Linked Document

Within a linked document, you can add hyperlinks to other objects (elements, packages, diagrams, attributes
and operations) in the Enterprise Architect Project Browser.
To do this, click on the object in the Project Browser and drag it to the point at which to create the hyperlink.
The linked document editor automatically creates the hyperlink, using the object name as the hyperlink text.
You can edit this text if required.
Similarly, you can create a hyperlink to an element in the model by highlighting the link text in the linked

© 1998-2010 Sparx Systems Pty Ltd

 602 Modeling Fundamentals | Elements

document, right-clicking on it and selecting the Create | Link to Existing Element context menu option. This
displays the Select Classifier 515 dialog, from which you select the element to link to.
In either case, when you next open the document, you can double-click on the hyperlink to locate and highlight
the object in the Project Browser. You can then perform all normal operations on the object, including opening
any linked document on the highlighted element.
You can also create a hyperlink to a wide range of additional objects, such as web pages, Help files, Model
Searches 1235 and Team Review 208 Forums, by highlighting the appropriate text and then selecting the Create
| New | Hyperlink context menu option. This displays the Hyperlink Details 840 dialog.
For an alternative method of creating a hyperlink to an external document, Help file or web page, see the
Hyperlinks and Bookmarks 1597 topic.

4.6.9.5 Create Element From Document

Using the Linked Document Editor, you can create document-specific elements and diagrams in the Project
Browser, with hyperlinks from the document to the created item. When you click on the hyperlink, the element
or diagram is highlighted in the Project Browser. The element or diagram is created in the same package as
the element for which the linked document was created.
You can create and link to any type of element or diagram, but the facility has specific options for the following
element types:
· Class 811
· Requirement 846

· Issue 1563 .
You can create the same arrangement with existing elements, diagrams and packages by dragging them from
the Project Browser into the text of the document, creating a hyperlink 601 with the item name as the text.

Create Item
To create an element or diagram in the Project Browser, whilst in a linked document, follow the steps below:
1. Open the linked document, either from a Document Artifact 599 element or through the context menu
599 for an existing element (Corporate, Business and Software Engineering, System Engineering and
Ultimate editions).
2. Enter some text, including appropriate text to act as the link (such as the element or diagram name).
3. Highlight the appropriate text and right-click on it. The editor context menu displays.
4. Select the Create | New menu option, and the required submenu option. If you select the:
· Class, Requirement or Issue option, the corresponding element is immediately created in the
Project Browser.
· Other option, the New Element 524 dialog displays; specify the element type and - if appropriate -
stereotype, and click on the Create button.
· Diagram option, the New Diagram 422 dialog displays; specify the diagram type and click on the OK
button.
5. The highlighted text is now a hyperlink. Click on the link to highlight the new element or diagram in the
Project Browser.
You can now edit or expand the element or diagram as required.

4.6.9.6 Replace or Delete Documents

If a linked document is out of date, you can either edit 600 the text or replace the entire contents from another
file. To replace the contents:
1. Click in the body of the document and press [Ctrl]+[A] to select all the document text.
2. Press [Delete].
3. Right-click and select the File | Import context menu option. The Windows Open dialog displays, in
which you can browse for the file to import into the document.
4. Click on the Save icon in the Linked Document screen toolbar.
Alternatively, you can delete the linked document. To do this:
1. Click on an element in the Project Browser or diagram, and either:
· select the Element | Delete Linked Document menu option or

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 603

· right-click and select the Delete Linked Document context menu option.
2. Enterprise Architect prompts you to confirm the deletion; click on the Yes button.
If required, you can now create another linked document for the element.

4.6.9.7 Create Linked Document Templates

Linked Document templates can be created via the Resources window.

Under the Templates folder, right-click on the Linked Document Templates icon and click on the Create
Template context menu option. The following dialog displays.

Enter a name for your template, or select a previously-created template. Click on the OK button.

You can group your templates into folders. Right-click on your newly created template and select the Assign
Template to Group context menu option. Enter a category name and click on the OK button.
You can also modify 604 and delete the templates using the context menu options.

Note:
You can transport these linked document templates between models, using the Export Reference Data 223
and Import Reference Data 225 options on the Tools menu.

© 1998-2010 Sparx Systems Pty Ltd

 604 Modeling Fundamentals | Elements

4.6.9.8 Edit Linked Document Templates

Double-click on a previously created template in the Resource View to invoke the Linked Document Template
Editor.

The Document Template Editor is built into Enterprise Architect.

The following topics provide assistance on using the Document Editor.

· Scroll Through Text 1588
· File and Print Options 1588
· Cut and Paste Options 1589
· Image and Object Inserts 1591
· Character Formatting 1592
· Paragraph Formatting 1593
· Tab Support 1595

Enterprise Architect User Guide

 Modeling Fundamentals | Elements 605

· Page Breaks and Repagination 1595

· Headers and Footers 1596
· Hyperlinks and Bookmarks 1597
· Table Commands 1597
· Sections and Columns 1599
· Stylesheets and Table of Contents 1600
· Text/Picture Frame and Drawing Objects 1604

· Search/Replace Commands 1605

© 1998-2010 Sparx Systems Pty Ltd

 606 Modeling Fundamentals | Connectors

4.7 Connectors

UML connectors, along with elements, form the basis of a UML model. Connectors link elements together to
denote some kind of logical or functional relationship between them. Each connector has its own purpose,
meaning and notation and is used in specific kinds of UML diagrams. For more information on using
connectors, see:
· Connector Context Menu 606

· Connector Tasks 609

· Connector Properties 626

Off-Page Connector
UML, and therefore Enterprise Architect, does not have a connector that continues activity flow between two
diagrams. In creating a model diagram, if the need arises to continue flow to another diagram, you should
consider revising and simplifying the structure of the process so that groups of Actions are captured in
composite Activity elements, and each group of Actions is modeled within the child diagram of an Activity.
BPMN 956 , however, does enable you to create off-page connectors. You can also use the Suppress Line
Segments 617 menu option to indicate continuation of flow in a large diagram that, when printed, occupies
several pages. Be aware that these options are purely diagrammatic and do not indicate any diagram
relationships in any of the relationship tools.

4.7.1 Connector Context Menu

If you right-click on a connector in a diagram, the connector context menu displays. This provides quick
access to some important functions. The menu is split into up to seven distinct sections:
· Add-Ins - displays in the first section only if you have Add-Ins installed and registered, such as Eclipse
· Properties 607
· Type Specific 607
· Style 608
· Appearance 609
· UML Help - Displays the Enterprise Architect Help topic for this connector type
· Delete - delete the connector with this option.

Note:
Not all menu options are present on all connector context menus. Context menus vary slightly between
connector types. The type-specific menu options are not always included, for example.

Example Context Menu for a

Generalization:

Enterprise Architect User Guide

 Modeling Fundamentals | Connectors 607

Connector Role Context Menu

For connectors with Roles, right-clicking a connector within up to 60 pixels of an end point displays a
role-specific context menu.
The Role context menu has three additional menu options:
· A Source/Target Role... menu option that opens the connector specification dialog with the respective
role page 629 selected.
· A Multiplicity submenu that enables the multiplicity for the role to be set.
· A Link to Element Feature menu option that displays a dialog through which you can attach the end of the
connector to a specific attribute or operation 611 .

4.7.1.1 Properties Menu Section

The Properties section of the connector context menu contains the following options:

Menu Option Use to

<Connector type> Properties Open the Properties 626 window for the selected connector.

Advanced Display the Advanced 608 menu.

Attach Note or Constraint Attach a note or constraint 612 to the connector.

Note:
Not all menu options are present on all connector context menus. Context menus vary slightly between
connector types. The type specific menu options are not always included, for example.

4.7.1.2 Type-Specific Menu Section

The Type-Specific section of the connector context menu is specific to the object, and only appears for a few
different connectors. Some examples are shown below:

Connector Menu Option Use to

Transition Message Set the value of the Message.

© 1998-2010 Sparx Systems Pty Ltd

 608 Modeling Fundamentals | Connectors

Connector Menu Option Use to

Aggregation Set Aggregation to Change the Aggregation to composite.

Composite

Aggregation Set Aggregation to Shared Set the Aggregation to shared. Appears after Set
Aggregation to Composite has been selected.

Note:
Not all menu options are present on all connector context menus. Context menus vary between connector
types. The type-specific menu options are not always included, for example.

4.7.1.3 Advanced Menu Section

The Advanced section of the connector context menu contains the following options:

Menu Option Use to

Set Source and Target Change the source and/or target 614 of the connector.

Change Type Change the connector type 614 .

Reverse Direction Reverse the direction of the connector. For example, if the connector is an
arrow, the arrowhead swaps to the other end.

Specialize Associations Specify how the properties of this Association specialize the properties of
other Associations.

Information Flows Realize 866 any information items conveyed 865 on an Information Flow 864
Realized connector between these same two elements.

Dependency Properties Select a stereotype for the Dependency (or Trace, Role Binding, Occurrence
or Represents connector).

Custom Properties Display the Custom Properties 550 dialog, on which you can set the values for
predefined properties for a particular type of connector. For example, set
isDerived to True or False for an Association.

Note:
Not all menu options are present on all connector context menus. Context menus vary slightly between
connector types. The type specific menu options are not always included, for example.

4.7.1.4 Style Menu Section

The Style section of the connector context menu provides the following options:

Menu Option & Function Use to

Keys

Line Style Set the connector line style 615 - options are Direct, Auto Routing, Custom,
Bezier, Tree (Horizontal) or Tree (Vertical).

Pin End(s) Pin the connector start and/or end to the current position on the target element.
A sub-menu displays to offer the options of pinning the start point only, the end
point only, or both.
Once one or both ends are pinned, a fourth option is available to unpin both
ends.

Bend Line at Cursor Insert an anchor point 615 on the line at the point of the cursor so you can
[Ctrl]+[Q] change the shape of the line.

Enterprise Architect User Guide

 Modeling Fundamentals | Connectors 609

Menu Option & Function Use to

Keys

Suppress Line Segment Hide a segment of a connector so that you can view a part of the diagram that it
crosses.
To reverse the change, right-click on the connector and select the Show All
Line Segments context menu option.

Straighten Line at Cursor Remove an anchor point 615 on the line at the point of the cursor. (This is the
[Ctrl]+[Q] exact opposite of Bend Line at Cursor, and [Ctrl]+[Q] toggles the connector
point between the options.)

Note:
Not all menu options are present on all connector context menus. Context menus vary slightly between
connector types. The type specific menu options are not always included, for example.

4.7.1.5 Appearance Menu Section

The Appearance section of the connector context menu provides the following options:

Menu Option Use to

Appearance Set the line color and line thickness of the connector.

Visibility Set connector visibility; see table below for sub-menu options.

Tidy Line Angles Tidy the line angles 615 of a custom connector.

Visibility Sub-Menu
Menu Option Use to

Hide Connector Hide the connector. To show the connector again, follow the steps in the
Hide/Show Connectors 621 topic.

Hide Connector in Other Hide or show the connector in other diagrams 621 .
Diagrams

Hide All Labels Hide or show all labels attached to the connector.

Set Label Visibility Hide or show labels 622 attached to the connector, individually.

Note:
Not all menu options are present on all connector context menus. Context menus vary slightly between
connector types. The type specific menu options are not always included, for example.

4.7.2 Connector Tasks

This topic details some of the tasks associated with managing model connectors, such as:
· Connect Elements 610
· Connect to an Element Feature 611
· Change Connector Styles 615
· Arrange Connectors 613
· Change Connector Type 614
· Create Connector in Project Browser 618

· Reverse Connector 623

· Delete Connectors 619

© 1998-2010 Sparx Systems Pty Ltd

 610 Modeling Fundamentals | Connectors

· Hide/Show Connectors 621

· Hide/Show Labels 622
· Create Generalization Set 620
· Change the Source or Target Element 614
· Set Relation Visibility 619
· Add a Note to a Connector 612
· Use Tree Style Hierarchy 625
· Create Connector in Project Browser 618
· Show Uses Arrow Head 625
· Set Association Specializations 623
· Change Sequence Message Scope 624 .

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions, if security
is enabled, you must have Update Element 198 permission to update or delete a connector.

4.7.2.1 Connect Elements

Connect Elements on a Diagram

The fastest and simplest ways to create connectors are using the Quick Linker and using the Toolbox. The
following topics describe these and other approaches for creating connectors on a diagram:
· Create Connectors In Place Using the Quick Linker 476
· Create Connectors Using the Toolbox 399
· Create a Group of Elements Using UML Patterns 901
· Create Domain Specific Connectors From UML Profiles 906 .

Tip:
To create another connector of the same type as the last connector you used, click on the appropriate source
element and press [F3].

Select Connectors
To select a connector, simply click on it. Drag handles display, indicating that the connector is selected. This
gives the connector focus for keyboard commands such as [Delete], and displays connector properties in
docked windows such as the Tagged Values window. If there is more than one connector on a diagram, you
can cycle through them using the arrow keys.

Drag Connectors
You can drag a connector to position it. Click on the connector and drag the connector to where it is to appear.
Note that there are some limitations on how far or to where you can drag a connector.

Notes:
· You can reposition a connector by selecting and dragging the connectors as required.
· If a connector has source and target roles, you can attach either end of the connector to a specific attribute
or operation 611 in the source or target element.

Tip:
To reattach the end of a connector to a different source or target element, see the Change the Source or
Target Element 614 topic.

Connector Properties and Commands

You can double-click on a connector to change properties 626 , or right-click to display the context menu

Enterprise Architect User Guide

 Modeling Fundamentals | Connectors 611

containing commands to change connector type 614 and direction 623 .

You can also highlight the connectors on a specific element. Select the element and press [L]. All the
connectors issuing from or terminating at that element are highlighted.

Create Connectors Without a Diagram

Sometimes it is useful to create relationships between elements without a diagrammatic representation. You
can do this using the Project Browser and the Relationship Matrix, as explained in the following topics:
· Add Connectors With the Project Browser 618
· Add Connectors With the Relationship Matrix 1266 .

4.7.2.2 Connect to Element Feature

If a connector has source and target roles, you can connect either end of the connector to a specific operation
or attribute in the source or target element. This is entirely a visual aid, to indicate which features are
significant in the relationship. In code generation or transformation, the link is interpreted as a normal source-
element to target-element relationship.
To do this, follow the steps below:
1. Right-click on the end of the connector joined to the element containing the required feature.
2. Select the Link to Element Feature context menu option. The Link to Element Feature dialog displays.

3. In the Feature Type field, click on the drop-down arrow and select the required feature type - Attribute
or Operation. The attributes or operations from the element are listed in the Feature field.
4. Click on the required attribute or operation, and click on the OK button.
The end of the connector changes to a bracket next to the selected feature.

You might create a number of feature-to-feature relationships between two elements (such as a Class and a
Table that represents the Class data) to produce a diagram similar to the following:

© 1998-2010 Sparx Systems Pty Ltd

 612 Modeling Fundamentals | Connectors

You can change the feature to which the connector is attached by following the above procedure and selecting
the new feature.
You can break the link to the selected feature in the following ways:
· Follow the above procedure, setting the Feature Type to None.
· Delete the attribute or operation from the element
· Change the connector type to a type that does not have source and target roles
· Change the connector to a different source or target element that does not contain the feature.
Note that reversing the direction of the connector does not break the connector's attachment to the feature.

4.7.2.3 Add a Note to a Connector

This topic describes how you can connect notes and constraints to graphical relationships.
Notes enable you to provide explanations and further detail for one or more connectors on a diagram, with a
visible note element, as in the example below.

Constraints let you specify a logical or informal constraint against a set of connectors; for example the {XOR}
constraint in the image above indicates that only one of the connectors in the specified set can be true at any
one time (exclusivity).

Attach a Note or Constraint to a Connector

To attach a note or constraint to one or more connectors, follow the steps below:

Enterprise Architect User Guide

 Modeling Fundamentals | Connectors 613

1. Right-click on one of the connectors to attach a note to. The context menu displays.
2. Select the Attach Note or Constraint menu option. The Link Relations dialog displays.
3. Check all the connectors that participate in the set. In the example below, two connectors have been
checked to participate in a logical constraint.

4. Click on the OK button to complete the note or constraint creation.

5. You can then use the normal Note dialog to enter the appropriate text for the note or constraint.

Note:
The constraint note is drawn slightly differently to a regular note, and has { and } automatically added
to visually indicate the constraint form.

4.7.2.4 Arrange Connectors

Connectors between two elements can be moved around the element borders to create a good layout. There
is a limit to how much a connector can be moved around, but generally it is very easy to find an acceptable
layout. For the best layouts, use the custom line style; this enables you to add as many line points and bends
as you require to create a clean and readable diagram.

Move a Connector
To move a connector, follow the steps below:
1. Click once on the connector to select it.
2. Holding the mouse button down, move the connector in the required direction.
3. To refine the movement, click and hold very near to one end of the connector; this enables a slightly
different movement range.
4. To further refine the movement and range, select either a routed, direct or custom line style. Each
behaves slightly differently (see Connector Styles 615 ).

© 1998-2010 Sparx Systems Pty Ltd

 614 Modeling Fundamentals | Connectors

4.7.2.5 Change Connector Type

To change a connector type, follow the steps below:
1. In the Diagram view, right-click on the connector to change. The context menu displays.
2. Select the Connection Detail | Change Type menu option.

3. In the Connector Type field, click on the drop-down arrow and select the required connector type.
4. Click on the OK button to apply changes.

4.7.2.6 Change the Source or Target Element

After you have created a connector between two elements, you might later want to change either the source or
target. Instead of deleting and re-creating the connector, Enterprise Architect enables you to change the
source or target. There are two ways of doing this: using the Set Source and Target dialog or using the mouse.

Using the Set Source and Target dialog

To change the source or target element of a connector using the Set Source and Target dialog, follow the
steps below:
1. Right-click on the connector to open the context menu.
2. Select the Advanced | Set Source and Target menu option. The Set Source and Target dialog
displays.

Enterprise Architect User Guide

 Modeling Fundamentals | Connectors 615

3. Click on the drop-down arrows on the From Element and To Element fields, and select the source and
target elements.
4. Click on the OK button to apply changes.

Using the Mouse

To change the source or target element of a connector using the mouse, follow the steps below:
1. Click on the connector and position the cursor over the 'handle' at one end.
2. When the cursor changes, click the mouse and drag the handle to the new element.

Note:
The connector does not actually move until you release the mouse button over the new source or target
element. However:
· A dotted line shows where the connector would be during the move, and
· The solid outline of the nearest element or extension changes to a hatched outline as you move the cursor
onto it; this helps you identify where the connector will connect to, if there are many closely-arranged
elements, Parts, Ports and other extensions.

4.7.2.7 Connector Styles

Connectors come in six different routing styles:

Style Description

Direct A straight line from element A to element B. You can move the line (back and forward,
up and down) to a limited degree.

Auto Routing A vertical and horizontal route from A to B with 90-degree bends. You can move the
line to improve the route, but the location and number of bends are not configurable.

Bezier A smooth curved line from A to B. Bezier style is directly available for Data Flow
diagram connectors, Mind Mapping connectors, State Flows, State Transitions, Object
Flows, and Control Flows.

Note:
You can convert other types of relationship to Bezier style by assigning the Tagged
Value _Bezier, with an integer value other than 0. However, some relationship types
(such as Aggregate) do not accommodate this style very well.
This Tagged Value over-rides the value of the Style field in the connector Properties
626 dialog.

Custom Line The most flexible option. You can add one or more line points and bend and push the
line into virtually any shape, using the Toggle Line Point at Cursor option.

Tree Style - A line from element A to B with two right-angle bends, and the end points fixed to
Vertical selected locations on the elements (Vertical or Horizontal).
Tree Style -
Horizontal

© 1998-2010 Sparx Systems Pty Ltd

 616 Modeling Fundamentals | Connectors

Style Description

Note:
You can convert relationships to Tree style by assigning the Tagged Value
_TreeStyle, with a value of H (Horizontal) or V (Vertical).
This Tagged Value over-rides the value of the Style field in the connector Properties
626 dialog.

Lateral - Vertical A line from element A to B with a single right-angle bend, and the end points fixed to
selected locations on the elements (Vertical or Horizontal).
Lateral - Horizontal
Note:
You can convert relationships to Lateral style by assigning the Tagged Value
_TreeStyle, with a value of LH (lateral-horizontal) or LV (lateral vertical).
This Tagged Value over-rides the value of the Style field in the connector Properties
626 dialog.

Set the Connector Style

To set the connector style, follow the steps below:
1. Right-click on the connector to change; the context menu displays.
2. Select the Line Style option.
3. From the submenu, select the required style - Direct, Auto Routing, Custom, Tree or Lateral (or Bezier,
where appropriate).
Alternatively:
1. Select the connector to change.
2. Press the following keys to change the style:
· [Ctrl]+[Shift]+[D] for Direct
· [Ctrl]+[Shift]+[A] for Auto Routing
· [Ctrl]+[Shift]+[C] for Custom
· ([Ctrl]+[Shift]+[Z] for Bezier, where appropriate).

Bend Connectors
To bend a connector to quickly and easily route connectors in the required layout, follow the steps below:
1. Right-click on the connector; the context menu displays.
2. Set the line style to Custom Line ([Ctrl]+[Shift]+[C]); this enables the Bend Line at Cursor option in
the context menu.
3. Click on the Bend Line at Cursor option to add a line point.

Note:
Right-clicking a line point displays the Straighten Line at Cursor context menu option, which you can
use to remove the line point.

4. Using the mouse, drag the line point to the required position.
Alternatively:
1. Hold down [Ctrl] or [Shift] and click on a point on the connector to create a line point.

Note:
[Ctrl]+click also removes a line point.

2. Using the mouse, drag the line point to the required position.

Enterprise Architect User Guide

 Modeling Fundamentals | Connectors 617

Tidy Line Angles

To tidy line angles (custom connector), follow the steps below:
1. Right-click on the connector; the context menu displays.
2. Click on the Tidy Line Angles menu option; this nudges the custom line in horizontal and vertical
increments, saving you the time of trying to get a good layout manually.

Note:
You can set the Tidy Line Angles option to operate by default; click on the Tools | Options menu
option to display the Options dialog, and select the Diagram Behavior page.

Suppress Line Segments

To suppress individual line segments, follow the steps below:
1. Right-click on the connector; the context menu displays.
2. Set the line style to Custom Line ([Ctrl]+[Shift]+[C]), this enables the Suppress Line Segment option
in the context menu.
3. Click on the Suppress Line Segment option to suppress a line between two bend points.

Note:
The segment you right-clicked on is suppressed.

4. To show the segment again, right-click on the line and click on the Show All Line Segments context
menu option.
One application for this is to represent the continuation of flow when your diagram crosses the page boundary
marker in the Diagram View. When you suppress the line segment that crosses the boundary, the link name
(connector properties) displays at both ends of the hidden segment. When you print the diagram on multiple
pages, the link name identifies the connection apparently broken by the page boundary.

© 1998-2010 Sparx Systems Pty Ltd

 618 Modeling Fundamentals | Connectors

4.7.2.8 Create Connector in Project Browser

You can create a connector from one element to another directly in the Project Browser.

Connect Elements from the Project Browser

To connect elements from the Project Browser, follow the steps below:
1. In the Project Browser, either:
· Right-click on the element to create a connector for, and select the Add | Create Link context menu
option, or
· Select the element, press [Insert] and select the Create Link context menu option.
The Create Link dialog displays.
2. In the Direction field, click on the drop-down arrow and select the direction of the new connector (
Outgoing means this element is the source).

3. In the Link Type field, click on the drop-down arrow and select the type of connector.
4. In the Choose target(s) list, click on the name of the target. (If necessary, in the Select Target Type
field click on the drop-down arrow and select a feature to list only elements having that feature.)
5. Click on the OK button to create the connector.

Note:
You can also reproduce an existing connector between two elements when you paste those elements from
the Project Browser into a diagram as instances. An option 430 enables you to copy the relationship as well,
or just the elements.

Enterprise Architect User Guide

 Modeling Fundamentals | Connectors 619

4.7.2.9 Relationship Visibility

You can change the visibility of individual connectors or relationships, diagram by diagram.

Set Relationship Visibility

To set relationship visibility, follow the steps below:
1. Open the diagram to change.
2. Select the Diagram | Visible Relations menu option. Alternatively, press [Ctrl]+[Shift]+[I]. The Set
Visible Relations dialog displays.

3. Select the checkbox against each list item to show, and clear the checkbox against each item to hide. If
you want to display the information in a more readable layout, you can resize the dialog.
4. Click on the OK button to apply the changes.

4.7.2.10 Delete Connectors

To delete a connector, follow the steps below:
1. Right-click on the connector. The context menu displays.

2. Select the Delete Connector option. The Remove Connector dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 620 Modeling Fundamentals | Connectors

3. This dialog provides the options to hide the connector so that it remains functional, or remove the
connector completely. Click on the appropriate radio button and click on the OK button.

If you select the Hide option, it has the same effect as hiding the connector 621 on the Links tab of the
source element Properties dialog, or using the Visibility | Hide Connector context menu option. It also
hides the connector on the Relationships 1269 window.

Note:
The dialog does not display if:
· You have previously selected the Don't ask again checkbox or
· On the Links page of the Options dialog (Tools | Options | Links) the Prompt on connector deletes
checkbox is not selected.
Selecting the Don't ask again checkbox also deselects the Prompt on connector deletes checkbox.
Selecting the Prompt on connector deletes checkbox restores the dialog if you have used the Don't ask
again checkbox.
If you hide the dialog, the Delete Connector context menu option defaults to the setting you last used on the
dialog. Make sure that you have selected the right option to default to.

4.7.2.11 Generalization Sets

A generalization set enables you to specify the relationship of a group of subtypes.
To create a generalization set, follow the steps below:
1. Right-click on the connector. The context menu displays.
2. Select the Advanced | Generalization Set | New menu option. The following dialog displays.

Enterprise Architect User Guide

 Modeling Fundamentals | Connectors 621

3. In the Name field, type the name of the Generalization set; for example, Gender.
4. In the Power Type field, either type a new power type, or click on the drop-down arrow or browser
button [ ... ] and select an existing one from the Select <Item> 515 dialog.
5. Check the IsMember column for the child subtypes that are part of this Generalization set.
The OMG UML specification (UML Superstructure Specification, v2.1.1, section 7.3.21, p. 77) states:
Each Generalization is a binary relationship that relates a specific Classifier to a more general Classifier (e.g.
from a class to its superclasses). Each GeneralizationSet defines a particular set of Generalization
relationships that describe the way in which a general Classifier (or superclass) may be divided using specific
subtypes.

4.7.2.12 Hide/Show Connectors

Connectors/relations that appear in multiple diagrams can be selectively shown or hidden. This makes it
easier to read diagrams where elements might have many connectors, but not all are relevant in the context of
the current diagram.

Hide or Show a Connector in the Current Diagram

To hide or show a connector in the current diagram, follow the steps below:
1. Double-click on the required diagram element in the Diagram view. The element Properties dialog
displays.
2. Select the Links tab. This lists the connectors linked to the element, whether or not they are hidden on
the diagram.
3. Right-click on the connector to hide or show. The context menu displays.
4. Select the Show Relation menu option to show the hidden connector on the diagram, or the Hide
Relation menu option to hide the visible connector.

© 1998-2010 Sparx Systems Pty Ltd

 622 Modeling Fundamentals | Connectors

Tip:
Alternatively, hide a connector by right-clicking on it on the diagram and selecting the Visibility | Hide
Connector context menu option. However, you must use the Links tab of the element Properties dialog to
show the relationship again.

Note:
Certain elements, such as Requirements, do not have a Links tab in the Properties dialog. In these cases,
open the Relationships 1269 window (View | Other Element Tools | Relationships) for the element and right-
click on the relationship in the list to display the context menu. This enables you to hide or show that
relationship in the diagram. Be aware that, in the Corporate, Business and Software Engineering, System
Engineering and Ultimate editions with security on, locks on the diagram and elements can make the required
option unavailable.

Hide or Show a Connector in Other Diagrams

To hide or show a connector in other diagrams, follow the steps below:
1. Right-click on the connector in the diagram. The context menu displays.
2. Select the Visibility | Hide Connector in Other Diagrams menu option. The Set Connector Visibility
dialog displays.

3. If the two connected elements have been included in other diagrams, these diagrams are listed here. In
the list, all diagrams for which the checkbox is selected show the connector. Deselect the checkbox for
any diagrams in which to hide the connector. If you want to display the information in a more readable
layout, you can resize the dialog.

Tip:
To hide the connector in all of the diagrams listed, click on the Suppress All button.

4. Click on the OK button to save the changes.

4.7.2.13 Hide/Show Labels

You can hide or display one or more labels on a connector. To do this, follow the steps below:
1. Right-click on the connector. The context menu displays.
2. Select the Visibility | Set Label Visibility menu option. The Label Visibility dialog displays.

Enterprise Architect User Guide

 Modeling Fundamentals | Connectors 623

If you have several, long labels, you can resize this dialog for greater clarity.

3. Select the checkbox against each label to display, and clear the checkbox against each label to hide.
4. Click on the OK button.

4.7.2.14 Connector In-place Editing Options

You can edit many of the Enterprise Architect connector labels directly on the diagram. Each label can be
bound to a single connector field.

Procedure
To put a label into Edit mode, either:
· Select the Edit Label option from the context menu, or
· Select a label and press [F2].
To save the current text to the field, either press [Return] or deactivate the Edit window.

To cancel edit mode without saving any changes, press [Esc].

4.7.2.15 Reverse Connector

You can reverse the direction of a connector without having to delete and re-create it. This is helpful if your
design changes or you add the connector wrongly to begin with.

Procedure
To reverse a connector, follow the steps below:
1. Right-click on the incorrect connector to open the context menu.
2. Select the Connection Detail | Reverse Direction menu option.

4.7.2.16 Set Association Specializations

UML enables specialization of properties defined by Associations. Enterprise Architect enables this through
the Specialize Associations option in the advanced section of the context menu for an Association.
The following dialog displays, showing all Associations between the two Classes connected by the current
Association and their parents.

© 1998-2010 Sparx Systems Pty Ltd

 624 Modeling Fundamentals | Connectors

The left two columns define the source role of the current Association, while the right two define the target
role. With this you are able to select the relationships of each end of the properties listed. When a relationship
is set then this is drawn at the corresponding end of the connector on any diagram it appears on.
The dialog above displays when you select the Advanced | Specialize Associations context menu option on
the lowest Association connector in the following diagram.

4.7.2.17 Change Sequence Message Scope

A message in a Sequence diagram represents a dynamic interaction from one element to another. Sometimes
when you are designing your model you might have to change either the start or end point of a message as
the responsibilities of elements change during design. For this reason, Enterprise Architect enables you to
change the message scope by setting a new start or end element.

Change Message Scope

To change message scope, follow the steps below:
1. Select the message in the Sequence diagram.
2. Right-click on the message to open the context menu.
3. Select Advanced | Set Source and Target.
4. In the pop up dialog, in the From Element and To Element fields, click on the drop-down arrows and

Enterprise Architect User Guide

 Modeling Fundamentals | Connectors 625

select the required elements.

5. Click on the OK button to save changes.
The message is re-routed to meet your changed requirements.

4.7.2.18 Show Uses Arrow Head

By default the Use connector in Use Cases has no arrow head. To generate arrow heads on the connectors,
follow the steps below.
1. Select the Tools | Options Links menu option. The Links page of the Options dialog displays.
2. In the General panel, select the Show Uses arrowheads checkbox.

3. Click on the Close button.

When you save the Use Case diagram, the Use connectors change to display arrowheads.

4.7.2.19 Tree Style Hierarchy

In Enterprise Architect you can create a tree style inheritance diagram using a special form of the
Generalization connector, as shown below.

Note:
The Son ->Parent connector has not yet been put in Tree Style - Vertical style.

This style of diagram provides a clearer layout for inheritance hierarchies and is easy to work with.

Create a Tree Style Connector

To create a tree style connector, follow the steps below:

© 1998-2010 Sparx Systems Pty Ltd

 626 Modeling Fundamentals | Connectors

1. Create a normal Generalization between two elements.

2. Right-click on the connector to open the context menu.
3. Select the Line Style | Tree Style - Vertical or the Line Style | Tree Style - Horizontal menu option.
4. Enterprise Architect automatically makes the Generalization layout conform to a specific shape. By
adding more Generalization connectors, and checking their Tree Style options, you can achieve the
appearance of the diagram above. You can slide the root and child Classes left and right to achieve the
required result; Enterprise Architect maintains the conformity of the branch connectors.

Set the Default Connector Style

To set this style of connector as default, follow the steps below:
1. Select the Tools | Options | Links menu option. The Links page of the Options dialog displays.

2. Select the Generalization link style Default = Tree checkbox to make this branching style the default
style for inheritance connectors.

4.7.3 Connector Properties

To access the connector Properties dialog, double-click on a connector in a diagram. You can change several
characteristics of connectors from this dialog.
Many of these characteristics generate text labels on or around the connector. You can change these labels
using the Label 452 context menu.
The connector Properties dialog has the following tabs:
· General (see below)
· Constraints 628
· Source Role 629
· Target Role 631
· Tagged Values. 631
The General tab enables you to configure the name of the connector, the direction, the line style, the
stereotype (optional) and a comment.

Enterprise Architect User Guide

 Modeling Fundamentals | Connectors 627

Option Use to

Source Type in the name of the source element for the connector.

Target Type in the name of the target element for the connector.

Name (Optional) Type a name for the connector. If entered, the name displays on the diagram.

Alias (Optional) Type an alternative name or alias for the connector.

Direction Select the appropriate direction details: from source to destination, destination to
source, or bi-directional.
Some connectors have arrow heads that depend on this setting. Some connectors are
logically dependent on this (such as Inheritance).

Style Select the appropriate connection style; choose from: Direct, Auto-Routing, Bezier,
Custom, Tree (Vertical) or Tree (Horizontal).

Stereotype (Optional) Type the name of a stereotype for the connector, or click on the drop-down
arrow and select one. Alternatively, click on the [ ... ] button and select the stereotype
from the Stereotype Selector 897 dialog.
If entered, the stereotype is displayed on the diagram and over-rides the connector type
in the RTF documentation.

Virtual Indicate that inheritance is virtual. Available only for Generalization connectors.
Inheritance

Scope Select the appropriate value for the scope (used for inheritance). Available only for
Generalization connectors where the child Class is C++.

© 1998-2010 Sparx Systems Pty Ltd

 628 Modeling Fundamentals | Connectors

Option Use to

Notes (Optional) Type any notes on the connector. The notes are displayed in documentation,
if required.
As for the Notes 641 window, you can format the text, using the Rich Notes Text 642
toolbar at the top of the field.

See Also
· Message Scope 624

4.7.3.1 Connector Constraints

A UML connector can also have associated constraints placed on it. Constraints tell us something about the
rules and conditions under which a relation operates. For example, it might be a pre-condition that a customer
is of a certain type before an Association connector to an Account is allowed.

Tip:
Constraints about an Association (connector) can be added to further refine the model. Constraints detail the
business and operational rules for the model.

Set Constraints on a Connector

To set constraints on a connector, follow the steps below:
1. Double-click on a connector to open the Connector Properties dialog.
2. Select the Constraints tab.
3. Fill in details of the constraint(s) that apply and click on the Save button.

Enterprise Architect User Guide

 Modeling Fundamentals | Connectors 629

Option Use to

Constraint Type in the name of the constraint.

Type Specify the type of constraint (such as pre-condition).

Notes Type in any notes about the connector.

Defined Constraints Review the list of constraints for this connector.

4.7.3.2 Source Role

This description refers to the role of the Source element in a relationship, but applies equally to the role of the
Target element.
A connector can have certain properties assigned to one end, and be associated with the particular role that
element plays in the relationship. You can enter details about this role to further develop your model.

Set Source Role Details

To set the source role details, follow the steps below:
1. Double-click on a connector. The Connector Properties dialog displays.
2. Select the Source Role tab.
3. Enter the required details and click on the OK button.

Option Use to

<Type> Role Type in or select the name of the role to be played.

Alias Type an alias for the role, if required.

© 1998-2010 Sparx Systems Pty Ltd

 630 Modeling Fundamentals | Connectors

Option Use to

Role Notes Type in any required notes about the role.

Derived Indicate that the role value or values can be computed from other information.

Owned Indicate that the role is owned by the opposite Class rather than the Association.
Selecting this checkbox adds a 'dot' to the appropriate end of the connector. ( )

Derived Union Indicate that the role is derived from the properties that subset it.

Multiplicity Specify the role multiplicity. (You can define the values of this field on the Cardinality 665
tab of the UML Types dialog.)
This is the range of instances of the role that can be active in the relationship; for
example, one employee can be assigned to tasks; for the target role you define the range
of instances (such as tasks) the employee could be assigned to.
The values have the following formats:
· *, or 0..* - zero, one or many instances
· 0..n - zero or up to n instances, but no more than n
· n - exactly n instances
· n..* - n, or more than n instances.
Note that you can also define source and target element multiplicity in the element
Attribute properties 562 .

Ordered Indicate that the role is a list and the list is ordered.

Allow Indicate that the role can contain duplicate elements (relevant only if multiplicity is > 1).
Duplicates
Maps to the UML property isUnique (selecting the checkbox maps to the isUnique value of
FALSE).

Containment Indicate the nature of the containment at the Destination (reference, value...).

Access Select the access level for the role.

Aggregation Select the type of aggregation that this role uses.

Target Scope Select the level at which this role applies (instance or classifier).

Navigability Select whether or not this role is navigable (non-navigable ends are shown depending on
diagram properties).

Changeable Select whether this role is subject to change.

Constraint(s) Type in any constraint on the role.

Qualifier(s) Type any qualifiers or restrictions on the role. Separate multiple qualifiers with a semi-
colon.
Alternatively, click on the [ ... ] button at the end of the field, and define a new qualifier on
the Qualifiers 832 dialog. (Qualifiers typed into the Qualifier(s) field are also automatically
added to this dialog.)

Stereotype (Optional) Type the name of a stereotype that applies to this end of the Association, or
click on the [ ... ] button at the end of the field and select a stereotype from the Stereotype
Selector 897 dialog.

Member Type Type a role type that can be used when generating collection Classes for multiplicity > 1.

Enterprise Architect User Guide

 Modeling Fundamentals | Connectors 631

Note:
Source role details are displayed at the start end of a connector. If you have drawn the connector the wrong
way, you can always use the Reverse Direction menu option from the connector context menu.

4.7.3.3 Target Role

A connector can have certain properties assigned to one end, and be associated with the particular role that
element can play in the relationship.
You can enter details about this role to further develop your model.

Set Destination Role Details

To set the destination role details, follow the steps below:
1. Double-click on a connector to open the Connector Properties dialog.
2. Select the Target Role tab.
3. The details and appearance of this tab are identical to the Source Role tab. See Source Role 629 .

Note:
Destination role details are displayed at the terminating end of a connector on the diagram.

4.7.3.4 Connector Tagged Values

The Tagged Values tab of the connector Properties dialog simply provides the Tagged Values 632 window
within the frame of the Properties dialog. You can define Tagged Values for the connector and, on Association
and Aggregation connector types, you can set additional Tagged Values for the source and/or target role.

Set Tagged Values

To set Tagged Values for the connector, follow the steps below:
1. On the Properties dialog for the connector, click on the Tagged Values tab.

2. Select the connector type, Connector Source or Connector Target as required.

3. Either click on the New Tags button or press [Ctrl]+[N]. The Tagged Value dialog displays.

4. In the Tag field type the tag name and value, or click on the drop-down arrow and select a predefined
Tagged Value type.
5. Click on the OK button to save the changes.

© 1998-2010 Sparx Systems Pty Ltd

 632 Modeling Fundamentals | Tagged Values

4.8 Tagged Values

What is a Tagged Value?

Tagged Values are a convenient way of adding additional information to an element, in addition to that directly
supported by UML. UML provides the Tagged Value element for just this purpose. Often Tagged Values are
used during code generation or by other tools to pass information or operate on elements in particular ways.
Tagged Values are the preferred method of extending the code generation capabilities of the modeling tool per
element, per language.
A Tagged Value, strictly, is the value of a property of a modeling item 633 , the property being called a tag. For
example, a Class element called Person might have a tag called Age with the Tagged Value of 42. More
loosely, the combination of tag and value can be referred to as a Tagged Value.
A Tagged Value Type 664 is a group of parameters that define and/or limit the possible values of a tag and, in
many instances, how a specific value is assigned to the tag. For example, the tag Age might have a Tagged
Value Type of Integer, so the user simply types in a numeric value. Alternatively, the type could be Spin, with
lower and upper limits of, say, 20 and 120, so the user sets a value by clicking on arrows in the field to
increment or decrement the value within the limits of 20 and 120.
To quickly add Tagged Values to one of more elements, see the Quick Add - Tagged Value to Elements 634
topic.

The Tagged Values Window

The Tagged Values window is used to view and modify Tagged Values for the currently selected modeling
item, either in the current diagram or in the Project Browser.
The Tagged Values window is, by default, set to hide fully qualified values (which show exactly where the
Tagged Value came from) and duplicate values, as in the first window below. If you prefer, you can change the
settings to show duplicate values 637 and fully-qualified values, as in the second window below:

Enterprise Architect User Guide

 Modeling Fundamentals | Tagged Values 633

Note:
Fully qualified Tagged Values can be displayed only if the Tagged Value was created in Enterprise Architect
release 7.1 or later. You cannot display the fully qualified path for Tagged Values from earlier releases.

The Tagged Values window is a dockable window. You can use it to perform the following actions:
· Assign a Tagged Value to an Item 635
· Modify Tagged Values 635
· Assign Notes to a Tagged Value 636
· Perform advanced tag management. 638
A Technology Developer can also create new structured Tagged Values, reference data Tagged Values and
custom Tagged Values 1171 from predefined Tagged Value Types 1166 .

Model Elements and Features with Tagged Values

The following model components can use the Tagged Values window as a convenient way to quickly view and
modify Tagged Values:

Component Description

Elements Elements display their own Tagged Values along with any inherited values.

Object Instances Object Instances display owned tags and those obtained from their classifier.

Ports and Parts Ports and parts display information similar to objects and display Port/Part 'Type' instead
of a classifier. Tags are included for all parents and other structures of the Ports type.

Attributes Include owned Tagged Values and those received from attribute type classifiers, with the
inclusion of any inherited ones.

Operations Owned properties only.

Connectors Owned properties only.

When over-riding an inherited property, Enterprise Architect copies the tag from the parent down to the child
element and sets the new value, leaving the original tag unchanged.

© 1998-2010 Sparx Systems Pty Ltd

 634 Modeling Fundamentals | Tagged Values

To edit Tagged Values, use the Tagged Values toolbar, as described below.

Tagged Values Toolbar Buttons

The buttons in the Tagged Values toolbar enable you to add, edit, sort, delete and arrange the Tagged Values
of model features.

From left to right, the button functions are as follows:

· The Show in compartments button displays the Tagged Values in element compartments on diagrams
· The Sort and Show Alphabetically button sorts the current Tagged Values for the element alphabetically
· The New Tagged Value button adds a new tag, to which you assign a value
· The Edit Tagged Value Notes button enables you to create notes that explain the purpose of the Tagged
Value
· The Delete Tagged Value button removes the currently selected Tagged Value
· The Default Tagged Value Types button enables quick access to tag definitions created in the
Configuration menu
· The Tagged Value Options button enables you to show or hide the fully qualified paths for the Tagged
Values in the window, and to show duplicate Tagged Values
· The Help button displays help relating to use of the Tagged Values window.

4.8.1 Quick Add - Tagged Value To Elements

It is possible to add a single Tagged Value to one or more elements with a special shortcut.
1. From an element context menu (or the context menu of a multi-selection) choose the Add | Tagged
Value menu option. (Alternatively, select one or more elements and press [Shift]+[Ctrl]+[T]). The
Tagged Values dialog displays, which enables you to enter a Name and Value for the tag.

2. Click on the OK button to add your new Tagged Value to all the currently selected elements.

Note:
You can also use the Current Element toolbar. The last button is a shortcut to the Add Tagged Value
function.

To delete this property you must open the element Properties dialog, go to the Tagged Values tab and
manually delete the item. There is currently no shortcut to delete tags from multiple elements simultaneously.
To add notes to the Tagged Value, go to the Tagged Values tab, click on the Tagged Value name, and click
on the Edit Notes button in the tab toolbar. The Notes dialog displays.

Enterprise Architect User Guide

 Modeling Fundamentals | Tagged Values 635

Any Notes text you enter also displays in the Info section at the bottom of the Tagged Values window.

4.8.2 Assign a Tagged Value to an Item

You can assign Tagged Values to several model features, as listed in the Model Elements and Features with
Tagged Values 633 topic.
To add a Tagged Value follow the steps below:
1. If necessary, create user-defined tags using a predefined Tagged Value Type 1166 .
2. Select the model feature to associate with the defined Tagged Value.
3. Ensure that the Tagged Values window is visible (select the View | Tagged Values menu option, or
press [Ctrl]+[Shift]+[6]).

Alternatively, open the Properties dialog for the object and select the Tagged Values tab.
4. Either click on the New Tags button or press [Ctrl]+[N]. The Tagged Value dialog displays.

5. In the Tag field, type the tag name or click on the drop-down arrow and select the appropriate tag to
assign to the item.

Note:
Direct entry of predefined Tagged Values is only available for predefined tags of type string.

6. If appropriate, type a specific value for the tag in the Value field.
7. To confirm selection of the Tagged Value, click on the OK button.

Modify Tagged Values with the Tagged Values Window

Once a Tagged Value has been assigned to the model feature it is possible to edit the values from the Tagged
Values window. To edit the Tagged Values follow the steps below:
1. Click on the View | Tagged Values menu option, or press [Ctrl]+[Shift]+[6]. The Tagged Values
window displays.
2. Click on the model feature for which to edit the Tagged Values. The window shows all of the tags for the
© 1998-2010 Sparx Systems Pty Ltd
 636 Modeling Fundamentals | Tagged Values

selected feature, each with their current value.

3. Edit the fields as appropriate. The information entered can only reflect the value types that have been
defined by the tag's Tagged Value Type.
There are four types of value field for a Tagged Value:
· 'Open' fields, in which you can type any appropriate value
· 'Drop-down list' fields, where you click on the drop-down arrow to select from a discrete list of possible
values such as M or F, or Win, Lose or Draw
· 'Spin' fields, where you click on up or down arrows in the field to increase or decrease the value within
certain limits
· 'Further detail' fields, where you click on an ellipsis ([...]) in the field to display a dialog in which you enter
information (such as notes) or indicate a source of further information (such as a classifier 515 ).
The example below shows a value being modified, using a drop-down list.

Note:
To override a Tagged Value defined in a parent element, edit the value in the from <parentname>
compartment of the Tagged Values window. Once this has been done the tag is moved into the selected
element's Tagged Values; this does not affect the Tagged Values defined in the parent element.

4.8.3 Assign Notes to a Tagged Value

Once the Tagged Value has been assigned to a model feature 633 , it is possible to add information and notes
describing the Tagged Value to the information property of the Tagged Value. To facilitate this from the
Tagged Values window, follow the steps below:
1. Click on the View | Tagged Values menu option, or press [Ctrl]+[Shift]+[6]. The Tagged Values
window displays.
2. Click on the model feature for which to edit the Tagged Values; its Tagged Values display in the Tagged
Values window.
3. Click on the Tagged Value to add information to.
4. Click on the Edit Tagged Value Notes button or press [Ctrl]+[E]. The Tagged Value Note dialog
displays.

Enterprise Architect User Guide

 Modeling Fundamentals | Tagged Values 637

5. In the Note field, type the information relating to the Tagged Value, then click on the OK button. The
information is displayed in the lower portion of the Tagged Values dockable window whenever the
Tagged Value is selected.

4.8.4 Show Duplicate Tags

Tagged Values are by default set to hide duplicate values. This setting is used to facilitate inherited and
overridden tag names.
To set the Tagged Values window to show duplicate values, follow the steps below:
1. On the Tagged Values window toolbar, click on the Options icon.
2. Select the Show Duplicate Tags context menu option.
Alternatively:
1. Select the Tools | Options menu option. The Options dialog displays.
2. From the hierarchical tree, select the Objects item.

© 1998-2010 Sparx Systems Pty Ltd

 638 Modeling Fundamentals | Tagged Values

3. Select the Show Duplicate Tags checkbox.

In either procedure, to hide duplicate values again deselect the option or check box.

4.8.5 Advanced Tag Management

Tagged Values can also be managed within a type hierarchy and with respect to element instances, using the
Tagged Values 632 window.
Using the Tagged Values window it is possible to:
· View Tagged Values inherited from parent Classes or realized interfaces or applied stereotypes
· Override Tagged Values derived from parents or applied stereotypes with a unique value for the current
element
· Delete Tagged Values from the current element (if a parent version of the Tagged Value exists, it re-
appears in the list after the override is deleted).

Enterprise Architect User Guide

 Modeling Fundamentals | Tagged Values 639

The diagram below illustrates a complex tag hierarchy and the way Tagged Values can be either inherited or
overridden in specialized Classes to create the final tagged property set for an element.
Note also that a similar concept applies to instances, in which case the full tag set is created from the directly
owned tags, plus all of those merged in from the classifier's type hierarchy, additional stereotypes and realized
interfaces.

© 1998-2010 Sparx Systems Pty Ltd

 640 Modeling Fundamentals | Tagged Values

Enterprise Architect User Guide

 Modeling Fundamentals | Notes 641

4.9 Notes

You use the Notes window to view and edit the documentation (notes) associated with elements, diagrams,
attributes, operations and connectors, either from a diagram (for both elements and connectors) or from the
Project Browser (elements only). When you select an element, the note displayed changes to reflect the
current selection. If you make changes to notes in this window, they are saved.
Notes are the main documentation feature you use to describe an element or connector. In the documentation
that Enterprise Architect generates, notes feature prominently.
If you want to display the Notes information in a more readable layout, you can resize the dialog. You can also
format the notes text using the Notes 642 toolbar at the top of the Notes window.

You can cut, copy, paste and delete text in the Notes window, or in any Notes or Description field that shows
the Notes toolbar, using a right-click context menu. From the context menu, you can also select an option to
spell-check a highlighted word.

Tip:
You can also edit notes by double-clicking on an element or connector in a diagram or in the Project Browser,
to open the Properties dialog. Any formatting changes made in one display are reflected in the other.

Note:
On the Testing, Maintenance and Project Management windows, any descriptive, history, input or results text
for a selected item is also displayed in the Notes window. You cannot edit this text in the Notes window.

Glossary Entries
The Notes window or field also enables you to create a Project Glossary 323 entry from text you have
highlighted in the window or field. To create the Glossary entry, follow the steps below:
1. Highlight the notes text to use as the Glossary definition (if suitable text is available), and press [Ctrl]
+[C] to copy it.
2. Highlight the text to use as the Glossary term, and right-click on it to display the context menu.
3. Select the Create | Glossary Definition menu option. The Glossary Detail 325 dialog displays, with the
selected term in the Term field.

© 1998-2010 Sparx Systems Pty Ltd

 642 Modeling Fundamentals | Notes

4. If you have copied some definition text, paste it into the Meaning field. Otherwise type a suitable
definition of the term in this field.
5. In the Type field, select the appropriate term type.
6. Click on the Apply button to save the new Glossary definition.
The term displays in the Notes text as a roll-over hyperlink (as shown in the above screen illustration) which,
when you move the cursor over it, displays the Glossary definition of the term.
Having created a glossary definition anywhere else in the model, you can insert the glossary term in the text of
the Notes window (or Notes panel of a dialog) as a rollover hyperlink to the definition. To do this:
1. In the Notes dialog, move the cursor to the point in the text at which to insert the glossary term.
2. Press [Ctrl]+[Space]. The glossary term selection list displays.

3. Double-click on the term to insert in the Notes text. The term is inserted as a rollover hyperlink to the
definition.

4.9.1 Notes Toolbar

Although it is not an independent toolbar that you can pin to the screen top or sides, or float in your work area,
the Notes toolbar appears in many places across Enterprise Architect in the Notes and Description fields of:
· The element Properties dialog:
· General tab
· Requirements tab
· Scenario tab
· Hyperlink Notes
· The Diagram Properties dialog
· The Connector Properties dialog
· The Message Properties dialog
· The Operations and Attributes Properties dialogs
· The Testing Window descriptions
· The Notes window
· The Rules and Scenarios Window for:
· Requirements
· Linked Requirements
· Scenarios.

Enterprise Architect User Guide

 Modeling Fundamentals | Notes 643

Notes:
· If the toolbar is displayed but grayed out, the text field is read-only and cannot be edited. Other
Description or Notes fields in Enterprise Architect might not have the toolbar, in which case the Notes
facility is not available for those fields.
· For any Notes text that is displayed on a diagram, you must select the Render Formatted Notes
checkbox on the Feature Visibility 438 dialog 438 in order to reproduce the formatting.
· You can create a Project Glossary 323 term and definition from text in any field that has the Notes toolbar.
See The Notes Window 641 .

The options of this toolbar operate on selected text and any new text continuing from the formatting. The
options (with some keyboard shortcuts) are, from left to right:
· Make text bold [Ctrl]+[B]
· Make text italic [Ctrl]+[I]
· Underline text [Ctrl]+[U]
· Change the font color of the text
· Insert list bullet points [Ctrl]+[.] (full stop)
· Insert list numbering [Ctrl]+[1]
· Make text superscript
· Make text subscript
· Insert a hyperlink - this displays the following Hyperlink Details dialog, on which you specify the type of
hyperlink and type in or browse for the location of the target of the hyperlink.

Additional keyboard shortcuts:

· Undo changes [Ctrl]+[Z]
· Redo changes [Ctrl]+[Y] or [Ctrl]+[Shift]+[Z]
· Copy [Ctrl]+[C]
· Paste [Ctrl]+[V]
· Cut [Ctrl]+[X]
Any Note text appearing in the element Note compartments in diagrams is not formatted.

© 1998-2010 Sparx Systems Pty Ltd

 644 Modeling Fundamentals | Reference Data

4.10 Reference Data

Reference data is used in many places to provide content for drop-down list boxes. Setting up a project often
involves setting up the base set of reference types to use. Reference data options can be set up from the
Settings menu, including:
· People 645
· General Types 653
· Maintenance 660
· Metrics and Estimation 659

· UML 662
· Data Types 666
Having set up the reference data in a project, you can also export and import 223 it between projects.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Manage Reference Data - Update 198 permission
to update and delete reference items.

Enterprise Architect User Guide

 Modeling Fundamentals | Reference Data 645

4.10.1 People
The People dialog enables you to control the following for your project:
· Project Authors 645
· Project Roles 648
· Project Resources 650
· Project Clients 651

To display this dialog, select the Settings | People menu option.

4.10.1.1 Project Authors

You can define the people who are working on a project, such as the authors of specific elements.
To define the project authors, select the Settings | People menu option. The People dialog displays, defaulted
to the Project Author(s) tab.

© 1998-2010 Sparx Systems Pty Ltd

 646 Modeling Fundamentals | Reference Data

Complete the fields as described below:

Option Use to

Name Type the name of the person registered as a Project Author.

If you are using a Windows Active Directory, you can select names from the directory.
Click on the [ ... ] (Browse) button to display the Select Users 647 dialog.
You can also type a list of names separated by semi-colons. This enables you to define
a group of people sharing a role, such as a team of Developers, Testers or Analysts. Do
not leave any spaces between the names and the semicolon.

Note:
If you enter multiple names, Enterprise Architect adds them separately and in
alphabetical order to the Defined Authors list. If you then click on one of these names,
Enterprise Architect displays that name only in the Name field.

Role Specify the role the Project Author plays in the project (such as Designer, Analyst, or
Architect).
You can type a role name or click on the drop-down arrow and select a role defined
through the Project Roles 648 tab.

Enterprise Architect User Guide

 Modeling Fundamentals | Reference Data 647

Option Use to

Note:
If you type a role, this is not added to the roles on the Project Roles tab.

Notes Type any additional notes concerning the Project Author.

Defined Authors Review the Project Authors already defined.

Click on the Save button to add the new names to the Defined Authors list.

To add further Authors, click on the New button.

To delete a Project Author, click on the name in the Defined Authors list and click on the Delete button.

Note:
You can transport these author definitions between models, using the Export Reference Data 223 and
Import Reference Data 225 options on the Tools menu.

Select from User Directory

If your company is using a Windows Active Directory, you can select the Project Author names from the local
or corporate-wide directory. To do this, follow the steps below:
1. On the Project Author(s) tab, click on the [ ... ] button. The Select Users dialog displays.

2. Click on the Object Types button and select the checkbox for the object type User.
3. Click on the OK button to return to the Select Users dialog.
4. Click on the Locations button. The Locations dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 648 Modeling Fundamentals | Reference Data

5. Click on the appropriate area or level of the directory, and click on the OK button. The Select Users
dialog redisplays.
6. In the Enter the object names to search field, type the first letter of the user name to search for.
7. Click on the Check Names button. The Multiple Names Found dialog displays, listing the names
starting with the specified letter found in the directory location.
8. Click on the required name (or press and hold [Ctrl] and click on several names), and click on the OK
button. The simple Select Users dialog redisplays, with the selected names listed.
9. Click on the OK button. The Project Authors tab redisplays, with the selected name or names in the
Name(s) field.

4.10.1.2 Project Roles

People associated with a project play a role in analysis, design or implementation, such as Application
Analyst, Architect, Developer and Project Manager. Project roles define the activities that resources can
undertake.
To define the role types that are captured within Enterprise Architect, select the Settings | People menu
option and, on the People dialog, click on the Project Roles tab.

Enterprise Architect User Guide

 Modeling Fundamentals | Reference Data 649

To add further roles, click on the New button and complete the fields as described below:

Option Use to

Role Type the name of the role.

Description Type a short description of the role.

Notes Type any additional information related to the role.

Defined Roles Review all roles that have been previously defined in Enterprise Architect.

Click on the Save button to add the new role to the Defined Roles list.
The Defined Roles list is available for selection for any element in the model; for example, you can select roles
on the Project Authors 645 tab of the People dialog, and the Resource Allocation 314 tab of the Project
Management window. You can also specify other roles on these dialogs, but such roles are not added to the
Defined Roles list.
To delete a role, click on the role type in the Defined Roles list and click on the Delete button.

© 1998-2010 Sparx Systems Pty Ltd

 650 Modeling Fundamentals | Reference Data

Notes:
· Deleting a role has no effect on any Project Author definition having this role; the deleted role becomes a
simple text entry in the Project Author definition.
· You can transport these role definitions between models, using the Export Reference Data 223 and
Import Reference Data 225 options on the Tools menu.

4.10.1.3 Project Resources

Resources are, for example, project authors, analysts, programmers and architects. That is, anyone who
might work on the system over time, either adding to the model or programming and designing elements of the
system outside Enterprise Architect.
To record information on project resources, select the Settings | People menu option and, on the People
dialog, click on the Resources tab.

Complete the fields as described below:

Option Use to

Name Type the name of the person listed as a resource. The resource name is
available for use in Resource Management 314 .

Organization Type the name of the organization employing the resource.

Enterprise Architect User Guide

 Modeling Fundamentals | Reference Data 651

Option Use to

Role(s) Type the role the resource plays in the project (for example, Designer,
Analyst, Architect).

Phone 1, Phone 2, Mobile, Type the contact telephone numbers for the resource.
Fax

Email Type the email address for the resource.

Notes Type any additional notes on the resource.

Available Resources Review resources that have already been defined.

Click on the Save button to add the new resource to the Available Resources list.

To add further resources, click on the New button.

To delete a resource, click on the name in the Available Resources list and click on the Delete button.

Note:
You can transport these resource definitions between models, using the Export Reference Data 223 and
Import Reference Data 225 options on the Tools menu.

4.10.1.4 Project Clients

Project clients are the eventual owners of the software system.
To capture client details associated with the current model, select the Settings | People menu option and, on
the People dialog, click on the Project Clients tab.

© 1998-2010 Sparx Systems Pty Ltd

 652 Modeling Fundamentals | Reference Data

Complete the fields as described below:

Option Use to

Name Type the name of the client.

Organization Type the name of the organization that employs the client.

Role(s) Type the role the client plays in the project (for example, Manager,
Sponsor).

Phone 1, Phone 2, Mobile, Fax Type the contact telephone numbers for the client.

Email Type the email address of the client.

Notes Type additional notes on the client.

Defined Clients Review clients that have already been defined.

Click on the Save button to add the new client to the Defined Clients list.

To add details of further clients, click on the New button.

To delete a client record, click on the name in the Defined Clients list and click on the Delete button.

Enterprise Architect User Guide

 Modeling Fundamentals | Reference Data 653

Note:
You can transport these client definitions between models, using the Export Reference Data 223 and Import
Reference Data 225 options on the Tools menu.

4.10.2 General Types

The General Types dialog enables you to configure:
· Status types 653
· Constraint types 655
· Constraint Status types 656

· Requirement types 657

· Scenario types. 658
To display the General Types dialog, select the Settings | General Types menu option.

4.10.2.1 Status Types

You can configure a basic list of status types used in Enterprise Architect. Note that whilst most dialogs use
this list, not all do so.
To configure status types, select the Settings | General Types menu option. The General Types dialog
displays at the Status tab.

© 1998-2010 Sparx Systems Pty Ltd

 654 Modeling Fundamentals | Reference Data

Create New Status Type

When you display the Status tab, the fields default to the definition of the first type in the Type list. To add a
new type, click on the New button and:
· In the Status field, type the name of the status
· In the Description field, type a short description of the status
· Click on the Save button.
The status type displays in the Type list. Add the status definition as described in the following sections.

Note:
You can transport the status types (and the colors assigned to status types) between models, using the
Export Reference Data 223 and Import Reference Data 225 options on the Tools menu.

Status Type Color

It is possible to assign a color to each status type, which gives a visual indication of the status of each diagram
object. Select a named status type from the Type list, click on the Status Type Colordrop-down list and select
the color for that status. Click on the Save button to keep your changes.

Note:
To ensure status colors display on your diagrams, open the Options dialog at the Objects 362 page and select
the Show status colors on diagrams checkbox.

Apply Colors to UML Elements

By default, status colors only apply to Requirement 846 , Issue 1563 and Change 1564 elements. You might decide
to also apply these colors to other UML elements, such as Use Cases or Classes. To do this, click on the
Applies to... button and select the checkbox against each required element type in the Applied Status Colors
list.

Enterprise Architect User Guide

 Modeling Fundamentals | Reference Data 655

Note:
Requirement, Feature, Issue and Change elements have a status color compartment, but other elements do
not. The status color for these elements is applied to the element shadow. Therefore, on the Options dialog
Diagram Appearance 356 page you must also select the Element Shadows on checkbox.

4.10.2.2 Constraint Types

The Constraint tab of the General Types dialog enables you to define constraints. These are picked up in a
variety of places where constraints might fall into more categories than the basic (default) Pre-, Post- and
Invariant conditions.
To access this dialog, select the Settings | General Types menu option. Click on the Constraint tab.

© 1998-2010 Sparx Systems Pty Ltd

 656 Modeling Fundamentals | Reference Data

To add a new constraint, click on the New button and:

· In the Constraint field, type the name of the constraint; for example, Assumption
· In the Description field, type a brief description of the constraint
· In the Note field type any additional information required
· Click on the Save button.
The constraint displays in the Defined Constraint Types list.

Note:
You can transport these constraints between models, using the Export Reference Data 223 and Import
Reference Data 225 options on the Tools menu.

4.10.2.3 Constraint Status Types

You can configure the basic list of constraint status types used in Enterprise Architect, using the Constraint
Status tab of the General Types dialog.
To access this dialog, select the Settings | General Types menu option. Click on the Constraint Status tab.

Enterprise Architect User Guide

 Modeling Fundamentals | Reference Data 657

To add a new constraint status type, click on the New button, type the status type in the Status field, and click
on the Save button. The constraint status type displays in the Status list.

Note:
You can transport these constraint status types between models, using the Export Reference Data 223 and
Import Reference Data 225 options on the Tools menu.

4.10.2.4 Requirement Types

The Requirement tab of the General Types dialog enables you to specify the generic set of requirement types
that can be entered into the requirements sections of dialogs. This helps to maintain a single set of typed
requirements.
To access this dialog, select the Settings | General Types menu option. Click on the Requirement tab.

© 1998-2010 Sparx Systems Pty Ltd

 658 Modeling Fundamentals | Reference Data

To add a new requirement type, click on the New button and:

· In the Requirement field type the name of the requirement type
· In the Description field type a short description of the requirement type
· In the Weight field type the weighting to apply to the requirement type
· In the Note field, type any additional information on the requirement type
· Click on the Save button.
The requirement type displays in the Defined Requirement Types list.

Note:
You can transport these requirement types between models, using the Export Reference Data 223 and
Import Reference Data 225 options on the Tools menu.

4.10.2.5 Scenario Types

A drop-down list of scenario types is available in the Scenario 490 tab of an element Properties dialog, with the
standard types Basic Path, Exception and Alternate Flow. You can set additional scenario types using the
Scenario tab the General Types dialog.
To access this dialog, select the Settings | General Types menu option. Click on the Scenario tab.

Enterprise Architect User Guide

 Modeling Fundamentals | Reference Data 659

To add a new scenario type, click on the New button and:

· In the Scenario Type field type the name of the scenario type
· In the Description field type a short description of the scenario type
· In the Weight field type the weighting to apply to the scenario type
· In the Note field, type any additional information on the scenario type
· All four fields must be completed. Click on the Save button.
The scenario displays in the Defined Scenario Types list.

Note:
You can transport these scenario types between models, using the Export Reference Data 223 and Import
Reference Data 225 options on the Tools menu.

4.10.2.6 Metrics and Estimation

TCF values, EFC values and Default Hour Rate for a project are controlled from the Estimation Factors dialog.
Risk, metric and effort types for a project are controlled from the Project Indicators dialog.
For further information on these see the Project Management 312 and Resource Management 313 topics, or
specifically:
· Technical Complexity Factors 336
· Environment Complexity Factors 337
· Default Hours 340
· Effort Types 319
· Metric Types 320
· Risk Types. 322
© 1998-2010 Sparx Systems Pty Ltd
 660 Modeling Fundamentals | Reference Data

4.10.3 Maintenance
To control Testing types 661 for your project, select the Settings | Maintenance menu option to display the
Maintenance dialog.

4.10.3.1 Problem Types

NOT CURRENTLY USED
For the maintenance and change control screens, you can use the Maintenance dialog to set the base
Problem Types that are handled. Examples are hardware-related issues, performance problems, software
bugs and network problems.
To access this dialog, select the Settings | Maintenance menu option. The Maintenance dialog displays,
defaulting to the Problem Types tab.

Enterprise Architect User Guide

 Modeling Fundamentals | Reference Data 661

To add a new problem type, click on the New button and:

· In the Problem Type field type the name of the problem type
· In the Description field type a short description of the problem type
· In the Weight field type the weighting to apply to the problem type
· In the Note field, type any additional information on the problem type
· Click on the Save button.
The problem type displays in the Defined Types list.

Note:
You can transport these problem types between models, using the Export Reference Data 223 and Import
Reference Data 225 options on the Tools menu. You transport the problem types together with test types as
a Maintenance Types file.

4.10.3.2 Testing Types

Use the Test Types tab of the Maintenance dialog to add testing types to the basic set that comes with
Enterprise Architect. Typical test types are load tests, performance tests and function tests.
To access this dialog, select the Settings | Maintenance menu option. The Maintenance dialog displays.
Click on the Test Types tab.

© 1998-2010 Sparx Systems Pty Ltd

 662 Modeling Fundamentals | Reference Data

To add a new test type, click on the New button and:

· In the Test Type field type the name of the testing type
· In the Description field type a short description of the testing type
· In the Weight field type the weighting to apply to the testing type
· In the Note field, type any additional information on the testing type
· Click on the Save button.
The testing type displays in the Defined Types list.

Note:
You can transport these test types between models, using the Export Reference Data 223 and Import
Reference Data 225 options on the Tools menu. You can either export the test types together with the default
problem types, as a Maintenance Types file, or separately as a Test Types file.

4.10.4 UML Types

The UML Types dialog enables you to configure stereotypes 662 , Tagged Value types 664 and the cardinality
list 665 for your project.
Select the Settings | UML menu option to display this dialog.

4.10.4.1 Stereotype Settings

Enterprise Architect has an extensive set of Standard Element Stereotypes 899 that you can apply 896 to any
UML construct. Using the Stereotypes tab of the UML Types dialog, a Technical Developer can also customize
the stereotypes for your project by adding, modifying and deleting them. For information on customizing
stereotypes, see Custom Stereotypes 1093

Enterprise Architect User Guide

 Modeling Fundamentals | Reference Data 663

Stereotypes can be modified to make use of metafiles (image files) or customized colors, or to make use of
the Enterprise Architect Shape Scripts 664 to make new element shapes to determine the shape and
dimensions of the element.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Configure Stereotypes 198 permission to add,
modify or delete stereotypes.

To display the Stereotypes tab, select the Settings | UML menu option. The UML Types dialog displays,
showing the Stereotypes tab.

© 1998-2010 Sparx Systems Pty Ltd

 664 Modeling Fundamentals | Reference Data

4.10.4.1.1 Shape Editor

The Shape Editor enables a Technology Developer to specify custom shapes via a scripting language; that is,
to create Shape Scripts. These custom shapes are drawn instead of the standard UML notation. Each script is
associated with a particular Stereotype, and is drawn for every element of that stereotype.

Notes:
· Shape Scripts adopt the same color gradient settings as normal elements, as defined in the Standard
Colors page of the Options dialog.
· If an element's appearance is modified by a Shape Script, many of the Advanced 549 context menu
options for that element are disabled.

For information on creating Shape Scripts, see the Shape Scripts 1147 topic.

4.10.4.2 Tagged Value Types

Tagged Values are used in a variety of places within Enterprise Architect to specify additional information
about an element or connector. The Tagged Value Types tab of the UML Types dialog enables a Technology
Developer to rapidly create Tagged Values, using a range of predefined structured Tagged Values 1166 to
create structured tags 1168 that adhere to a specific format. For example, for model features that use the
predefined tag Boolean you can use the Tagged Values window to assign a value of True or False and no
other value.
You can also add default Tagged Value names and create predefined reference data Tagged Value types 1170

and custom masked Tagged Value types 1171 .

Any Tagged Value names created display in the drop-down lists of Tagged Value names in the Tagged Value
dialogs for elements, operations and attributes. For more information regarding the use of Tagged Values see
the Tagged Values Window 632 topic.
To display the Tagged Value Types tab, select the Settings | UML menu option to display the UML Types
dialog, and click on the Tagged Value Types tab.

Enterprise Architect User Guide

 Modeling Fundamentals | Reference Data 665

For further information on adding and modifying Tagged Values, see Tagged Value Types 1166 .

Note:
You can transport these Tagged Value Type definitions between models, using the Export Reference Data
223 and Import Reference Data 225 options on the Tools menu. Tagged Value Types are exported as
Property Types.

4.10.4.3 Cardinality
The Cardinality Values tab of the UML Types dialog enables you to add, modify and delete values in the
default cardinality list.
The cardinality values are used to define the multiplicity of source 629 and target 631 elements in relationships.
This is the range of instances of the role that can be active in the relationship; for example, one employee can
be assigned to tasks; for the target role you define the range of instances (such as tasks) the employee could
be assigned to.
The cardinality values are also used to define the multiplicity of a Classifying element; that is, the number of
instances of the element that can exist. For example, the Class element Building Walls might have a
multiplicity of 2..n, meaning that at least two walls must exist (to support the roof) but there can be many walls
if the building design required it.
The values have the following formats:
· *, or 0..* - zero, one or many instances
· 0..n - zero or up to n instances, but no more than n
· n - exactly n instances

© 1998-2010 Sparx Systems Pty Ltd

 666 Modeling Fundamentals | Reference Data

· n..* - n, or more than n instances.

To access this dialog, select the Settings | UML menu option. Click on the Cardinality Values tab.

To add a new cardinality value, click on the New button. To modify an existing value, click on it in the
Cardinality list.
In the Cardinality field, type the required cardinality value. Click on the Save button.

Note:
You can transport these cardinality values between models, using the Export Reference Data 223 and
Import Reference Data 225 options on the Tools menu.

4.10.4.4 Data Types

Different programming languages support different inbuilt data types. The Programming Languages Datatypes
dialog enables you to extend and manage the set of inbuilt data types associated with a language as well as
create new programming languages for use within Enterprise Architect.

Notes:
· In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Configure Datatypes 198 permission to update
and delete data types.
· You can delete data types that you have defined, but you cannot delete any of the predefined data types.

To access this dialog, select the Settings | Code Datatypes menu option.

Enterprise Architect User Guide

 Modeling Fundamentals | Reference Data 667

Option Use to

Product Name Specify the name of the programming language.

Add Product Add a new programming language to the drop-down fields for Class elements within the
Enterprise Architect model and enable the new language to be made available to the
Code Template Editor 1305 once at least one datatype has been added to the language.

Datatype Specify the name of the datatype; this is the language-specific name of the datatype.

Common Type Specify the common type, the generic name of the datatype; for example, the Java
boolean datatype has a common datatype Boolean.

New Create a new data type.

Save Save the newly created datatype.

Delete Delete the selected datatype.

Note:
You can transport these data types between models, using the Export Reference Data 223 and Import
Reference Data 225 options on the Tools menu.

4.10.5 Resources
Access: View | Other Project Tools | Resources.
The Resources window displays a tree of Technologies, Templates, Documents, UML Profiles and Patterns,
commonly-used model elements and Matrix profiles. This view provides useful shortcuts and re-use functions
that you can use to add stock elements to the current model, and patterns and elements for additional
information.

© 1998-2010 Sparx Systems Pty Ltd

 668 Modeling Fundamentals | Reference Data

Tip:
In the Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Configure Resources 198 permission to maintain
Resources window items.

· MDG Technologies 1066 , UML Profiles 906 and UML Patterns 901 provide a convenient way to insert
complex new elements and features without having to retype or reconfigure each element
Note:
From release 7.5 of Enterprise Architect, the method of importing MDG Technologies into the Resources
window is available but not recommended. However, you might previously have imported Technologies
into the Resources window, and these are still available until you specifically delete them (right-click on
the Technology and select the Delete Technology context menu option).
You can also synchronize 910 the Tagged Values and constraints for any elements created from a profile
element in the Resources window.

· Templates provides a range of templates for creating HTML (web) 1649 reports, RTF 1569 reports in either
the legacy report generator 1628 or the extended RTF report generator 1570 , linked documents 597 and MDG
Technology reports; you can create, edit, copy and delete your own templates, and view and copy system-

Enterprise Architect User Guide

 Modeling Fundamentals | Reference Data 669

supplied or technology-supplied templates using context menu options

· Documents 1568 provides a shortcut to saved RTF documents
Tip:
To add a document to the shortcut list, select the Project | Documentation | Rich Text Format (RTF)
Report menu option. Once you have defined your document click on the Resource Document button and
type in a name. The document name then displays in the Resources window. By right-clicking on the
document name 1606 you can regenerate documents individually or as a batch, or open them directly from
Enterprise Architect.

· Matrix Profiles 1267 provides quick access to saved Relationship Matrix profiles; double-click on a profile to
load the matrix with the saved settings and source-target packages
· Favorites 669 provides a shortcut to elements that you configure as a shortcut
· Stylesheets enables you to import XSL Style sheets, which are then available in the drop-down list on the
XML Export dialog.
Note:
If you select a style sheet on export, Enterprise Architect applies that style sheet to the XMI generated
before saving to file. This makes it convenient to generate other forms of output from the base XMI
content. Combined with UML Profiles, this is a powerful means of extending Enterprise Architect to
generate almost any content required.

4.10.5.1 Favorites
The Resources window contains a Favorites folder. Here you can hyperlink to any UML element from the
model as a whole, and conveniently drag and drop instances or links to this element into other diagrams. This
is particularly useful where certain elements - such as the list of Actors in a system - are re-used again and
again, and switching to the Actors folder is not convenient. In cases like this, using the Favorites folder makes
managing and creating your model much easier.

Modify the Favorites Folder

Add to the Favorites Folder
To add an element to the Favorites folder:
· In a diagram, right-click on the element to add.
· From the context menu select the Find | Add to Favorites option.
· Switch back to the Resources window and check the Favorites folder; the new element should be listed in
its category within the favorites.

Delete from the Favorites Folder

To delete a favorite:
· Right-click on it within the Favorites folder in the Resources window.
· Select Delete Favorite from the context menu.
· Confirm the action by clicking on the Yes button.

View Properties of a Favorite

To view a favorite's properties from the Favorites folder:
· Select and right-click on the favorite in the Resources window.
· Select Element Properties from the context menu.

© 1998-2010 Sparx Systems Pty Ltd

Part

V
 Modeling Languages | 671

5 Modeling Languages

Enterprise Architect is a UML-based modeling tool. However, it strongly supports modeling with extensions to
UML and with other existing modeling languages, and enables you to create your own modeling tools as MDG
Technologies.
For information on the modeling languages and facilities supported, see:
· Standard UML Models 672
· Specialized UML Models 917
· Build Your Own Modeling Language. 1092

© 1998-2010 Sparx Systems Pty Ltd

 672 Modeling Languages | Standard UML Models

5.1 Standard UML Models

The Unified Modeling Language (UML)

Enterprise Architect's modeling platform is based on the Unified Modeling Language (UML) 2.3, a standard
that defines rules and notations for specifying business and software systems. The notation supplies a rich set
of graphic elements for modeling object oriented systems, and the rules state how those elements can be
connected and used. UML is not a tool for creating software systems; instead, it is a visual language for
communicating, modeling, specifying and defining systems.
UML is not a prescriptive process for modeling software systems; it does not supply a method or process,
simply the language. You can therefore use UML in a variety of ways to specify and develop your software
engineering project. This language is designed to be flexible, extendable and comprehensive, yet generic
enough to serve as a foundation for all system modeling requirements. With its specification, there is a wide
range of elements characterized by the kinds of diagrams they serve, and the attributes they provide. All can
be further specified by using stereotypes, Tagged Values and profiles. Enterprise Architect supports many
different kinds of UML elements (as well as some custom extensions). Together with the connectors between
elements, these form the basis of the model.
See:
· UML Diagrams 673
· UML Elements 741
· UML Connectors 852

Wide Range of Applications

Although initially conceived as a language for software development, UML can be used to model a wide range
of real world domains and processes (in business, science, industry, education and elsewhere), organizational
hierarchies, deployment maps and much more. Enterprise Architect also provides additional custom diagrams
and elements, to address further modeling interests. This topic is intended to provide an introduction to
Enterprise Architect's diagrams, elements and connectors, and its modeling process 370 . It also illustrates its
alignment, when applicable, to the Unified Modeling Language.

Extending UML for New Domains

Using UML Profiles 906 , UML Patterns 901 , Grammars, Data Types, Constraints and other extensions, UML
and Enterprise Architect can be tailored to address a particular modeling domain not explicitly covered in the
original UML specification. Enterprise Architect makes extending UML simple and straightforward and, best of
all, the extension mechanism is still part of the UML Specification.

Find Out More

UML is an open modeling standard, defined and maintained by the Object Management Group. Further
information, including the full UML 2.3 documentation, can be found on the OMG website at http://www.omg.
org.

Tip:
If you are unfamiliar with UML, please explore the topics in this section, the Diagram Toolbox 399
descriptions, and the EAExample project supplied with Enterprise Architect. The online UML Tutorial (parts 1
and 2) and UML 2.0 Tutorial are also very helpful.

Recommended Reading:
In addition to the UML Specification available from the OMG, two books that provide excellent introductions to
UML are:
· Schaum's Outlines: UML by Bennet, Skelton and Lunn. Published by McGraw Hill.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 673

ISBN 0-07-709673-8
· Developing Software with UML by Bern Oestereich. Published by Addison Wesley.
ISBN 0-201-36826-5

5.1.1 UML Diagrams

What is a UML Diagram?

A UML diagram is a representation of the components or elements of a system or process model and,
depending on the type of diagram, how those elements are connected or how they interact from a particular
perspective. For example, how and why an object changes state, or how requirements are realized by the
process or a system.

Types of Diagram
There are two major groupings of UML diagrams:
· Structural Diagrams 719 which depict the structural elements composing a system or function, reflecting the
static relationships of a structure, or run-time architectures.
· Behavioral Diagrams 673 which show a dynamic view of the model, depicting the behavioral features of a
system or business process.

Enterprise Architect provides the following additional diagram types that extend the core UML diagrams for
business process modeling, formal requirements specifications and other domain-specific models:
· Analysis 733 diagrams
· Custom 734 diagrams
· Requirements 736 diagrams
· Maintenance 737 diagrams
· User Interface 738 diagrams
· Database 739 diagrams
· Business Modeling and Business Interaction 739 diagrams.

Enterprise Architect also supports diagram types specific to MDG Technologies 1066 , including integrated
technologies such as Archimate 1073 , BPMN 952 , Data Flow Diagrams 1076 , Eriksson-Penker Extensions 1080 ,
ICONIX 1084 and Mind Mapping 1087 .

Work with Diagrams

Diagrams are developed in the main workspace in which you create and connect model elements. You create
them by right-clicking a package and selecting the New Diagram context menu option, or load them by
double-clicking their diagram icon in the Project Browser.
For full details on how to work with diagrams, see Diagram Tasks 421 .

5.1.1.1 Behavioral Diagrams

Behavioral diagrams depict the behavioral features of a system or business process. Behavioral diagrams
include the following diagram types:

Activity Diagrams
Activity diagrams 674 model the behaviors of a system, and the way in which these behaviors are related in an
overall flow of the system.

Use Case Diagrams

Use Case diagrams 676 capture Use Cases and relationships among Actors and the system; they describes
the functional requirements of the system, the manner in which external operators interact at the system
boundary, and the response of the system.

© 1998-2010 Sparx Systems Pty Ltd

 674 Modeling Languages | Standard UML Models

State Machine Diagrams

State Machine diagrams 678 illustrate how an element can move between states, classifying its behavior
according to transition triggers and constraining guards.

Timing Diagrams
Timing diagrams 690 define the behavior of different objects within a time-scale, providing a visual
representation of objects changing state and interacting over time.

Sequence Diagrams
Sequence diagrams 706 are structured representations of behavior as a series of sequential steps over time.
They are used to depict work flow, message passing and how elements in general cooperate over time to
achieve a result.

Communication Diagrams
Communication diagrams 715 show the interactions between elements at run-time, visualizing inter-object
relationships.

Interaction Overview Diagrams

Interaction Overview diagrams 717 visualize the cooperation between other interaction diagrams (Timing,
Sequence, Communication and Interaction Overview diagrams) to illustrate a control flow serving an
encompassing purpose.

See Also
· Behavioral Modeling 569
· Code Generation from Behavioral Models 1314

5.1.1.1.1 Activity Diagram

Activity diagrams are used to model the behaviors of a system, and the way in which these behaviors are
related in an overall flow of the system.
The logical paths a process follows, based on various conditions, concurrent processing, data access,
interruptions and other logical path distinctions, are all used to construct a process, system or procedure.

Note:
You can create Analysis diagrams 733 (Simplified Activity), containing the elements most useful for business
process modeling, using the New Diagram 422 dialog.

Example Diagram
The following diagram illustrates some of the features of Activity diagrams, including Activities, Actions, Start
Nodes, End Nodes and Decision points.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 675

Toolbox Elements and Connectors

Select Activity diagram elements and connectors from the Activity 412 pages 412 of the Toolbox.

Tip:
Click on the following elements and connectors for more information.

Activity Diagram Elements Activity Diagram Connectors

© 1998-2010 Sparx Systems Pty Ltd

 676 Modeling Languages | Standard UML Models

Activity Diagram Elements Activity Diagram Connectors

5.1.1.1.2 Use Case Diagram

A Use Case diagram captures Use Cases and relationships between Actors and the subject (system). It
describes the functional requirements of the system, the manner in which outside things (Actors) interact at
the system boundary, and the response of the system.
In developing a Use Case diagram, also consider:
· Use Case Extension Points 807
· Use Rectangle Notation 808
· Business Use Case 739 (stereotyped Use Case)

Example Diagram
The following diagram illustrates some features of Use Case diagrams:

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 677

Toolbox Elements and Connectors

Select Use Case diagram elements and connectors from the Use Case 406 pages 406 of the Toolbox.

Tip:
Click on the following elements and connectors for more information.

Use Case Diagram Elements Use Case Diagram Connectors

Note:
Invokes and Precedes relationships are defined by the Open Modeling Language (OML). They are
stereotyped Dependency relationships; Invokes indicates that Use Case A, at some point, causes Use Case
B to happen, whilst Precedes indicates that Use Case C must complete before Use Case D can begin.

© 1998-2010 Sparx Systems Pty Ltd

 678 Modeling Languages | Standard UML Models

5.1.1.1.3 State Machine Diagrams

Note:
State Machine diagrams were formerly known as State diagrams.

A State Machine diagram illustrates how an element (often a Class) can move between states, classifying its
behavior according to transition triggers and constraining guards. Other aspects of State Machine diagrams
further depict and explain movement and behavior 573 .
For information on code generation from State Machine diagrams, see the SW Code Generation - State
Machine Diagrams 1316 and State Machine Modeling for HDLs 1319 topics.
State Machine representations in UML are based on the Harel State Chart Notation (see the OMG UML
Superstructure Specification 2.1.1, section 15.1), and therefore are sometimes referred to as State Charts.
You can display a State Machine as a diagram (as below) or as a table 682 in one of three relationship
formats. In all formats, you use the same Toolbox elements and connectors 411 .
To select the display format, follow the steps below:
1. Right-click on the diagram background to display the context menu.
2. Select the Statechart Editor option.
3. Select the appropriate display option:
· Diagram
· Table (State-Next State)
· Table (State-Trigger)
· Table (Trigger-State).

Example Diagram
The following diagram illustrates some features of State Machine diagrams. The Saved State is a Composite
790 State, and enclosed States are sub-states 790 . Initial and final pseudo-states 682 indicate the entry to and
exit from the State Machine. Composite States and sub-states are both State 789 elements, a Composite State
being an expanded State element that encloses other State elements, which are then referred to as sub-
states. Composite States and State Machines can also contain Regions 681 .

Note:
State elements can display either with or without a line across them. The line - as shown below - displays
when the element has features such as attributes (which could be hidden) or when the Show State
Compartment 362 checkbox is selected in the Objects page of the Options dialog.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 679

You have two options for exposing the contents of a composite State, such as Saved. Firstly, you can double-
click on the element to display its child diagram separately, as shown below:

Alternatively, you can right-click on the composite element and select the Advanced | Show Composite
Diagram context menu option, which displays the child diagram in the context of the parent diagram.

© 1998-2010 Sparx Systems Pty Ltd

 680 Modeling Languages | Standard UML Models

Toolbox Elements and Connectors

Select State Machine diagram elements and connectors from the State 411 pages 411 of the Toolbox.

Tip:
Click on the following elements and connectors for more information.

State Machine Diagram Elements State Machine Diagram Connectors

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 681

State Machine Diagram Elements State Machine Diagram Connectors

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, Section 15.3.12, p. 560 ) states:
A state machine owns one or more regions, which in turn own vertices and transitions.
The behaviored classifier context owning a state machine defines which signal and call triggers are defined for
the state machine, and which attributes and operations are available in activities of the state machine. Signal
triggers and call triggers for the state machine are defined according to the receptions and operations of this
classifier.
As a kind of behavior, a state machine may have an associated behavioral feature (specification) and be the
method of this behavioral feature. In this case the state machine specifies the behavior of this behavioral
feature. The parameters of the state machine in this case match the parameters of the behavioral feature and
provide the means for accessing (within the state machine) the behavioral feature parameters.
A state machine without a context classifier may use triggers that are independent of receptions or operations
of a classifier, i.e. either just signal triggers or call triggers based upon operation template parameters of the
(parameterized) state machine.

5.1.1.1.3.1 Regions
Regions can be created in Composite States 790 or State Machines 789 on a State Machine diagram 678 .
Regions indicate concurrency, such that a single State is active in each region. Multiple transitions can occur
from a single event dispatch, so long as similarly triggered transitions are divided by Regions.
To create a Region in a Composite State or State Machine element, follow the steps below:
1. Right-click on the element, and select the Advanced | Define Concurrent Substates context menu
option. The State Regions dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 682 Modeling Languages | Standard UML Models

2. Create the Regions of a State, which can be named or anonymous.

3. Click on the OK button.

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 544) states:
A region is an orthogonal part of either a composite state or a state machine. It contains states and transitions.

5.1.1.1.3.2 Pseudo-States
Pseudo-states are a UML 2.3 abstraction for various types of transient vertices used in State Machine 678
diagrams. Pseudo-states are used to express complex transition paths. The following types of pseudo-state
are available:
· Initial 778
· Entry Point 769
· Exit Point 771
· Choice 758
· Junction 782
· History 777
· Terminate 804
· Final 772
· Fork 775
· Join 776

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 536) states:
A pseudostate is an abstraction that encompasses different types of transient vertices in the state machine
graph... Pseudostates are typically used to connect multiple transitions into more complex state transitions
paths. For example, by combining a transition entering a fork pseudostate with a set of transitions exiting the
fork pseudostate, we get a compound transition that leads to a set of orthogonal target states.

5.1.1.1.4 State Machine Table

A State Machine table is one of two variants of a State Machine (the other is the State Machine diagram) 678 . It
displays the information of the State Machine in table form, and is a method of specifying the discrete behavior
of a finite state-transition system; that is, what state the State Machine moves to and the conditions under
which the transition takes place.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 683

You can display the state transition as one of two different relationships:
· State - Trigger: The rows indicate the current states and the columns indicate trigger events (or the other
way around if you prefer, in a Trigger - State format). The cell at the intersection of a row and column
identifies the target state in the transition if the trigger occurs, and the condition (or guard) of the transition.

· State - Next State: The rows and columns both indicate states, and the cell at the intersection of a row and
column indicates the event that triggers a transition from the current (row) state to the next (column) state,
the condition (or guard) of the event, and the effect of the transition.

© 1998-2010 Sparx Systems Pty Ltd

 684 Modeling Languages | Standard UML Models

Select Format
You can display a State Machine as a diagram or table, and as a table in one of three relationship formats.
To select the display format, follow the steps below:
1. Right-click on the diagram background to display the context menu.
2. Select the Statechart Editor option.
3. Select the appropriate display option:
· Diagram
· Table (State-Next State)
· Table (State-Trigger)
· Table (Trigger-State)
To define the State Machine Table further, see:
· State Machine Table Options 684
· State Machine Table Operations 686

5.1.1.1.4.1 State Machine Table Options

You can choose the State Machine table 682 layout and set other options from the State Machine Diagram:
Options dialog, which you display by either:
· Double-clicking on the State Machine table background or
· Right-clicking on the background and selecting the State Table Options context menu option.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 685

Option Use to

Table Format Select the required table format:

· State - Trigger: rows represent States, each state name in a left edge cell;
columns represent Triggers, each trigger name in a column header cell; the
intersection of a row and column identifies the Transition (if there is one);
the Transition cell displays information about the next State and the
condition (guard) of the Transition
· Trigger - State: as above, except that rows represent triggers and columns
represent states
· State - Next State: both rows and columns represent states; intersection of
row and column defines the transition (if there is one) from the row state to
the column state.
Cell Size

Transition Cell Width Specify the width of the transition cells (that is, the column width).

Transition Cell Height Specify the height of the transition cells (that is, the row height).

Left Edge Cell Width Specify the width of the left edge (row title) cells.

Top Edge Cell Height Specify the height of the top edge (column title) cells.

Cell Color

State/Trigger Cell Select the color of the row and column title cells.

© 1998-2010 Sparx Systems Pty Ltd

 686 Modeling Languages | Standard UML Models

Option Use to

State/Trigger Select the color of the enumeration (row/column numbering) cells.

Enumeration
Note:
You must select at least one of the Enable State Enumeration and Enable
Event Enumeration checkboxes to set this color.

Transition Cell Select the color of the transition cells (in the main body of the table).

Highlight Options

Highlight Zones Related Highlight the cells for all elements involved in a selected transition - the initial
to Selected Transition state, the target state, and the trigger.

Highlight Color Select the color of the highlight.

Use Different Color for Highlight the cell for the target element in a transition in a different color to the
Target State cell for the source element.

Target Zone Color Select the color of the highlight.

Display Options

Always Display an Add an empty row (and, on a State - Next State table, an empty column) to the
Empty State Zone end of the table.
The title cell contains an ellipsis (...). You can click twice (not double-click) on
the ellipsis to edit it and identify a new state. In this case, another empty state
zone is automatically added.

Enable State Add a cell to each state title cell, to number the state. Numbering starts at 0.
Enumeration

Prefix If required, type a prefix for the state number or delete the default S to have no
prefix.

Enable Event Add a cell to each event or trigger title cell, to number the event. Numbering
Enumeration starts at 0.

Prefix If required, type a prefix for the event number or delete the default E to have no
prefix.

Sample State Table Display a preview of the table format as you define it.

Advanced Define diagram options. The State Machine Diagram Properties 423 dialog
displays.

Restore Defaults Reapply the State Table diagram default values.

Apply Apply changed options to the State Table diagram.

5.1.1.1.4.2 State Machine Table Operations

Overview
As a State Machine table 682 is a variant of a State Machine diagram 678 , most of the operations for
manipulating the data are the same as for State Machine diagrams. These include operations to:
· Create new items by drag-and-dropping a specified object from the Toolbox to the current diagram
· Delete an item
· Apply to the diagram elements in the Project Browser
· Display or change the properties of the State, Trigger or Transition
· Apply to the diagram, such as Lock Diagram, Zoom, and in place editing of the element.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 687

The operations specific to State Machine tables are described in the following topics:
· Change Position of State Machine Table 687

· Change Size of State Machine Table 687

· Insert New State (and Substate) 687
· Insert Trigger 688
· Insert/Change Transition 688
· Reposition State/Trigger Cells 689
· Add Legend 689
· Find Cell in State Machine Diagram 689
· State Machine Table Conventions 689
· Export State Table To CSV File 690
If necessary, you can move the State Machine table around in the Diagram View. To change the position of
the State Machine table, follow the steps below:
1. Press [Ctrl]+[A] or double click on the top left cell to select the whole State Machine table.
2. Drag and drop the State Machine table to the required position. Alternatively, use [Shift]+["], [!], [#]
or [$] to move the State Machine table.

There are three ways to change the size of the State Machine table:
· Change the cell size on the State Machine Diagram: Options 684 dialog.
· Press [Ctrl]+[A] or double click on the top left cell to select the whole State Machine table, then press
[Ctrl]+["], [!], [#] or [$] to change the size.
· Select the State Machine table, then drag the shape handles to change the size.

You can insert a new State in the State Machine table, using one of following methods:
· In the top left cell in the State Machine table, move the cursor to the word State to display a + at the end of
the word; click on the + to create a new State
· Right-click in the top left cell in the State Machine table to display the context menu, and select the Add
State menu option
· Right-click on an existing State cell in the State Machine table to display the context menu, and select the
· Insert New State Before option to insert a new State before the current State, or
· Insert New State After option to insert a new State after the current State
· Click on an existing State cell in the State Machine table, and press [Insert] to create and insert a new
State above the selected State
· In the Toolbox, on the State Elements page, click on an element and then click on:
· the diagram background to add a new State to the end of the table, or
· an existing State cell to add the new State just above it.

Note:
From the State Elements page of the Toolbox you can insert State, Initial, Final, Entry, Exit and Terminate
elements.

Add a Substate
To add a Substate to a selected State, follow the steps below:
1. Right-click on the required State cell in the State Machine table. The context menu displays.
2. Select the Add Substate menu option. Enterprise Architect adds the Substate to the State.

Note:
If the selected State does not allow a Substate, then the Add Substate menu option is grayed out.

You can also drag one existing State over another. If the second State allows Substates, the dragged State
then becomes its Substate.
Similarly, you can change the parent State of a Substate by dragging the Substate from the original parent
State to a different State.

© 1998-2010 Sparx Systems Pty Ltd

 688 Modeling Languages | Standard UML Models

Remove Parent Relation of a Substate

To remove the parent relation of a Substate and make it a separate State, follow the steps below:
1. Right-click on the Substate in the State Machine table. The context menu displays.
2. Select the Remove Parent Relation menu option. The Substate cell becomes a State cell.
You can also drag and drop the Substate onto the top left cell of the State Machine table. The dragged
Substate again becomes a State cell.

If the State Machine table format is either State-Trigger or Trigger-State, you can use one of the following
methods to insert a new Trigger:
· In the top left cell in the State Machine table, move the cursor to the word Event to display a + at the end of
the word; click on the + to create a new Trigger
· In the top left cell in the State Machine table, right-click to display the context menu and select the Add
Trigger menu option to create a new Trigger
· Select an existing Trigger in the State Machine table, then press [Insert] to insert a new Trigger before the
existing Trigger
· Click on an existing Trigger in the State Machine table, right-click to display the context menu and select
either the:
· Insert New Trigger Before option to insert a new Trigger before the current Trigger, or
· Insert New Trigger After option to insert a new Trigger after the current Trigger.

You can insert a new Transition using one of the following methods:
· Right-click on the cell in which to create a Transition, to display the context menu
· If the State Machine table format is State-Trigger or Trigger-State, the context menu lists the States
you can choose as the target of the Transition; click on the required State name to create the
Transition
· If the State Machine table format is State-Next State, click on the Insert Transition menu option to
create the Transition.
· In the State Relationships page of the Toolbox, select the Transition element, then click on the cell in the
State Machine table in which to create the Transition. Double-click on the Transition to define it in the
Transition Properties dialog.

Change the Transition

As for the State Chart 678 diagram, to change the properties of a Transition double-click the Transition cell and
edit the details on the Transition Properties dialog.

Change Transition States

You can change the source and target of the Transition by right-clicking the Transition and selecting the
Advanced | Set Source and Target context menu option.
Alternatively, you can change the Transition source, target or Trigger by clicking on the Transition and
dragging it to a different cell.
If the State Machine table format is either State-Trigger or Trigger-State, you can change the target state of a
transition by:
1. Highlighting the target state name in the Transition cell and clicking on it to display a list of the states in
the table.
2. Clicking on the preferred target state name.

Highlight States and Trigger Related to Transition

You can select options to highlight the source State, target State and Trigger cells associated with a
Transition, using the Highlight Options panel on the State Machine Diagram: Options 684 dialog. When you
click on the Transition cell its associated State and Trigger cells are highlighted.
Alternatively, click on the Transition cell and press and hold [L].

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 689

You can change the position of a selected State or Trigger cell in one of the following ways:
· Right-click on the State or Trigger title cell and select the appropriate Order | Move xxx context menu
option
· Click on the cell and press [Shift]+["], [!], [#] or [$].

You can add a simple legend to any State Machine Table cell that has no transition. The two legend symbols
are:
· I - Ignore
· N - Never Happen
To assign a legend symbol to a State Machine Table cell, follow the steps below:
1. Right-click on the cell to which to assign the legend. The context menu displays.
2. Select the appropriate menu option:
· Legend | Ignore
· Legend | Never Happen.
The required symbol displays in the center of the cell.
To remove a legend symbol from a cell, right-click on the cell and select the Legend | Remove Legend
context menu option.

On the State Machine table you can select a State or Trigger element and locate it in a State Machine
diagram, by selecting the Find | Locate in State Chart context menu option. Enterprise Architect switches to
the State Machine diagram and highlights the selected element. You can locate a Transition relationship in a
similar way, by selecting the Locate in State Chart context menu option.

Note:
A Trigger on a State Machine table might or might not exist on the corresponding State Machine diagram. If
the Trigger does not exist on the State Machine diagram, the Locate in State Chart option is disabled.

Conversely, on the State Machine diagram, you can select a State or Trigger element and locate it on the
corresponding State Machine table, by selecting the Find | Locate in State Table context menu option.
Enterprise Architect switches to the State Machine table and highlights the selected element. You can locate a
Transition relationship in a similar way, by selecting the Locate in State Table context menu option.

Trigger
· Deleting a Trigger removes it completely from the model, therefore you cannot UNDO a Trigger deletion
· There is a <None> column at the end of the Event heading row. This is for Transitions that have no Trigger
information.

State
From the Toolbox you can insert the following State element types only (although the State Machine table
might pick up and display other types, such as Submachine State):
· State
· Initial
· Final
· Entry
· Exit
· Terminate.

Transition
The Transition cell displays its properties in one of two ways, depending on the State Machine table format. If
the State Machine table format is State - Trigger or Trigger - State, the Transition cell displays the Guard and
Target as shown below:

© 1998-2010 Sparx Systems Pty Ltd

 690 Modeling Languages | Standard UML Models

If the State Machine table format is State - Next State, then the Transition cell displays the Trigger, Guard and
Effect as shown below:

The State Machine table enables you to edit the Guard and Effect in place. If the Guard or Effect is empty for
your selected Transition cell, the cell displays an ellipsis [ ... ] instead. Click twice (not double-click) on the
ellipsis to type in the Guard and Effect names.

To export a State Machine Table to a CSV file, follow the steps below:
1. Open the required State Machine Table.
2. Right-click on the diagram background and select the Export Statechart to CSV file context menu
option.
3. The Save As browser dialog displays. Select the appropriate directory location and type in the .CSV
filename.
4. Click on the Save button.

5.1.1.1.5 Timing Diagram

One of four types of Interaction diagram. (The other three are Sequence Diagrams 706 , Interaction Overview
Diagrams 717 and Communication Diagrams 715 .)
A Timing diagram defines the behavior of different objects within a time-scale. It provides a visual
representation of objects changing state and interacting over time.
You can use Timing diagrams to define hardware-driven or embedded software components; for example,
those used in a fuel injection system or a microwave controller. You can also use Timing diagrams to specify
time-driven business processes.
To create and edit a Timing diagram, see the following topics:
· Create a Timing Diagram 692
· Set a Time Range 692
· State Lifeline 794
· Value Lifeline 808
· Edit a Timing Diagram 692
· Time Intervals 700
· Message (Timing Diagram) 882

Example Diagram
An example of a Timing diagram is shown below:

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 691

(See OMG UML Superstructure Specification, v2.1.1, p. 454, figures 14.30 and 14.31).

Toolbox Elements and Message

Select Timing diagram elements and connectors from the Timing 410 pages 410 of the Toolbox.

Tip:
Click on the following elements and connectors for more information.

Timing Diagram Elements Timing Diagram Message

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 517) states:
Timing Diagrams are used to show interactions when a primary purpose of the diagram is to reason about
time. Timing diagrams focus on conditions changing within and among Lifelines along a linear time axis.
Timing diagrams describe behavior of both individual classifiers and interactions of classifiers, focusing
attention on time of occurrence of events causing changes in the modeled conditions of the Lifelines.
The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 519) also states:

© 1998-2010 Sparx Systems Pty Ltd

 692 Modeling Languages | Standard UML Models

The primary purpose of the timing diagram is to show the change in state or condition of a lifeline
(representing a Classifier Instance or Classifier Role) over linear time. The most common usage is to show the
change in state of an object over time in response to accepted events or stimuli. The received events are
annotated as shown when it is desirable to show the event causing the change in condition or state.

5.1.1.1.5.1 Create a Timing Diagram

To create a Timing diagram, follow the steps below:
1. Right-click on a package in the Project Browser. The context menu displays.
2. Select the Add | Add Diagram menu option. The New Diagram dialog displays.
3. In the Select From panel, select UML Behavioral.
4. In the Diagram Types panel, select Timing.
5. Click on the OK button. The Diagram view displays, on which you create the Timing elements for the
diagram. See Set a Time Range 692 and Edit a Timing Diagram 692 .

5.1.1.1.5.2 Set a Time Range

Before adding Lifeline elements to your Timing diagram, set a time range. To do this, follow the steps below:
1. Right-click on the diagram. The context menu displays.
2. Select the Set Timeline Range option. The Set Timeline Range dialog displays.

3. In the Start Time and End Time fields, type the numeric values for the start and end points of the
timeline; for example, set the range 0 to 100.

Note:
The start time must be less than the end time.

4. In the Time Units field, type the unit in which the time is measured; for example, seconds or minutes.
5. If it is not necessary to show the time range on the diagram, select the Suppress In Diagram
checkbox.
6. Click on the OK button. If you have not suppressed it, the time range displays underneath the Lifeline
elements that you create on the diagram.

5.1.1.1.5.3 Edit a Timing Diagram

On a Timing Diagram, you can add State Lifeline elements and Value Lifeline elements. You can maintain the
states and transitions on these Lifeline elements either on the diagram itself or via the Configure Timeline
dialog. See the following topics:
· Add and Edit a State Lifeline Element 693
· Edit States in a State Lifeline Element 693
· Edit Transitions in a State Lifeline Element 694
· Add and Edit a Value Lifeline Element 696
· Add States in a Value Lifeline Element 696
· Edit Transitions in a Value Lifeline Element 696
· Configure Timeline dialog - States Tab 697
· Configure Timeline dialog - Transitions Tab 699

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 693

From the Timing elements page of the Toolbox drag a State Lifeline 794 element onto your diagram. The
element displays on the diagram.
To define the name of the State Lifeline, follow the steps below:
1. Right-click on the element. The context menu displays.
2. Select the Other Properties option. The Timeline <name> dialog displays, showing the General tab.
3. Overtype the Name field.
4. Click on the Apply button and the OK button.

Sizing and Scale

In the top left corner of a selected Lifeline element are the left and right quick sizing buttons ( ). These
buttons increase or decrease the width of the Lifeline element, which in turn controls the scale width of each
time unit. By increasing the width of the element you increase the resolution when adding transitions, which
makes them easier to edit.

Note:
In order to edit the State Lifeline element, you must click on it to select it.

Set Timeline Start Position

You might require more space at the start of your timelines; for example, to use long state names. To insert
this space in all the timelines on a diagram, follow the steps below:
1. Right-click on the diagram background to display the context menu.
2. Select the Set Timeline Start Position menu option. The Set Timeline Start Position dialog displays.
3. The Value 80 to 300 field defaults to 80 as the minimum distance in pixels between the start of the
timeline element and the start of the timeline itself. Type a new value up to 300 pixels and click on the
OK button to increase the space at the start of the timeline, as shown in the following diagrams.

80 Pixels 150
Pixels

You now edit the states 693 and transitions 694 in the State Lifeline.

Add States
1. Click on the State Lifeline element. The New State button ( ) and Edit States button ( ) display at
the bottom left of the element.
2. Click on the New State button. The New State dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 694 Modeling Languages | Standard UML Models

3. In the State field, type the name of the state.

4. Click on the OK button.

Note:
You must add at least two states; for example, On and Off.

5. As you add states, increase the height of the element by dragging a handle-box ( ) on the edge
of the element.

Note:
You can also add states using the States tab of the Configure Timeline dialog. Add either:
· Discrete states to the Timeline as described in Add a New State 698 , or
· A continuous range of numeric states as described in Numeric Range Generator 698 .

Edit States
1. Click on the State Lifeline element and click on the required state. The Edit State dialog displays.
2. In the State field, change the name as required.
3. Click on the OK button.
4. If necessary, change the order of the states by either:
· Clicking on the up or down arrows ( and ) beside each state name, or
· Right-clicking on the state name and selecting the Move Up or Move Down context menu options.

Note:
You can also edit the states using the States 697 tab of the Configure Timeline dialog.

Delete States
1. Right-click on the state name. The context menu displays.
2. Select the Delete option.
Alternatively:
1. Click on the State Lifeline element.
2. Hold down [Ctrl] and move the cursor over the state name. The cursor changes form (7 ).
3. Click the mouse button. The state name is deleted.

Add and Move Transitions

After you have added states, you can add transitions via the diagram. As you move the cursor over the
timeline, the cursor changes to one of three shapes:

· The move cursor ( ) displays when it is directly over the timeline. Hold down the mouse button and drag
the line to move the timeline to a state above or below the current position. You can move the transition
more than one state up or down, if necessary.

· The new transition up cursor ( ) displays when it is just below the timeline, and there is another state
above the line. Press and hold [Alt]; the cursor changes ( ). Click to create a new transition to the state
above the line. To push the transition up more than one state, then move the cursor onto the line and drag
it up. The transition is for one interval unit; to make it longer, see Change the Transition Time below.

If you do not hold [Alt], the cursor does not change and the whole timeline from the transition onwards
moves up.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 695

· The new transition down cursor ( ) displays when it is just above the transition line, and there is another
state below the line. Press and hold [Alt]; the cursor changes ( ). Click to create a new transition to the
state below the line. To push the transition down more than one state, then move the cursor onto the line
and drag it down. The transition is for one interval unit; to make it longer, see Change the Transition Time
below.

If you do not hold [Alt], the cursor does not change and the whole timeline from the transition onwards
moves down.
As you move the cursor over the vertical line of a transition, the time at which the transition occurs displays
next to the line.

Edit Transitions
Follow the steps below:
1. Click directly on the appropriate transition line, after the transition begins. Alternatively, right-click on the
transition line to display the context menu, and select the Edit menu option.

The Edit Transition dialog displays. The fields in this dialog are all optional.

2. In the At Time field, type the point on the timescale at which the transition occurs.
3. In the Transition To field, type the name of the state to which the transition occurs.
4. In the Event field, type the name of the event that the transition represents; this displays on the
Timeline element just above the transition line.
5. In the Duration Constraint field, type any constraint on the duration of the transition; this displays on
the Timeline element, along the top of the element over the transition.
6. In the Time Constraint field, type any constraint on the start of the transition. This displays on the
Timeline element at the start of the transition.
7. Click on the OK button.

Notes:
· Once Event, Duration Constraint or Time Constraint are displayed on the diagram, you can edit them
directly by clicking on them to display their specific dialog. You can also delete them by pressing and
holding [Ctrl] as you click on them; the cursor changes form when you press [Ctrl].
· You can also edit transitions using the Transitions 699 tab of the Configure Timeline dialog.

Change the Transition Time

Move the cursor over one or other of the vertical transition lines and drag the line left or right to change the
time of the transition. While on the line, the cursor shape changes to the horizontal movement cursor ( ).

Merge Transitions
If necessary, you can 'push' a transition to merge it with the next or previous transition point on any Lifeline
element on the diagram.

© 1998-2010 Sparx Systems Pty Ltd

 696 Modeling Languages | Standard UML Models

Position the cursor off the appropriate side of the transition line; the cursor changes form ( or ). Click
the mouse button. The system locates the nearest transition in the required direction, on any element on the
diagram, and merges the current transition with that transition.

Delete Transitions
Transitions are automatically deleted when you move the transition to the same state as the previous
transition state, and release the cursor.
Alternatively, right-click on the transition line to display the context menu, and select the Delete menu option.

From the Toolbox drag a Value Lifeline 808 element onto your diagram. The element displays on the diagram.
To edit the Value Lifeline name, follow the steps below:
1. Right-click on the element. The context menu displays.
2. Select the Other Properties option. The Timeline <name> dialog displays, showing the General tab.
3. Overtype the Name field.
4. Click on the Apply button and the OK button.

Sizing and Scale

In the top left corner of a selected Lifeline element are the left and right quick sizing buttons ( ). These
buttons increase or decrease the width of the Lifeline element, which in turn controls the scale width of each
time unit. By increasing the width of the element you increase the resolution when adding transitions, which
makes them easier to edit.

Note:
In order to edit the Value Lifeline element, you must click on it to select it.

You now add states 696 and edit transitions 696 on the Value Lifeline.

Adding States to a Value Lifeline is similar to adding states to a State Lifeline 693 element.

Notes:
· For a Value Lifeline, only the first state displays on the diagram. The other states are added to a list to
access when creating transitions; they only display on the Lifeline element as you create transitions to
those states.
· You can only edit or delete states in a Value Lifeline element using the States 697 tab of the Configure
Timeline dialog.

Add Transitions
After you have added states to the Value Lifeline element, you can add transitions via the diagram. To do this,
follow the steps below:

1. Move the cursor above the transition line. The cursor changes form ( ).
2. Click the mouse button. The New Transition Event dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 697

3. In the Transition To field, click on the drop-down arrow and select a state from the list of available
states; this displays on the Lifeline element within the transition box. The remaining fields on the dialog
are optional.
4. In the Event field, type the name of the event that the transition represents; this displays on the Lifeline
element just below and at the start of the transition line.
5. In the Duration Constraint field, type any constraint on the duration of the transition; this displays on
the Lifeline element, along the top of the element over the transition.
6. In the Time Constraint field, type any constraint on the start of the transition. This displays on the
Lifeline element at the start of the transition, just after the Event name.
7. Click on the OK button to create the new transition.

Edit Transitions
To edit a transition, follow the steps below:
1. Click on the state name in the transition. Alternatively, right-click on the state name to display the
context menu, and select the Edit menu option.

The Edit Transition dialog displays; this is the same as the New Transition Event dialog, except that the
At Time field is enabled.
2. If necessary, overtype the At Time field to define a different start point.

Note:
You cannot change the At Time field for the first state in the timeline; this is always 0.

3. Edit the remaining fields as necessary.

4. Click on the OK button to save the changes.

Change the Transition Time

To change the start or end time of a transition, click on the start or end point of the transition and drag it to the
new position. While on the line, the cursor shape changes to the horizontal movement cursor ( ).

Delete Transitions
To delete a transition, press and hold [Ctrl] and click on the transition state name. While you hold [Ctrl] on the
transition state name, the cursor changes form (7 ).
Alternatively, right-click on the state name to display the context menu, and select the Delete menu option.

You can also manage states using the States tab of the Configure Timeline dialog. To display this, either:
· Double-click on the Lifeline element
· Right click on the Lifeline element and, from the context menu, select the Properties option, or
· On a Value Lifeline, click on the Edit States button ( ).

© 1998-2010 Sparx Systems Pty Ltd

 698 Modeling Languages | Standard UML Models

The Configure Timeline dialog defaults to the States tab.

All states currently defined for the Lifeline element are listed in the States panel.

Add a New State:

1. In the State Name field, type the name of the first new state in the Lifeline element; for example,
WaitState.
2. Click on the Save button. The state is added to the States panel and (for a State Lifeline Element) to the
diagram.
3. Click on the New button.
4. In the State Name field, type the name of the next state in the Lifeline element.
5. Repeat steps 2 to 5 until you have added all required states (you must add at least three to the Lifeline
element).
6. When you have added all the required states, click on the OK button to close the Configure Timeline
dialog.

Edit an Existing State:

1. Click on the state in the States: list.
2. In the State Name field, change the name of the state.
3. Click on the Save button.

Delete an Existing State:

1. Click on the state in the States: list.
2. Click on the Delete button.

Change the Order of States:

1. Click on the state in the States: list.

2. Click on the or buttons to move the state up or down the sequence.

Numeric Range Generator

You can also use the Configure Timeline dialog to create a range of states having numeric values to be
applied to the Timeline.

Important:
This operation deletes all existing states and transitions for the Timeline element.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 699

1. Display the Configure Timeline dialog.

2. Click on the Create Continuous Numeric States button. The Numeric Range Generator dialog
displays.
3. In the High Value and Low Value fields, type the upper and lower values of the range.
4. In the Step Value field, type the increase interval.

Note:
Nonsense values do not parse; Low Value must be less than High Value, and Step Value must be a
positive value smaller than the total range.

5. In the Units field, type the name of the measurement unit; for example, minutes.
6. Click on the OK button. Enterprise Architect displays a warning that existing states and transitions will
be deleted.
7. Click on the Yes button. The Configure Timeline dialog redisplays, with the defined range of states
listed in the States panel.
8. Click on the OK button. For a:
· Value Lifeline, the first state is shown on the Timeline for the full time range of the Timeline.
· State Lifeline, the range of states is displayed as the y-axis of the Timeline.
You can also manage transitions using the Transitions tab of the Configure Timeline dialog. To display this,
either:
· Double-click on the Lifeline element
· Right click on the Lifeline element and, from the context menu, select the Properties option, or
· On a Value Lifeline, click on the Edit States button ( ).
The Configure Timeline dialog defaults to the States tab. Click on the Transitions tab.

All transitions defined for the Timeline element are listed in the Transition Points panel.

© 1998-2010 Sparx Systems Pty Ltd

 700 Modeling Languages | Standard UML Models

Add a New Transition

1. Click on the New button.
2. In the New Transition panel, type the details of the transition.
3. Click on the Save button.

Edit a Transition
1. Click on a transition in the list.
2. In the Edit Transition panel, edit the fields for the transition as required.
3. Click on the Save button.

Delete a Transition
1. Click on a transition in the list.
2. Click on the Delete button. The transition is removed from the dialog and the Lifeline.
3. Click on the OK button.

5.1.1.1.5.4 Time Intervals

You create and manage Time Intervals using the Interval Bar (the pale line along the top of each selected
Lifeline element). Time Intervals enable you to perform various operations on transitions, such as copy and
paste. They also enable you to compress sections of the timeline so that they are not visible.
Each Time Interval displays across all Timeline elements down to the last element on the diagram.

Create Time Intervals

To create a Time Interval, follow one of the three sets of steps below:

Interval Bar - Context Menu

1. Right-click on the Interval Bar at approximately the point at which to start or finish the Time Interval.

The context menu displays.

2. Select the Create Time Interval option. The Time Interval displays down all the timeline elements, as a
narrow pale band with a blue compression box at the top.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 701

3. Move the cursor to the edge of the Time Interval in the Interval Bar so that the cursor changes to the
drag form ( ) and drag the edge to the correct start or end point.

Interval Bar - [Shift] key

1. Move the cursor over the Interval Bar and press [Shift]. The cursor changes shape ( ).
2. Click to create the Time Interval.
3. Move the cursor to the edge of the Time Interval in the Interval Bar so that the cursor changes to the
drag form ( ) and drag the edge to the correct start or end point.

Timeline - Context menu

1. Right-click on the timeline just after a transition. The context menu displays.
2. Click on the Select menu option. Enterprise Architect creates a Time Interval covering the period from
the selected transition up to the next transition.

Notes:
· If there are other Time Intervals in this period, Enterprise Architect replaces them with the single Time
Interval for the transition state. You should consider this when creating the Time Interval, as it extends
across the other Timeline Elements in the diagram.
· A value of this method is that it creates a Time Interval for a period in which no transitions occur, which
could be lengthy. You can then compress this Time Interval (see below) to hide the period of inactivity. See
also Compress Timeline 704 .

Compress Time Intervals

You can compress Time Intervals to conserve space on long timelines.
Uncompressed Time Intervals

© 1998-2010 Sparx Systems Pty Ltd

 702 Modeling Languages | Standard UML Models

Compressed Time Intervals

Notice:

Item Description

The compression toggle boxes:

· is expanded, click on this to compress the selected time interval
· is compressed, click on this to expand the selected time interval again.
The compressed sections of the timelines themselves, in all elements.
If there is space between the paired symbols, there are transitions within the
compressed section.
If the timeline continues through the paired symbols there are no transitions in the
compressed section.

25 ... 55 The compressed sections in the time range underneath the elements.

You can also compress and expand Time Intervals using context menu options; see Time Interval Operations
on Transitions 703 .

Select Time Intervals

· To select a Time Interval across all elements on the diagram, click on the Interval Bar within the Time
Interval.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 703

· To select a number of individual Time Intervals, press and hold [Ctrl] while clicking on the Interval Bar
within each Time Interval.
· To select all Time Intervals in a range, click on the Interval Bar within the first Time Interval in the range,
then press and hold [Shift] and click on the Interval Bar within the last Time Interval in the range. All Time
Intervals between the two are selected.
After you have selected one or more Time Intervals, you can modify the selection in the following ways:
· To exclude Lifeline elements from the selection, press and hold [Ctrl] and click on any part of the selection
within that element. In the diagram below, the Value Lifeline is excluded from selection.

Repeat the step to toggle the selection and re-include the element. See also Toggle Interval Selection 704 .
· To select only one Lifeline element and exclude all others, press and hold [Shift] and click on any part of
the selection within that element.

Note:
Selection is useful for cutting, copying and pasting transitions.

Move and Resize Time Intervals

To move a Time Interval, move the cursor over the Interval bar within the Time Interval, hold down the mouse
button and drag the interval left or right.
To resize a Time Interval, move the cursor over the Interval Bar at the start or end edge of the Time Interval,
hold down the mouse button and move the edge left or right.

Note:
Time Intervals can meet, but cannot overlap.

Delete Time Intervals

Select 702 each Time Interval to be deleted and press [Delete].

Note:
Deleting the Time Interval does not delete transitions within that interval.

You can operate on selected Time Intervals 700 , or all Time Intervals in the diagram.

Selected Intervals
Note:
The Copy, Cut and Delete operations act on all selected Time Intervals over the whole diagram, not just the
current one.

To select and update specific Time Intervals, right-click on the Interval Bar within an interval. The following
context menu displays.

© 1998-2010 Sparx Systems Pty Ltd

 704 Modeling Languages | Standard UML Models

Option Use to

Select Interval Select the Time Interval or, if the interval is already selected, deselect it. You can
select several Time Intervals in this way, accessing the menu separately on each
Deselect Interval interval.

Toggle Interval Switch the selection or deselection of the Time Interval within the selected
Selection Timeline element.
You select or deselect a Time Interval across all Timeline Elements, but the
Toggle option acts only on the element in which you access the menu. See also
Select Time Intervals 702 .

Compress Interval Compress the Time Interval, and hide all transitions within that Time Interval.
This is also useful for hiding long sections of inactivity on the time line. Also see
Compress Timeline 704 , below.

Remove Interval Delete the Time Interval.

Copy Copy the transitions for all selected Time Intervals.

Cut Copy and delete the selected transitions from the diagram.

Cut and Remove Time Copy and delete the transitions that lie in the selected Time Intervals from the
diagram.
This option also removes time from the timeline, the amount being the duration
of the Time Interval. All transitions and Time Intervals to the right of the selected
time interval are moved left.

Delete Delete the selected transitions from the diagram.

Delete and Remove Delete the transitions that lie in the selected Time Intervals from the diagram.
Time
This option also removes time from the timeline, the amount being the duration
of the Time Interval. All transitions and Time Intervals to the right of the current
Time Interval are moved left.

Insert Time Add time to the timeline and move all transitions and time intervals to the right.
Also expand the duration of the current Time Interval.

Compress Timeline
The Compression toggle boxes and Compress Interval menu option operate on the Time Interval and
compress the timeline and all transitions within the Interval. You have an alternative option that operates on

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 705

the timeline and compresses a single transition state.

1. Right-click on the timeline (rather than the Interval Bar) just after a transition. The context menu
displays.
2. Click on the Compress menu option. Enterprise Architect creates a new Time Interval covering the
period from the selected transition up to the next transition, and then compresses that Time Interval.

Notes:
· If there are other Time Intervals in this period, Enterprise Architect replaces them with the single Time
Interval for the transition state. You should consider this when creating and compressing the Time Interval,
as it extends across the other Timeline elements in the diagram.
· A value of this method is that it creates a Time Interval for a period in which no transitions occur, which
could be lengthy, and then compresses this Time Interval to hide the period of inactivity.

All Time Intervals in the Diagram

To create a new Time Interval or work across all Time Intervals in the diagram, right-click on the Interval Bar
between Time Intervals. The following context menu displays.

Note:
The Paste menu options become active after transitions have been copied.

Menu Option Use to

Create Time Interval Create a single Time Interval 700 .

Expand all Time Intervals Expand all Time Intervals over the whole diagram.
Compress all Time Compress all Time Intervals over the whole diagram.
Intervals
Paste Combine Paste copied transitions over any existing transitions within the copied time
frame.

Note:
The diagram does not allow two consecutive transitions to the same state, and
removes the second transition automatically.

Paste Remove Delete all the transitions and then pastes the copied transition within the copied
time frame.
Paste Insert Insert time, moving all transitions and Time Intervals to the right to make room
to paste in the copied transitions.
Insert Time Add time to the timeline and move all transitions and Time Intervals to the right.
This option does not change the duration of any Time Interval.

© 1998-2010 Sparx Systems Pty Ltd

 706 Modeling Languages | Standard UML Models

Copy and Paste Transitions From One Timeline Element to Another

A special mode enables you to copy transitions from one Timeline element to another. Any states that don't
exist in the Timeline element you are pasting to are created.
1. Press and hold [Shift] and select the Timeline element within a Time Interval to copy or cut.
2. Right-click on the Interval Bar (it doesn't matter which element you select). The context menu displays.
3. Copy or cut 704 the transitions. You can also cut and remove time.
4. Select the timeline to paste transitions to and right-click on the Interval Bar. The context menu displays.
5. Select one of the paste operations. Note that states are created if they don't already exist in the
timeline.

Note:
Any new states created might be in the wrong order. You can change the order via the diagram quick buttons
693 .

Shift Transitions Left or Right

You can move transitions within a selected Time Interval or multiple selected Time Intervals.
1. Select all the Time Intervals containing the transitions to be shifted; see Select Time Intervals 702 .

2. Press and hold [Shift] and click on the Interval Bar (it doesn't matter which Timeline element you select)
and move the transition left or right.

Note:
You cannot drag transitions over other transitions; the move stops when the moved transition collides with a
stationary transition.

Tip:
If you have collision problems, use [Shift]+select to shift transitions for a single Timeline element.

5.1.1.1.6 Sequence Diagram

A Sequence diagram is one of four types of Interaction diagram. (The other three are Timing Diagram 690 ,
Interaction Overview Diagram 717 and Communication Diagram 715 .)
A Sequence diagram is a structured representation of behavior as a series of sequential steps over time. It is
used to depict work flow, message passing and how elements in general cooperate over time to achieve a
result.
· Each sequence element 710 is arranged in a horizontal sequence, with messages passing back and
forward between elements.
· Messages on a Sequence diagram can be of several types; the Messages can also be configured to reflect
the operations and properties of the source and target elements (see the Notes in the Message 868 topic).
· An Actor element can be used to represent the user initiating the flow of events.
· Stereotyped elements, such as Boundary 836 , Control 838 and Entity 839 , can be used to illustrate screens,
controllers and database items, respectively.
· Each element has a dashed stem called a lifeline, where that element exists and potentially takes part in
the interactions.
To configure a Sequence diagram, see the following topics:
· Denote the Lifecycle of an Element 708

· Layout of Sequence Diagrams 709

· Sequence Element Activation 711
· Lifeline Activation Levels 712
· Message Label Visibility 714
· Change the Top Margin 714
· Change the Timing Details 874 .
Also take note of the important information in the Sequence Diagrams and Version Control 710 topic.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 707

Robustness diagrams, used extensively in ICONIX 1084 , can be created as Sequence diagrams.
To toggle the numbering of messages on a Sequence diagram, select or deselect the Show Sequence
Numbering 360 checkbox on the Options dialog.

Example Diagram
The following example Sequence diagram demonstrates several different elements:

Toolbox Elements and Connectors

Select Sequence diagram elements and connectors from the Interaction 410 pages 410 of the Toolbox.
Enterprise Architect also supports a number of stereotyped elements 739 to represent various entities in
business modeling.

Tip:
Click on the following elements and connectors for more information.

Sequence Diagram Elements Sequence Diagram Connectors

© 1998-2010 Sparx Systems Pty Ltd

 708 Modeling Languages | Standard UML Models

Sequence Diagram Elements Sequence Diagram Connectors

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 503) states:
A sequence diagram describes an Interaction by focusing on the sequence of Messages that are exchanged,
along with their corresponding OccurrenceSpecifications on the Lifelines.

5.1.1.1.6.1 Denote Lifecycle of an Element

You can capture element lifetimes using messages that are denoted as New or Delete message types. To do
this, follow the steps below:
1. Double-click on a message within a Sequence diagram to display the Message Properties dialog.
2. In the Lifecycle field, click on the drop-down arrow and select New or Delete.
3. Click on the OK button to save the changes.
The example below shows two elements that have specific creation and deletion times.

Note:
To show the termination X on the lifeline in the following example diagram, you must switch on garbage
collection: Tools | Options | Diagram | Sequence | Garbage Collect.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 709

5.1.1.1.6.2 Layout of Sequence Diagrams

You can modify the vertical height of sequence messages to get an attractive and effective layout. To offset
message positions, follow the steps below:
1. Select the appropriate message in a Sequence diagram.
2. Use the mouse to drag the message up or down as required.
As you drag a message up or down a lifeline, any messages or fragments below that message are shifted up
or down the same amount. However, be aware that if you drag up or down past the next or previous message,
Enterprise Architect interprets that as the requirement to swap positions, rather than simply offset a message
position.
The example below shows an economical use of space in a Sequence diagram.

© 1998-2010 Sparx Systems Pty Ltd

 710 Modeling Languages | Standard UML Models

5.1.1.1.6.3 Sequence Elements

A Sequence diagram 706 models a dynamic view of the interactions between model elements at runtime.
Sequence diagrams are commonly used as explanatory models for Use Case scenarios. By creating a
Sequence diagram with an Actor and elements involved in the Use Case, you can model the sequence of
steps the user and the system undertake to complete the required tasks. An element in a Sequence diagram
is usually either an Actor (the stimulus that starts the interaction) or a collaborating element.

Note:
A Sequence diagram is often attached directly under the Use Case to which it refers. This helps keep
elements together, both in the model and when documentation is produced. To do this, right-click the Use
Case on the diagram and select the Advanced | Make Composite context menu option.

The example below shows some possible elements of Sequence diagrams and their stereotyped display.
· Actor - An instance of an actor at runtime.
· Lifeline - An Object element with the stereotype Lifeline.
· Boundary - Represents a user interface screen or input/output device.
· Entity - A persistent element - typically implemented as a database table or element.
· Control - The active component that controls what work gets done, when and how.

Tip:
Use Sequence diagrams early in analysis to capture the flow of information and responsibility throughout the
system. Messages between elements eventually become method calls in the Class model.

5.1.1.1.6.4 Sequence Diagrams and Version Control

You might create Sequence diagrams that use elements from other packages as the Lifelines within the
diagram. In such cases, the diagrams could be corrupted when the element packages are checked in and out
under version control. This is because during checkout the elements are first deleted from the model and then
re-imported, and although they are reinstated in the diagrams, any Messages connecting them are not.
So, if the diagram and its elements reside in different packages, a round-trip of the element package through
version control might damage the Sequence diagram.
The solution is to drag-and-drop each Class onto the Sequence diagram as an object - when you drop the
Class onto the Sequence diagram, in the Paste Element dialog select the as Instance of Element (Object)
option. This creates a new object in the diagram's parent package, based on the selected Class element. You
then create the Messages between the objects.
Therefore, to ensure that a Sequence diagram is not damaged by round-trips of other packages through
version control, remember that:
· The Lifelines must be objects (even though Enterprise Architect allows you to drop elements as Lifelines
onto a Sequence diagram, it is not a strictly UML compliant construct)

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 711

· The Lifelines must be in the same package as the diagram.

The following illustration shows the Project Browser with two packages: P1, containing the elements, and P2,
containing a Sequence diagram that uses those elements. The diagram itself is also shown.

This diagram will not be damaged, because all the Lifelines are objects and these objects reside in the same
package as the Sequence diagram.

5.1.1.1.6.5 Sequence Element Activation

Sequence elements in a Sequence diagram 706 have Activation rectangles drawn along their lifelines. These
rectangles describe the time the element is active during the overall period of processing. This visual
representation can be suppressed by right-clicking the Sequence diagram, and selecting the Suppress
Activations context menu option.
In general, Enterprise Architect calculates the period of activation for you, but in some cases you might want to
fine tune the rectangle length. There are several context menu options on a sequence message that you can
use to accomplish this. To access the following context menu, right-click on the message and select the
Activations context menu option.

· Start New Message Group: Starts off a new round of processing in the current diagram. This enables you
to describe more than one processing scenario in a single diagram.
· Extend Source Activation Down: Forces an element to stay active beyond the normal processing period.
This could be used to express an element that continues its own processing concurrently with other

© 1998-2010 Sparx Systems Pty Ltd

 712 Modeling Languages | Standard UML Models

processes.
· Extend Source Activation Up: Forces an element's activation upwards.
· End Source Activation: Truncates the activation of the source element after the current message. This is
useful for expressing an asynchronous message after which the source element becomes idle.
· End Target Activation: Ends a Forced Activation started by the Extend Source Activation options.
The Raise Activation Level and Lower Activation Level options display on the context menu only where
their use is appropriate. For example, after a self-message the next message starts by default at a lower
activation level but the Raise Activation Level command displays on the context menu to enable you to raise
its level.
A more convenient way to change activation levels is directly on the diagram. Whenever appropriate, left and/
or right arrows display on specific connectors. In the following diagram, see connector 1.3. Click on the arrow
to raise or lower the activation level.

Note:
Program flow can more accurately be depicted with nested activation levels for callback messages.

5.1.1.1.6.6 Lifeline Activation Levels

Complicated processing systems can be easily negotiated and reflected in Sequence diagrams, by adding
activation layers on a single lifeline. For example, a Class invokes the method Sample A, which in turn calls
Sample A1. To produce the arrangement in the diagram, select the More tools | Interaction menu option,
click on the Self-message icon in the Interaction Relationships panel and then click on the lifeline.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 713

In order to raise the Activation level of Sample A1, click on the raise arrow of the selected connector. The
lifeline now visually depicts that method Sample A1 is called during the processing of Sample A.

In the example below, a few more self-messages have been added. The message Sample A2a is called from
Sample A2 which in turn is called from Sample A (not Sample A1). Sample A1 is called from Sample A.

© 1998-2010 Sparx Systems Pty Ltd

 714 Modeling Languages | Standard UML Models

5.1.1.1.6.7 Sequence Message Label Visibility

On Sequence messages, you can control label visibility using the message context menu. To hide and show
the labels used in Sequence messages, follow the steps below:
1. Right-click on the message within the Sequence diagram. The message context menu displays.
2. Select the Set Label Visibility menu option. The Label Visibility dialog displays.

3. Select or clear the checkbox against each message label to display or hide, respectively.
4. Click on the OK button to save the settings.

5.1.1.1.6.8 Change the Top Margin

In order to change the top margin of a Sequence diagram 706 from the default 50 units, right-click on the
diagram to display the context menu and select the Set Top Margin menu option. You can set the top margin
to any value between 30 and 250 units.

5.1.1.1.6.9 Inline Sequence Elements

It is possible to represent Part 825 and Port 826 elements on a Sequence diagram 706 . Child Parts and Ports
appear as inline sequence elements under their parent Class sequence element.

1. Right-click on the sequence elements containing the child Ports or Parts, to display the context menu.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 715

2. Select the Embedded Elements | Embedded Elements menu option.

3. Select the checkbox against each Part or Port to show, and click on the Close button.

5.1.1.1.7 Communication Diagram

One of four types of Interaction diagram. (The other three are Timing Diagrams 690 , Sequence Diagrams 706
and Interaction Overview Diagrams 717 .)
A Communication diagram shows the interactions between elements at run-time in much the same manner as
a Sequence diagram. However, Communication diagrams are used to visualize inter-object relationships,
while Sequence diagrams are more effective at visualizing processing over time.
Communication diagrams employ ordered, labeled associations to illustrate processing. Numbering is
important to indicate the order and nesting of processing. A numbering scheme could be:
1
1.1
1.1.1
1.1.2
1.2, and so on.
A new number segment begins for a new layer of processing, and would be equivalent to a method invocation.
Robustness diagrams are simplified Communication diagrams, but can be created in any diagram type that
supports Boundary 836 , Control 838 and Entity 839 elements.

Example Diagram
The example below illustrates a Communication diagram among cooperating object instances. Note the use of
message levels to capture related flows, and the different colors 716 of the messages 879 .

Toolbox Elements and Connectors

Select Communication diagram elements and connectors from the Communication 409 pages 409 of the
Toolbox.

© 1998-2010 Sparx Systems Pty Ltd

 716 Modeling Languages | Standard UML Models

Tip:
Click on the following elements and connectors for more information.

Communication Diagram Elements Communication Diagram Connectors

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 511) states:
Communication Diagrams focus on the interaction between Lifelines where the architecture of the internal
structure and how this corresponds with the message passing is central. The sequencing of Messages is
given through a sequence numbering scheme.
Communication Diagrams correspond to simple Sequence Diagrams that use none of the structuring
mechanisms such as InteractionUses and CombinedFragments. It is also assumed that message overtaking
(i.e., the order of the receptions are different from the order of sending of a given set of messages) will not
take place or is irrelevant.

Note:
Communication diagrams were known as Collaboration diagrams in UML 1.4.

5.1.1.1.7.1 Communication Diagrams in Color

Enterprise Architect enables you to highlight particular message flows in a Communication diagram 715 using
different colors for each message set.
To highlight the colors in a Communication diagram, follow the steps below:
1. Select the Tools | Options | Communication Colors menu option. The Communication Message
Coloring page of the Options dialog displays.
2. Select the Use Communication Colorcheckbox.
3. Click on the drop-down arrow of each Message n field, and select the required color for each message
group.
4. Click on the Close button. On your Communication diagram, each sequence group of messages
displays in a different color as shown below.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 717

5.1.1.1.8 Interaction Overview Diagram

One of four types of Interaction diagram. (The other three are Timing Diagrams 690 , Sequence Diagrams 706
and Communication Diagrams 715 .)
Interaction Overview diagrams visualize the cooperation between other interaction diagrams to illustrate a
control flow serving an encompassing purpose. As Interaction Overview diagrams are a variant of Activity
diagrams 674 , most of the diagram notation is the same, as is the process of constructing the diagram.
Decision points, Forks, Joins, Start points and End points are the same. Instead of Activity 753 elements,
however, rectangular elements are used. There are two types of these elements:
· Interaction 779 elements display an inline Interaction diagram, which can be any one of the four types
· Interaction Occurrence 780 elements are references to an existing Interaction diagram: they are visually
represented by a frame, with ref in the frame's title space; the diagram name is indicated in the frame
contents.
To create an Interaction Occurrence, simply drag an Interaction diagram from the Project Browser onto your
Interaction Overview diagram. The ref frame displays, encapsulating an instance of the Interaction diagram.

Example Diagram
The following example depicts a sample sale process, shown in an Interaction Overview diagram, with sub-
processes abstracted within Interaction Occurrences. The diagram appears very similar to an Activity diagram,
and is conceptualized the same way; as the flow moves into an interaction, the respective interaction's
process must be followed before the Interaction Overview's flow can advance.

© 1998-2010 Sparx Systems Pty Ltd

 718 Modeling Languages | Standard UML Models

Toolbox Elements and Connectors

Select Interaction Overview diagram elements and connectors from the Activity 412 pages 412 of the Toolbox.

Tip:
Click on the following elements and connectors for more information.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 719

Interaction Overview Diagram Elements Interaction Overview Diagram Connectors

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 514) states:
Interaction Overview Diagrams define Interactions (described in Chapter 14, "Interactions") through a variant
of Activity Diagrams (described in Chapter 6, "Activities") in a way that promotes overview of the control flow.
Interaction Overview Diagrams focus on the overview of the flow of control where the nodes are Interactions or
InteractionUses. The Lifelines and the Messages do not appear at this overview level.

5.1.1.2 Structural Diagrams

Structural diagrams depict the structural elements composing a system or function. These diagrams reflect the
static relationships of a structure, such as Class or Package diagrams, or run-time architectures such as
Object or Composite Structure diagrams.
Structural diagrams include the following diagram types:

Class Diagrams
Class diagrams 721 capture the logical structure of the system, the Classes and objects that make up the
model, describing what exists and what attributes and behavior it has.

Composite Structure Diagrams

Composite Structure diagrams 724 reflect the internal collaboration of Classes, Interfaces and Components
(and their properties) to describe a functionality.

© 1998-2010 Sparx Systems Pty Ltd

 720 Modeling Languages | Standard UML Models

Component Diagrams
Component diagrams 730 illustrate the pieces of software, embedded controllers and such that make up a
system, and their organization and dependencies.

Deployment Diagrams
Deployment diagrams 727 show how and where the system is to be deployed; that is, its execution
architecture.

Object Diagrams
Object diagrams 723 depict object instances of Classes and their relationships at a point in time.

Package Diagrams
Package diagrams 720 depict the organization of model elements into packages and the dependencies
amongst them.

Profile Diagrams
Profile Diagrams 732 are those created in a <<profile>> package, to extend UML elements, connectors and
components.

5.1.1.2.1 Package Diagram

Package diagrams depict the organization of model elements into packages and the dependencies amongst
them, including package imports and package extensions. They also provide a visualization of the
corresponding namespaces.
The following example demonstrates a basic Package diagram.

The nesting connector between ConnSeq and Controller reflects what the package contents reveal. Package
contents can be listed by clicking on the diagram background to display the diagram's Properties 423 dialog,
selecting the Elements tab and selecting the Package Contents checkbox.
The «import» connector indicates that the elements within the target Integer package, which in this example is
the single Class Integer, are imported into the package Controller. The Controller's namespace gains access
to the Integer Class; the Integer namespace is not affected.
The «merge» connector indicates that the package Controller's elements are imported into GenApply,
including Controller's nested and imported contents. If an element already exists within GenApply, such as
Loader and Time, these elements' definitions are expanded by those included in the package Controller. All

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 721

elements added or updated by the merge are noted by a generalization relationship back to that package.

Notes:
· Private elements within a package cannot be imported or merged.
· If you click on an element listed in a package, and then double-click, you can display and edit the element
properties 481 .

Toolbox Elements and Connectors

Select Package diagram elements and connectors from the Class 407 pages 407 of the Toolbox.

Tip:
Click on the following elements and connectors for more information.

Package Diagram Elements Package Diagram Connectors

5.1.1.2.2 Class Diagram

The Class diagram captures the logical structure of the system: the Classes 811 - including Active 812 and
Parameterized 813 (template) Classes - and things that make up the model. It is a static model, describing
what exists and what attributes and behavior it has, rather than how something is done. Class diagrams are
most useful to illustrate relationships between Classes and Interfaces. Generalizations, Aggregations and
Associations are all valuable in reflecting inheritance, composition or usage, and connections, respectively.

Example Diagram
There are two forms of the Aggregation 854 relationship in the following diagram. The pale form indicates that
the Class Account uses AddressBook, but does not necessarily contain AddressBook. The dark Composite
Aggregation form indicates ownership or containment by the target Classes (at the diamond end) of the source
Classes.

© 1998-2010 Sparx Systems Pty Ltd

 722 Modeling Languages | Standard UML Models

Toolbox Elements and Connectors

Select Class diagram elements and connectors from the Class 407 pages of the Toolbox.
Enterprise Architect also supports a number of stereotyped Class 739 elements to represent various entities in
web page modeling.

Tip:
Click on the following elements and connectors for more information.

Class Diagram Elements Class Diagram Connectors

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 723

Class Diagram Elements Class Diagram Connectors

5.1.1.2.3 Object Diagram

An Object diagram is closely related to a Class diagram 721 , with the distinction that it depicts object instances
of Classes and their relationships at a point in time. This might appear similar to a Composite Structure 724
diagram, which also models run-time behavior; the difference is that Object diagrams exemplify the static
Class diagrams, whereas Composite Structure diagrams reflect run-time architectures different from their
static counterparts. Object diagrams do not reveal architectures varying from their corresponding Class
diagrams, but reflect multiplicity and the roles instantiated Classes could serve. They are useful in
understanding a complex Class diagram, by creating different cases in which the relationships and Classes
are applied. An Object diagram can also be a kind of Communication diagram 715 , which also models the
connections between objects, but additionally sequences events along each path.

Note:
Communication diagrams were known as Collaboration diagrams in UML 1.4.

Example Diagram
The following example first shows a simple Class diagram, with two Class 811 elements connected.

The Classes above are instantiated below as Objects in an Object diagram. There are two instances of
Computer in this model, which can prove useful for considering the relationships and interactions Classes play
in practice, as Objects.

© 1998-2010 Sparx Systems Pty Ltd

 724 Modeling Languages | Standard UML Models

Toolbox Elements and Connectors

Select Object diagram elements and connectors from the Object 408 pages of the Toolbox.
Enterprise Architect also supports a number of stereotyped Object 739 elements to represent various entities in
business modeling.

Tip:
Click on the following elements and connectors for more information.

Object Diagram Elements Object Diagram Connectors

5.1.1.2.4 Composite Structure Diagram

A Composite Structure diagram reflects the internal collaboration of Classes 811 , Interfaces 821 or
Components 816 (and their Properties 726 ) to describe a functionality. Composite Structure diagrams are
similar to Class diagrams 721 , except that they model a specific usage of the structure. Class diagrams model
a static view of Class structures, including their attributes and behaviors. A Composite Structure diagram is
used to express run-time architectures, usage patterns and the participating elements' relationships, which
might not be reflected by static diagrams.
In a Composite Structure diagram, Classes are accessed as Parts 825 or run-time instances fulfilling a
particular role. These Parts can have multiplicity, if the role filled by the Class requires multiple instances.
Ports 826 defined by a Part's Class should be represented in the composite structure, maintaining that all
connecting Parts provide the required interfaces specified by the Port. There is extensive flexibility, and an
ensuing complexity, that come with modeling composite structures. To optimize your modeling, consider
building Collaborations 814 to represent reusable patterns responding to your design issues.

Example Diagram
The following diagram shows a Collaboration used in Composite Structure diagrams to model common
patterns. This particular example shows a relationship for performing an installation.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 725

The following diagram uses the Install Collaboration in a Collaboration Occurrence 815 , and applies it to the
UtilLoad Class via a «represents» relationship. This indicates that the classifier UtilLoad uses the collaboration
pattern within its implementation.

For further examples of Composite Structure diagrams, see the Toolbox elements listed below.

Toolbox Elements and Connectors

Select Composite Structure diagram elements and connectors from the Composite 409 pages of the Toolbox.
Enterprise Architect also supports a stereotyped Collaboration to represent a Business Use Case Realization
739 in business modeling.

Tip:
Click on the following elements and connectors for more information.

Composite Structure Diagram Elements Composite Structure Diagram Connectors

© 1998-2010 Sparx Systems Pty Ltd

 726 Modeling Languages | Standard UML Models

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 193) states:
A composite structure diagram depicts the internal structure of a classifier, as well as the use of a
collaboration in a collaboration use.

5.1.1.2.4.1 Properties
A property is a nested structure within a classifier, which is usually a Class 811 or an Interface 821 on a
Composite Structure diagram 724 . The contained structure reflects instances and relationships reflected within
the containing classifier. Properties can have multiplicity.
To demonstrate properties, consider the following diagram, which demonstrates some properties of the Library
Class.

There are two Parts 825 , libBooks and records, which are instances corresponding to the Classes Books and
Computer respectively. After dragging Parts from the Toolbox out to the workspace, right-click on a Part and
select the Advanced | Set Property Type context menu option to connect to a classifier.

Note:
If Parts disappear when dragged onto the Class, adjust the Z-order of the Class (right-click on it and select
the Z-Order context menu option).

The relationship between the two Parts is indicated by the connector, reflecting that communication between
the Parts is via the barcode. This contained structure and its Parts are properties owned by the Library Class.
To indicate a property that is not owned by composition to the containing classifier, use a box symbol with a
dashed outline, indicating association. To do this, right-click on the Part and select the Advanced | Custom
Properties context menu option. Set the IsReference option to true.
Properties can also be reflected using a normal composite structure (without containing it in a Class), with the
appropriate connectors, parts and relationships indicated through connections to the Class. This alternative
representation is shown in the following diagram. However, this depiction fails to express the ownership
immediately reflected by containing properties within a classifier.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 727

5.1.1.2.5 Deployment Diagram

A Deployment diagram shows how and where the system is to be deployed; that is, its execution architecture.
Hardware devices, processors and software execution environments (system Artifacts 810 ) are reflected as
Nodes 822 , and the internal construction can be depicted by embedding or nesting Nodes. Deployment 862
relationships indicate the deployment of Artifacts, and Manifest 867 relationships reveal the physical
implementation of components. As Artifacts are allocated to Nodes to model the system's deployment, the
allocation is guided by the use of deployment specifications.
A simple Deployment diagram is shown below, representing the arrangement of servers at a head office. The
servers are represented by Nodes linked by either simple or aggregate Association relationships.

© 1998-2010 Sparx Systems Pty Ltd

 728 Modeling Languages | Standard UML Models

Deployment diagrams are ideal for using alternative images 447 for the objects that the elements represent.
Such images can be substituted for the elements in the above diagram, as shown below:

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 729

Toolbox Elements and Connectors

Select Deployment diagram elements and connectors from the Deployment 413 pages of the Toolbox.

Tip:
Click on the following elements and connectors for more information.

Deployment Diagram Elements Deployment Diagram Connectors

© 1998-2010 Sparx Systems Pty Ltd

 730 Modeling Languages | Standard UML Models

Deployment Diagram Elements Deployment Diagram Connectors

5.1.1.2.6 Component Diagram

A Component diagram illustrates the pieces of software, embedded controllers and such that make up a
system, and their organization and dependencies. A Component diagram has a higher level of abstraction
than a Class diagram 721 ; usually a component is implemented by one or more Classes 811 (or Objects 823 ) at
runtime. They are building blocks, built up so that eventually a component can encompass a large portion of a
system.

Example Diagram
The following diagram demonstrates some components and their inter-relationships. Assembly 855 connectors
connect the provided interfaces supplied by Product and Customer to the required interfaces specified by
Order. A Dependency 861 relationship maps a customer's associated account details to the required interface
Payment, indicated by Order.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 731

Toolbox Elements and Connectors

Select Component diagram elements and connectors from the Component 412 pages of the Toolbox.

Tip:
Click on the following elements and connectors for more information.

Component Diagram Elements Component Diagram Connectors

© 1998-2010 Sparx Systems Pty Ltd

 732 Modeling Languages | Standard UML Models

Component Diagram Elements Component Diagram Connectors

5.1.1.2.7 Profile Diagram

A Profile diagram is any diagram created in a <<profile>> package.
Profiles provide a means of extending the UML. They are based on additional stereotypes and Tagged Values
that are applied to UML elements, connectors and their components. A Profile is a collection of such
extensions that together describe some particular modeling problem and facilitate modeling constructs in that
domain.
For information on creating a Profile diagram, see the Developing Profiles 1093 and Create Profiles 1095 topics.
A typical unit on a Profile diagram resembles the following illustration:

Toolbox Elements and Connectors

Select the following Profile diagram elements and connectors from the Profile 414 pages of the Toolbox.

Profile Diagram Elements Profile Diagram Connectors

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 733

5.1.1.3 Extended Diagrams

In addition to diagrams defined by the UML, Enterprise Architect provides some extended diagram platforms
to model business processes or develop custom diagrams.
· Analysis Diagram 733
· Custom Diagram 734
· Requirements Diagram 736
· Maintenance Diagram 737
· User Interface Diagram 738
· Database Schema 739
· Documentation 1616
· Business Modeling and Business Interaction 739

5.1.1.3.1 Analysis Diagram

An Analysis diagram is a simplified Activity diagram 674 , which is used to capture high level business
processes and early models of system behavior and elements. It is less formal than some other diagrams, but
provides a good means of capturing the essential business characteristics and requirements.
Enterprise Architect supports some of the Eriksson-Penker Business Extensions 1080 that facilitate business
process modeling 930 . The complete Eriksson-Penker Business Extensions UML Profile can also be loaded
into Enterprise Architect and used to create detailed process models.

Robustness diagrams, used extensively in ICONIX 1084 , can be created as Analysis diagrams.

Toolbox Elements and Connectors

Select Analysis diagram elements and connectors from the Analysis 416 pages of the Toolbox.

© 1998-2010 Sparx Systems Pty Ltd

 734 Modeling Languages | Standard UML Models

Tip:
Click on the following elements and connectors for more information. The Information element is a simple
flow-chart representation of data or input/output.

Analysis Diagram Elements Analysis Diagram Connectors

5.1.1.3.2 Custom Diagram

A Custom diagram is an extended Class diagram 721 that is used to capture requirements, user interfaces or
custom-design models.
The below example reflects a Requirements diagram 736 . Requirement elements 846 can be linked back to
Use Cases 806 and Components 816 in the system to illustrate how a particular system requirement is met.
Change 1564 and Defect (Issue) 1563 elements look the same as Requirement elements and can be coded and
managed in the same way.
Screen design is supported through a stereotyped Screen 847 element and UI Controls 849 . Use this model to
design high level system prototypes.
Custom models provide a few extensions to the UML model and enable some exploratory and non-rigorous
experimentation with model elements and diagrams.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 735

Toolbox Elements and Connectors

Select Custom diagram elements and connectors from the Custom 417 pages of the Toolbox.

Tip:
Click on the following elements and connectors for more information.

Custom Diagram Elements Custom Diagram Connectors

© 1998-2010 Sparx Systems Pty Ltd

 736 Modeling Languages | Standard UML Models

5.1.1.3.3 Requirements Diagram

A Requirements diagram is a custom diagram used to describe a system's requirements or features as a
visual model.
Requirements are defined using Requirement elements (Custom elements of type Requirement). To view the
detailed description of a Requirement, double-click on the element to display its properties. Requirement
elements can be linked back to Use Cases 806 and Components 816 in the system to illustrate how a particular
system requirement is met.
Requirements models provide extensions to the UML model and enable traceability 1245 between specifications
and design requirements, and the model elements that realize them.

Requirements can have relationships with other elements such as other Requirements and Use Cases. To
view the traceability of a requirement, use the Traceability 1253 window, which you access using the View |
Traceability menu option (or press [Ctrl]+[Shift]+[4]).

Toolbox Elements and Connectors

Select Requirements diagram elements and connectors from the Requirements 418 pages of the Toolbox.

Tip:
Click on the following elements and connectors for more information.

Requirements Diagram Elements Requirements Diagram Connectors

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 737

5.1.1.3.4 Maintenance Diagram

A Maintenance diagram is a custom diagram used to describe change requests and issue items within a
system model.
An example Maintenance diagram is shown below. Change, Task and Issue elements can be linked back to
other model elements in the system to illustrate how they must be modified, fixed or updated.
Maintenance models provide extensions to the UML model and enable change management of change items,
and of the model elements that require the changes to be made to them.

Toolbox Elements and Connectors

Select Maintenance diagram elements and connectors from the Maintenance 418 pages of the Toolbox.

Tip:
Click on the following elements and connectors for more information.

Maintenance Diagram Elements Maintenance Diagram Connectors

© 1998-2010 Sparx Systems Pty Ltd

 738 Modeling Languages | Standard UML Models

Maintenance Diagram Elements Maintenance Diagram Connectors

5.1.1.3.5 User Interface Diagram

User Interface Diagrams are custom diagrams used to visually mock-up a system's user interface using forms,
controls and labels.
In the example User Interface diagram below, forms, controls and labels are arranged on the diagram to
describe its appearance. UI Control elements can also be traced to other model elements linking the UI with
the underlying implementation.

Toolbox Elements and Connectors

Select User Interface diagram elements and connectors from the User Interface 419 pages of the Toolbox.

Note:
Click on the following elements and connectors for more information.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 739

User Interface Diagram Elements User Interface Diagram Connectors

5.1.1.3.6 Database Schema

The following diagram shows an example Database Schema, used in Data Modeling 1011 .

Toolbox Elements and Connectors

Select Database Schema diagram elements from the Data Modeling 421 pages of the Toolbox.

5.1.1.3.7 Business Modeling/Interaction

Business Modeling diagrams and Business Interaction diagrams enable you to model both the structure and
behavior of a business system.
Business Modeling diagrams are based on a Class (UML Structural) diagram, whilst Business Interaction
diagrams are based on a Sequence (UML Behavioral) diagram. Both diagram types have the same default
Toolbox, which consists of a Business Modeling element page. The available elements include stereotyped
Objects 823 , and a stereotyped Actor 757 (Business Actor), Use Case 806 (Business Use Case) and
Collaboration 814 (Business Use Case Realization).

© 1998-2010 Sparx Systems Pty Ltd

 740 Modeling Languages | Standard UML Models

The following diagram shows the appearance of the elements when dragged and dropped onto a Business
Modeling diagram:

The following diagram shows the appearance of the elements when dragged and dropped onto a Business
Interaction diagram:

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 741

5.1.2 UML Elements

Models in UML are constructed from elements such as Classes, Objects, Interfaces, Use Cases, Components
and Nodes, each of which has a different purpose, different rules and different notation. Model elements are
used at different stages of the design process for different purposes.
This topic provides an introduction to elements defined by UML, which together compose the backbone of
modeling. Most conceivable modeling elements are stereotypes or extensions of the elements introduced in
this topic.
· During early analysis, Use Cases, Activities, Business Processes, Objects and Collaborations are used to
capture the problem domain
· During elaboration, Sequence diagrams, Objects, Classes and State Machines are used to refine the
system specification
· Components and Nodes are used to model larger parts of the system as well as the physical entities that
are created and deployed into a production environment.

© 1998-2010 Sparx Systems Pty Ltd

 742 Modeling Languages | Standard UML Models

UML elements can be divided into two categories: those used on Behavioral Diagrams 742 and those used on
Structural Diagrams 809 . This basic set can be extended 835 almost without limit using Stereotypes 895 and
UML Profiles 906 .

5.1.2.1 Behavioral Diagram Elements

The following figure illustrates the main UML elements 741 that are used in Behavioral Diagrams 673 . For more
information on using each element, click on the element name in this list:
· Action 743 , Activity 753 , Actor 757
· Central Buffer Node, 758 Choice 758 , Collaboration 814 , Combined Fragment 759
· Datastore 764 , Decision 765 , Diagram Frame 766 , Diagram Gate 767
· Endpoint 768 , Entry Point 769 , Exception 769 , Expansion Region 769 , Exit Point 771
· Final 772 , Flow Final 772 , Fork 773
· History 777
· Initial 778 , Interaction 779 , Interaction Occurrence 780 , Interruptible Activity Region 781
· Join 773 , Junction 782
· Lifeline 783
· Note 785
· Object 823
· Package 825 , Partition 786
· Receive 787 , Region 788
· Send 789 , State 789 , State/Continuation 792 , State Lifeline 794 , State Machine 796 , Structured Activity 798 ,
Synch 802 , System Boundary 802
· Terminate 804 , Trigger 804
· Use Case 806
· Value Lifeline 808

Note:
Actor, Collaboration, Note, Object and Package elements are used in both Behavioral diagrams and
Structural diagrams.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 743

5.1.2.1.1 Action

An Action element describes a basic process or transformation that occurs within a system. It is the basic
functional unit within an Activity diagram 674 . Actions can be thought of as children of Activities 753 . Both

© 1998-2010 Sparx Systems Pty Ltd

 744 Modeling Languages | Standard UML Models

represent processes, but Activities can contain multiple steps or decomposable processes, each of which can
be embodied in an Action. An Action cannot be further broken down or decomposed.

An Action can be further defined with pre-condition and post-condition 752 notes, and certain properties can
be graphically depicted 745 on the Action (Enterprise Architect prompts you to define the type of Action you are
creating when you first drag the Action icon from the Toolbox). The data values passed out of and into an
Action can be represented by Action Pins 749 . For a named Action (that is, other than a basic Action) you can
also assign 751 Action Pins to represent specific properties.
For a basic (Atomic) Action, you can define the effect of the Action using the Effect tab of the element
Properties dialog, and select to display the effect on the diagram.

An Action can also be depicted as an Expansion Node 749 to indicate that the Action comprises an Expansion
Region 769 .

Class Operations in Activity Diagrams

Operations from Classes can be displayed on Activity diagrams as Actions. When an operation is shown as an
Action, the notation of the Action displays the name of the Class that features the operation. To add an
operation to an Activity diagram follow the steps below:
1. Open an Activity diagram.
2. From the Project Browser open a Class and locate the operation to be added to the Activity diagram.
3. Drag the operation on to the diagram.

4. When the operation has been added to the Activity diagram the Action displays the name of the Class
that features the operation.

If you right-click on the Action in the diagram, you can locate the behavior classifier (CallBehavior Activity) or
call operation (CallOperation Activity) in the Project Browser using the Find | Locate Classifier in Project
Browser and Find | Locate Operation in Project Browser context menu options.
If it becomes necessary to change the operation that this Action refers to, follow the steps below:
1. Right-click on the Action. The context menu displays.
2. Select the Advanced | Set Operation menu option. The Set Operation dialog 748 displays.
3. If necessary, in the In Namespace field, select the model that contains the required operation.
4. Double-click on the required operation. The Action updates to show the new classifier and operation.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 745

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 241) states:
An action is a named element that is the fundamental unit of executable functionality. The execution of an
action represents some transformation or processing in the modeled system, be it a computer system or
otherwise.
The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 313) also states:
An action may have sets of incoming and outgoing activity edges that specify control flow and data flow from
and to other nodes. An action will not begin execution until all of its input conditions are satisfied. The
completion of the execution of an action may enable the execution of a set of successor nodes and actions
that take their inputs from the outputs of the action.

5.1.2.1.1.1 Action Notation

Some properties can be graphically depicted on an Action 743 element, as shown in the examples below.

Action Notation Kind: Action Notation Action Notation Kind: Action Action Notation
CallOperation Kind: AcceptEvent Notation Kind: Kind:
CallBehavior AcceptEventTim SendSignal
er

When you drag the Action icon from the Activity page of the Toolbox onto your diagram, a selection list
displays showing the commonest types of Action to create. (If this list does not display, press [Ctrl] as you
drag the icon.)

When you click on one of the specific types, that type of Action element displays on diagram. If you click on
the Other option, the New Action dialog displays:

© 1998-2010 Sparx Systems Pty Ltd

 746 Modeling Languages | Standard UML Models

You can again select to create a normal (Atomic) Action element, a CallOperation or a CallBehavior, or you
can select the Other radio button and click on the drop-down arrow in the blank field to select the Action type
from an extensive list.
If you later decide that the Action type is not appropriate, you can change it by right-clicking on the Action and
selecting the Advanced | Custom Properties context menu option, which displays the Custom Properties
dialog. Set the Action type by selecting a value from the Kind drop-down list. For a Value Specification Action,
you also set the value on this dialog.

AcceptEvent Actions
For an Accept Event Action element, the Properties dialog contains a Triggers tab on which you define one or
more triggers to denote the type of events accepted by the Action, as defined in the following table:

Option Use to

Name Specify the name of the trigger.

Type Specify the type of trigger: Call, Change, Signal or Time.

· Call - specifies that the event is a CallEvent, which sends a message to the
associated object by invoking an operation.
· Change - specifies that the event is a ChangeEvent, which indicates that the
transition is the result of a change in value of an attribute.
· Signal - specifies that the event is a SignalEvent, which corresponds to the

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 747

Option Use to

receipt of an asynchronous signal instance.

· Time - corresponds to a TimeEvent; which specifies a moment in time.

Note:
Code generation for State Machines currently supports Change and Time trigger
events only, and expects a specification value.

Specification Specify the event instigating the Transition.

SendSignal Action & BroadcastSignal Action

For a SendSignal or BroadcastSignal Action element, you can model the signal to be sent and the associated
arguments to be conveyed, using the Signal tab of the element Properties dialog.

To complete this tab, follow the steps below:

1. In the Signal field, click on the [ ... ] button and select the required signal from the Select Signal 515
dialog.
2. In the Attribute field, click on the drop-down arrow and select the attribute (as previously created in the
© 1998-2010 Sparx Systems Pty Ltd
 748 Modeling Languages | Standard UML Models

Signal element) with which the arguments are to be associated.

3. In the Value field, type the appropriate value for the attribute.
4. Identify the arguments (as ActionPins 749 ) for the Signal; click on the Add button under the Arguments
panel, and select the appropriate Pins from the Select Pin 515 dialog.

Note:
To assign more than one Pin, press [Ctrl] whilst you select each Pin.

5. Click on the Save button.

Structural Feature Actions

Enterprise Architect supports the following types of Structural Feature Actions:
· AddStructuralFeatureValue
· ClearStructuralFeature
· ReadStructuralFeature
· RemoveStructuralFeatureValue
· WriteStructuralFeature
These actions can take Ports, Parts or Attributes as the target structural feature. To set the appropriate
feature, follow the steps below:
1. Right-click on the Action element in the diagram, and select the Advanced | Set Structural Feature
context menu option. The Set Structural Feature dialog displays.

2. To locate the structural feature, click on the Add button. The Select Property dialog displays (a variant
of the Select <Item> 515 dialog).
3. Browse or search for the appropriate structural feature, and double-click on it. The feature name and
location displays in the structuralFeature field of the Set Structural Feature dialog.
4. Click on the OK button to save the setting.
The Set Feature dialog is the Set Operation dialog used to change the operation represented by an Action 744
on an Activity diagram.
As the Set Operation or Set Attribute dialog, it is also used to set the Value operation or attribute for Tagged
Values of type RefGUID 1167 or for the target of a hyperlink 840 in a diagram.
To use this dialog, follow the steps below:
1. The Set Operation (or Set Attribute) dialog displays, with the model hierarchy opened at the point at
which you selected the original operation or attribute.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 749

2. If required, in the In Namespace field, click on the drop-down arrow and select another model that
contains the required operation or attribute. The package hierarchy for that model displays.
3. Browse through the hierarchy, or use the Search 515 tab to locate the required operation or attribute,
then double-click on the item to select it.

5.1.2.1.1.2 Action Expansion Node

Representing an Action 743 as an Expansion Node is a shorthand notation to indicate that the Action
comprises an Expansion Region 769 .
To specify an Action as an Expansion Node, right-click on the Action to display the context menu and select
the Embedded Elements | Add Expansion Node menu option. After designating an Action as an Expansion
Node, you can modify or delete it using the Embedded Elements | Embedded Elements menu option.

5.1.2.1.1.3 Action Pin

An Action Pin is used to define the data values passed out of and into an Action 743 . An input pin provides

© 1998-2010 Sparx Systems Pty Ltd

 750 Modeling Languages | Standard UML Models

values to the Action, whereas an output pin contains the results from that Action.
Action Pins are used below to connect two Actions:

See UML Superstructure Specification, v2.1.1, Figure 12.110, p. 391.

Action Pins can be further characterized as defining exception parameters, streams, or states. Associating a
state with a Pin defines the state of input or output values. For instance, the Pin could be called Orders, but
the state could be Validated or Canceled.
To add an Action Pin to an Action, right-click on the Action to display the context menu and select the
Embedded Elements | Add Action Pin menu option. (You can also assign 751 Action Pins, to define specific
properties of the Action.)
The Properties dialog of an Action Pin has a Pin tab on which you define the specific actions of the Pin.

A Pin serves as an argument for Call Behavior Actions and Call Operation Actions. When an Action is
associated with a valid behavior in the model, the associated behavior's parameters are listed in the
Parameter field drop-down list to facilitate a one-to-one mapping between the argument and the parameter.
The fields in the Argument panel are enabled only for Pins belonging to Call Actions, and only when the Action
is associated with a valid behavior with valid parameters.
You can also change certain properties of an Action Pin on the Custom Properties dialog: right-click on the Pin
and select the Advanced | Custom Properties context menu option. The following properties can be set:

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 751

5.1.2.1.1.4 Assign Action Pins

Apart from adding Action Pins to any Action, you can assign specialized input or output Action Pins to Actions
that have a specific type (that is, those that are not Basic or Atomic Actions). These input/output Pins signify
various properties of the Action - they are not visible as structures on the diagram unless they have previously
been added 749 , but are listed in the Project Browser as properties of the Action.
You can only assign Pins that have already been added or assigned to the Action, or that are being created
specifically to be assigned to the Action.
To assign Pins to an Action, follow the steps below:
1. Right-click on the Action in the diagram, and select the Advanced | Assign Action Pins context menu
option. The Assign Action Pins to <ActionName> dialog displays.

The format of this dialog depends on the type of Action: for a SendObject Action the dialog has two
fields (request and target); for the above TestIdentity Action, three; and for a CallBehavior Action, one (
result). The fields are populated in exactly the same way.
2. The mandatory number and type of Pins are automatically selected (if they exist) or created. To change
or add a Pin in a field, click on the corresponding Add button. The Select Pins dialog displays (a variant
of the Select <Item> 515 dialog), showing the selected Action and listing all the input Pins currently
owned by the Action.
3. Double-click on one of the Pins (or, depending on the multiplicity of the Pin, [Ctrl]+click on several
Pins). Alternatively, if no suitable Pin exists, click on the Add New button and then click on the
newly-created Pin. The selected Pin is identified in the field on the Assign Action Pins to <ActionName>
dialog.
4. Click on the OK button.
To check the exact location of an assigned Action Pin, you can right-click on the Pin name in the dialog and
select the Find in Project Browser context menu option.

© 1998-2010 Sparx Systems Pty Ltd

 752 Modeling Languages | Standard UML Models

5.1.2.1.1.5 Local Pre/Post Conditions

Actions 743 can be further defined with pre-condition and post-condition notes, which constrain an Action's
entry and exit. These notes can be added to an Action as defined below.

See UML Superstructure Specification, v2.1.1, Figure 12.32, p. 316.

Create a Constraint
To attach a constraint to an Action follow the steps below:
1. Right-click on the Action. The context menu displays:
2. Select the Add | Constraint menu option. A Note is created on the diagram, connected to the Action.
3. Right-click on the Note. The context menu displays.
4. Select the View Properties menu option. The Constraint dialog displays.

5. In the Constraint Type field, click on the drop-down arrow and select the required constraint type.
6. In the Constraint field, type the text for the constraint.
7. Click on the OK button to save the constraint.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 753

5.1.2.1.2 Activity

An Activity organizes and specifies the participation of subordinate behaviors, such as sub-Activities or
Actions 743 , to reflect the control and data flow of a process. Activities are used in Activity diagrams 674 for
various modeling purposes, from procedural-type application development for system design, to business
process modeling of organizational structures or work flow.
The following simple diagram of an Activity contains Action elements and includes input parameters and
output parameters 755 .

You can define an Activity as a composite element 837 , either during creation or during later edits. When
creating a composite Activity element, it is simpler to apply the mechanism for creating Structured Activity
elements, which reduces the number of steps to work through. See the Structured Activity 798 topic. If
converting an existing Activity element, right-click on the element and select the Advanced | Make
Composite context menu option.
Certain properties can be graphically depicted 754 on an Activity. The Actions in an Activity can be further
organized by Activity Partitions 756 .

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 318) states:
An activity specifies the coordination of executions of subordinate behaviors, using a control and data flow
model. The subordinate behaviors coordinated by these models may be initiated because other behaviors in
the model finish executing, because objects and data become available, or because events occur external to
the flow. The flow of execution is modeled as activity nodes connected by activity edges. A node can be the
execution of a subordinate behavior, such as an arithmetic computation, a call to an operation, or manipulation
of object contents. Activity nodes also include flow-of-control constructs, such as synchronization, decision,
and concurrency control. Activities may form invocation hierarchies invoking other activities, ultimately
resolving to individual actions. In an object-oriented model, activities are usually invoked indirectly as methods
bound to operations that are directly invoked.
Activities may describe procedural computation. In this context, they are the methods corresponding to
operations on classes. Activities may be applied to organizational modeling for business process engineering
and workflow. In this context, events often originate from inside the system, such as the finishing of a task, but

© 1998-2010 Sparx Systems Pty Ltd

 754 Modeling Languages | Standard UML Models

also from outside the system, such as a customer call. Activities can also be used for information system
modeling to specify system level processes. Activities may contain actions of various kinds:

· Occurrences of primitive functions, such as arithmetic functions.

· Invocations of behavior, such as activities.

· Communication actions, such as sending of signals.

· Manipulations of objects, such as reading or writing attributes or associations.

Actions have no further decomposition in the activity containing them. However, the execution of a single
action may induce the execution of many other actions. For example, a call action invokes an operation that is
implemented by an activity containing actions that execute before the call action completes.

5.1.2.1.2.1 Activity Notation

Certain properties can be graphically depicted on an Activity 753 element, as shown below.

To define these properties, right-click on the Activity and select the Advanced | Custom Properties context
menu option. The following dialog displays:

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 755

5.1.2.1.2.2 Activity Parameter Nodes

An Activity Parameter Node accepts input to an Activity 753 or provides output from an Activity.
The following example depicts two entry parameters and one output parameter defined for the Activity.

To define an Activity Parameter Node for an Activity, follow the steps below:
1. Right-click on the element and select the Embedded Elements | Add Activity Parameter context
menu option.
2. The Properties dialog displays, which prompts for the Name and other properties of the embedded
element.
3. After closing this dialog, you can further define the new Activity Parameter; right-click on it and select
the Advanced | Custom Properties context menu option. The following dialog displays:

Similar to characterizing Action Pins 749 , Activity Parameter Nodes also have the isException and isStream
options. IsException indicates that a parameter can emit a value at the exclusion of other outputs, usually
because of some error. IsStream indicates whether or not a parameter can accept or post values during the
execution of the Activity.
The following example uses the above settings:

© 1998-2010 Sparx Systems Pty Ltd

 756 Modeling Languages | Standard UML Models

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 338) states:
An activity parameter node is an object node for inputs and outputs to activities.
... Activity parameter nodes are object nodes at the beginning and end of flows that provide a means to accept
inputs to an activity and provide outputs from the activity, through the activity parameters.
Activity parameters inherit support for streaming and exceptions from Parameter.

5.1.2.1.2.3 Activity Partition

Enterprise Architect supports two types of Activity Partition:
· The Activity Partition feature, described in this topic, which is used to logically organize an Activity 753
element
· The Activity Partition 786 element, which is used to logically organize an Activity 674 diagram.
In effect, these are the same. They partition the Actions of the Activity without affecting the token flow, helping
to structure the view or parts of the Activity.
An example of a feature-partitioned Activity is shown below:

To define Partitions using the feature:

1. Right-click on the Activity element. The context menu displays.
2. Select the Advanced | Partition Activity menu option. The Activity Partitions dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 757

3. In the Name field, type the name of a partition. Click on the Save button.
4. Repeat step 3 for each partition to be created.

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 341) states:
Partitions divide the nodes and edges to constrain and show a view of the contained nodes. Partitions can
share contents. They often correspond to organizational units in a business model. They may be used to
allocate characteristics or resources among the nodes of an activity.
The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 341) also states:
An activity partition is a kind of activity group for identifying actions that have some characteristic in common.

5.1.2.1.3 Actor

An Actor is a user of the system; user can mean a human user, a machine, or even another system or
subsystem in the model. Anything that interacts with the system from the outside or system boundary is
termed an Actor. Actors are typically associated with Use Cases 806 .
Actors can use the system through a graphical user interface, through a batch interface or through some other
media. An Actor's interaction with a Use Case is documented in a Use Case scenario, which details the
functions a system must provide to satisfy the user requirements.
Actors also represent the role of a user in Sequence Diagrams 706 . Enterprise Architect supports a
stereotyped Actor element for business modeling 739 . The business modeling elements also represent Actors
as stereotyped Objects.

Toolbox Icon

© 1998-2010 Sparx Systems Pty Ltd

 758 Modeling Languages | Standard UML Models

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 584) states:
An actor models a type of role played by an entity that interacts with the subject (e.g. by exchanging signals
and data), but which is external to the subject. ... Actors may represent roles played by human users, external
hardware, or other subjects. Note that an actor does not necessarily represent a specific physical entity but
merely a particular facet (i.e., "role") of some entity that is relevant to the specification of its associated Use
Cases. Thus, a single physical instance may play the role of several different actors and, conversely, a given
actor may be played by multiple different instances.

5.1.2.1.4 Central Buffer Node

A Central Buffer Node is an object node for managing flows from multiple sources and destinations,
represented in an Activity diagram 674 . It acts as a buffer for multiple in-flows and out-flows from other object
nodes, but does not connect directly to Actions.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 352) states:
A central buffer node is an object node for managing flows from multiple sources and destinations. ... A central
buffer node accepts tokens from upstream object nodes and passes them along to downstream object nodes.

5.1.2.1.5 Choice

The Choice pseudo-state 682 is used to compose complex transitional paths in, for example, a State Machine
diagram 678 , where the outgoing transition path is decided by dynamic, run-time conditions. The run-time
conditions are determined by the actions performed by the State Machine 789 on the path leading to the
choice.
The following example depicts the Choice element. Upon reaching the Filter pseudo-state, a transition fires to
the appropriate state based on the run-time value passed to the Filter. Very similar in form to a Junction 782
pseudo-state, the Choice pseudo-state's distinction is in deciding transition paths at run-time.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 759

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 538) states:
...choice vertices which, when reached, result in the dynamic evaluation of the guards of the triggers of its
outgoing transitions. This realizes a dynamic conditional branch. It enables splitting of transitions into multiple
outgoing paths such that the decision on which path to take may be a function of the results of prior actions
performed in the same run-to-completion step. If more than one of the guards evaluates to true, an arbitrary
one is selected. If none of the guards evaluates to true, then the model is considered ill-formed. (To avoid this,
it is recommended to define one outgoing transition with the predefined "else" guard for every choice vertex.)
Choice vertices should be distinguished from static branch points that are based on junction points.

5.1.2.1.6 Combined Fragment

A Combined Fragment reflects a piece or pieces of interaction (called interaction operands) controlled by an
interaction operator 762 , whose corresponding boolean conditions are known as interaction constraints. It
displays as a transparent window, divided by horizontal dashed lines for each operand.
The following diagram illustrates the use of Combined Fragments, with a Sequence diagram 706 modeling a
simplified purchasing process. A loop fragment is created to iterate through an unknown number of items for
purchase, after which the cashier requests payment. At this point, two payment options are considered and an

© 1998-2010 Sparx Systems Pty Ltd

 760 Modeling Languages | Standard UML Models

alternative fragment is created 761 , divided to show the two operands: cash and credit card. After the fragment
completes its trace, the cashier gives a receipt to the customer, under the fulfilled condition that payment
requirements were met.

The order of interaction fragment conditions can be changed directly on the diagram. Select an interaction
fragment with more than one condition defined. Up and down arrows appear on the right hand side of the each
condition. Just click on the arrow to change the order.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 761

Note:
In order to select an interaction fragment, you must click near the inside edge or drag a selection rectangle
around the fragment. This prevents accidental selection when moving connectors inside the interaction
fragment.

Tip:
Press and hold [Alt] to move a combined fragment independently of its contents.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 467) states:
A combined fragment defines an expression of interaction fragments. A combined fragment is defined by an
interaction operator and corresponding interaction operands. Through the use of CombinedFragments the
user will be able to describe a number of traces in a compact and concise manner.

5.1.2.1.6.1 Create a Combined Fragment

Use the following guidelines to create a Combined Fragment 759 in Enterprise Architect.
1. Drag the Fragment element from the Interaction Elements page of the Toolbox. The following dialog
displays:

2. In the Type field, click on the drop-down arrow and select the interaction operator. See the Interaction
Operators 762 topic for an explanation of the various types of Combined Fragments.
3. In the Condition field, specify a condition or interaction constraint for each operand.
4. A rectangular frame displays, partitioned by dashed lines into segments for each operand.
5. Adjust the frame to encompass the required event occurrences for each operand.

© 1998-2010 Sparx Systems Pty Ltd

 762 Modeling Languages | Standard UML Models

5.1.2.1.6.2 Interaction Operators

When creating Combined Fragments 759 , you must apply an appropriate interaction operator to characterize
the fragment. The following table provides guidance on the various operators, and their corresponding
descriptions.

Interaction Use to
Operator

alt Divide up interaction fragments based on Boolean conditions.

opt Enclose an optional fragment of interaction.

par Indicate that operands operate in parallel.

loop Indicate that the operand repeats a number of times, as specified by interaction
constraints.

critical Indicate a sequence that cannot be interrupted by other processing.

neg Assert that a fragment is invalid, and implies that all other interaction is valid.

assert Specify the only valid fragment to occur. Often enclosed within a consider or ignore
operand.

strict Indicate that the behaviors of the operands must be processed in strict sequence.

seq Indicate that the Combined Fragment is weakly sequenced. This means that the
ordering within operands is maintained, but the ordering between operands is
undefined, so long as an event occurrence of the first operand precedes that of the
second operand, if the event occurrences are on the same lifeline.

ignore Indicate which messages should be ignored during execution, or can appear
anywhere in the execution trace.

consider Specify which messages should be considered in the trace. This is often used to
specify the resulting event occurrences with the use of an assert operator.

ref Provide a reference to another diagram.

Note:
The ref fragment is not created using the method described in the Create a
Combined Fragment 761 topic. To create a ref fragment, simply drag an existing
diagram from the Project Browser onto the current diagram.

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 468-471) states:
The semantics of a CombinedFragment is dependent upon the interactionOperator as explained below.

Alternatives
The interactionOperator alt designates that the CombinedFragment represents a choice of behavior. At most
one of the operands will be chosen. The chosen operand must have an explicit or implicit guard expression
that evaluates to true at this point in the interaction. An implicit true guard is implied if the operand has no
guard.
The set of traces that defines a choice is the union of the (guarded) traces of the operands.
An operand guarded by else designates a guard that is the negation of the disjunction of all other guards in
the enclosing CombinedFragment.
If none of the operands has a guard that evaluates to true, none of the operands are executed and the
remainder of the enclosing InteractionFragment is executed.

Option

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 763

The interactionOperator opt designates that the CombinedFragment represents a choice of behavior where
either the (sole) operand happens or nothing happens. An option is semantically equivalent to an alternative
CombinedFragment where there is one operand with non-empty content and the second operand is empty.

Break
The interactionOperator break designates that the CombinedFragment represents a breaking scenario in the
sense that the operand is a scenario that is performed instead of the remainder of the enclosing
InteractionFragment. A break operator with a guard is chosen when the guard is true and the rest of the
enclosing Interaction Fragment is ignored. When the guard of the break operand is false, the break operand
is ignored and the rest of the enclosing InteractionFragment is chosen. The choice between a break operand
without a guard and the rest of the enclosing InteractionFragment is done non-deterministically.
A CombinedFragment with interactionOperator break should cover all Lifelines of the enclosing
InteractionFragment.

Parallel
The interactionOperator par designates that the CombinedFragment represents a parallel merge between the
behaviors of the operands. The OccurrenceSpecifications of the different operands can be interleaved in any
way as long as the ordering imposed by each operand as such is preserved.
A parallel merge defines a set of traces that describes all the ways that OccurrenceSpecifications of the
operands may be interleaved without obstructing the order of the OccurrenceSpecifications within the
operand.

Weak Sequencing
The interactionOperator seq designates that the CombinedFragment represents a weak sequencing between
the behaviors of the operands.
Weak sequencing is defined by the set of traces with these properties:
1. The ordering of OccurrenceSpecifications within each of the operands is maintained in the result.
2. OccurrenceSpecifications on different lifelines from different operands may come in any order.
3. OccurrenceSpecifications on the same lifeline from different operands are ordered such that an
OccurrenceSpecification of the first operand comes before that of the second operand.
Thus weak sequencing reduces to a parallel merge when the operands are on disjunct sets of participants.
Weak sequencing reduces to strict sequencing when the operands work on only one participant.

Strict Sequencing
The interactionOperator strict designates that the CombinedFragment represents a strict sequencing between
the behaviors of the operands. The semantics of strict sequencing defines a strict ordering of the operands on
the first level within the CombinedIFragment with interactionOperator strict. Therefore
OccurrenceSpecifications within contained CombinedFragment will not directly be compared with other
OccurrenceSpecifications of the enclosing CombinedFragment.

Negative
The interactionOperator neg designates that the CombinedFragment represents traces that are defined to be
invalid.
The set of traces that defined a CombinedFragment with interactionOperator negative is equal to the set of
traces given by its (sole) operand, only that this set is a set of invalid rather than valid traces. All
InteractionFragments that are different from Negative are considered positive meaning that they describe
traces that are valid and should be possible.

Critical Region
The interactionOperator critical designates that the CombinedFragment represents a critical region. A critical
region means that the traces of the region cannot be interleaved by other OccurrenceSpecifications (on those
Lifelines covered by the region). This means that the region is treated atomically by the enclosing fragment
when determining the set of valid traces. Even though enclosing CombinedFragments may imply that some
OccurrenceSpecifications may interleave into the region, such as with par-operator, this is prevented by
defining a region.
Thus the set of traces of enclosing constructs are restricted by critical regions.

Ignore / Consider

© 1998-2010 Sparx Systems Pty Ltd

 764 Modeling Languages | Standard UML Models

(p. 473) The interactionOperator ignore designates that there are some message types that are not shown
within this combined fragment. These message types can be considered insignificant and are implicitly
ignored if they appear in a corresponding execution. Alternatively one can understand ignore to mean that the
messages that are ignored can appear anywhere in the traces.
Conversely the interactionOperator consider designates which messages should be considered within this
CombinedFragment. This is equivalent to defining every other message to be ignored.

Assertion
The interactionOperator assert designates that the CombinedFragment represents an assertion. The
sequences of the operand of the assertion are the only valid continuations. All other continuations result in an
invalid trace. Assertions are often combined with Ignore or Consider.

Loop
The interactionOperator loop designates that the CombinedFragment represents a loop. The loop operand
will be repeated a number of times.
The Guard may include a lower and an upper number of iterations of the loop as well as a Boolean
expression. The semantics is such that a loop will iterate minimum the 'minint' number of times (given by the
iteration expression in the guard) and at most the 'maxint' number of times. After the minimum number of
iterations have executed, and the boolean expression is false the loop will terminate. The loop construct
represent a recursive application of the seq operator where the loop operand is sequenced after the result of
earlier iterations.

The Semantics of Gates

The gates of a CombinedFragment represent the syntactic interface between the CombinedFragment and its
surroundings, which means the interface towards other InteractionFragments.
The only purpose of gates is to define the source and the target of messages.

5.1.2.1.7 Datastore

A Datastore is an element used to define permanently stored data. A token of data that enters into a Datastore
is stored permanently, updating tokens for data that already exists. A token of data that comes out of a
Datastore is a copy of the original data.
Use Object Flow 886 connectors to connect elements (such as Activities 753 ) to Datastores, as values and
information are being passed between nodes. Selection and transformation behavior, together composing a
sort of query, can be specified as to the nature of data access. For instance, selection behavior determines
which objects are affected by the connection to the Datastore. Transformation behavior might then further
specify the value of an attribute pertaining to a selected object.
To define the behavior of access to a Datastore, attach a note to the Object Flow connector. To do this, right-
click on the Object Flow and select the Attach Note or Constraint context menu option. A dialog indicates
other flows in the Activity diagram 674 , to which you can attach the note (if the behavior applies to multiple
flows). To comply with UML 2, preface behavior with the notation «selection» or «transformation».

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 360) states:
A data store node is a central buffer node for non-transient information... A data store keeps all tokens that
enter it, copying them when they are chosen to move downstream. Incoming tokens containing a particular
object replace any tokens in the object node containing that object.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 765

5.1.2.1.8 Decision

A Decision is an element of an Activity diagram 674 or Interaction Overview diagram 717 that indicates a point
of conditional progression: if a condition is true, then processing continues one way; if not, then another.
This can also be used as a Merge node 784 in that multiple alternative flows can be merged (but not
synchronized) to form one flow. The following examples show both of these modes of using the decision
element.
Used as a decision:

See UML Superstructure Specification, v2.1.1, figure 12.77, p. 363.

Used as a merge:

See UML Superstructure Specification, v2.1.1, figure 12.106, p. 388.

Note:
Moving a diagram generally does not affect the location of elements in packages. If you move a diagram out
of one package into another, all the elements in the diagram remain in the original package. However,
Decision elements are used only within one diagram, have no meaning outside that diagram, and are never
re-used in any other diagram. Therefore, if you move a diagram containing these elements, they are moved
to the new parent package with the diagram.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 361 (Decision symbol)) states:

© 1998-2010 Sparx Systems Pty Ltd

 766 Modeling Languages | Standard UML Models

A decision node is a control node that chooses between outgoing flows. A decision node has one incoming
edge and multiple outgoing activity edges.
The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 387 (Merge symbol)) also states:
A merge node is a control node that brings together multiple alternate flows. It is not used to synchronize
concurrent flows but to accept one among several alternate flows... A merge node has multiple incoming
edges and a single outgoing edge.

5.1.2.1.9 Diagram Frame

A Diagram Frame element is a rendition of a diagram dropped from the Project Browser into another diagram.
It is a type of Combined Fragment 759 with the Interaction Operator 762 ref. However, it can be created on any
type of diagram, and is not created in the same way as other Combined Fragments.
When you drop the diagram from the Project Browser onto the open diagram, the following prompt displays:

If you click on the Diagram Frame radio button, a Diagram Frame is inserted into the diagram, containing an
image of the dropped diagram.
If you select the Diagram Reference option, an empty frame is inserted with the name of the dropped diagram

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 767

in the frame label. If you select the Hyperlink radio button, a diagram icon is inserted with no frame, and with
the parent package and diagram name next to it.
In all three cases, the object acts as a hyperlink to the real referenced diagram. You can also define properties
for the objects, as for other elements, by right-clicking on the object and selecting the element Properties
context menu option.

Notes:
· You can change the size of all three objects, but you cannot reduce a Diagram Frame to less than the size
of the enclosed diagram.
· You cannot change the diagram within a Diagram Frame. To edit the diagram, double-click within the
frame and edit the original diagram.
· The Diagram Frame element looks identical to but is not the same as a diagram frame border, which you
can set automatically on new images of diagrams using the Tools | Options | Diagram option, and
selecting the appropriate checkboxes in the Diagram Frames panel. These options set frames on print-outs
of diagrams, images of diagrams copied to file, and images of diagrams copied to the clipboard. If you
paste the image from the clipboard into another diagram, the image initially looks the same as the Diagram
Frame element but it is actually a discreet unit that you manipulate using the Image Manager 447 .

5.1.2.1.10 Diagram Gate

A Diagram Gate is a simple graphical way to indicate the point at which messages can be transmitted into and
out of interaction fragments. A fragment might be required to receive or deliver a message; internally, an
ordered message reflects this requirement, with a gate indicated on the boundary of the fragment's frame. Any
external messages 'synching' with this internal message must correspond appropriately. Gates can appear on
Interaction diagrams (Sequence 706 , Timing 690 , Communication 715 or Interaction Overview 717 ), interaction
occurrences 780 and combined fragments 759 (to specify the expression).

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 480) states:
A Gate is a connection point for relating a Message outside an InteractionFragment with a Message inside the
InteractionFragment ... Gates are connected through Messages. A Gate is actually a representative of an

© 1998-2010 Sparx Systems Pty Ltd

 768 Modeling Languages | Standard UML Models

OccurrenceSpecification that is not in the same scope as the Gate. Gates play different roles: we have formal
gates on Interactions, actual gates on InteractionUses, expression gates on CombinedFragments.

5.1.2.1.11 Endpoint

An Endpoint is used in Interaction diagrams (Sequence 706 , Timing 690 , Communication 715 or Interaction
Overview 717 ) to reflect a lost or found message in sequence. To model this, drag an Endpoint element onto
the workspace.
With Sequence diagrams, drag a message from the appropriate lifeline to the Endpoint. With Timing
diagrams, the message connecting the lifeline to the Endpoint requires some timing specifications to draw the
connection.
The following example depicts a lost message in a Sequence diagram.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 492) states:
A lost message is a message where the sending event occurrence is known, but there is no receiving event
occurrence. We interpret this to be because the message never reached its destination.
A found message is a message where the receiving event occurrence is known, but there is no (known)
sending event occurrence. We interpret this to be because the origin of the message is outside the scope of
the description. This may, for example, be noise or other activity that we do not want to describe in detail.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 769

5.1.2.1.12 Entry Point

Entry Point pseudo-states 682 are used to define the beginning of a State Machine 678 . An Entry Point exists
for each region, directing the initial concurrent state configuration.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 471) states:
An entry point pseudostate is an entry point of a state machine or composite state. In each region of the state
machine or composite state it has a single transition to a vertex within the same region.

5.1.2.1.13 Exception

The Exception Handler element defines the group of operations to carry out when an exception occurs. In an
Activity diagram 674 , the protected element can contain a set of operations and is connected to the exception
handler via an Interrupt Flow 867 connector. Any defined error contained within an element's parts can trigger
the flow to move to an exception.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 364) states:
An exception handler is an element that specifies a body to execute in case the specified exception occurs
during the execution of the protected node.

5.1.2.1.14 Expansion Region

You create 771 an Expansion Region as one variant of a Region 788 (the other is an Interruptible Activity
Region 781 ).
On an Activity diagram 674 , an Expansion Region surrounds a process to be imposed multiple times on the

© 1998-2010 Sparx Systems Pty Ltd

 770 Modeling Languages | Standard UML Models

incoming data, once for every element in the input collection. If there are multiple inputs, the collection sizes
must match, and the elements within each collection must be of the same type. Similarly, any outputs must be
in the form of a collection matching the size of the inputs.
The concurrency of the Expansion Region's multiple executions can be specified as type parallel, iterative, or
stream. Parallel reflects that the elements in the incoming collections can be processed at the same time or
overlapping, whereas an iterative concurrency type specifies that execution must occur sequentially. A stream-
type Expansion Region indicates that the input and output come in and exit as streams, and that the
Expansion Region's process must have some method to support streams.
To modify the mode of an Expansion Region, right-click on it and select the Advanced | Custom Properties
context menu option.

See UML Superstructure Specification, v2.1.1, figure 12.87, p. 372.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 771

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 367) states:
An expansion region is a structured activity region that executes multiple times corresponding to elements of
an input collection.

5.1.2.1.14.1 Add Expansion Region

When you add a Region 788 element to a diagram, the following prompt displays:

The Select type defaults to InterruptibleActivityRegion.

1. Select the type ExpansionRegion 769 .

2. In the Kind field, click on the drop-down arrow and select the concurrency attribute.

5.1.2.1.15 Exit Point

Exit Points are used in Submachine states 796 and State Machines 789 to denote the point where the machine
is exited and the transition sourcing this exit point, for Submachines, is triggered. Exit points are a type of
pseudo-state 682 used in the State Machine 678 diagram.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1 p. 538) states:
An exit point pseudostate is an exit point of a state machine or composite state. Entering an exit point within
any region of the composite state or state machine referenced by a submachine state implies the exit of this
composite state or submachine state and the triggering of the transition that has this exit point as source in the
state machine enclosing the submachine or composite state.

© 1998-2010 Sparx Systems Pty Ltd

 772 Modeling Languages | Standard UML Models

5.1.2.1.16 Final

There are two nodes used to define a Final state in an Activity 753 , both defined in UML 2.3 as of type Final
Node. The Activity Final element, shown above, indicates the completion of an Activity; upon reaching the
Final, all execution in the Activity diagram 674 is aborted. The other type of final node, Flow Final 772 , depicts
an exit from the system that has no effect on other executing flows in the Activity.
The following example illustrates the development of an application. The process comes to a Flow Final node
when there are no more components to be built; note that the Fork 775 element indicates a concurrent process
with the building of new components and installation of completed components. The Flow Final terminates
only the sub-process building components. Similarly, only those tokens entering the decision branch for the
installation of further components terminate with the connecting Flow Final (that is, stop installing this
component, but keep on installing other components). It is only after the Deliver Application activity is
completed, after the control flow reaches the Final node, that all flows stop.
The node that initiates a flow is the Initial 778 node.

See UML Superstructure Specification, v2.1.1, figure 12.91, p. 374.

Note:
Moving a diagram generally does not affect the location of elements in packages. If you move a diagram out
of one package into another, all the elements in the diagram remain in the original package. However, Final
elements are used only within one diagram, have no meaning outside that diagram, and are never re-used in
any other diagram. Therefore, if you move a diagram containing these elements, they are moved to the new
parent package with the diagram.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 332) states:
An activity may have more than one activity final node. The first one reached stops all flows in the activity.

5.1.2.1.17 Flow Final

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 773

There are two nodes used to define a final state in an Activity, both defined in UML 2.3 as of type Final Node.
The Flow Final element depicts an exit from the system, as opposed to the Activity Final 772 , which represents
the completion of the Activity. Only the flow entering the Flow Final node exits the Activity; other flows continue
undisturbed.
The following example Activity Diagram 674 illustrates the development of an application. The process comes
to a Flow Final node when there are no more components to be built; note that the Fork 775 element indicates
a concurrent process with the building of new components and installation of completed components. The
Flow Final terminates only the sub-process building components. Similarly, only those tokens entering the
decision branch for the installation of further components terminate with the connecting Flow Final (that is,
stop installing this component, but keep on installing other components). It is only after the Deliver Application
activity is completed, after the control flow reaches the Final node, that all flows stop.

See UML Superstructure Specification, v2.1.1, figure 12.91, p. 374.

Note:
Moving a diagram generally does not affect the location of elements in packages. If you move a diagram out
of one package into another, all the elements in the diagram remain in the original package. However, Flow
Final elements are used only within one diagram, have no meaning outside that diagram, and are never re-
used in any other diagram. Therefore, if you move a diagram containing these elements, they are moved to
the new parent package with the diagram.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 375) states:
A flow final destroys all tokens that arrive at it. It has no effect on other flows in the activity.

5.1.2.1.18 Fork/Join

The Fork/Join elements have different modes of use, as follows:

· To fork or split the flow into a number of concurrent flows.
· To join the flow of a number of concurrent flows.
· To both join and fork a number of incoming flows to a number of outgoing flows.
These elements are used in both Activity 674 and State Machine 678 diagrams. With respect to State Machine
diagrams, Forks 775 and Joins 776 are used as pseudo-states 682 . Other pseudo-states include history states

© 1998-2010 Sparx Systems Pty Ltd

 774 Modeling Languages | Standard UML Models

777 , entry points 769 and exit points 771 . Forks are used to split an incoming transition into concurrent multiple
transitions leading to different target states. Joins are used to merge concurrent multiple transitions into a
single transition leading to a single target. They are semantic inverses. To learn more about these individual
elements see their specific topics.
Some examples of Fork/Join nodes include:
Fork or split the flow into a number of concurrent flows:

See UML Superstructure Specification, v2.1.1, figure 12.95 p. 377.

Join the flow of a number of concurrent flows:

See UML Superstructure Specification, v2.1.1, figure 12.103, p. 384.

Join and Fork a number of incoming flows to a number of outgoing flows:

Toolbox Icon

OMG UML Specification

Fork
The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 376) states:
A fork node is a control node that splits a flow into multiple concurrent flows... A fork node has one incoming
edge and multiple outgoing edges.
Join
The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 381-382) states:

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 775

A join node is a control node that synchronizes multiple flows... A join node has multiple incoming edges and
one outgoing edge.

5.1.2.1.18.1 Fork

See UML Superstructure Specification, v2.1.1, figure 12.95 p. 377.

These elements are used in both Activity 674 and State Machine 678 diagrams. With respect to State Machine
diagrams, a Fork pseudo-state 682 signifies that its incoming transition comes from a single state, and it has
multiple outgoing transitions. These transitions must occur concurrently, requiring the use of concurrent
regions 788 , as depicted below in the Composite State 790 . Unlike Choice 758 or Junction 782 pseudo-states,
Forks must not have triggers or guards. The following diagram demonstrates a Fork pseudo-state dividing into
two concurrent regions, which then return to the End State via the Join 776 pseudo-state.

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 538) states:
Fork vertices serve to split an incoming transition into two or more transitions terminating on orthogonal target
vertices (i.e. vertices in different regions of a composite state). The segments outgoing from a fork vertex must
not have guards or triggers.

© 1998-2010 Sparx Systems Pty Ltd

 776 Modeling Languages | Standard UML Models

5.1.2.1.18.2 Join

See UML Superstructure Specification, v2.1.1, figure 12.103, p. 384.

The Join element is used by Activity 674 and State Machine 678 diagrams. The above example illustrates a
Join transition between Activities. With respect to State Machine diagrams, a Join pseudo-state 682 indicates
multiple States 789 concurrently transitioning into the Join and onto a single State. Unlike Choice 758 or
Junction 782 pseudo-states, Joins must not have triggers or guards. The following diagram demonstrates a
Fork 775 pseudo-state dividing into two concurrent Regions 788 , which then return to the End State via the
Join.

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 538) states:
Join vertices serve to merge several transitions emanating from source vertices in different orthogonal
regions. The transitions entering a join vertex cannot have guards or triggers.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 777

5.1.2.1.19 History

There are two types of History pseudo-state 682 defined in UML: shallow and deep History. A shallow History
sub-state is used to represent the most recently active sub-state of a Composite State 790 ; this pseudo-state
does not recurse into this sub-state's active configuration, should one exist. A single connector can be used to
depict the default shallow History state, in case the Composite State has never been entered.
A deep History sub-state, in contrast, reflects the most recent active configuration of the Composite State. This
includes active sub-states of all regions, and recurses into those sub-states' active sub-states, should they
exist. At most one deep History and one shallow History can dwell within a composite state. You can convert a
shallow History pseudostate to a deep History pseudostate using the Advanced 550 element context menu.

Toolbox Icon

© 1998-2010 Sparx Systems Pty Ltd

 778 Modeling Languages | Standard UML Models

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 537) states:
... deepHistory represents the most recent active configuration of the composite state that directly contains this
pseudostate (e.g., the state configuration that was active when the composite state was last exited). A
composite state can have at most one deep history vertex. At most one transition may originate from the
history connector to the default deep history state. This transition is taken in case the composite state had
never been active before. Entry actions of states entered on the path to the state represented by a deep
history are performed.
... shallowHistory represents the most recent active substate of its containing state (but not the substates of
that substate). A composite state can have at most one shallow history vertex. A transition coming into the
shallow history vertex is equivalent to a transition coming into the most recent active substate of a state. At
most one transition may originate from the history connector to the default shallow history state. This transition
is taken in case the composite state had never been active before. Entry actions of states entered on the path
to the state represented by a shallow history are performed.

5.1.2.1.20 Initial

The Initial element is used by Activity 674 and State Machine 678 diagrams. In Activity diagrams, it defines the
start of a flow when an Activity 753 is invoked. With State Machines, the Initial element is a pseudo-state 682
used to denote the default state of a Composite State 790 ; there can be one Initial vertex in each Region 788 of
the Composite State.
This simple example shows the start of a flow to receive an order.

See UML Superstructure Specification, v2.1.1, Figure 12.97, p. 378.

The activity flow is completed by a Final 772 or Flow Final 772 node.

Note:
Moving a diagram generally does not affect the location of elements in packages. If you move a diagram out
of one package into another, all the elements in the diagram remain in the original package. However, Initial
elements are used only within one diagram, have no meaning outside that diagram, and are never re-used in
any other diagram. Therefore, if you move a diagram containing these elements, they are moved to the new
parent package with the diagram.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 537) states:
An initial pseudostate represents a default vertex that is the source for a single transition to the default state of
a composite state. There can be at most one initial vertex in a region. The outgoing transition from the initial
vertex may have a behavior, but not a trigger or guard.
The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 378) also states:

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 779

An initial node is a control node at which flow starts when the activity is invoked.

5.1.2.1.21 Interaction
An Interaction element is used to describe a system, representing its interactions at varying levels of detail, for
review not only by design professionals but also by end users and stakeholders. An Interaction element can
contain the following types of diagram:
· Sequence 706
· Interaction Overview 717

· Communication 715
· Timing 690 .

An Interaction element in Enterprise Architect is treated as a behavior of the classifier it is encapsulated within.
It can have parameters and return types, which are modeled using the Behavior tab of the Interaction
element's Properties dialog. The element is interpreted as a method of the containing Class in the generated
code (see the Generate Code From Behavioral Model 1314 topic).
An Interaction element can also be set as the classifier for an Interaction Occurrence 780 in a Sequence
diagram, or for a Call Behavior Action 745 in an Activity diagram. Establishing such an association (between a
behavior 582 and a behavior call 582 ) facilitates adding arguments 582 that can be individually mapped to the
associated behavior's parameters.

Note:
The behavioral code generation engine expects the Sequence diagram and all its associated messages and
interaction fragments to be encapsulated within an Interaction element (such as setupUSB in the example
below).

(The IO Class shown above is available in the EAExample model, under Systems Engineering Model |
Implementation Model | Software.)

© 1998-2010 Sparx Systems Pty Ltd

 780 Modeling Languages | Standard UML Models

5.1.2.1.22 Interaction Occurrence

An Interaction Occurrence (or InteractionUse) is a reference to an existing Interaction (Sequence 706 )

diagram. Interaction Occurrences are visually represented by a frame, with ref in the frame's title space. The
diagram name is indicated in the frame contents. To create an Interaction Occurrence, simply open a
Sequence diagram (preferably contained within an Interaction element 779 ) and drag another Sequence
diagram (also preferably contained within an Interaction element) into its workspace. A dialog displays,
providing configuration options. The resulting Interaction Occurrence acts as an invocation of the original
Interaction. You use the Call 581 tab of the element Properties dialog to set up the actual arguments 582 of the
Interaction and also to change to a different associated Interaction element.
The following figure illustrates the use of an Interaction Occurrence in another Interaction (Sequence)
diagram. You can display the sequence represented by the Interaction Occurrence by double-clicking on the
element.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 781

Note:
The behavioral code generation engine expects the Sequence diagram and all its associated messages and
interaction fragments to be encapsulated within an Interaction element (such as doReadUSB in the example
below).

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 423) refers to an Interaction
Occurrence as an InteractionUse, and states:
An InteractionUse refers to an Interaction. The InteractionUse is a shorthand for copying the contents of the
referred Interaction where the InteractionUse is. To be accurate the copying must take into account
substituting parameters with arguments and connect the formal gates with the actual ones.
It is common to want to share portions of an interaction between several other interactions. An InteractionUse
allows multiple interactions to reference an interaction that represents a common portion of their specification.

5.1.2.1.23 Interruptible Activity Region

You create 782 an Interruptible Activity Region as one variant of a Region 788 (the other is an Expansion
Region 769 ).
In an Activity diagram 674 , an Interruptible Activity Region surrounds a group of Activity 753 elements, all
affected by certain interrupts in such a way that all tokens passing within the region are terminated should the
interruption(s) be raised. Any processing occurring within the bounds of an Interruptible Activity Region is
terminated when a flow is instigated across an interrupt flow to an external element.
The example below illustrates that an order cancellation kills any processing of the order at the receipt, filling
or shipping stage.

© 1998-2010 Sparx Systems Pty Ltd

 782 Modeling Languages | Standard UML Models

See UML Superstructure Specification, v2.1.1, figure 12.100, p. 381.

To create an Interruptible Activity Region, click on this Add an Interruptible Activity Region 782 link.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 380) states:
An interruptible region contains activity nodes. When a token leaves an interruptible region via edges
designated by the region as interrupting edges, all tokens and behaviors in the region are terminated.

5.1.2.1.23.1 Add Interruptible Activity Region

When you add a Region element to an Activity diagram, the following prompt displays:

The Select type panel defaults to InterruptibleActivityRegion 781 and the Kind field is disabled. Click on the
OK button.

5.1.2.1.24 Junction

Junction pseudo-states 682 are used to design complex transitional paths in State Machine 678 diagrams. A
Junction can be used to combine or merge multiple paths into a shared transition path. Alternatively, a
Junction can split an incoming path into multiple paths, similar to a Fork 775 pseudostate. Unlike Forks or
Joins 776 , Junctions can apply guards to each incoming or outgoing transition, such that if the guard
expression is false, the transition is disabled.
The following example illustrates how guards can be applied to transitions coming into or out of a Junction
pseudo-state.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 783

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 538) states:
... junction vertices are semantic-free vertices that are used to chain together multiple transitions. They are
used to construct compound transition paths between states. For example, a junction can be used to converge
multiple incoming transitions into a single outgoing transition representing a shared transition path (this is
known as a merge). Conversely, they can be used to split an incoming transition into multiple outgoing
transition segments with different guard conditions. This realizes a static conditional branch. (In the latter case,
outgoing transitions whose guard conditions evaluate to false are disabled. A predefined guard denoted "else"
may be defined for at most one outgoing transition. This transition is enabled if all the guards labeling the
other transitions are false.) Static conditional branches are distinct from dynamic conditional branches that are
realized by choice vertices.

5.1.2.1.25 Lifeline

A Lifeline is an individual participant in an interaction (that is, Lifelines cannot have multiplicity). A Lifeline
represents a distinct connectable element. To specify that representation within Enterprise Architect, right-click

© 1998-2010 Sparx Systems Pty Ltd

 784 Modeling Languages | Standard UML Models

on the Lifeline and select the Advanced | Instance Classifier context menu option. The Select <Item> 515
dialog displays which you use to locate the required project classifiers.
Lifelines are available in Sequence 706 diagrams. There are different Lifeline elements for Timing diagrams 690
(State Lifeline 794 and Value Lifeline 808 ) 808 ; however, although the representation differs between the two
diagram types, the meaning of the Lifeline is the same.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p.489) states:
A lifeline represents an individual participant in the Interaction. While Parts and StructuralFeatures may have
multiplicity greater than 1, Lifelines represent only one interacting entity.
Lifeline is a specialization of NamedElement.
If the referenced ConnectableElement is multivalued (i.e. has a multiplicity > 1), then the Lifeline may have an
expression (the 'selector') that specifies which particular part is represented by this Lifeline. If the selector is
omitted this means that an arbitrary representative of the multivalued ConnectableElement is chosen.

5.1.2.1.26 Merge

A Merge Node brings together a number of alternative flow paths in Activity 674 , Analysis 733 and Interaction
Overview 717 diagrams. For example, if a Decision 765 is used after a Fork 775 , the two flows coming out of the
Decision must be merged into one before going to a Join 776 ; otherwise, the Join waits for both flows, only one
of which arrives.
A Merge Node has multiple incoming edges and a single outgoing edge. The edges coming into and out of a
Merge Node must be either all object flows 886 or all control flows 860 .

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 387) states:
A merge node is a control node that brings together multiple alternate flows. It is not used to synchronize
concurrent flows but to accept one among several alternate flows.

5.1.2.1.27 Message Endpoint

A Message Endpoint element defines the termination of a State 794 or Value 808 Lifeline in a Timing diagram
690 .

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 785

Toolbox Icon

5.1.2.1.28 Message Label

A Message Label is an alternative way of denoting Messages 882 between Lifelines, which is useful for
'uncluttering' Timing diagrams 690 strewn with messages. To indicate a Message between Lifelines, draw a
connector from the source Lifeline into a Message Label. Next, draw a connector from another Message Label
to the target Lifeline. Note that the label names must match to reflect that the message occurs between the
two Message Labels.
The following diagram illustrates how Message Labels are used to construct a message between Lifelines.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 518) states:
Labels are only notational shorthands used to prevent cluttering of the diagrams with a number of messages
crisscrossing the diagram between Lifelines that are far apart. The labels denote that a Message may be
disrupted by introducing labels with the same name.

5.1.2.1.29 Note

A Note element is a textual annotation that can be attached to a set of elements of any other type. The
attachment is created separately, using a Notelink 886 connector. Both Note and Notelink are available in any
Enterprise Architect diagram, through the Common 405 pages of the Toolbox.

© 1998-2010 Sparx Systems Pty Ltd

 786 Modeling Languages | Standard UML Models

A Note is also called a Comment.

A Constraint is a form of Note, identifying a constraint on other elements. As for a Note, you can connect the
Constraint element to other elements using a Notelink connector. This element is just a means of documenting
the fact that there are constraints; it has no impact on the other elements. You define the types of constraint in
the project reference data 655 , apply them to the element in the element Properties 488 dialog, and manage
them through the Scenarios & Requirements 514 window.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 59) states:
A comment gives the ability to attach various remarks to elements. A comment carries no semantic force, but
may contain information that is useful to a modeler.
A comment can be owned by any element.

5.1.2.1.30 Partition

Enterprise Architect supports two types of Activity Partition:

· The Activity Partition feature 756 , which is used to logically organize an Activity 753 element
· The Activity Partition element, described in this topic, which is used to logically organize an Activity 674
diagram.
In effect, these are the same. They partition the Actions of the Activity without affecting the token flow, helping
to structure the view or parts of the Activity.
The following example depicts the partitioning between the Classes Process Payment and Order Processor.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 787

The Partition orientation defaults to horizontal. To turn it into a vertical Partition, right-click on it and select the
Advanced | Vertical Partition context menu option.

You can neatly align and join the Activity Partitions on a diagram using the element context menu Dockable
555 option. For Partitions, the option defaults to selected.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 341) states:
Partitions divide the nodes and edges to constrain and show a view of the contained nodes. Partitions can
share contents. They often correspond to organizational units in a business model. They may be used to
allocate characteristics or resources among the nodes of an activity.
The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 341) also states:
An activity partition is a kind of activity group for identifying actions that have some characteristic in common.

5.1.2.1.31 Receive

A Receive element is used to define the acceptance or receipt of a request, in an Activity diagram 674 .
Movement from a Receive element occurs only once receipt is fulfilled according to its specification. The
Receive element comes in two forms:
· Accept Event Action element (pennant shape)
· Accept Time Event Action element (hourglass shape)
The following example reflects a payment process on an order. Upon receiving the payment (from Request
Payments, a Send 789 element), the payment is confirmed and the flow continues to ship the order.

© 1998-2010 Sparx Systems Pty Ltd

 788 Modeling Languages | Standard UML Models

See UML Superstructure Specification, v2.1.1, figure 12.26, p. 312.

To depict an Accept Time Event, use the standard Receive element from the Toolbox. Right-click on this
element, and select the Advanced | Accept Time Event context menu option. The following example shows
the hourglass-shaped Accept Time Event Action:

See UML Superstructure Specification, v2.1.1, figure 12.27, p. 312.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 239) states:
AcceptEventAction is an action that waits for the occurrence of an event meeting specified conditions.

5.1.2.1.32 Region

Enterprise Architect supports two types of Region element:

· Expansion Region 769
· Interruptible Activity Region 781

When you add a Region element to an Activity diagram 674 , the following prompt appears. You use this to
specify the Region type.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 789

Toolbox Icon

5.1.2.1.33 Send

The Send element is used to depict the action of sending a signal, in an Activity diagram 674 . It is the opposite
of a Receive 787 element.
The following example shows an order being processed, where a signal is sent to fill the processed order and,
upon creation of the resulting invoice, a notification is sent to the customer.

See UML Superstructure Specification, v2.1.1, figure 12.132, p. 408.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 285) states:
SendObjectAction is an action that transmits an object to the target object, where it may invoke behavior such
as the firing of state machine transitions or the execution of an activity. The value of the object is available to
the execution of invoked behaviors. The requestor continues execution immediately. Any reply message is
ignored and is not transmitted to the requestor.

5.1.2.1.34 State

A State represents a situation where some invariant condition holds; this condition can be static (waiting for an
event) or dynamic (performing a set of activities). State modeling is usually related to Classes 811 , and
describes the enableable states a Class or element can be in and the transitions that enable the element to
move there. There are two types of State: Simple States and Composite States 790 , both created from the
State element from the Toolbox.
Furthermore, there are pseudo-states 682 , resembling some aspect of a State but with a pre-defined
implication. Pseudo-states model complex transitional paths, and classify common State Machine 678
behavior.
You can define entry, internal and exit actions for a State using operations 570 .

If a State element has features such as attributes or operations, the depiction of the element in a diagram has

© 1998-2010 Sparx Systems Pty Ltd

 790 Modeling Languages | Standard UML Models

a line under the element name. This line persists if the features are hidden. The line also displays if the Show
State Compartment checkbox is selected on the Objects page of the Options dialog (Tools | Options |
Objects).

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 546) states:
A state models a situation during which some (usually implicit) invariant condition holds. The invariant may
represent a static situation such as an object waiting for some external event to occur. However, it can also
model dynamic conditions such as the process of performing some activity (i.e., the model element under
consideration enters the state when the activity commences and leaves it as soon as the activity is
completed).

5.1.2.1.34.1 Composite State

Composite States are composed within the State Machine diagram 678 by expanding a State 789 element,
adding Regions 681 if applicable, and dragging further State elements, related elements and connectors within
its boundaries. The internal State elements are then referred to as Sub-states.
(You can also define a State element, as with many other types of element, as a composite element 837 ; this
then has a hyperlink to a child diagram that can be another State Machine diagram or other type of diagram
elsewhere in the model.)
Composite States can be orthogonal, if Regions are created. If a Composite State is orthogonal, its entry
denotes that a single Sub-state is concurrently active in all Regions. The hierarchical nesting of Composite
States, coupled with Region use, generates a situation of multiple States concurrently active; this situation is
referred to as the active State configuration.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 791

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 478) states:
A composite state either contains one region or is decomposed into two or more orthogonal regions. Each
region has a set of mutually exclusive disjoint subvertices and a set of transitions. A given state may only be
decomposed in one of these two ways.
Any state enclosed within a region of a composite state is called a substate of that composite state. It is called
a direct substate when it is not contained by any other state; otherwise it is referred to as an indirect substate.
Each region of a composite state may have an initial pseudostate and a final state. A transition to the
enclosing state represents a transition to the initial pseudostate in each region. A newly-created object takes
its topmost default transitions, originating from the topmost initial pseudostates of each region.
A transition to a final state represents the completion of activity in the enclosing region. Completion of activity
in all orthogonal regions represents completion of activity by the enclosing state and triggers a completion
event on the enclosing state. Completion of the topmost regions of an object corresponds to its termination.

© 1998-2010 Sparx Systems Pty Ltd

 792 Modeling Languages | Standard UML Models

5.1.2.1.35 State/Continuation

The State/Continuation element serves two different purposes for Interaction (Sequence 706 ) diagrams, as
State Invariants 793 and Continuations 792 . Enterprise Architect prompts you to identify the purpose when you
create the element.

Toolbox Icon

5.1.2.1.35.1 Continuation
A Continuation is used in seq and alt Combined Fragments 759 , to indicate the branches of continuation an
operand follows. To indicate a continuation, end an operand with a Continuation, and indicate the continuation
branch with a matching Continuation (same name) preceding the Interaction Fragment.
You create a Continuation by dragging the State/Continuation 792 element onto the diagram from the
Interaction Elements page of the Toolbox.
For the following continuation example, an alt Combined Fragment has Continuations pathSucc and pathFail.
These Continuations are located within the Interaction Occurrence 780 ConnHandler, which has subsequent
events based on the continuation.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 793

The following diagram shows the interaction referenced by the Interaction Occurrence.

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 474) states:
A Continuation is a syntactic way to define continuations of different branches of an Alternative
CombinedFragment. Continuation is intuitively similar to labels representing intermediate points in a flow of
control.
The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 474) also states:
Continuations have semantics only in connection with Alternative CombinedFragments and (weak)
sequencing.
If an InteractionOperand of an Alternative CombinedFragment ends in a Continuation with name (say) X, only
InteractionFragments starting with the Continuation X (or no continuation at all) can be appended.

5.1.2.1.35.2 State Invariant

A State Invariant is a condition applied to a Lifeline 783 , which must be fulfilled for the Lifeline to exist. You
create a State Invariant by dragging the State/Continuation 792 element onto the diagram from the Interaction
Elements page of the Toolbox.
The following diagram illustrates a State Invariant.

© 1998-2010 Sparx Systems Pty Ltd

 794 Modeling Languages | Standard UML Models

When a State Invariant is moved near to a Lifeline, it snaps to the center. If the sequence object is dragged
left or right, the State Invariant moves with it.

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 502) states:
A StateInvariant is a runtime constraint on the participants of the interaction. It may be used to specify a
variety of different kinds of constraints, such as values of attributes or variables, internal or external states,
and so on.
A StateInvariant is an InteractionFragment and it is placed on a Lifeline.

5.1.2.1.36 State Lifeline

A Lifeline is the path an object takes across a measure of time, as indicated by the x-axis. There are two
sorts: State Lifelines (defined here) and Value Lifelines 808 , both used in Timing diagrams 690 .
A State Lifeline follows discrete transitions between states, which are defined along the y-axis of the timeline.
Any transition has optional attributes of timing constraints, duration constraints and observations. An example
of a State Lifeline is shown below:

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 795

See UML Superstructure Specification, v2.1.1, figure 14.29, p. 519.

A State Lifeline consists of a set of transition points. Each transition point can be defined with the following
properties:

Property Description

At time Specifies the starting time for a change of state.

Transition to Indicates the state to which the lifeline changes.

Event Describes the occurring event.

Timing constraints Refers to the time taken for a state to change within a lifeline, or the time taken to
transmit a message (e.g. t..t+3).

Timing observations Provides information on the time of a state change or sent message.

Duration constraints Pertains to a lifeline's period at a particular state. The constraint could be
instigated by a change of state within a lifeline, or that lifeline's receipt of a
message.

Duration observations Indicates the interval of a lifeline at a particular state, begun from a change in
state or message receipt.

In the example diagram above, the OK transition point has these properties:

Property Value

At Time 18 ms

Transition to Idle

Event OK

Timing constraints t..t+3

Timing observations –

Duration constraints –

Duration observations –

Toolbox Icon

© 1998-2010 Sparx Systems Pty Ltd

 796 Modeling Languages | Standard UML Models

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 518) states:
This is the state of the classifier or attribute, or some testable condition, such as an discrete enumerable
value.
It is also permissible to let the state-dimension be continuous as well as discrete. This is illustrative for
scenarios where certain entities undergo continuous state changes, such as temperature or density.

5.1.2.1.37 State Machine

A State Machine element is a container for groups of related State elements. You can create sections of a
State Machine diagram, showing the organization of the inter-related State elements, and enclose each
section in a State Machine element. You can also create Regions 681 on a State Machine element.

Toolbox Icon

5.1.2.1.38 Structured Activity

Structured Activity elements are used in Activity diagrams 674 . A Structured Activity is an activity node that can
have subordinate nodes as an independent Activity Group. No other Activities or their side effects should
interfere with this Activity's processing.
Enterprise Architect provides two forms of Structured Activity - basic and specialized. It also applies the
mechanism for creating Structured Activities to creating composite Activity 753 elements quickly and simply.
The two basic Structured Activities are:
· Structured Activity Node 798 - represents an ordered arrangement of executable Activity nodes (Actions,
Decisions, Merges and so on) that can include branched and nested nodes; this is the base element from
which the other types of Structured Activity are derived
· Sequential Node 798 - represents a sequential arrangement of executable Activity nodes.
The two specialized Structured Activities are used to effectively model discreet patterns within an activity
graph, defined in Clauses or Partitions:
· Conditional node 798 - represents an arrangement of Actions and Activities where choice determines which
Activities are performed
· Loop node 798 - represents a sequence of Actions and Activities that are - or can be - repeated on the
same object.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 797

Note:
All four Structured Activity Nodes are created as composite elements 837 . However, for the Loop Node and
Conditional Node elements you must create the child element structure on the parent diagram within the
node element itself, as for a Composite State 790 . You cannot develop the partitioned structure of the nodes
on a child diagram.
For this reason, the Show Composite Diagram facility is not available for the Loop Node and Conditional
Node. It is also not available on the Structured Activity Node, as this is the base element for the Loop and
Conditional Nodes. You can, however, use the two basic nodes as composite elements, and display the child
diagram structure on the parent Sequential node.

When you create a Structured Activity, by selecting the icon from the Activity page of the Toolbox, the
following context menu displays:

The first two options specifically create a Loop or Conditional Node. The Other option displays the New
Structured Activity dialog, on which you can select to create any of the four nodes, or a simple Composite
Activity element.

Toolbox Icon

OMG UML Specification

Structured Activity Node
The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 409) states:
A structured activity node is an executable activity node that may have an expansion into subordinate nodes
as an ActivityGroup. The subordinate nodes must belong to only one structured activity node, although they
may be nested.
A structured activity node represents a structured portion of the activity that is not shared with any other
structured node, except for nesting.

Sequential Node
The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 408) states:
A sequence node is a structured activity node that executes its actions in order.

© 1998-2010 Sparx Systems Pty Ltd

 798 Modeling Languages | Standard UML Models

Loop Node
The OMG UML specification (UML Superstructure Specification, v2.1.1, pp. 384-385) states:
A loop node is a structured activity node that represents a loop with setup, test, and body sections.
Each section is a well-nested subregion of the activity whose nodes follow any predecessors of the loop and
precede any successors of the loop. The test section may precede or follow the body section. The setup
section is executed once on entry to the loop, and the test and body sections are executed repeatedly until the
test produces a false value. The results of the final execution of the test or body are available after completion
of execution of the loop.

Conditional Node
The OMG UML specification (UML Superstructure Specification, v2.1.1, p.355) states:
A conditional node is a structured activity node that represents an exclusive choice among some number of
alternatives.
A conditional node consists of one or more clauses. Each clause consists of a test section and a body section.
When the conditional node begins execution, the test sections of the clauses are executed. If one or more test
sections yield a true value, one of the corresponding body sections will be executed. If more than one test
section yields a true value, only one body section will be executed. The choice is nondeterministic unless the
test sequence of clauses is specified. If no test section yields a true value, then no body section is executed;
this may be a semantic error if output values are expected from the conditional node.

5.1.2.1.38.1 Structured and Sequential Nodes

On a diagram, Structured and Sequential Activity Nodes have broken borders and composite diagram icons,
as shown below:

To display the Activity diagram represented by a Structured or Sequential Activity Node element, double-click
on the element.
Structured Activity Node elements can point to child diagrams that themselves contain or consist of Structured
Activity elements; that is, the Structured Activity elements are nested, as shown in the section of Project
Browser below.

5.1.2.1.38.2 Loop and Conditional Nodes

A Loop Structured Activity Node by default has Setup, Test and Body partitions. The Setup partition is
executed once on entry to the Loop, and the Test and Body partitions are executed repeatedly until the Test
produces a false value. The results of the final execution of the Test or Body are available after execution of
the Loop is complete.
A Conditional Structured Activity Node has a default Clause containing Test and Body partitions. Further
Clauses can be added if required.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 799

The two elements are depicted on an Activity diagram as shown below:

You define the Loop or Condition nodes by dragging other Activity diagram elements from the Toolbox page
into the appropriate partition of the element, and linking and organizing the structure as required. The
elements are aligned on the top left of the partition, so that resizing the node maintains the organization of the
structure within and between the partitions. If you try to shrink the node below the structure size, the node
automatically defaults to the 'best fit' size.

Conditional Node
When you create 796 a Conditional Node, the element Properties dialog displays. Much of this you can
complete 481 as for any other element. However, for the Conditional Node the dialog also has a Condition tab,
as shown below:

© 1998-2010 Sparx Systems Pty Ltd

 800 Modeling Languages | Standard UML Models

Add an Action Pin 749 as the Result for the node, clicking on the Add button to display the Select Pins dialog
(a version of the Select <Item> 515 dialog).
On creation, the Conditional Node automatically has one Clause containing a Decider and Body Output, and
a Test partition and a Body partition. You can add further Clauses as required. For each Clause you also add
an Action Pin for the Decider and for the Body Output. Click on the Save button to save the Clause definition.
The Select Pin dialog reveals only Output pins as appropriate to the context. If the required Action Pin does
not already exist, you can click on the Add New button on the dialog to automatically create an Output pin
under the appropriate parent node.
For the Result and Body Output entries, you can check on the exact location of each Action Pin by
right-clicking on the entry and selecting the Find in Project Browser context menu option.

The Nodes panel, by default, lists the Actions and Activities contained in the Test partition. Click on the Body
radio button to list the elements contained in the Body partition. An element must be completely contained in
the Body partition to be listed there - if it overlaps with the Test partition in any way, it is treated as being part
of the Test partition.

Add or Remove Clauses

To add another Clause, click on the Add button underneath the Clause(s) list. This inserts a new Clause in the
list, and identifies which is the preceding, or Predecessor, Clause and (if appropriate) which is the following, or
Successor, Clause. The remaining fields in the Clause(s) panel are cleared to enable you to add Decider and

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 801

Body Output Action Pins. New Test and Body partitions are immediately added to the element on the
diagram, and you can populate these partitions with Activity elements, which are then identified in the Nodes
panel.
To remove a Clause, highlight it in the list and click on the Delete button. This immediately removes the
Clause's corresponding partitions from the diagram, along with all their contained Activity elements. Removing
a Clause from between two other Clauses adjusts the numerical order; for example, if Clause 2 is removed
from between Clause 1 and Clause 3, Clause 3 is renamed as Clause 2, and any further Clauses are also
moved up one place.

Loop Node
When you create 796 a Loop Node, the element Properties dialog displays. Much of this you can complete 481
as for any other element. However, for the Loop Node the dialog also has a Loop tab, as shown below:

Add an Action Pin 749 for each of the Decider, Loop Variable Input, Loop Variable, Body Output and
Result fields for the node, in each case clicking on the Browse or Add button to display the Select Pins dialog
(a version of the Select <Item> 515 dialog). The Select ActionPin dialog reveals only Input pins (Loop Variable
Input) or Output pins as appropriate to the context. If the required Action Pin does not already exist, you can
click on the Add New button on the dialog to automatically create the Input pin or an Output pin under the
appropriate parent node.
You can also check on the exact location of an existing Action Pin by right-clicking on the pin name and

© 1998-2010 Sparx Systems Pty Ltd

 802 Modeling Languages | Standard UML Models

selecting the Find in Project Browser context menu option.

The Nodes panel, by default, lists the Actions and Activities contained in the Setup partition. Click on the
Body or Test radio buttons to list the elements contained in the corresponding partitions. An element must be
completely contained in a partition to be listed there - if it overlaps with the partition above in any way, it is
treated as being part of that partition.

5.1.2.1.39 Synch

A Synch state is useful for indicating that concurrent paths of a State Machine 678 are synchronized. After
bringing the paths to a synch state, the emerging transition indicates unison.

Toolbox Icon

5.1.2.1.40 System Boundary

A System Boundary element is a non-UML element used to define conceptual boundaries. You can use
System Boundaries to help group logically related elements (from a visual perspective, not as part of the UML
model).
In the UML Superstructure Specification, v2.1.1, System Boundaries are described in the sections on Use
Cases 806 , because the System Boundary is often used to indicate the application of a Use Case to another
entity. In this context, the System Boundary:
· encloses the Use Case, and
· is associated with a classifier 515 such as a Class 811 , Component 816 or Sub-system (Actor 757 ) through
the Select <Item> dialog.
By associating the System Boundary - and not the Use Case - with the classifier, the classifier is linked to the
Use Case as a user, but not as an owner.

You can also define a Use Case as the classifier of a System Boundary element, to link the elements
enclosed in the System Boundary (such as parts of an Activity diagram) to their representation in a logical
Use Case. See http://www.sparxsystems.com.au/resources/map_uc.html.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 803

The following properties of a System Boundary can be set: the name, the border style 803 , and the number of
horizontal or vertical swim lanes.

A System Boundary element can be marked as Selectable, using the element's context menu. When not
selectable, you can click within the System Boundary space without activating or selecting the Boundary itself.
This is useful when you have many elements within the Boundary and the Boundary makes their selection
difficult.

Note:
A System Boundary can have an associated image that it displays instead of its default format. Use the
Appearance | Alternate Image 448 menu option to select an image.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 594) states:
If a subject (or system boundary) is displayed, the Use Case ellipse is visually located inside the system
boundary rectangle. Note that this does not necessarily mean that the subject classifier owns the contained
Use Cases, but merely that the Use Case applies to that classifier.

5.1.2.1.40.1 Boundary Element Settings

Configure Boundary Elements

Boundary elements can be configured to display in different ways. The main differences are:
· Solid border
· Dotted border
· With horizontal or vertical 'swim lanes'; swim lanes are used to group elements in a vertical or horizontal
context (for example, Client, Application and Database tiers could be represented in swim lanes).

© 1998-2010 Sparx Systems Pty Ltd

 804 Modeling Languages | Standard UML Models

5.1.2.1.41 Terminate

The Terminate pseudo-state 682 indicates that upon entry of its pseudo-state, the State Machine's 678
execution ends.

Toolbox Icon

5.1.2.1.42 Trigger

A Trigger indicates an event that initiates an action (and might arise from completion of a previous action).
You initially define a Trigger in one of four ways:
· As a property of a Transition 892 relationship
· As a property of an Accept Event Action 743 (on the Triggers tab of the element Properties dialog)
· As an event in a State Machine Table 688
· Directly, as a Trigger element, through the New Element 524 dialog.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 805

When you save the Trigger, it is added to the list of elements for the parent package in the Project Browser.
You can then right-click on it and select the Properties context menu option to view and, if required, edit its
properties as an element rather than as a property itself. Triggers created as events remain as Event
elements, whilst Triggers created in other ways are Trigger elements, with a Trigger tab in the Properties
dialog.

Option Use to

Type If necessary, edit the type of trigger:

· Call - specifies that the event is a CallEvent, which sends a message to the
associated object by invoking an operation.
· Change - specifies that the event is a ChangeEvent, which indicates that the
transition is the result of a change in value of an attribute.
· Signal - specifies that the event is a SignalEvent, which corresponds to the
receipt of an asynchronous signal instance.
· Time - corresponds to a TimeEvent; which specifies a moment in time.
Specification Either type in the event instigating the Trigger, or click on the [ ... ] button and select
the event (depending on the Type value).

Ports Click on the Add button and select the appropriate Port from the Select Port 515
dialog.

Notes:
· To create new Ports using the Select Port dialog, the Trigger should be created
as a child of a Class or Component element.
· To add several Ports at once, press [Ctrl] as you select each Port.
· To check the exact location of a Port, right-click on the Port name and select the
Find in Project Browser context menu option.

You can also drag the Trigger element onto another diagram, although there are limited uses for the element
in that context.
This element is not the same as a Trigger Operation 1033 , which is an operation automatically executed as a
result of the modification of data in a database.

© 1998-2010 Sparx Systems Pty Ltd

 806 Modeling Languages | Standard UML Models

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 456) states:
Events may cause execution of behavior (e.g., the execution of the effect activity of a transition in a state
machine). A trigger specifies the event that may trigger a behavior execution as well as any constraints on the
event to filter out events not of interest.

5.1.2.1.43 Use Case

A Use Case is a UML modeling element that describes how a user of the proposed system interacts with the
system to perform a discrete unit of work. It describes and signifies a single interaction over time that has
meaning for the end user (person, machine or other system), and is required to leave the system in a
complete state: the interaction either completed or rolled back to the initial state. A Use Case:
· Typically has requirements and constraints that describe the essential features and rules under which it
operates
· Can have an associated Sequence diagram 706 illustrating behavior over time; who does what to whom,
and when
· Typically has scenarios associated with it that describe the work flow over time that produces the end
result; alternative work flows (for example, to capture exceptions) are also enabled.

Note:
Use a Use Case diagram and model to build up the functional requirements and implementation details of the
system.

The following is an example Use Case model:

If extending a Use Case, you can specify the points of extension with Use Case Extension Points 807 . To
display the attributes, operations or constraints of a Use Case on a diagram, use Rectangle Notation 808 .
Enterprise Architect also provides two stereotyped Use Cases - the Test Case 848 and the Business Use Case
739 .

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 807

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 592) states:
A UseCase is a kind of behaviored classifier that represents a declaration of an offered behavior. Each Use
Case specifies some behavior, possibly including variants, that the subject can perform in collaboration with
one or more actors.

5.1.2.1.43.1 Use Case Extension Points

Use extension points to specify the point of an extended Use Case 806 where an extending Use Case's
behavior should be inserted. The specification text can be informal or precise to define the location of the
extension point.

Note:
Conditions to apply the extending Use Case, and the extension point to use, should be attached as a note to
the extend relationship.

To work with extension points, follow the steps below:

1. Right-click on the Use Case element. The context menu displays.
2. Select the Advanced | Edit Extension Points... menu option. The Use Case Extension Points dialog
displays, listing defined points for that Use Case.

3. Select an extension point in the list and click on the appropriate button to edit or remove the extension
point, or to add a new one.

© 1998-2010 Sparx Systems Pty Ltd

 808 Modeling Languages | Standard UML Models

5.1.2.1.43.2 Rectangle Notation

You can display a Use Case 806 using rectangle notation. This displays the Use Case in a rectangle, with an
oval in the top right-hand corner. Any attributes, operations or constraints belonging to the Use Case are
shown, in the same style as a Class 811 .

To show a Use Case using rectangle notation, right-click on the Use Case object on the diagram and select
the Advanced | Use Rectangle Notation context menu option. This setting only applies to the selected Use
Case, and can be toggled on and off.

Note:
Actor 757 elements can also be displayed using rectangle notation.

5.1.2.1.44 Value Lifeline

A Lifeline is the path an object takes across a measure of time, indicated by the x-axis. There are two sorts:
Value Lifelines (defined here) and State Lifelines 794 , both used in Timing diagrams 690 .
A Value Lifeline shows the Lifeline's state across the diagram, with parallel lines indicating a steady state. A
cross between the lines indicates a transition or change in state.
An example of a Value Lifeline is shown below:

See UML Superstructure Specification, v2.1.1, Figure 14.30, p. 520.

A Value Lifeline consists of a set of transition points. Each transition point can be defined with the following
properties:

Property Description

At time Specifies the starting time for a change of state.

Transition to Indicates the state to which the Lifeline will change.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 809

Property Description

Event Describes the occurring event.

Timing constraints Refers to the time taken for a state to change within a Lifeline, or the time taken to
transmit a message.

Timing observations Provides information on the time of a state change or sent message.

Duration constraints Pertains to a Lifeline's period at a particular state. The constraint could be
instigated by a change of state within a Lifeline, or that Lifeline's receipt of a
message.

Duration observations Indicates the interval of a Lifeline at a particular state, begun from a change in
state or message receipt.

In the example diagram above, the 10ms transition point has these properties:

Property Text

At Time 10ms
Transition to Waitcard
Event Switch
Timing constraints –
Timing observations –
Duration constraints d..3*d
Duration observations –

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 518) states:
Shows the value of the connectable element as a function of time. Value is explicitly denoted as text. Crossing
reflects the event where the value changed.

5.1.2.2 Structural Diagram Elements

The following figure illustrates the main UML elements 741 that are used in Structural Diagrams 719 . For more
information on using each element, click on the element name in this list:
· Actor 757 , Artifact 810
· Class 811 , Collaboration 814 , Collaboration Occurrence 815 , Component 816

· Data Type 817 , Deployment Specification 818 , Document Artifact 819

· Enumeration 819 , Execution Environment 820 , Expose Interface 820
· Information Item 821 , Interface 821
· Node 822 , Note 785
· Object 823
· Package 825 , Part 825 , Port 826 , Primitive 829
· Qualifiers 830
· Signal 834

© 1998-2010 Sparx Systems Pty Ltd

 810 Modeling Languages | Standard UML Models

Note:
Actor, Collaboration, Note, Object and Package elements are used in both Behavioral diagrams and
Structural diagrams.

5.1.2.2.1 Artifact

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 811

An Artifact is any physical piece of information used or produced by a system, represented in a Deployment
Diagram 727 .
Artifacts can have associated properties or operations, and can be instantiated or associated with other
Artifacts. Examples of Artifacts include model files, source files, database tables, development deliverables or
support documents. The files represented by the Artifact are listed on the Files tab of the element Properties
dialog.
To open the files represented by the Artifact, click on the element on the diagram and press [Ctrl]+[E]. Each
file is opened either on a separate tab in the Diagram View workspace (if the file can be opened within
Enterprise Architect) or in the default Windows viewer/editor for the file type (if the file cannot be opened within
Enterprise Architect).
Files can also be launched individually from the Files tab (opening in the Windows default editor), as for
elements of any other type that have associated files 507 .

Toolbox Icon

Create Artifact For External File

You can also create an Artifact element on a diagram for an external file, by clicking on the file in a file list
(such as Windows Explorer) or on your Desktop and dragging it onto the diagram. A short context menu
displays with two options - Hyperlink and Artifact.

Click on the Artifact option to create the element on the diagram. The Properties dialog displays, and you can
define the name or other properties as required. Click on the OK button, and then open the Properties dialog
again and click on the Files tab. The file pathname is listed in the Files panel.

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 201) states:
An Artifact defined by the user represents a concrete element in the physical world. A particular instance (or
'copy') of an artifact is deployed to a node instance. Artifacts may have composition associations to other
artifacts that are nested within it. For instance, a deployment descriptor artifact for a component may be
contained within the artifact that implements that component. In that way, the component and its descriptor are
deployed to a node instance as one artifact instance.

5.1.2.2.2 Class

A Class is a representation of objects that reflects their structure and behavior within the system. It is a
template from which actual running instances are created, although a Class can be defined either to control its
own execution 812 or as a template or parameterized Class 813 that specifies parameters that must be defined
by any binding Class.
A Class can have attributes 558 (data) and methods (operations 569 or behavior). Classes can inherit
characteristics from parent Classes and delegate behavior to other Classes. Class models usually describe
the logical structure of the system and are the building blocks from which components are built.
The top section of a Class, as illustrated below, shows the attributes (or data elements) associated with the
Class. These hold the 'state' of an object at run-time. If the information is saved to a data store and can be
reloaded, it is termed 'persistent'. The lower section contains the Class operations (or methods at run-time).
Operations describe the behavior a Class offers to other Classes, and the internal behavior it has (private
methods).
Class elements are generally used in Class diagrams 721 and Composite Structure diagrams 724 .

© 1998-2010 Sparx Systems Pty Ltd

 812 Modeling Languages | Standard UML Models

Enterprise Architect also supports a number of stereotyped Class elements to represent various entities in
web-page modeling 851 . A Class can also be integrated with an Associate 855 connector to form an
Association Class 856 , to allow the Associate connector to have operations and attributes that define certain
types of UML relationship.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, pp. 52-53) states:
The purpose of a class is to specify a classification of objects and to specify the features that characterize the
structure and behavior of those objects.
Objects of a class must contain values for each attribute that is a member of that class, in accordance with the
characteristics of the attribute, for example its type and multiplicity.
When an object is instantiated in a class, for every attribute of the class that has a specified default, if an initial
value of the attribute is not specified explicitly for the instantiation, then the default value specification is
evaluated to set the initial value of the attribute for the object.
Operations of a class can be invoked on an object, given a particular set of substitutions for the parameters of
the operation. An operation invocation may cause changes to the values of the attributes of that object. It may
also return a value as a result, where a result type for the operation has been defined. Operation invocations
may also cause changes in value to the attributes of other objects that can be navigated to, directly or
indirectly, from the object on which the operation is invoked, to its output parameters, to objects navigable
from its parameters, or to other objects in the scope of the operation's execution. Operation invocations may
also cause the creation and deletion of objects.

5.1.2.2.2.1 Active Classes

An Active Class indicates that, when instantiated, the Class controls its own execution. Rather than being
invoked or activated by other objects, it can operate standalone and define its own thread of behavior.
To define an Active Class in Enterprise Architect, follow the steps below:
1. Highlight a Class, and display its Properties dialog.
2. Click on the Advanced button.
3. Select the Is Active checkbox.
4. Click on the OK button to save the details.

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 438) states:

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 813

An active object is an object that, as a direct consequence of its creation, commences to execute its classifier
behavior, and does not cease until either the complete behavior is executed or the object is terminated by
some external object. (This is sometimes referred to as "the object having its own thread of control.") The
points at which an active object responds to communications from other objects is determined solely by the
behavior of the active object and not by the invoking object. If the classifier behavior of an active object
completes, the object is terminated.

5.1.2.2.2.2 Parameterized Classes (Templates)

Enterprise Architect supports template or parameterized Classes, which specify parameters that must be
defined by any binding Class. A template Class enables its functionality to be reused by any bound Class. If a
default value is specified for a parameter, and a binding Class doesn't provide a value for that parameter, the
default is used. Parameterized Classes are commonly implemented in C++.
Enterprise Architect imports and generates templated Classes for C++. Template Classes are shown with the
parameters in a dashed outline box in the upper right corner of a Class.
To create a parameterized Class, follow the steps below:
1. Display the Properties dialog for a Class.
2. Select the Details tab.

3. In the Type field, click on the drop-down arrow and select Parameterized.

© 1998-2010 Sparx Systems Pty Ltd

 814 Modeling Languages | Standard UML Models

For an instantiated template, select Instantiated and add the arguments in the Arguments field.
4. Click on the Add button and define the required parameters in the Class Parameter dialog.

Notation Example

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 622) states:
A template is a parameterized element that can be used to generate other model elements using
TemplateBinding relationships. The template parameters for the template signature specify the formal
parameters that will be substituted by actual parameters (or the default) in a binding.

5.1.2.2.3 Collaboration

A Collaboration defines a set of cooperating roles and their connectors. These are used to collectively
illustrate a specific functionality, in a Composite Structure diagram 724 . A Collaboration should specify only the
roles and attributes required to accomplish a specific task or function. Although in practice a behavior and its
roles could involve many tangential attributes and properties, isolating the primary roles and their requisites
simplifies and clarifies the behavior, as well as providing for reuse. A Collaboration often implements a pattern
to apply to various situations.
The following example illustrates an Install Collaboration, with three roles (Objects 823 ) connected as shown.
The process for this Collaboration can be demonstrated by attaching an Interaction diagram (Sequence 706 ,
Timing 690 , Communication 715 or Interaction Overview 717 ).

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 815

To understand referencing a Collaboration in a specific situation, see the Collaboration Occurrence 815 topic.
Enterprise Architect supports a stereotyped Collaboration to represent a Business Use Case Realization 739 in
business modeling.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 171) states:
A collaboration describes a structure of collaborating elements (roles), each performing a specialized function,
which collectively accomplish some desired functionality. Its primary purpose is to explain how a system works
and, therefore, it typically only incorporates those aspects of reality that are deemed relevant to the
explanation.

5.1.2.2.4 Collaboration Occurrence

Use a Collaboration Occurrence to apply a pattern defined by a Collaboration to a specific situation, in a

Composite Structure diagram 724 .
The following example uses an occurrence, NWServer, of the Collaboration Install, to define the installation
process of a network scanner. This process can be defined by an interaction attached to the Collaboration.
(See the Collaboration 814 topic for a representation of the Install Collaboration.)

© 1998-2010 Sparx Systems Pty Ltd

 816 Modeling Languages | Standard UML Models

To create a Collaboration Occurrence, drag the required Collaboration from the Project Browser onto the
diagram and, on the Paste Element dialog, select the Paste as Link radio button.

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 173) refers to a Collaboration
Occurrence as a Collaboration Use, and states:
A collaboration use represents one particular use of a collaboration to explain the relationships between the
properties of a classifier. A collaboration use shows how the pattern described by a collaboration is applied in
a given context, by binding specific entities from that context to the roles of the collaboration. Depending on
the context, these entities could be structural features of a classifier, instance specifications, or even roles in
some containing collaboration. There may be multiple occurrences of a given collaboration within a classifier,
each involving a different set of roles and connectors. A given role or connector may be involved in multiple
occurrences of the same or different collaborations.

5.1.2.2.5 Component

A Component is a modular part of a system, whose behavior is defined by its provided and required interfaces;
the internal workings of the Component should be invisible and its usage environment-independent. Source
code files, DLLs, Java beans and other artifacts defining the system can be manifested in Components.
A Component can be composed of multiple Classes 811 , or Components pieced together. As smaller
Components come together to create bigger Components, the eventual system can be modeled, building-
block style, in Component diagrams 730 . By building the system in discrete Components, localization of data
and behavior enables decreased dependency between Classes and Objects 823 , providing a more robust and
maintainable design.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 817

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 148) states:
A component represents a modular part of a system that encapsulates its contents and whose manifestation is
replaceable within its environment.
A component defines its behavior in terms of provided and required interfaces. As such, a component serves
as a type whose conformance is defined by these provided and required interfaces (encompassing both their
static as well as dynamic semantics).

5.1.2.2.6 Data Type

A Data Type is a specific kind of classifier, similar to a Class 811 except that a Data Type cannot own sub Data
Types, and instances of a Data Type are identified only by their value. For example, an instance of a Person
Class is a Helen object, but an instance of an Integer Data Type is 12.
All copies of an instance of a Data Type, and any instances of that Data Type with the same value, are
considered to be the same instance. That is, instances of Helen are not necessarily the same Helen, but all 12
s are the same 12. For example, the 12 on a watch face is exactly the same integer as the number of months
in a year.
Instances of a Data Type that have attributes (that is, are instances of a structured Data Type) are considered
to be the same if the structure is the same and the values of the corresponding attributes are the same. If a
Data Type has attributes, instances of that Data Type contain attribute values matching the attributes.
A typical use of Data Types would be to represent programming language primitive types or CORBA basic
types. For example, integer and string types are often treated as Data Types.
A Data Type is denoted by a rectangle with the keyword «dataType», as above or, when it is referenced by (for
example) an attribute, by a string containing the name of the Data Type, as below:

Toolbox Icon

© 1998-2010 Sparx Systems Pty Ltd

 818 Modeling Languages | Standard UML Models

5.1.2.2.7 Deployment Spec

A Deployment Specification (spec) specifies parameters guiding deployment of an artifact, as is necessary

with most hardware and software technologies. A specification lists those properties that must be defined for
deployment to occur, as represented in a Deployment diagram 727 . An instance of this specification specifies
the values for the parameters; a single specification can be instantiated for multiple artifacts.
These specifications can be extended by certain component profiles. Examples of standard Tagged Values
that a profile might add to a Deployment Specification are «concurrencyMode» with Tagged Values {thread,
process, none} or «transactionMode» with Tagged Values {transaction, nestedTransaction, none}.
The following example depicts the artifact RepositoryApp deployed on the server node, as per the
specifications of RepositoryApp, instantiated from the Deployment Specification SystemSpec.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 206) states:
A deployment specification specifies a set of properties that determine execution parameters of a component
artifact that is deployed on a node. A deployment specification can be aimed at a specific type of container. An
artifact that reifies or implements deployment specification properties is a deployment descriptor.

5.1.2.2.8 Device

A Device is a physical electronic resource with processing capability upon which Artifacts 810 can be deployed

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 819

for execution, as represented in a Deployment diagram 727 . Complex Devices can consist of other devices;
that is, a Device can be a nested element, where a physical machine is decomposed into its elements either
through namespace ownership or through attributes that are typed by Devices.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, 10.3.7, v2.1.1, p. 207) states:
In the metamodel, a Device is a subclass of Node.

5.1.2.2.9 Document Artifact

A Document Artifact is an artifact 810 having a stereotype of «document». You create the Document Artifact on
a Component, Documentation or Deployment diagram, and associate it with an RTF document. Double-click
on the element to display the Linked Document Editor. See the Linked Documents 597 topic. When you have
created the linked document, the Document Artifact element on the diagram shows an A symbol in the bottom
right corner.

Toolbox Icon

5.1.2.2.10 Enumeration

An Enumeration is a data type, whose instances can be any of a number of user-defined enumeration literals.
It is possible to extend the set of applicable enumeration literals in other packages or profiles. You create
Enumerations in Class 721 or Package diagrams 720 , and in diagrams developed from the Metamodel 415 and
Profile 414 pages of the Toolbox.

Toolbox Icon

© 1998-2010 Sparx Systems Pty Ltd

 820 Modeling Languages | Standard UML Models

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 69) states:
An enumeration is a data type whose values are enumerated in the model as enumeration literals.

5.1.2.2.11 Execution Environment

An Execution Environment is a node 822 that offers an execution environment for specific types of components
816 that are deployed on it in the form of executable artifacts 810 . This is depicted in a Deployment diagram
727 .

Execution Environments can be nested; for example, a database Execution Environment can be nested in an
operating system Execution Environment. Components of the appropriate type are then deployed to specific
Execution Environment nodes.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 210 states:
... an ExecutionEnvironment is ... usually part of a general Node, representing the physical hardware
environment on which the ExecutionEnvironment resides. In that environment, the ExecutionEnvironment
implements a standard set of services that Components require at execution time (at the modeling level these
services are usually implicit). For each component Deployment, aspects of these services may be determined
by properties in a DeploymentSpecification for a particular kind of ExecutionEnvironment.

5.1.2.2.12 Expose Interface

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 821

The Expose Interface element is a graphical method of depicting the required or supplied interfaces 821 of a
Component 816 , Class 811 or Part 825 , in a Component 730 or Composite Structure 724 diagram. It just
identifies the fact that the element provides or requires an interface; to depict the fact that the provided
interface is used, or the required interface provided, by another element use the Assembly 855 connector.
The Expose Interface element must be attached to the Class or Component element, and it becomes a child
element of that Class or Component; it cannot exist independently. You can attach more than one Expose
Element to another element.
When you create the Expose Interface element, a dialog displays in which you enter a name for the element
and specify whether it represents a required interface or a provided interface.

Toolbox Icon

5.1.2.2.13 Information Item

An Information Item represents an abstraction of data. It is used in Activity 674 , Analysis 733 and Object 723
diagrams. An Information Item is also represented by an Information Flow 864 connector.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 608) states:
An information item is an abstraction of all kinds of information that can be exchanged between objects. It is a
kind of classifier intended for representing information at a very abstract way, one which cannot be
instantiated.
One purpose of information items is to be able to define preliminary models, before having made detailed
modeling decisions on types or structures. One other purpose of information items and information flows is to
abstract complex models by a less precise but more general representation of the information exchanged
between entities of a system.

5.1.2.2.14 Interface

An Interface is a specification of behavior (or contract) that implementers agree to meet. By implementing an
Interface, Classes 721 are guaranteed to support a required behavior, which enables the system to treat non-
related elements in the same way; that is, through the common interface. You also use Interfaces in a
Composite Structure 724 diagram.
Interfaces are drawn in a similar way to a Class, with operations specified, as shown below. They can also be
drawn as a circle with no explicit operations detailed. Right-click on the element and select the Use Circle
Notation context menu option to switch between styles. Realize 889 connectors to an Interface drawn as a

© 1998-2010 Sparx Systems Pty Ltd

 822 Modeling Languages | Standard UML Models

circle are drawn as a solid line without target arrows.

Note:
An Interface cannot be instantiated (that is, you cannot create an object from an Interface). You must create a
Class that 'implements' the Interface specification, and in the Class body place operations for each of the
Interface operations. You can then instantiate the Class.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 88) states:
An interface is a kind of classifier that represents a declaration of a set of coherent public features and
obligations. An interface specifies a contract; any instance of a classifier that realizes the interface must fulfill
that contract. The obligations that may be associated with an interface are in the form of various kinds of
constraints (such as pre- and post-conditions) or protocol specifications, which may impose ordering
restrictions on interactions through the interface.
Since interfaces are declarations, they are not instantiable. Instead, an interface specification is implemented
by an instance of an instantiable classifier, which means that the instantiable classifier presents a public
facade that conforms to the interface specification. Note that a given classifier may implement more than one
interface and that an interface may be implemented by a number of different classifiers.

5.1.2.2.15 Node

A Node is a physical piece of equipment on which the system is deployed, such as a workgroup server or
workstation. A Node usually hosts components and other executable pieces of code, which again can be
connected to particular processes or execution spaces. Typical Nodes are client workstations, application
servers, mainframes, routers and terminal servers.
Nodes are used in Deployment diagrams 727 to model the deployment of a system, and to illustrate the
physical allocation of implemented artifacts. They are also used in web modeling, from dedicated web
modeling pages in the Toolbox 399 .

Toolbox Icon

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 823

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 213) states:
In the metamodel, a Node is a subclass of Class. It is associated with a Deployment of an Artifact. It is also
associated with a set of Elements that are deployed on it. This is a derived association in that these
PackageableElements are involved in a Manifestation of an Artifact that is deployed on the Node. Nodes may
have an internal structure defined in terms of parts and connectors associated with them for advanced
modeling applications.

5.1.2.2.16 Object

An Object is a particular instance of a Class 811 at run time. For example a car with the license plate AAA-001
is an instance of the general class of cars with a license plate number attribute. Objects are often used in
analysis to represent the numerous artifacts and items that exist in any business, such as pieces of paper,
faxes and information. To model the varying behavior of Objects at run-time, use run-time states 823 .
Early in analysis, Objects can be used to quickly capture all the things that are of relevance within the system
domain, in an Object 723 , Composite Structure 724 or Communication 715 diagram. As the model progresses
these analysis Objects are refined into generic Classes from which instances can be derived to represent
common business items. Once Classes are defined, Objects can be typed; that is they can have a classifier
set that indicates their base type. See the Object Classifiers 519 topic.
Enterprise Architect also supports a number of stereotyped Object 739 elements to represent various entities in
business modeling.

Toolbox Icon

5.1.2.2.16.1 Run-time State

At run-time, an Object 823 instance can have specific values for its attributes, or exist in a particular state. To
model the varying behavior of Objects at run-time, use instance values selected from the Select <Item> 515
dialog and run-time states or run-states.
Typically there is interest in the run-time behavior of Objects that already have a classifier set. You can select
from the classifier's attribute list and apply specific values for your Object instance. If the classifier has a child
State Machine 678 , its States 789 propagate to a list where the run-time state for the Object can be defined. To
do this, see the following topics:
· Define a Run-Time Variable 824
· Remove a Defined Variable 824
· Object State 824

© 1998-2010 Sparx Systems Pty Ltd

 824 Modeling Languages | Standard UML Models

The following example defines run-time values for the listed variables, which are attributes of the instances'
classifier AccountItem.

To add run-time state 823 instance variables to an Object, follow the steps below:
1. Right-click on the Object. The context menu displays.
2. If Instance Variables are supported, select the Advanced | Set Run State menu option (or press [Ctrl]
+[Shift]+[R]). The Set Run State dialog displays.

3. In the Variable field, click on the drop-down arrow and select the variable, or type in the new variable
name.
4. Set the Operator, the Value and optionally type in a Note.
5. Click on the OK button to save the variable.

To delete a run-time state 823 variable for an Object, follow the steps below:
1. Right-click on the required Object. The context menu displays.
2. Select the Set Run State option. The Run State dialog displays.
3. In the Variable field, click on the drop-down arrow and select the variable to delete.
4. Clear the Value field.
5. Click on the OK button.

5.1.2.2.16.2 Object State

To set the Object state for a Class instance, follow the steps below:
1. Right-click on the required Object and select the Advanced | Set Object State context menu option.
The Set Instance State dialog displays.

2. In the State field, either type the required State (such as Awaiting Approval) or select a State from the
drop-down list.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 825

Note:
The drop-down list for the State field is populated with:
1. Any States owned by the object's classifier.
2. Any States owned by any superclasses of the object's classifier.
3. Any States owned by State Machines owned by the object's classifier.
4. Any States owned by State Machines owned by any superclasses of the object's classifier.

3. Click on the OK button to apply the State. The object now shows the run-time state in square brackets
below the object name.

5.1.2.2.17 Package

A Package is a namespace as well as an element that can be contained in other Package's namespaces. A
Package can own or merge with other Packages, and its elements can be imported into a Package's
namespace. In addition to using Packages in the Project Browser to organize your project contents, you can
drag these Packages onto a diagram workspace (most diagram types, both standard and extended) for
structural or relational depictions, including Package imports or merges.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 109) states:
A package is a namespace for its members, and may contain other packages. Only packageable elements
can be owned members of a package. By virtue of being a namespace, a package can import either individual
members of other packages, or all the members of other packages. In addition a package can be merged with
other packages.

5.1.2.2.18 Part

Parts are run-time instances of Classes 811 or Interfaces 821 . Multiplicity can be specified for a Part, using the
notation:
[x{...y}]
where x specifies the initial or set amount of instances when the composite structure is created, and y
indicates the maximum amount of instances at any time.

© 1998-2010 Sparx Systems Pty Ltd

 826 Modeling Languages | Standard UML Models

Parts are used to express composite structures 724 , or modeling patterns that can be invoked by various
objects to accomplish a specific purpose. When illustrating the composition of structures, Parts can be
embedded as properties of other Parts. When embedded as properties 726 , Parts can be bordered by a solid
outline, indicating the surrounding Part owns the Part by composition. Alternatively, a dashed outline indicates
that the property is referenced and used by the surrounding Part, but is not composed within it.
You can also set properties 829 and property values 826 for Parts.

Toolbox Icon

5.1.2.2.18.1 Add Property Value

To add property value variables to a Part, follow the steps below:
1. Right-click on the Part. The context menu displays.
2. Select the Advanced | Set Property Values menu option (or press [Ctrl]+[Shift]+[R]). The Set
Property Values dialog displays.

3. In the Variable field, click on the drop-down arrow and select the variable, or type in the new variable
name.
4. Set the Operator, the Value and optionally type in a Note.
5. Click on the OK button to save the variable.
A Part with a property value resembles the following figure.

5.1.2.2.19 Port

Ports define the interaction between a classifier and its environment. Interfaces controlling this interaction can
be depicted using the Interface element 821 . Any connector to a Port must provide the required interface, if

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 827

defined. Ports can appear on a contained Part 825 , a Class 811 , or the boundary of a Composite element 837 .

A Port is a typed structural feature or property of its containing classifier. Ports are typically created 827 in
Class diagrams 721 , Object diagrams 723 and Composite Structure diagrams 724 .
You can expose an inherited Port, or redefine a Port 827 . You also define specific properties 829 for a Port
element.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 182) states:
A port is a property of a classifier that specifies a distinct interaction point between that classifier and its
environment or between the (behavior of the) classifier and its internal parts. Ports are connected to properties
of the classifier by connectors through which requests can be made to invoke the behavioral features of a
classifier. A Port may specify the services a classifier provides (offers) to its environment as well as the
services that a classifier expects (requires) of its environment.

5.1.2.2.19.1 Add a Port to an Element

To add a new Port 826 to an element, use one of the following steps:
1. Click on the Port symbol in the Composite Elements page of the Toolbox and drag it to (or click on) the
target host element. This creates an untyped, simple Port on the boundary, near the cursor position.
2. On the context menu of a suitable Class, Part or Composite element 837 , select the Embedded
Elements | Add Port menu option to add a new Port at the cursor position.
3. Drag a suitable classifier from the Project Browser onto a Class or Part. Enterprise Architect prompts
you to add a typed Port or Part at the cursor position. The new Port is typed by the original dragged
classifier.
4. Use the Embedded Elements 827 window to add a new Port to the currently selected element.

5.1.2.2.19.2 Inherited and Redefined Ports

A Port 826 is a redefinable and re-useable property of a composite classifier. So, as for attributes, any Class
can inherit Ports from its parent and realized interfaces. If you have an inheritance hierarchy with Ports defined
in the parent Classes, when you open the Embedded Elements window the inherited Ports and their named
owners are listed there.
It is possible to expose, for design purposes, an inherited Port (that is, the child Class is re-using the parent
Port). In this case, Enterprise Architect creates a clone of the re-used Port and marks it as read-only in the
child Class. This is convenient for modeling Port interactions in child Classes where the Ports are defined in
the parent elements.
It is also possible to redefine a Port in a child Class, so that the name is the same but the child is a modifiable
clone of the original. This is useful where a child Class places additional restrictions or behavior on the Port.
The Embedded Elements window enables you to highlight an inherited Port and mark it as redefined; this
creates a new Port on the child Class, which is editable but still logically related to the initial Port.
The Embedded Elements window below illustrates Port inheritance. The Port removableHD is owned by the
child Class. The Ports eth0 and USB are owned by the Computer Class. The Port firewire has been added to
PC. If any of the inherited Ports are made visible, they are considered re-use Ports and appear on the child in
read-only format. Using the Redefine button, the inherited Port can be copied down and made writeable.

© 1998-2010 Sparx Systems Pty Ltd

 828 Modeling Languages | Standard UML Models

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 829

5.1.2.2.19.3 The Property Tab

The element Properties 481 dialog for Ports and Parts has a Property tab in place of the Class element Details
tab.

This tab defines the type, initial value, Qualifiers 830 , multiplicity, and redefined and subsetted properties of the
Port or Part.
You set the Qualifiers by clicking on the Qualifiers button, to display the Qualifiers 832 dialog.

You add Redefined and Subsetted Properties by clicking on the appropriate Add button, to display the
Select Property 517 dialog.

5.1.2.2.20 Primitive

© 1998-2010 Sparx Systems Pty Ltd

 830 Modeling Languages | Standard UML Models

A Primitive element identifies a predefined data type, without any relevant substructure (that is, it has no parts
in the context of UML). It could be regarded as a conceptual Data Type 817 .

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 124) states:
A primitive data type may have an algebra and operations defined outside of UML, for example,
mathematically ... The run-time instances of a primitive type are data values. The values are in many-to-one
correspondence to mathematical elements defined outside of UML (for example, the various integers).
Instances of primitive types do not have identity. If two instances have the same representation, then they are
indistinguishable.

5.1.2.2.21 Qualifiers
Qualifiers are ordered sets of properties of an Association end point 629 , a Part 825 , a Port 826 , or an Attribute
558 , that limit the nature of the relationship between two classifiers or objects. You define a qualifier on the
Qualifiers 832 dialog, which you display by clicking on the [ ... ] button at the end of the Qualifiers field on the
Association, Part, Port or Attribute Properties dialog.
Some examples of qualified Associations are shown in the following diagram:

Notes:
· When typing multiple Qualifiers into the Qualifier(s) field on a Properties dialog, separate them with a
semi-colon; each Qualifier then displays on a separate line. For example, in the diagram the Qualifier 'rank:
Rank;file:File' has been rendered in two lines, with a line break at the ; character.
· You can enable or disable Qualifier rectangles in the Diagram page of the Options dialog (select the Tools
| Options | Diagram menu option). If disabled, the old style text Qualifiers are used. It is not recommended
that you disable Qualifiers as they are an integral part of the UML.
· You can enable or disable a mild shading on the Qualifier rectangles in the Links page of the Options
dialog.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 831

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 129) states:
A qualifier declares a partition of the set of associated instances with respect to an instance at the qualified
end (the qualified instance is at the end to which the qualifier is attached). A qualifier instance comprises one
value for each qualifier attribute. Given a qualified object and a qualifier instance, the number of objects at the
other end of the association is constrained by the declared multiplicity. In the common case in which the
multiplicity is 0..1, the qualifier value is unique with respect to the qualified object, and designates at most one
associated object. In the general case of multiplicity 0..*, the set of associated instances is partitioned into
subsets, each selected by a given qualifier instance. In the case of multiplicity 1 or 0..1, the qualifier has both
semantic and implementation consequences. In the case of multiplicity 0..*, it has no real semantic
consequences but suggests an implementation that facilitates easy access of sets of associated instances
linked by a given qualifier value.

© 1998-2010 Sparx Systems Pty Ltd

 832 Modeling Languages | Standard UML Models

5.1.2.2.21.1 Qualifiers Dialog

The Qualifiers dialog is used to define the Qualifiers 830 of an Association connector end 629 , Port 826 , Part 825
or Attribute 558 .

General Tab
Review, edit or complete the fields as indicated in the following table.

Field Use to

Name Display the name of the Qualifier. For a new Qualifier, type the name (with no spaces).

Alias Display an optional alias for the Qualifier. If necessary, type in a new alias.

Type Display the Qualifier type.

The type can be defined by the code language (data type) or by a classifier element.
When you click on the drop-down arrow, the set of values in the list provides the
appropriate data types.
To select or define possible classifiers, either click on the Select Type option in the list,
or click on the [ ... ] (Select) button to display the Select <Item> 515 dialog.
To add new code language data types that can be displayed in this list, see the Data
Types 666 topic.

Scope Define the Qualifier as Public, Protected, Private or Package. If necessary, click on the

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 833

Field Use to

drop-down arrow and select a different scope.

Stereotype Define the optional stereotype of the Qualifier. If necessary, either type a different
stereotype name or click on the drop-down arrow and select a stereotype.

Derived Indicate that the Qualifier is a calculated value. If you select this checkbox, the Qualifier
name on the element has the derived symbol (/) as a prefix.

Static Indicate that the Qualifier is a static member.

Const Indicate that the Qualifier is a constant.

Initial Display an optional initial value. If necessary, type in a new initial value.

Notes Enter any free text notes associated with the Qualifier. You can format the notes text
using the Notes 642 toolbar at the top of the field.

To change the position of a Qualifier in the list in the Qualifiers panel, click on the Scroll Up or Scroll Down
(hand) buttons.

Detail Tab
Use the Detail tab to model additional properties of a selected Qualifier, such as its multiplicity, redefined
properties and subsetted properties.

Select a Qualifier on the General tab, then review, edit or complete the Detail tab fields as indicated in the

© 1998-2010 Sparx Systems Pty Ltd

 834 Modeling Languages | Standard UML Models

following table.

Field Use to

Multiplicity

Lower bound Define a lower limit to the number of elements allowed in the
collection.

Upper bound Define an upper limit to the number of elements allowed in the
collection.

Allow Duplicates Indicate that duplicates are allowed.

Maps to the UML property isUnique, value FALSE).

Multiplicity is Ordered Indicate that the collection is ordered.

Redefined Property Review the redefined properties for the Qualifier.

Add redefined properties by clicking on the Add button to
display the Select Property 517 dialog.

Subsetted Property Review the subsetted properties for the qualifier.

Add subsetted properties by clicking on the Add button to
display the Select Property 517 dialog.

5.1.2.2.22 Signal

A Signal is a specification of Send 789 request instances communicated between objects, typically in a Class
721 or Package 720 diagram. The receiving object handles the Received 787 request instances as specified by
its receptions. The data carried by a Send request is represented as attributes of the Signal. A Signal is
defined independently of the classifiers handling the signal occurrence.
To define a reception, create an operation in the receiving object and assign the stereotype <<signal>> to it.
The reception has the same name as the signal that the object can receive.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 450) states:
A signal triggers a reaction in the receiver in an asynchronous way and without a reply. The sender of a signal
will not block waiting for a reply but continue execution immediately. By declaring a reception associated to a
given signal, a classifier specifies that its instances will be able to receive that signal, or a subtype thereof,
and will respond to it with the designated behavior.
And (UML Superstructure Specification, v2.1.1, p. 447 - 448):
A reception is a declaration stating that a classifier is prepared to react to the receipt of a signal. A reception
designates a signal and specifies the expected behavioral response. The details of handling a signal are
specified by the behavior associated with the reception or the classifier itself. ...Receptions are shown using
the same notation as for operations with the keyword <signal>

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 835

5.1.2.3 Inbuilt and Extension Stereotypes

There are many other UML elements that you can also work with in Enterprise Architect, most of which are
basic elements extended by the use of stereotypes. This topic gives a brief introduction to some of these
elements.
· Analysis Stereotypes 835
· Boundary Element 836
· Composite Elements 837
· Control Element 838
· Entity Element 839
· Event Elements 839
· Hyperlinks 840
· N-Ary Association 844
· Process 846
· Requirements 846
· Screen 847
· Table 849
· UI Control Element 849
· Web Stereotypes 851
For more information on the use of stereotypes in Enterprise Architecture, see the UML Stereotypes 895 topic.

5.1.2.3.1 Analysis Stereotypes

Enterprise Architect has some built in stereotypes that you can assign to an element during analysis. The
effect of these stereotypes is to display a different icon from the normal element icon, providing a visual key to
the element purpose. The Robustness diagram below illustrates the main types of inbuilt icons for elements:

The stereotypes used are:

· Boundary 836 - for a system boundary (for example, a Login screen)
· Control 838 - to specify an element is a controller of some process (as in the Model-View-Controller pattern)
· Entity 839 - the element is a persistent or data element
Also see the Business Modeling 739 elements, used in Business Modeling and Business Interaction diagrams.

© 1998-2010 Sparx Systems Pty Ltd

 836 Modeling Languages | Standard UML Models

5.1.2.3.2 Boundary

or

A Boundary is a stereotyped Object 823 that models some system boundary, typically a user interface screen.
You can also create a Boundary as a stereotyped Class 811 . See the Create a Boundary 836 topic.
A Boundary is used in the conceptual phase to capture users interacting with the system at a screen level (or
some other boundary interface type). It is often used in Sequence 706 and Robustness (Analysis 733 )
diagrams. It is the View in the Model-View-Controller 836 pattern.

Tip:
Use Boundary elements in analysis to capture user interactions, screen flows and element interactions (or
'collaborations').

Toolbox Icon

or

5.1.2.3.2.1 Create a Boundary

Create As An Object
To create a Boundary 836 element on a diagram as an Object, follow the steps below:
1. In the Toolbox, select the More Tools | Analysis menu option.
2. From the Analysis Elements page, drag the Boundary element onto the diagram.

Create As A Class
To create a Boundary element as a stereotyped Class, using the Class Properties dialog, follow the steps
below:
1. Insert a new Class.
2. Right-click on the element and select the Properties context menu option; the Properties dialog
displays.
3. In the Stereotype field, type the value boundary.
4. Click on the Apply and OK buttons.
5. Save the diagram ([Ctrl]+[S]).
The following illustration shows an Actor 757 interacting with a Boundary (in this case, a Login screen).

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 837

Note:
The Model-View-Controller (MVC) pattern is a design pattern for building a wide range of applications that
have a user interface, business or application logic and persistent data.

5.1.2.3.3 Composite Elements

Enterprise Architect supports Composite elements for Classes, Objects, Use Cases and such. A Composite
element is a pointer to a child diagram.

Create a Composite Element

To set Composite elements from the element context menu, follow the steps below:
1. Create the element to set as a Composite element.
2. Right-click on the element in the diagram and select the Advanced | Make Composite context menu
option.

Note:
If the Make Composite option is not listed in the context menu, the option is not available for the type
of element you have selected.

The element displays as follows:

Note the small icon in the bottom right hand corner indicating that this is now a Composite element.
3. Double-click on the Composite element to access the child diagram that it points to.
The Composite element and its child diagram are represented in the Project Browser as follows:

Note that ClassX, ClassY and ClassZ are elements in the child diagram.

Alternative Notation
Composite elements can show their contents instead of their usual notation. To enable this, right-click on the
element to open the context menu, then select the Advanced | Show Composite Diagram option.

The Automation Interface

Automation support 1666 is available for Composite elements. Element has an Elements collection and a
Diagrams collection.

© 1998-2010 Sparx Systems Pty Ltd

 838 Modeling Languages | Standard UML Models

5.1.2.3.4 Control

or

A Control is a stereotyped Object 823 that models a controlling entity or manager. A Control organizes and
schedules other activities and elements, typically in Analysis 733 (including Robustness), Sequence 706 and
Communication 715 diagrams. It is the controller of the Model-View-Controller 838 pattern.
You can also create a Control as a stereotyped Class 811 . See the Create a Control Element 838 topic.

Toolbox Icon

or

5.1.2.3.4.1 Create a Control Element

Create As An Object
To create a Control 838 element on a diagram as an Object, follow the steps below:
1. In the Toolbox, select the More Tools | Analysis menu option.
2. From the Analysis Elements page, drag the Control element onto the diagram.

Create As A Class
To create a Control element as a stereotyped Class, using the Class Properties dialog, follow the steps below:
1. Insert a new Class.
2. Right-click on the element and select the Properties context menu option; the Properties dialog
displays.
3. In the Stereotype field, type the value control.
4. Click on the Apply and OK buttons.
5. Save the diagram ([Ctrl]+[S]).
The appearance changes as illustrated in the following diagram (for the Security Controller element):

Note:
The Model-View-Controller (MVC) pattern is a design pattern for building a wide range of applications that
have a user interface, business or application logic and persistent data.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 839

5.1.2.3.5 Entity

From: Sequence Diagram 706 Communication 715 , Object 723 , Analysis 733
(including Robustness) Diagrams

An Entity is a stereotyped Object 823 that models a store or persistence mechanism that captures the
information or knowledge in a system. It is the Model in the Model-View-Controller 838 pattern.
You can also create an Entity as a stereotyped Class 811 . See the Create an Entity 839 topic.

Toolbox Icon

or

5.1.2.3.5.1 Create an Entity

Create As An Object
To create an Entity 839 element on a diagram as an Object, follow the steps below:
1. In the Toolbox, select the More Tools | Analysis menu option.
2. From the Analysis Elements page, drag the Entity element onto the diagram.

Create As A Class
To create an Entity element as a stereotyped Class, using the Class Properties dialog, follow the steps below:
1. Insert a new Class.
2. Right-click on the element and select the Properties context menu option; the Properties dialog
displays.
3. In the Stereotype field, type the value entity.
4. Click on the Apply and OK buttons.
5. Save the diagram ([Ctrl]+[S]).

5.1.2.3.6 Event
UML includes two elements that are used to model Events. The first element is the Send Event. This element
models the generation of a stimulus in the system and the passing of that stimulus to other elements, either
within the system or external to the system.

The second element is the Receive Event, which is depicted as a rectangle with a recessed 'V' on the left side.
This element indicates that an event occurs in the system due to some external or internal stimulus. Typically
this invokes further activities and processing.

© 1998-2010 Sparx Systems Pty Ltd

 840 Modeling Languages | Standard UML Models

Send and Receive Events can be added from the Analysis 416 and Activity 412 Element pages of the Toolbox.
If you should select the wrong type of event, or otherwise want to change the type, right-click on the Event and
select the Advanced | Make Sender or Advanced | Make Receiver context menu option, as appropriate.

Toolbox Icons

5.1.2.3.7 Feature

A Feature is a small, granular function or characteristic expressed in client-valued terms as a satisfaction of a

requirement; for example: 'context-sensitive Help', or 'ability to reverse-engineer VB.Net'.
Features are the primary requirements-gathering artifact of the Feature-Driven Design (FDD) methodology.
They define the product feature that satisfies what a Requirement 846 element has formalized as a contractual,
testable, expected deliverable (for example: requirement - 'every element must provide context-sensitive Help';
feature - 'every element provides context-sensitive Help'). One Feature might realize one or more
Requirements, and one Requirement might be realized by more than one Feature.
Features also have relationships with Use Cases 806 . A Use Case defines the interaction a user has with the
system in order to satisfy one or more Requirements. The Feature identifies the facility that provides the
means for that interaction.
Feature elements are non-UML and are not related to UML-defined features, which are either
BehavioralFeatures (operations 569 , or methods) or StructuralFeatures (Ports 826 , Parts 825 and attributes 558
).
Feature elements are available from the Requirements page of the Toolbox.

Note:
Feature elements can be created with or without an identifying F in the top right corner of the element. To
toggle the display of this letter, select or deselect the Show stereotype icon for requirements checkbox on
the Options dialog, Objects 362 page.

Toolbox Icon

5.1.2.3.8 Hyperlinks

You can place a Hyperlink element onto a diagram. This element is a type of text element, but one that can
contain a pointer to a range of objects such as associated document files, web pages, Help, model features
and even other Enterprise Architect model files. When you double-click on the element, Enterprise Architect
executes the link. To add a Hyperlink element, drag the Hyperlink icon from the Common page of the Toolbox
onto the diagram.
(Alternatively, click on the Hyperlink icon in the UML Elements toolbar and then click on the diagram.)

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 841

Configure the Hyperlink

When you add the Hyperlink to the diagram, the Hyperlink Details dialog displays. If you want to display the
information in a more readable layout, you can resize the dialog.

You first select the type of object to link to, by clicking on the drop-down arrow in the Hyperlink Type field.
The Hyperlink Details dialog displays the appropriate fields, prompts or dialog to enable you to specify the
object to link to. For example, if you intend to hyperlink to:
· an attribute, the Set Attribute dialog 748 displays to enable you to select that attribute
· a file, the Action field displays to enable you to specify whether to Open the file in read only mode, or Edit
the file; in either case the file is opened within Enterprise Architect if possible, or, if not possible, with the
Windows default viewer/editor for the file type. For example, if you hyperlink to a .rtf file, you can view it in
whichever viewer is appropriate; however, you cannot edit .rtf files in Enterprise Architect, so the file always
opens in the Windows default .rtf editor.
· a diagram, the Select a Diagram dialog displays, which enables you to select the diagram from anywhere in
the project; you can filter the selection to diagrams of certain types.
If you select EA Command, the Hyperlink Address field changes to a drop-down list of Enterprise Architect
commands. You can select LocalPath and click on the [ ... ] (Browse) button to display the Local Paths 1343
dialog, which you complete as required. Subsequently, when you click on the hyperlink the Local Paths dialog
immediately displays and you can apply, switch, expand or update the current path.
Once you have defined the object and its location, you can change the location either by overtyping the
Hyperlink Address field or by clicking on the [ ... ] (Browse) button.

In the Alias field, type the text to display in the hyperlink. If you do not provide an alias, either the text defaults
to the link itself, or (for certain link targets such as a matrix profile) the dialog generates a simple text
instruction.
If you prefer to display only the hyperlink text, without the icon, select the Hide Icon checkbox.

© 1998-2010 Sparx Systems Pty Ltd

 842 Modeling Languages | Standard UML Models

Notes:
· If required, you can create a number of empty hyperlinks to complete later. If you then double-click on an
empty hyperlink, the Hyperlink Details dialog displays and you can enter the details.
· Once you have created the hyperlink, you can also edit the hyperlink text by clicking once on the field and
once on the text, then right-clicking and selecting the Edit Selected context menu option.

Note that you can add notes to the hyperlink, which display in the Hyperlink Details dialog when you right-click
on the hyperlink and select the Properties context menu option. You can format these notes using the Notes
642 toolbar.

You can also create:

· A hyperlink to a file 842
· A hyperlink to a script 842
· An Action as a hyperlink 842
· A hyperlink between diagrams. 842

5.1.2.3.8.1 Hyperlinks To Files

To create a hyperlink on a diagram to an external file, simply click on the file in a file list (such as Windows
Explorer) or on your Desktop and drag it onto the diagram.
A short context menu displays with two options - Hyperlink and Artifact. Click on the Hyperlink option to
create the hyperlink on the diagram.
The link is effective immediately, and you can right-click on it to add or change properties as described above.

5.1.2.3.8.2 Script Hyperlinks

You can create a hyperlink on a diagram to execute a script. Simply open the Debug 1467 window and drag the
required script onto the diagram. A context menu displays, from which you select whether the script to be
executed is a Build, Test, Run, Debug or Deploy script. The hyperlink is effective immediately; when you click
on it, the script executes.

5.1.2.3.8.3 Add Action As Hyperlink

You can create an Action 745 element to represent a wide range of behaviors and actions, including a
hyperlink. To do this, follow the steps below:
1. Drag an Action element from the Activity page of the Toolbox onto the diagram. A context menu
immediately displays.
2. Select the Other menu option. The New Action dialog displays, with the Other radio button selected.
3. Click on the drop down arrow on the field in the Select kind panel, and click on Hyperlink.
4. Click on the OK button. The Hyperlink Action element displays on the diagram.
5. Right click on the element and select the Advanced | Set Hyperlink menu option. The Hyperlink
Details dialog displays.
6. Set the hyperlink's properties as described above.

5.1.2.3.8.4 Hyperlinks Between Diagrams

To create a hyperlink between diagrams, follow the steps below.

Note:
If the hyperlink appears as a Sub Activity, select the Tools | Options | Diagram | Behavior menu option and
deselect the Use Automatic SubActivities checkbox.

1. Open the diagram in which to display the hyperlink to another diagram. From the Project Browser select
the diagram you want to create a hyperlink to.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 843

2. Drag the diagram on to the current diagram. The Select Type dialog displays.

3. Select the Hyperlink option and click on the OK button. The final hyperlinked diagram should resemble
the diagram below, where the Class diagram is the diagram to which the Product Order diagram
hyperlinks (notice that the hyperlink icon is different).

© 1998-2010 Sparx Systems Pty Ltd

 844 Modeling Languages | Standard UML Models

5.1.2.3.9 N-Ary Association

An n-Ary Association element is used to model complex relationships between three or more elements,
typically in a Class diagram 721 . It is not a commonly-employed device, but can be used to good effect where
there is a dependant relationship between several elements. It is generally used with the Associate 855
connector, but the relationships can include other types of connector.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 845

In the example above there is a relationship between a Company, an Employee and a Salary.

Toolbox Icon

5.1.2.3.10 Packaging Component

(compare with and )

A Packaging Component is an element that appears very similar to a Component 816 in a diagram but
behaves as a Package 825 in the Project Browser (that is, it can be version controlled and can contain other
Packages and elements). It is typically used in Component diagrams 730 .
In the Project Browser, the three elements display as shown below:

The Component element cannot contain child Packages or Packaging Components.

© 1998-2010 Sparx Systems Pty Ltd

 846 Modeling Languages | Standard UML Models

Toolbox Icon

5.1.2.3.11 Process

A Process is an Activity 753 element with the stereotype process, which expresses the concept of a business
process. Typically this involves inputs, outputs, work flows, goals and connections with other Processes. The
Process element is typically used in Analysis diagrams 733 .
Business processes typically range across many parts of the organization and span one or more systems.

Toolbox Icon

5.1.2.3.12 Requirements
As an analysis step, often it is desirable to capture simple system requirements. These are eventually realized
by Use Cases 806 .
In the initial requirement gathering phase, cataloging requirements can be achieved using the Requirement
extension on a Custom diagram 734 .

Requirements can also be aggregated to create a hierarchy. The diagram below illustrates how this might be
done.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 847

A requirement that a user can log into a website is implemented by the Login Use Case, which in turn is
implemented by the Business Logic, ASP Pages and Login Web Page. Using this approach, you can easily
model quite detailed and complex dependencies and implementation relationships.

Notes:
· External requirements can be created with or without an identifying E in the top right corner of the element.
To toggle the display of this letter, select or deselect the Show stereotype icon for requirements
checkbox on the Options dialog, Objects 362 page.
· The colors on Requirement elements identify the status of the requirement. You change the status - and
hence color - on the element Properties 919 dialog. You set the color for each status on the Status Types
653 dialog.

Toolbox Icon

5.1.2.3.13 Screen
A Screen is used to prototype User Interface screen flow. By using UML features such as requirements,
constraints and scenarios against User Interface 738 diagram elements, you can build up a solid and detailed
understanding of user interface behavior without having to use code. This becomes an excellent means of
establishing the precise behavior the system has from a user perspective, and in conjunction with the Use
Case 375 model, defines exactly how a user gets work done.
Web pages can also be prototyped and specified rigorously using Enterprise Architect's custom interface
extensions.
The example diagram below illustrates some features of Enterprise Architect's screen modeling extensions
that support web page prototyping. By adding requirements, rules, scenarios and notes to each element, a
detailed model is built up of the form or web page, without having to resort to GUI builders or HTML.

© 1998-2010 Sparx Systems Pty Ltd

 848 Modeling Languages | Standard UML Models

Note:
Enterprise Architect displays UI Controls 849 as a range of special icons, depending on the stereotype used;
for example, a Control stereotyped as a «list» displays with a vertical scroll bar.

Toolbox Icon

5.1.2.3.14 Test Case

A Test Case is a stereotyped Use Case 806 element. You might use it to extend the facilities of the Testing 1537
window, by applying element properties and capabilities to the tests of a feature represented by another
element or - more appropriately - set of elements. That is, you can define in one go - in the Testing window for
the Test Case element - the details of the tests that apply to each of several elements, instead of recording the
details separately in each element.
Within the Test Case element properties you can define test requirements and constraints, and associate the
test with test files. You can also link the element to Document Artifacts or (in the Corporate, Business and
Software Engineering, System Engineering and Ultimate editions) directly to linked documents, such as a Test
Plan.
The Test Case element enables you to give greater visibility to tests, in the Project Browser, Element List,
Model Search, Relationship Matrix, Traceability window and reports.
The Test Case element is available through the Use Case and Maintenance pages of the Toolbox.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 849

5.1.2.3.15 Table

A Table is a stereotyped Class 811 . It is drawn with a small table icon in the upper right corner. You typically
use this element in Data Modeling 739 and Class 721 diagrams.
A Table element has a special Properties dialog, with settings for database type and the ability to set column
information and data-related operations such as triggers and indexes. When setting up a Table, make sure
you set the default database type 1014 for that Table, otherwise you do not have any data types to choose from
when creating columns.

Toolbox Icon

5.1.2.3.16 UI Control Element

A UI Control element represents a user interface control element (such as an edit box). It is used for capturing
the components of a screen 847 layout and requirements in a Custom 734 or User Interface 738 diagram.
There are a number of UI Control elements available in the User Interface 419 page of the Toolbox. These
include:
· List
· Table
· Text Box
· Label
· Form
· Panel
· Button
· Combobox
· Checkbox
· Checkbox (left hand side)
· Radio button
· Radio button (left hand side)
· Vertical Line
· Horizontal Line.
The icons can be combined on a Screen icon to represent the appearance of a user interface screen, as
shown:

© 1998-2010 Sparx Systems Pty Ltd

 850 Modeling Languages | Standard UML Models

You can also extend the available icons by selecting other stereotypes in the UI Control Element Properties
dialog. The full set of available stereotypes is shown below; type or select the text in the Stereotype field to
create the corresponding icon.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 851

Toolbox Icon

(where UI Control is the name of the user interface element type)

5.1.2.3.17 Web Stereotypes

Enterprise Architect supports a number of stereotypes for web page modeling, the graphical elements for
which display with a graphical icon instead of the usual «stereotype» format. These stereotypes are only
supported for Class 811 elements. The image below indicates the various graphical icons and their associated
stereotypes.

A similar set of web modeling elements and their relationships are also available through dedicated Web
Modeling pages in the Toolbox 399 .

© 1998-2010 Sparx Systems Pty Ltd

 852 Modeling Languages | Standard UML Models

Set a Web Icon

To set a web icon, follow the steps below:
1. Create a new Class element in a diagram.
2. Display the Class Properties dialog.
3. In the Stereotype field, either type in the required stereotype name or click on the drop-down arrow and
select the required stereotype (as named above).
4. Click on the OK button. The Class displays as in one of the examples above.

5.1.3 UML Connectors

What is a Connector?
A connector is a logical or functional relationship between model elements. There are several different
connector types, each having a particular purpose and syntax. Enterprise Architect supports all of the UML
connectors as well as various custom connectors. Together with the UML Elements 741 , these form the basis
of UML models.
For more information on using these connectors, consult the appropriate topic by clicking on the required
connector icon in the table below.

Notes:
· Invokes and Precedes relationships are defined by the Open Modeling Language (OML). They are
stereotyped Dependency relationships; Invokes indicates that Use Case A, at some point, causes Use
Case B to happen, whilst Precedes indicates that Use Case C must complete before Use Case D can
begin.
· An Extension relationship shows that a stereotype extends one or more metaclasses. All stereotypes must
extend either one or more Metaclasses, or another stereotype that extends a stereotype (that itself extends
a stereotype, and so on).
· A Tagged Value relationship defines a reference-type (that is, RefGUID) Tagged Value owned by the
source stereotype. The Tagged Value is named for the target role of this association, and is limited to
referencing elements with the stereotype by the association target element.
· The Application and Redefinition relationships are deprecated.

Behavioral Diagram Connectors Structural Diagram Connectors Inbuilt and Extended

Connectors

Activity Diagrams Composite Structure Diagrams Analysis Diagrams

Use Case Diagrams

Common Connectors

Package and Class Diagrams

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 853

Behavioral Diagram Connectors Structural Diagram Connectors Inbuilt and Extended

Connectors

Profile 906

State Diagrams

Timing Diagrams

Component Diagrams

Metamodel 1380

Sequence Diagrams

Deployment Diagrams Custom

Communication Diagrams

Interaction Overview Diagrams

© 1998-2010 Sparx Systems Pty Ltd

 854 Modeling Languages | Standard UML Models

Behavioral Diagram Connectors Structural Diagram Connectors Inbuilt and Extended

Connectors

Requirements

User Interface

Maintenance

WSDL

XML Schema No special connectors

Object Documentation

No special connectors

Data Modeling

5.1.3.1 Aggregate

An Aggregation connector is a type of association that shows that an element contains or is composed of
other elements. It is used in Class models 721 , Package models 720 and Object models 723 to show how more
complex elements (aggregates) are built from a collection of simpler elements (component parts; for example,
a car from wheels, tires, motor and so on).
A stronger form of aggregation, known as Composite Aggregation, is used to indicate ownership of the whole
over its parts. The part can belong to only one Composite Aggregation at a time. If the composite is deleted,
all of its parts are deleted with it.
After drawing an Aggregation association, its form can be changed 855 .

Toolbox Icon

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 855

5.1.3.1.1 Change Aggregation Connector Form

In Enterprise Architect, the default Aggregation relationship 854 is the weak form of the relationship,
represented by a hollow diamond. To change the form of an Aggregation connector from weak to strong,
follow the steps below.
1. Right-click on an Aggregation connector to display the context menu.
2. Select Set Aggregation to Composite. The diamond is shown as filled.

Note:
If the connector is already a Strong (Composition) connector, the context menu option changes to Set
Aggregation to Shared.

5.1.3.2 Assembly

An Assembly connector bridges a component's required interface 820 (Component1) with the provided
interface of another component (Component2), typically in a Component diagram 730 .

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 156) states:
An assembly connector is a connector between two components that defines that one component provides the
services that another component requires. An assembly connector is a connector that is defined from a
required interface or port to a provided interface or port.

5.1.3.3 Associate

An Association implies two model elements have a relationship, usually implemented as an instance variable
in one Class 811 . This connector can include named roles at each end, multiplicity, direction and constraints.
Association is the general relationship type between elements. To connect more than two elements in an
association, you can use the N-Ary Association 844 element.
When code is generated for Class diagrams 721 , Associations become instance variables in the target Class.

© 1998-2010 Sparx Systems Pty Ltd

 856 Modeling Languages | Standard UML Models

The relationship is also used in Package, 720 Object, 723 Communication 715 , Data Modeling 739 and
Deployment 727 diagrams.
An Associate connector can also be integrated with a Class element to form an Association Class 856 , to allow
the Associate connector to have operations and attributes that define certain types of UML relationship.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 41) states:
An association specifies a semantic relationship that can occur between typed instances. It has at least two
ends represented by properties, each of which is connected to the type of the end. More than one end of the
association may have the same type.
An end property of an association that is owned by an end class or that is a navigable owned end of the
association indicates that the association is navigable from the opposite ends; otherwise, the association is
not navigable from the opposite ends.

5.1.3.4 Association Class

An Association Class connector is a UML construct that enables an Associate 855 connector to have attributes
558 and operations 569 (features). This results in a hybrid relation with the characteristics of a connection and
a Class 811 . It is used to model particular types of connections in UML (see the OMG UML Specification 857 for
more details).
When you add an Association Class connection, Enterprise Architect also creates a Class that is automatically
connected to the Association. When you hide or delete the Association, the Class is also hidden or deleted.
To add an Association Class to a Class 721 or Deployment 727 diagram, click on the Association Class icon in
the Toolbox. Click and hold on the source object in the diagram while you drag the line to the target element,
then release the mouse button. Enterprise Architect draws the connector and adds the Class, then prompts
you to add the Class name. Note that the names of the Class and the connector are the same. You can also
connect a new Class to an existing Association 857 .
The following diagram illustrates an Association Class between model elements. Note the dotted line from the
Class to the Association. You cannot move or delete this line.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 857

Note:
If you are applying a stereotype with a Shape Script 1104 to an Association Class, be aware that the Shape
Script is applied to both the Class part and the Association part. Therefore, you might have to include logic in
the shape main that tests the type of the element so that you can give separate drawing instructions for Class
and for Association. Such logic is not necessary in the:
· shape source or shape target, which are ignored by Classes, or the
· decoration shapes, which are ignored by Associate connectors.
If you dis-associate the Class from the Associate connector, both parts keep their Shape Scripts until the
stereotypes are removed.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 49) states:
A model element that has both association and class properties. An AssociationClass can be seen as an
association that also has class properties, or as a class that also has association properties. It not only
connects a set of classifiers but also defines a set of features that belong to the relationship itself and not to
any of the classifiers.

5.1.3.4.1 Connect New Class to Association

To connect a new Class to an existing Association, follow the steps below:
1. Create a Class in the diagram containing the Association to connect.
2. Right-click on the new Class. The context menu displays.
3. Select the Advanced | Association Class 856 menu option. The Create Association Class dialog
displays.

© 1998-2010 Sparx Systems Pty Ltd

 858 Modeling Languages | Standard UML Models

4. Select the connector to connect to.

5. Click on the OK button.

5.1.3.5 Communication Path

A Communication Path defines the path through which two DeploymentTargets are able to exchange signals
and messages. Communication Path is a specialization of Association 855 . A DeploymentTarget is the target
for a deployed Artifact 810 and can be a Node 822 , Property or InstanceSpecification 818 in a Deployment
diagram 727 .

Toolbox Icon

5.1.3.6 Compose

A Composite Aggregation 854 is used to depict an element that is made up of smaller components, typically in
a Class 721 or Package 720 diagram. A component - or part instance - can be included in a maximum of one
composition at a time. If a composition is deleted, usually all of its parts are deleted with it; however, a part
can be individually removed from a composition without having to delete the entire composition. Compositions
are transitive, asymmetric relationships and can be recursive.
See the example below.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 859

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 43) states:
Composite aggregation is a strong form of aggregation that requires a part instance be included in at most one
composite at a time. If a composite is deleted, all of its parts are normally deleted with it.

5.1.3.7 Connector

Connectors illustrate communication links between parts to fulfill the structure's purpose, typically in a
Composite Structure 724 diagram. Each Connector end is distinct, controlling the communication pertaining to
its connecting element. These elements can define constraints specifying this behavior. Connectors can have
multiplicity.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 177) states:
Specifies a link that enables communication between two or more instances. This link may be an instance of
an association, or it may represent the possibility of the instances being able to communicate because their
identities are known by virtue of being passed in as parameters, held in variables or slots, or because the
communicating instances are the same instance. The link may be realized by something as simple as a
pointer or by something as complex as a network connection. In contrast to associations, which specify links
between any instance of the associated classifiers, connectors specify links between instances playing the
connected parts only.

© 1998-2010 Sparx Systems Pty Ltd

 860 Modeling Languages | Standard UML Models

5.1.3.8 Control Flow

The Control Flow is a connector connecting two nodes in an Activity diagram 674 . Control Flow connectors
bridge the flow between Activity nodes, by directing the flow to the target node once the source node's activity
is completed.

Control Flows and Object Flows can define a Guard and a Weight condition.
A Guard defines a condition that must be true before control passes along that activity edge. A practical
example of this is where two or more activity edges (Control Flows) exit from a Decision 765 element. Each
flow should have a Guard condition that is exclusive of the other and defines which edge is taken under what
conditions. The Control Flow Properties dialog enables you to set up Guard conditions on Control Flows and
on Object Flows.
A Weight defines the number of tokens that can flow along a Control or Object Flow connection when that
edge is traversed. Weight can also be defined on the Control Flow and Object Flow Properties dialogs.

Toolbox Icon

OMG UML specification:

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 356) states:
A control flow is an edge that starts an activity node after the previous one is finished.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 861

5.1.3.9 Delegate

A Delegate connector defines the internal assembly of a component's external Ports 826 and Interfaces 821 , on
a Component diagram 730 . Using a Delegate connector wires the internal workings of the system to the
outside world, by a delegation of the external interfaces' connections.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 156) states:
A delegation connector is a connector that links the external contract of a component (as specified by its ports)
to the internal realization of that behavior by the component's parts. It represents the forwarding of signals
(operation requests and events): a signal that arrives at a port that has a delegation connector to a part or to
another port will be passed on to that target for handling.

5.1.3.10 Dependency

Dependency relationships are used to model a wide range of dependent relationships between model
elements in Use Case 676 , Activity 753 and Structural 719 diagrams, and even between models themselves.
You can create the Dependency from the Common 405 page of the Toolbox. The Dependencies package as
defined in UML 2.3 has many derivatives, such as Realize 889 , Deployment 862 and Use 894 . Once you create
a Dependency you can further refine its meaning by applying a specialized stereotype 862 .

© 1998-2010 Sparx Systems Pty Ltd

 862 Modeling Languages | Standard UML Models

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 64) states:
A dependency is a relationship that signifies that a single or a set of model elements requires other model
elements for their specification or implementation. This means that the complete semantics of the depending
elements is either semantically or structurally dependent on the definition of the supplier element(s).

5.1.3.10.1 Apply a Stereotype

To apply a stereotype to a Dependency 861 relationship, follow the steps below:
1. Select the Dependency relationship to change.
2. Right-click on the connector and, from the context menu, select the Dependency Properties option.
The Dependency Properties dialog displays.
3. In the Stereotype field, either type in the required stereotype name or click on the drop-down arrow and
select the stereotype from the list.
4. Click on the OK button.
Alternatively, you can right-click on the Dependency relationship and select the Advanced | Dependency
Stereotypes context menu option, then select from a shorter list of standard stereotypes.

5.1.3.11 Deployment

A Deployment is a type of Dependency 861 relationship that indicates the deployment of an artifact onto a
node or executable target, typically in a Deployment diagram 727 . A Deployment can be made at type and
instance levels. At the type level, a Deployment would be made for every instance of the node. Deployment
can also be specified for an instance of a node, so that a node's instances can have varied deployed artifacts.
With composite structures modeled with nodes defined as Parts 825 , Parts can also serve as targets of a
Deployment relationship.

Toolbox Icon

5.1.3.12 Extend

An Extend connection is used to indicate that an element extends the behavior of another. Extensions are

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 863

used in Use Case models 676 to indicate that one Use Case 806 (optionally) extends the behavior of another.
An extending Use Case often expresses alternative flows.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 587) states:
This relationship specifies that the behavior of a Use Case may be extended by the behavior of another
(usually supplementary) Use Case. The extension takes place at one or more specific extension points
defined in the extended Use Case. Note, however, that the extended Use Case is defined independently of
the extending Use Case and is meaningful independently of the extending Use Case. On the other hand, the
extending Use Case typically defines behavior that may not necessarily be meaningful by itself. Instead, the
extending Use Case defines a set of modular behavior increments that augment an execution of the extended
Use Case under specific conditions.
Note that the same extending Use Case can extend more than one Use Case. Furthermore, an extending Use
Case may itself be extended.

5.1.3.13 Generalize

A Generalize is used to indicate inheritance. Drawn from the specific classifier to a general classifier, the
generalize implication is that the source inherits the target's characteristics. It is used typically in Class 721 ,
Component 730 , Object 723 , Package 720 , Use Case 676 and Requirements 736 diagrams.

Toolbox Icon

(and )

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 73) states:
A generalization is a taxonomic relationship between a more general classifier and a more specific classifier.
Each instance of the specific classifier is also an indirect instance of the general classifier. Thus, the specific
classifier inherits the features of the more general classifier.

© 1998-2010 Sparx Systems Pty Ltd

 864 Modeling Languages | Standard UML Models

5.1.3.14 Include

An Include connection indicates that the source element includes the functionality of the target element.
Include connections are used in Use Case models 676 to reflect that one Use Case 806 includes the behavior
of another. Use an Include relationship to avoid having the same subset of behavior in many Use Cases; this
is similar to delegation 861 used in Class models 721 .

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 591) states:
Include is a DirectedRelationship between two Use Cases, implying that the behavior of the included Use
Case is inserted into the behavior of the including Use Case. It is also a kind of NamedElement so that it can
have a name in the context of its owning Use Case. The including Use Case may only depend on the result
(value) of the included Use Case. This value is obtained as a result of the execution of the included Use Case.

5.1.3.15 Information Flow

An Information Flow represents information items 821 or classifiers flowing between two elements in any
diagram. The connector is available from the Common page of the Toolbox and from every Quick Link menu.
You can have more than one Information Flow connector between the same two elements, identifying which
items flow between the two under differing conditions.

Example of Use
1. Open a diagram and add two elements (for example, Nodes on a Deployment diagram).
2. Click on the Information Flow connector in the Common page of the Toolbox and drag between the two
elements. The Information Items Conveyed 865 dialog displays.
3. Add the classifier or information item element(s) to the Information Flow. The diagram now resembles
the following.

4. Add another connector between the same two elements (for example, a Communication Path
connector).

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 865

5. Right-click the connector and select the Advanced | Information Flows Realized context menu option.
The Information Flows Realized 866 dialog displays.
6. Tick the checkbox against the required classifier element and click on the OK button. The combined
connector now resembles the following:

Notes:
· Once the connectors are combined, you cannot access the Information Items Conveyed dialog directly.
You add or delete information items on the connector using the Information Items Realized dialog. If you
have more than one Information Flow connector between the elements, they form part of the same
combined connector; you can again work on them separately through the Information Items Realized
dialog.
· If you have information flows in a diagram that you use as the source for a Pattern, the Information Items
Conveyed and Information Flows Realized data is not copied into the Pattern.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 606) states:
An InformationFlow specifies that one or more information items circulates from its sources to its targets.
The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 607) also states:
An information flow is an abstraction of the communication of an information item from its sources to its
targets. It is used to abstract the communication of information between entities of a system. Sources or
targets of an information flow designate sets of objects that can send or receive the conveyed information
item.

5.1.3.15.1 Convey Information on a Flow

As you create an Information Flow 864 connector between two elements, you can specify which Information
Items 821 or classifiers are conveyed on this flow.
To specify these Information Items or classifiers, right-click on the connection and select the Advanced |
Information Item Conveyed context menu option. The Information Items Conveyed dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 866 Modeling Languages | Standard UML Models

Button Use to

Add Display the Select <Item> 515 dialog, from which you select the required
Information or Classifier element(s).

Remove Remove the selected item.

Note:
If you select more than one element, they are listed in one entry for the Information Flow connector.

5.1.3.15.2 Realize an Information Flow

The Information Flows Realized dialog displays all flows that can be realized on the selected connector. To
realize an Information Flow 864 on this connector, select the corresponding checkbox and click on the OK
button.
If you want to change the information items conveyed on an information flow, click on the flow text and click on
the Items button. The Information Items Conveyed 865 dialog displays, and you can add or remove items as
required. When you click on the OK button, the Information Items Realized dialog redisplays and you can
realize the selected flow or flows as above.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 867

5.1.3.16 Interrupt Flow

The Interrupt Flow is a connection used to define the two UML concepts of connectors for Exception Handler
769 and Interruptible Activity Region 781 . An Interrupt Flow is also known as an activity edge. It is typically
used in an Activity diagram 674 .

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 327) states:
An activity edge is an abstract class for directed connections between two activity nodes.

5.1.3.17 Manifest

A Manifest relationship indicates that the Artifact 810 source embodies the target model element, typically in
Component 730 and Deployment 727 diagrams. Stereotypes 895 can be added to Enterprise Architect to
classify the type of manifestation of the model element.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 212) states:
An artifact embodies or manifests a number of model elements. The artifact owns the manifestations, each
representing the utilization of a packageable element.
Specific profiles are expected to stereotype the manifestation relationship to indicate particular forms of
manifestation, e.g. «tool generated» and «custom code» might be two manifestations for different classes
embodied in an artifact.

5.1.3.18 Message
Messages indicate a flow of information or transition of control between elements. Messages can be used by
Timing Diagrams 882 , Sequence Diagrams 868 and Communication Diagrams 879 (but not Interaction
Overview 717 diagrams) to reflect system behavior. If between Classes 811 or classifier instances, the
associated list of operations is available to specify the event.
Moving a Message can disrupt the organization of other features on the diagram. To avoid this, and move only
the Message, press [Alt] while you move the Message.

© 1998-2010 Sparx Systems Pty Ltd

 868 Modeling Languages | Standard UML Models

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 491) states:
A Message defines a particular communication between Lifelines of an Interaction.
A Message is a NamedElement that defines one specific kind of communication in an Interaction. A
communication can be, for example, raising a signal, invoking an Operation, creating or destroying an
Instance. The Message specifies not only the kind of communication given by the dispatching
ExecutionSpecification, but also the sender and the receiver.
A Message associates normally two OccurrenceSpecifications - one sending OccurrenceSpecification and one
receiving OccurrenceSpecification.

Note:
Communication diagrams were known as Collaboration diagrams in UML 1.4.

5.1.3.18.1 Message (Sequence Diagram)

Sequence diagrams 706 depict work flow or activity over time using Messages passed from element to
element. These Messages correspond in the software model to Class operations and behavior. They are
semantically similar to the Messages passed between elements in a Communication diagram, and can be of
many different types 873 .
To create a Message on a Sequence diagram, follow the steps below:
1. Access the Sequence diagram. The Interaction pages of the Toolbox display.
2. In the Interaction Relationships page, click on the Message icon, click on the source object and drag
the cursor to the destination (target) object. The Message Properties dialog displays (if not, right-click
on the Message and select the Message Properties context menu option).

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 869

3. In the Message field, type the Message name.

Notes:
· If the Message flow is towards a Class 811 element (dropped in from a Class diagram) or a Lifeline
783 element having a classifier, and the destination Class has defined operations, you can click on
the drop-down arrow and select an appropriate operation name. The Message then reflects the
destination Class operations.
· If the available operations are not appropriate, you can click on the Operations button and define a
new operation in the target element, using the Operations 570 dialog.
· If you create a Message without making reference to the target Class operations, no new operation
is added to the target Class.

4. In the Parameters field, type any parameters that the Message has, as a comma-separated list. If
required, in the Parameter Values field type the actual value for each parameter, again as a comma-
separated list.
5. If the Message is a return message, in the Return Value field enter the returned value or type.

Note:
It is possible to depict returns from a Self Message 871 . Simply create a second Self Message at the
end of execution and select the Is Return checkbox in the Control Flow Type panel.

6. If the Message flow is from a Class element or Lifeline element with classifier that has defined attributes

© 1998-2010 Sparx Systems Pty Ltd

 870 Modeling Languages | Standard UML Models

, click on the drop-down arrow in the Assign to field and select an appropriate attribute name. The
Message reflects the attributes from the source Class. You cannot add further attributes to the source
Class here - if no appropriate attribute is listed, open the element Properties dialog and add the
required attribute.

Otherwise, if required, type the name of the object to assign the message flow to.
7. In the Stereotype field, type or select an optional stereotype for the connector (this is displayed on the
diagram, if entered).
8. If required, in the Alias field type an alias for the name of the Message.

Note:
On the diagram, the alias displays if the Use Alias if Available checkbox is selected on the Diagram
tab of the Diagram Properties dialog. The Alias displays instead of or as well as the Message name,
depending on the setting selected in the Alias Usage panel of the Diagram Behavior 359 page of the
Options dialog.

9. In the Condition field, type any conditions that must be true in order for the message to be sent.
10. In the Synch: field in the Control Flow Type panel, select Synchronous or Asynchronous 877 as
appropriate.
11. In the Lifecycle field, select New to create a new element at the end of the Message, or Delete to
terminate the message flow at the end of the Message. If neither case applies, leave the field at the
default of <none>.
12. If required, in the Notes field type any explanatory notes. You can format the notes using the Notes 642
toolbar at the top of the field.
13. Click on the OK button to save the Message definition.

Notes:
· You can change the timing details 874 of a message on the Timing Details dialog, and emphasize the
sequence of closely-ordered messages using General Ordering 876 .
· To toggle the numbering of messages on a Sequence diagram, select or deselect the Show Sequence
Numbering 360 checkbox on the Options dialog.

Co-Region Notation
Co-Region notation can be used as a short hand for parallel combined fragments. To access the Co-Region
submenu, right-click on a connector in a Sequence diagram and select the Co-Region context menu option.
There are four sub-options available:
· Start at head
· End at head
· Start at tail
· End at tail.

Toolbox Icon

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 871

5.1.3.18.1.1 Self-Message

A Self-Message reflects a new process or method invoked within the calling lifeline's operation. It is a
specification of a Message 867 , typically in a Sequence diagram 706 .

Self-Message as Return
It is possible to depict a return from a Self Message call.

To create a Self Message return:

1. Create a second Self Message at the end of execution.
2. Double-click on the Message name to open the Message Properties dialog.
3. Select the Is Return checkbox.
4. Raise the Activation level 712 of the return.
Self-Message Calls 872 indicate a nested invocation; new activation levels are added with each Call.

Toolbox Icon

© 1998-2010 Sparx Systems Pty Ltd

 872 Modeling Languages | Standard UML Models

5.1.3.18.1.2 Call

A Call is a type of Message 868 connector that extends the level of activation from the previous Message. All
Self-Messages 871 create a new activation level, but this focus of control usually ends with the next Message
(unless activation levels 711 are manually adjusted). Self-Message Calls, as depicted above by the first Call,
indicate a nested invocation; new activation levels are added with each Call. Unlike a regular Message
between elements, a Call between elements continues the existing activation in the source element, implying
that the Call was initiated within the previous Message's activation scope.

Toolbox Icon

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 873

5.1.3.18.1.3 Message Examples

The following are different types of Messages 868 available on Sequence Diagrams 706 . Note that Messages
on Sequence diagrams can also be modified with Shape Scripts 1147 .

Other Sequence Messages

The following are examples of Messages that are not part of the sequence described by the diagram.

© 1998-2010 Sparx Systems Pty Ltd

 874 Modeling Languages | Standard UML Models

5.1.3.18.1.4 Change the Timing Details

It is possible to change the timing details of a Message in a Sequence diagram 706 by right-clicking on the
Message 867 connector and selecting the Timing Details context menu option. The Timing Details dialog
displays.

Complete the fields on this dialog as follows:

Option Use to

Duration Constraint Indicate the minimum and maximum limits on how long a message can last.

Duration Constraint Indicate the minimum and maximum interval between sending or receipt of the
Between Messages previous message at the current message's source Lifeline, and sending the current

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 875

Option Use to

message.

Duration Capture the duration of a message.

Observation

Timing Constraint Indicate the minimum and maximum time at which the message should arrive at the
target.

Timing Observation Capture the point at which the message was sent.

See the OMG UML specification (UML Superstructure Specification, v2.1.1, p. 511).
In the diagram below, on the Open Order Message:
· Duration Constraint has been set to 0...13.
On the Get Cart Message:
· Duration Constraint Between Messages has been set to d...d*3
· Duration Observation has been set to d=duration
· Timing Constraint has been set to t...t+3
· Timing Observation has been set to t=now.

By typing a value in the Duration Constraint field, you enable the Message angle to be adjusted. After
clicking on the OK button on the Timing Details dialog, click on the head of the Message connector and drag
the connector up or down to change the angle. You cannot extent the angle beyond the life line of the
connecting sequence object or create an angle of less than 5 degrees.
You can also create the Duration Constraint Between Messages line by dragging the General Ordering 876
arrow up to the point at which the previous message joins the source Lifeline for the current message. A dialog
displays on which you enter the value for the constraint. Having created the line, you can move it to any point
within half way along the current message and half way along the previous message, to avoid overlap with
other message timing details. You can edit or delete the value either through the Timing Details dialog or by
right-clicking on the line itself and selecting the appropriate context menu option.

© 1998-2010 Sparx Systems Pty Ltd

 876 Modeling Languages | Standard UML Models

5.1.3.18.1.5 General Ordering

In a Sequence diagram 706 , the workflow is represented by the sequence of Messages down the diagram.
Messages near the top of the diagram are passed before Messages lower down the diagram.
Consider the following diagram.

Message 1 is earlier than Message 2. However, in a complex diagram, or when representing finely timed
operations or parallel processing, this might not be apparent. You can reinforce the sequence using a General
Ordering arrow.
Click on the Message arrow. A small arrow displays at the source anchor point.

Click on this arrow and drag it to the start of the next Message in sequence (Message 2 in the example). The
General Ordering arrow displays, indicating that the second Message follows the first.

The General Ordering arrow is exaggerated in the above figure. You would normally have the arrow running
almost horizontal across the diagram.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 877

You can have more than one General Ordering arrow issuing from or targeting a Message, if necessary.

5.1.3.18.1.6 Asynchronous Signal Message

You define a Message as an asynchronous signal message by displaying the Message Properties 868 dialog
and setting the Synch field to Asynchronous and the Kind field to Signal. (A synchronous message cannot
be used to convey signals, so setting the Synch field to Synchronous disables the Kind field.)

Note:
Return Value, Assign To and the Operations button, which are not applicable to asynchronous signals, are
disabled.

The Operations button changes to a Signal button, which you click on to associate the asynchronous signal
message with a Signal element in the model. You can type the arguments corresponding to the Signal
attributes into the Argument(s) field.

© 1998-2010 Sparx Systems Pty Ltd

 878 Modeling Languages | Standard UML Models

When you click on the Signal button, the Select *Signal dialog displays, through which you locate and select
the required Signal element. (The Select *Signal dialog is a variation of the Select <Item> 515 dialog.)

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 879

5.1.3.18.2 Message (Communication Diagram)

A Message in a Communication diagram 715 is equivalent in meaning to a Message in a Sequence diagram. It
implies that one object uses the services of another object, or sends a message to that object. Communication
Messages in Enterprise Architect are always associated with an Associate 855 connector between object
instances. Always create the Associate connector first, then add a Message to the connector 880 .
Messages can be dragged into a suitable position by clicking and dragging on the message text.
Communication Messages are ordered to reflect the sequencing of the diagram. The numbering scheme
should reflect the nesting of each event. A sequencing scheme could be:

1
2, 2.1, 2.2, 2.3
3.

This would indicate the single sequence of events 2.1, 2.2 and 2.3 occurs within an operation initiated by
event 2. This is the default pattern applied by Enterprise architect
Alternatively, the sequence could be:

1
2, 2.1, 2.1.1, 2.1.1.1
2.2, 2.2.1, 2.2.1.1
3

This would indicate that two sequences of events can be initiated by event 2, and 2.1 and 2.2 are separate
sequences, not consecutive events in one sequence. You can set the sequence pattern and order 880 using
the Message Properties dialog and the Sequence Communications dialog.
If the target object is a Class or has its instance classifier set, the drop-down list of possible message names

© 1998-2010 Sparx Systems Pty Ltd

 880 Modeling Languages | Standard UML Models

includes the exposed operations for the base type.

5.1.3.18.2.1 Create a Communication Message

To create a Communication Message 879 , follow the steps below:
1. Open a diagram (one of: Communication, Analysis, Interaction Overview, Object, Activity or State
Machine).
2. Add the required objects.
3. Add an Associate 855 relationship between each pair of objects that communicate.
4. Right-click on an Associate to display the context menu.
5. Select the option to add a Message from one object to the other.
6. When the Message Properties 868 dialog displays, type in a name and any other required details.
7. Click on the OK button. The Message is added, connected to the Association and Object instances.
8. Move the Message to the required position.

5.1.3.18.2.2 Re-Order Messages

When constructing your Communication diagram, it is frequently necessary to create or delete Message
'groups' and to re-order the sequence of Messages. There are two dialogs that help you perform these tasks:
the Message Properties dialog and the Sequence Communications dialog.

Organize Message Groups

If you have several Messages 879 in the form 1.1, 1.2, 1.3, 1.4, for example, but would like to start a new
numbering group on, say, the third Message (that is, 1.1, 1.2, 2.1, 2.2, 2.3 ), you can change a Message in the
series to a Start Group message.
To reorganize message groups, follow the steps below:
1. Double-click on a Message name. The Message Properties dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 881

2. To make the selected Message the start of a new group, select the Start New Group checkbox.
3. If required, in the Notes field, type an explanatory note. You can format the text using the Notes 642
toolbar at the top of the field.
4. Click on the OK button to save changes.

Sequence Messages
In larger and more complex diagrams, you might have to use deeper levels of Messages in a group; for
example, 1, 1.2, 1.2.1, 1.2.1.1. You might also have to change the sequence of Messages, making Message
1.3, for example, into Message 1.1.
To change the sequence or level of Messages, follow the steps below:
1. Either:
· Select the Diagram | Sequence Messages menu option
· Click on the diagram background and select the Sequence Communication Messages context
menu option or
· Right-click on a Message and select the Sequence Communication Messages context menu
option.
The Communication Messages dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 882 Modeling Languages | Standard UML Models

2. Click on the Message to adjust and, at the bottom of the dialog, click on the:
· 'Up Hand' or 'Down Hand' buttons to move the Message up or down the sequence (e.g. Message 1.2
to Message 1.1 or 1.3)
· 'Left Hand' or 'Right Hand' buttons to move the Message up or down a level (e.g. Message 1.2.1 to
Message 1.2 or Message 1.2.1.1).
3. Repeat step 2 until the Message sequence and levels match your requirements. You might have to
adjust other Message numbers (in group, sequence or level) to accommodate the changes you have
made.
4. Click on the OK button to save changes.

Note:
Communication diagrams were known as Collaboration diagrams in UML 1.4.

5.1.3.18.3 Message (Timing Diagram)

Messages are the communication links between Lifelines 783 in a Timing diagram 690 . In the case of a
Timeline, a Message is a connection between two Timeline objects.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 883

See UML Superstructure Specification, v2.1.1, figures 14.30 and 14.31, p. 520.

Toolbox Icon

5.1.3.18.3.1 Create a Timing Message

To create a Message 882 in a Timing diagram 690 , at least two Lifeline objects (State 794 or Value 808 ) must be
created first, each with existing transition points. To create a Message between Lifelines, follow the steps
below:
1. Click on one of the Lifelines in the Timing diagram.
2. Select the Message icon from the Timing Relationships page of the Toolbox (More tools | Timing).
3. Drag the cursor onto the Lifeline at the point at which the Message originates. The Timing Message
dialog displays. (If not, double-click on the Message.)

© 1998-2010 Sparx Systems Pty Ltd

 884 Modeling Languages | Standard UML Models

The dialog consists of a set of transition points. Each transition point can be defined with the following
properties:

Property Description

Start Defines the lifeline where the message originates.

End Defines the lifeline where the message terminates.

These are set by default when a Message is created by dragging the cursor between two Lifelines.

Property Description

Start Time Specifies the start time for a message.

End Time Specifies the end time for a message.

Name The name of the message.

Time Observation Provides information on the time of a sent message.

Duration Observation Indicates the interval of a Lifeline at a particular state, begun from a
message receipt.

Transition To The state in the target Lifeline that the Message points to.

Event The occurring event.

Time Constraint The time taken to transmit a message.

Duration Constraint Pertains to a lifeline's period at a particular state. The constraint

could be instigated by that Lifeline's receipt of a message.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 885

The following diagram shows the Message configured by the above dialog snapshot.

See UML Superstructure Specification, v2.1.1, figures 14.30 and 14.31, p. 520.

Note:
You can move the source end of the Message freely along the source timeline. However, the target end
(arrow head) must attach to a transition. If you create a new Message and do not give it a target transition, it
automatically finds and attaches to the nearest transition. If you move the target end, it drags the transition
with it.

5.1.3.19 Nesting

The Nesting Connector is an alternative graphical notation for expressing containment or nesting of elements
within other elements. It is most appropriately used for displaying Package 825 nesting in a Package diagram
720 .

Toolbox Icon

© 1998-2010 Sparx Systems Pty Ltd

 886 Modeling Languages | Standard UML Models

5.1.3.20 Notelink

A Notelink connector connects a Note 785 to one or more other elements of any other type.
Both Note and Notelink are available in any category of the Toolbox, in the Common 405 page. You can also
select them from the UML Elements 83 toolbar.

Toolbox Icon

5.1.3.21 Object Flow

Object Flows are used in Activity diagrams 674 and State Machine diagrams 678 . When used in an Activity
diagram, an Object Flow connects two elements, with specific data passing through it. To view sample Activity
diagrams using Object Flows, see the Object Flows in Activity Diagrams 886 topic.
In State Machine diagrams, an Object Flow is a specification of a state flow or transition. It implies the passing
of an Object 823 instance between elements at run-time.
You can insert an Object Flow from the State or Activity pages of the Toolbox, or from the drop-down list of all
relationships located in the header toolbar. You can also modify a transition connection to an Object Flow by
selecting the ObjectFlow checkbox on the connection Properties dialog.
See the Control Flow 860 topic for information on setting up Guards and Weights on Object Flows.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 389) states:
An object flow is an activity edge that only passes object and data tokens.

5.1.3.21.1 Object Flows in Activity Diagrams

In Activity diagrams 674 , there are several ways to define the flow of data between objects.
The following diagram depicts a simple Object Flow 886 between two actions, Fill Order and Ship Order, both
accessing order information.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 887

See UML Superstructure Specification, v2.1.1, figure 12.110, p. 391.

This explicit portrayal of the data object Order, connected to the Activities by two Object Flows, can be refined
by using the following format. Here, Action Pins 749 are used to reflect the order.

See UML Superstructure Specification, v2.1.1, figure 12.110, p. 391.

The following diagram is an example of multiple Object Flows exchanging data between two actions.

See UML Superstructure Specification, v2.1.1, figure 12.111, p. 391.

Selection and transformation behavior, together composing a sort of query, can specify the nature of the
Object Flow's data access. Selection behavior determines which objects are affected by the connection.
Transformation behavior might then further specify the value of an attribute pertaining to a selected object.
Selection and transformation behaviors can be defined by attaching a note to the Object Flow. To do this,
right-click on the Object Flow and select the Attach Note or Constraint context menu option. A dialog lists
other flows in the diagram, to which you can select to attach the note, if the behavior applies to multiple flows.
To comply with UML 2, preface the behavior with the notation «selection» or «transformation».

See UML Superstructure Specification, v2.1.1, figure 12.112, p. 392.

© 1998-2010 Sparx Systems Pty Ltd

 888 Modeling Languages | Standard UML Models

5.1.3.22 Occurrence

An Occurrence relationship indicates that a Collaboration 814 represents a classifier, in a Composite Structure
diagram 724 . An Occurrence connector is drawn from the Collaboration to the classifier.

Toolbox Icon

5.1.3.23 Package Import

A Package Import relationship is drawn from a source Package 825 to a Package whose contents are to be
imported. Private members of a target Package cannot be imported. The relationship is typically used in a
Package diagram 720 .

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 112) states:
A package import is a relationship between an importing namespace and a package, indicating that the
importing namespace adds the names of the members of the package to its own namespace. Conceptually, a
package import is equivalent to having an element import to each individual member of the imported
namespace, unless there is already a separately-defined element import.

5.1.3.24 Package Merge

In a Package diagram 720 , a Package Merge indicates a relationship between two Packages 825 whereby the
contents of the target Package are merged with those of the source Package. Private contents of a target
Package are not merged. The applicability of a Package Merge addresses any situation where multiple

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 889

packages contain identically-named elements, representing the same thing. A Package Merge merges all
matching elements across its merged Packages, along with their relationships and behaviors. Note that a
Package Merge essentially performs generalizations and redefinitions of all matching elements, but the
merged Packages and their independent element representations still exist and are not affected.
The Package Merge serves a graphical purpose in Enterprise Architect, but creates an ordered Package
relationship applied to related Packages (which can be seen under the Link tab in the Package's Properties
dialog). Such relationships can be reflected in XMI exports or Enterprise Architect Automation Interface scripts
for code generation or other Model Driven Architecture (MDA) interests.
Package Merge relationships are useful to reflect situations where existing architectures contain functionalities
involving like elements, which are merged in a developing architecture. Merging doesn't affect the merged
objects, and supports the common situation of product progression.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 113-114) states:
A package merge is a directed relationship between two packages that indicates that the contents of the two
packages are to be combined. It is very similar to Generalization in the sense that the source element
conceptually adds the characteristics of the target element to its own characteristics resulting in an element
that combines the characteristics of both.
This mechanism should be used when elements defined in different packages have the same name and are
intended to represent the same concept. Most often it is used to provide different definitions of a given concept
for different purposes, starting from a common base definition. A given base concept is extended in
increments, with each increment defined in a separate merged package. By selecting which increments to
merge, it is possible to obtain a custom definition of a concept for a specific end. Package merge is particularly
useful in meta-modeling and is extensively used in the definition of the UML metamodel.
Conceptually, a package merge can be viewed as an operation that takes the contents of two packages and
produces a new package that combines the contents of the packages involved in the merge. In terms of model
semantics, there is no difference between a model with explicit package merges, and a model in which all the
merges have been performed.

5.1.3.25 Realize

A source object implements or Realizes its destination object. Realize connectors are used in a Use Case 676 ,
Component 730 or Requirements 736 diagram to express traceability 1245 and completeness in the model. A
business process or Requirement 846 is realized by one or more Use Cases 806 , which in turn are realized by
some Classes 811 , which in turn are realized by a Component 816 , and so on. Mapping Requirements, Classes
and such across the design of your system, up through the levels of modeling abstraction, ensures the big
picture of your system remembers and reflects all the little pictures and details that constrain and define it.

© 1998-2010 Sparx Systems Pty Ltd

 890 Modeling Languages | Standard UML Models

Toolbox Icon

(and )

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 131) states:
A Realization signifies that the client set of elements are an implementation of the supplier set, which serves
as the specification. The meaning of 'implementation' is not strictly defined, but rather implies a more refined
or elaborate form in respect to a certain modeling context. It is possible to specify a mapping between the
specification and implementation elements, although it is not necessarily computable.

5.1.3.26 Recursion

A Recursion is a type of Message 868 used in Sequence diagrams 706 to indicate a recursive function.

Toolbox Icon

5.1.3.27 Role Binding

Role Binding is the mapping between a Collaboration Occurrence's 815 internal roles and the respective Parts
825 required to implement a specific situation, typically in a Composite Structure diagram 724 . The associated
Parts can have properties defined to enable the binding to occur, and the Collaboration to take place.
A Role Binding connector is drawn between a Collaboration 814 and the classifier's fulfilling roles, with the
Collaboration's internal binding roles labeled on the classifier end of the connector.

Toolbox Icon

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 891

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 174) states:
A mapping between features of the collaboration type and features of the classifier or operation. This mapping
indicates which connectable element of the classifier or operation plays which role(s) in the collaboration. A
connectable element may be bound to multiple roles in the same collaboration occurrence (that is, it may play
multiple roles).

5.1.3.28 Represents

The Represents connector indicates that a Collaboration 814 is used in a classifier, typically in a Composite
Structure diagram 724 . The connector is drawn from the Collaboration to its owning classifier.

Toolbox Icon

5.1.3.29 Representation

The Representation relationship is a specialization of a Dependency 861 , connecting Information Item 821
elements that represent the same idea across models, typically in an Analysis diagram 733 . For example,
Bonus and Salary are both a representation of the Information Item Wage.

Toolbox Icon

© 1998-2010 Sparx Systems Pty Ltd

 892 Modeling Languages | Standard UML Models

5.1.3.30 Trace

The Trace relationship is a specialization of a Dependency 861 , connecting model elements or sets of
elements that represent the same concept across models. Traces are often used to track requirements and
model changes, typically in a Traceability 1250 diagram, or in a Class 721 , Use Case 676 , Object 723 or
Composite Structure 724 diagram.
As changes can occur in both directions, the order of this Dependency is usually ignored. The relationship's
properties can specify the trace mapping, but the trace is usually bi-directional, informal and rarely
computable.

Toolbox Icon

5.1.3.31 Transition

A Transition defines the logical movement from one State 789 to another, in a State Machine diagram 678 . The
Transition can be controlled through the following connector Properties dialog:

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 893

Option Use to

Guard Type in an expression that is evaluated after an Event is dispatched, but before the
corresponding Transition is triggered. If the guard is true at that time, the Transition
is enabled; otherwise, it is disabled.

Effect is a Behavior Convert the Effect field from a free-text field to the definition of a specific Activity or
behavior.
Enterprise Architect displays the Select <Item> 515 dialog to prompt you to select
the Activity or behavior element from the model.

Effect Either:
· Type a description of the effect of the Transition, or
· If you have selected the Effect is a Behavior check box, select an Activity or
behavior to be performed during the Transition (to change this subsequently,
click on the [ ... ] button to redisplay the Select <Item> dialog).
Trigger

Name Specify the name of the trigger.

Type Specify the type of trigger: Call, Change, Signal or Time.

· Call - specifies that the event is a CallEvent, which sends a message to the
associated object by invoking an operation.
· Change - specifies that the event is a ChangeEvent, which indicates that the
transition is the result of a change in value of an attribute.
· Signal - specifies that the event is a SignalEvent, which corresponds to the
receipt of an asynchronous signal instance.
· Time - corresponds to a TimeEvent; which specifies a moment in time.

© 1998-2010 Sparx Systems Pty Ltd

 894 Modeling Languages | Standard UML Models

Option Use to

Note:
Code generation for State Machines currently supports Change and Time trigger
events only, and expects a specification value.

Specification Specify the event instigating the Transition.

Save Save the current trigger.

Add Select triggers from the model using the Select Trigger 515 dialog.

Note:
To add multiple triggers, press [Ctrl] while selecting each trigger.

Delete Remove the selected trigger from the list.

Triggers List the current triggers for the Transition.

Note:
Fork and Join segments can have neither triggers nor guards.

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 568) states:
A transition is a directed relationship between a source vertex and a target vertex. It may be part of a
compound transition, which takes the state machine from one state configuration to another, representing the
complete response of the state machine to an occurrence of an event of a particular type.

5.1.3.32 Use

A Use relationship indicates that one element requires another to perform some interaction. The Use (or
Usage) relationship does not specify how the target supplier is used, other than that the source client uses it in
definition or implementation. A Use relationship is a sub-typed Dependency 861 relationship.
You typically use the Use relationship in Use Case diagrams 676 to model how Actors 757 use system
functionality (Use Cases 806 ), or to illustrate usage dependencies between Classes 811 or Components 816 .

Notes:
· It is more usual (and correct UML) to have an Associate connector 855 between an Actor and a Use Case.
· To depict a usage dependency on a Class 721 or Component 730 diagram, draw a Dependency connector.
Right-click on the Dependency, and select the Dependency Stereotypes | Use context menu option.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 895

Toolbox Icon

OMG UML Specification

The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 138) states:
A usage is a relationship in which one element requires another element (or set of elements) for its full
implementation or operation. In the metamodel, a Usage is a Dependency in which the client requires the
presence of the supplier.

5.1.4 UML Stereotypes

UML supports a large number of stereotypes, which 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 899 associated with them.
For further definition of stereotypes, see the OMG UML specification (UML Superstructure Specification,
v2.1.1, section 18.3.8, pp. 667-672).
A stereotype is generally displayed as in the example below (where «myStereotype2» is the stereotype).

In some cases the stereotype causes the element to be drawn differently 900 , as below:

A metafile can be associated with the applied stereotype, as in the example below:

© 1998-2010 Sparx Systems Pty Ltd

 896 Modeling Languages | Standard UML Models

New, or customized, stereotypes can be created. Stereotypes can also be associated with new shapes, using
either metafiles (image files) and colors or Shape Scripts, to apply non-UML shapes to elements and
connectors. For further information on customizing stereotypes 1093 and applying Shape Scripts 1147 , see the
MDG Technology SDK 1092 topic.

5.1.4.1 Apply Stereotypes

Enterprise Architect enables you to apply one or more stereotypes to any UML construct, including:
· Elements (such as Classes and Objects)
· Relationships (such as Dependencies and Associations)
· Association Ends
· Attributes and Operations
· Operation Parameters.
To apply a stereotype to any UML construct, using the Properties dialog, select any one of the following steps:

1. In the Stereotype field, type the stereotype(s) to apply as a comma-separated list.

2. Click on the drop-down arrow and select the required stereotype from the list.
3. Click on the [ ... ] button to use the Stereotype Selector 897 dialog.

To apply a stereotype to an element using the Properties window, select any of the following steps:

1. In the Stereotype field, type the stereotype(s) to apply as a comma-separated list.

2. Click on the drop-down arrow and select the required stereotype from the list.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 897

3. Select the browse other stereotypes... option in the drop-down list to use the Stereotype Selector 897
dialog.

5.1.4.2 Stereotype Selector

The Stereotype Selector dialog enables you to apply one or more stereotypes 896 to a UML construct, from
multiple stereotype sources such as Profiles or the Custom Stereotypes list. The appearance of the stereotype
is influenced by the stereotype visibility 898 settings on the Diagram Properties dialog.

Select Stereotypes to Apply/Remove

1. On the element or connector Properties dialog, click on the [ ... ] button near the Stereotype field. The
Stereotype for:<object type> dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 898 Modeling Languages | Standard UML Models

2. Click on the Profile drop-down arrow and choose the required stereotype source.
3. In the Stereotypes list, enable or disable the required stereotype by selecting or deselecting the
checkbox against it.
4. Click on the OK button to apply the selection.
You can also define a new stereotype to apply to the required construct by clicking on the New... button and
entering the name of the new stereotype when prompted.

5.1.4.3 Stereotype Visibility

You control the visibility of applied stereotypes using three options in the diagram Properties 423 dialog.
Select:
· The Show Element Stereotypes checkbox to show or hide all element stereotypes in the current diagram
· The Show Feature Stereotypes checkbox to show or hide all attribute and operation stereotypes in the
current diagram
· The Use Stereotype Icons checkbox to display icons, instead of strings, for those stereotypes that have
icons defined.
The example below shows how a Class would appear having multiple stereotypes applied to it:
Use Stereotype Icons disabled: displays all the applied stereotypes in a comma-separated string within
gullimets.

Use Stereotype Icons enabled: displays icons for those stereotypes with icons defined. Stereotypes without
icons defined are still displayed in the comma-separated string.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 899

5.1.4.4 Standard Stereotypes

Below is a list of standard element stereotypes (as provided in the EABase.eap base model), each enclosed
by guillemets (« »):

Stereotype Base Class

«access» Permission

«become» Flow

«call» Usage

«copy» Flow

«create» Message

«derive» Abstraction

«destroy» Message

«document» Abstraction

«executable» Abstraction

«facade» Package

«file» Abstraction

«framework» Package

«friend» Permission

«global» AssociationEnd

«implementation» Class

«implementation» Generalization

«import» Permission

«instantiate» Usage

«invariant» Constraint

«library» Abstraction

«local» AssociationEnd

«metaclass» Class

«parameter» AssociationEnd

«postcondition» Constraint

«powertype» Class

«precondition» Constraint

© 1998-2010 Sparx Systems Pty Ltd

 900 Modeling Languages | Standard UML Models

Stereotype Base Class

«process» Classifier

«refine» Abstraction

«requirement» Comment

«responsibility» Comment

«self» AssociationEnd

«send» Usage

«stub» Package

«table» Abstraction

«thread» Classifier

«trace» Abstraction

«type» Class

«utility» Classifier

5.1.4.5 Stereotypes with Alternative Images

You can alter the appearance of elements using stereotypes. This does not apply to elements that include
Lifelines, such as those in Sequence diagrams.
If the stereotype has an associated metafile, when the stereotype is applied to a Class or other element that
supports alternative graphical format, Enterprise Architect then draws the alternative image instead of the
standard one.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 901

5.1.5 UML Patterns

What is a Pattern?
Patterns are a group of collaborating Objects/Classes that can be abstracted from a general set of modeling
scenarios. They are also known as parameterized collaborations.
Patterns are an excellent means of achieving re-use and building in robustness. As patterns are discovered in
any new project, the basic pattern template from previous engagements can be re-used with the appropriate
variable names modified for the current project.
Patterns generally describe how to solve an abstract problem, and it is the task of the pattern user to modify
the pattern elements to meet the demands of the current engagement.
Before using a pattern it must first be created 902 as a standard UML diagram and then saved as an XML
pattern file. This XML file can then be imported 904 as a UML resource that can be used 904 in any model.

Sparx-Created GoF Patterns

To get you started with design patterns in Enterprise Architect, Sparx Systems provides you with an MDG
technology 1083 for the patterns described in the book Design Patterns - Elements of Reusable Object-Oriented
Software by Gamma et al., referred to as the 'Gang of Four' or GoF. These patterns are made available
through a set of Toolbox 399 pages.
The pattern elements are drawn from the EABase.eap file, through the Resources window hierarchy.
Therefore, if you are developing your model in a DBMS repository (or you inadvertently delete the GoF
patterns from your .eap file) you can download them as a 'zip' file from www.sparxsystems.com/uml_patterns.
html.
Because the patterns are drawn from the Resources window, if you delete a pattern in the Resources window
the equivalent Toolbox item cannot work. Therefore, if you cannot drop a pattern element from the Toolbox,
check that it is still available in the Resources window.

© 1998-2010 Sparx Systems Pty Ltd

 902 Modeling Languages | Standard UML Models

5.1.5.1 Create a Pattern

To create a Pattern you first must model the Pattern as a standard UML diagram within Enterprise Architect.
The following diagram was created from an example in the GoF book Design Patterns - Elements of Reusable
Object-Oriented Software by Gamma et al.

Notes:
· In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Manage Diagrams 198 permission to save a
diagram as a Pattern.
· If your source diagram contains information flows, the Information Items Conveyed and Information Flows
Realized data is not copied into the Pattern.

Save a Diagram as a Pattern

To save a diagram as a Pattern, follow the steps below:
1. Select the Diagram | Save UML Pattern menu option. The Save Diagram as UML Pattern dialog
displays.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 903

2. In the Pattern Name field, type the Pattern name.

3. In the Filename field, type a directory path and .XML filename into which to save the Pattern.
4. In the Category field, type the Category under which the Pattern should be listed in UML Patterns
(required).
5. In the Version field, type the Pattern version number, and in the Notes field type any notes on the
Pattern.
6. Select the actions for the elements that are contained in the Pattern by selecting the appropriate
checkboxes. These actions are performed when the Pattern is used (for more detail refer to the Use a
Pattern 904 topic). The available actions are:
· Create: Creates the Pattern element directly without modification
· Merge: Merges the Pattern element with an existing element, enabling the existing element to take
on the role of the selected Pattern element
· Instance: Creates the Pattern element as an instance of an existing element
· Type: Creates the Pattern element types as an existing element.

Notes:
· If your Pattern includes an Object element, you would use Instance to set the classifier of the Object
to one of the Classes in the diagram onto which you are dropping the Pattern.
· If your Pattern includes a Property (Port or Part) you would use Type to set the type of the Property
to one of the Classes in the diagram onto which you are dropping the Pattern.

7. To change the name of one of the elements, double-click on the element to display the Edit dialog.
From this dialog you can also add comments detailing the element's purpose.

© 1998-2010 Sparx Systems Pty Ltd

 904 Modeling Languages | Standard UML Models

8. Click on the OK button twice to save the Pattern. Once saved you can load it 904 into Enterprise
Architect as a Pattern in the Resources 667 window.

5.1.5.2 Import a Pattern

Before using a previously created Pattern 902 file in a UML model, you must first import it into the model; it is
then available from the Resources window and optionally from the Toolbox. To import a UML Pattern you have
previously saved, follow the steps outlined below:
1. Select the Resources window.
2. Right-click on the UML Patterns node. The context menu displays.
3. Select the Import UML Pattern menu option. The Select UML Pattern Import Filename dialog displays.
4. Locate the XML file to import.
5. Click on the Open button to import the Pattern.
The imported Pattern is placed in the appropriate category as defined in the XML file. If the category does not
already exist under UML Patterns, a new one is created.
Gang of Four patterns are integrated with Enterprise Architect in the EABase.eap file. However, if you create
your model in a DBMS repository (or you inadvertently delete the patterns from your model .eap file) you can
use the above procedure to download examples of the Gang of Four patterns from the GoF Patterns zip file on
the Sparx Systems website.

5.1.5.3 Use a Pattern

Using a Pattern enables you to use items defined in the Pattern with the UML model. Using Patterns enables
you to rapidly create template solutions for code structures that perform the same type of task in other
situations.
To use a Pattern that you have previously imported 904 into the model, follow the steps below:
1. Open the diagram into which to add the UML Pattern.
2. Select the Resources window.
3. Expand the UML Pattern folder and find the Pattern to add.
4. Either:
· Right-click on the Pattern and select the Add Pattern to Diagram context menu option or
· Drag and drop the Pattern from the Resources window onto the diagram.
(You can also view the Pattern details in read-only mode by selecting the View Pattern Details context
menu option.)

The Add Pattern dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 905

Panel Use to

Preview Display a preview of the Pattern; click on the Preview link to open a view of the
Pattern and drag the sides into as large a picture as you require.

Pattern Access the individual elements contained in the Pattern.

Elements
From here you can:
· select the action for the individual element (Create, Merge, Instance or Type, as
applicable for each element) by clicking on the drop-down arrow, or
· modify the default of the Pattern element (see below) or - for a merged element -
choose the namespace, by clicking on the [ ... ] button on the right of the Default
entry.

Element Notes Display the comments that describe the element in the Pattern. Highlight an
element in the Pattern Elements panel to view the notes.

5. Once the appropriate selections have been made, click on the OK button to import the Pattern into the
model, recreating the original diagram with new GUIDs.

Modify Pattern Element Default

To change the default of the Pattern element, follow the steps below:
1. From the Add Pattern dialog select the individual element in the Pattern Element panel.
2. Click on the [ ... ] button to display the Edit dialog. The specific method for changing the element name
is dependant upon the entry in the Action column of the Pattern Elements panel.
3. If the Action entry is Create, then in the Default field in the Edit dialog delete the existing value and
type your own, user-defined value. Click on the OK button. The element default is updated on the Add
Pattern dialog.
4. If the Action entry for the element is Merge, in the Edit dialog click on the [ ... ] button to browse to an

© 1998-2010 Sparx Systems Pty Ltd

 906 Modeling Languages | Standard UML Models

existing element classifier. The Select <Item> 515 dialog displays.

5. Locate and select an existing element classifier. You can restrict the number of choices by selecting the
elements from a specific namespace; to do this, click on the In Namespace drop-down arrow and
select a namespace. For more information regarding setting element classifiers see the Using
Classifiers 520 topic.

5.1.6 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 912 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 907 for loading and working with different Profiles.
UML Profiles for Enterprise Architect are specified in XML files, with a specific format; see the examples 915 in
this section. You can import 908 these XML files into Enterprise Architect as part of an MDG Technology 1066 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 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 542 topic.

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.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 907

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 the MDG Technology SDK 1092 topic.

5.1.6.1 Use Profiles

This topic describes the use of Profiles for UML modeling, including the following tasks:
· How to import a UML Profile 908 for use in a model
· How to add Profile Objects and Features to a diagram 909
· Use of Tagged Values in Profiles 910
· How to synchronize stereotyped Tagged Values and constraints 910

A Technology Developer might create a new Profile, which they can save (export) to disk for future UML

© 1998-2010 Sparx Systems Pty Ltd

 908 Modeling Languages | Standard UML Models

models. The processes of creating 1095 and exporting 1106 a new UML Profile are described in the MDG
Technology SDK 1092 topic.

5.1.6.1.1 Import a UML Profile

Note:
This topic describes importing a stand-alone Profile. You can also embed Profiles in an MDG Technology 1118

and import 1146 the Technology file into the Enterprise Architect installation directory.

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 | Other Project Tools | 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.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 909

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

5.1.6.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 Toolbox 399 (click on the More tools option at the top of the Toolbox).
Similarly, when you import an MDG Technology 1066 , 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.

© 1998-2010 Sparx Systems Pty Ltd

 910 Modeling Languages | Standard UML Models

5.1.6.1.3 Tagged Values in Profiles

Stereotypes within a UML Profile can have one or more associated Tagged Values. When you create an
element based on a UML Profile Stereotype by dragging from the Resources window to a diagram, any
associated Tagged Values are added to the element as well. Tagged Values and Profiles are an excellent way
to extend the use of Enterprise Architect and the power of UML modeling.
For example, in the UML Profile for XSD, there is an XSDComplexType stereotype, which has the following
Tagged Value declaration:
<TaggedValues>
<Tag name="mixed" description="Determines whether this element can contain mixed element and character content.
See the W3C XML Schema recommendation"/>
<Tag name="modelGroup" description="Overrides the package-level default model group" values="all | sequence |
choice" default="choice"/>
<Tag name="memberNames" description="Overrides the package-level default for naming complexType definitions"/>
</TaggedValues>
When you create an element from the XSDComplexType stereotype (by dragging from the Profile Elements
page of the Toolbox onto a diagram), the Tagged Values are added automatically.

Tagged Values that have default values are automatically set and displayed in the element tags section, if
applicable. When you select the element, the Tagged Values window displays all the associated tags,
including ones that have no value set. Also note that Tagged Values in the Profile that have a Values section
(for example, values="element | attribute | both" default="both") enable you to select the non-default values
from a drop-down list. (See the enum Tagged Value Type in the Predefined Structured Types 1166 topic.)
Where no Value list exists, the tag accepts free text.

5.1.6.1.4 Synchronize Tagged Values and Constraints

When you create an element, attribute, operation or link from a UML Profile item, you add the Tagged Values
and constraints from the Profile. Over time you might modify the constraints or the notes and tags of the
Tagged Values of a particular profiled item, so the items already created might be missing additional Tagged
Value tags and notes, or constraints.
Similarly, you might have manually set the stereotype on a set of elements and now want them to receive the
Tagged Values and constraints associated with that stereotype.
To make sure you have all the related Tagged Values and constraints, use the Synch Tagged Values and
Constraints function. This operates in two ways:
· If the Profile was created in an MDG Technology File and is not held in the Resources window
· If the Profile is held in the Resources window.

Synchronize Items In MDG Technology File

When an MDG Technology file is deployed in Enterprise Architect, the Profile is accessed through the Toolbox
pages also defined in the file. The profiled elements in these Toolbox pages automatically trigger an additional
context menu option, Synchronize Stereotype.
The MDG Technology can be an in-house customized Add-In, or an external technology such as those
provided with Enterprise Architect; for example, BPMN 1.1.
To synchronize elements created using the MDG Technology pages of the Toolbox, follow the steps below:
1. Open a diagram containing elements to be synchronized. Ensure that the Toolbox displays pages
containing the stereotyped profile elements from the MDG Technology.

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 911

Note:
The diagram does not necessarily have to contain profiled elements. The function operates from the
Toolbox. However, you might prefer to see the immediate effect of the synchronization on element
properties and Tagged Values, by opening an appropriate diagram at the start.

2. Right-click on the element profile in the Toolbox (for example, the BPMN 1.1 Activity element). The
Toolbox context menu displays.
3. Click on the Synchronize Stereotype menu option. The Synch Profiled Elements dialog displays.

4. Click on the OK button to proceed. The Actions list is populated with the items that have been modified
and the changes that were made.
You can review any changes by displaying the element Properties dialog and by opening the Tagged Values
window and clicking on an appropriate profiled element.
You can also quickly synchronize the tags and constraints of a single element in a diagram by dragging the
updated profile element from the Toolbox page onto the element in the diagram. Select the Apply
«stereotype» context menu option.

Synchronize Items In Resources Window

To synchronize elements created using a Profile in the Resources window, follow the steps below:
1. Locate the required UML Profile in the Resources window.
2. Locate the stereotyped profile element.
3. Right-click on it to display the context menu, and select the Synch Tagged Values and Constraints
option. The Synch Profiled Elements dialog displays.

4. Click on the OK button to proceed. The Actions list is populated with the items that have been modified
and the changes that were made.

© 1998-2010 Sparx Systems Pty Ltd

 912 Modeling Languages | Standard UML Models

5.1.6.2 Profile References

UML Profile XML File Format Information

Enterprise Architect provides a facility to import pre-defined elements, operations, attributes and connectors
as a source of re-useable components that meet common modeling requirements (such as profiles for XML
schema and for business process modeling). This topic provides a quick list of the types of data that can be
pre-defined and the characteristics of each type.
This topic gives you a reference to:
· Supported Types 912 of stereotype with Tagged Values and/or constraints
· Profile Structure 913
· Supported Attributes 914
· Example of the XML file that constitutes a Profile 915

5.1.6.2.1 Supported Types

A UML profile is made up of one or more stereotypes that might have Tagged Values and constraints. The
table below and the Supported Attributes 914 table define what can be stereotyped and what information must
be supplied.

List of All Supported Types in AppliesTo/Apply Node

AppliesTo / Apply Type Tags Constraint Metafile

"actor" Element Yes Yes Yes

"package" Package Yes Yes Yes

"usecase" Element Yes Yes Yes

"collaboration" Element Yes Yes Yes

"class" Element Yes Yes Yes

"table" Element Yes Yes Yes

"component" Element Yes Yes Yes

"node" Element Yes Yes Yes

"object" Element Yes Yes Yes

"sequence" Element Yes Yes Yes

"entity" Element Yes Yes Yes

"screen" Element Yes Yes Yes

"GUIElement" Element Yes Yes Yes

"requirement" Element Yes Yes

"state" Element Yes Yes

"activity" Element Yes Yes Yes

"interface" Element Yes Yes Yes

"event" Element Yes Yes

"issue" Element Yes Yes

"change" Element Yes Yes

"hyperlink" Element Yes

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 913

AppliesTo / Apply Type Tags Constraint Metafile

"attribute" Attribute Yes Yes

"operation" Operation Yes Yes

"association" Connector Yes Yes

"associationEnd" AssociationEnd

"generalization" Connector Yes Yes

"dependency" Connector Yes Yes

"transition" Connector Yes Yes

"objectflow" Connector Yes Yes

"startnode" Element Yes Yes

"stopnode" Element Yes Yes

"note" Element Yes Yes

"decision" Element Yes Yes

"aggregation" Connector Yes Yes

5.1.6.2.2 Profile Structure

UML Profiles for Enterprise Architect are distributed in XML format. The file has the following format:

General Header Details

<?xml version="1.0" encoding="utf-8" ?>
<UMLProfile profiletype="uml2">
<!--Profile name, version number and general notes -->
<Documentation id="XSDSchema" name="UML Profile for XSD Schema" version="1.0" notes="Defines a set of
stereotypes and tagged values for XSD Schemas"/>
<!-- The profile content -->
<Content>
<!-- List of stereotypes used in this profile. Can also include tagged values, constraints, metafile and descriptive
comments-->
<Stereotypes>

Stereotype Definitions
The header is followed by one or more Stereotype definitions; for example:
<!-- «XSDComplexType» -->
<Stereotype name="XSDComplexType" notes="ComplexType definition generated in XML Schema">
<AppliesTo>
<Apply type="class"/>
</AppliesTo>
<TaggedValues>
<Tag name="mixed" description="URI to unique target namespace"/>
<Tag name="modelGroup" description="Default model group used when generating complexType definitions for this
Schema" values="all | sequence | choice" default="choice"/>
<Tag name="attributeMapping" description="Default for generating UML attributes as elements, attributes or both
within complexTypes" values="element | attribute| both" default="both"/>
<Tag name="roleMapping" description="Prefix associated with namespace"/>
<Tag name="memberNames" description="Schema version"/>
</TaggedValues>

<Constraints>
<Constraint name="" type="" notes=""/>
</Constraints>
</Stereotype>
Note the specification of Stereotype name and notes. Also note the use of Tagged Values to set properties for
the Profile element. The Tagged Values can have a default value, can be empty and can specify enableable

© 1998-2010 Sparx Systems Pty Ltd

 914 Modeling Languages | Standard UML Models

values. Tagged Values are edited in the Properties window of an element, method, attribute or connector.
You can also specify the default size, default comment and Metafile for drawing an element; see the fragment
below:
<Stereotype name="Router" cx="130" cy="100" notes="" metafile="router.emf">
In the above example, the metafile shape for this element is specified as 'router.emf'; when you load this Profile,
the .emf file must be in the same directory as the Profile, otherwise the load fails.
Also note how to specify a default comment for an element. All white space between lines is ignored. To force
a line break, use the \n character. To force tabs, use \t.
<Comment>
Some text here about how this works\n\t
with comments being imported from the XML description
in one long row.
</Comment>
The example above would import like this:
Some text here about how this works
with comments being imported from the XML description in one long row.

5.1.6.2.3 Attributes Supported in XML Profile

The table below lists the three main types of object you can define for the main XML element nodes in an XML
Profile document. These are the:
· Stereotype, which creates a visible entry in the UML Profile folder in the Resources window
· Tagged Values, which are additional properties that an element or connector support
· Constraints that apply to the model element.

Type Attribute Optional Notes

stereotype cx Yes Deprecated. Initial x coordinate of element.

cy Yes Deprecated. Initial y coordinate of element.

_image Yes Shape script definition.

_imageFile Yes Deprecated. Location of image file (.wmf).

metafile Yes Filename of associated metafile; this MUST be in the same directory
as the Profile XML.

name No Stereotype name.

notes Yes Notes visible in browser.

_sizeX Yes Initial width of the element, in pixels at 100% zoom.

_sizeY Yes Initial height of the element, in pixels at 100% zoom.

tag default Yes A default value; for example, 'true'.

description Yes A description of the tag; appears in the tag tab and for elements in
the Properties window setting notes.

name No Tag name.

values Yes List of possible values; values separated by ' | ' (<space>|<space>);
for example, 'true | false'. For elements, populates the drop combo in
the tag section of the docked Properties window.

constraint name Yes Constraint name.

notes No Additional explanatory notes.

type Yes Constraint type (for example, 'pre' for precondition, 'post' for
postcondition).

Enterprise Architect User Guide

 Modeling Languages | Standard UML Models 915

5.1.6.2.4 Example Profile

Below is an example UML Profile showing the structure and use of the file:

<?xml version="1.0" encoding="UTF-8"?>

<UMLProfile>
<Documentation id="EAExample" name="UML Profile for Example" version="1" notes="An example set of
stereotypes and tagged values"/>
<!-- The profile content -->
<Content>
<!-- List of stereotypes used in this profile-->
<Stereotypes>
<!--A profile is a list of stereotypes, that apply to elements, connectors and features in a UML
model. Stereotypes can have set tagged values, constraints,
Valid targets, default dimensions. The examples below are a good starting point -->
<Stereotype name="SimpleStereotype" notes="Place notes about stereotype here"
metafile="router.emf">
<!-- Place a list of types that this will apply to ...
valid types are any UML element (class, interface, component,
aggregation, generalization, association, transition, operation and attribute. Make sure
you use lowercase names, XML is case sensitive-->
<AppliesTo>
<Apply type="class"/>
<Apply type="interface"/>
<Apply type="node"/>
</AppliesTo>
<!--Add one or more tagged values for this stereotype. These are automatically added
to the target element when created
Note that you can specify a default value using "default=" and a pick list of values for
example " true | false" note the use of a " | " to separate values -->
<TaggedValues>
<Tag name="hasNamespace" description="Indicates element is bound to
Namespace" default="true" values="true | false"/>
<Tag name="targetNamespacePrefix" description="Prefix associated with
namespace"/>
</TaggedValues>
<!-- Zero or more constraints to apply to element - specify name, type and notes -->
<Constraints>
<Constraint name="constraint1" type="pre" notes="My Notes"/>
</Constraints>
</Stereotype>
<!-- End of stereotype. When writing your own, you can duplicate a stereotype selection as
above and
change it to start work on a new stereotype-->
<!-- «AnotherExample» -->
<Stereotype name="AnotherExample" cx="130" cy="100" notes="This element has a default
height and width specified">
<AppliesTo>
<Apply type="class"/>
<Apply type="operation"/>
<Apply type="attribute"/>
</AppliesTo>
<TaggedValues>
<Tag name="memberNames" description="Schema version"/>
</TaggedValues>
<Constraints>
<Constraint name="constraint1" type="pre" notes="My Notes"/>
</Constraints>
</Stereotype>
<!-- «Aggregation» -->
<Stereotype name="aggregationLink" type="weak" notes="">
<AppliesTo>
<Apply type="aggregation"/>
</AppliesTo>
</Stereotype>
<!-- «Composition» -->
<Stereotype name="compositionLink" type="strong" notes="">
<AppliesTo>
<Apply type="aggregation"/>
</AppliesTo>
</Stereotype>
<!-- «IndexKey» -->
<Stereotype name="UniqueID" notes="">
<AppliesTo>
<Apply type="operation"/>

© 1998-2010 Sparx Systems Pty Ltd

 916 Modeling Languages | Standard UML Models

</AppliesTo>
<TaggedValues>
<Tag name="indexed" description="indicates if indexed or not" values="true
| false" default="true"/>
</TaggedValues>
<Constraints>
<Constraint name="constraint1" type="pre" opType="pre" notes="My Notes"/
>
<Constraint name="constraint2" type="pre" opType="post" notes="My
Notes"/>
</Constraints>
</Stereotype>
<!-- «Attribute» -->
<Stereotype name="attname" notes="">
<AppliesTo>
<Apply type="attribute"/>
</AppliesTo>
<Constraints>
<Constraint name="constraint1" type="pre" notes="My Notes"/>
</Constraints>
</Stereotype>
<!-- «Association» -->
<Stereotype name="assocname" notes="">
<AppliesTo>
<Apply type="association"/>
</AppliesTo>
<Constraints>
<Constraint name="constraint1" type="pre" notes="My Notes"/>
</Constraints>
</Stereotype>
</Stereotypes>
</Content>
</UMLProfile>

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 917

5.2 Specialized UML Models

Enterprise Architect provides specific modeling tools for a range of specialized model types, supporting:
· Requirements modeling 917
· Business modeling 930
· Business Rule modeling 934
· BPMN modeling 952
· BPEL modeling 958
· Systems engineering 986 (with SysML)
· Data modeling 1011
· XML Schema modeling (XSD) 1039
· Web Service modeling (WSDL) 1049
· SPEM 1061
· Various other modeling languages such as Archimate, SoaML and ICONIX, as MDG Technologies 1066

available in the Enterprise Architect install directory

· The use of other technologies from file or internet sites. 1070

5.2.1 Requirements

Introduction
This section describes the Enterprise Architect Requirements Management facilities, and discusses:
· What requirements are
· How requirements are generated and organized
· How Enterprise Architect supports and simplifies Requirements Management.
Additional discussion of the management of requirements in Enterprise Architect can be found in the
Requirements Management with Enterprise Architect white paper on the Sparx Systems website.

What is a Requirement?
Requirements are essentially what the system, application or business process is required to do. A
requirement can be broad and high level, defining - for example - a need for a process to update a particular
database. A requirement can also be more specialized and detailed, recording the expectation that - for
example - a system call must always be acknowledged by return. Detailed requirements can be organized into
a hierarchy culminating in a high-level requirement, so that satisfying each of the detailed requirements results
in meeting the higher-level requirements and ultimately the top-level requirement. This hierarchical structure
helps manage the complexity of large systems with thousands of requirements and many processes being
developed to implement the requirements.

Gathering Requirements
Gathering requirements is typically the first step in developing a solution, be it for developing a system or a
process. Requirements are gathered from all parties expected to use, maintain or benefit from the solution,
and are organized into groups, functional areas and hierarchies as necessary. They can be transcribed into a
spreadsheet or a requirements gathering or management tool, or they can be created in an integrated
modeling tool such as Enterprise Architect.

Requirements Management and Enterprise Architect

The management of requirements is one of the more problematic disciplines in software development, for
reasons such as:
· Diverse group input into the requirements
· Organizational boundary divisions

© 1998-2010 Sparx Systems Pty Ltd

 918 Modeling Languages | Specialized UML Models

· Tool boundary divisions

· Volatility of requirements
· Imprecision and ambiguity in natural languages.
These can cause issues with:
· Traceability and
· Integration with change and configuration management systems.
Enterprise Architect can reduce or eliminate these problems in Requirements Management; it is one of the few
UML tools that integrate Requirements Management with other software development disciplines in the core
product, by defining requirements within the model. Within Enterprise Architect, you can:
· Create 918 and view 928 requirements as entities and properties directly in the model
· Collate the requirements in an external CSV file and then import 922 them into your model
· Detail use cases 924 and scenarios directly in the model
· Enter standard attributes 919 (properties) for each requirement, such as difficulty, status and type, and
define your own attributes 920 (properties)
· Trace 928 requirements to Use Cases, business rules, test cases and analysis artifacts (using, for example,
the Relationship Matrix 1261 )
· Trace and view the impact of changes 928 on requirements (through, for example, the Traceability 1253
window) and review the changes 928 themselves
· Create customer-quality MS Word and HTML reports 929 on requirements.

Note:
All of these features are illustrated by examples in the EAExample.eap model, provided as part of your
Enterprise Architect installation in the Enterprise Architect Program Files directory:
..\Program Files\Sparx Systems\EA

5.2.1.1 Create Requirements

Within Enterprise Architect you can create external Requirement elements in a number of ways, such as:
· Dragging a Requirement icon from the Toolbox into a specific diagram (which also adds the Requirement
to the diagram's parent package - see below)
· Generating an element within a specific package in the Project Browser - see below
· Importing requirements from a spreadsheet application such as Excel, via CSV 922
· Creating Requirement elements on the Element List 1258 for the selected package or diagram
· Converting an internal responsibility 926 into an external element, in a selected target package
· Importing requirements from another requirements management tool, such as Telelogic DOORS (in this
case via the Sparx Systems MDG Link For DOORS integration tool).

Notes:
· The Requirement element name can be simply descriptive text, with or without a manually-typed reference
number. However, as requirements often have to have a unique reference for external checking, you can
use the Enterprise Architect auto-numbering 525 facility to automatically apply a numbering system with or
without prefixes and suffixes. Set the element type to Requirement.
· External Requirement elements can be displayed with or without an identifying E in the top right corner. To
toggle display of this letter, select or deselect the Show stereotype icon for requirements checkbox on
the Options dialog, Objects 362 page (Tools | Options | Objects).
· Requirement elements can be color coded to indicate their status; see the Color Code External
Requirements 920 topic.

Create Requirement Elements Within a Diagram

To create Requirement elements in a diagram, follow the steps below:
1. Open the Custom 417 pages on the Toolbox.
2. Drag the Requirement element onto the current diagram.
3. Enter the Name and other details 919 for the requirement.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 919

Enterprise Architect creates a Requirement element in the current diagram and in the diagram's parent
package.

Create Requirement Elements in Project Browser

To create a requirement directly in the Project Browser, follow the steps below:
1. Right-click on the required parent package to open the context menu.
2. Select the Insert | New Element menu option. Alternatively, press [Ctrl]+[M].
3. In the New Element dialog select the Requirement type.
4. Enter the Name (or select Auto) and click on the OK button.
Enterprise Architect creates a requirement in the current package.

5.2.1.1.1 Requirement Properties

Note:
In Requirement Management tools and texts, the characteristics of a requirement are commonly called
attributes. However, in UML the term attribute 558 refers to a different type of feature, and the requirement
characteristics are defined as properties. In this Enterprise Architect documentation, the term properties is
used.

Requirement properties differ slightly from the properties of other elements 481 ; they are mainly focused on the
type, status, difficulty and priority of the Requirement. The Notes field is also important, as it describes
precisely what requirement the element represents.
To edit the properties of a Requirement , double-click on the element in a diagram or right-click on it in the
Project Browser and select the Properties context menu option. The Requirement Properties dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 920 Modeling Languages | Specialized UML Models

If necessary, edit the name (Short Description) of the Requirement element, then type a detailed explanation
of the requirement in the Notes field at the bottom of the dialog. Set the Status, Difficulty, Priority and Type,
and other parameters as required.
You can add and delete Status field values, and assign a color to each value to indicate the status of the
Requirement on a diagram; for more information, see the Color Code External Requirements 920 topic.
When you have finished entering the Requirement properties, click on the OK button.
In a project, it might be necessary to define more information in a requirement than is provided by the
standard properties. For more information on extending the requirement properties, see the Extend
Requirement Properties 920 topic.

5.2.1.1.1.1 Color Code External Requirements

External requirements can be color coded to provide quick visual cues indicating the status of a requirement.
To enable color coded external requirements follow the steps below:
1. Select the Tools | Options menu option. The Options dialog displays.
2. From the hierarchical tree select Objects, and select the Show status colors on diagrams checkbox
to enable the status of external requirements to be represented by color coding.
The color code requirements use the following default conventions:
· Yellow for Proposed
· Blue for Approved
· Green for Validated
· Orange for Mandatory
· Black for Implemented.

You can change these colors, and add or remove status types, using the Status Types 653 dialog.

5.2.1.1.2 Extend Requirement Properties

A project might apply further properties to a requirement, such as cost, lateness penalty or risk to the business
if not met. You can add these properties to specific Requirement elements, or configure them to be
automatically available in all Requirement elements on creation, using Tagged Values 632 . (These are
sometimes referred to as User-defined attributes.)
Extended element properties are not visible unless you open the Tagged Values window for the element.
Alternatively, you can display the additional properties on the element image on its diagrams 921 .

Add Tagged Values to Existing Requirements

To add a property to a single Requirement as a Tagged Value, simply click on the Requirement, display the
Tagged Values window ([Ctrl]+[Shift]+[6]), and enter 635 the name of the property as the tag name and the
value of the property as the tag value.
It is likely that any property you add to one Requirement would also apply to others. You might therefore use a
predefined Tagged Value Type to identify your Requirement property, so that you can select it whenever
required. The predefined Tagged Value Type also enables you to define specific values for the Tagged Value.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 921

If the appropriate predefined Tagged Value Type does not exist, a Technology Developer can create it to add
to the structured tags 1168 , reference tags 1170 , or customized tags 1171 collections.

Configure Requirements to be Created With Extended Properties

If it is necessary to create all Requirements with the same extended set of properties, you can create a
Requirement Template diagram and either create a special Requirement that defines those properties (as
Tagged Values), or drag an existing Requirement with those properties onto the diagram. You then set the
Requirement Template diagram 542 as the template for all new Requirement elements, so that those new
Requirements automatically have all of the properties you need.
However, this then excludes other Requirement element formats, including the standard Requirement format.
If you want to use another Requirement format, you have to replace or cancel the current Template.
Alternatively, you can create a Profile.
A Profile also defines exactly what a new Requirement element should contain, and how it should display in
diagrams. However, a Profile is a collection of alternative element definitions, so it does not override the
default Requirement format, nor does it prevent you from defining several different types of Requirement
element. You can therefore have separate and parallel definitions of elements for business requirements,
system requirements, project requirements, or any other category of requirement you decide to work with.
For information on importing and using existing Profile files, see the UML Profiles 906 topic. For information on
creating new Profiles, see the Developing Profiles 1093 topic.

5.2.1.1.2.1 Display Tagged Values On Diagrams

If you have extended the properties of a Requirement, you might want to make those properties visible in the
Requirement elements in your diagrams, by switching on display of the element tags compartment. You can
do this in one of two ways:
· To display the tags compartment on all elements on a diagram, double-click on the diagram background
and select the Elements 426 tab of the Diagram Properties dialog; select the Tags checkbox and click on
the OK button.
· To display the tags compartment on a specific element on a diagram, right-click on the element and select
the Feature Visibility 438 context menu option; select the Tags checkbox in the Show Element
Compartments panel of the Feature Visibility dialog, and click on the OK button.
The Tagged Values are then displayed in the Requirement element on the diagram.

5.2.1.1.3 Connect Requirements

A Requirement element can be connected to other Requirements, most commonly using Aggregate
relationships 854 to form a hierarchy of requirements.
Requirements are also connected to other types of element, most commonly Use Cases, by Realize or
Implements 889 relationships.
These relationships are very important, both in identifying how the Requirements are organized and used in
the model, and in tracing 928 the development from the Requirements throughout the model. Both of these
tasks are very simple in Enterprise Architect, because once a connector on a Requirement exists, Enterprise
Architect automatically lists the Requirement in the:
· Requirements Traceability 1253 window (an important tool in examining the role of Requirements in the
model)
· Requirements 485 tab of the target element Properties dialog
· Scenarios & Requirements 514 window
· Relationships Window 1269

© 1998-2010 Sparx Systems Pty Ltd

 922 Modeling Languages | Specialized UML Models

· Dependency 1624 and Implementation reports 1626

· Standard RTF output 1569 .

The connector itself is also listed in the Links 489 tab of the target element Properties dialog, and in the
Relationship Matrix 1261 . There are, therefore, many ways to locate, view and track Requirement relationships.

Connect On Diagram
Relationships can be created on a diagram by clicking on the appropriate connector icon from the
Requirement 418 and Common 405 pages of the Toolbox, clicking on the source (originating) element, and
dragging to the target element.
If you are connecting elements in different packages, you can drag elements from the Project Browser onto a
common diagram and set up the relationships there. Alternatively, you can quickly generate a Realize
connector by dragging an existing Requirement element from the Project Browser over the element that
implements the Requirement. Enterprise Architect interprets this as a request to create the Realize connector
and does so automatically. The Requirement element is not added to the diagram. However, if you
subsequently drag the Requirement onto the diagram the connector is already in place.

Connect Off Diagram

You can also connect a Requirement element to other elements without necessarily having the elements on
the same diagram, or having a diagram open.
Use the Relationship Matrix to create relationships 1266 for requirements; this is a convenient way of quickly
building up complex relationships and hierarchies.

5.2.1.1.4 Import Requirements and Hierarchies in CSV

You can import Requirements from a spreadsheet application in CSV 305 format. Before doing this you must
create a CSV import file specification 300 that:
· In the Default Types field has the value requirement,package to import requirements and a package
structure to contain them
· Has the Preserve Hierarchy checkbox selected
· Identifies the data fields on the spreadsheet that are to be translated into Enterprise Architect, in the order
in which they are plotted across the spreadsheet
· Is to operate on a spreadsheet containing the CSV_KEY and CSV_PARENT_KEY fields 302 (which, if not
generated by a CSV export from Enterprise Architect, you have added and populated yourself).
This enables you to import the individual and grouped requirements from the spreadsheet into Enterprise
Architect, and to reconstruct the hierarchies of Requirements in the target package in the Project Browser.

5.2.1.2 Model Requirements

Represent Requirements
In Enterprise Architect, a requirement can be modeled as an:
· External Requirement 846 - an expectation of the system or process, what the system or process must
provide, modeled as an element; for example, a business requirement or a stakeholder request -
Requirements at this level have their own properties and are reported on separately in RTF reports

· Internal requirement 925 – a responsibility of an existing element, what the element must do or accomplish,
defined as a property of the element.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 923

Requirements Management in Enterprise Architect is primarily concerned with external Requirement elements
and the elements that implement or realize them.

Requirements in the Model

Requirement elements can be grouped and organized within Requirements diagrams 736 . The Requirement
elements are connected to each other by Aggregate relationships to form a hierarchy:

It is quite usual to develop a package of many hundreds of Requirement elements, arranged individually and
in hierarchies of varying complexity. In the Project Browser you can use the Turn On Level Numbering 1215
facility to highlight the order and arrangement of the Requirements quickly and easily. The following illustration
shows a number of Requirements in a package, where Level Numbering makes the order and arrangement
clear:

© 1998-2010 Sparx Systems Pty Ltd

 924 Modeling Languages | Specialized UML Models

If elements are added, moved or deleted from the package, the numbering automatically adjusts.

Note:
This numbering can also be applied in the RTF report generator 1578 using the LevelNumber field in the
Element section – {Element.LevelNumber}.

Use Cases
Requirements are implemented (realized) by model elements such as Use Cases, Classes, Interfaces and
Components. There are many ways to trace 1245 either the Requirement for the feature or service modeled by
the elements, or the elements that develop the requirement, most visibly in Traceability 1250 diagrams that
depict the Requirements and the model elements connected 921 by Realize relationships. The Realize
connector enables members of the project team to keep design objectives and development in tandem, and
the development path and purpose clear.

The more usual realization relationship is between a Requirement and a Use Case. A Requirement can be
realized by one or more Use Cases, and a Use Case can realize one or more Requirements.
Whilst a Requirement defines a condition that must be met, the Use Case 806 is the key to defining and
visualizing how that condition is met. A Use Case diagram 676 depicts the logical grouping of actions,
processes and components to achieve a required result, and through the use of Actor 757 elements also
defines the user and/or system roles participating in the process.
Each Use Case (as a composite element 837 ) can contain a combination of child diagrams that define in
greater detail how a particular activity or facility might be implemented - such diagrams include Sequence 706 ,
Communication 715 , Activity 674 , State Machine 678 and Business Rule Flow 939 diagrams. The actual
implementation of each Use Case is realized by Class, Component and Interface elements organized in their
own diagrams. These realizations can also be captured and viewed in Traceability diagrams, depicting the full
development pathway from initial requirement through to testing and production.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 925

5.2.1.2.1 Internal Requirements

Internal requirements in Enterprise Architect are element responsibilities. They are defined on the
Requirements 485 tab of the element Properties dialog.

Internal requirements form the functional requirements of the system to be built. The meaning of the
requirement can vary depending on which element is the host; for example, a business process requirement
might mean something different to a Use Case requirement, which again might mean something different to a
Class requirement. In the example above, an internal responsibility to enable the user to login to the system
has been defined for the Login Use Case. This is a responsibility of the Use Case - an action it is responsible
for carrying out - and it applies only to this Use Case.
The significant parameters (or, in Requirement Management terms, attributes) are the Type, Status, Difficulty
and Priority. Whilst you can provide a detailed description of the responsibility in the Notes field, there is more
scope in the name (Requirement field) to define the nature of the responsibility. An additional field, Stability,
indicates the probability of the requirement changing; high stability means a low probability of change.
The example Use Case above also has connections to two external requirements, which are system functions
that the Use Case implements either in full or in part. You can convert 926 an internal responsibility into an
external requirement.
You can also create internal responsibilities for an element using the Scenarios & Requirements 514 window.
A responsibility created in the window displays in the element Properties dialog, and vice versa.

© 1998-2010 Sparx Systems Pty Ltd

 926 Modeling Languages | Specialized UML Models

5.2.1.2.1.1 Make Internal Requirement External

Elements in Enterprise Architect have internal requirements, or responsibilities (what they must do or
accomplish). These often overlap or duplicate more formal requirements that the system in general must
meet. You can move internal requirements to external requirements in one go using the Move External
function.

Procedure
If you have defined an internal requirement for an element and want to move it out (where it can perhaps be
implemented by multiple elements), follow the steps below:
1. Double-click on the element in a diagram or in the Project Browser to open the element Properties
dialog.
2. Click on the Requirements tab.
3. Locate and highlight the requirement.
4. Click on the Move External button. The Browse Project dialog displays.

5. Select the package to place the new requirement in.

6. Click on the OK button.
Enterprise Architect creates a new Requirement element in the target package and automatically generates a
Realization connector from the element to the Requirement.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 927

Notice the requirement is now marked external and the dialog fields grayed out. To edit its details 919 , double-
click on the requirement.
Also notice that a Requirement element has been created in the target package.

5.2.1.3 Manage Requirements

One of the main advantages of managing Requirements in Enterprise Architect is that you can display many
different aspects of information on the Requirements, from overall organization and location through lists,
current status, general properties, detailed individual notes and specific properties, to relationships and
dependencies with other elements in the model.
As most of these aspects are displayed in dockable windows, you can review the Requirements from several
different perspectives simultaneously in the Enterprise Architect work area, as shown below:

This display shows the position of the Store User Details Requirement element in the model, and how it
relates to other Requirements (Project Browser); the default characteristics of the Requirement (Element List)
and the extended characteristics (Tagged Values window), and a detailed description of the Requirement (
Notes window). You can configure some of these windows to display more information, and/or use other
windows and facilities.
Brief descriptions of appropriate screens and their use are provided in the following topics:
· View Requirements 928
· Trace Use of Requirements 928
· Manage Requirement Changes 928

· Report on Requirements 929

© 1998-2010 Sparx Systems Pty Ltd

 928 Modeling Languages | Specialized UML Models

5.2.1.3.1 View Requirements

Use the following windows and facilities to: locate and list Requirement elements in the model; add, move and
delete the elements; display and edit the properties and characteristics of individual elements; and generate
reports on packages or specific elements.
· Project Browser 1209 - shows the content and structure of your model.
· Element List 1255 - lists the elements in a diagram or package, filtered and sorted according to the settings
you define; shows all or selected default properties of each element.
· (Requirements) 736 Diagram 396 - shows the arrangement of a group of Requirements, and can show
whether the elements are in the same package or different packages.
· Model Search 1231 - enables you to locate Requirements in general in the model, or specific Requirement
elements, according to the search criteria you use.
· Model Views 1222 - enables you to maintain links to commonly-used elements, and to rapidly show
developments and changes in (Requirement) package contents through either reports or slide shows of
selected diagrams.
· Properties 508 - shows every standard property of a selected element, whether updated by the user or
maintained automatically by the system.
· Tagged Values 632 - shows extended properties of a selected Requirement element.
· Element Browser 510 - shows every added-on property, such as attributes, operations, Tagged Values and
constraints.
· Notes 641 - displays the detailed description of a requirement, and any other additional information
recorded on the requirement.

5.2.1.3.2 Trace Use of Requirements

Having investigated the representation of requirements in your model, you might review either how they have
been used to direct development through the model, or how a particular development was initiated. This is
discussed in greater detail in the Traceability 1245 topics, but the windows and facilities you might use to follow
development from Requirements are briefly described below. The significant feature in tracing Requirements
and development is the connectors 921 between the elements.
· Relationships 1269 window - quickly identifies every relationship of which a selected Requirement element is
a member, and the partner element in that relationship, whether or not the relationship is visible in the
current diagram. If the partner element is not in the diagram, you have the option of adding it.
· Traceability 1253 window 1253 - a very useful tool in showing chains of relationships that include the selected
element. The window can show, for example, that a Requirement A is realized by a Use Case X, but Use
Case X also realizes Requirement B, which in turn is also realized by Use Case Y. You can control the type
and extent of these relationship chains, but as the system checks the connectors and partner elements of
every relationship within the limits you impose, the system can take some time to produce the final results.
· Relationship Matrix 1261 - a significant tool in mapping the relationships between the Requirements
elements in a package and other elements in either that package or a different package. Where a
relationship is missing, you can add it; if an existing relationship is misplaced, you can delete it.
· Properties 481 dialog, Requirements 485 tab - for elements other than Requirements (particularly Use
Cases), shows all internal responsibilities and external requirement elements attached to the element.
· Scenarios & Requirements 514 window - as for the Properties dialog, shows the Requirements and
responsibilities of the selected element, and the scenarios and constraints under which the Requirements
are being realized.

5.2.1.3.3 Manage Requirement Changes

Because requirements are statements of what a system or process must do or provide, they have a great
impact on the modeling and development of the system. A new requirement might initiate an extensive
program of work, and changes to or removal of that requirement can therefore have a major effect on the
model. Issues concerning requirements, and changes to Requirements, must both be carefully managed.
The first steps in managing changes to requirements would be to raise specific Issue and Change request
items against the Requirement element. You could monitor the appearance of these items using the filtered
searches of the Model Views. You might then review 928 the Requirement properties and/or its relationship
hierarchies. During model development, you might capture periodic Baselines and use these to review the
changes and, if necessary, roll them back to a previous point. You might also use the Auditing facility to
monitor changes as they are made, and to ensure that no unauthorized or potentially risky changes are being
made in the model.
These facilities are briefly discussed below.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 929

Changes and Issues

A change is, very broadly, an item defining an addition or alteration to a requirement. An issue identifies either
a failure to meet a requirement, or a risk in meeting the requirement.
Changes and issues can arise in development at a number of levels, being raised for problems that apply
system-wide down to within a specific element. There are two mechanisms that can be used to identify a
change or issue, and the work required to resolve it:
· Change 1564 and Issue 1563 (or Defect) elements - structured comments that identify a problem at system-
level, although they can also be attached to a specific element from which a problem arises. Both types of
element resemble the Requirement element, and can be linked to one or more other elements that have to
be reviewed, with relationships such as Association, Dependency and Realize. The two types of element
can also form hierarchies or groups, where complex problems arise.
· Maintenance items 1558 raised against a specific element, and recorded for that element in the Maintenance
1558 window. Maintenance items enable the distinction between Defects (a failure to meet a requirement)

and Issues (a risk factor that might affect satisfying the requirement). They also include Tasks, which
record work items associated with the element.
Maintenance items are very specific, but if there is a possibility of an item having a wider impact on other
elements or the system in general, you can translate the item 1561 into a Change or Issue element, or any other
type of element that best identifies the problem and its solution.

Model Views
Model Views 1222 are very useful for trapping changes and issues in the model, especially on Requirements.
You can set up searches to identify the appearance of new Change or Issue elements, or to detect changes in
the properties of the Requirement elements themselves.

Baselines
A Baseline 280 is a snapshot of a package or a model branch at a particular point in time, which you
determine. You can use the Baseline as a distribution mechanism for changes to the model, but the main use
is to enable you to compare the current model with a previous stage, and detect what changes have been
made since the Baseline was captured. If you do not want a change to remain in the model, you can roll the
affected elements back to the state they had in the Baseline. Therefore, if you maintain your requirements in a
specific package or branch, you can capture Baselines of the package and ensure that changes conform to
your change management process or, if not, can be reversed.

Auditing
The Auditing 270 facility enables you to capture any changes made to your model within the selection criteria
that you define. You can, for example, configure the Auditing facility to specifically record changes to
Requirement 273 elements. As auditing is continuously monitoring, you can detect changes as they are made,
and verify that they are acceptable. You can also store the log of changes, and review it later on. Note that you
cannot reverse the changes automatically, as you can with Baselines. You might therefore use Auditing to
identify changes that you will investigate more fully and - if necessary - reverse in a Baseline comparison.

5.2.1.3.4 Report on Requirements

Enterprise Architect provides two report generation facilities that enable you to output RTF reports and HTML
reports on your model structure and components. The RTF reporting facility 1569 is especially comprehensive,
and contains a number of features that provide particular support to Requirements Management:
· A requirements report template 1575 that extracts details of external requirements in the model; you can
copy and tailor this template for your particular needs.
· Options in the Element List 1258 and Model Search 1231 to generate RTF reports on selected (Requirement)
items from the collected information.
· The Implementation Report 1626 , which lists for a selected package the elements that require implementers,
together with any source elements in Realize 889 (Implements) relationships with those elements.
· The Dependency Report 1624 , which lists for a selected package any elements that are dependent on
another element for their specification. For example, a Use Case derives its specification from the
Requirement that it realizes.

© 1998-2010 Sparx Systems Pty Ltd

 930 Modeling Languages | Specialized UML Models

5.2.2 Business Models

Modeling the Business Process

Modeling the business process is an essential part of any software development process. It enables the
analyst to capture the broad outline and procedures that govern what it is a business does. This analysis
model 931 provides an overview of where the proposed software system being considered fits into the
organizational structure and daily activities. It can also provide the justification for building the system by
capturing the current manual and automated procedures that are to be rolled up into a new system, and the
associated cost benefit.
As an early model of business activity, it enables the analyst to capture the significant events, inputs,
resources and outputs associated with business process. By connecting later design elements (such as Use
Cases) back to the business process model through Implementation connectors, it is possible to build up a
fully traceable model from the broad process outlines to the functional requirements and eventually to the
software artefacts actually being constructed.
As the Business Process Model typically has a broader and more inclusive range than just the software
system being considered, it also enables the analyst to clearly map what is in the scope of the proposed
system and what is to be implemented in other ways (such as a manual process).

An Example
The example below demonstrates the kind of model that can be built up to represent a business process. In
this model, the goal of the business process is to take customer orders and to ship those orders out. A user
starts the process with an inquiry, which leads to the involvement of the Book Catalogue, Shopping Cart, on-
line pages and warehouse inventory. The output of significance to the business is a customer order.

The second half of the process model is to respond to a customer order and ship the required items. The
second process involves the warehouse inventory and shipping company, and completes when an order is
delivered to the customer.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 931

See Also
· Business Modeling and Business Interaction Diagrams 739

· Web Stereotypes 851

5.2.2.1 Analysis Models

This section discusses the development of analysis models to construct business processes. It describes:
· Process Modeling Notation 931
· Inputs, Resources and Information 931

· Events 932
· Outputs 932
· Goals 933
· A Complete Business Process 933

5.2.2.1.1 Process Modeling Notation

A business process model typically defines the following elements:
· The goal or reason for the process
· Specific inputs
· Specific outputs
· Resources consumed
· Activities that are performed in some order, and
· Events that drive the process.
The business process:
· Can affect more than one organizational unit
· Can have a horizontal organizational impact
· Creates value of some kind for the customer; customers can be internal or external.
A business process is a collection of activities designed to produce a specific output for a particular customer
or market. It implies a strong emphasis on how the work is done within an organization, in contrast to a
product's focus on what. A process is thus a specific ordering of work activities across time and place, with a
beginning, an end, and clearly defined inputs and outputs: a structure for action. The notation used to depict a
business process is illustrated below.

The process notation 846 implies a flow of activities from left to right. Typically an Event 932 element is placed
to the left of the process and the output to the right. To specifically notate the internal activities, Activity
elements 753 can be placed inside the process element.

The BPMN Profile

One popular notation and approach to business modeling is the Business Process Modeling Notation (BPMN).
This notation is specifically targeted at the business modeling community and has a relatively direct mapping
to UML through a BPMN Profile. Sparx Systems provides a built-in profile for BPMN 952 modeling in Enterprise
Architect.

5.2.2.1.2 Inputs, Resources and Information

Business processes use information to tailor or complete their activities. Information, unlike resources, is not
consumed in the process; rather it is used as part of the transformation process. Information can come from
external sources, from customers, from internal organizational units and could even be the product of other
processes. A resource is an input to a business process and, unlike information, is typically consumed during
the processing. For example, as each daily train service is run and actuals recorded, the service resource is

© 1998-2010 Sparx Systems Pty Ltd

 932 Modeling Languages | Specialized UML Models

'used up' as far as the process of recording actual train times is concerned.
The notation to illustrate information and resources is shown below.

A Supply connector indicates that the information or object linked to the process is not used up in the
processing phase. For example, order templates can be used over and over to provide new orders of a certain
style; the templates are not altered or exhausted as part of this activity.
An Input connector indicates that the attached object or resource is consumed in the processing procedure.
As an example, as customer orders are processed they are completed and signed off, and typically are used
only once per unique resource (order).

5.2.2.1.3 Events
An event 839 is the receipt of some object, a time or date reached, a notification or some other trigger that
initiates the business process. The event might be consumed and transformed (for example a customer order)
or simply act as a catalyst (for example, nightly batch job).

5.2.2.1.4 Outputs
A business process typically produces one or more outputs of value to the business, either for internal use or
to satisfy external requirements. An output might be a physical object (such as a report or invoice), a
transformation of raw resources into a new arrangement (a daily schedule or roster) or an overall business
result such as completing a customer order.
An output of one business process might feed into another process, either as a requested item or a trigger to
initiate new activities.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 933

An Output connector indicates that the business process produces some object (either physical or logical) that
is of value to the organization, either as an externally visible item or as an internal product (possibly feeding
another process).

5.2.2.1.5 Goals
A business process has some well defined goal. This is the reason the organization does this work, and
should be defined in terms of the benefits this process has for the organization as a whole and in satisfying the
business requirements.

A Goal connector indicates that the attached object to the business process describes the goal of the process.
A goal is the business justification for performing the activity.

5.2.2.1.6 A Complete Business Process

The diagram below illustrates how the various model elements can be grouped together to produce a coherent
picture of a named business process. Included are the inputs, outputs, events, goals and other resources that
are of significance.

© 1998-2010 Sparx Systems Pty Ltd

 934 Modeling Languages | Specialized UML Models

5.2.3 Business Rules

Note:
Business Rule Modeling is available in the Business and Software Engineering edition and Ultimate edition of
Enterprise Architect.

To model Business Rules in Enterprise Architect, you work through the following steps:
· Create a Rule model 935 to define business rules.
· Create a Business Domain model 938 , which provides the business vocabulary for defining business rules.
· Create a 939 Rule Flow 939 model 939 , which groups the rules for a specific task under a Rule Task, and
provides the order in which the business rules are executed.
· Model the rules in the Rule Composer 945 , which enables the rules to be transformed to a logical level of
detail.
· Validate 950 the rules in the Rule Composer.
· Generate code for the business rules 951 using Enterprise Architect's general code generation methods.
These steps are represented graphically in the following flow:

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 935

Create a Business Rule Model

You can create a Business Rule Model from a template provided with Enterprise Architect. To do this, follow
the steps below:
1. In the Project Browser, either:
· Click on the New Model From Pattern icon in the toolbar
· Right-click on a model root node and select the Add a New Model using Wizard context menu

© 1998-2010 Sparx Systems Pty Ltd

 936 Modeling Languages | Specialized UML Models

option, or
· Right-click on a package and select the Add | Add a New Model using Wizard context menu
option.
The Select Model(s) dialog displays.
2. In the Select From field, click on the drop-down arrow and select Business Rule Model. Alternatively,
if it is listed in the Technology panel, select the Business Rule Model item.
3. In the Name panel, select the checkbox next to the Business Rule Model icon.
4. Click on the OK button.

The following model structure is created in the Project Browser:

The Business Rules Model diagram, shown below, encapsulates the components of the Business Rules
model.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 937

5.2.3.1 Model Business Rules For RuleTasks

The Rule Model enables you to define Business Rule elements and associate them with a Rule Task. In the
example, you might define a set of rules to perform an eligibility check for a customer, to determine if the
customer is eligible to rent a car.
To do this, follow the steps below:
1. Create a diagram of type Rule Model. The Rule Model pages display in the Toolbox.

2. Drag and drop a Rule Task element (Eligibility in the example) from the Rule Flow Activity diagram
package onto the Rule Model diagram.
3. Drag as many Business Rule elements as necessary from the Toolbox (or Project Browser if they exist
already) onto the diagram. You type the rule as the element name here, then define the parameters of
the rules using the Rule Composer 945 .
4. Create a Dependency relationship between each Business Rule element and the Rule Task element.

Note:
However, when you bring the rule into the Rule Composer, it automatically creates the Dependency
relationship anyway.

5. Repeat steps 2 - 4 for the next Rule Task element.

© 1998-2010 Sparx Systems Pty Ltd

 938 Modeling Languages | Specialized UML Models

The resulting Rule Model resembles the following diagram:

After you have modeled rules for all the Rule Task elements in the Rule Flow diagram, the Business Domain
model is ready for code transformation 951 . The code templates for generating technology-specific rule code
work hand-in-hand with the EASL code templates 1193 to generate the code for the Rule Flow diagram.

5.2.3.2 Create a Business Domain Model

The Business Domain Model provides the business vocabulary - terms and facts - on which Business Rules
can be modeled. In Enterprise Architect a Business Domain model is created as a conceptual Class diagram.

Note:
When you create Classes in the Business Domain model, select the correct language for code generation to
ensure that the correct data type is set for attributes and operation parameters.
Business Rules code generation is supported for the following languages:
· C++
· C#
· Java
· VB.Net.

The following diagram shows an example Business Domain model, for a Car Rental system.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 939

In the example Business Domain model, the Classes Rent, Customer, Car and Application, together with their
attributes and operations, provide the terms for the business vocabulary. The Class Rental System processes
the rules. To make Rental System process the rules, you add a Rule Flow Activity 939 as a behavior for this
Class.
When you create a Rule Flow behavior (Activity) under a Class you can model the rules as Rule Tasks
(Actions). When code is generated the rule flow behavior is rendered as a method inside the corresponding
Class.
Alternatively, if you have existing operations in the Class that already suit the purpose, you can model
business rules in those operations 943 . When code is generated for the Class the rules logic is generated as
the method body for the corresponding operation.

5.2.3.3 Create a Rule Flow Model

You create a Rule Flow Activity as a behavior for a Class, to enable that Class to process a set of rules.
To add a Rule Flow Activity to a Class, follow the steps below:
1. On the Business Domain model diagram, right-click on the Class that processes the rules (in the
example, Rental System).
2. From the context menu select the Add | RuleFlow Activity menu option.
A new Rule Flow Activity with a Rule Flow diagram is created as a behavior for the selected Class. The Rule
Flow diagram models the sequence in which a series of Rule Tasks are executed.
Code generation for a Rule Flow model renders each RuleFlow Activity as a set of operations or methods.
Depending on what you want these methods to do, you might want to pass in some parameters to be used
within the Rule Flow Activity. See the Pass Parameters to Rule Flow Activity 942 topic.

Add a Rule Task

A Rule Task is a stereotyped Action that groups Business Rules for a specific task. You create Rule Task

© 1998-2010 Sparx Systems Pty Ltd

 940 Modeling Languages | Specialized UML Models

elements in a Rule Flow diagram using the associated Rule Flow pages of the Toolbox.

The following illustration is of a possible Rule Flow diagram for the car rental example.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 941

The Rule Task elements Eligibility, Determine Rent Payable, Determine Penalty and Determine Total Amount
Payable group the business rules for the specific task indicated by the element name. You then identify the
business rules 937 for each group.

Notes:
· In a Rule Flow diagram, every Decision Node has a matching Merge Node to ensure proper code
generation.
· For code generation, the Rule Task elements must be grouped inside the appropriate Rule Flow Activity in
the Project Browser. However, Rule elements can be defined anywhere in the model, as they can be used
in more than one Rule Task.

© 1998-2010 Sparx Systems Pty Ltd

 942 Modeling Languages | Specialized UML Models

5.2.3.3.1 Pass Parameters to Rule Flow Activity

To pass in parameters to be used within a Rule Flow Activity, follow the steps below:
1. In the Project Browser, double-click on the Rule Flow Activity. The element Properties dialog displays.
2. Click on the Behavior tab.
3. Click on the Edit Parameters button. The Parameters dialog displays.
4. Create and define 583 each parameter, setting Type and Default values.
5. Save each parameter and, when you have finished setting the parameters, close both dialogs.

The Rule Flow Activity parameters can be accessed by the Rule Tasks within the parent Rule Flow Activity. In
the following hierarchy, the parameters m_rent and m_application can be used by any of the Rule Tasks under
the ProcessApplication Rule Flow Activity.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 943

You can use the parameters as condition variables or action variables in the Business Rule Decision Table 945
, or as rule variables in the Computation Table 945 for any of the Rule Tasks. If the Activity parameter is not
accessible to a Rule Task, Enterprise Architect displays an error message.

5.2.3.3.2 Model Rules In an Operation

You can model business rules either in the Business Rule 937 elements attached to the Rule Task element in
a RuleFlow Activity 939 diagram, or in the operations of the rule Class in the Business Domain model 938 .
To model business rules for an operation:
1. Open the Properties dialog for the operation and, in the Stereotype field on the General tab, type the
value RuleTask.
2. In the Project Browser, right-click on the operation and select the Rule Composer option to open the
Rule Composer.
3. Model the rules for the operation 945 .

The operations appear in the Project Browser as shown below:

On code generation, the code for rules logic is generated in the method body.
When you drag and drop a RuleTask operation onto a Rule Flow diagram, an operation call behavior action
581 is created. To pass the parameters for this operation call, open the Properties dialog and select the Call
tab. Set the Behavior field to the operation to be called. Under the Arguments field, click on the Edit
Arguments button and edit the argument values 582 to be passed.
On the diagram, the call behavior actions for the RuleTask operations are indicated as shown below:

© 1998-2010 Sparx Systems Pty Ltd

 944 Modeling Languages | Specialized UML Models

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 945

5.2.3.4 Compose Business Rules

You use the Rule Composer to define a business rule written in plain text within a Business Rule element or
Class operation. The Rule Composer enables you to model conceptual-level business rules at a logical level
in tabulated format, which assists in transforming the rules to technology-specific rules (code 951 ).
You can also download 950 the contents of the Rule Composer to a spreadsheet application such as Microsoft
Excel, via a CSV 300 file.

Access The Rule Composer

To access the Rule Composer, right click on a Rule Task element and select the Rule Composer context
menu option. The Rule Composer displays in the central work area on its own tab.

The Rule Composer consists of:

· a Rule Statements list
· a Decision Table and
· a Computation Rule Table.
To assist with traceability, as the Rule Composer is completed, selections in one table automatically highlight
the corresponding rows and columns of the other tables. For example, If a Rule Statement is selected, the
related rule column in the Decision Table and row in the Computation Rule Table are highlighted. Similarly, if
a Computational Rule is selected, the corresponding column in the Decision Table and row in the Rule
Statements list are highlighted.

Rule Statements Table

The Rule Statements table lists the rules associated with the selected Rule Task. You add a rule to the table
by dragging an existing Business Rule element from the Project Browser onto an empty row in the Rule
Statements table. You cannot create new rules within the table.
To define a business rule associated with the selected Rule Task, follow the steps below:
1. For the first rule, select the text within the Business Rule element and drag it onto the empty row.
2. For a subsequent rule, click on the No column and select the Add Row context menu option. An empty

© 1998-2010 Sparx Systems Pty Ltd

 946 Modeling Languages | Specialized UML Models

row is added to the Rule Statements table.

3. Drag the required Business Rule element from the Project Browser onto the new row. If the Business
Rule element is not already on the diagram, this adds the element to the diagram and creates a
Dependency relationship between the Business Rule and Rule Task elements.

To remove a rule that is no longer required in the Rule Composer, right-click on the appropriate No field and
select the Remove Rule context menu option.

Note:
This removes the rule from the Rule Composer and deletes the Dependency relationship with the Rule Task
element. However, it does not remove the Business Rule element from either the diagram or the Project
Browser (where, in either case, it might be in use with other Rule Task elements).

Decision Table
The Decision Table enables you to model conditional rules (for example: Cars must not be rented to
customers of age less than 18).
The table has three sections:
· Rule Conditions – to model condition variables
· Rule Actions – to model action variables
· Rule Bindings – to link the rule in the rule table.

Rule Conditions Section

To model Rule Conditions, follow the steps below:
1. The Business Domain model defines the business terms (such as Customer) and their associated
attributes. From the appropriate Class element in the Project Browser, drag and drop the required
condition attribute (such as age) or operation (such as IsValidLicense()) onto the Rule Conditions
column.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 947

Notes:
· The Rule Condition field enables you to use intellisense to display a list of possible entries for the
field. Press [Ctrl]+[Spacebar] in the field to display the list of entries.
· If the Rule Condition is of type enum, the Allowable Values fields are automatically set with the
enum literals. The procedure then ends here.

2. Define a range of accepted values for the Rule Condition.

3. Right-click on the Allowable Values column and select the Edit Allowable Values context menu
option. The Edit Allowable Values dialog displays.

Type each required value or range of values in the Value field, and click on the Save button to display
the value in the Allowable Values list box; for example:

age could have the values:

<18
>18 and <50
>50

IsValidLicense() could return:

True
False
4. Click on the OK button to save the values and close the dialog. A new constraint AllowableValues is
created for the attribute.

Notes:
· You can check this constraint by opening the Properties dialog for the attribute and selecting the
Constraints tab.
· If the Rule Condition references an enumeration, the enum literals are not editable in the Edit
Allowable Values dialog.

5. If the Rule Condition is an operation, you can pass parameters to it. Right click on the Allowable
Values field, and select the Edit Parameters context menu option. The Edit Parameters dialog
displays. Select the parameters and type their values into the Value text box. Click on the OK button to
cancel the dialog.

© 1998-2010 Sparx Systems Pty Ltd

 948 Modeling Languages | Specialized UML Models

Note:
You can add an operation as a Rule Condition more than once, to allow calling the operation with
different sets of parameters.

To add another Rule Condition, right-click on the No column and select the Add Row context menu option. An
empty row is added to the table.
To remove a Rule Condition from the table, right-click on the appropriate No field and select the Delete Row
context menu option. This does not affect the original attribute or the new constraint in the model. You can
either re-use the attribute with its constraint, or use the attribute Properties dialog to remove the constraint.

Rule Actions Section

In the Rule Actions section, when a specific value of a Rule Condition calls an operation (such as post error)
or decision attribute (such as Eligible - Yes/No), you assign the operation or attribute as an action. To model
Rule Actions, follow the steps below:
1. From a business term Class element in the Project Browser, drag and drop the required attribute or
operation onto the Rule Actions field.

Note:
The Rule Actions field enables you to use intellisense to display a list of possible entries for the field.
Press [Ctrl]+[Spacebar] in the field to display the list of entries.

2. For an attribute, double-click on the Allowable Values/Parameters field. The Edit Allowable Values
dialog displays; type the range of values in the text box (such as Yes, No; or Accept, Reject), click on
the Save button and close the dialog. Select the appropriate response in the Result column fields.

Note:
If the dropped action variable is of type enum, the Allowable Values/Parameters fields are
automatically set with the enum literals.

3. For an operation, a checkbox displays in each of the Result column fields. To call the operation, select
the checkbox in the appropriate column.

To pass parameters to the operation, double-click on the Allowable Values/Parameters field. The Edit
Parameters dialog displays. Select the parameters and type the values into the Value text box. Click on
the Save button and close the dialog.

Note:
You can add an operation as a Rule Action more than once, to allow calling the operation with different
sets of parameters.

4. Click on the Save button in the Rule Composer toolbar to save the values.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 949

Note:
Alternatively, you can right-click on an Allowable Values/Parameters field to display a context menu with
two options:
· If the Rule Action is an attribute, the Edit Allowable Values option is enabled and this displays the Edit
Allowable Values dialog
· If the Rule Action is an operation, the Edit Parameters option is enabled and this displays the Edit
Parameters dialog.

To add another Rule Action, right-click on the No column and select the Add Row context menu option. An
empty row is added to the table.
To remove a Rule Action from the table, right-click on the appropriate No field and select the Delete Row
context menu option. This does not affect the original attribute or operation in the model.

Rule Bindings Section

The Rule Bindings section lies on top of the Rule Conditions section. It binds the Rule Condition and Rule
Action values to the appropriate rule in the Rule Table. To bind a rule, follow the steps below.
1. Select the rule number in the Rule Bindings field over one of the Value<n> or Result<n> columns.
2. Ensure that the values set in the Value<n> or Result<n> field for the Rule Condition or Rule Action,
underneath the rule number, all satisfy the rule.
3. Click on the Save icon in the Rule Composer toolbar.
For example, (referring to the screen diagram at the top of this Rule Composer topic) if rule 2 is Car must not
be rented to Customers of age less than 18:
· Select 2 in the Rule field over the Value1 column
· Select < 18 against Customer.age in the Value1 column in the Rule Conditions table
· Select No against Customer.Eligible in the Result1 column in the Rule Action table
· Select Reject against Application.Status in the Result1 column in the Rule Action table.

Computation Rule Table

The Computation Rule table enables you to model rules involving computations.

The table has the following columns:

· Computation Rule Actions
· Expression
· Rule Bindings
· Rule Dependency.
To define a computation rule, follow the steps below:
1. From the Project Browser, drag and drop the appropriate attribute from a Class in the Fact model into
the Computation Rule Actions field.

Note:
Both the Computation Rule Actions field and the Expression field enable you to use intellisense to
display a list of possible entries for the fields. Press [Ctrl]+[Spacebar] in the field to display the list of
entries.

© 1998-2010 Sparx Systems Pty Ltd

 950 Modeling Languages | Specialized UML Models

2. In the Expression field, type the expression to be evaluated.

3. In the Rule Bindings field, type the rule number from the Rule table of the rule being modeled, to link
the table data to the rule.
4. If the rule depends on another rule being satisfied first, type the number of that rule in the Rule
Dependency field.
5. Click on the Save icon in the Rule Composer toolbar to save the computation rule.
If the computation rule is also a Rule Conditions rule, add the condition variable in the Decision table and bind
the appropriate rule in the Rule Bind section.

Export Rules To CSV File

To export the contents of the Rule Composer to a CSV file, follow the steps below:

1. Click on the Export to CSV icon ( ) in the Rule Composer toolbar. The Windows Browser dialog
displays.
2. Browse to the required file location and type in a .CSV filename to export to.
3. Click on the Save button to export the data.

5.2.3.5 Validate Business Rules

It is recommended practice to validate the business rules in the Rule Composer before you generate code for
the Rule Task elements. To do this, click on the Validation (green tick) icon in the Rule Composer toolbar.

The business rules on the Rule Composer are parsed and any errors or warnings that might indicate
incomplete or unfavorable code generation are displayed on a Rule Composer Validation tab on the Output
screen. For example:

To highlight and investigate the faulty data in the Rule Composer, double-click on the appropriate warning or
error message.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 951

5.2.3.6 Code Generation For Business Rules

After you have modeled the business rules for all the Rule Task elements in the Rule Flow diagram, you can
generate code from the Rule Flow behavior.
To return a value from the Rule Flow behavior:
1. Double-click on the last Rule Task element before the end node of the Rule Flow diagram. The
element's Properties dialog displays.
2. Click on the Effect tab.
3. In the Effect field, type the return statement; for example, return true.
4. Click on the Save button, and on the OK button to close the dialog.
Generate code for the Class 1309 containing the rule flow behavior (in our initial example, Rental System 938 ).
The code for business rules logic is generated, with the rule statements expressed in natural language as
comments.
The following code snippet was generated from the Rental System Class element in our example:

///////////////////////////////////////////////////////////
// RentalSystem.cs
// Implementation of the Class RentalSystem
// Generated by Enterprise Architect
// Created on: 08-May-2009 2:39:23 PM
///////////////////////////////////////////////////////////

public class RentalSystem {

public Customer m_Customer;

public Car m_Car;
public Rent m_Rent;

public RentalSystem(){

~RentalSystem(){

public virtual void Dispose(){

/* Begin - EA generated code for Activities and Interactions */

public bool ProcessApplication(Rent m_rent,Application m_application)

{
// behavior is an Activity

/*CAR MUST NOT BE RENTED TO CUSTOMERS WITHOUT A VALID LICENCE NUMBER*/

if( m_Customer.ValidLicenceNumber == "FALSE" )
{
m_application.Status = "Reject";
m_Customer.Eligibile = false;
}
/*CAR MUST NOT BE RENTED TO CUSTOMERS OF AGE LESS THAN 18*/
if( m_Customer.age < 18 )
{
m_application.Status = "Reject";
m_Customer.Eligibile = false;
}
/*CAR MUST NOT BE RENTED TO CUSTOMERS WITH BAD HISTORY LEVEL 3*/
if( m_Customer.BadHistoryLevel == 3 )
{
m_application.Status = "Reject";
m_Customer.Eligibile = false;
}
if (Customer.Eligible == true)
{

/*RENT FOR SMALL CARS IS 80 AUD PER DAY*/

© 1998-2010 Sparx Systems Pty Ltd

 952 Modeling Languages | Specialized UML Models

if( m_Car.type == Small )

{
m_rent.RentPerDay = 80;
}
/*RENT FOR AWD CARS IS 100 AUD PER DAY*/
if( m_Car.type == AWD )
{
m_rent.RentPerDay = 100;
}
/*RENT FOR LUXURY CARS IS 150 AUD PER DAY*/
if( m_Car.type == Luxury )
{
m_rent.RentPerDay = 150;
}
/*RENT PAYABLE IS CALCULATED AS THE PRODUCT OF RENTPERDAY AND
RENTALPERIOD IN DAYS*/
m_rent.RentPayable = m_rent.RentPerDay * m_rent.No_of_rent_days;
if (CustomerBadHistoryLevel > 0)
{

/*PENALTY OF 20 % OF RENT MUST BE APPLIED FOR CUSTOMERS

WITH BAD HISTORY LEVEL 2*/
if( m_Customer.BadHistoryLevel == 2 )
{
m_rent.PenaltyFee = m_rent.RentPayable * 0.2;
}
/*PENALTY OF 10 % OF RENT MUST BE APPLIED FOR CUSTOMERS
WITH BAD HISTORY LEVEL 1*/
if( m_Customer.BadHistoryLevel == 1 )
{
m_rent.PenaltyFee = m_rent.RentPayable * 0.1;
}
}
else
{

/*TOTAL AMOUNT PAYABLE IS CALCULATED AS THE SUM OF RENT PAYABLE

AND PENALTY IF ANY.*/
m_rent.TotalAmountPayable = m_rent.RentPerDay + m_rent.PenaltyFee;
}
else
{

}
return m_application.Status;
}

/* End - EA generated code for Activities and Interactions */

}//end RentalSystem

5.2.4 BPMN Models

The following text is derived from the Business Process Modeling Notation entry in the online Wikipedia.
The Business Process Modeling Notation (BPMN) is a standardized graphical notation for drawing
business processes in a workflow. BPMN was developed by Business Process Management Initiative
(BPMI), and is now being maintained by the Object Management Group since the two organizations
merged in 2005.
The primary goal of BPMN is to provide a standard notation that is readily understandable by all
business stakeholders. These business stakeholders include the business analysts who create and
refine the processes, the technical developers responsible for implementing the processes, and the
business managers who monitor and manage the processes. Consequently BPMN is intended to serve
as common language to bridge the communication gap that frequently occurs between business
process design and implementation.
... The adoption of BPMN standard notation will help unify the expression of basic business process
concepts (e.g. public and private processes, choreographies) as well as advanced modeling concepts
(e.g. exception handling, transaction compensation).
BPMN ... supports only the concepts of modeling that are applicable to business processes ... other
types of modeling done by organizations for non-business purposes [are] out of scope for BPMN. For

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 953

example, ... modeling ... the following is not a part of BPMN:

· Organizational structures

· Functional breakdowns

· Data models
In addition, while BPMN shows the flow of data (messages) and the association of data artifacts to
activities, it is not a data flow diagram.
For further information on the concepts of BPMN, refer to the Wikipedia item and its linked sources.

Note:
The Enterprise Architect installer for releases later than 7.1 provides you with version 1.5 of MDG Technology
for BPMN, which supports BPMN version 1.1 and BPEL. This enables you to create and maintain diagrams in
the BPMN 1.1 and BPEL formats.
The installer also provides version 1.4.4 of MDG Technology for BPMN, which supports BPMN 1.0. This
enables you to maintain existing diagrams created in BPMN 1.0 format, and to create new diagrams in BPMN
1.0 if you want to maintain consistency through your project.
Enterprise Architect also enables you to migrate a BPMN 1.0 model (or part of a model) to BPMN 1.1 957 .

BPMN in Enterprise Architect

The BPMN notation is specifically targeted at the business modeling community and has a relatively direct
mapping to UML through BPMN Profiles integrated with the Enterprise Architect installer. Through use of
these profiles, Enterprise Architect enables you to develop BPMN diagrams quickly and simply. The BPMN
facilities are provided in the form of:
· A BPMN diagram type, accessed through the New Diagram 422 dialog
· BPMN pages in the Toolbox
· BPMN element and relationship entries in the Toolbox Shortcut 403 menu and Quick Linker 474 .

BPMN Toolbox Pages

You can access the BPMN pages of the Toolbox through the More tools | BPMN 1.0 and BPMN 1.1 menu
options. These pages provide the graphical (Core) and non-graphical (Types) BPMN elements for use on
business process diagrams.
Specifications of these elements and relationships are defined by Tagged Values (for example, to define the
Message, Timer and Default Path (/) symbols in the diagram below).
For further information on BPMN and Tagged Values, see the Change BPMN Element Appearance 956 topic.

© 1998-2010 Sparx Systems Pty Ltd

 954 Modeling Languages | Specialized UML Models

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 955

Page Item Use to

Core Business Process Extend a composite Activity that defines a business process.

BPEL Process Define the behavior of an executable or abstract business

process.

Activity Define an activity within a business process

Start Event Define the initiating event in a process.

Intermediate Event Define an intermediate event in a process.

End Event Define the terminating event in a process.

Gateway Define a decision point in a business process. If a condition is

true, then processing continues one way; if not, then another.

Pool Extend a Partition element to logically organize an Activity.

Lane Extend a Partition element to subdivide a Pool.

Data Object Extend an Artifact element to define a physical piece of

information used or produced by a system.

Group Extend a Boundary element to group other elements.

Text Annotation Create a comment.

Relationships Sequence Flow Extend a Control Flow relationship to define the flow of activity.

Message Flow Extend a Control Flow relationship to define the flow of

communications in the process.

Association Associate information and artifacts with flow objects.

Types Assignment

© 1998-2010 Sparx Systems Pty Ltd

 956 Modeling Languages | Specialized UML Models

Page Item Use to

Condition

Message
Define the properties (Tagged Values) of the Core BPMN 1.1
Participant elements such as Activities, Events and Gates.

Signal

Rule

Transaction

Web Service

Property

Disable BPMN
If you prefer not to use BPMN in Enterprise Architect, you can disable it (and subsequently re-enable it) using
the MDG Technologies 1069 dialog (Settings | MDG Technologies).

5.2.4.1 Change BPMN Element Appearance

To define the specifications of BPMN elements and relationships, open the Tagged Values window and select
the required element or relationship in a diagram. The Tagged Values window shows the appropriate Tagged
Values and provides a list of values to assign to each one.
Some Tagged Values directly affect the appearance of the elements they apply to, as described in the
following examples:
· Events - to change the decoration of a Start Event or Intermediate Event, set the Trigger Tagged Value; to
change the decoration of an End Event, set the Result Tagged Value. For example, to create a BPMN
'off-page' connector, set the Trigger or Result Tagged Value to Link to depict flow onto the diagram, into a
branch diagram or off the diagram for the Start, Intermediate and End events respectively.
· Gateways - to create the different varieties of Gateway, set the GatewayType Tagged Value; other display
options are available for XOR gateways - you can set the XORType Tagged Value to create Event-based
or Data-based XOR gateways, and for Data-based XOR gateways you can set the MarkerVisible Tagged
Value to false to hide the decoration.
· Activities - there is a wide variety of appearance options for Activities:
· The ActivityType Tagged Value can be set to Task or Sub-Process; the latter option displays the
'plus-in-a-box' decoration on the bottom edge of the shape
· An Ad-hoc Activity is shown by setting the AdHoc Tagged Value to true; this displays the 'tilde'
decoration on the bottom edge of the shape
· A Compensation Activity is shown by setting the IsCompensation Tagged Value to true; this displays
the 'rewind' icon on the bottom edge of the shape
· A Multiple Instance Activity is shown by setting the LoopType Tagged Value to MultiInstance; this
displays the 'pause' icon on the bottom edge of the shape
· A Loop Activity is shown by setting the LoopType Tagged Value to either Standard or MultiInstance
, this displays the 'loop' icon on the bottom edge of the shape.
· Transactions - to denote a Transaction with a double-lined border, set the IsATransaction Tagged
Value to true.
· Sequence Flows - to put a diagonal slash across the line at the source end, set the ConditionType Tagged
Value to Default; to put an unfilled diamond-shaped decoration at the source end, set the Tagged Value to
Expression.

Version Differences
Some BPMN elements have changed in appearance between BPMN version 1.0 and BPMN version 1.1.
In Enterprise Architect releases later than 7.1, if you work on a model created in an earlier release, using
BPMN 1.0, existing elements default to their version 1.0 appearance. New elements assume the BPMN

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 957

version 1.1 appearance and automatically have a Tagged Value BPMNVersion set to 1.1

If you want a new element to revert to the BPMN version 1.0 appearance, set the Tagged Value to 1.0.
Conversely, if you want an older element to assume the BPMN version 1.1 appearance, assign the
BPMNVersion Tagged Value to it, with the value 1.1.

5.2.4.2 Migrate BPMN 1.0 Model to BPMN 1.1

Note:
This facility is available from Release 7.5 of Enterprise Architect.

Enterprise Architect enables you to migrate a BPMN 1.0 model (or part of a model) to BPMN 1.1, using the
Automation Interface function MigrateToBPMN11() 1762 . This function updates the Tagged Values and, if
required, stereotypes to BPMN 1.1 for all elements, attributes, connectors and diagrams under the selected
package or element.

Warning:
In BPMN 1.0, various tags have free-text direct-entry value fields, and you can provide additional information
on these tags in the Tagged Value Note dialog for display at the bottom of the Tagged Values 632 window.
In BPMN 1.1, some of these tags (such as the Categories tag on a BusinessProcess stereotyped element)
have been changed to memo type, and you use the Tagged Value Note dialog to enter the value; therefore,
you cannot have additional notes for these tags, all information must be within the tag's value.
For such tags, when migrating from BPMN 1.0 to BPMN 1.1, the BPMN 1.0 tag value is moved into the BPMN
1.1 tag notes field and the BPMN 1.0 tag notes are discarded. If you want to preserve the tag notes text, take
a copy of the BPMN 1.0 model before migration to enable you to copy the tag notes text into the tag value
after migration.

The following VB script calls the MigrateToBPMN11() function to migrate the Tagged Values to BPMN 1.1:

Sub MigrateElement (sGUID, lngPackageID)

Dim proj as EA.Project

set proj = Repository.GetProjectInterface
proj.MigrateToBPMN11 sGUID, "BPMN"

'refresh the model

If lngPackageID<>0 Then
Repository.RefreshModelView (lngPackageID)
End If

End Sub

Sub MigrateSelectedItem

Dim selType
Dim selElement as EA.Element
Dim selPackage as EA.Package

selType = GetTreeSelectedItemType

If selType = 4 Then 'means Element

set selElement = GetTreeSelectedObject
MigrateElement selElement.ElementGUID, selElement.PackageID
MsgBox "Complete",0,"BPMN 1.1 Migration"

ElseIf selType = 5 Then 'means Package

set selPackage = GetTreeSelectedObject
MigrateElement selPackage.PackageGUID, selPackage.PackageID
MsgBox "Complete",0,"BPMN 1.1 Migration"

Else
MsgBox "Select a Package or Element in the Project Browser to initiate migration",0,"BPMN 1.1 Migration"

End If

© 1998-2010 Sparx Systems Pty Ltd

 958 Modeling Languages | Specialized UML Models

End Sub

Sub Main

MigrateSelectedItem

End Sub

Main

5.2.5 BPEL Models

Note:
Business Process Execution Language (BPEL) is supported in the Business and Software Engineering and
Ultimate editions of Enterprise Architect.

The following text is derived from the BPEL entry in the online Wikipedia :
Business Process Execution Language (BPEL), short for Web Services Business Process Execution
Language (WS-BPEL), is an executable language for specifying interactions with Web Services.
Processes in Business Process Execution Language export and import information by using Web
Service interfaces exclusively.
Web service interactions can be described in two ways :
1. Executable business processes, which model the actual behavior of a participant in a business
interaction.
2. Abstract business processes, which are partially specified processes that are not intended to be
executed. An Abstract Process may hide some of the required concrete operational details.
BPEL is an Orchestration language, serialized in XML, which specifies an executable process that
involves message exchanges with other systems. This messaging facility depends on the use of the
Web Services Description Language (WSDL) 1.1 to describe outgoing and incoming messages.
Although there is no standard graphical notation for WS-BPEL, Enterprise Architect uses BPMN version 1.1 as
a graphical front-end to capture BPEL 1.1 process descriptions. The BPMN specification includes an informal
and partial mapping from BPMN to BPEL 1.1.
For further information on the concepts of BPEL, refer to the Wikipedia item and its linked sources.

BPEL in Enterprise Architect

Enterprise Architect currently supports generating BPEL from executable processes. With the help of the
BPMN version 1.1 Profile, Enterprise Architect enables you to develop BPEL diagrams quickly and simply. The
BPEL facilities are provided in the form of:
· A BPEL Model Template in the Select Models 372 dialog
· A BPEL diagram type, accessed through the New Diagram 422 dialog
· A BPEL Process element in the BPMN 1.1 Core 952 Toolbox pages, which acts as a container from which
BPEL can be generated
· Custom dialogs for BPMN elements, highlighting the BPMN Tagged Values relevant to BPEL generation.

BPEL Example Generation

The Enterprise Architect Example file (EAExample.EAP) has a sample BPMN 1.1 model from which BPEL can
be generated. If you have installed Enterprise Architect at the default location, open this file:
C:\Program Files\Sparx Systems\EA\EAExample.EAP
The BPMN model package, within EAExample.EAP, is in: System Model -> Implementation Model (PSM) ->
BPEL Example.

Modeling Restrictions
· Use the elements from the BPMN 1.1 Toolbox pages for BPEL modeling.
· Every BPEL Process and Sub-Process should start with a StartEvent and end with an EndEvent.
· A StartEvent or an EndEvent should not be attached to the boundary of a Sub-Process.
· SequenceFlow Looping is not supported - only Activity looping is supported. All SequenceFlows should

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 959

flow downstream and not upstream.

· Mapping of an IntermediateEvent with multiple triggers to BPEL is not supported.
· Mapping of multi-instance parallel While loops to BPEL is not supported.
· Mapping of Independent sub-processes to BPEL is not supported.

See Also
· Create a BPEL Model 959
· Model a BPEL Process 961
· Model a Sequence Flow Connector 980

· Create Assignments 981

· Generate BPEL 983
· Create a BPEL Web Service 983
· BPEL Model Validation 984

5.2.5.1 Create a BPEL Model

You can create a BPEL model from the Project Browser, using the Select Model(s) 372 (Model Wizard) dialog.
To display the dialog, use one of the following methods:
· Click on the New Model from Pattern icon in the Project Browser toolbar
· Right-click on a model root node and select the Add a New Model using Wizard context menu option
· Right-click on a package and select the Add | Add a New Model using Wizard context menu option.
The BPEL model pattern is available in the Common catalog (in the Select From field, select Common).

BPEL Package Structure

Notice the BPEL Process (LoanApproval_Process) itself and the supporting components (SupportingElements
and Participant Pools).

© 1998-2010 Sparx Systems Pty Ltd

 960 Modeling Languages | Specialized UML Models

See Also
· Model a BPEL Process 961
· Model a Sequence Flow Connector 980

· Create Assignments 981

· Generate BPEL 983
· Create a BPEL Web Service 983

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 961

· BPEL Model Validation 984

5.2.5.2 Model a BPEL Process

The BPEL Process in Enterprise Architect represents the top-level container for the BPEL elements, from
which BPEL can be generated. Conceptually it maps to the BPEL process element.
To create a BPEL Process in your BPEL model, follow the steps below:
1. Open or create a BPEL diagram.
2. Open the BPMN 1.1 pages of the Toolbox (More tools | BPMN 1.1).
3. Drag a BPEL Process element from the Toolbox onto the diagram. The BPEL Properties dialog
displays.

4. In the Name field, type a name for the BPEL Process.

5. The Query Language field defaults to XPath 1.0. The Process Type field is pre-set to Private
(Enterprise Architect can generate BPEL from private processes only) and the Ad Hoc field is pre-set
to False.

Note:
Click on the UML button if you need to define further properties of the BPEL Process, using the normal
element Properties 481 dialog and Behavior 581 tab.

6. Click on the OK button to close the dialog.

To return to the BPEL Properties dialog for subsequent editing:

· Double-click on the element in the Project Browser (the Shows Properties 351 option must be selected in
the Double click on browser panel of the Options dialog) or
· Right-click on the element in the diagram or Project Browser and select the BPEL | BPEL Properties
context menu option.

The BPEL Process element is a stereotyped Activity that, when created, has a child diagram. Double-click on
the element to display the diagram, and use further elements from the BPMN 1.1 Core page of the Toolbox to
model the process; specifically:
· Start Event 962
· End Event 965
· Intermediate Event 968

· Gateway 972

© 1998-2010 Sparx Systems Pty Ltd

 962 Modeling Languages | Specialized UML Models

· Activity 974
· Pool 979 .

Note:
On the BPMN 1.1 Core page, the following elements are not mappable to BPEL:

· Pool
· Lane
· Data Object
· Group
· Text Annotation.

See Also
· Create a BPEL Model 959
· Model a Sequence Flow Connector 980

· Create Assignments 981

· Generate BPEL 983
· Create a BPEL Web Service 983
· BPEL Model Validation 984

5.2.5.2.1 Model Start Event

A Start Event indicates where a particular Process begins. Every Process in Enterprise Architect must begin
with a Start Event.
A Process can start in several ways, depending on the Trigger Type. The OMG BPMN 1.1 Specification
defines six types of Trigger:
· None
· Message
· Timer
· Conditional
· Signal
· Multiple
In Enterprise Architect, four of these Trigger types can be mapped to BPEL as per the OMG BPMN 1.1
Specification:
· Message
· Timer
· Conditional
· Multiple
To create a new Start Event in your model, follow the steps below:
1. Open a BPEL diagram created under a BPEL Process 961 .

2. Drag the Start Event element from the BPMN 1.1 Core page of the Toolbox onto the diagram. A prompt
displays to select either an edge-mounted event (on an element border) or a standalone event.
3. Click on either option. The BPEL Properties dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 963

4. In the Name field, type a name for the Event.

5. Click on the drop-down arrow in the Trigger Type field and select the required type.
Depending on the trigger type you select, further details might be required.
If you select Timer:
6. The Details tab changes as below:

7. In the Time Cycle field, type the value of the time cycle.
8. The Time Date field defaults to today's date. If it is necessary to change the date, click on the checkbox
and the drop-down arrow and select a new date from the calendar.

Note:
The Time Cycle and Time Date fields are mutually exclusive, so you can only set one of them.

9. Go to step 10.
If you select Message:
6. The Details tab changes, as below.

© 1998-2010 Sparx Systems Pty Ltd

 964 Modeling Languages | Specialized UML Models

7. To the right of the Web Service field, click on the [ ... ] button and select a BPEL web service 983 from
the list.
8. To the right of the Message field, click on the [ ... ] button and select a message from the list of all
messages in the selected web service.
9. Go to step 10.
If you select Conditional:
6. The Details tab changes, as below.

7. To the right of the Condition field, click on the [ ... ] button and select a Condition element from the list
of Condition elements created in the Supporting Elements package 959 .
8. Go to step 10.
If you select Multiple:
6. The Details tab changes, as below.

7. To the right of the Events field, click on the [ ... ] button and select further Start Events from the list of
events in this process that might trigger the process.
8. Go to step 10.
Resume the procedure:

10. Click on the Assignments tab.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 965

11. (Optional) To the right of the field, click on the [ ... ] button and select one or more Assignment elements
from the list of Assignments created 981 in the Supporting Elements package 959 .

Note:
Click on the UML button if you need to define further properties of the Start Event, using the normal
element Properties 481 dialog.
Alternatively, right-click on the element and select the Properties context menu option.

12. Click on the OK button to close the dialog.

To return to the BPEL Properties dialog for subsequent editing:

· Double-click on the element in the diagram or Project Browser (the Shows Properties 351 option must be
selected in the Double click on browser panel of the Options dialog) or
· Right-click on the element in the diagram or Project Browser and select the BPEL | BPEL Properties
context menu option.

5.2.5.2.2 Model End Event

An End Event indicates, where a particular Process ends. A Process can start in many ways, depending on
the Trigger Type, but every Process in Enterprise Architect must terminate with an End Event.
The OMG BPMN 1.1 Specification defines eight types of End Event (or Result), which determine the
consequence of reaching the End Event. These are:
· None
· Message
· Error
· Cancel
· Compensation
· Signal
· Terminate
· Multiple
In Enterprise Architect, five of these Result types can be mapped to BPEL, as per the OMG BPMN 1.1
Specification:
· Message
· Error
· Compensation
· Terminate
· Multiple

To create a new End Event in your model, follow the steps below:
1. Open a BPEL diagram created under a BPEL Process 961 .

2. Drag the End Event element from the BPMN 1.1 Core page of the Toolbox onto the diagram. A prompt
displays to select either an edge-mounted event (on an element border) or a standalone event.
3. Click on either option. The BPEL Properties dialog displays.
© 1998-2010 Sparx Systems Pty Ltd
 966 Modeling Languages | Specialized UML Models

4. In the Name field, type a name for the Event.

5. Click on the drop-down arrow in the Result Type field and select the required type.
Depending on the result type you select, further details might be required.
If you select Message:
6. The Details tab changes, as below.

7. To the right of the Web Service field, click on the [ ... ] button and select a BPEL web service 983 from
the list.
8. To the right of the Message field, click on the [ ... ] button and select a message from the list of all
messages in the selected web service.
9. Go to step 10.
If you select Error:
6. The Details tab changes, as below.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 967

7. In the Error Code field, type the required error code.

8. Go to step 10.
If you select Compensation:
6. The Details tab changes, as below.

7. To the right of the Activity field, click on the [ ... ] button and select an Activity from the list of all
Activities in the process.
8. Go to step 10.
If you select Terminate:
6. No action is required on the Details tab. Go to step 10.
If you select Multiple:
6. The Details tab changes, as below.

7. To the right of the Events field, click on the [ ... ] button and select further events from the list of events
in this process that might terminate the process.
8. Go to step 10.
Resume the procedure:

10. Click on the Assignments tab.

© 1998-2010 Sparx Systems Pty Ltd

 968 Modeling Languages | Specialized UML Models

11. (Optional) To the right of the field, click on the [ ... ] button and select one or more Assignment elements
from the list of Assignments created 981 in the Supporting Elements package 959 .

Note:
Click on the UML button if you need to define further properties of the End Event, using the normal
element Properties 481 dialog.
Alternatively, right-click on the element and select the Properties context menu option.

12. Click on the OK button to close the dialog.

To return to the BPEL Properties dialog for subsequent editing:

· Double-click on the element in the diagram or Project Browser (the Shows Properties 351 option must be
selected in the Double click on browser panel of the Options dialog) or
· Right-click on the element in the diagram or Project Browser and select the BPEL | BPEL Properties
context menu option.

5.2.5.2.3 Model Intermediate Event

An Intermediate Event indicates where an event occurs somewhere between the start and end of a process.
The OMG BPMN 1.1 Specification defines ten types of Intermediate Event (or Trigger). These are:
· None
· Message
· Timer
· Error
· Cancel
· Compensation
· Conditional
· Link
· Signal
· Multiple
In Enterprise Architect, six of these Trigger types can be mapped to BPEL.
· Message
· Timer
· Error
· Compensation
· Conditional
· Link (but not if the Intermediate Event is edge-mounted on an Activity).

To create a new Intermediate Event in your model, follow the steps below:
1. Open a BPEL diagram created under a BPEL Process 961 .

2. Drag the Intermediate Event element from the BPMN 1.1 Core page of the Toolbox onto the diagram. A
prompt displays to select either an edge-mounted event (on an element border) or a standalone event.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 969

Note:
When an Intermediate Event is created as a standalone event, it must have one incoming and one
outgoing SequenceFlow (except for a Link 971 Intermediate Event, which can have either incoming or
outgoing SequenceFlows, but not both).

3. Click on either option. The BPEL Properties dialog displays.

4. In the Name field, type a name for the Event.

5. Click on the drop-down arrow in the Trigger Type field and select the required type.
Depending on the trigger type you select, further details might be required.
If you select Message:

6. To the right of the Web Service field, click on the [ ... ] button and select a BPEL web service 983 from
the list.
7. To the right of the Message field, click on the [ ... ] button and select a message from the list of all
messages in the selected web service.
8. Go to step 11.
If you select Error:
6. The Details tab changes, as below.

7. In the Error Code field, type the required error code.

8. Go to step 11.
If you select Compensation:
6. The Details tab changes, as below.

© 1998-2010 Sparx Systems Pty Ltd

 970 Modeling Languages | Specialized UML Models

7. To the right of the Activity field, click on the [ ... ] button and select an Activity from the list of all
Activities in the process.

Note:
If the Compensation Intermediate Event is edge-mounted on an Activity, create a BPMN 1.1
Association connector from this Intermediate Event Activity to a Compensation Activity. Ensure that
the IsCompensation tag for the Activity is set to true.

8. Go to step 11.
If you select Timer:
6. The Details tab changes, as below:

7. In the Time Cycle field, type the value of the time cycle.
8. The Time Date field defaults to today's date. If it is necessary to change the date, click on the checkbox
and the drop-down arrow and select a new date from the calendar.

Note:
The Time Cycle and Time Date fields are mutually exclusive, so you can only set one of them.

9. Go to step 11.
If you select Conditional:
6. The Details tab changes, as below.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 971

7. To the right of the Condition field, click on the [ ... ] button and select an element from the list of
Condition elements created in the Supporting Elements package 959 .
8. Go to step 11.
If you select Link:
6. The Details tab changes, as below.

Note:
A Link Intermediate Event can be used as either a GoTo or an Off-page connector. Therefore this
Event can have either incoming or outgoing Sequence Flows, but not both.

7. Close the dialog, and drag a Sequence Flow connector from the Toolbox to create a connector either
from or to the appropriate Activity element.
8. If you have created an outgoing Sequence Flow from the Event to an Activity, no further details are
required.
9. If you have created an incoming Sequence Flow to the Event from an Activity, right-click on the Event
and select the BPEL | BPEL Properties context menu option. The BPEL dialog redisplays as shown
below:

10. To the right of the Link Event field, click on the [ ... ] button and select the target Link Intermediate
Event from the list.

Resume the procedure:

Note:
Click on the UML button if you have to define further properties of the Intermediate Event, using the
normal element Properties 481 dialog.
Alternatively, right-click on the element and select the Properties context menu option.

11. Click on the OK button to close the dialog.

To return to the BPEL Properties dialog for subsequent editing:

· Double-click on the element in the diagram or Project Browser (the Shows Properties 351 option must be
selected in the Double click on browser panel of the Options dialog) or

© 1998-2010 Sparx Systems Pty Ltd

 972 Modeling Languages | Specialized UML Models

· Right-click on the element in the diagram or Project Browser and select the BPEL | BPEL Properties
context menu option.

5.2.5.2.4 Model Gateway

Gateways control the way in which Sequence Flows 980 converge and diverge within a Process. They provide
a gating mechanism that either allows or blocks a Sequence Flow.
The OMG BPMN 1.1 Specification describes four types of Gateways:
· Exclusive (XOR)
· Inclusive (OR)
· Complex
· Parallel (AND)
In Enterprise Architect, three of these Gateway types can be mapped to BPEL, as per the OMG BPMN 1.1
Specification:
· Exclusive (XOR)
· Inclusive (OR)
· Parallel (AND)

Exclusive Gateway
An Exclusive Gateway represents a 'fork in the road'; that is, there can be two or more alternative paths but
only one can be taken. Therefore, each path is mutually exclusive (XOR). Exclusive Gateways can be one of
two types:
· Data-Based
· Event-Based

Data-Based Exclusive Gateway

This is the commonest type of Exclusive Gateway, where the boolean expression set in the
ConditionExpression Tagged Value of the outgoing Sequence Flow is evaluated to determine the flow path. In
Enterprise Architect:
· One of the outgoing Sequence Flows from the Gateway must have the ConditionType tag set to Default
and the ConditionExpression tag set to empty
· All other Sequence Flows must have the ConditionType tag set to Expression and the ConditionExpression
tag set to a boolean expression.
The Default condition on an outgoing Sequence Flow ensures that at least this path is taken if all others
evaluate to false.

Event-Based Exclusive Gateway

On this Gateway, the branching is based on the events (such as receiving a message) that occur at that point
in the Process, rather than the evaluation of an expression. As an example (from the OMG BPMN 1.1
Specification), when a company receives a response from a customer, they perform one set of activities if the
customer responds Yes and another set of activities if the customer responds No. The customer’s response
determines which path is taken. This Gateway maps to a BPEL Pick element. When modeling this Gateway:
· The outgoing Sequence Flow must have its ConditionType tag set to None
· The target of the outgoing Sequence Flow must be either an:
· Activity with TaskType tag set to Receive, or
· Intermediate Event with Trigger set to Message or Timer.
Note:
If an Activity is the target of one outgoing Sequence Flow, then the Intermediate Event with a
Message trigger must not be used.

Inclusive Gateway (OR)

With this type of Gateway, all the outgoing Sequence Flows with a condition that evaluates to true are taken.
In Enterprise Architect:
· One of the outgoing Sequence Flows from the Gateway must have the ConditionType tag set to default
and the ConditionExpression tag set to empty

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 973

· All other Sequence Flows must have the ConditionType tag set to Expression and the ConditionExpression
tag set to a boolean expression.
The Default condition on an outgoing Sequence Flow ensures that at least this path is taken if all others
evaluate to false.

Parallel Gateway (AND)

This Gateway provides a mechanism to create parallel flows. In Enterprise Architect, the ConditionType tag on
all the outgoing Sequence Flows from this Gateway must be set to None.

Create Gateway
To create a new Gateway element in your model, follow the steps below.
1. Open a BPEL diagram created under a BPEL Process 961 .

2. Drag the Gateway element from the BPMN 1.1 Core page of the Toolbox onto the diagram. The BPEL
Properties dialog displays.

3. In the Name field, type a name for the Gateway.

4. Click on the drop-down arrow in the Gateway field and select the required type.
5. If you have selected Inclusive or Parallel, no further details are required.
6. If you have selected Exclusive, in the Exclusive Type field click on the drop-down arrow and select the
sub-type - Data or Event.
7. If you have selected the sub-type Event, in the Instantiate field click on the drop-down arrow and select
either True or False.

Note:
Click on the UML button if you need to define further properties of the Gateway, using the normal
element Properties 481 dialog.
Alternatively, right-click on the element and select the Properties context menu option.

8. Click on the OK button to close the dialog.

To return to the BPEL Properties dialog for subsequent editing:

· Double-click on the element in the diagram or Project Browser (the Shows Properties 351 option must be
selected in the Double click on browser panel of the Options dialog) or
· Right-click on the element in the diagram or Project Browser and select the BPEL | BPEL Properties
context menu option.

© 1998-2010 Sparx Systems Pty Ltd

 974 Modeling Languages | Specialized UML Models

5.2.5.2.5 Model Activity

An Activity represents work that is performed within a Process. An Activity can be modeled as a:
· Sub-Process - a compound Activity that is defined as a flow of other BPMN elements or
· Task 975 - an atomic Activity that cannot be broken down into a smaller unit.
Activities - both Tasks and Sub-Processes - can also act as Looping constructs. The OMG BPMN 1.1
Specification defines two types of Looping construct:
· Standard Loops (while or until)
· Multi-Instance Loops (for each).
A Standard Loop has a boolean Condition that is evaluated after each cycle of the loop. If the evaluation is
True, then the loop continues. If Test Time is set to After, the loop is equivalent to a while loop. If Test Time is
set to Before, the loop is equivalent to an until loop.
A Multi-Instance Loop is equivalent to a for each loop and has a numeric expression as a Condition that is
evaluated only once before the Activity is performed. The result of the evaluation specifies the number of times
the loop is repeated.

Sub-Process
The BPMN Specification defines three types of Sub-Process:
· Embedded
· References
· Reusable.
In Enterprise Architect, two of these Sub-Process types can be mapped to BPEL:
· Embedded
· References.
To create a new Sub-Process Activity in your model, follow the steps below.
1. Open a BPEL diagram created under a BPEL Process 961 .

2. Drag the Activity element from the BPMN 1.1 Core page of the Toolbox onto the diagram. The BPEL
Properties dialog displays.

3. In the Name field, type a name for the Activity.

4. In the Type field click on the drop-down arrow and select the Sub-Process option.
5. In the Task Type field click on the drop-down arrow and select the Sub Process type - Embedded or
References.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 975

6. If you select Embedded, you do not have to set any other properties.
7. If you select References, the Details tab displays as follows:

8. To the right of the SubProcess field, click on the [ ... ] button and select a Sub-Process from the list of
all Sub-Processes in the BPEL process.

Note:
Click on the UML button if you need to define further properties of the Activity, using the normal
element Properties 481 dialog.
Alternatively, right-click on the element and select the Properties context menu option.

9. Click on the OK button to close the dialog.

To return to the BPEL Properties dialog for subsequent editing:
· Double-click on the element in the diagram or Project Browser (the Shows Properties 351 option must be
selected in the Double click on browser panel of the Options dialog) or
· Right-click on the element in the diagram or Project Browser and select the BPEL | BPEL Properties
context menu option.

Task
The OMG BPMN 1.1 Specification defines eight types of Task:
· Service
· User
· Receive
· Send
· Script
· Manual
· Reference
· None.
In Enterprise Architect, six of these Task types can be mapped to BPEL, as per the OMG BPMN 1.1
Specification:
· Service
· User
· Receive
· Send
· Reference
· None.
To create a new Task Activity in your model, follow the steps below.
1. Open a BPEL diagram generated under a BPEL Process 961 .

2. Drag the Activity element from the BPMN 1.1 Core page of the Toolbox onto the diagram. The BPEL
Properties dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 976 Modeling Languages | Specialized UML Models

3. In the Name field, type a name for the Activity.

4. In the Type field click on the drop-down arrow and select the Task option.
5. In the Task Type field click on the drop-down arrow and select the Task type.
Depending on the Task type you select, further details might be required.
If you select None:
6. No further details are required. Go to step 11
If you select Reference:
6. The Details tab changes, as below.

7. To the right of the Activity field, click on the [ ... ] button and select an Activity from the list of all Tasks
in the process.
8. Go to step 11.
If you select Send:
6. The Details tab changes, as below.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 977

7. To the right of the Web Service field, click on the [ ... ] button and select a BPEL web service 983 from
the list.
8. To the right of the Message field, click on the [ ... ] button and select a message from the list of all
messages in the selected web service.
9. Go to step 11.
If you select Receive:
6. The Details tab changes, as below.

7. To the right of the Web Service field, click on the [ ... ] button and select a BPEL web service 983 from
the list.
8. To the right of the Message field, click on the [ ... ] button and select a message from the list of all
messages in the selected web service.
9. In the Instantiate field click on the drop-down arrow and select True if this is the first Activity after the
Start Event 962 , otherwise select False.
10. Go to step 11.
If you select Service or User:
6. The Details tab changes, as below.

7. To the right of the Web Service field, click on the [ ... ] button and select a BPEL web service 983 from
the list.
8. To the right of the Input Message field, click on the [ ... ] button and select a message from the list of
all messages in the selected web service.

© 1998-2010 Sparx Systems Pty Ltd

 978 Modeling Languages | Specialized UML Models

9. To the right of the Output Message field, click on the [ ... ] button and select a message from the list of
all messages in the selected web service.
10. Go to step 11.

Resume the procedure:

11. (Optional) Click on the Assignments tab.

12. To the right of the field, click on the [ ... ] button and select one or more Assignment elements from the
list of Assignments created 981 in the Supporting Elements package 959 .
13. (Optional) Click on the Loop Details tab.

14. In the Type field click on the drop-down arrow and select the loop type - Standard or MultiInstance
(the field defaults to None).
15. In the Condition field, type the condition to be evaluated (boolean for a Standard loop, numeric
expression for a MultiInstance loop).
16. In the Min Value field, type the minimum value for the evaluation.
17. (Standard loop) In the Max Value field type the maximum value for the evaluation.
18. (Standard loop) In the Test Time field click on the drop-down arrow and select After to define a while
loop or Before to define an until loop.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 979

Note:
Click on the UML button if you need to define further properties of the Activity, using the normal
element Properties 481 dialog.
Alternatively, right-click on the element and select the Properties context menu option.

19. Click on the OK button to close the dialog.

To return to the BPEL Properties dialog for subsequent editing:

· Double-click on the element in the diagram or Project Browser (the Shows Properties 351 option must be
selected in the Double click on browser panel of the Options dialog) or
· Right-click on the element in the diagram or Project Browser and select the BPEL | BPEL Properties
context menu option.

5.2.5.2.6 Model Pool

A Pool represents a Participant 959 in a Process and does not map to any specific BPEL element. Enterprise
Architect uses Pools to represent external Participants, with which the BPEL Process communicates. These
are 'black box' pools; that is, they are abstract and do not expose any details (they do not contain any BPMN
elements inside them).
To create a new Pool in your model, follow the steps below.
1. Open a BPEL diagram created under a BPEL Process 961 .

2. Drag the Pool element from the BPMN 1.1 Core page of the Toolbox onto the diagram. The BPEL
Properties dialog displays.

3. In the Name field, type a name for the Pool element.

Note:
Click on the UML button if you need to define further properties of the Activity, using the normal
element Properties 481 dialog.
Alternatively, right-click on the element and select the Properties context menu option.

4. Click on the OK button to close the dialog.

To return to the BPEL Properties dialog for subsequent editing:

· Double-click on the element in the diagram or Project Browser (the Shows Properties 351 option must be

© 1998-2010 Sparx Systems Pty Ltd

 980 Modeling Languages | Specialized UML Models

selected in the Double click on browser panel of the Options dialog) or

· Right-click on the element in the diagram or Project Browser and select the BPEL | BPEL Properties
context menu option.

5.2.5.3 Model a Sequence Flow Connector

A Sequence Flow connector shows the order in which the activities (Tasks and Events) are performed in a
BPEL Process.

Create Sequence Flow

To create a new Sequence Flow connector in your model, follow the steps below.
1. Open a BPEL diagram created under a BPEL Process 961 .

2. Click on the Sequence Flow connector from the BPMN 1.1 Relationships page of the Toolbox, then click
on the start element and drag across to the target element on the diagram. Double-click on the
connector to display the Properties dialog.

If the Sequence Flow connector has a non-Gateway element as the start element, the Properties dialog
displays as shown below:

You cannot change anything on this dialog; go to step 5.

If the Sequence Flow connector has a Gateway 972 as the start element, the Properties dialog initially
displays as above but with the Assignments field enabled. An Activity 974 behaves as a Gateway if it is
the source for more than one Sequence Flow.
3. In the Condition group-box, in the Type field, either leave the value as None for the condition on the
connector, or click on the drop-down arrow and select Default (the ELSE in an IF...THEN...ELSE
statement) or Expression.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 981

Note:
If you select Expression: all fields are enabled and:
· You must type or browse for ([ ... ]) an expression value in the Expression field.
· (Optional) In the Ordering field, type a numerical value; for an Exclusive or Inclusive Gateway, the
order of outgoing flows is based on the value of this field.

4. (Optional) In the Assignments panel, click on the [ ... ] button and select one or more Assignment
elements from the list of Assignments created 981 in the Supporting Elements package 959 .

Note:
Click on the UML button if you need to define further properties of the connector, using the normal
Control Flow connector Properties 860 dialog.
Alternatively, right-click on the connector and select the ControlFlow Properties context menu option.

5. Click on the OK button to close the dialog.

To return to the BPEL Properties dialog for subsequent editing:

· Double-click on the connector in the diagram or
· Right-click on the connector in the diagram and select the BPEL | BPEL Properties context menu option.

5.2.5.4 Create Assignments

A BPMN Assignment element enables data to be copied between messages, and new data to be inserted,
using expressions within a BPEL Process. A BPMN Assignment element maps to a BPEL assign activity and
copies the specified value from the source to the target.
In Enterprise Architect, Assignment elements should be created in the Assignments package in
SupportingElements 959 . If they are created elsewhere, they cannot be enacted correctly.
To create a new Assignment in your model, follow the steps below:
1. Navigate to and open (or create, if necessary) the BPEL diagram under the Assignments package.
2. Open the BPMN 1.1 Types page of the Toolbox (More tools | BPMN 1.1).
3. Drag an Assignment element from the Toolbox onto the diagram. The BPEL Properties dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 982 Modeling Languages | Specialized UML Models

4. In the Name field, type a name for the Assignment.

5. In the Assign Time field, click on the drop-down arrow and select either Start or End. This determines
whether the assignment occurs at the start or end of an Activity.
In the Copy From panel:
6. In the Type field, click on the drop-down arrow and select either Literal, Expression or Message.
7. If you select Literal, the Literal field is enabled and the Message and Part fields are disabled. Type a
value in the Literal field.
8. If you select Expression or Message, the Literal field is disabled and the Message and Part fields are
enabled.

Note:
If you select Expression, Enterprise Architect uses the getVariableData Xpath 1.0 function to create
the expression from the selected Message and Part.

9. To the right of the Message field, click on the [ ... ] button and select a Message created under the
SupportingElements package.

Note:
Messages are created when you create a Web Service 983 .

10. (Optional) To the right of the Part field, click on the [ ... ] button and select a Message Property.
In the Copy To panel:
11. To the right of the Message field, click on the [ ... ] button and select a Message created under the
SupportingElements package.
12. To the right of the Part field, click on the [ ... ] button and select a Message Property. This field is
mandatory if you have entered a value in the Part field in the Copy From panel.
13. Click on the OK button to close the dialog.

To return to the BPEL Properties dialog for subsequent editing:

· Double-click on the element in the diagram or Project Browser (the Shows Properties 351 option must be
selected in the Double click on browser panel of the Options dialog) or
· Right-click on the element in the diagram or Project Browser and select the BPEL | BPEL Properties
context menu option.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 983

See Also
· Model a BPEL Process 961
· Generate BPEL 983
· BPEL Model Validation 984

5.2.5.5 Generate BPEL

To generate BPEL, follow the steps below:
1. Right-click on the BPEL Process element and select the BPEL | Generate BPEL context menu option.
The Generate BPEL dialog displays.

2. The Namespace Details panel shows all of the Pools (participants) involved in the BPEL process. Note
that DefaultPool refers to the BPEL Process itself. Ensure that the Namespace and Prefix columns
have values for all of the Pools; if not, double-click on an entry to bring up the Namespace Details
dialog for that entry.

3. Complete the Namespace and Prefix fields as required.

See Also
· BPEL Models 958
· Create Assignments 981
· Create a BPEL Model 959
· Model a BPEL Process 961
· Create a BPEL Web Service 983

· BPEL Model Validation 984

5.2.5.6 Create a BPEL Web Service

Enterprise Architect enables you to create, for BPEL Process and Pool elements, Web Services that support
either synchronous (request-response) or asynchronous (one-way) interactions.
To create a web service, follow the steps below:
1. Right-click on the BPEL Process or Pool element and select the BPEL | Create Web Service context
menu option. The Create Web Service dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 984 Modeling Languages | Specialized UML Models

2. You can create a Web Service:

· From scratch - select the Create New option in the Web Service field, or
· By importing an existing WSDL into a (for example) SupportingElements package and then selecting
the Create from existing WSDL option in the Web Service field.
Once you enter all the required values, the Web Service is created under the SupportingElements package.

See Also
· BPEL Models 958
· Create a BPEL Model 959
· Create Assignments 981
· Model a BPEL Process 961
· Generate BPEL 983
· BPEL Model Validation 984

5.2.5.7 BPEL Model Validation

You can use the Enterprise Architect Model Validation 1528 facility to check the validity of the BPEL model. You
can validate an entire BPEL Process or a single BPMN element. Note that Enterprise Architect checks for both
the UML and the BPEL rules by default. To enable only BPEL rule validation, select only the BPEL Rules
checkbox in the Model Validation Configuration 1530 dialog.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 985

Example Model Violation

The following model shows several basic BPEL violations:

1. StartEvent1 has its trigger set to None, which cannot be mapped to BPEL.
2. EndEvent1 has its trigger set to Cancel, which cannot be mapped to BPEL.
3. EndEvent1 cannot have any outgoing SequenceFlows, as it represents the end of a process.
4. Activity2 has no outgoing SequenceFlows. Enterprise Architect expects only an EndEvent to represent
the end of a process.
If you run Model Validation on this diagram, Enterprise Architect lists the violations in the Output window, as
shown:

© 1998-2010 Sparx Systems Pty Ltd

 986 Modeling Languages | Specialized UML Models

See Also
· BPEL Models 958
· Create a BPEL Model 959
· Create Assignments 981
· Model a BPEL Process 961
· Generate BPEL 983
· Create a BPEL Web Service 983

5.2.6 Systems Engineering

Note:
Systems Modeling Language (SysML) is available in the Systems Engineering edition and Ultimate edition of
Enterprise Architect.

To model Systems using SysML 989 in Enterprise Architect, you work through the following steps:
· Create a Systems Engineering model 987 to develop your system.
· Create a Requirements model 1007 to define the systems requirements and expectations.
· Create an Operational Domain model 1007 , which describes the environment that the system operates
within, and the entities it interacts with.
· Create Constraint models 1002 to describe the systems operating characteristics using parametric models.
· Simulate the parametric models 1005 to verify their correctness and obtain the desired characteristic.
· Design the system's composition 1009 using SysML Blocks and Parts.
· Implement the embedded software 1314 using UML Classes and behavioral models.
· Create a Library of reusable SysML blocks 1011 , representing subsystems that can be reused on other
projects, and other common Type definitions.
These steps are represented graphically in the following flow:

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 987

Create a Systems Engineering Model

You can create a Systems Engineering Model from a template provided with Enterprise Architect. To do this,
follow the steps below:
1. In the Project Browser, either:
· Click on the New Model From Pattern icon in the toolbar
· Right-click on a model root node and select the Add a New Model using Wizard context menu
option, or
© 1998-2010 Sparx Systems Pty Ltd
 988 Modeling Languages | Specialized UML Models

· Right-click on a package and select the Add | Add a New Model using Wizard context menu
option.
The Select Model(s) dialog displays.
2. In the Select From field, click on the drop-down arrow and select Systems Engineering Model.
Alternatively, if it is listed in the Technology panel, select the Systems Engineering Model item.
3. In the Name panel, select the checkbox next to the Systems Engineering Model icon.
4. Click on the OK button.
The following model structure is created in the Project Browser:

The Systems Engineering Model diagram, shown below, encapsulates the key components of the Systems
Engineering model.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 989

5.2.6.1 SysML
Note:
Systems Modeling Language (SysML) is supported in the Systems Engineering and Ultimate editions of
Enterprise Architect.

The following text is derived from the official OMG SysML site of the Object Management Group.

© 1998-2010 Sparx Systems Pty Ltd

 990 Modeling Languages | Specialized UML Models

The OMG systems Modeling Language (OMG SysML™) is a general-purpose graphical modeling
language for specifying, analyzing, designing, and verifying complex systems that may include
hardware, software, information, personnel, procedures, and facilities.
The language provides graphical representations with a semantic foundation for modeling system
requirements, behavior, structure, and parametrics, which is used to integrate with other engineering
analysis models.
SysML was developed in response to requirements developed jointly by the OMG and the International
Council on Systems Engineering (INCOSE) by the diverse group of tool vendors, end users, academia,
and government representatives.
For further information on the concepts of SysML, refer to the official OMG SysML website and its linked
sources.

SysML in Enterprise Architect

Enterprise Architect enables you to develop SysML models quickly and simply, through use of an MDG
Technology integrated with the Enterprise Architect installer. The SysML technology provides:
· Each of the nine SysML diagram types, accessed through the New Diagram 422 dialog
· A collection of SysML pages in the Toolbox that contain each of the supported SysML elements and
relationships
· SysML element and relationship entries in the Toolbox Shortcut 403 Menu and Quick Linker 474 .
· Simulation of SysML Parametric diagrams 1005 , which supports engineering analysis of critical system
parameters including the evaluation of key metrics such as performance, reliability and other physical
characteristics.

SysML Toolboxes
You can access the SysML pages of the Toolbox through the More tools | SysML menu option. You can also
enable SysML as the active technology to access the Toolbox pages directly.
The following sets of Toolbox pages are available:

· Model Elements 991 contains the constructs needed to build SysML models, package structures and views
· Block Definition 992 contains the constructs needed to design SysML blocks, constraint blocks, data and
value types
· Internal Block 994 contains the constructs needed to design SysML block compositions within Internal Block
Diagrams
· Parametrics 995 contains the constructs needed to construct SysML Parametric Diagrams using constraint
blocks
· Activity 996 contains the constructs needed to construct SysML Activity models
· Interaction 998 contains the constructs needed to construct SysML interactions and Sequence diagrams
· State Machine 999 contains the constructs needed to build SysML State Machines
· Use Case 1000 contains the constructs needed to build SysML Use Case models
· Requirements 1001 contains the constructs needed to build SysML Requirements models.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 991

Disable SysML
If you prefer not to use SysML in Enterprise Architect, you can disable it (and subsequently re-enable it) using
the MDG Technologies 1069 dialog (Settings | MDG Technologies).

5.2.6.1.1 SysML Model Elements

You can access the SysML Model elements Toolbox page through the More tools | SysML | SysML Model
Elements menu option. These pages provide the SysML elements to build SysML models, package structures
and views.

Page Item Use to

SysML Model Model Create a Package containing a SysML Model.

Package Group model constructs together in a single unit of

containment.

View Create a stereotyped Package that defines a SysML View of a

system, from the perspective of a SysML View Point.

View Point Create a stereotyped Class that defines a SysML View Point,
which specifies the rules and conventions for the construction
and use of Views.

SysML Model Conform Establish a conformance dependency of a View to the defining

Relationships View Point.

Containment Graphically display ownership of one element within a parent

one.

Dependency Establish a traceable relationship describing how one element

is dependant upon another.

Import Represent a reuse of elements from one model package in

another.

Realization Identify a design fulfillment of a specification between

elements.

Refine Represent a refinement of one element by another.

© 1998-2010 Sparx Systems Pty Ltd

 992 Modeling Languages | Specialized UML Models

5.2.6.1.2 SysML Block Definition

You can access the SysML Block Definition Toolbox pages through the More tools | SysML | SysML Block
Definition menu option. These pages provide the SysML elements to design SysML blocks, constraint blocks,
data and value types.

Page Item Use to

SysML Block Block Define a composite system entity in SysML.

Definition

Actor Represent a user that interacts with one or more SysML

systems.

Block (constraint) Define a composite constraint as a system of parametric

equations.

DataType Define a SysML data type.

ValueType Define a SysML quantity, expressed as a measurable

dimension with specific units.

Enumeration Define a data type as a set of symbols or values.

Interface Define an element that describes a specification of an

interaction point with properties and methods.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 993

Page Item Use to

Signal Define a SysML message, containing attributes, exchanged

between system blocks in an interaction.

Unit Represent a standard unit of measure in SysML.

Dimension Identify a measurable quantity in SysML.

Part Describe the decomposition of a SysML Block subsystem in

the context of its whole using instances of reusable SysML
Blocks.

Port Describe a structural interaction point of a SysML Block which,

in turn, connects between interacting parts of a block.

Port (flow) Describe what flows in and out of interacting SysML Blocks.

Flow Specification Define a set of flow properties that correspond to individual

pieces of a common interaction point.

SysML Block Item Flow Specify the items that flow across a connector in an interaction
Relationships point.

Dependency Establish a traceable relationship describing how one element

is dependant upon another.

Generalization Describe an element as a specialized descendant of another

element, containing additional properties and behavior.

Containment Graphically display ownership of one element within a parent

element.

Association (part) Describe the characteristics of a connection between a SysML

Block and its internal parts, such as the multiplicity and type.

Association Describe the characteristics of a connection between separate

(reference) SysML Blocks, such as the multiplicity and type.

Association (shared) Describe the characteristics of a common connection between

SysML Blocks, such as the multiplicity and type.

Allocate Relate model elements together to formalize a refinement of

behavior, structure, constraints or design expectations.

© 1998-2010 Sparx Systems Pty Ltd

 994 Modeling Languages | Specialized UML Models

5.2.6.1.3 SysML Internal Block

You can access the SysML Internal Block Toolbox pages through the More tools | SysML | SysML Internal
Block menu option. These pages provide the SysML elements to design SysML block compositions within
Internal Block Diagrams.

Page Item Use to

SysML Block Part Describe the decomposition of a SysML Block subsystem in

Internal the context of its whole, using instances of reusable SysML
Blocks.

Connector Part Create a SysML connector part.

Distributed Part Create a SysML distributed part.

Flow Part Create a SysML flow part.

Participant Part Create a SysML participant part.

Signal Define a SysML message, containing attributes, exchanged

between system blocks in an interaction.

Port Describe a structural interaction point of a SysML Block which,

in turn, connects between interacting parts of a block.

Port (flow) Describe what flows in and out of interacting SysML Blocks.

Flow Specification Define a set of flow properties that correspond to individual

pieces of a common interaction point.

SysML Block Dependency Establish a traceable relationship describing how one element
Internal is dependant upon another.
Relationships

Item Flow Specify the items that flow across a connector in an interaction
point.

Binding Connector Establish a connection between two parts in a system

decomposition.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 995

5.2.6.1.4 SysML Parametrics

You can access the SysML Parametrics Toolbox pages through the More tools | SysML | SysML
Parametrics menu option. These pages provide the SysML elements to construct SysML Parametric
Diagrams using constraint blocks.

Page Item Use to

SysML Constraint Property Instantiate a Constraint Block for use in a Parametric diagram.
Parametrics

Property Define a SysML property typed by a DataType, ValueType or

Block.

SysML Objective Function Define a SysML Constraint Block for use as an objective
Parametrics function to evaluate Measures of Effectiveness.
Extensions

Measure of Define a SysML property for use as a measure of effectiveness

Effectiveness (MOE).

© 1998-2010 Sparx Systems Pty Ltd

 996 Modeling Languages | Specialized UML Models

5.2.6.1.5 SysML Activity

You can access the SysML Activity Toolbox pages through the More tools | SysML | SysML Activity menu
option. These pages provide the SysML elements to construct SysML Activity models.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 997

Page Item Use to

SysML Activities Activity Define a SysML Block of executable behavior as a UML

Activity.

Action Declare a unit of execution in an Activity as a UML Action.

Action (call behavior) Declare a unit of execution that calls another behavior.

Action (accept event) Declare a unit of execution that accepts an event raised by the
system.

Action (accept event Declare a unit of execution that accepts an event raised by a
timer) time epoch.

Action (send signal) Declare a unit of execution that sends a signal as an event.

Partition Create an Activity Partition to group execution elements

together by the node responsible for their execution.

Control Operator Control the execution of an Activity.

Parameter Provide access to input and output objects within the Activity.

Parameter (optional) Define a parameter whose contents are optional in the

Activity's execution.

Parameter (probability) Tag a parameter with probability of the likelihood of the

parameter's use in the Activity.

Object Node Declare a variable in the Activity, typed by a ValueType,

DataType or Block.

Object Node (no Declare an ObjectNode in an Activity which discards

buffer) unconsumed tokens.

Object Node Declare an ObjectNode in an Activity which overwrites tokens.

(overwrite)

Central Buffer Node Declare an ObjectNode that stores tokens for consumption
throughout the Activity.

Decision Create a branch of control in an Activity based on a decision.

Merge Merge two or more Activity control branches together.

Synch Establish a rendezvous point for two or more Activity flows, in

order to synchronize their execution in the Activity.

Initial Declare the start of Activity's execution.

Final Declare the end of an Activity's execution, and the termination

of the Activity.

Flow Final Declare the end of an Activity's execution path without

terminating the Activity.

Region Group a subset of an Activity into a common execution

context.

Exception Declare a node of execution that happens outside the normal

flow of execution of an Activity.

Fork/Join Simultaneously branch / join a set of Control or Object Flows.

© 1998-2010 Sparx Systems Pty Ltd

 998 Modeling Languages | Specialized UML Models

Page Item Use to

SysML Activity Control Flow Establish a flow of logic between two Activity nodes.
Relationships

Control Flow Declare a continuous control flow.

(Continuous)

Control Flow Declare a discrete control flow.

(Discrete)

Control Flow Tag a control flow with a probability of the likelihood of the
(Probability) flow's traversal.

Object Flow Establish a flow of objects (data) between two Activity nodes.

Object Flow Declare a continuous object flow.

(Continuous)

Object Flow (Discrete) Declare a discrete object flow.

Object Flow Tag an object flow with a probability of the likelihood of the
(Probability) flow's traversal.

Interrupt Flow Declare a control flow that interrupts flow within a Region.

SysML Activity Enhanced Functional Declare an Activity used to contain an Enhanced Functional
Extensions Flow Block Flow Block Diagram (EFFBD).

Streaming Activity Declare an Activity where the flow of tokens passes through its
parameters continuously throughout the Activity's execution.

Non-Streaming Declare an Activity where the flow of tokens passes through its
Activity parameters at the start of the Activity's execution.

5.2.6.1.6 SysML Interaction

You can access the SysML Interaction Toolbox pages through the More tools | SysML | SysML Interaction
menu option. These pages provide the SysML elements to construct SysML interactions and Sequence
diagrams.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 999

Page Item Use to

SysML Interaction Define a SysML Block of executable behavior as a UML

Interactions Interaction.

Sequence Reference an instance of a SysML Block as a Lifeline in the

Interaction.

Fragment Declare a portion of an interaction as a group with specific

behavior semantics.

Endpoint Create an exit point for the Interaction.

Diagram Gate Create an endpoint for the interaction, which bridges between
nested interactions.

State/Continuation Constrain the Interaction with assertions of the state that the
lifeline is expected to be in.

SysML Message Describe a message exchange between two lifelines in an

Interactions Interaction.
Relationships

Self-Message Describe a message exchange between a lifeline and itself in

an Interaction.

Recursion Describe a recursive message exchange between a lifeline

and itself in an Interaction.

Call from Recursion Describe a message exchange between two lifelines within a
recursive exchange.

5.2.6.1.7 SysML State Machine

You can access the SysML State Toolbox pages through the More tools | SysML | SysML State Machine
menu option. These pages provide the SysML elements to build SysML State Machines.

Page Item Use to

SysML State State Declare a significant condition in the life of a SysML Block
within its State Machine.

© 1998-2010 Sparx Systems Pty Ltd

 1000 Modeling Languages | Specialized UML Models

Page Item Use to

State Machine Describe the life-cycle behavior of a SysML Block in terms of

its states and transitions.

Initial Declare the starting state of the State Machine.

Final Declare the ending state of the State Machine, and its
completion.

Choice Declare a Junction with a mandatory 'else' transition.

History Represent the last active State of the State Machine prior to its
interruption.

Junction Declare a decision point at which a Transition branches out

into multiple guarded, alternative paths.

Entry Declare an Entry point between State Machines, Substate

Machines and Regions.

Exit Declare an Exit point between State Machines, Substate

Machines and Regions.

Terminate Declare a termination State in which the State Machine no

longer operates.

Fork/Join Simultaneously branch / join a set of Transitions.

SysML State Transition Establish a life-cycle path between one State and another,
Relationships based on its operational conditions.

5.2.6.1.8 SysML Use Case

You can access the SysML Use Case Toolbox pages through the More tools | SysML | SysML Use Case
menu option. These pages provide the SysML elements to build SysML Use Case models.

Page Item Use to

SysML Use Actor Represent a user that interacts with one or more SysML
Cases systems.

Use Case Describe the expected functionality of a system as a UML Use

Case.

Boundary Graphically bound elements in a diagram with a border.

SysML Use Communication Path Declare which Actors perform in the Use Case.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1001

Page Item Use to

Case
Relationships

Generalize Describe an element as a specialized descendant of another

element, containing additional properties and behavior.

Include Describe one Use Case as a subset of another.

Extend Describe one Use Case as an extension of another.

5.2.6.1.9 SysML Requirements

You can access the SysML Requirements Toolbox pages through the More tools | SysML | SysML
Requirements menu option. These pages provide the SysML elements to build SysML Requirements models.

Page Item Use to

SysML Requirement Specify the capabilities of the system, or the conditions that it
Requirements should satisfy.

Test Case Describe the verification of a Requirement through methods of

inspection, analysis, demonstration or testing.

SysML Containment Graphically display ownership of one element within a parent

Requirement element.
Relationships

Trace Declare a trace relationship between a SysML Requirement

and another SysML element.

Copy Declare a copy of one SysML Requirement by another.

© 1998-2010 Sparx Systems Pty Ltd

 1002 Modeling Languages | Specialized UML Models

Page Item Use to

Derive Derive a SysML Requirement from another.

Verify Declare a verification of a SysML Requirement by another

SysML element.

Refine Declare a refinement of a SysML Requirement by another

SysML element.

Satisfy Declare that the SysML Requirement is satisfied by another

SysML element.

SysML Extended Requirement Extend a SysML Requirement with additional Tag properties.
Requirement
Extensions

Functional Declare a SysML Requirement that describes the operation, or

Requirement behavior, that the system must perform.

Interface Requirement Declare a SysML Requirement that describes how the system
connects, or interfaces with, other systems.

Performance Declare a SysML Requirement that describes how the system

Requirement performs against defined capabilities or conditions.

Physical Requirement Declare a SysML Requirement that describes the physical

characteristics, or physical constraints, of the system.

Design Requirement Declare a SysML Requirement that specifies a constraint on

the implementation of the system.

5.2.6.2 SysML Parametric Models

Note:
Systems Modeling Language (SysML 989 ) is supported in the Systems Engineering and Ultimate editions of
Enterprise Architect.

SysML Parametric models support the engineering analysis of critical system parameters, including the
evaluation of key metrics such as performance, reliability and other physical characteristics. They unite
requirements models with system design models by capturing executable constraints based on complex
mathematical relationships.
The following text is derived from the SysML entry in the online Wikipedia.
The advantages of SysML over UML for systems engineering become obvious if you consider a
concrete example, such as modeling an automotive system. With SysML you can use Parametric
diagrams to precisely define performance and mechanical constraints such as maximum acceleration,
curb weight, air conditioning capacity, and interior cabin noise management.
For further information on the concepts of SysML Parametric models, refer to the official OMG SysML website
and its linked sources.

Create a Parametric Model

Enterprise Architect enables you to develop SysML Parametric models quickly and simply; these models can
also be simulated 1005 . To create a Parametric model, follow the steps below:
1. Create a collection of SysML Constraint Blocks that formally describe the function of a constraint in a
simulation model. Each Constraint Block contains properties that describe its input and output
parameters, as well as Element Script that describes the constraint's executable component.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1003

2. Right-click on each of the constraintBlocks and select the SysML | Add Element Script context menu
option to add script to the constraint block. This is where you express the relationship / behavior of the
constraint block as an executable script.

3. Create a SysML Constraint Block to contain the Parametric model to simulate. The Parametric model
contains properties and occurrences of constraint blocks as Constraint Property elements, connected in
a Parametric Diagram.

© 1998-2010 Sparx Systems Pty Ltd

 1004 Modeling Languages | Specialized UML Models

4. Right-click within a Parametric Diagram and select the SysML | Simulate Diagram... context menu
option.
5. Depending on your configuration selections 1005 , the simulation's results are either written to a
comma-separated CSV file or graphed in a 2-dimensional plot.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1005

5.2.6.2.1 Simulate a SysML Model

Note:
Systems Modeling Language (SysML) is supported in the Systems Engineering and Ultimate editions of
Enterprise Architect.

To simulate a SysML model, follow the steps below:

1. Right-click within a Parametric Diagram and select the SysML | Simulate Diagram... context menu
option. The Simulation Configuration dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1006 Modeling Languages | Specialized UML Models

2. The Parameters panel lists all of the parameters that can be assigned input. Select each of the required
parameters and click on the right Arrow button to assign them as input. Parameters designated as
input parameters are listed in the Inputs panel on the right.

Note:
There must be at least one input parameter assigned for the simulation to execute.

3. Assign a set of values for each of the designated input parameters. For each input parameter, in the
Input Values panel select one of the two possible value kinds:
· Discrete - To enter a constant or a comma-separated range of discrete values
· Range - To enter a range of values beginning at the From value and ending at the To value. The
input values are incremented by the Step value.
4. Specify the classes of output value:
· Parameters - To output the parameters' data, select the checkbox
· Variables - To output the data generated within each internal variable, select the checkbox. Internal
variables are automatically generated by the simulator
5. Specify how the simulation results are to be reported. The Output Format panel enables you to choose
how the simulation outputs the simulation data.
· Plot To Graph: To plot the results on a 2-dimensional graph, select the checkbox; if you select this
option, you must specify an input parameter for the plot's X Axis
· Title - To enter a title for the graph, type in the title text
· Output to File - To output the results to a CSV text file, select the checkbox and type or browse ([...]
) for the file name.
6. Click on the OK button to execute the simulation.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1007

5.2.6.3 Create a Requirements Model

The SysML Requirements Model provides the system requirements, the expected abstract behavior and the
operating constraints that the designed system must conform to.
The following diagram shows an example requirements model for a Portable Audio Player.

In the example Requirements Model, each of the child packages contains child models that capture the
following aspects of the system's requirements:
· The Specifications package contains SysML Requirements describing the overall expectations of the
designed system.
· The Use Cases package contains SysML Use Cases that describe the general interaction between the
system and its users.
· The Interactions package contains SysML Interactions that describe a detailed sequence of interactions
between the system and its users.
· The State Machines package contains SysML State Machines that describe each of the operational states
the designed system has.
· The Constraint Blocks package contains SysML ConstraintBlocks that describe the expected performance
and operating boundaries of the system.

5.2.6.4 Create an Operational Domain Model

The SysML Operational Domain Model defines the system's operating environment, which describes the
operating conditions that the system is intended to operate within.
The following diagram shows an example Operational Domain model for a Portable Audio Player. The SysML
Block Definition Diagram describes the Operational Domain (in this example - the ListeningDomain) as a
system composition.

© 1998-2010 Sparx Systems Pty Ltd

 1008 Modeling Languages | Specialized UML Models

In this example, the ListeningDomain is defined as a system containing other subsystems within it. The
domain contains subsystems that define the Listener (i.e. User), the Portable Audio Player, Clothing (which
the user wears), and the External Environment.
Details of the ListeningDomain system are further detailed in the ListeningDomain's Internal Block Diagram.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1009

In this example, the ListeningDomain's system's detailed composition shows how the Portable Audio Player
and other sub-systems fit together to form the Listening Domain. It also describes the binding relationships
between the parts, which describe how they are functionally bound to one another.

5.2.6.5 Compose System Design

The SysML Design Model contains the blocks that define the system's composition. It describes the manner in
which reusable subsystems fit together to fulfill the design requirements.
The following diagram shows an example Design Model for a Portable Audio Player. The SysML Block
Definition Diagram describes the Portable Audio Player as a composition of various reusable off-the-shelf
subsystems in-house designed ones.

© 1998-2010 Sparx Systems Pty Ltd

 1010 Modeling Languages | Specialized UML Models

In the example above, the Portable Audio Player is defined as a SysML system containing subsystems that
perform specific tasks. The design contains subsystems for supplying power, performing playback and audio
processing, interfacing with other devices, and the user interface.
Details of the Portable Audio Player's composition are further described in detail within the Portable Audio
Player's Internal Block Diagram.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1011

In this example, the Portable Audio Player's composition is described, detailing how each of the sub-systems
is structured. It also describes the binding relationships between the parts, which describe how they are
functionally bound to one another - for example, the CPU, Memory and Codec are interfaced together in the P
rocessing Subsystem.

5.2.6.6 Create Reusable Subsystems

Model Based Systems Engineering provides the flexibility and expressiveness to define complex systems
quickly effectively by reusing common entities across design projects. A Library is a package containing many
reusable subsystems, parametric constraints, common data types and common value types, dimensions and
units.
The following diagram shows an example library model.

In the example Library, each of the child packages contains child models that capture the following reusable
entities:
· Blocks defining systems such as those listed in the Components package, or those defined in the External
package.
· ConstraintBlocks defining parametric constraints for use in parametric models.
· Value Types describing quantities, expressed as measurable dimensions in specific units.
· Data Types and Flow Specifications describing data structures and Flows.

5.2.7 Data Models

You perform database modeling and database design in Enterprise Architect using the UML Data Modeling
Profile. This profile provides easy-to-use and easy-to-understand extensions to the UML standard, mapping
the database concepts of tables and relationships onto the UML concepts of Classes and associations. These
extensions also enable you to model database keys, triggers, constraints, RI and other relational database
features.

Note:
The UML Data Modeling Profile is not currently a ratified standard; however it has wide industry support and
is a useful method for bridging the gap between the UML and conventional relational database modeling.

Typical data modeling tasks you might perform are listed at the end of this topic.

© 1998-2010 Sparx Systems Pty Ltd

 1012 Modeling Languages | Specialized UML Models

For information on forward and reverse engineering of your data models, see the Database Engineering 1363

topic.

Tables and Columns

The basic modeling structure of a relational database is the table, which represents a set of records, or rows,
with the same structure. The basic organizational element of a relational database is the column. Every
individual item of data entered into a relational database is represented by a value in a column of a row in a
table.
The UML Data Modeling Profile represents:
· Tables as stereotyped Classes; that is, Class elements with a stereotype of table
· Columns as stereotyped attributes; that is, attributes with a stereotype of column.
Enterprise Architect can generate simple DDL scripts to create the tables in your model. You can also perform
Model Driven Architecture (MDA) Transformations 1385 to DDL - Enterprise Architect provides a template
specifically for DDL transformations 1393 .
To help you map Class attributes to Table fields, you can create connectors between specific attributes in the
Class element and the column attributes in the Table element. See the Connect to Element Feature 611 topic.

Database Keys
Two types of key are used to access tables: Primary Keys and Foreign Keys. A Primary Key uniquely identifies
a record in a table, while a Foreign Key accesses data in some other related table via its Primary Key.
A Primary Key consists of one or more columns; a simple Primary Key (single column) is defined as the
attribute of a stereotyped operation. A complex Primary Key (several columns) is defined as the stereotyped
operation itself.
A Foreign Key is a collection of columns (attributes) that together have some operational meaning (they
enforce a relationship to a Primary Key in another table). Foreign keys are represented in Enterprise Architect
as operations with the stereotype FK; the operation parameters become the columns involved in the key.

Supported Databases
Enterprise Architect supports import of database schema from these databases:
· DB2
· Firebird/InterBase
· Informix
· Ingres
· MS Access 97, 2000, 2003
· Access 2007
· MS SQL Server 2000, 2005, 2008
· MySQL
· Oracle 9i, 10g and 11g
· PostgreSQL
· Sybase Adaptive Server Anywhere (Sybase ASA)
· Sybase Adaptive Server Enterprise (Sybase ASE).

Notes:
· You can download SQL Server 2005 data types and SQL Server 2008 data types from the Resources page
of the Sparx Systems web site.
· Firebird 1.5 database tables can be modeled and generated as InterBase tables. Firebird tables can be
imported but are treated as InterBase tables.

Typical Tasks
Typical tasks you can perform when modeling or designing databases include:
· Create a Data Model Diagram 1013

· Create a Table 1013

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1013

· Set Properties of a Table 1014

· Create Columns 1019
· Create Oracle Packages 1022
· Create Primary Keys 1022
· Create Foreign Keys 1024
· Create Stored Procedures 1030 .
You can also perform additional, advanced 1031 procedures such as creating views or indexes and triggers.

5.2.7.1 A Data Model Diagram

An example of a Data Model diagram is provided below, showing three tables that are linked on primary to
foreign key pairs with associated multiplicity.
Note the use of stereotyped operations for Primary (PK) and Foreign (FK) keys. Operations could also be
added for:
· Triggers 1033
· Constraints 1033 (check, unique)
· Indexes 1033

A Data Model diagram is represented in Enterprise Architect as a Class diagram, and is created in exactly the
same way 422 as other diagrams.

5.2.7.2 Create a Table

What is a Table?
The basic modeling structure of a relational database is the Table. A Table represents a set of records, or
rows, with the same structure.

© 1998-2010 Sparx Systems Pty Ltd

 1014 Modeling Languages | Specialized UML Models

The UML Data Modeling Profile represents a Table as a stereotyped Class; that is, a Class element with a
stereotype of table applied to it. A table icon is shown in the upper right corner of the image when it is shown
on a Data Model diagram.

Create a Table
To create a Table, follow the steps below:
1. Select a diagram.
2. Select the More Tools | Data Modeling menu option on the Toolbox.
3. Click on the Table element in the list of elements, then click on the diagram. The Table element is
displayed on the diagram.

4. If the Class: Table n Properties dialog does not display, double-click on the Table to display it.
5. In the Name field, type a name for the Table and set any other properties 1014 as required.
6. Click on the OK button.

5.2.7.3 Working with Tables

Once you have created your table, you can set its properties. Most table properties can be set from the
Properties dialog, as described below. However, some properties must be entered as Tagged Values as
described for setting the value of the Table Owner 1016 and, for MySQL 1016 and Oracle 1017 databases, setting
the table options.

Set the Database Type

The most important property to set for a table (after its name) is the database type. This defines the list of
datatypes that are available for defining columns, and also declares which dialect of DDL is generated.
Enterprise Architect supports the following databases:
· DB2
· Informix
· Ingres
· InterBase
· MS Access 97, 2000, 2003
· Access 2007
· MySQL
· Oracle 9i, 10g and 11g
· PostgreSQL
· SQL Server 2000, 2005 and 2008

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1015

· SQLServer7
· Sybase Adaptive Server Anywhere (Sybase ASA)
· Sybase Adaptive Server Enterprise (Sybase ASE).
To set the database type, follow the steps below:
1. Double-click on the table element in a diagram to open the Properties dialog.
2. Select the General tab.

3. In the Database field, click on the drop-down arrow and select the database type.
4. Click on the Apply button to save changes.
By clicking on the Table Detail tab on this dialog, you can access the Columns dialog 1019 or Operations dialog
1033 , or you can Generate DDL 1367 for this table.

© 1998-2010 Sparx Systems Pty Ltd

 1016 Modeling Languages | Specialized UML Models

5.2.7.3.1 Set Table Owner

To define the owner of a table, follow the steps below:
1. Select the Tagged Values tab of the table Properties dialog. The Tagged Values tab shows the tags for
the table.

2. Click on the New Tag button . The Tagged Value dialog displays.

3. In the Tag field, type the tag name Owner. In the Value field, type a value for the Owner tag.

Note:
For a PostgreSQL database, to define the owner name:
· In the Tag field, type the tag name OWNER TO
· In the Value field, type Owner_Name.

4. Click on the OK button to confirm the operation. Generated DDL includes the table owner in the SQL
script.

5.2.7.3.2 Set MySQL Options

In MySQL, to make use of foreign keys you must declare the table type as InnoDB. To do this, follow the steps
below:
1. Select the Tagged Values tab of the table Properties dialog. The Tagged Values tab shows the tags for
the table.

2. Click on the New Tag button . The Tagged Value dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1017

3. In the Tag field, type the tag name Type. In the Value field, type InnoDB as the value for the Type tag.
4. Click on the OK button to confirm the operation. Generated DDL includes the table type in the SQL
script.
5. To allow for later versions of MySQL, additional table options that can be added in the same manner
include:

Tag Value (Example)

ENGINE InnoDB

CHARACTER SET latin1

CHARSET latin1

COLLATE latin1_german2_ci

5.2.7.3.3 Set Oracle Table Properties

For Oracle, you can set table properties using the table's Tagged Values. Follow the steps below:
1. Select the Tagged Values tab of the table Properties dialog. The Tagged Values tab shows the tags for
the table.

2. Click on the New Tag button . The Tagged Value dialog displays.
3. Define the table properties as shown in the examples below:

4. Click on the OK button to save the Tagged Value.

All available properties for an Oracle table are listed below.

© 1998-2010 Sparx Systems Pty Ltd

 1018 Modeling Languages | Specialized UML Models

Note:
The same properties can be added to indexes and constraints 1033 . Highlight the index or constraint and add
the properties as Tagged Values.

Property/Tag Value

BUFFER_POOL DEFAULT

CACHE NOCACHE

DBVERSION 9.0.111

FREELISTS 1

GRANT OWNER1 SELECT

GRANT OWNER2 DELETE, INSERT, SELECT, UPDATE

INITIAL 65536

INITRANS 1

LOGGING LOGGING

MAXEXTENTS 2147483645

MAXTRANS 255

MINEXTENTS 1

MONITORING MONITORING

OWNER OWNER1

PARALLEL NOPARALLEL

PCTFREE 10

PCTINCREASE 0

PCTUSED 0

SYNONYMS PUBLIC:TABLE_PUB;OWNER2:TABLE_OWNER2

TABLESPACE MY_TABLESPACE

TEMPORARY YES

The properties defined for a given table are listed on the Tagged Values tab, as illustrated by the following
typical Tagged Value list:

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1019

5.2.7.3.4 Create Columns

What is a Column?
The basic organizational element of a relational database is the column. Every individual item of data entered
into a relational database is represented as a value in a column of a row in a table. Columns are represented
in the UML Data Modeling Profile as a stereotyped attribute; that is, an attribute with the Column stereotype.

Create Columns
Note:
For MySQL, before creating columns first add ENUM and SET datatypes. Select the Settings | Database
Datatypes menu option and, on the Database Datatypes dialog, in the Product Name field select MySQL.
Add the datatypes ENUM and SET.

To create columns, follow the steps below:

1. Right-click on the Table in a diagram to open the context menu, and select the Attributes menu option.
2. The <Tablename> Columns dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1020 Modeling Languages | Specialized UML Models

3. In the Name field, type the column name.

4. In the Data Type field, click on the drop-down arrow and select the data type, and click on the Save
button.

Tip:
If the drop-down list of datatypes is empty, this means that you have not selected a target database for
the table. Close the Columns dialog and re-open the Table Properties dialog to set a database type
before continuing. To prevent this recurring, set the default database type 1337 .

5. The following fields for each column are optional:

· Primary Key - select the checkbox if the column represents the primary key 1022 for this table
· Not Null - select the checkbox if empty values are forbidden for this column
· Unique - select the checkbox if it is forbidden for any two values of this column to be identical
· Initial - type a value that can be used as a default value for this column, if required
· Access - click on the drop-down arrow and select a scope of Private, Protected or Public (the field
defaults to Public)
· Alias - type an alternative name for the field (for display purposes), if any
· Notes - type any other information necessary to document the column; you can format the text using
the Notes toolbar 642 at the top of the field.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1021

Notes:

· The unique characteristic applied to a single column ensures that no two data values in the
column can be identical. The unique stereotype applied to an index 1033 ensures that no two
combinations of values across a set of columns can be identical.
· Some datatypes, such as the Oracle NUMBER type, require a precision and scale. These fields
are displayed where required and should be filled in as appropriate. For example, for Oracle:

create NUMBER by setting Precision = 0 and Scale = 0

create NUMBER(8) by setting Precision = 8 and Scale = 0
create NUMBER(8,2) by setting Precision = 8 and Scale = 2.
· Oracle VARCHAR2(15 CHAR) and VARCHAR2(50 BYTE) datatypes can be created by adding the
tag LengthType with the value CHAR or BYTE.
· For MySQL ENUM and SET datatypes, in the Initial field type the values as a comma-separated list,
in the format ('one','two','three') or, if one value is the default, in the format: ('one','two','three') default
'three'.

5. Click on the Column Properties button. The Database Columns Properties dialog displays.

If you require a sequence, such as an Oracle sequence, select the AutoNum property, set the value to
True and, if necessary, define the start number and increment. Click on the OK button to return to the
<Tablename> Columns dialog.
6. Click on the Save button and on either the New button to define another column or the Close button to
exit from the dialog.

Change the Column Order

To change the column order, follow the steps below:
1. On the Columns dialog, highlight a column name in the Columns panel.
2. Click on the:

· button to move the column up one position

· button to move the column down one position.

© 1998-2010 Sparx Systems Pty Ltd

 1022 Modeling Languages | Specialized UML Models

5.2.7.3.5 Create Oracle Packages

To create an Oracle package, follow the steps below:
1. Open the project in the Project Browser and create an Enterprise Architect package (and, if required, a
Class diagram).
2. Add a Class 811 element to either the package or the diagram.
3. Open the Properties 481 dialog for the element and, in the Stereotype field, type the value Package.
4. For the package specification, create an Operation 569 with the name Specification and with no return
type.
5. Open the Properties 570 dialog for the Specification Operation and, on the Behavior tab, type the entire
package specification into the Initial Code 576 field.
6. For the package body, create an Operation with the name Body and with no return type.
7. Open the Properties dialog for the Body Operation and, on the Behavior tab, type the entire package
body into the Initial Code field.

5.2.7.4 Primary Key

What is a Primary Key?

Keys are used to access tables, and come in two varieties: Primary Keys and Foreign Keys. A Primary Key
uniquely identifies a record in a table, while a Foreign Key 1024 accesses data in some other related table via its
Primary Key.

Define a Simple Primary Key

If a Primary Key consists of a single column, it is very easy to define.
1. Right-click on the table in a diagram to display the context menu. Select the Attributes menu option.
2. In the Attributes dialog, select the column that makes up the Primary Key.
3. Select the Primary Key checkbox and click on the Save button.
A stereotyped operation is automatically created. It is this operation that defines the Primary Key for the table.
To remove a Primary Key, simply delete this operation.

Define a Complex Primary Key

Often, a Primary Key consists of more than one column. For example, a column LastName might not be
unique within a table, so a Primary Key is created from the LastName, FirstName and DateOfBirth columns.
Perform the following steps to create a complex Primary Key:
1. Follow the steps above to create a Simple Primary Key. It doesn't matter which column you choose.
2. Right-click on the table in a diagram to open the context menu. Select the Operations menu option.
3. Select the Primary Key operation (its name begins with PK_) and then click on the Column tab.
4. To add a column to the Primary Key, click on the New button, select a column from the Column Name
list box, and then click on the Save button.
5. Click on the Hand buttons (up and down arrow) to change the order of columns in the Primary Key, if
necessary.
(See also the SQL Server Non-Clustered Primary Keys 1024 topic).

Define a Primary Key Name Template

To define the name template for a Primary Key, follow the steps below:
1. Select the Tools | Options | Source Code Engineering | Code Editors menu option. The Code
Enterprise Architect User Guide
 Modeling Languages | Specialized UML Models 1023

Editors page of the Options dialog displays.

2. Click on the DDL Name Templates button. The DDL Name Template dialog displays, showing the
default name templates.

3. Edit or replace the template in the Primary Key Name Template field.

Note:
If you want to display the Primary Key description as PK_tablename_columnname then change the
Primary Key Name Template field to PK_%tablename%_%columnname%.

4. Click on the Save button.

© 1998-2010 Sparx Systems Pty Ltd

 1024 Modeling Languages | Specialized UML Models

5.2.7.4.1 SQL Server Non Clustered Keys

To define a primary key as non-clustered for a SQL Server table, follow the steps below:
1. Right-click on the table in a diagram to open the context menu.
2. Select the Operations menu option. The Table Operations dialog displays.
3. Highlight the Primary Key Operation and select Extended Properties. The Database Operation
Properties dialog displays.

4. Select the SQL Server Non Clustered Primary Key checkbox.

5. Click on the Save & Close button.

5.2.7.5 Foreign Key

What is a Foreign Key?

Two types of key are used to access tables: Primary Keys 1022 and Foreign Keys. A Primary Key uniquely
identifies a record in a table, while a Foreign Key accesses data in some other related table via its Primary
Key.
Foreign keys are represented in Enterprise Architect using stereotyped operations. A Foreign Key is a
collection of columns (attributes) that together have some operational meaning (they enforce a relationship to
a Primary Key in another table). A Foreign Key is modeled as an operation stereotyped with the FK
stereotype; the operation parameters become the columns involved in the key.

Note:
It isn't necessary to define a Foreign Key in order to access another table through its Primary Key. Foreign
Keys are a feature of some database management systems, providing 'extras' such as referential integrity
checking that prevents the deletion of a record if its Primary Key value exists in some other table's Foreign
Key. The same thing can be achieved programmatically.

To create a Foreign Key 1025 , click on the link.

You might also have to define a Name Template 1028 for Foreign Keys.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1025

5.2.7.5.1 Create Foreign Key

To create a Foreign Key, follow the steps below:
1. Locate the required Tables in a diagram. Both tables must have the same defined database types 1015 .
2. Select an Associate connector in the Class Relationships page of the Toolbox.
3. Click on the Table to contain the Foreign Key (source) and draw the connector to the other Table
(target).
4. Right-click on the connector to display the context menu, and select the Foreign Keys option. The
Foreign Key Constraint dialog displays.

5. The default foreign key name is set by the Foreign Key Name Template. To change the name to
something other than the default provided by the template, select the Override Template checkbox and
edit the foreign key name.
6. In the Source: panel and the Target: panel, click on the name of each of the two columns involved in the
Foreign Key relationship (in the screenshot above, the column name WarehouseID in each panel).
7. Select the appropriate referential integrity constraint from the On Delete and/or On Update combo
boxes.
8. Click on the Apply or OK buttons to automatically generate the Foreign Key operations.
You have created the Foreign Key. The example below shows how this looks in a diagram:

© 1998-2010 Sparx Systems Pty Ltd

 1026 Modeling Languages | Specialized UML Models

Composite Foreign Key

To create a composite Foreign Key, select the required columns in each of the Source: and Target: panels
and click on the OK button. The Foreign Key columns are sorted according to datatype to match the datatypes
of the targeted composite Primary Key. If required, you can change the order of the key columns by clicking on

the and buttons.

Tip:
If you are defining a MySQL database and want to use Foreign Keys, you must set the table type 1016 to
enable this.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1027

This creates the composite Foreign Key. The example below shows how this looks in a diagram:

© 1998-2010 Sparx Systems Pty Ltd

 1028 Modeling Languages | Specialized UML Models

5.2.7.5.2 Define Foreign Key Name Template

To define the name template for a Foreign Key, follow the steps below:
1. Select the Tools | Options | Source Code Engineering | Code Editors menu option. The Code
Editors page of the Options dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1029

2. Click on the DDL Name Template button. The DDL Name Template dialog displays, showing the
default name templates.

3. Edit or replace the name template in the Foreign Key Name Template field.

Note:
If you want to display the Foreign Key description as
FK_foreigntablename_FKcolumnname_primarytablename_PKcolumnname then change the Foreign
Key Name Template field to FK_%foreigntablename%_%fkcolumnname%_%primarytablename%_%
pkcolumnname%.

4. Click on the Save button.

© 1998-2010 Sparx Systems Pty Ltd

 1030 Modeling Languages | Specialized UML Models

5.2.7.6 Stored Procedures

What is a Stored Procedure?

A stored procedure is a group of SQL statements that form a logical unit and perform a particular task. Stored
procedures are used to encapsulate a set of operations or queries to execute on a database server. You can
compile and execute stored procedures with different parameters and results, and they can have any
combination of input, output and input/output parameters.
Enterprise Architect models stored procedures as individual Classes 1030 .

Note:
Stored procedures are currently supported for: DB2; SQL Server; Firebird/Interbase; Informix; Ingres; Oracle
9i, 10g and 11g; MySQL; PostgreSQL; Sybase Adaptive Server Enterprise (ASE) and Sybase Adaptive
Server Anywhere (ASA).

5.2.7.6.1 Create Individual Class Procedure

To create a stored procedure as an individual Class, follow the steps below:
1. Open the required diagram.
2. From the Data Modeling page of the Toolbox (More tools | Data Modeling) drag the Procedure icon
onto the diagram.
3. If the Properties dialog does not automatically display, double-click on the element.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1031

4. In the Database field click on the drop-down arrow and select the target DBMS to model. (The field
displays the default database if it has already been set.)
5. In the Procedure definition field, type the entire procedure text.
6. Click on the OK button.

To define a name for the stored procedure, click on the element, click on the name (Class<n>) and click
again. This highlights the text for editing 588 . Type in the required name.

5.2.7.7 Advanced Topics

In creating a data model, you can perform more advanced modeling such as:
· Creating Views 1032
· Creating Indexes, Check Constraints and Triggers 1033

· Converting Datatypes for a Table 1035

· Converting Datatypes for a Package 1036
· Customizing Datatypes for a DBMS 1037

© 1998-2010 Sparx Systems Pty Ltd

 1032 Modeling Languages | Specialized UML Models

5.2.7.7.1 Views

Note:
Views are currently supported for: DB2; SQL Server; Firebird/Interbase; Informix; Ingres; Oracle 9i, 10g and
11g; MySQL; PostgreSQL; Sybase Adaptive Server Enterprise (ASE) and Sybase Adaptive Server Anywhere
(ASA).

Create a View
To create a database View, follow the steps below:
1. On the Data Modeling page of the Toolbox (More tools | Data Modeling), drag the View icon onto your
Data Modeling diagram.
2. If the View Properties dialog does not immediately display, double-click on the element.

3. From the Database drop-down list, select the target DBMS to model. The default database displays if it
has already been set.
4. Click on the OK button.
To define a name for the View, click on the element, click on the name (Class<n>) and click again. This
highlights the text for editing 588 . Type in the required name.

Define View Properties

1. Create a Dependency connector from the View to the table or tables on which the View depends.
2. Double-click on the View to display the Properties dialog. The tables are now listed in the
Dependencies field.
3. In the View definition field, type the full view definition. (The code editor 1428 provides intellisense for
basic SQL keywords and functions).
4. Click on the OK button to save your definition.
The View definition and certain other parameters are held as Tagged Values. The View definition is held in
the viewdef memo Tagged Value, as shown in the following example diagram. You can select and view the
viewdef Tagged Value in the Tagged Values 632 window, and include it in RTF reports by inserting the
valueOf(viewdef) 1587 field in the Package::Element or Element::Tagged Values sections.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1033

5.2.7.7.2 Index, Trigger, Check Constraint

What is an Index?
An index is a sorted look-up for a table. When it is known in advance that a table must be sorted in a specific
order, it is usually worth the small processing overhead to always maintain a sorted look-up list rather than sort
the table every time it is required. In Enterprise Architect, an index is modeled as a stereotyped operation. On
generating DDL, the necessary instructions for generating indexes are written to the DDL output.
The unique characteristic applied to a single column ensures that no two data values in the column can be
identical. The unique stereotype applied to an index ensures that no two combinations of values across a set
of columns can be identical.

© 1998-2010 Sparx Systems Pty Ltd

 1034 Modeling Languages | Specialized UML Models

What is a Trigger?
A trigger is an operation automatically executed as a result of the modification of data in the database, and
usually ensures consistent behavior of the database. For example, a trigger might be used to define
validations that must be performed every time a value is modified, or might perform deletions in a secondary
table when a record in the primary table is deleted. In Enterprise Architect, a trigger is modeled as a
stereotyped operation.

What is a Check Constraint?

A Check Constraint enforces domain integrity by limiting the values that are accepted by a column.

Create an Index
Ensure that the column(s) to be used in the index have already been defined 1019 in the table.
1. Right-click on the required table either in a diagram or in the Project Browser.
2. Select the Operations context menu option. The Operations dialog displays.
3. Add an operation (with a name such as IDX_CustomerID; the IDX_ prefix is optional but it helps identify
the operation).
4. In the Stereotype field for the operation, select index (check and unique are also supported).
5. Click on the Column tab.
6. Select the required columns from the Columns drop-down list in the required order, then click on the
Save button to save changes.

Create a Check Constraint or Trigger

1. Locate the required table in either a diagram or the Project Browser.
2. Use the context menu to open the Operations dialog.
3. Add an operation (such as CHK_ColumnName or TRG_OnCustomerUpdate; the CHK_ and TRG_
prefixes are optional but help identify the operation).
4. In the Stereotype field for the constraint, select check or trigger as appropriate and click on the Save
button to save changes.
5. Select the constraint operation, then the Behavior tab.
6. Enter the entire check constraint clause (for example, col1 < 1000), or the entire trigger code (including
the CREATE_TRIGGER statement) in the Initial Code field and click on the Save button to save
changes.

The example below shows how an index looks in a diagram (in the Order element):

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1035

5.2.7.7.3 Data Type Conversion Procedure

Once a database schema has been set up on an Enterprise Architect diagram (either by importing through
ODBC or manually setting up the tables), the DBMS can be changed to another type and the column
datatypes are mapped accordingly.
To map the DBMS type of a table to another DBMS type, follow the steps below:
1. Double-click on the table element in a diagram to open the table Properties dialog.
2. The Database field shows the current DBMS for this table.
3. To map the column datatypes to another DBMS, select the target from the Database drop-down and
click on the Apply button.
4. The datatypes are converted to match those of the new DBMS, and these are reflected in any DDL
generated from this table.

© 1998-2010 Sparx Systems Pty Ltd

 1036 Modeling Languages | Specialized UML Models

5.2.7.7.4 Data Type Conversion for a Package

The DBMS Package procedure or mapper enables you to convert a package of database tables from one
DBMS type to another DBMS type, as well as providing the ability to change the ownership of tables.
To map the DBMS types of a package to another DBMS type, follow the steps below:
1. Right-click on the package in the Project Browser to display the context menu.
2. Select the Code Engineering | Reset DBMS Options menu option. The Manage DBMS Options dialog
displays.

3. In the Current DBMS field, click on the drop-down arrow and select the current DBMS. In the New
DBMS field click on the drop-down arrow and select the target DBMS.
4. Select the Convert DBMS Type checkbox.
5. If there are child packages that also require changing, select the Process Child Packages checkbox.
6. Click on the OK button. All tables in the selected packages are mapped to the new DBMS.
To change the owner of the table or all of the tables in a package, follow the steps below:
1. Right-click on the package in the Project Browser to display the context menu.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1037

2. Select the Code Engineering | Reset DBMS Options menu option. The Manage DBMS Options dialog
displays.

3. In the New Owner field, type the name for the new table owner.
4. In the Current Owner field, click on the drop-down arrow and select the current owner to change, or
select <All> to change the ownership of all tables in the package to the name you typed in the New
Owner field.
5. Select the Change Table Owner checkbox.
6. If there are child packages that also require changing, select the Process Child Packages checkbox.
7. Click on the OK button. The ownership changes for all Tables in the selected packages with the
specified current owner.
For more information on setting the table owner see the Set Table Owner 1016 topic. To display the table owner
in the current diagram see the Diagram Properties 423 topic.

5.2.7.7.5 DBMS Datatypes

When setting up your data modeling profile, you can customize the datatypes associated with a particular
DBMS using the Database Datatypes screen. This screen enables you to add and configure custom data
types. For some data types you must add the size and precision, defaults and maximum values.
To access the Database Datatypes screen, select the Settings | Database Datatypes menu option. You can
also add a DBMS product and configure the inbuilt data types.

© 1998-2010 Sparx Systems Pty Ltd

 1038 Modeling Languages | Specialized UML Models

You can also map database datatype sizes between products. To do this, follow the steps below:
1. On the Database Datatypes dialog, click on the Datatype Map button. The Database Datatypes
Mapping dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1039

2. In the From Product Name field, click on the drop-down arrow and select the DBMS product to map
datatypes from. The Defined Datatypes for Databases panel displays all the defined datatypes for the
product and, where appropriate, their sizes and values.
3. Click on the datatype to map (this must have a defined size unit and value). The Datatype and
Common type fields under the From Product Name field display this datatype.
4. In the To Product Name field, click on the drop-down arrow and select the DBMS product to map
datatypes to. The Datatype and Common Type fields under this field display the corresponding values
to those in the fields for the from product.
5. In the Size panel, click on the radio button for the appropriate size unit and type the default values in the
corresponding data fields.
6. Click on the Save button to save the mapping.
7. To map further datatypes, repeat this process from step 3.
8. When you have finished mapping datatypes, click on the Close button, and again on the Database
Datatypes dialog.

5.2.8 XML Schema - XSD

Enterprise Architect supports rapid modeling, forward engineering and reverse engineering of W3C XML
schemas (XSD). The topics in this section explain the support of XML Technologies 1039 and how to use
Enterprise Architect to model 1040 XML schemas.

5.2.8.1 XML Technologies

Enterprise Architect enables rapid modeling, forward engineering and reverse engineering of XML Schema
(XSD), a key W3C XML technology.
XSD support is critical for the development of a complete Service Oriented Architecture (SOA), and the
coupling of UML 2.3 and XML provides the natural mechanism for specifying, constructing and deploying
XML-based SOA artifacts within an organization.

© 1998-2010 Sparx Systems Pty Ltd

 1040 Modeling Languages | Specialized UML Models

5.2.8.2 Model XSD

XML schemas are modeled using UML Class 721 diagrams. The XML Schema 420 pages of the Toolbox
provide in-built support for the UML profile for XSD 1041 . This enables an abstract UML Class model to be
automatically generated as a W3C XML Schema (XSD) file.
The following Class diagram models simple schema for an example Employee Details system, intended to
store a company's employee contact information. The Classes shown form the EmployeeDetails package. The
UML attributes of the Classes map directly to XML elements or attributes. Note that the Classes have no
methods, since there is no meaningful correspondence between Class methods and XSD constructs.

The following code shows the schema generated for the Employee Details package by default. Notice how
each UML Class corresponds to a complexType definition in the schema. The Class attributes are generated
as schema elements contained in a Sequence model group within the definition. The Enumeration Class is the
exception here - it maps directly to an XSD enumeration, contained within a simpleType definition.

<?xml version="1.0"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="ContactInfo" type="ContactInfo"/>
<xs:complexType name="ContactInfo">
<xs:sequence>
<xs:element name="ContactInfo.homePhone" type="xs:string" maxOccurs="1"/>
<xs:element name="ContactInfo.email" type="xs:string"/>
<xs:element name="ContactInfo.streetAddress" type="xs:string"/>
<xs:choice>
<xs:element name="ContactInfo.mobilePhone" type="xs:string"/>
<xs:element name="ContactInfo.officePhone" type="xs:string"/>
</xs:choice>

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1041

</xs:sequence>
</xs:complexType>
<xs:simpleType name="Gender">
<xs:restriction base="xs:string">
<xs:pattern value="male|female"/>
</xs:restriction>
</xs:simpleType>
<xs:element name="Employee" type="Employee"/>
<xs:complexType name="Employee">
<xs:complexContent>
<xs:extension base="Person">
<xs:sequence>
<xs:element name="status" type="Status"/>
<xs:element name="jobTitle" type="xs:string"/>
<xs:element name="startDate" type="xs:date"/>
<xs:element name="department" type="xs:string"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="Person" type="Person"/>
<xs:complexType name="Person">
<xs:sequence>
<xs:element name="surName" type="xs:string" maxOccurs="1"/>
<xs:element name="firstName" type="xs:string" maxOccurs="1"/>
<xs:element name="birthDate" type="xs:string" maxOccurs="1"/>
<xs:element name="contactDetails" type="ContactInfo"/>
</xs:sequence>
<xs:attribute name="gender" use="optional" type="Gender"/>
</xs:complexType>
<xs:element name="EmployeeRecords" type="EmployeeRecords"/>
<xs:complexType name="EmployeeRecords">
<xs:all>
<xs:element name="Employee" type="Employee"/>
</xs:all>
</xs:complexType>
<xs:simpleType name="Status">
<xs:restriction base="xs:string">
<xs:enumeration value="Full-Time"/>
<xs:enumeration value="Part-Time"/>
<xs:enumeration value="Casual"/>
` <xs:enumeration value="Contract"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>

The following topics provide further explanation:

· UML Profile for XSD 1041
· XSD Datatypes Package 1047

· Abstract XSD Models 1047

5.2.8.2.1 UML Profile for XSD

The UML Profile for XSD specifies a set of stereotypes, Tagged Values and constraints that can be applied to
the UML model in order to change particular aspects of the resulting schema. For example, you might have to
convert certain UML Class attributes to XSD attributes, or use a model group other than the default Sequence.
Enterprise Architect provides native support for the UML Profile for XSD via the XML schema 420 pages of the
Toolbox. Alternatively, you can use the profile via Enterprise Architect's generic profile mechanism by
downloading the UML Profile for XSD. See the Using Profiles 906 topic for details on importing UML profiles
into Enterprise Architect. The XSD profile used by Enterprise Architect is an adaptation of the profile defined
in Modeling XML Applications with UML (David Carlson).
The XSD stereotypes provide an explicit mapping from XSD to UML constructs. The Tagged Values further
define aspects of the mapping, such as whether the elements should be qualified. Full information on the
Tagged Values can be obtained from the W3C XML Schema recommendation. The constraints define any
conditions that must be satisfied for the stereotype to apply.
The following stereotypes are provided:
· XSDschema 1042
· XSDcomplexType 1043

© 1998-2010 Sparx Systems Pty Ltd

 1042 Modeling Languages | Specialized UML Models

· XSDsimpleType 1043
· XSDsequence 1044
· XSDchoice 1044
· XSDelement 1044
· XSDattribute 1045
· XSDany 1045
· XSDrestriction 1045
· XSDgroup 1046
· XSDtopLevelElement 1046
· XSDtopLevelAttribute 1046
· XSDunion 1047
· XSDattributeGroup 1047 .
The following tables list the features of the UML Profile for XSD.

Notes:
· Tagged Value names are shown in bold followed by the allowed values.
· If a default value is used by Enterprise Architect's schema generator, it is underlined.

«XSDschema»
UML Package
Construct

Description All Classes in a package are defined within one schema. This
stereotype can be used to specify schema-wide settings.

Tagged anonymousRole: Specifies if the role name is included in the element declaration
Values (true | false) for the UML attribute.

anonymousType: Specifies whether the Class type is anonymous for attributes.

(true | false)

attributeFormDefault: Determines whether attribute instances must be qualified.

(qualified | unqualified)

defaultNamespace: The default namespace used in this schema. This value is used
to specify the default namespace attribute (xmlns=), in the
schema element.

elementDerivation: Determines whether inheritances are generated using XSD

(true | false) extension or copy-down inheritance.

elementFormDefault: Determines whether element instances must be qualified.

(qualified | unqualified)

memberNames: Determines whether elements generated from Class attributes

(qualified | unqualified) have their name qualified by the corresponding Class name.

modelGroup: Specifies the default XSD model group used to generate

(all | sequence | choice) complexType definitions.

schemaLocation: The URI that identifies the location of the schema. This value is
used in the import and include elements.

targetNamespace: The URI that uniquely identifies this schema's namespace.

targetNamespacePrefix: The prefix that abbreviates the targetNamespace.

version: The version of this schema.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1043

Constraints None.

«XSDcomplexType»
UML Class
Construct

Description complexType definitions are created for generic UML Classes.

This stereotypes helps tailor the generation of a complexType
definition.

Tagged memberNames: Determines whether elements generated from the UML Class
Values (qualified | unqualified) attributes and associations have their name qualified by the
corresponding Class name for this complexType definition.

mixed: Determines whether this element can contain mixed element

(true | false) and character content. See the W3CXML Schema
recommendation.

modelGroup: Overrides the default XSD model for generating this

(all | sequence | choice) complexType definition.

Constraints None.

«XSDsimpleType»
UML Class
Construct

Description An XSD simpleType is generated for Classes with this

stereotype.

Tagged derivation: Specifies the derivation of the simpleType. See the W3C XML
Values (restriction | list) Schema recommendation.

length:

minLength:

maxLength:

minInclusive:
See the W3C XML Schema recommendation.
minExclusive:

maxInclusive:

maxExclusive:

totalDigits:

fractionDigits:

whiteSpace:

pattern:

Constraints This Class can only participate in an inheritance relation with

another simpleType. It cannot have any attributes or own any
associations; they are ignored if present.

© 1998-2010 Sparx Systems Pty Ltd

 1044 Modeling Languages | Specialized UML Models

«XSDsequence»
UML Class
Construct

Description The schema generator creates a sequence model group as the

container for the attributes and associations owned by this
Class. The model group is in turn added to the model groups of
this Class respective owners.

Note:
Tagged values specified by owners of this Class persist through
to the child elements of this model group. Thus if
memberNames are unqualified for a complexType, so are the
children of this model group when added to that complexType.

Tagged None.
Values

Constraints This Class must be the destination of unidirectional associations.

If it is not, this Class and its connectors are ignored, possibly
invalidating other model group Classes.
Inheritance relations are ignored for this Class.

«XSDchoice»
UML Class
Construct

Description Creates an XSD choice element. See XSDsequence for more

details.

Tagged None.
Values

Constraints As for XSDsequence.

«XSDelement»
UML Attribute: AssociationEnd
Construct

Description By applying this stereotype to a UML Class attribute or

AssociationEnd, the corresponding UML entity is generated as
an element within the parent complexType and not as an XSD
attribute.

Tagged form: Overrides the schema's elementFormDefault value.

Values (qualified | unqualified)

position: Causes the elements to be ordered within a sequence model

group of the containing complexType. Duplicated and invalid
position Tagged Values are ignored and result in undefined
ordering of the UML attributes. Missing position values cause the
defined positions to be allocated as specified, with the remaining
elements filling the missing positions in an undefined order.

anonymousRole: Specifies if the role name is included in the element declaration

(true | false) for the UML attribute.

anonymousType: Specifies whether the Class type is anonymous for attributes.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1045

(true | false)

default
See the W3C XML Schema recommendation.
fixed

Constraints None.

«XSDattribute»
UML Attribute: AssociationEnd
Construct

Description By applying this stereotype to a UML Class attribute or

AssociationEnd, the corresponding UML entity is generated as
an XSD attribute within the parent complexType and not as an
XSD element.

Tagged form: Overrides the schema's attributeFormDefault value.

Values (qualified | unqualified)

use:
(prohibited | optional |
See the W3C XML Schema recommendation.
required)

default

fixed

Constraints The attribute datatype should not see a Class specification,

otherwise it is ignored.

«XSDany»
UML Class: Attribute
Construct

Description If applied to a UML attribute, an XSD anyAttribute element is

generated. If applied to a UML Class, an XSD any element is
generated.

Tagged namespace:
Values See the W3C XML Schema recommendation.
processContents:
(skip | lax | strict)

Constraints None.

«XSDrestriction»
UML Generalization
Construct

Description Overrides the default use of XSD extension for inheritance and
generates the child as a complexType with a restriction element
instead.

Tagged None.
Values

© 1998-2010 Sparx Systems Pty Ltd

 1046 Modeling Languages | Specialized UML Models

Constraints Applies only to UML Class parent-child relations.

«XSDgroup»
UML Class
Construct

Description An XSDgroup is generated for Classes with this stereotype.

Tagged modelGroup: Overrides the default XSD model for generating this group
Values (sequence | choice | all) definition.

Constraints A group Class can only associate itself to other group Classes.
A group Class can be associated by another group Class or a
complexType Class.
The association should be via an Association connector.
A group Class cannot be inherited/aggregated.

«XSDtopLevelElement»
UML Class
Construct

Description Creates an <xs:element> construct which acts as a container for

XSDcomplexType and XSDsimpleType Class.

Tagged default
Values See the W3C XML Schema recommendation.

fixed

Constraints An XSDtopLevelElement Class can contain either an

XSDsimpleType or an XSDcomplexType as its child Class. When
such a Class is present as its child, all its inheritance is ignored.
This Class cannot be inherited.

«XSDtopLevelAttribute»
UML Class
Construct

Description Creates an <xs:attributr> construct which acts as a container for

XSDsimpleType Class.

Tagged use:
Values (optional | required |
See the W3C XML Schema recommendation.
prohibited)

default

fixed

Constraints An XSDtopLevelAttribute Class can contain only an

XSDsimpleType Class as its child Class. When such a Class is
present as its child, all its inheritance is ignored.
This Class can inherit from only one XSDsimpleType Class.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1047

«XSDunion»
UML Class
Construct

Description Creates an <xs:union> construct which can act as a container for

XSDsimpleType Class.

Tagged None
Values

Constraints An XSDunion Class can contain only XSDsimpleType as its child

Class and can generalize from other XSDsimpleType Classes
only.
All the Classes that this Class generalizes become the members
of the attribute memberTypes.
This Class cannot have any attributes or associations.

«XSDattributeGroup»
UML Class
Construct

Description Creates an <XSDattributeGroup> construct which can act as a

container for a set of elements for stereotype XSDattribute.

Tagged None
Values

Constraints An XSDattributeGroup Class can contain only elements of

stereotype XSDattribute and can be associated only with other
XSDattributeGroup Classes.
Only XSDcomplexType Classes can associate with this Class.
This Class cannot be inherited.

5.2.8.2.2 XSD Datatypes Package

When modeling XSD constructs, it is often useful to have the XSD primitive types represented as UML
elements. In this way user-defined types, for example, can reference the datatype elements as part of
inheritance or association relationships.
Sparx Systems provides the set of primitive XSD data types as a UML package in the form of an XMI file. Each
of the XSD primitive types is represented by a UML Class in a package named XSDDatatypes. To import the
XSDDatatypes package into your model, follow the steps below:
1. Download the XSDDatatypes package using the following link: XSDDatatypes Package. The file
XSDDataTypes.xml is an XMI file.
2. Use Enterprise Architect's XMI import 290 facility, which is available via the Project | Import/Export |
Import Package from XMI menu option.
3. When the XMI import is complete, you have the UML package named XSDDatatypes in your model,
from which you can drag and drop the relevant types as required.

5.2.8.2.3 Abstract XSD models

XML schemas can be modeled using simple, abstract Class models. This can be useful in enabling an
architect to start work at a higher level of abstraction, without concern for the implementation details of a
schema. Such an abstract model can be refined further using the XML Schema 420 pages of the Toolbox, or it
can be generated directly by Enterprise Architect's schema generator 1376 . In this case, a set of default
mappings 1049 is assumed by the schema generator to convert the abstract model to an XSD file.
The following is a simplified version of the Employee Details example model, which does not use XSD-specific
stereotypes or Tagged Values.

© 1998-2010 Sparx Systems Pty Ltd

 1048 Modeling Languages | Specialized UML Models

The following schema fragment would be generated by Enterprise Architect, given the above model.
<?xml version="1.0"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:simpleType name="Status">
<xs:restriction base="xs:string">
<xs:enumeration value="Full-Time"/>
<xs:enumeration value="Part-Time"/>
<xs:enumeration value="Casual"/>
<xs:enumeration value="Contract"/>
</xs:restriction>
</xs:simpleType>
<xs:element name="Person" type="Person"/>
<xs:complexType name="Person">
<xs:sequence>
<xs:element name="firstName" type="xs:string"/>
<xs:element name="surName" type="xs:string"/>
<xs:element name="birthDate" type="xs:string"/>
<xs:element name="gender" type="xs:string"/>
<xs:element name="contactDetails" type="ContactInfo"/>
</xs:sequence>
</xs:complexType>
<xs:element name="Employee" type="Employee"/>
<xs:complexType name="Employee">
<xs:complexContent>
<xs:extension base="Person">
<xs:sequence>
<xs:element name="status" type="Status"/>
<xs:element name="jobTitle" type="xs:string"/>
<xs:element name="startDate" type="xs:date"/>
<xs:element name="department" type="xs:string"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="EmployeeRecords" type="EmployeeRecords"/>
<xs:complexType name="EmployeeRecords">
<xs:sequence>
<xs:element name="Employee" type="Employee" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:element name="ContactInfo" type="ContactInfo"/>
<xs:complexType name="ContactInfo">
<xs:sequence>
<xs:element name="homePhone" type="xs:string"/>

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1049

<xs:element name="mobilePhone" type="xs:string"/>

<xs:element name="officePhone" type="xs:string"/>
<xs:element name="email" type="xs:string"/>
<xs:element name="streetAddress" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:schema>

5.2.8.2.3.1 Default UML to XSD Mappings

The following table describes the default mapping of UML to XSD constructs. This set of mappings is useful
when defining simple schemas from abstract Class models. The defaults are also assumed by the schema
generator when generating unstereotyped elements in an abstract model. The XML Schema pages of the
Toolbox (and UML Profile for XSD) override these default mappings through the use of stereotypes and
Tagged Values.

UML Construct Default XSD Production Rules

Package A schema element is generated for the target package. If the target package includes
Classes from another package, which has the Tagged Values targetNamespace and
targetNamespacePrefix set, these are included as attributes of the schema element.
In addition, an import or include element is created for each referenced package. (An
include element is used if the external package shares the same targetNamespace
Tagged Value as the target package. An import element is used where the
targetNamespaces differ).

Class A root-level element declaration and complexType definition are generated. The
element name and type are the same as the Class name. An XSD sequence model
group is generated to contain UML attributes generated as elements.

Attribute An element is declared for each Class attribute. The element name is set to that of the
UML attribute name. This is prefixed with the Class name to make the element unique.
The minOccurs and maxOccurs attributes are set to reflect the attribute cardinality.

Note:
If left unspecified, minOccurs and maxOccurs default to 1.

If the attribute refers to another Class, the element declaration is followed a

complexType definition, which contains a reference to the appropriate complexType.

Association An element is declared for each association owned by a Class. The element name is
set to that of the association role. The minOccurs and maxOccurs reflect the
cardinality of the association.

Note:
If the direction of the association is unspecified, the owner is assumed to be the
source.

Generalization For single inheritances, an extension element is generated with the base attribute set
(Inheritance) to the base Classname. The UML attributes of the child Class are then appended to
an all model group within the extension element.

«enumeration» (st A simpleType element is declared for the enumeration Class with the name attribute
ereotype) set to the Classname. A restriction element is generated with base set to string. Each
of the Class attributes is appended to the restriction element as XSD enumeration
elements with value set to the UML attribute name. Any type specification for the UML
attributes is ignored by the schema generator.

5.2.9 Web Services - WSDL

Enterprise Architect enables rapid modeling, forward engineering and reverse engineering of Web Service
Definition Language (WSDL), a key W3C XML technology.
WSDL support is critical for the development of a complete Service Oriented Architecture (SOA), and the
coupling of UML 2.3 and XML provides the natural mechanism for specifying, constructing and deploying
XML-based SOA artifacts within an organization. This section explains how to use Enterprise Architect to

© 1998-2010 Sparx Systems Pty Ltd

 1050 Modeling Languages | Specialized UML Models

model WSDL 1050 files.

5.2.9.1 Model WSDL

The WSDL pages 420 of the Toolbox can be used to conveniently model WSDL documents. WSDL
documents are represented as components marked with the stereotype WSDL. WSDL documents are
contained in a package hierarchy representing the target WSDL namespace and its constituent XSD Types,
Messages, PortTypes, Bindings and Services. The top-level package is stereotyped as a WSDLnamespace.
The figure below shows a WSDL namespace package structure:

A WSDLnamespace package can contain one or more WSDL components. Each WSDL component can be
automatically generated to a WSDL file using Enterprise Architect's built in WSDL generator 1379 . The following
topics describe the various WSDL elements and features supported by Enterprise Architect:

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1051

· WSDL Namespace 1051

· WSDL Document 1053
· WSDL Service 1054
· WSDL Port Type 1056
· WSDL Message 1056
· WSDL Binding 1057
· WSDL Port Type Operation 1059

· WSDL Message Part 1060

5.2.9.1.1 WSDL Namespace

The WSDL namespace in Enterprise Architect represents the top-level container for the WSDL elements,
including WSDL documents. Conceptually it maps to the targetNamespace in a WSDL definition element. A
given WSDL namespace can reuse its schema Types, Messages, Port Types, Bindings and Service across
multiple physical WSDL documents.
The figure below shows an example WSDL namespace (OnlineBookstore PSM, which has a red margin to the
bottom right corner), including a single WSDL document:

© 1998-2010 Sparx Systems Pty Ltd

 1052 Modeling Languages | Specialized UML Models

To create a new WSDL namespace in your model, follow the steps below.
1. Open or create the appropriate diagram.
2. Select the More Tools | WSDL menu option from the Toolbox.
3. Drag the Namespace element from the Toolbox onto the diagram. The WSDL Namespace Properties
dialog displays:

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1053

4. Type in a WSDL Package Name and Target Namespace name. You can edit these values later.
5. Click on the OK button to create a package stereotyped as WSDLnamespace. This contains the
following sub-packages and an Overview diagram to navigate between the sub-packages:
· Types: Contains the XSD types used by the WSDL Message elements; this package is modeled as
an XML Schema 1040 , and you drag XSDelement 1044 , XSDsimpleType 1043 and XSDcomplexType 1043
elements onto the Types diagram from the XML Schema 420 page 420 of the Toolbox
· Messages: Contains the WSDL Messages, modeled as UML Classes marked with the stereotype
WSDLmessage
· PortTypes: Contains the WSDL Port Types, modeled as UML interfaces marked with the stereotype
WSDLportType
· Bindings: Contains the WSDL Bindings, modeled as UML Classes that realize the PortTypes
· Services: Contains the WSDL Services, modeled as UML interfaces with associations to each
exposed Binding.
6. Use the Overview diagram to navigate between the subpackages, by double-clicking the relevant
packages. You can edit the sample WSDL elements created in the previous step, or drag new items
from the WSDL pages of the Toolbox onto the relevant diagrams.

You can edit the WSDL-specific properties of the namespace later by double-clicking the package in the
Project Browser. Alternatively, on the WSDL Namespace Properties dialog, click on the UML button to invoke
the standard Properties dialog for a package. (This button does not display on the initial WSDL Namespace
Properties dialog for a new Namespace element.)

5.2.9.1.2 WSDL Document

WSDL documents are represented in Enterprise Architect by UML components stereotyped as «WSDL».
These components are modeled as direct child elements of the top-level WSDL namespace package. You can
create multiple WSDL documents for a single namespace, thus enabling the services for that namespace to
be reused and exposed as required across multiple WSDLs.
To define new WSDL document components for your namespace, follow the steps below:
1. Open the Overview diagram defined for your WSDL namespace package, and drag the WSDL element
from the Toolbox onto the diagram. The WSDL Document Properties dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1054 Modeling Languages | Specialized UML Models

2. Type in the Name and File Name for the document.

3. The XMLNS panel lists the default XML namespaces used by the document. If required, click on the
New button to add further namespaces.

Note:
You can also delete any namespace entries that you add. It is recommended that you do not delete
any of the default entries, as it may cause an invalid WSDL document to be generated.

4. Select one or more services that should be exposed by this document. The list of available services is
populated from the Services package 1054 .
5. Click on the OK button.
You can edit the WSDL-specific properties of the document later by double-clicking the component in the
diagram or the Project Browser. Alternatively, click on the UML button in the WSDL Document Properties
dialog to invoke the standard Properties dialog for a package. (This button does not display on the initial
WSDL Document Properties dialog for a new WSDL element.)

5.2.9.1.3 WSDL Service

WSDL services are represented in Enterprise Architect by UML interfaces, stereotyped as WSDLservice.
Services should be defined under the Services packages in the WSDL namespace structure.
To define new WSDLservice elements for your namespace, follow the steps below:
1. Open the Overview diagram defined for your WSDL namespace package, and double-click on the

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1055

Services package element to open the Services diagram.

2. Drag the Service element from the Toolbox onto the diagram. The WSDL Service dialog displays.

3. In the Name field, type the service name.

4. Click on the New button to add Service Ports. The WSDL Port dialog displays.

5. Type in the Port Name and Location, and select a Binding. The list of Bindings is taken from those
defined in the Bindings package 1057 .
6. Click on the OK button to close the WSDL Port dialog. For each Port defined in this way, Enterprise
Architect creates an Association relationship between the Service and corresponding Binding element.
7. Click on the OK button to close the WSDL Service dialog.
You can edit the WSDL-specific properties of the service later by double-clicking the Service interface in the
diagram or Project Browser. Alternatively, click on the UML button in the WSDL Service dialog to invoke the
standard Properties dialog for an interface. (This button does not display on the initial WSDL Service dialog for
a new Service element.)

© 1998-2010 Sparx Systems Pty Ltd

 1056 Modeling Languages | Specialized UML Models

5.2.9.1.4 WSDL Port Type

WSDL Port Types are represented in Enterprise Architect by UML interfaces stereotyped as WSDLportType.
PortTypes should be defined under the PortTypes packages in the WSDL namespace structure.
To define new WSDLportType elements for your namespace, follow the steps below:
1. Open the Overview diagram defined for your WSDL namespace package, and double-click on the
PortTypes package to open the PortTypes diagram.
2. Drag the Port Type element from the Toolbox onto the diagram. The WSDL PortType dialog displays.

3. Type in the name for the portType.

4. Click on the OK button to close the WSDL PortType dialog.
5. Define operations for the portType by dragging the Port Type Operation 1059 item from the WSDL page
of the Toolbox onto the portType interface.
You can edit the WSDL-specific properties of the portType later by double-clicking the interface in the diagram
or Project Browser. Alternatively, in the WSDL PortType dialog, click on the UML button to invoke the
standard Properties dialog for an interface. (This button does not display on the initial WSDL PortType dialog
for a new PortType element.)

5.2.9.1.5 WSDL Message

WSDL messages are represented in Enterprise Architect by UML Classes stereotyped as WSDLmessage.
Messages should be defined under the Messages package in the WSDL namespace structure.
To define new WSDLmessage elements for your namespace, follow the steps below:
1. Open the Overview diagram defined for your WSDL namespace package, and double-click on the
Messages package to open the Messages diagram.
2. Drag the Message element from the Toolbox onto the diagram. The WSDL Message dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1057

3. Type in the Name for the message.

4. Click on the OK button to close the WSDL Message dialog.
5. You can define parts for the message by dragging the Message Part 1060 element from the WSDL
Elements page of the Toolbox onto the Message element.
You can edit the WSDL-specific properties of the message later by double-clicking the Message element in
the diagram or Project Browser. Alternatively, on the WSDL Message dialog, click on the UML button to
invoke the standard Properties dialog for a Class. (This button does not display on the initial WSDL Message
dialog for a new Message element.)

5.2.9.1.6 WSDL Binding

WSDL bindings are represented in Enterprise Architect by UML Classes stereotyped as WSDLbinding.
Bindings should be defined under the Bindings package in the WSDL namespace structure. Each
WSDLbinding Class implements the operations specified by a particular WSDLportType interface. Therefore,
WSDLportTypes should be defined before 1056 creating WSDLbindings.
To define new WSDLbinding elements for your namespace, follow the steps below:
1. Open the Overview diagram defined for your WSDL namespace package, and double-click on the
Bindings package to open the Bindings diagram.
2. Drag the Binding element from the Toolbox onto the diagram. The WSDL Binding dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1058 Modeling Languages | Specialized UML Models

3. Type in a Name for the Binding.

4. Select the PortType for the Binding; the drop-down list of PortTypes is taken from those defined in the
PortTypes package.
5. Select the Protocol for the Binding, either http or soap.
6. For SOAP Bindings, enter the Transport URL and select the Style. For http Bindings, select the Verb.
7. Click on the OK button to close the WSDL Binding dialog and create the binding. A realization
connector is created between the binding and the corresponding Port Type interface.
8. To specify the Binding operations, select and double-click on an Operation in the Binding element. The
WSDL Binding Operation Details dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1059

9. Type in or select the Binding Operation details.

10. Click on the Parameters button. The WSDL Binding Operation Parameters dialog displays. For each
input, output and fault, click on the Details button and enter the details.
11. Click on the OK button on each of the WSDL Binding Parameter Details, WSDL Binding Operation
Parameters and WSDL Binding Operation Details dialogs to close them.
You can edit the WSDL-specific properties of the binding later by double-clicking the binding Class in the
diagram or Project Browser. Alternatively, on the WSDL Binding dialog, click on the UMLbutton to invoke the
standard Properties dialog for a Class. (This button does not display on the initial WSDL Binding dialog for a
new Binding element.)

5.2.9.1.7 WSDL Port Type Operation

WSDL portType operations are represented in Enterprise Architect by operations defined as part of a
WSDLportType interface (see the WSDL Port Type 1056 topic).
To add portType operations to your WSDLportType interfaces, follow the steps below.
1. Open the Overview diagram defined for your WSDL namespace package, and double-click on the
PortTypes package to open the PortTypes diagram.
2. Drag the PortType Operation item onto a WSDLPortType stereotyped interface. The WSDL PortType
Operation dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1060 Modeling Languages | Specialized UML Models

3. Type in the Name for the operation.

4. Select the Operation Type.
5. Type in or select the Input, Output and Fault details for the operation. The Message drop-down list is
taken from the WSDLmessage elements defined under the Messages package.
6. Click on the OK button to close the WSDL PortType Operation dialog and create the operation.
You can edit the WSDL-specific properties of the portType operation later by double-clicking the operation in
the diagram or Project Browser. Alternatively, on the WSDL PortType Operation dialog, click on the UML
button to invoke the standard Properties dialog for an operation. (This button does not display on the initial
WSDL PortType Operation dialog for a new PortType Operation.)

5.2.9.1.8 WSDL Message Part

WSDL message parts are represented in Enterprise Architect by UML attributes defined as part of a
WSDLmessage Class (see the WSDL Message 1056 topic).
To add message parts to your WSDLmessage Classes, follow the steps below:
1. Open the Overview diagram defined for your WSDL namespace package, and double-click on the
Messages package to open the Messages diagram.
2. Drag the Message Part element onto a WSDLmessage stereotyped Class. The WSDL Message Part
Enterprise Architect User Guide
 Modeling Languages | Specialized UML Models 1061

dialog displays.

3. Type in a Name and Type for the message part. The type should be selected from the drop-down list of
primitive XSD types or from the types defined under the Types package.
4. Click on the OK button.
You can edit the WSDL-specific properties of the message part later by double-clicking the attribute in the
diagram or Project Browser. Alternatively, on the WSDL Message Part dialog, click on the UML button to
invoke the standard Properties dialog for an attribute. (This button does not display on the initial WSDL
Message Part dialog for a new message part attribute.)

5.2.10 SPEM
According to the Object Management Group (OMG) Software & Systems Process Engineering Meta-Model
Specification (Version 2.0, April 01 2008):
The Software and Systems Process Engineering Meta-model (SPEM) is a process engineering
meta-model as well as conceptual framework, which can provide the necessary concepts for modeling,
documenting, presenting, managing, interchanging, and enacting development methods and processes.
An implementation of this meta-model would be targeted at process engineers, project leads, project
and program managers who are responsible for maintaining and implementing processes for their
development organizations or individual projects.
In 1999, the OMG placed a Request for Proposal concerning Software Process Engineering (SPE). In
November 2002, the OMG released the Software Process Engineering Meta-model Specification 1.0. SPEM
was defined as a Profile of UML, which used UML as a notation and took an object-oriented approach. To
accommodate UML 2, the SPEM specification was upgraded to 2.0 in April 2008.
For more information on the concepts of SPEM, please refer to the full specification at
http://www.omg.org/spec/SPEM/2.0/PDF.

SPEM in Enterprise Architect

SPEM 2.0 focuses on providing the additional information structures that you require for processes modeled
with UML 2 Activities or BPMN/BPDM, to describe an actual development process.
Enterprise Architect enables you to develop SPEM diagrams quickly and simply, through use of an MDG
Technology integrated with the Enterprise Architect installer. The SPEM facilities are provided in the form of:
· A SPEM diagram type, accessed through the New Diagram 422 dialog
· A set of SPEM pages 1062 in the Toolbox, providing SPEM elements (stereotyped UML elements)
· SPEM element and relationship entries in the Toolbox Shortcut 403 Menu and Quick Linker 474 .

Disable SPEM
If you prefer not to use SPEM in Enterprise Architect, you can disable it (and subsequently re-enable it) using
the MDG Technologies 1069 dialog (Settings | MDG Technologies).

© 1998-2010 Sparx Systems Pty Ltd

 1062 Modeling Languages | Specialized UML Models

5.2.10.1 SPEM Toolbox Pages

You can access the SPEM pages of the Toolbox through the More tools | SPEM menu option. These pages
provide the graphical SPEM elements for drawing the diagrams.

Enterprise Architect User Guide

Modeling Languages | Specialized UML Models 1063

© 1998-2010 Sparx Systems Pty Ltd

 1064 Modeling Languages | Specialized UML Models

Page Item Use to

Base Plug-in Phase Create a predefined special Activity representing a significant

period in a project.

Iteration Group a set of nested Activities that are repeated more than
once. Typically, Iteration is an Activity for which the default
value of the isRepeatable attribute is True.

Process Represent a special Activity that describes a structure for

particular types of development projects, or parts of them.

Delivery Process Represent a special Process describing a complete and

integrated approach for implementing a specific project type.

Process Pattern Represent a special Process to describe a reusable cluster of

Activities in a general process area that provides a consistent
development approach to common problems.

Process Planning Represent a special Process that is prepared for instantiation

Template by a project planning tool.

Artifact Represent a Work Product Definition that provides a

description and definition for tangible work product types.

Deliverable Represent a Work Product Definition that provides a

description and definition for packaging other Work Products,
and that can be delivered to an internal or external party.

Outcome Represent a Work Product Definition that provides a

description and definition for non-tangible work products.

Method Content Category Categorize content based on the user’s criteria.

Guidance Identify reference items such as Guidelines, Templates,

Checklists, Tool Mentors, Estimates, Supporting Materials,
Reports and Concepts.

Metric Define a standard measurement for instances of Method

Content elements.

Role Definition Define a set of related skills, competencies, and

responsibilities.

Step Represent parts or subunits of a Task Definition.

Task Definition Describe an assignable unit of work. Every Task Definition is

assigned to specific Role Definitions. A Task is associated with
input and output Work Products.

Tool Definition Describe the tools that are recommended or necessary for
completing a specific Task.

Work Product Define any forms of document, report or outcome that are
Definition consumed, produced or modified by Tasks.

Package Method Content Create a physical container to organize the Method Content
Package elements.

Method Library Create an overall physical container for all SPEM 2.0
elements.

Method Plugin Create a physical container for Method Content Package and
Process Packages. It can be used stand-alone as well as
extended to many other Method Plugins.

Process Package Create a physical container that contains different kinds of

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1065

Page Item Use to

Process element.

Process Component Create a special Process Package that provides the

mechanism of encapsulation.

Process Activity Define basic units of work within a Process as well as the
Process itself.

Composite Role Represent an aggregation of Role Definition references for an

Activity.

Milestone Represent any significant events in a development project.

Process Create a special Activity that describes a structure for

particular types of development project.

Role Use Represent a Role Definition in the context of one specific

Activity.

Task Use Represent a Task Definition in the context of one specific

Activity.

Team Profile Define a nested hierarchy of teams and team members.

Work Product Use Represent a Work Product Definition in the context of one
specific Activity.

In Enterprise Architect, every SPEM stereotype can be presented in one of two ways:
· Iconic presentation, or
· Textual presentation.
The iconstyle tag is used for switching between these presentations. For example, in the SPEM diagram
below, if you want the SPEM_TaskDefinition to have iconic presentation you set the iconstyle Tagged Value
to True, and display the element as an icon. To get the textual presentation for SPEM_TaskDefinition, as an
outline with a decoration in the top right corner, set the Tagged Value to False.

© 1998-2010 Sparx Systems Pty Ltd

 1066 Modeling Languages | Specialized UML Models

5.2.11 MDG Technologies - Using

The Model Driven Generation (MDG) Technologies enable you to access and use resources pertaining to a
specific technology in Enterprise Architect. You have various options for bringing MDG Technologies into use
with Enterprise Architect:
· Sparx Systems already provide some in the Enterprise Architect Install directory, such as Archimate 1073 ,
Data Flow Diagrams 1076 , Entity Relationship Diagrams 1077 , ICONIX 1084 , and Mind Mapping 1087 ; you can
see which technologies are available using the MDG Technologies 1069 dialog; these are available across
Enterprise Architect
· You can access and activate 1070 MDG Technologies remote from Enterprise Architect, in system folders or
web sites; these are available across Enterprise Architect
· Technology Developers can create new MDG Technologies 1092 and deploy them to the project team as
appropriate.
You can also import Technologies 1071 into the Resources window for the current model only; however, this
method is no longer recommended.
Having made the MDG Technologies available to Enterprise Architect, you can manage 1069 their availability to
users and you can work 1067 with them.
You also have the facility to turn off 1070 or disable the Enterprise Architect basic UML and Extended Toolbox
pages and facilities, so that you can apply the Enterprise Architect facilities and features exclusively to one or
more selected MDG Technologies.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1067

5.2.11.1 Work with MDG Technologies

Any MDG Technology listed on the MDG Technologies 1069 dialog can be enabled, which makes their interface
profiles and Toolbox pages available for your use.

MDG Technology Toolbox Pages

When you enable an MDG Technology, any Technology-specific diagram types are added to the New
Diagram dialog lists, and the Technology's Toolbox pages are added to those available through the More
tools menus in the Toolbox.

If you set the MDG Technology to Active, its Toolbox pages override any parallel Enterprise Architect Toolbox
pages. For example, the ICONIX Class pages would override the Enterprise Architect Class pages.
You create 422 Technology-specific diagrams and populate them with elements and connectors in the same
way as for standard Enterprise Architect diagrams.

© 1998-2010 Sparx Systems Pty Ltd

 1068 Modeling Languages | Specialized UML Models

The Resources Window

Note:
The method of importing MDG Technologies into the Resources window is available but not recommended. If
you use this method, the MDG Technology Toolbox pages, Tasks Pane, Project Browser icons and model
templates are not available.
It is now recommended that you create or download new technologies into the Enterprise Architect
installation directory, or use new technologies from remote file locations and web sites 1070 .
However, you might previously have imported Technologies into the Resources window, and these are still
available until you specifically delete them (right-click on the Technology and select the Delete Technology
context menu option).

The Resources 667 window (View | Other Element Tools | Resources) displays a tree structure containing
nodes such as imported MDG Technologies, Templates, Documents, Stylesheets, Matrix profiles and UML
Profiles.

MDG Technologies can bundle the functionality provided by UML Profiles, UML Patterns, Code Templates and
Model Types.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1069

Profiles contained in MDG Technologies are applied to:

· Elements such as Classes and Interfaces, which are dragged directly from the Toolbox or the Resources
window to the current diagram
· Attributes, which are dragged over a host element (such as a Class) to be automatically added to the
element feature list
· Operations which, like Attributes, are dragged over a host element to add the operation
· Connectors such as Association, Generalization, and Dependency, which are added by selecting them in
the Toolbox or Resources window, then clicking on the source element in a diagram and dragging to the
target element (in the same way as adding normal connectors); the connector is added with the new
stereotype and Tagged Value information
· Association Ends, which are added by dragging the connector end element over the end of an Association
in the diagram.
Patterns contained in MDG Technologies are used to:
· Enable reuse in a model
· Build in robustness.
Code Templates are used to:
· Specify the transformation from UML elements into various parts of a given programming language.
Model Types are used to:
· Define the data types for the model.

5.2.11.1.1 Manage MDG Technologies

You use the MDG Technologies dialog to manage the MDG Technologies available and accessible to
Enterprise Architect users. To display this dialog, select the Settings | MDG Technologies menu option.

The MDG Technologies dialog lists the technologies held in the Enterprise Architect Install directory, in
alphabetical order.

Enable and Disable MDG Technologies

All MDG Technologies listed can be made available (enabled) or removed from use (disabled). To enable or
disable a Technology, click on its Enabled checkbox.
When an MDG Technology is enabled, three things happen:
· The MDG Technology is added to the list of available options in the profile field of the Default Tools 80

© 1998-2010 Sparx Systems Pty Ltd

 1070 Modeling Languages | Specialized UML Models

toolbar, so that you can apply the interface profiles of the MDG Technology
· At least one set of Toolbox pages for the MDG Technology is automatically added to the Toolbox 399 ; you
can access the added Toolbox pages through the More Tools menu
· Any MDG Technology-specific diagram templates are added to the New Diagram 422 dialog for selection;
when selected, these display the diagram-specific Toolbox pages.
You can quickly enable or disable all the listed MDG Technologies by clicking on the All or None buttons.
However, if you click on the None button, you should scroll to the top of the list and select the Basic UML 2
Technology checkbox to re-enable the UML and Extended Toolbox pages and diagram types.

Set as Default
You can make an MDG Technology the default interface to Enterprise Architect. Depending on the MDG
Technology selected, this can change the way Enterprise Architect windows are displayed and override the
Toolbox pages with pages specific to that Technology.
To set an MDG Technology as the default interface, click on it in the Technology panel and click on the Set
Active button.
This displays an asterisk against the MDG Technology name in the Technology panel, and selects the MDG
Technology in the profile field of the Default Tools toolbar. If the MDG Technology has not been enabled, this
also enables it.

You can also enable one or more of the MDG Technologies (and likely make one of them the default) and
then deselect the Basic UML 2 Technology checkbox, to work exclusively in the selected technologies only.
The UML and Extended Toolbox pages, diagram types and quicklinks are excluded from the Toolbox, More
tools menu, diagrams and New Diagram dialog in the user interface.

MDG Technologies Outside Enterprise Architect

The MDG Technologies dialog lists technologies that have been loaded into the Enterprise Architect install
directory. You can also add MDG Technologies in folders and websites remote from Enterprise Architect. To
do this, click on the Advanced button. See the Access Remote MDG Technologies 1070 topic.

5.2.11.1.1.1 Access Remote MDG Technologies

You can access MDG Technologies in folders and websites remote from Enterprise Architect.
If you have not already identified the location of the MDG Technology, you must first do this. You can then
select 1071 the MDG Technology for use.
Later, if you have no further use for the MDG Technology, you can remove 1071 it from the list of identified MDG
Technologies.

Note:
If you add or remove remote MDG Technologies, you must restart Enterprise Architect to show them on or
remove them from the list on the MDG Technologies dialog.

Identify Remote MDG Technology

To specify the location of the MDG Technology to access, follow the steps below:
1. Select the Settings | MDG Technologies menu option. The MDG Technologies 1069 dialog displays.
2. Click on the Advanced button. The MDG Technologies - Advanced dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1071

3. Click on the Add button. A short context menu displays, offering the options:
· Add Path
· Add URL.
4. To specify an MDG Technology in a directory folder, select the Add Path option. The Browse for Folder
dialog displays.
Browse for the MDG Technology folder, click on it, and click on the OK button. Go to step 6.
5. To specify an MDG Technology on a web site, select the Add URL option. The Input dialog displays.

In the Enter Value field, type or copy-and-paste the MDG Technology URL. Click on the OK button.
6. The folder path or URL for the MDG Technology displays in the Path panel.

Use Remote MDG Technology

To access a remote MDG Technology listed in the MDG Technologies - Advanced dialog, double-click on the
folder path or URL.

Remove Listed MDG Technology

To remove an MDG Technology listed in the MDG Technologies - Advanced dialog, click on the folder path or
URL and click on the Remove button. The path or URL is deleted.

5.2.11.2 Import MDG Technologies

Note:
This method of importing MDG Technologies into the Resources window is available but not recommended. If
you use this method, the MDG Technology Toolbox pages, Tasks Pane, Project Browser icons and model
templates are not available.
It is now recommended that you reference technologies directly from the Enterprise Architect install directory
on your hard drive, or from remote file locations and web sites 1070 .

To import an MDG Technology you must have a suitable MDG Technology XML file. If the MDG Technology
includes references to any metafiles, they should be in the same directory as the MDG Technology XML file.
An imported MDG Technology is available only within the model into which it has been imported, not in every
model you have in Enterprise Architect. To make the MDG Technology available across all your models,
download it into the Enterprise Architect install directory.

© 1998-2010 Sparx Systems Pty Ltd

 1072 Modeling Languages | Specialized UML Models

Import an MDG Technology

To import an MDG Technology, follow the steps below:
1. Select the Tools | Import Technology menu option. The Import Technology dialog displays.

2. In the Filename field, type the path and filename of the MDG Technology file to import, or browse for it
using the [ ... ] button.

Note:
When you enter the filename, the MDG Technology name displays in the Technology field and the
option checkboxes become available. Any options that remain grayed out indicate that no examples of
that type exist in the MDG Technology XML file.

3. All option checkboxes default to selected. Clear those against resources you do not want to import, and
leave selected the checkbox against each of the resources to import. Leave selected:
· Patterns, to import patterns, if they exist
· Images, to import graphics
· Profiles, to import profiles, if they exist
· Element Size, to import the element size attributes
· Alternate Image, to import the metafile image
· Tagged Values, to import Tagged Values
· Color and Appearance, to import the color (background, border and font) and appearance (border
thickness) attributes
· Code Modules, to import the various languages associated with the technology, if they exist
· Data Types, to import the data types
· Code Templates, to import the code templates, if they exist
· Code Options, to import the options that include items such as default file extensions and default
file paths.
4. Click on the Import button.
If the MDG Technology already exists, Enterprise Architect displays a prompt to overwrite the existing version
and import the new one.
Once the import is complete, the MDG Technology is listed in the MDG Technologies folder of the Resources
1067 window and in the MDG Technologies 1069 dialog.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1073

5.2.11.3 Extensions - MDG Technologies

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 Archimate 1073 , BPEL, 958 BPMN 952 , Data Flow Diagrams 1076 , Eriksson-Penker Extensions 1080 , ICONIX 1084
, Mind Mapping 1087 , Systems Modeling Language (SysML) 989 and SPEM 1061 are already provided with the
Enterprise Architect installer.
Enterprise Architect provides support for downloading MDG Technologies 1070 from external system files or
websites, or for creating your own easily with the Enterprise Architect MDG Technology Wizard 1118 .
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)
· Strategic Modeling
· 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.
Sparx Systems provide different editions of Enterprise Architect tailored for systems engineering 14 and
business engineering 13 , or both 13 together. These editions incorporate several of the above MDG
Technologies and other add-ins.

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.

5.2.11.4 Archimate
Archimate is an open-standard enterprise architecture language from The Open Group, based on the IEEE
1471 standard.
Archimate offers a common language for describing the construction and operation of business processes,
organizational structures, information flows, IT systems and technical infrastructure, enabling Enterprise
Architects to describe, analyse and visualize the relationships among business domains in an unambiguous
way.

© 1998-2010 Sparx Systems Pty Ltd

 1074 Modeling Languages | Specialized UML Models

Archimate in Enterprise Architect

Enterprise Architect enables you to develop Archimate diagrams quickly and simply, through use of an
Archimate MDG Technology integrated with the Enterprise Architect installer. The Archimate facilities are
provided in the form of:
· An Archimate diagram type, accessed through the New Diagram 422 dialog
· A set of Archimate pages in the Toolbox
· Archimate element and relationship entries in the Toolbox Shortcut 403 Menu and Quick Linker 474 .

Archimate Toolbox Pages

You can access the Archimate pages of the Toolbox through the More tools | Archimate menu option.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1075

The toolbox pages provide three categories of elements - Information,

Behavior and Structure - and a page of connectors that are largely based
on the UML connectors.
The appearance of elements can be modified with the use of Tagged
Values, as suggested below:
· For Artifact, Process, Function, Interaction, Service, Event, Actor, Role,
Collaboration, Interface, Component, Node and Device elements:
· iconstyle=true shows the iconic representation of the element
· iconstyle=false shows a rectangle with a decoration in the top
corner
· An Interface element (if iconstyle=true) can be provided, required,
symmetric or assembly, and can be rotated, by setting the Tagged
Values
· A Function element (if iconstyle=true) can be rotated
· An Actor element (if iconstyle=false) can be compound
· Process and Function elements can be marked atomic.

Because there is a large range of Archimate elements, you should make

good use of the Quick Linker 474 arrow to guide you in selecting
appropriate source and target elements and relationship types to model
your enterprise architecture.

Disable Archimate
If you prefer not to use Archimate in Enterprise Architect, you can disable it
(and subsequently re-enable it) using the MDG Technologies 1069 dialog (
Settings | MDG Technologies).

© 1998-2010 Sparx Systems Pty Ltd

 1076 Modeling Languages | Specialized UML Models

5.2.11.5 Data Flow Diagrams

The following text is derived from the Data Flow Diagram entry in the online Wikipedia.
A data flow diagram (DFD) is a graphical representation of the "flow" of data through an information
system. A data flow diagram can also be used for the visualization of data processing (structured
design). It is common practice for a designer to draw a context-level DFD first which shows the
interaction between the system and outside entities. This context-level DFD is then "exploded" to show
more detail of the system being modeled.
Data flow diagrams were invented by Larry Constantine ... based on Martin and Estrin's "data flow
graph" model of computation. [They] are one of the three essential perspectives of Structured Systems
Analysis and Design Method SSADM. The sponsor of a project and the end users will need to be
briefed and consulted throughout all stages of a system's evolution. With a dataflow diagram, users are
able to visualize how the system will operate, what the system will accomplish, and how the system will
be implemented. The old system's dataflow diagrams can be drawn up and compared with the new
system's dataflow diagrams to draw comparisons to implement a more efficient system.
Developing a DFD helps in identifying the transaction data in the data model.
For further information on the concepts of Data Flow Diagrams, refer to the Wikipedia item and its linked
sources.

Data Flow Diagrams in Enterprise Architect

Enterprise Architect enables you to develop Data Flow diagrams quickly and simply, through use of an MDG
Technology integrated with the Enterprise Architect installer. The Data Flow diagram facilities are provided in
the form of:
· A Data Flow diagram type, accessed through the New Diagram 422 dialog
· A Data Flow Diagram page in the Toolbox
· Data Flow element and relationship entries in the Toolbox Shortcut 403 Menu and Quick Linker 474 .

Data Flow Diagram Toolbox Page

You can access the Data Flow Diagram page of the Toolbox through the More tools | Data Flow Diagrams
menu option. The following icons are available:

· Process is a process or activity in which data is used or generated

· External represents an external source, user or depository of the data
· Data Store represents an internal physical or electronic repository of data, into and out of which data is
stored and retrieved
· Data Flow (connector) represents how data flows through the system, in physical or electronic form
· Gate represents the termination point of incoming and outgoing messages on a lower level diagram (that
is, messages to and from processes depicted elsewhere).
When dragged onto a Data Flow diagram, the elements and relationship have the following appearances:

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1077

To preserve the simplicity and readability of the diagram, you cannot display the element compartments on the
diagram.

Context Diagram
A Context diagram is a top-level Data Flow diagram that has just one Process element representing the
system being modeled, showing its relationship to external systems.

Disable Data Flow Diagrams

If you prefer not to use Data Flow Diagramming in Enterprise Architect, you can disable it (and subsequently
re-enable it) using the MDG Technologies 1069 dialog (Settings | MDG Technologies).

5.2.11.6 Entity Relationship Diagrams (ERDs)

Note:
Entity Relationship Diagrams are supported in the Corporate, Business and Software Engineering, Systems
Engineering and Ultimate editions of Enterprise Architect.

The following text is derived from the Entity Relationship Model entry in the online Wikipedia:
An entity-relationship model (ERM) is an abstract and conceptual representation of data.
Entity-relationship modeling is a database modeling method, used to produce a type of conceptual
schema or semantic data model of a system, often a relational database, and its requirements in a
top-down fashion. Diagrams created by this process are called Entity-Relationship Diagrams, ER

© 1998-2010 Sparx Systems Pty Ltd

 1078 Modeling Languages | Specialized UML Models

Diagrams, or ERDs.
For further information on the concepts of Entity Relationship Diagrams, refer to the Wikipedia item and its
linked sources.

Entity Relationship Diagrams in Enterprise Architect

Entity Relationship Diagrams in Enterprise Architect are based on Chen's ERD building blocks: entities are
represented as rectangles, attributes are represented as ellipses and relationships are represented as
diamond-shape connectors. ERD technology in Enterprise Architect assists you in every stage from building
conceptual data models to generating Data Definition Language (DDL) for the target DBMS.
Enterprise Architect enables you to develop Entity Relationship diagrams quickly and simply, through use of
an MDG Technology integrated with the Enterprise Architect installer. The Entity Relationship diagram facilities
are provided in the form of:
· An Entity Relationship diagram type, accessed through the New Diagram 422 dialog
· An Entity Relationship Diagram page in the Toolbox
· Entity Relationship element and relationship entries in the Toolbox Shortcut 403 Menu and Quick Linker
474 .

Enterprise Architect also provides transformation templates to transform Entity Relationship Diagrams 1399 into
Data Modeling Diagrams, and vice versa 1390 .

Entity Relationship Diagram Toolbox Page

You can access the Entity Relationship Diagram page of the Toolbox through the More tools | Entity
Relationship Diagrams menu option. The following icons are available:

· Entity is an object or concept that is uniquely identifiable. The property of Multiplicity in the SourceRole and
TargetRole definitions for the Relationship connector (below) can be used to define the cardinality of an
Entity that participates in this relationship.
· Attribute is a property of an entity or a relationship type.
· N-ary Association represents unary (many-to-many recursive) or ternary relationships and can also be
used to represent relationships that have attributes among the entities; Note that the N-ary Association
element should always be at the target end of a connector.
· Connector is a connector between an Entity and an Attribute, and between two Attributes.
· Relationship is a diamond-shape connector, representing the meaningful association among entities.
· Disjoint and Overlapping represent the relationships between the super-class Entity and the sub-class
Entity.

Tagged Values
Some of the Entity Relationship diagram components can be modified by Tagged Values, as indicated below:

Component Tagged Value Notes

Entity isWeakEntity If true, this entity is a weak entity.

Attribute attributeType Four options:

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1079

Component Tagged Value Notes

· normal Attribute
· primary key attribute
· multi-valued Attribute
· derived Attribute.

commonDataType Defines the common data type for each attribute.

dbmsDataType Defines the customized DBMS data type for each attribute.

Note:
You must define the customized type first through the Settings |
Database Datatypes menu option. Also, set the
commonDataType tag to na to activate the dbmsDataType tag.

N-ary isRecursive If true, the N-ary Association represents the many-to-many

Association recursive relationship.
For one-to-many and one-to-one recursive relationships, we
suggest using the normal Relationship connector.

Relationship isWeak If true, the Relationship is a weak relationship.

Disjoin Participation Two options: partial and total.

Overlapping

Diagram
A typical Entity Relationship Diagram is represented below:

© 1998-2010 Sparx Systems Pty Ltd

 1080 Modeling Languages | Specialized UML Models

Tip:
Sometimes you might want to limit the stretch of the diamond-shape Relationship connectors. Simply pick a
Relationship connector, right-click to display the context menu, and select the Bend Line at Cursor option.

Disable Entity Relationship Diagrams

If you prefer not to use Entity Relationship Diagrams in Enterprise Architect, you can disable it (and
subsequently re-enable it) using the MDG Technologies 1069 dialog (Settings | MDG Technologies).

5.2.11.7 Eriksson-Penker Extensions

Eriksson-Penker extensions (developed by H. E. Eriksson and M.Penker) provide a framework for UML
business processing model extensions, to which an enterprise architect can add stereotypes and properties
appropriate to their business.

Eriksson-Penker in Enterprise Architect

Enterprise Architect provides - through the integration of MDG Technologies with the installer - two

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1081

well-respected and proven UML extensions that further enhance the capture of business activities, processes,
objects and information flows. One of these is Business Process Modeling Notation 952 (BPMN). The other is
the Eriksson-Penker profile which, through a set of stereotypes, provides a unique and powerful means of
visualizing and communicating business processes and the necessary flow of information within an
organization.
The Eriksson-Penker extensions are provided in the form of:
· An Eriksson-Penker diagram type, accessed through the New Diagram 422 dialog
· An Eriksson-Penker page in the Toolbox
· Eriksson-Penker element and relationship entries in the Toolbox Shortcut 403 Menu and Quick Linker 474 .

Eriksson-Penker Toolbox Page

You can access the Eriksson-Penker page of the Toolbox through the More tools | Eriksson-Penker
Extensions menu option. The following icons are available:

© 1998-2010 Sparx Systems Pty Ltd

 1082 Modeling Languages | Specialized UML Models

The following is an example of a simple Eriksson-Penker diagram:

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1083

For further information on the MDG Technology for Eriksson-Penker Extensions, see The Business Process
Model tutorial.

5.2.11.8 GoF Patterns

The following text is derived from the Design Patterns entry in the online Wikipedia.
Gang of Four (GoF) Patterns are 23 classic software design patterns providing recurring solutions to
common problems in software design. They were developed by Erich Gamma, Richard Helm, Ralph
Johnson and John Vlissides, often referred to as the Gang of Four. The patterns are defined in the
book Design Patterns: Elements of Reusable Object-Oriented Software (Gamma et al., ISBN
0-201-63361-2).
For further information on the concepts of GoF Patterns, refer to the Wikipedia item and its linked sources.

GoF Patterns in Enterprise Architect

Enterprise Architect enables you to develop diagrams from GoF patterns quickly and simply, through use of an
MDG Technology integrated with the Enterprise Architect installer. The GoF Patterns are provided in the form
of:
· GoF Behavioral Patterns, GoF Creational Patterns and GoF Structural Patterns pages in the Toolbox
· Gang of Four pattern entries in the Toolbox Shortcut 403 Menu.

GoF Toolbox Pages

You can access the GoF Pattern pages of the Toolbox through the More tools | GoF Patterns menu option.
The following icons are available:

© 1998-2010 Sparx Systems Pty Ltd

 1084 Modeling Languages | Specialized UML Models

When you drag one of the pattern elements onto a new diagram, the Add Pattern GoF <pattern
group><pattern type> 904 dialog displays. If necessary, modify the action and/or default for the component
elements, then click on the OK button to create a diagram based on the pattern.
The GoF patterns are drawn from the Resources window. If you delete a pattern in the Resources window the
equivalent Toolbox item cannot work. Therefore, if you cannot drop a pattern element from the Toolbox, check
that it is still available in the Resources window.

Disable GoF Patterns

If you prefer not to use the GoF Patterns technology in Enterprise Architect, you can disable it (and
subsequently re-enable it) using the MDG Technologies 1069 dialog (Settings | MDG Technologies).

5.2.11.9 ICONIX
The following text is derived from the ICONIX entry in the online Wikipedia.
The ICONIX Process is a minimalist, streamlined approach to Use Case driven UML modeling that uses
a core subset of UML diagrams and techniques to provide thorough coverage of object-oriented
analysis and design. Its main activity is robustness analysis, a method for bridging the gap between
analysis and design. Robustness analysis reduces the ambiguity in use case descriptions, by ensuring
that they are written in the context of an accompanying domain model. This process makes the use
cases much easier to design, test and estimate.
The ICONIX Process was developed by Doug Rosenberg. For more information on ICONIX, see the ICONIX
Software Engineering Inc. website http://www.iconixsw.com/.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1085

ICONIX in Enterprise Architect

Enterprise Architect enables you to develop models under ICONIX quickly and simply, through use of an MDG
Technology integrated with the Enterprise Architect installer. The ICONIX facilities are provided in the form of:
· A set of ICONIX pages in the Toolbox
· ICONIX element and relationship entries in the Toolbox Shortcut 403 Menu and Quick Linker 474 .

To further help you develop and manage a project under ICONIX, Enterprise Architect also provides a white
paper on the ICONIX Roadmap.
In addition, Enterprise Architect has an alternative visual layout 1086 specific to ICONIX.

ICONIX Toolbox Pages

Within the Toolbox, Enterprise Architect provides ICONIX versions of the pages for UML Analysis 733 , Use
Case 676 , Class 721 , Interaction (Sequence 706 ), Activity 674 and Custom 734 diagrams (which often form the
basis for Robustness diagrams). Compared to the standard Toolbox pages, these have slightly different
element and relationship sets. You can access them by either:
· Selecting the More tools | ICONIX | <Diagram Type> menu option for a specific Toolbox page, or
· Selecting the ICONIX option in the drop-down field of the Default Tools toolbar, which adds all six pages to
the Toolbox. The first page and the Common page are expanded, and the others are closed up.

© 1998-2010 Sparx Systems Pty Ltd

 1086 Modeling Languages | Specialized UML Models

ICONIX Layout
The ICONIX layout re-organizes the Enterprise Architect work area, opening the:
· Toolbox on the right hand side of the screen (follow the instructions above to display the ICONIX pages)
· The Tasks Pane window auto-hidden in the top right of the screen
· Project Browser window in the top left of the screen, and
· Notes, Properties and Tagged Values windows nested on the bottom left of the screen.

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1087

To apply this layout, select the View | Workspace Layouts menu option and select the Basic Layout
(Alternate) 86 option.

Disable ICONIX
If you prefer not to use ICONIX in Enterprise Architect, you can disable it (and subsequently re-enable it) using
the MDG Technologies 1069 dialog (Settings | MDG Technologies).
This does not affect the ICONIX layout, which you can switch back to your own layout or the Enterprise
Architect default layout using the View | Workspace Layouts menu option.

5.2.11.10 Mind Mapping

The following text is derived from the Mind Map entry in the online Wikipedia.
A Mind Map is a diagram used to represent words, ideas, tasks or other items linked to and arranged
radially around a central key word or idea. It is used to generate, visualize, structure and classify ideas,
and as an aid in study, organization, problem solving, decision making, and writing.
A Mind Map is an image-centered diagram that represents semantic or other connections between
portions of information. By presenting these connections in a radial, non-linear graphical manner, it
encourages a brainstorming approach to any given organizational task, eliminating the hurdle of initially
establishing an intrinsically appropriate or relevant conceptual framework to work within.
The elements are arranged intuitively according to the importance of the concepts and are organized
into groupings, branches, or areas. The uniform graphic formulation of the semantic structure of
information on the method of gathering knowledge, may aid recall of existing memories.
The use of the term Mind Maps is trademarked in the UK and the USA by The Buzan Organization, Ltd.
For further information on the concepts of Mind Mapping, refer to the Wikipedia item and its linked sources.

Mind Mapping in Enterprise Architect

Enterprise Architect enables you to develop Mind Maps quickly and simply, through use of an MDG
Technology integrated with the Enterprise Architect installer. The Mind Mapping facilities are provided in the
form of:
· A Mind Mapping diagram type, accessed through the New Diagram 422 dialog

© 1998-2010 Sparx Systems Pty Ltd

 1088 Modeling Languages | Specialized UML Models

· A Mind Mapping page in the Toolbox

· Mind Mapping element and relationship entries in the Toolbox Shortcut 403 Menu and Quick Linker 474 .

Mind Mapping Toolbox Page

You can access the Mind Mapping page of the Toolbox through the More tools | Mind Mapping menu option.
The following icons are available:

· Central Topic is the main theme of the Mind Map; you would normally have one or two of these on the
diagram, but can add as many as are necessary
· Main Topic represents the immediate concepts generated by the Central Topic
· Topic represents the larger divisions of a Main Topic
· Sub Topic represents the finer divisions of a Topic or Main Topic; you could also have Subtopics of
Subtopics to represent increasingly finer distinctions
· Relationship represents the connection between any two elements; you can have several Relationships per
element. Each relationship has three anchor points, so you can curve the lines to develop the flow of
concepts more easily.
When dragged onto a Mind Mapping diagram, the elements and relationship have the following appearances:

As the elements can represent any concept, object or relationship, you can use the full range of element
properties and features to expand on what the element represents, including adding Note elements. However,
to preserve the simplicity and readability of the diagram itself, you cannot display the element compartments
on the diagram.

Disable Mind Mapping

If you prefer not to use Mind Mapping in Enterprise Architect, you can disable it (and subsequently re-enable
it) using the MDG Technologies 1069 dialog (Settings | MDG Technologies).

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1089

5.2.11.11 SoaML
Note:
Service Oriented Architecture Modeling Language (SoaML) is supported in the Corporate, Systems
Engineering, Business and Software Engineering and Ultimate editions of Enterprise Architect.

The following text is derived from Service oriented architecture Modeling Language (SoaML) - Specification for
the UML Profile and metamodel for Services (UPMS) (OMG document ad/2008-11-01); pp. 25-26:
A service is an offer of value to another through a well-defined interface and available to a community
(which may be the general public). A service results in work provided to one by another.
Service Oriented Architecture (SOA) is a way of organizing and understanding [representations of]
organizations, communities and systems to maximize agility, scale and interoperability. The SOA
approach is simple - people, organizations and systems provide services to each other. These services
allow us to get something done without doing it ourselves or even without knowing how to do it -
enabling us to be more efficient and agile. Services also enable us to offer our capabilities to others in
exchange for some value - thus establishing a community, process or marketplace. The SOA paradigm
works equally well for integrating existing capabilities as for creating and integrating new capabilities.
SOA ... is an architectural paradigm for defining how people, organizations and systems provide and
use services to achieve results. SoaML ... provides a standard way to architect and model SOA
solutions using the Unified Modeling Language (UML). The profile uses the built-in extension
mechanisms of UML to define SOA concepts in terms of existing UML concepts.
... the highest leverage of employing SOA comes from understanding a community, process or
enterprise as a set of interrelated services and ... supporting that service oriented enterprise with
service-enabled systems. SoaML enables business oriented and systems oriented services
architectures to mutually and collaboratively support the enterprise mission. ... SoaML depends on
Model Driven Architecture® (MDA®) to help map business and systems architectures, the design of the
enterprise, to the technologies that support SOA, like web services and CORBA®.
For further information on the concepts of SoaML, see the specification document on the OMG website (
http://www.omg.org/docs/ad/08-11-01.pdf).

SoaML in Enterprise Architect

Enterprise Architect enables you to model services architectures quickly and simply, through use of an MDG
Technology integrated with the Enterprise Architect installer. The SoaML facilities are provided in the form of:
· Two SoaML diagram types - SoaML Component Diagram and SoaML Sequence Diagram - accessed
through the New Diagram 422 dialog
· SoaML pages in the Toolbox
· SoaML element and relationship entries in the Toolbox Shortcut 403 Menu and Quick Linker 474 .

SoaML Toolbox Pages

You can access the SoaML pages of the Toolbox through the More tools | Mind Mapping menu option.
There is a set of pages for each SoaML diagram type, although the last five pages in each set are the same.

© 1998-2010 Sparx Systems Pty Ltd

 1090 Modeling Languages | Specialized UML Models

SoaML Component Diagram SoaML Sequence Diagram

Enterprise Architect User Guide

 Modeling Languages | Specialized UML Models 1091

Example SoaML Diagram

Disable SoaML
If you prefer not to use SoaML in Enterprise Architect, you can disable it (and subsequently re-enable it) using
the MDG Technologies 1069 dialog (Settings | MDG Technologies).

© 1998-2010 Sparx Systems Pty Ltd

 1092 Modeling Languages | Build Your Own Modeling Language

5.3 Build Your Own Modeling Language

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.

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 895 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 906 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 901 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 1092 .
For more information on MDG Technologies, see the MDG Technologies 1066 topic.

5.3.1 MDG Technology SDK

Introduction
In describing aspects of developing technologies to use in conjunction with Enterprise Architect, it is expected
that you are familiar with the concepts introduced in the main body of the Enterprise Architect User Guide.
Wherever appropriate, cross-references to these concepts are provided in the text.

Contents
· Developing Profiles 1093 (incorporating Custom Stereotypes 1093 )
· MDG Technologies 1118
· Shape Scripts 1147
· Tagged Value Types 1166
· Code Template Framework 1172

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1093

5.3.1.1 Developing Profiles

Introduction
Profiles provide a means of extending the UML, which enables you to build models in particular domains. They
are based on additional stereotypes 1093 and Tagged Values 1166 that are applied to UML elements, connectors
and their components. A Profile is a collection of such extensions that together describe some particular
modeling problem and facilitate modeling constructs in that domain. UML Profiles for Enterprise Architect are
specified in XML files, with a specific format. These XML files can be imported into Enterprise Architect
through the Resources window.
The imported Profile also automatically generates a page of elements and relationships in the Toolbox.
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.
Items in the Profile represent stereotypes. UML supports a large number of stereotypes, which are an inbuilt
mechanism for logically extending or altering the meaning, display, appearance and syntax of a model
element. Different model elements have different stereotypes associated with them.
For more information on the use of Profiles in Enterprise Architect, see the UML Profiles 906 topic.
For information on developing your own Profiles, see the following topics:
· Custom Stereotypes 1093
· Create Profiles 1095
· Quick Linker 1113
· Customize Toolbox Profiles 1134
· Create Diagram Profiles 1139
· Create Tasks Pane Profiles 1141

5.3.1.1.1 Custom Stereotypes

UML supports a large number of stereotypes, which are an inbuilt mechanism for logically extending or
altering the meaning, physical appearance and syntax of a model element. Different model elements have
different stereotypes associated with them. For more information on the use of stereotypes in Enterprise
Architect, see the UML Stereotypes 895 topic.
In Enterprise Architect you can create new stereotypes with their own custom appearance. The stereotypes
can be altered to make use of metafiles (image files) and customized colors, or you can make use of an
Enterprise Architect Shape Script to make new element shapes to determine the shape and dimensions of the
element.
To add your own custom stereotypes, follow the steps below:
1. From the main menu, select Settings | UML. The UML Types dialog displays, defaulted to the
Stereotypes tab.

© 1998-2010 Sparx Systems Pty Ltd

 1094 Modeling Languages | Build Your Own Modeling Language

2. Type or select a Stereotype name.

3. Select a Base Class from the drop-down list.
4. To associate a Metafile with this stereotype, click on the Metafile radio button and the Assign button,
and locate the required .emf or .wmf file.
5. Enter optional Notes and select Default Colors for this stereotype.
6. Click on the Save button to save the stereotype.
The table below describes the functionality of the Stereotypes tab.

Option Use to

Stereotype Specify the name of the stereotype.

Group name Enable grouping of stereotype features by a plural name, for attributes and
operations, which is shown on diagrams in the attribute and operations
compartments.

Base Class Enable the stereotyped element to inherit the base characteristics from a pre-
existing element type.

Notes Type any notes concerning the stereotype (not the elements to which the stereotype
is to be applied).

Override Appearance

None Switch to the default element appearance.

Metafile Enable an image file to be used for the appearance of the stereotype.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1095

Option Use to

Shape Script Specify custom shapes for the stereotype using the Enterprise Architect Shape
Scripting language. For more information see the Shape Scripts 1147 topic.

Assign Add the associated metafile or Shape Script from the stereotyped element.

Remove Remove the associated metafile or Shape Script from the stereotyped element.

Default Colors

Fill Set the default background color of the element.

Border Control the border color.

Font Control the color of the stereotype font.

Reset Reset the appearance of the element to the default element appearance.

Note:
You can transport these custom stereotype definitions between models, using the Export Reference Data
223 and Import Reference Data 225 options on the Tools menu.

5.3.1.1.2 Create Profiles

This topic describes how to create profiles and profile items. These creation tasks include creating the profile
stereotypes, defining the metaclasses they apply to, and defining Tagged Values and constraints. This topic
also describes how to export a profile for use in modeling.
To create a Profile, follow the steps below:
1. Create a Profile Package 1095

2. Add Stereotypes and Metaclasses 1096

3. Define Tagged Values for Stereotypes 1098

4. Define Constraints for Stereotypes 1101

5. Add Enumerations 1103

6. Add Shape Scripts 1104

7. Set Default Appearance 1106

8. Export the Profile 1106

5.3.1.1.2.1 Create a Profile Package

In Enterprise Architect, you must create a Profile in a Package that has the stereotype «profile». To create a
Profile Package, follow the steps below.
1. Open or create a Package diagram.
2. Open the Profile page of the Toolbox (More tools | Profile).

© 1998-2010 Sparx Systems Pty Ltd

 1096 Modeling Languages | Build Your Own Modeling Language

3. Drag the Profile item onto the Class diagram. The New Model Package dialog displays.
4. In the Package Name field, type a name for the Profile.
5. Select the Automatically add new diagram checkbox.
6. Click on the OK button. The New Diagram 422 dialog displays.
7. Provide the required diagram name, and select the diagram group UML Structural and diagram type
Class.
8. Click on the OK button. Enterprise Architect creates a package with the stereotype «profile> and with a
child Class diagram.
9. In the Project Browser, double-click on the Profile Package on the diagram to open the child diagram.
You now use this child diagram to add stereotypes 1096 to the Profile.

5.3.1.1.2.2 Add Stereotypes and Metaclasses

To add metaclasses and stereotypes to a Profile, follow the steps below for as many stereotypes and
metaclasses as you require:
1. Open the child diagram of the Profile Package.
2. Drag the Metaclass element from the Profile page of the Toolbox onto the diagram. The Create New
Metaclass dialog displays, in which you can tick multiple metaclasses for dropping onto the diagram.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1097

3. Scroll down the Element list and select the checkbox for Class.
4. Click on the OK button, display the Class Properties dialog, and in the Name field type a name for the
element. Click on the OK button again.
5. Drag a Stereotype element from the Toolbox onto the diagram. If the Properties dialog does not display,
double-click on the element on the diagram.
6. In the Name field, type a name for the stereotype.
7. Click on the OK button and, if it displays, Close the Generate Code dialog.
8. Click on the Extension relationship in the Toolbox and drag the connection from the stereotype element
to the metaclass element.
9. Your diagram should now resemble the one below:

© 1998-2010 Sparx Systems Pty Ltd

 1098 Modeling Languages | Build Your Own Modeling Language

Note:
If you want to have a stereotype extending more than one metaclass, do not create two stereotype Classes
with the same name. You cannot have two stereotypes with the same name in the same profile; one is
discarded when you save the profile. Therefore, create one stereotype Class with an Extension connector to
each of several Metaclass elements, as shown below.

You can now add stereotype Tags 1098 , Constraints 1101 , Enumerations 1103 , and/or Shape Scripts 1104 to your
Profile, and define the default appearance 1106 of the elements or connectors as required.

5.3.1.1.2.3 Define Stereotype Tagged Values

Stereotypes within a UML Profile can have one or more associated Tagged Values. When creating a UML
Profile, you define these Tagged Values as attributes of the stereotyped Class.
You can also:
· Define Stereotype Tags with Predefined Tag Types 1099
· Define Stereotype Tags with Supported Attributes 1100
· Use the Tagged Value Connector 1101
To define Tagged Values for a stereotype, follow the steps below:
1. Open the Attributes dialog for the stereotyped element.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1099

2. Click on the New button to create a new attribute.

3. In the Name field, type the name of the stereotype tag.
4. In the Type field, click on the drop-down arrow and select the attribute type.
5. In the Initial field, type the initial value of the tag. (See Add Enumeration Elements 1103 for the steps for
creating enumerated types for Tagged Values.)
6. In the Notes field, type a description of the tag.
7. Click on the Save button and Close button.

Define Predefined Tag Types

To define a stereotype tag with a predefined Tagged Value Type, you must first create the predefined Tagged
Value Type. For full instructions on how to do this, see the Create Structured Tagged Values 1168 topic.

Assign Predefined Tag Types to Stereotypes

To assign a predefined tag type to a stereotype, just create an attribute with the same name. For example, to
make the Tagged Value Handicap appear in a stereotype, create an attribute named Handicap. You can set
the default value for the Tagged Value by giving the attribute an Initial value.

© 1998-2010 Sparx Systems Pty Ltd

 1100 Modeling Languages | Build Your Own Modeling Language

Supported stereotype attribute tags are special tags that set the default behavior of stereotyped elements,
such as the initial size of the element and the default location of any image files associated with the
stereotype. For a list of supported attributes, see the Supported Attributes 1108 topic.
To define tags for a stereotype with supported attributes, follow the steps below:
1. Open the Attributes dialog for the stereotyped element.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1101

2. In the Name field, type the name of the stereotype tag.

3. In the Initial field, type the initial value of the tag.

Note:
For supported attributes you set only the Name (which must match the attributes listed in the
supported attributes section) and the Initial value; do not set the other values.

4. Click on the Save button and Close button.

In a Profile, you can use the Tagged Value connector to define a Tagged Value that has as its value the name
of an element containing the stereotype pointed to. You select the Tagged Value connector from the Profile
pages of the Toolbox.
The following diagram demonstrates how you might use the connector. It shows a (saved and imported) profile
that defines two stereotypes: «Collection» and «Node». The «Collection» stereotype has a Tagged Value
connector with the target role named rootNode, pointing to the «Node» stereotype.

In the Tagged Values window for the connector, against rootNode, you click on the selection button ([ ... ]).
This displays the Select <Item> 515 dialog, through which you locate the elements in the current model with
the «Node» stereotype. You can then select one of these elements as the value of the tag.

5.3.1.1.2.4 Define Stereotype Constraints

Defining constraints for stereotypes uses the same procedure as defining constraints for any Class. To define
constraints for a stereotype, follow the steps below:
1. Open the Class Properties dialog of the stereotype element in a diagram.
2. Click on the Constraints tab and click on the New button to create a new constraint.

© 1998-2010 Sparx Systems Pty Ltd

 1102 Modeling Languages | Build Your Own Modeling Language

3. In the Constraint field, type the value of the constraint.

4. In the Type field, click on the drop-down arrow and select the appropriate type.
5. In the Status field, click on the drop-down arrow and select the appropriate status.
6. In the Notes field, type any additional information required.
7. Click on the Save button, and on the OK button to close the dialog.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1103

5.3.1.1.2.5 Add Enumeration Elements

Enumerations can be used to restrict the values available to stereotype tags.

Note:
Enumerations defined under a Profile Package do not appear as elements in the profile when imported.

To add an Enumeration element, follow the steps below:

1. Open your Profile Package child Class diagram.
2. In the Toolbox, select More tools | Profile. The contents of the Profile page of the Toolbox display.
3. Drag an Enumeration item from the toolbox onto the diagram. If the Properties dialog does not display,
double-click on the element on the diagram.
4. In the Name field, type the name of the new Enumeration.
5. Click on the Details tab and click on the Attributes button. The Attributes Properties dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1104 Modeling Languages | Build Your Own Modeling Language

6. In the Name field, type the name of the Enumeration attribute.

7. In the Type field, click on the drop-down arrow and select the appropriate type.
8. In the Initial field, type the initial value of the attribute.
9. Click on the Save button, and repeat steps 6 to 9 for additional attributes.
10. When you are finished, click on the Close button.
11. Right-click on the Stereotype element and select the Attributes context menu option. The Attribute
Properties dialog displays for the stereotype.
12. In the Name field type a name for the attribute.
13. In the Type field type the name of the Enumeration element.
14. In the Initial field type the name of the first enumeration attribute you defined.
15. Click on the Save and Close buttons.
You have now generated a drop-down list for setting the value of the tag in the Tagged Values window.

5.3.1.1.2.6 Add Shape Scripts

To add a Shape Script 1147 to a stereotype in a UML Profile, follow the steps below:
1. On the Profile Package child diagram, select a Stereotype element.
2. Right-click on the element and select the Attributes context menu option.
3. In the Attributes Properties dialog, in the Name field, type _image.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1105

4. Click on the [ ... ] button next to the Initial field. The Shape Editor 1150 dialog displays.
5. Enter the Shape Script in the Shape Editor dialog, and click on the OK and Close buttons.
The Stereotype element now resembles the example below:

© 1998-2010 Sparx Systems Pty Ltd

 1106 Modeling Languages | Build Your Own Modeling Language

Note:
If you are creating a Shape Script for an Association Class 856 , be aware that the Shape Script is applied to
both the Class part and the Association part. Therefore, you might have to include logic in the shape main
that tests the type of the element so that you can give separate drawing instructions for Class and for
Association. Such logic is not necessary in the:
· shape source or shape target, which are ignored by Classes, or the
· decoration shapes which are ignored by Associations.

5.3.1.1.2.7 Set Default Appearance

You can define the appearance of stereotyped elements and connectors as you create or edit the stereotypes
1093 , using the Override Appearance and Default Colors panels of the UML Types dialog. However, an easier

way is to review your completed profile diagram and set the default appearance of the elements and
connectors in place.
Simply click on the required element or connector and press [F4], then define the background, font and border
colors and border thickness as appropriate, on the Default Appearance 538 dialog.
When you save the profile 1106 containing the stereotyped elements and connectors, make sure that you select
the Color and Appearance checkbox on the Save UML Profile dialog.

5.3.1.1.2.8 Export a Profile

Once you have created a Profile and defined the elements and metaclasses, you can save (export) the Profile
to disk for future models.
To save a Profile, follow the steps below:
1. If your profile is
· a single profile spread over multiple diagrams within the same Profile package, find the Profile
package in the Project Browser window, right-click on it and select the Save Package as UML
Profile context menu option
· one of multiple profiles within the same Profile package, right-click anywhere in the background of
the Profile diagram and select the Save as Profile context menu option
· a single diagram within the Profile package, choose either the Save Package as UML Profile
context menu option or the Save as Profile context menu option.

Note:
The two menu options give slightly different results. See Save Profile Options 1107 .

2. The Save UML Profile dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1107

3. Click on the [ ... ] (Browse) button, and select the export destination for the XML Profile file. If
necessary, edit the profile filename, but do not delete the .xml extension.
4. In the Profile Type field, click on the drop-down arrow and select XMI (UML)2.0.

Note:
The drop-down list is not available unless the package has the <<profile>> stereotype.

5. Set the required export options for all stereotypes defined in the profile:
· Element Size - select the checkbox to export the element size attributes
· Color and Appearance 1106 - select the checkbox to export the color (background, border and font)
and appearance (border thickness) attributes
· Alternate Image - select the checkbox to export the metafile images
· Code Templates - select the checkbox to export the code templates, if they exist.
6. Click on the Save button to save the profile to disk.
For information on importing and using the profile in modeling, see the Use Profiles 907 topic.

When you save a UML Profile, you can save it either from the package or from the diagram, depending on
whether the Profile is:
· a single profile spread over multiple diagrams within the same Profile package (find the Profile package in
the Project Browser, right-click on it and select the Save Package as UML Profile context menu option),
which is typically the case for a stereotypes profile
· one of multiple profiles within the same Profile package (right-click anywhere in the background of the
Profile diagram and select the Save as Profile context menu option); for example, when creating multiple
toolbox profiles
· a single diagram within the Profile Package (choose either the Save Package as UML Profile context
menu option or the Save as Profile context menu option).
The two context menu options produce slightly different results. You should take these into consideration,
especially in the third instance where you could choose either option.

Save From Diagram Save From Package Notes

The profile takes the diagram The profile takes the package Package and diagram names are not
name. name. necessarily the same, although you can
save a lot of confusion if you make them
the same or very similar. For example:
package GL with diagrams GL1, GL2,
GL3.

The profile takes the The profile takes the package's

diagram's notes. notes.

You can take the default size You cannot take the default size
and appearance (including and appearance from the
alternate image) from the diagram object.
diagram object.
You can use the _sizeX, _sizeY
and _image properties, but there
is no equivalent for default
colors.

Can be much faster. Can be much slower. The difference arises because diagram
objects are kept in memory and Project
Browser elements aren't.
This is only likely to be an issue if the
profile is a large one and you are using a
slow network connection to a remote
repository.

© 1998-2010 Sparx Systems Pty Ltd

 1108 Modeling Languages | Build Your Own Modeling Language

5.3.1.1.2.9 Supported Attributes

Supported Stereotype Attributes in UML Profiles

The following attributes can be applied to stereotypes in UML Profiles:

Attribute Meaning

icon Contains the path to a bitmap file to be used as the Project Browser icon for all
elements other than Package, with the given stereotype. The bitmap must be
16x16 pixels. For a transparent background, use light grey - RGB(192,192,192).

_image Shape script definition.

_instanceMode

_instanceOwner Used for defining behavior on creating an instance 1110 .

_instanceType

_lineStyle Sets the line style of a connector. The value of the attribute can be one of:
· direct
· auto
· custom
· bezier
· treeH (horizontal)
· treeV (vertical)
· treeLH (lateral horizontal)
· treeLV (lateral vertical).

_metatype Used for defining stereotypes as metatypes 1109 .

_sizeY Initial height of the element, in pixels at 100% zoom.

_sizeX Initial width of the element, in pixels at 100% zoom.

_strictness Used for restricting application of multiple stereotypes 1110 .

Supported Metatype Attributes in UML Profiles

The following attributes can be applied to metatype Classes in UML Profiles, and refer to the stereotypes that
extend them:

Attribute Meaning

_AttInh If set to 1, switches on the Inherited Features: Show Attributes setting.

_AttPkg If set to 1, switches on the Attribute Visibility: Package setting.
_AttPri If set to 1, switches on the Attribute Visibility: Private setting.
_AttPro If set to 1, switches on the Attribute Visibility: Protected setting.
_AttPub If set to 1, switches on the Attribute Visibility: Public setting.
_ConInh If set to 1, switches on the Show Element Compartments: Inherited Constraints
setting.
_Constraint If set to 1, switches on the Show Element Compartments: Constraints setting.
_DefaultDiagramType Used for defining child diagram types 1111 .

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1109

Attribute Meaning

_HideStype If set to a comma-separated list of stereotypes, sets the Hide Stereotyped Features
filter.
_MakeComposite Used for creating composite elements 1111 .
_OpInh If set to 1, switches on the Inherited Features: Show Operations setting.
_OpPkg If set to 1, switches on the Operation Visibility: Package setting.
_OpPri If set to 1, switches on the Operation Visibility: Private setting.
_OpPro If set to 1, switches on the Operation Visibility: Protected setting.
_OpPub If set to 1, switches on the Operation Visibility: Public setting.
_PType If set to 1, switches on the Show element type (Port and Part only) setting.
_ResInh If set to 1, switches on the Show Element Compartments: Inherited Responsibilities
setting.
_Responsibility If set to 1, switches on the Show Element Compartments: Responsibilities setting.
_Runstate If set to 1, switches on the Hide Object Runstate in current diagram setting.
_SourceAggregation Used to set the aggregation type at the end of a connector; do not set both
_SourceAggregation and _TargetAggregation.
Set to 1 for shared, 2 for composite.
_SourceMultiplicity Used to set the multiplicity of the source element, such as 1..* or 0..1.
_SourceNavigability If the connector is non-navigable, set this attribute to Non-Navigable. For other
values, set the direction 1739 attribute.
_Tag If set to 1, switches on the Show Element Compartments: Tags setting.
_TagInh If set to 1, switches on the Show Element Compartments: Inherited Tags setting.
_TargetAggregation Used to set the aggregation type at the end of a connector; do not set both
_SourceAggregation and _TargetAggregation.
Set to 1 for shared, 2 for composite.
_TargetMultiplicity Used to set the multiplicity of the target element, such as 1..* or 0..1.
_TargetNavigability If the connector is non-navigable, set this attribute to Non-Navigable. For other
values, set the direction 1739 attribute.

The _metatype attribute is applied to a stereotype element. This is used where users want to hide the identity
of an element as a stereotyped UML element. It is also a method of getting custom types to appear in contexts
where only Enterprise Architect's inbuilt types would normally appear; for example in the lists of element types
in the Relationship Matrix.
In the following example from SysML, block is defined as a stereotype that extends a UML Class.

© 1998-2010 Sparx Systems Pty Ltd

 1110 Modeling Languages | Build Your Own Modeling Language

However, a SysML user isn't interested in UML Classes, only in SysML Blocks. An element created from a
stereotype defined this way, while behaving like a stereotyped Class in most contexts:
· Shows Block Properties rather than Class Properties as the title of its Properties dialog
· Is auto-numbered as Block1 not Class1 on creation, and
· Appears as Block not Class in many other contexts throughout Enterprise Architect.
The _strictness attribute is applied to a stereotype element. It defines to what level multiple stereotypes can
be applied to an element. The type of the attribute is StereotypeStrictnessKind and it can have one of four
values:
· profile, which states that an element of this type cannot be given more than one different stereotype from
the same profile
· technology, which states that an element of this type cannot be given more than one different stereotype
from the same technology
· all, which states that an element of this type cannot have multiple stereotypes at all, or
· none, which is the default Enterprise Architect behaviour and states that there are no restrictions on the
use of multiple stereotypes.
The following example is from SysML and shows that a «flowPort» cannot have any other stereotype applied
to it.

The _instanceType attribute is applied to a stereotype element and defines what kind of element is created as
an instance of this element type. The value corresponds to the metatype given to a stereotype using the
_metatype attribute. It is shown on the Paste Element 430 dialog and is translated if it matches an Enterprise
Architect element type.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1111

The _instanceMode attribute is applied to a stereotype element and controls the text in the Paste Element
dialog after being translated. Valid values are instance and property, with the default being instance.

The _instanceOwner attribute is applied to a stereotype element and controls the text in the Paste Element
dialog. It is translated if it matches an Enterprise Architect element type. The default value is Element.
The following example from SysML shows that when an instance of a Block is created, it is created as a
BlockProperty element.

The _makeComposite attribute is applied to a metaclass element, not a stereotype element. It defines
whether an element is always made composite when created.

Notes:
· A stereotyped package is not by default created with a child diagram, so you should use the
_makeComposite attribute to ensure the child diagram is created.
· Unless you also use the _defaultDiagramType attribute to define the child diagram type 1111 , the child
diagram created is a Package diagram.

The following example from BPMN shows that a BusinessProcess element is always created as a Composite
element with a BPMN custom child diagram.

The _defaultDiagramType attribute is applied to a metaclass element, not a stereotype element. It defines
the type of diagram created when an element is made composite 1111 .
This attribute can take as its name any of the inbuilt diagram types of Enterprise Architect as listed in Values

© 1998-2010 Sparx Systems Pty Ltd

 1112 Modeling Languages | Build Your Own Modeling Language

For _defaultDiagramType, below.

Alternatively, if a custom diagram type is required, it should be prefixed with the diagram profile name and '::'.

Note:
The diagram profile name is the name given to the profile when you save it, which by default is the name of
the profile package or profile diagram. If you follow the recommendation in Create Diagram Profiles 1139 , the
diagram profile name is based on the technology name, but be aware that the attribute prefix is not a direct
reference to the technology name.

The following examples show a «BusinessProcess»Activity that, when made a composite element,
automatically creates an Analysis diagram, and a «block» stereotype that creates a SysML InternalBlock
custom diagram.

You can also use the _defaultDiagramType attribute for packages, extending the Package metaclass.

Values For _defaultDiagramType

The following initial values should be used to refer to Enterprise Architect's inbuilt diagram types:
· UML Behavioral::Use Case
· UML Behavioral::Activity
· UML Behavioral::State Machine
· UML Behavioral::Communication
· UML Behavioral::Sequence
· UML Behavioral::Timing
· UML Behavioral::Interaction Overview
· UML Structural::Package
· UML Structural::Class
· UML Structural::Object
· UML Structural::Composite Structure
· UML Structural::Component
· UML Structural::Deployment
· Extended::Custom
· Extended::Requirements
· Extended::Maintenance
· Extended::Analysis
· Extended::User Interface
· Extended::Data Modeling
· Extended::ModelDocument.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1113

5.3.1.1.2.10 Stereotype Profiles

In Enterprise Architect 6, an MDG Technology could consist of many UML Profiles, each representing an
Toolbox page. Each profile could include stereotype definitions alongside redefinitions of standard UML
elements. This meant that to define a stereotype in a technology, it had to appear in one of the Toolbox pages.
Releases from Enterprise Architect 7 take a different approach, splitting the task of defining the stereotypes
and the task of defining the Toolbox pages into separate profiles. The MDG Technology's stereotypes are
contained in one or more profiles. The stereotypes within each profile use the profile name as the namespace.
Create one or more packages with the «profile» stereotype, each package name being the namespace. Within
each package create profile diagrams defining all the stereotypes in the namespace. You can use multiple
diagrams to do this, but do not use nested packages.
Give the «profile» package a description in the Notes field (e.g. MDG Technology for BPMN). When all of the
stereotypes are defined (make sure that every stereotype extends at least one Metaclass) right-click on the
profile package in the Project Browser and select the Save Package as UML Profile context menu option,
then proceed as usual.

5.3.1.1.3 Quick Linker

Introduction
The Quick Linker provides a fast and simple way to create new elements and connectors on a diagram.
When an element is selected in a diagram, the Quick Linker arrow is displayed in the upper right corner of a
element. Simply clicking and dragging the arrow enables you to create new connectors and elements. The
philosophy behind the built-in Quick Linker definitions is to provide, not a complete list of valid or legal
connections, but a short and convenient list of the commonest connections for the given context.
As part of a UML Profile, you can add to or replace the built-in Quick Linker definitions, as explained in the
following sections:
· Quick Linker Definition Format 1113
· Quick Linker Example 1115
· Hide Default Quick Linker Settings 1117

· Quick Linker Object Names 1117 .

Customized Quick Linker Settings

A Quick Linker definition is a Comma Separated Value (CSV) format file. It is best manipulated in a
spreadsheet which should be set up to save the CSV file as comma-separated text without quotation marks
around text fields.
To add a Quick Linker definition file to a profile or technology, simply place a DocumentArtifact element onto
the Profile diagram. Give it the name 'QuickLink' then double-click on it. Open your CSV file in a text editor
such as Notepad and copy and paste the contents into the DocumentArtifact element. The definitions are
saved with the profile and are processed and applied when the profile is imported. The same applies if a
profile is included within a technology, with the proviso that the QuickLink element must be in the same profile
as the link stereotype definitions. This means that a technology could have a set of Quick Link definitions for
each profile.

5.3.1.1.3.1 Quick Linker Definition Format

A Quick Linker definition is a text file consisting of records terminated by new-line characters. Each record
must consist of 23 comma-separated fields, as defined by the table below. The values of each field must not
be in quotes (" "). A Quick Linker definition can include comments: all lines that begin with // are ignored by
Enterprise Architect.
Each record of the Quick Linker definition represents a single entry on the Quick Linker menu. Some fields
define the menu command; some fields can be thought of as filters, with the entry being ignored if the filter
condition isn't met.
A Quick Linker definition has the following fields.

Column Field Description

A Source Element The row is ignored unless a connector is being dragged away from this

© 1998-2010 Sparx Systems Pty Ltd

 1114 Modeling Languages | Build Your Own Modeling Language

Column Field Description

Type type of element.

B Source Stereotype If set, the row is ignored unless a connector is being dragged away from
Filter an element with this stereotype.

C Target Element Type If set, the row is ignored unless a connector is being dragged onto this
type of element.
If blank, the row is ignored unless a connector is being dragged onto an
empty piece of diagram.

D Target Stereotype If set and Target Element Type also set, the row is ignored unless a
Filter connector is being dragged onto an element with this stereotype.

E Diagram Filter Contains either an inclusive or exclusive list of diagrams, which limits the
diagrams the given kind of connector can be included on.
Each diagram name is terminated by a semi-colon. Excluded diagram
names are preceded by an exclamation mark.
Example of an inclusive list: Collaboration;Object;Custom;
Example of an Exclusive list: !Sequence;

F New Element Type If set and Create Element also set, results in the creation of an element of
this type.

G New Element If set and Create Element also set, results in the creation of an element
Stereotype with this stereotype.

H New Link Type If set and Create Link also set, results in the creation of a connector of
this type.

I New Link Stereotype If set and Create Link also set, results in the creation of a connector with
this stereotype.

J New Link Direction Can be:

· directed (always creates an association from source to target)
· from (always creates an association from target to source)
· undirected (always creates an association with unspecified direction)
· bidirectional (always creates a bi-directional association), or
· to (creates either a directed or undirected association, depending on
the value of the Association Direction option).

Note:
Not all of the above work with all connector types; for example, you
cannot create a bi-directional Generalization.

K New Link Caption If a new connector is being created but not a new element, then this is the
text that appears on the context menu.

L New Link & Element If a new connector AND a new element are being created, then this is the
Caption text that appears on the context menu.

M Create Link If set to TRUE, results in creation of a new connector; otherwise should be
left blank.

N Create Element If set to TRUE the row is ignored unless a connector is being dragged
onto an empty piece of diagram and results in creation of a new element;
otherwise should be left blank.
This overrides the values of Target Element Type and Target Stereotype
Filter.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1115

Column Field Description

O Disallow Self Should be set to TRUE if self connectors are invalid for this kind of
connector connector; otherwise should be left blank.

P Exclusive to ST If set to TRUE, indicates that elements of type Source Element Type with
Filter + the stereotype Source Stereotype Filter do not display the Quick Linker
No inherit from definitions of the equivalent unstereotyped element.
Metatype

Q Menu Group If set, indicates the name of a sub-menu in which a menu item is created.

R Complexity Level Not implemented, always set to 0.

S Target Must Be If set to TRUE this menu item only appears when dragging from a child
Parent element to its parent; for example from a port to its containing Class.

T Embed element If set to TRUE the element being created is embedded in the target
element; otherwise should be left blank.

U Precedes Separator If set to TRUE results in a menu separator being added to the Quick
LEAF Linker menu; otherwise should be left blank.

V Precedes Separator If set to TRUE results in a menu separator being added to the Quick
GROUP Linker sub-menu; otherwise should be left blank.

W Dummy Column Depending on which spreadsheet application you use, this column might
require a value in every cell to force CSV export to work correctly with
trailing blank values.

5.3.1.1.3.2 Quick Linker Example

This example uses a Class element with the stereotype «quick». The example scenario is this: when you drag
a connector away from one of these elements, you want to create a Dependency either to or from a
component element. When you drag a connector onto an existing Port or component element, you want a
Dependency either to or from the component or, in the case of a component, you want to be able to create an
embedded Port element.
This results in 8 records in the Quick Linker definition 1113 file.
1. Dependency to new Component
2. Dependency from new Component
3. Dependency to existing Component
4. Dependency from existing Component
5. Dependency to existing Port
6. Dependency from existing Port
7. Dependency to existing Component, create new Port
8. Dependency from existing Component, create new Port
In the spreadsheet, this is implemented by the following values:

© 1998-2010 Sparx Systems Pty Ltd

 1116 Modeling Languages | Build Your Own Modeling Language

This saves to the following CSV:

Class,quick,,,,Component,,Dependency,,to,,Dependency to,TRUE,TRUE,TRUE,TRUE,Component,0,,,,,
Class,quick,,,,Component,,Dependency,,from,,Dependency from,TRUE,TRUE,TRUE,TRUE,Component,0,,,TRUE,,
Class,quick,Component,,,,,Dependency,,to,Dependency to,,TRUE,,TRUE,TRUE,,0,,,,,
Class,quick,Component,,,,,Dependency,,from,Dependency from,,TRUE,,TRUE,TRUE,,0,,,TRUE,,
Class,quick,Port,,,,,Dependency,,to,Dependency to,,TRUE,,TRUE,TRUE,,0,,,,,
Class,quick,Port,,,,,Dependency,,from,Dependency from,,TRUE,,TRUE,TRUE,,0,,,TRUE,,
Class,quick,Component,,,Port,,Dependency,,to,,Dependency to,TRUE,TRUE,TRUE,TRUE,Port,0,,TRUE,,,
Class,quick,Component,,,Port,,Dependency,,from,,Dependency from,TRUE,TRUE,TRUE,TRUE,Port,0,,TRUE,TRUE,,

You can create the following profile and cut and paste the CSV data into the document artifact to test the
effect.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1117

5.3.1.1.3.3 Hide Default Quick Linker Settings

If you have a Quick Linker definition with the Exclusive to stereotype flag (column P) set to TRUE, then the
default Quick Linker definitions between the given source and target are overridden. However, you might want
to override the defaults without actually having a Quick Linker definition. For example, if you don't define any
Quick Links for a «quick» Class to another «quick» Class, Enterprise Architect displays the default Quick Links
for a Class to another Class. To override this behaviour, create a Quick Linker definition that has the source
element type, source stereotype filter, target element type and target stereotype filter fields (columns A, B, C
and D) all set, with the Exclusive to stereotype flag (column P) set to TRUE, and with the new link type field
(column H) set to <none>.
For example, add this line to the example in Quick Linker Example 1115 :
Class,quick,Interface,,,,,<none>,,,,,,,,TRUE,,0,,,,,
This overrides the default Class-to-Interface Quick Links when a Quick Link is dragged from a «quick» Class
to an Interface element.

Note:
This technique does not affect the automatic appearance of Dependency, Trace, Information Flow and Help
items on the Quick Linker menu.

5.3.1.1.3.4 Quick Linker Object Names

List of Element Types

The following element names can be used in Quick Linker definitions:

Action ExecutionEnvironment Package

ActionPin ExitPoint Part
Activity ExitState Port
ActivityParameter ExpansionNode PrimitiveType
ActivityPartition ExpansionRegion ProvidedInterface
Actor Feature Receive
Artifact GUIElement RequiredInterface
Boundary HistoryState Requirement
CentralBufferNode InformationItem Screen
Change InitialActivity Send
ChoiceState InitialState Sequence
Class InteractionOccurrence Signal
Collaboration Interface State
Component Issue StateLifeline
DataType InterruptableActivityRegion StateMachine
Decision JunctionState Synchronization_H
DeepHistoryState MergeNode Synchronization_V
Deployment Specification MessageEndpoint SynchState
Device n-ary Association UMLDiagram
DiagramGate Node UseCase
EntryPoint Object ValueLifeline
EntryState ObjectNode

List of Connector Types

The following connector names can be used in Quick Linker definitions:

© 1998-2010 Sparx Systems Pty Ltd

 1118 Modeling Languages | Build Your Own Modeling Language

Aggregation Deployment Realization

Association Extension Redefinition
AssociationClass Generalization Sequence
CommunicationPath InterfaceLink StateFlow
Composition Manifest UCExtends
ConnectorLink Nesting UCIncludes
ControlFlow ObjectFlow UseCase
DelegateLink PackageImport
Dependency PackageMerge

5.3.1.2 MDG Technologies - Creating

The Model Driven Generation (MDG) Technologies enable Enterprise Architect users to access and use
resources pertaining to a specific technology in Enterprise Architect. There are various options for an
administrator or individual user to bring MDG Technologies into use with Enterprise Architect, as described in
the MDG Technologies - Using 1066 topic. You should read the MDG Technology topics to understand how
MDG Technologies are accessed and used within Enterprise Architect, especially the Manage MDG
Technologies 1069 topic.
A further option is that Technology Developers can develop new MDG Technologies and deploy them to the
project team as appropriate; this is described in the following topics:
· Create MDG Technologies 1118
· Working With MTS Files 1133
· Customize Toolbox Profiles 1134
· Create Diagram Profiles 1139
· Create Tasks Pane Profiles 1141
· Define Validation Configuration 1145
· Incorporate Model Templates 1146
· Deploy an MDG Technology 1146

An example of creating an MDG Technology for an Enterprise Architecture framework is provided in the white
paper: Enterprise Architecture Framework Design with Sparx Systems Enterprise Architect.

5.3.1.2.1 Create MDG Technologies

Using the MDG Technology Wizard, you can create MDG Technology files that can include UML Profiles, code
modules, Patterns, images, Tagged Value Types, RTF report templates, linked document templates, Toolbox
pages and Task Pane pages. To create an MDG Technology file, follow the steps below:
1. Select the Tools | Generate MDG Technology File menu option. The MDG Technology Creation
Wizard screen displays.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1119

2. Click on the Next button to proceed. The MDG Technology Wizard prompts you to:
· Create an MDG Technology File by creating a new MDG Technology Selection (MTS) file
· Create an MDG Technology File using an existing MTS file
· Not use any MTS file.

(An MTS file stores the selected options that you define during the creation of an MDG Technology File.
If you use an MTS file, you can later modify it to add or remove specific items in the MDG Technology
File. This is the recommended process.)
3. Select the appropriate MTS file option. Click on the Next button.

© 1998-2010 Sparx Systems Pty Ltd

 1120 Modeling Languages | Build Your Own Modeling Language

If you selected an MTS file, the MDG Technology Wizard prompts you to save the changes in the
existing MTS file or into a new MTS file. This enables you to create a modification based on the existing
MTS file, while preserving the original file.

4. If necessary, type in or browse for the required file path and name. Click on the Next button. The MDG
Technology Wizard - Create screen displays.

5. Complete the fields on this screen as follows:

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1121

Option Use to

Technology Type the name of the MDG Technology.

Filename Type or select the path and filename of the MDG Technology File (the file
extension for this file is .xml).

ID Type a reference for the MDG Technology File, up to 12 characters long.

Version Type the version number of the MDG Technology File.

Icon (Optional) Type or select the path and file name of the graphics file
containing the technology icon. The icon is a 16x16 bitmap image that is
shown in the list of technologies on the left of the MDG Technologies
dialog.

Logo (Optional) Type or select the path and file name of the graphics file
containing the technology logo. The logo is a 64x64 bitmap image that is
shown in the display pane on the top-right corner of the MDG
Technologies dialog.

URL (Optional) If you have any website product information that might be
helpful for users of this Technology, type or paste the URL in this field.

Support (Optional) If you have any web-based or other support facility that might
be helpful for users of this Technology, type or paste the contact address
in this field.

Notes Type a short explanation of the functionality of the MDG Technology.

6. Click on the Next button. The MDG Technology Wizard - Contents screen displays.

7. Select the checkbox for each item to be included in the MDG Technology file. Each selection runs
specific dialogs to enable definition of the specific items to be included in the MDG Technology, as
described in the following topics:
· Add a Profile 1122
· Add a Pattern 1123

© 1998-2010 Sparx Systems Pty Ltd

 1122 Modeling Languages | Build Your Own Modeling Language

· Add a Diagram Profile 1124

· Add a Toolbox Profile 1125
· Add Task Panel Pages 1126
· Add Tagged Value Types 1127
· Add Code Modules 1128
· Add MDA Transformations 1130
· RTF Report Templates 1132
· Linked Document Templates 1133
· Add Images 1130
· Add Scripts 1131 (Corporate and 'Suite' editions).
8. Work through the dialogs displayed in response to your choices, and when all are complete, click on
the Next button. The MDG Technology Wizard - Finish screen displays, providing information on the
items included in the MDG Technology File.

9. If you have used an MTS file and want to update it, select the Save to MTS checkbox.
10. If you are satisfied with the selection of items, click on the Finish button.
You can now edit the MTS file 1133 , if required, to add further items such as:
· Model Search definitions
· Model Views
· Model Validation configurations
· Model Templates.
To make the MDG Technology File accessible to an Enterprise Architect model, you must add the technology
file path to the MDG Technologies - Advanced dialog. See the Access Remote MDG Technologies 1070 topic.

5.3.1.2.1.1 Add a Profile

When creating an MDG Technology file, you can include UML 2.3-compliant profiles that you have defined 1095

. To use the Profiles section of the MDG Technology Wizard, follow the steps below:
1. Follow the steps in the Create MDG Technologies topic up to and including Step 6 1121 , where you select
the Profiles checkbox. The MDG Technology Wizard - Profile files selection dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1123

2. In the Directory field, navigate to the directory containing the required Profile or Profiles. The Profile
files are automatically listed in the Available Files panel.
3. To select each required Profile individually, highlight the Profile in the Available Files list and click on
the --> button. The file name displays in the Selected Files list. Alternatively, to select all available
Profiles, click on the -->> button.

Notes:
· DO NOT select diagram profiles or toolbox profiles on this dialog; this would generate conflicting
commands in the .MTS file.
· Make sure you do include your stereotype profile 1113 .

4. Click on the Next button to proceed.

5.3.1.2.1.2 Add a Pattern

When creating an MDG Technology file, you can include patterns 902 . To use the Patterns section of the MDG
Technology Wizard, follow the steps below:
1. Follow the steps in the Create MDG Technologies topic up to and including Step 6 1121 , where you select
the Patterns checkbox. The MDG Technology Wizard - Pattern files selection dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1124 Modeling Languages | Build Your Own Modeling Language

2. In the Directory field, navigate to the directory containing the required pattern or patterns. The pattern
files are automatically listed in the Available Files panel.
3. To select each required pattern individually, highlight the pattern in the Available Files list and click on
the --> button. The file name displays in the Selected Files list. Alternatively, to select all available
patterns, click on the -->> button.
4. Click on the Next button to proceed.

5.3.1.2.1.3 Add a Diagram Profile

When creating an MDG Technology file, you can include a diagram profile that you have defined 1139 . To use
the diagram profiles section of the MDG Technology Wizard, follow the steps below:
1. Follow the steps in the Create MDG Technologies topic up to and including Step 6 1121 , where you select
the Diagram Types checkbox. The MDG Technology Wizard - Diagram Types dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1125

2. In the Directory field, navigate to the directory containing the required diagram profiles. The profiles in
the directory are automatically listed in the Available Files panel.
3. To select each required diagram profile individually, highlight the file name in the Available Files list and
click on the --> button. The file name displays in the Selected Files list. Alternatively, to select all
available profiles (assuming they are all diagram profiles), click on the -->> button.
4. Click on the Next button to proceed.

5.3.1.2.1.4 Add a Toolbox Profile

When creating an MDG Technology file, you can include Enterprise Architect Toolbox page definitions that
you have created 1134 . To use the Toolboxes section of the MDG Technology Wizard, follow the steps below:
1. Follow the steps in the Create MDG Technologies topic up to and including Step 6 1121 , where you select
the Toolboxes checkbox. The MDG Technology Wizard - Toolboxes dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1126 Modeling Languages | Build Your Own Modeling Language

2. In the Directory field, navigate to the directory containing the required toolbox profiles. The profile files
are automatically listed in the Available Files panel.
3. To select each required toolbox profile individually, highlight the file name in the Available Files list and
click on the --> button. The file name displays in the Selected Files list. Alternatively, to select all
available profiles (assuming they are all toolbox profiles), click on the -->> button.
4. Click on the Next button to proceed.

5.3.1.2.1.5 Add Task Panel Pages

When creating an MDG Technology file, you can include Enterprise Architect Task Panel profiles that you
have created 1141 . To use the Taskpages section of the MDG Technology Wizard, follow the steps below:
1. Follow the steps in the Create MDG Technologies topic up to and including Step 6 1121 , where you select
the Taskpages checkbox. The MDG Technology Wizard - Taskpages dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1127

2. In the Directory field, navigate to the directory containing the required taskpage profiles. The profile
files are automatically listed in the Available Files panel.
3. To select each required taskpage profile individually, highlight the file name in the Available Files list
and click on the --> button. The file name displays in the Selected Files list. Alternatively, to select all
available profiles (assuming they are all taskpage profiles), click on the -->> button.
4. Click on the Next button to proceed.

5.3.1.2.1.6 Add Tagged Value Types

When creating an MDG Technology file, you can include Tagged Value Types 1166 . To use the Tagged Value
Types section of the MDG Technology Types Wizard, follow the steps below:
1. Follow the steps in the Create MDG Technologies topic up to and including Step 6 1121 , where you select
the Tagged Value Types checkbox. The MDG Technology Wizard - Tagged Value Types dialog
displays.

© 1998-2010 Sparx Systems Pty Ltd

 1128 Modeling Languages | Build Your Own Modeling Language

2. To select each required Tagged Value Type individually, highlight the file name in the Available Files list
and click on the --> button. The file name displays in the Selected Files list. Alternatively, to select all
available Tagged Value Types, click on the -->> button.
3. Click on the Next button to proceed.

5.3.1.2.1.7 Add Code Modules

When creating an MDG Technology file, you can include code modules. To use the code modules section of
the MDG Technology Types Wizard, follow the steps below:
1. Follow the steps in the Create MDG Technologies topic up to and including Step 6 1121 , where you select
the Code Modules checkbox. The MDG Technology Wizard - Code Modules dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1129

2. Click on the checkboxes (Product, Data Types, and Code Templates) for each of the required Code
Modules.

Note:
The code modules listed are those defined in your current project. These could be the Enterprise
Architect default languages, or those you have defined yourself using code templates 1302 and the
Code Template Editor 1305 . Before you can set up a code template for the new language in the editor,
you must define at least one data type 666 for the language. Once the MDG Technology file is created
it can be loaded into your current model and into other models.

3. To select any code options for a module, click on the [ ... ] button in the Code Options column for that
module. This enables you to select an XML document that provides additional settings for the language
that are not covered by the data types or code templates.

The root node of the XML document should be CodeOptions. The child nodes should be called
CodeOption and should contain a name attribute. The supported code options are as follows:

Code Option Description

ConstructorName The name of a function used as a constructor. Used by the

classHasConstructor 1174 code template macro.

CopyConstructorName The name of a function used as a copy constructor. Used by the

classHasCopyConstructor 1174 code template macro.

DefaultExtension The default extension when generating code.

DefaultSourceDirectory The default path to which Enterprise Architect generates new files.

DestructorName The name of a function used as a destructor. Used by the

classHasDestructor 1174 code template macro.

Editor The external editor used for editing source of this language.

ImplementationExtensio The extension used by Enterprise Architect to generate an implementation

n file.

© 1998-2010 Sparx Systems Pty Ltd

 1130 Modeling Languages | Build Your Own Modeling Language

Code Option Description

ImplementationPath The relative path from the source file to generate the implementation file.

PackagePathSeparator The delimiter used to separate package names when using the
packagePath macro from the code templates.

An example of a valid code options file is shown below.

<CodeOptions>
<CodeOption name="DefaultExtension">.ext</CodeOption>
<CodeOption name="Editor">C:\Windows\notepad.exe</CodeOption>
</CodeOptions>

4. Click on the Next button to proceed.

You can edit the code option values for source code engineering 1335 and for each required language using
the appropriate Language Options 1347 page of the Options dialog.

5.3.1.2.1.8 Add MDA Transforms

When creating an MDG Technology file, you can include the MDA Transformations that have been modified in
the model. To use the Transform Modules section of the MDG Technology Wizard, follow the steps below:
1. Follow the steps in the Create MDG Technologies topic up to and including Step 6 1121 , where you select
the MDA Transforms checkbox. The MDG Technology Wizard - Transform Modules dialog displays.

2. Click the checkbox against the template name of each required template that is present in the current
model.
3. Click on the Next button to proceed.

5.3.1.2.1.9 Add Images

When creating an MDG Technology file, you can include the images that have been imported into the model.
To use the Image Selection section of the MDG Technology Wizard, follow the steps below:
1. Follow the steps in the Create MDG Technologies topic up to and including Step 6 1121 , where you select
the Images checkbox. The MDG Technology Wizard - Image Selection dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1131

2. For each required model image available in the current model, select the checkbox next to the image
name. A preview of each image displays on the right of the dialog as you select the checkbox.
3. Click on the Next button to proceed.

5.3.1.2.1.10 Add Scripts

When creating an MDG Technology file, you can include scripts 1660 that you have created in the model.

Note:
This facility is available in the Corporate, Business and Software Engineering, Systems Engineering and
Ultimate editions of Enterprise Architect.

To use the Script Selection section of the MDG Technology Wizard, follow the steps below:
1. Follow the steps in the Create MDG Technologies topic up to and including Step 6 1121 , where you select
the Scripts checkbox. The MDG Technology Wizard - Scripts dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1132 Modeling Languages | Build Your Own Modeling Language

2. For each required script available in the current model, select the checkbox next to the script name.
3. Click on the Next button to proceed.

5.3.1.2.1.11 Add RTF Report Templates

When creating an MDG Technology file, you can include user-defined RTF Report templates. To use the
report templates section of the MDG Technology Wizard, follow the steps below:
1. Follow the steps in the Create MDG Technologies topic up to and including Step 6 1121 , where you select
the RTF Templates checkbox. The MDG Technology Wizard - RTF Report Templates dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1133

2. For each required user-defined report template available in the current model, select the checkbox next
to the template name.
3. Click on the Next button to proceed.

5.3.1.2.1.12 Add Linked Document Templates

When creating an MDG Technology file, you can include Linked Document templates. To use the Linked
Document templates section of the MDG Technology Wizard, follow the steps below:
1. Follow the steps in the Create MDG Technologies topic up to and including Step 6 1121 , where you select
the Linked Document Templates checkbox. The MDG Technology Wizard - Linked Document
Templates dialog displays.

2. For each required document template available in the current model, select the checkbox next to the
template name.
3. Click on the Next button to proceed.

5.3.1.2.2 Working with MTS Files

An MDG Technology Selection (.MTS) file stores the selected options that you define when creating an MDG
Technology File using the MDG Technology Wizard. If you use a .MTS file, you can edit it to change the
features selected when you generated the file, and to add or remove the advanced features described in this
topic.

Create a .MTS File

To create a .MTS file, select the Tools | Generate MDG Technology File menu option to launch the MDG
Technology Wizard, and work through the screens as described in Create MDG Technologies 1118 . On the
second page, select the Create a new MTS file option.

Advanced Options For Your .MTS File

Once you have created the .MTS file, you can add:
· Model Search definitions 1237

Note:
If you use a custom SQL search, the SQL must include ea_guid AS CLASSGUID and the object type.

© 1998-2010 Sparx Systems Pty Ltd

 1134 Modeling Languages | Build Your Own Modeling Language

· Model Views 1227

Notes:
· Technology views do not store Favorite packages, only Views.
· If your exported views run searches that you have defined you must also include those searches in your
MDG Technology.

· Model Validation configurations 1145

· Model Templates. 1146

Open the .MTS file in a text editor. To make it easier for you, you can copy the following lines and paste them
into the file before the last line of the file (that is, just before the </MDG.Selections> lines:
<ModelSearches file=""/>
<ModelViews file=""/>
(The code for the model validation configurations and model templates is provided in the corresponding
sections, accessed via the links in the list above.)
You can, if necessary, have more than one line for each inclusion; for example, more than one ModelSearch.
For each inserted line:
· In the file attribute, enter the filename of the Model Search XML file or Model View XML file.
Save the .MTS file.

Update the MDG Technology

Again select the Tools | Generate MDG Technology File menu option, but this time on the second page
select Open an Existing MTS file and specify the file path of the .MTS file you have updated. Click on <Next>
until the wizard is finished. Your MDG Technology file is updated.

5.3.1.2.3 Customize Toolbox Profiles

The following is a road map of how to create a set of custom toolboxes for Enterprise Architect.
1. Create a set of Toolbox Profiles 1134 that contain the definitions that Enterprise Architect requires to
create the toolboxes.
2. Create a .MTS file 1118 containing instructions on how to build your MDG Technology. Use this .MTS file
to build your MDG Technology.
3. Add some finishing touches:
· Create hidden sub-menus 1135
· Override Enterprise Architect's default toolboxes 1136

· Change the default icons for toolbox items 1136 .

5.3.1.2.3.1 Create Toolbox Profiles

You can create multiple toolbox profiles within an MDG Technology. Each toolbox profile contains definitions
that determine what appears in the Toolbox when a specific Toolbox page is open, either by selecting from
the More tools... option in the Toolbox window, or by opening or creating a diagram of the type that is linked
to the toolbox profile.
To create a toolbox profile, follow the steps below:
1. Create a diagram in a profile package. Give it a name by which you can refer to it later, such as
MyClassDiagram. In the Notes field for the diagram give it an alias and a description in the following
format:
Alias=MyClass;Notes=Structural elements for class diagrams;
2. On the diagram, create a Class, name it ToolboxPage and give it the «metaclass» stereotype.
3. Create a «stereotype» element for each of the toolbox pages to create within your toolbox, such as
MyClassElements and MyClassRelationships. Set their Alias to the text to display in the title bar of each
toolbox page, such as My Class Elements and My Class Relationships respectively. Use the Notes field
to define the tool-tip for each toolbox page; that is, Elements for Class Diagrams and Relationships
for Class Diagrams. Use the «extends» connector to set the stereotype elements to extend
ToolboxPage. See also: Toolbox Page Attributes 1135 .
4. In the «stereotype» elements, create an attribute for each toolbox item. The name of the attribute
should be the name of the element or connector to be dropped, including namespace, for example,
UML::Package, UML::Class and UML::Interface. The toolbox items display in the same order as the

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1135

attributes in the Class, so make use of the attribute ordering buttons to define the order of your toolbox.

Note:
To name an attribute for an item from your own technology, precede it with your profile name as the
namespace, and then follow it in brackets with the element or connector type that you are extending
(so that Enterprise Architect knows what object to create). For example, a SysML block element would
appear as SysML::Block(UML::Class). Click on the following links for a complete list of elements 1137
and connectors 1138 that can be extended.

To define a toolbox item that allows a pattern to be dropped onto a diagram, name the attribute My
Technology::MyPattern(UMLPattern) where MyTechnology is the ID of the technology and MyPattern is
the name of the pattern to drop. For example, BusFramework::Builder(UMLPattern).

To define a model-based pattern in a custom toolbox (such as the GoF patterns 901 ) create an attribute
with a name of the format PatternCategory::PatternName(UML Pattern). For example: GoF Behavioral
Patterns:: Mediator(UML Pattern).

You might not want to use names such as UML::Package or UML::Class in your toolbox, so give the
attributes an Initial Value of, for example, Package or Class.
5. To save the toolbox profile, right-click on the diagram and select the Save as Profile context menu
option.

Note:
Each profile element incorporated into an MDG Toolbox page enables synchronization 910 of the Tagged
Values and Constraints of all elements created from them.

The following attributes can be added to a stereotype Class that extends the ToolboxPage metaclass:
· ImagesOnly: if you give a toolbox page an attribute named imagesOnly with Initial Value set to true, the
toolbox page displays without the text labels next to the icons
· isCommon: if you give a toolbox page an attribute named IsCommon with Initial Value set to true, the
toolbox page is common to all defined toolboxes while your technology is active; the page is initially
displayed as collapsed
· isCollapsed: if you give a toolbox page an attribute named IsCollapsed with Initial Value set to true, the
toolbox page is initially minimized.
· Icon: see Assign Icons for Toolbox Items 1136
· isHidden: see Create Hidden Sub-Menus 1135 .

5.3.1.2.3.2 Create Hidden Sub-Menus

To create a sub-menu, create an additional «stereotype» element in the same toolbox profile and give it an
attribute named isHidden with Initial Value of true. Define the toolbox item attributes as before. In the parent
«stereotype» element, create an attribute with the identical name to the sub-menu element. The sub-menu
element can have an alias.
This technique is very useful for 'disambiguating' stereotypes that can be applied to multiple metaclasses. In
the example below, the «MyStereo» stereotype can be applied to either a Class or an Interface. On dragging
and dropping one from the toolbox, a hidden menu displays giving the choice of Class or Interface, then the
appropriate element is dropped:

© 1998-2010 Sparx Systems Pty Ltd

 1136 Modeling Languages | Build Your Own Modeling Language

5.3.1.2.3.3 Override Default Toolboxes

Enterprise Architect has many default Toolbox Profiles, one for each of its inbuilt diagram types. These define
the Toolbox pages that are displayed, by default, every time a diagram of a specific type is opened or brought
into view.
To replace one of Enterprise Architect's default toolboxes with one of your own (for example, if you have your
own version of the UML::Class toolbox that you want to be opened every time a Class diagram is opened - as
long as your technology is active) then include a RedefinedToolbox clause in the Notes field for the diagram
properties of your Toolbox Profile diagram. For example, the profile diagram's Notes field could resemble the
following:

RedefinedToolbox=UML::Class;Alias=Class;Notes=Structural elements for Class diagrams;

This states that the toolbox defined by this profile replaces the Enterprise Architect toolbox UML::Class as the
default toolbox for all UML Class diagrams. For a list of inbuilt toolboxes, see the List of Enterprise Architect
Toolboxes 1137 topic.

5.3.1.2.3.4 Assign Icons To Toolbox Items

To assign an icon to a toolbox item, create a new «stereotype» element in the same toolbox profile as the
toolbox item. Have the stereotype element extend a «metaclass» element named ToolboxItemImage. The «
stereotype» element must have the same name as the attribute that it is assigning an image to (for example,
MyTech::MyStereo(UML::Class) in the diagram below) and must have an attribute named Icon with Initial
Value set to the full path and file name of the image to be used. The image must be a 16x16 .BMP file.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1137

5.3.1.2.3.5 List of Enterprise Architect Toolboxes

The following is a list of the Toolbox pages that can be overridden:

· UML::Activity · Extended::Analysis
· UML::Class · Extended::Custom
· UML::Communication · Extended::DataModeling
· UML::Component · Extended::Maintenance
· UML::Composite · Extended::Requirements
· UML::Deployment · Extended::UserInterface
· UML::Interaction · Extended::WSDL
· UML::Metamodel · Extended::XMLSchema
· UML::Object
· UML::Profile
· UML::State
· UML::Timing
· UML::UseCase

5.3.1.2.3.6 Elements Used in Toolboxes

The following elements (all preceded with the namespace UML::) can be extended or redefined in Enterprise
Architect Toolbox pages. The text in red indicates the label name displayed in the default Enterprise Architect
Toolbox pages, where this differs in any way from the UML:: statement text.
When these profile elements are incorporated into an MDG Toolbox page, they enable synchronization 910 of
the Tagged Values and Constraints of all elements created from them.
You can also extend connectors 1138 .

· Action · InteractionState (State/Continuation)

· Activity · Interface
· ActivityFinal (Final) · Issue
· ActivityInitial (Initial) · Junction
· ActivityParameter · Lifeline
· ActivityPartition (Partition) · MergeNode (Merge)
· ActivityRegion (Region) · MessageEndPoint (Endpoint or Message Endpoint)
· Actor · MessageLabel (Message Label)
· Artifact · Metaclass
· AssociationElement (Association) · Node
· Boundary (for Use Cases) · Object
· CentralBufferNode (Central Buffer Node) · ObjectBoundary (Boundary)
· Change · ObjectControl (Control)
· Choice · ObjectEntity (Entity)
· Class · Package
· Collaboration · PackagingComponent
· CollaborationOccurrence · Part

© 1998-2010 Sparx Systems Pty Ltd

 1138 Modeling Languages | Build Your Own Modeling Language

· Comment (Note) · Port

· Component · Primitive
· Constraint · Process
· Datastore · Profile
· Decision · ProvidedInterface (Expose Interface)
· DeploymentSpecification (Deployment · ReceiveEvent (Receive)
Specification)
· Requirement
· Device
· RobustBoundary (Boundary)
· DiagramLegend (Diagram Legend)
· RobustControl (Control)
· DiagramNotes (Diagram Notes)
· RobustEntity (Entity)
· DocumentArtifact (Document Artifact or Document)
· Screen
· Entity (Information)
· SendEvent (Send)
· EntityObject (Entity)
· SequenceBoundary (Boundary)
· EntryState (Entry)
· SequenceControl (Control)
· Enumeration
· SequenceEntity (Entity)
· ExceptionHandler (Exception)
· Signal
· ExecutionEnvironment (Execution Environment)
· State
· ExitState (Exit)
· StateMachine (State Machine)
· Feature
· StateTimeLine (State Lifeline)
· FinalState (Final)
· Stereotype
· FlowFinalNode (Flow Final)
· StructuredActivity (Structured Activity)
· ForkJoinH (Fork/Join - Horizontal)
· SynchState (Synch)
· ForkJoinV (Fork/Join - Vertical)
· Table
· Gate (Diagram Gate)
· Terminate
· GUIElement (UI Control)
· TestCase (Test Case)
· HistoryState (History)
· Text
· Hyperlink
· UseCase (Use Case)
· InformationItem (Information Item)
· UMLBoundary (Boundary)
· InitialState (Initial)
· ValueTimeLine (Value Lifeline)
· InteractionFragment (Fragment)

5.3.1.2.3.7 Connectors Used In Toolboxes

The following connectors (all preceded with the namespace UML::) can be extended or redefined in Enterprise
Architect toolboxes. The text in red indicates the label name displayed in the default Enterprise Architect
Toolbox pages, where this differs in any way from the UML:: statement text.
You can also extend elements 1137 .

· Aggregation (Aggregate) · NoteLink (Note Link)

· Assembly · ObjectFlow (Object Flow)
· Association (Associate) · Occurrence
· AssociationClass (Association Class) · PackageImport (Package Import)
· CallFromRecursion (Call) · PackageMerge (Package Merge)

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1139

· CommunicationPath (Communication Path) · Precedes

· Composition (Compose) · ProfileApplication (Application)
· Connector · Realization (Realize or Implements)
· ControlFlow (Control Flow) · Recursion
· Delegate · Redefinition
· Dependency · Representation
· Deployment · Represents
· Extension · RoleBinding (Role Binding)
· Generalization (Generalize or Inheritance) · SelfMessage (Self-Message)
· InformationFlow (Information Flow) · TagValAssociation (Tagged Value)
· InterruptFlow (Interrupt Flow) · TraceLink (Trace)
· Invokes · Transition
· Manifest · UCExtend (Extend)
· Message · UCInclude (Include)
· Nesting · UseCaseLink (Use)

5.3.1.2.4 Create Diagram Profiles

Custom Diagram Types

You can create extended diagram types in Enterprise Architect and include them in MDG Technologies. To do
this, perform the following steps.
1. Create a profile with the same name as the MDG Technology in which it is to be included; for example,
SysML.
2. Create a «stereotype» Class element that is named as the custom diagram, for example,
BlockDefinition.
3. Create a Class element and name it as one of the Built-In Diagram Types 1140 prefixed with Diagram_,
for example Diagram_Logical for Class diagrams or Diagram_Use Case for Use Case diagrams.
4. Give the Diagram_x Class the «metaclass» stereotype and draw an «extends» connector from the
stereotype to the metaclass.
5. In the Notes field, give the stereotype Class a brief description of what the diagram is used for. This
description displays in the bottom right-hand corner of the New Diagram dialog.
6. Give the Diagram_x Class the following attributes as required:
· alias: string = Type (where Type appears before the word 'Diagram' on the diagram title bar)
· diagramID: string = abc (where abc is the diagram type that appears in the diagram frame 766 label)
· toolbox: string = ToolboxName (where ToolboxName is the name of the toolbox profile for the
toolbox that opens automatically each time a diagram is opened)
· frameString: string = FrameFormatString (where FrameFormatString is a string containing
substitution macros for defining the frame title, with or without additional delimiters such as [ ]; m
acros that can be used are:
· #DGMSTEREO#
· #DGMID#
· #DGMTYPE#
· #DGMALIAS#
· #DGMOWNERNAME#
· #DGMOWNERNAMEFULL#
· #DGMNAME#
· #DGMNAMEFULL#
· swimlanes: string = Lanes=2;Orientation=Horizontal;Lane1=Title1;Lane2=Title2; (where Lanes can
be any value, but the number of Lane<n> values must equal the value of Lanes; Orientation can be
omitted, in which case the swimlanes default to vertical)
© 1998-2010 Sparx Systems Pty Ltd
 1140 Modeling Languages | Build Your Own Modeling Language

· styleex: string = one or more of a range of values; see Attribute Values - stylex & pdata 1140
· pdata: string = one or more of a range of values; see Attribute Values - stylex & pdata 1140 .
The following example shows the DFD diagram profile which defines a DFD diagram as an extension of
the Enterprise Architect Analysis diagram.

7. Save the diagram as a profile in the usual manner.

8. Add the diagram profile to the 1124 .MTS file used in the MDG Technology.

5.3.1.2.4.1 Built-In Diagram Types

The following is a full list of built-in diagram types provided by Enterprise Architect.
· Activity
· Analysis
· Collaboration
· Component
· CompositeStructure
· Custom
· Deployment
· InteractionOverview
· Logical
· Object
· Package
· Sequence
· Statechart
· Timing
· Use Case
Note the use of Logical for Class diagrams and also notice the space in the middle of Use Case. These names
are used in Defining Child Diagram Types 1111 , or prefixed by Diagram_ in creating Diagram Profiles 1139 .

5.3.1.2.4.2 Attribute Values - stylex & pdata

When creating a diagram profile, you can use the pdata and stylex attributes to define a range of
characteristics of the diagrams created with the profile. If the attribute is defining several characteristics at
once, put the values in a single string separated by semicolons. For example:
styleEx: string = HideQuals=0;AdvanceElementProps=1;ShowNotes=1;

styleex: string =
· TConnectorNotation=Option; (where Option is one of UML 2.1, IDEF1X, or Information Engineering)
· ShowAsList=1; (to make the diagram open directly into the Element List 1255 )
· AdvanceElementProps=1; (to show the element property string)
· ShowTests=1; (to show the element Testing compartment)
· ShowMaint=1; (to show the element Maintenance compartment)
· ShowNotes=1; (to show the element Notes compartment)

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1141

· HideQuals=0; (to show qualifiers and visibility indicators)

· AdvancedFeatureProps=1; (to show the feature property string)
· ShowOpRetType=1; (to show the operation return type)
· SuppressBrackets=1; (to suppress brackets on operations without parameters)
· AttPkg=1; (to show package visible class members)
· VisibleAttributeDetail=1; (to show attribute details on the diagram)
· TExplicitNavigability=1; (to show non-navigable connector ends)
· AdvancedConnectorProps=1; (to show connector property strings)
· SuppConnectorLabels=1; (to suppress all connector labels).

pdata: string =
· UseAlias=1; (to use the aliases or elements in the diagram, if available)
· HideParents=0; (to show additional parents of elements in the diagram)
· HideEStereo=0; (to show element stereotypes in the diagram)
· ShowSN=1; (to show sequence notes)
· ShowIcons=1; (to use stereotype icons)
· HideAtts=0; (to show the element Attributes compartment)
· HideOps=0; (to show the element Operations compartment)
· ShowTags=1; (to show the element Tagged values compartment)
· ShowReqs=1; (to show the element Requirements compartment)
· ShowCons=1; (to show the element Constraints compartment)
· HideStereo=0; (to show attribute and operation stereotypes)
· HideProps=0; (to show property methods)
· OpParams=3; (to show operation parameters)
· HideRel=0; (to show relationships)
· SuppCN=0;(to show collaboration numbers).

5.3.1.2.5 Create Tasks Pane Profiles

Defining Tasks Pane profiles is a four-part process:
1. Define Toolboxes 1141 . Create any number of stereotype elements that each define a Tasks Pane
toolbox page
2. Define Contexts 1144 . Create any number of stereotype elements that each define a named Context. A
context might be when a specific diagram type is open, or when a specific element type is selected.
3. Allocate Contexts 1144 to Toolboxes. Define the many-to-many relationships between the Tasks Pane
toolboxes and the available contexts.
4. Create the Profile 1145 and incorporate it 1126 into your Technology.

5.3.1.2.5.1 Define Tasks Pane Toolboxes

A Tasks Pane toolbox is defined by a «stereotype» Class that extends a «metaclass»ToolboxPage element.
These elements must be owned by a «profile» package. Each «stereotype» Class represents the contents of
the Tasks Pane for a given context, and each attribute of the «stereotype» Class defines a command button in
the Tasks Pane. The following diagram shows an example of a Tasks Pane toolbox.

© 1998-2010 Sparx Systems Pty Ltd

 1142 Modeling Languages | Build Your Own Modeling Language

The title bar of the Tasks Pane toolbox is defined by the Alias of the «stereotype» Class, in this case
Debugging Profile. This example uses the following standard attribute types:
· EASystem::MenuCmd. These entries name an Enterprise Architect main menu command inside round
brackets. See the complete list of inbuilt commands 1142 . Type the text to appear in the Tasks Pane into the
Initial Value field.
· EASystem::ShowHelp. These entries name a page from the Enterprise Architect User Guide inside round
brackets. To find out the names of pages in the Enterprise Architect User Guide, right-click on the page
and select the Properties context menu option. Type the text to appear in the Tasks Pane into the Initial
Value field.
· EASystem::ShowMovie. These entries give the URL of a movie inside round brackets. Type the text to
appear in the Tasks Pane into the Initial Value field.
· SEPARATOR. This entry indicates that a separator should be placed in the Tasks Pane toolbox. If it is
necessary to place multiple separators in a single toolbox, note that Enterprise Architect does not allow
identically named attributes for a Class: simply change the case of one or more letters to get around the
problem.
Other useful attributes include:
· EASystem::ShowURL. This entry gives the URL of a web page inside round brackets. Type the text to
appear in the Tasks Pane into the Initial Value field.
· isCommon: A boolean attribute with Initial Value set to True, defines a Tasks Pane toolbox as context-
free and common, appearing for all contexts
· You can also run Add-In functions 1143 from the Tasks Pane.

Next Step
The next step is to create a set of Tasks Pane Contexts 1144 .

The following Enterprise Architect commands can all be used in user-defined Tasks Pane profiles. Tasks Pane
pages have attributes named in the form EASystem::MenuCmd(<CommandName>) where <CommandName>
is the name chosen from the following list:

· AddDiagram · ImplementationDetails · ValidateModel

· AddElement · ImportBinary · ViewAuditing
· AddPackage · ImportExportCSV · ViewDebug
· AutoRecordThread · ImportSchema · ViewElementList
· AddModelFromPattern · ImportSourceDirectory · ViewForum (for Team Review
window)
· Build · ImportWSDL
· ViewHierarchy (for Traceability

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1143

· BuildScripts · ImportXMI window)

· ConfigureCSV · ImportXMLSchema · ViewMaintenance
· ConfigureValidation · Run · ViewOutput
· CreateBaseLine · RunHTMLReport · ViewProjectManagement
· CreateSequenceDiagram · RunRTFReport · ViewRelationships
· DebugPause · SetClassifier · ViewRelMatrix
· DebugRun · ShowHideExecution · ViewRequirementTypes
· DebugStop · StartDebugRecording · ViewRules
· Deploy · StepInto · ViewSearch
· DiagramsOnlyReport · StepOut · ViewSourceCode
· ElementUsage · StepOver · ViewTaggedValues
· ExportXMI · StopDebugRecording · ViewTesting
· FileNew · Test · ViewTestingDetails
· FileOpen · TestingReport · ViewWebBrowser
· GenerateDDL · ToggleLevelNumbering
· GenerateWSDL · TransformPackage
· GenerateXMLSchema · TransformSelectedElements

To run Add-In functions from the Tasks Pane, you create an attribute in the Tasks Pane «stereotype» Class
with the following format:
"Assembly::FunctionName()"
where Assembly is the name of the Add-In and FunctionName is the name of a public function in the Add-In.
Give the attribute an initial value of the text that is to appear in the Tasks Pane. The function receives two
parameters and returns a success status, as in the following VB.Net example:

Public Function ShowMyDiagram(ByRef Repository As EA.Repository, ByVal args As Object) As String

Dim ret As String
ret = Repository.SQLQuery("select ea_guid from t_diagram where diagram_type='Custom' and StyleEx like
'*;MDGDgm=MyDiagrams::MyCustomDiagram;*'")
If ret Is Nothing Then
ShowMyDiagram = False
Exit Function
End If

Dim oXML As MSXML2.DOMDocument = New MSXML2.DOMDocument

oXML.loadXML(ret)

Dim NodeList As MSXML2.IXMLDOMNodeList = oXML.selectNodes("//ea_guid")

If NodeList.length = 0 Then
ShowMyDiagram = False
Exit Function
End If

Dim Node As MSXML2.IXMLDOMNode

Dim diag As EA.Diagram
If NodeList.length >= 1 Then
Node = NodeList.item(0)
diag = Repository.GetDiagramByGuid(Node.text)
Repository.OpenDiagram(diag.DiagramID)
Repository.ShowInProjectView(diag)
End If

ShowMyDiagram = True
End Function

© 1998-2010 Sparx Systems Pty Ltd

 1144 Modeling Languages | Build Your Own Modeling Language

5.3.1.2.5.2 Define Tasks Pane Contexts

Named Contexts
To create a context-sensitive set of Tasks Panes, you must define a set of named contexts that can be used in
the definition. A named context is a «stereotype» Class which extends a «metaclass» named ToolboxContext.
These elements must be owned by the same «profile» package that owns the Task Pane toolbox definitions
1141 . The context Class has one of the following attributes:

· contextDiagramType; this should have an Initial Value set to a valid diagram type
· contextItemType; this should have an Initial Value set to a valid element type
· contextKey.
Example Context Profile

Next Step
The next step is to allocate Tasks Pane contexts to Tasks Pane toolboxes 1144 .

5.3.1.2.5.3 Allocate Tasks Pane Contexts

Once you have defined your Tasks Pane toolboxes 1141 and Tasks Pane contexts 1144 , you can allocate your
toolboxes to as many contexts as apply, and any number of toolboxes can be allocated to a single context.
This is done by creating a «taggedValue» connector from the toolbox element to the context element. The
Association end at the context end must be named. The following diagram shows how this might appear.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1145

Next Step
The next step is to Save your Tasks Pane Profile 1145 .

5.3.1.2.5.4 Save a Tasks Pane Profile

The best organization structure for the model in which you are creating your Tasks Pane Profile is:
· A single «profile» package
· Three diagrams within the «profile» package named Toolboxes, Contexts and Context Allocations
· Each toolbox page «stereotype» element is owned by the «profile» package and appears on the Toolboxes
and Context Allocations diagrams
· Each context «stereotype» element is owned by the «profile» package and appears on the Contexts and
Context Allocations diagrams
· Each «metaclass» element is owned by the «profile» package and appears on the Toolboxes or Contexts
diagram.
From this structure, creating a Tasks Pane Profile is as simple as right-clicking on the «profile» package in the
Project Browser and selecting the Save Package as UML Profile context menu option.

5.3.1.2.6 Define Validation Configuration

The Model Validation Configuration dialog can be opened using the Project | Model Validation | Configure...
menu option. Using this dialog, you can choose which sets of validation rules are and are not executed when a
user performs a validation. Rather than perform this configuration manually and potentially have to change the
settings every time Enterprise Architect is started and a different technology is set active, you can define the
configuration settings within the MTS file.
To specify a set of rules as a white-list (that is, anything added to this list is turned ON), open your MTS file in
a text editor and copy and paste the following <ModelValidation> block at the top level inside the <MDG.Selections
> block:
<ModelValidation>
<RuleSet name="BPMNRules"/> <!-- ruleset ID defined in the Project.DefineRuleCategory call -->
<RuleSet name="MVR7F0001"/> <!-- notice you can turn on/off system rules as well! -->
</ModelValidation>
Ensure that the ruleset IDs do not contain any spaces.
To specify a set of rules as a black-list (that is, anything added to this list is turned OFF), open your MTS file in
a text editor and copy and paste the following <ModelValidation> block at the top level inside the <MDG.Selections

© 1998-2010 Sparx Systems Pty Ltd

 1146 Modeling Languages | Build Your Own Modeling Language

> block:
<ModelValidation isBlackList="true">
<RuleSet name="BPMNRules"/>
<RuleSet name="MVR7F0001"/>
</ModelValidation>
In the examples above, "BPMNRules" is the rule-set ID defined in the Project.DefineRuleCategory call - see
Project Interface 1753 for details. "MVR7F0001" is one of Enterprise Architect's built-in rule-sets. These validation
options are applied when you activate the appropriate technology. The global (default) technology has all rules
turned on.

5.3.1.2.7 Incorporate Model Templates

Enterprise Architect has a number of Model Templates 373 that can be added into a model, either on creation
of the model, or at any time by right-clicking on a package in the Project Browser and selecting the Add | Add
a New Model using Wizard 372 ... context menu option. You can create your own templates and include them
in your MDG Technology. The first step is to create a template package and save it to the MTS file.
Open your MTS file in a text editor and copy and paste the following <ModelTemplates> block at the top level
inside the <MDG.Selections> block:
<ModelTemplates>
<Model name="Template Name"
description="This is the description."
location="MyTemplatePackage.xml"
default="yes"
icon = "34"
filter= "Filter Name"/>
</ModelTemplates>
You can include as many <ModelTemplates> blocks as you have model templates. The attributes have the
following meanings:
· Model name: The name of the model template as shown in the Select model(s) dialog, which displays
when you create a new model or when you execute the Add a New Model using Wizard menu option.
· description: The text that is displayed in the Select model(s) dialog when the name is selected.
· location: Contains the path of the XML file that contains the XMI export of the model template package,
relative to the location of the MDG Technology file. If the XMI file is in the same folder as the technology file
then this just contains the file name.
· default: Contains either yes indicating that the model template is checked by default, or no indicating that
the model template is un-checked by default.
· icon: Contains an index to Enterprise Architect's base icons list. To show the appropriate view icon, use
one of the following values: 29 = Use Case, 30 = Dynamic; 31 = Class; 32 = Component; 33 =
Deployment; 34 = Simple.
· filter: If you have a large number of model templates, you can group them on the Select model(s) dialog by
giving all the model templates in the same group the same filter name. The filter name given appears in
the Select from: list box in the Select model(s) dialog.

5.3.1.2.8 Deploy An MDG Technology

An MDG Technology can be deployed in one of two ways: as a file or from an Add-In.

Deploy From a File

To deploy your technology as a file, you have a number of choices:
· Copy it to a folder named MDGTechnologies, which you must create under your Enterprise Architect
installation directory (by default this is C:\Program Files\Sparx Systems\EA. When you restart Enterprise
Architect, your MDG Technology is deployed.
· Copy it to any folder in your file system, including network drives: use the Enterprise Architect Settings |
MDG Technologies... menu option, press the Advanced button and add the folder to the Technologies
path. This deployment method enables you to quickly and easily deploy a technology to all Enterprise
Architect users on a LAN.
· Upload it to an internet or intranet location: use the Enterprise Architect Settings | MDG Technologies...
menu option, press the Advanced button and add the URL to the Technologies path. This deployment
method enables you to quickly and easily deploy a technology to an even wider group of Enterprise
Architect users.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1147

Deploy From an Add-in

To deploy your technology from an Add-In, you must write an EA_OnInitializeTechnologies 1803 function. The
following example is written in VB.Net:
Public Function EA_OnInitializeTechnologies(ByVal Repository As EA.Repository) As Object
EA_OnInitializeTechnologies = My.Resources.MyTechnology
End Function

5.3.1.3 Shape Scripts

Introduction
Enterprise Architect Shape Scripts enable you to specify custom shapes via a scripting language. These
custom shapes are drawn instead of the standard UML notation. Each script is associated with a particular
stereotype, and is drawn for every element of that stereotype. The following topics describe how to create and
apply Shape Scripts:
· Getting Started with Shape Scripts 1148
· Write Scripts 1151
· Example Scripts 1163
· Shape Editor 1150
· Add Shape Scripts to UML Profiles 1104

© 1998-2010 Sparx Systems Pty Ltd

 1148 Modeling Languages | Build Your Own Modeling Language

5.3.1.3.1 Getting Started With Shape Scripts

Shape Scripts are associated with stereotypes and are defined via the Stereotypes tab of the UML Types
dialog. To access this dialog, select the Settings | UML menu option. Each stereotype defined can have a
Shape Script.

You can create a Shape Script for an existing stereotype by selecting the stereotype from the list. Alternatively,
you can create new stereotypes by clicking on the New button and giving the stereotype a name. Select a
base Class and click on the Save button. Once the stereotype is saved, it displays in the list.

To override the appearance, select the Shape Script radio button and then click on the Assign button. The
Shape Script Editor 1150 displays.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1149

Type the example Shape Scripts in the Edit window. You can click on the Refresh button in order to view the
shape in the preview window.

Note:
If you define a composite Shape Script (such as the connector at the end of the Example Scripts 1163 topic),
click on the Next Shape button to page through the components of the shape.

Once you have finished writing your Shape Script 1151 , click on the OK button. To save the Shape Script you
must click on the Save button on the Stereotypes tab.
Once you have created your Shape Script for a particular stereotype, you can assign that stereotype to an
element or connector. The appearance reflects the Shape Script you created. To do this, drag and drop the
appropriate element or connector into your diagram.

Note:
If an element's appearance is modified by a Shape Script, many of the options on the Advanced 549 context
menu for that element are disabled.

Right-click on the element or connector and select the Properties context menu option. Click on the
Stereotype field drop-down arrow, select the stereotype you created and click on the OK button. The object's
shape now reflects the Shape Script you created.

© 1998-2010 Sparx Systems Pty Ltd

 1150 Modeling Languages | Build Your Own Modeling Language

5.3.1.3.2 Shape Editor

The Shape Editor enables you to create Shape Scripts. It provides the facilities of the Common Code Editor,
including intellisense for shape script attributes and functions. For more information on intellisense and the
Common Code Editor, see the Code Editors 1428 topic.
To access the Shape Editor, follow the steps below:
1. Select the Settings | UML menu option; the UML Types dialog displays, defaulted to the Stereotypes
tab.
2. Type a name in the Stereotype field, or click on an the required stereotype in the list.
3. From the Override Appearance panel, select the Shape Script radio button.
4. Click on the Assign button. The Shape Editor dialog displays.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1151

Option Use to

Format Select the Shape Script version.

Import Import a Shape Script from a text file.

Export Export a Shape Script to a text file.

OK Exit from the Shape Editor, don't forget to save your script from the
Stereotypes tab. See Getting Started With Shape Scripts 1148 .

Next Shape Rotate though the multiple shape definitions.

Refresh Parse your script and display the result in the Preview window.

5.3.1.3.3 Write Scripts

This topic is a detailed reference for writing Shape Scripts. For an introduction to writing Shape Scripts, see
the Getting Started With Shape Scripts 1148 and Example Scripts 1163 topics.
See the following reference topics for more detailed information on shape scripting:
· Syntax Grammar 1151
· Shape Attributes 1152
· Drawing Methods 1154
· Color Queries 1158
· Conditional Branching 1158
· Query Methods 1158
· Display Element/Connector Properties 1158

· Sub-shapes 1160
· Reserved Names 1161
· Miscellaneous 1162

5.3.1.3.3.1 Syntax Grammar

Grammar symbols:
· * = zero or more
· + = one or more
· | = or
· ; = terminator

© 1998-2010 Sparx Systems Pty Ltd

 1152 Modeling Languages | Build Your Own Modeling Language

ShapeScript ::= <Shape>*;

Shape ::= <ShapeDeclaration> <ShapeBody>;

ShapeDeclaration ::= <ShapeType> <ShapeName>;

ShapeType ::= "shape" | "decoration";

ShapeName ::= <ReservedShapeName> | <stringliteral>;

ReservedShapeName ::= See Reserved Names 1161 for fulled reserved shape listing

ShapeBody ::= "{" <InitialisationAttributeAssignment>* <DrawingStatement>*

<SubShape>* "}";

InitialisationAttributeAssign ::= <Attribute> "=" <Value> ";";

ment

Attribute ::= See Shape Attributes 1152 for full listing of attribute names

DrawingStatement ::= <IfElseSection> | <Method>;

IfElseSection ::= "if" "(" <QueryExpression> ")" <TrueSection> [<ElseSection>];

QueryExpression ::= <QueryName> "(" <ParameterList> ")";

QueryName ::= See Query Methods 1158 for a full listing of Query names

TrueSection ::= "{" <DrawingStatement>* "}"

ElseSection ::= "else" "{" <DrawingStatement>* "}"

Method ::= <MethodName> "(" <ParameterList> ")" ";";

MethodName ::= See Drawing Methods 1154 for a full listing of method names

5.3.1.3.3.2 Shape Attributes

syntax: attribute "=" value ";"
example:
shape main
{
//Initialisation attributes - must be before drawing commands
noshadow = "true";
h_align = "center";

//drawing commands
rectangle(0,0,100,100);
println("foo bar");
}

Attribute Name Type Description

bottomAnchorOffse (int,int) When creating a Shape Script for an embedded element (such as a Port),
t use this attribute to offset the shape from the bottom edge of its parent.
For example:
bottomAnchorOffset=(0,-10); move embedded element up 10 pixels from
the bottom edge

dockable string Makes the shape default to dockable 555 , so that it can be aligned with and
joined to other elements (both other Shape Scripts and standard elements)
on a diagram. You cannot reverse the dockable status with the

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1153

Attribute Name Type Description

Appearance menu option; to change the status, you must edit the Shape
Script.
Valid values: standard or off

editableField string Defines a shape as an editable region of the element.

This field impacts element shapes only, line glyphs are not supported.
Valid Values: alias, name, note, stereotype

endPointY, integer Only used for the reserved target and source shapes for connectors; this
endPointX point determines where the main connector line connects to the end
shapes.
Default: 0 and 0

fixedAspectRatio string Set to true to fix the aspect ratio. Do not use if you do not want to fix the
aspect ratio.

h_Align string Affects horizontal placement of printed text and subshapes depending on
the layoutType attribute.
Valid values: left, center, or right

layoutType string Determines how subshapes are sized and positioned. See Subshape
Layout 1160 for further details.
Valid values: leftright, topdown, border

leftAnchorOffset (int,int) When creating a Shape Script for an embedded element (such as a Port),
use this attribute to offset the shape from the left edge of its parent.
For example:
leftAnchorOffset=(10,0); move embedded element right 10 pixels from the
left edge

noShadow string Set to true to suppress the shapes shadow from being rendered.
Valid values: true or false (default= false)

orientation string Applies to decoration shapes only. Determines where the decoration is
positioned within the containing element glyph.
Valid values: NW, N, NE, E, SE, S, SW, W

preferredHeight Used by border layoutType - north and south

Used in drawing the source and target shapes for connectors to determine
how wide the line is.

preferredWidth Used by border layoutType - east and west.

Used by leftright layoutType, shapes where scalable is false to determine
how much space they occupy for layout purposes.

rightAnchorOffset (int,int) When creating a Shape Script for an embedded element (such as a Port),
use this attribute to offset the shape from the right edge of its parent.
For example:
rightAnchorOffset=(-10,0); move embedded element left 10 pixels from the
right edge

rotatable string Set to false to prevent rotation of the shape. This attribute is only
applicable to the source and target shapes for lines glyphs.
Valid values: true or false (default = true)

© 1998-2010 Sparx Systems Pty Ltd

 1154 Modeling Languages | Build Your Own Modeling Language

Attribute Name Type Description

scalable string Set to false to stop the shape from being relatively sized to the associated
diagram glyph.
Valid values: true or false (default= true)

topAnchorOffset (int,int) When creating a Shape Script for an embedded element (such as a Port),
use this attribute to offset the shape from the top edge of its parent.
For example:
topAnchorOffset=(0,10); move embedded element down 10 pixels from the
top edge

v_Align string Affects vertical placement of printed text and subshapes depending on the
layoutType attribute.
Valid values: top, center, or bottom

5.3.1.3.3.3 Drawing Methods

Method Name Description

addsubshape( Adds a sub-shape with the name shapename that must be defined within
string shapename[, the current shape definition.
int width,
int height])

arc( Draws an elliptical anticlockwise arc with the ellipse having extents at left,
int left, top, right and bottom. The start point of the arc is defined by the
int top, intersection of the ellipse and the line from the center of the ellipse to the
int right, point (startingpointx, startingpointy). The end of the arc is similarly
int bottom, defined by the intersection of the ellipse and the line from the center of the
int startingpointx, ellipse to the point (endingpointx, endingpointy).
int startingpointy, For example:
int endingpointx,
Arc(0, 0, 100, 100, 95, 0, 5, 0);
int endingpointy)

arcto( As for the arc method, except that a line is drawn from the current position
int left, to the starting point of the arc, and then the current position is updated to
int top, the end point of the arc.
int right,
int bottom,
int startingpointx,
int startingpointy,
int endingpointx,
int endingpointy)

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1155

Method Name Description

bezierto( Draws a bezier curve and updates the pen position.

int controlpoint1x,
int controlpoint1y,
int controlpoint2x,
int controlpoint2y,
int endpointx,
int endpointy)

defSize(int width, int height) Sets the default size of the element.
This can appear in IF and ELSE clauses with different values in each, and
causes the element to be resized automatically each time the values
change. For example:
if(HasTag("horizontal","true")) {
defSize(100,20);
rectangle(0,0,100,100);
}
else {
defSize(20,100);
rectangle(0,0,100,100);
}

The above example sets the shape to the specified default size each time
the
Tagged Value horizontal is changed.

When this is set, [Alt]+[Z] also resizes the shape to the defined dimensions.

Note:
The minimum value for both int width and int height is 10.

drawnativeshape() Causes Enterprise Architect to render the shape using its usual,
non-Shapescript notation. Subsequent drawing commands are
super-imposed over the native notation.
This method is only enabled for element Shape Scripts; line Shape Scripts
are not supported.

ellipse( Draws an ellipse with extents defined by left, top, right and bottom.
int left,
int top,
int right,
int bottom)

endpath() Ends the sequence of drawing commands that define a path.

fillandstrokepath() Fills the previously defined path with the current fill color, then draws its
outline with the current pen.

fillpath() Fills the previously defined path with the current fill color.

hidelabel( Hides the label specified by labelname.

string labelname)

image( Draws the image that has the name imageId in the Image Manager.
string imageId,
int left, Note:
int top,
The image must exist within the model in which the stereotype is used. If it
int right, does not already exist in the model, you must import it as reference data
int bottom) 225 .

lineto( Draws a line from the current cursor position to a point specified by x and y,

© 1998-2010 Sparx Systems Pty Ltd

 1156 Modeling Languages | Build Your Own Modeling Language

Method Name Description

int x, and then updates the pen cursor to that position.

int y)

moveto( Moves the pen cursor to the point specified by x and y.

int x,
int y)

polygon( Draws a regular polygon with center at the point (centerx, centery), and
int centerx, numberofsides number of sides.
int centery,
int numberofsides,
int radius,
float rotation)

print( Prints the specified text string.

string text)
Note:
You cannot change the font size, type or color of this text.

printifdefined( Prints the truepart if the given property exists and has a non-empty value,
string otherwise prints the optional falsepart.
propertyname,
string truepart[, Note:
string falsepart]) You cannot change the font size, type or color of this text.

println( Appends a line of text to the shape and a line break.

string text)
Note:
You cannot change the font size, type or color of this text.

printwrapped( Prints the specified text string, wrapped over multiple lines if the text is wider
string text) than its containing shape.

Note:
You cannot change the font size, type or color of this text.

rectangle( Draws a rectangle with extents at left, top, right, bottom. Values are
int left, percentages.
int top,
int right,
int bottom)

roundrect( Draws a rectangle with rounded corners, with extents defined by left, top,
int left, right and bottom. The size for the corners is defined by abs_cornerwidth
int top, and abs_cornerheight; these values do not scale with the shape.
int right,
int bottom,
int
abs_cornerwidth,
int
abs_cornerheight)

setdefaultcolors() Returns the brush and pen color to the default settings, or to the
user-defined colors if available. See Color Queries 1158 .

setfillcolor( Sets the fill color.

int red,
You can specify the required color by defining RGB values or using a color
int green,
value returned by any of the Color Queries 1158 ; for example:

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1157

Method Name Description

GetUserFillColor()
int blue)
setfillcolor(
Color newColor)

setlinestyle( Changes the stroke pattern for commands that use the pen.
string linestyle)
Parameters:
string linestyle: the following styles are valid:
· solid
· dash
· dot
· dashdot
· dashdotdot
setorigin( Positions floating text labels relative to the main shape.
string relativeTo,
relativeTo is one of N, NE, E, SE, S, SW, W, NW, CENTER
int xOffset,
int yOffset) xOffset and yOffset are in pixels, not percentage values, and can be
negative.

setpen( Sets the pen to the defined color and optionally sets the pen width.
int red,
int green, Note:
int blue[, This method is only for line-drawing commands. It does not affect any text
int penwidth]) commands.

setpencolor( Sets the pen color.

int red,
You can specify the required color by defining RGB values or using a color
int green,
value returned by any of the Color Queries 1158 ; for example:
int blue)
GetUserFillColor()
setpencolor(
Color newColor) Note:
This method is only for line-drawing commands. It does not affect any text
commands.

setpenwidth( Sets the width of the pen. Pen width should be between 1 and 5.
int penwidth)
Note:
This method is only for line-drawing commands. It does not affect any text
commands.

showlabel( Reveals the hidden label specified by labelname.

string labelname)

startcloudpath( Similar to StartPath, except that it draws the path with cloud-like curved
puffWidth, segments (puffs).
puffHeight,
Parameters:
noise)
· float puffWidth (default = 30), the horizontal distance between puffs
· float puffHeight (default = 15), the vertical distance between puffs
· float noise (default = 1.0), the randomization of the puffs' positions.
startpath() Starts the sequence of drawing commands that define a path.

strokepath() Draws the outline of the previously defined path with the current pen.

© 1998-2010 Sparx Systems Pty Ltd

 1158 Modeling Languages | Build Your Own Modeling Language

5.3.1.3.3.4 Color Queries

Color queries can only be used to retrieve arguments for the SetPenColor and SetFillColor commands. These
queries can be used in place of the arguments.
getUserFillColor()
getUserBorderColor()
getUserFontColor()
getUserPenSize()
shape main
{
setfillcolor(getuserbordercolor());
setpencolor(getuserfillcolor());

rectangle(0,0,100,100);
}

5.3.1.3.3.5 Conditional Branching

Shape Scripts provide condition branching with the if else statement, and query methods that evaluate to
either True or False. See:
· Syntax Grammar 1151 for IF statement syntax.
· Query Methods 1158 for methods that can be used as the conditional expression for IF statements.
· Example Scripts 1163 for an example.

5.3.1.3.3.6 Query Methods

Two query methods are available for seeing if the associated element has certain tags or properties; these
methods can be used as the conditional expression for an if else statement.

Method Description

boolean HasTag( Returns true if the associated element has a tag value with the name tagname.
string tagname, If the second parameter tagvalue is provided, the tag tagname must be present,
[string and the value of the tag has to be equal to tagvalue for the method to return true
tagvalue]) .

boolean HasProperty( Returns true if the associated element has a property with the name
string propertyname. If the second parameter propertyvalue is provided, the property
propertyname, must be present, and the value of the property has to be equal to propertyvalue
[string for the method to return true.
propertyvalue])
See Display Element/Connector Properties 1158 for a list of valid values for
propertyname.

5.3.1.3.3.7 Display Element/Connector Properties

The commands print, println, and printwrapped all take a string parameter representing the text to be
printed. Element and connector properties can be added to the text using the substitution macro
#propertyname#.
For example: println("name: #NAME#");
In addition to the properties listed below, Tagged Values can also be displayed by prefixing the Tagged Value
name with TAG:.
For example: print("#TAG:condition#");
You can also test against and display an element's custom properties in the same way as you do the named
properties.
For example: if(hasproperty("Name","Value"))
...
and: print("#Name#");

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1159

Properties Visible to Shape Scripts

Properties for Element Shape Scripts
· addin (value returned from an Add-In)
· alias
· author
· cardinality
· classifier
· classifier.alias
· classifier.metatype
· classifier.stereotype
· classifier.type
· complexity
· concurrency
· datecreated
· datemodified
· diagram.mdgtype
· diagram.name
· diagram.stereotype
· diagram.type
· haslinkeddocument
· isabstract
· isactive
· iscomposite
· isembedded
· isinparent
· isleaf
· islocked
· isroot
· isspec
· istagged
· keywords
· language
· metatype
· multiplicity
· name
· notes
· packagename
· parentedge ("Right", "Left", "Top", "Bottom")
· parent.metatype
· persistence
· phase
· propertytype
· propertytype.alias
· propertytype.metatype
· propertytype.name
· propertytype.stereotype
· scope
· status
· stereotype
· type
· version

© 1998-2010 Sparx Systems Pty Ltd

 1160 Modeling Languages | Build Your Own Modeling Language

· visibility.

Properties for Connector Shape Scripts

· addin (value returned from an Add-In)
· alias
· diagram.connectornotation
· diagram.mdgtype
· diagram.name
· diagram.stereotype
· diagram.type
· direction
· isroot
· isleaf
· name
· notes
· source.aggregation
· source.alias
· source.changeable
· source.constraints
· source.element.name
· source.element.stereotype
· source.metatype
· source.multiplicity
· source.multiplicityisordered
· source.qualifiers
· source.stereotype
· source.targetscope
· stereotype
· subtype
· target.aggregation
· target.alias
· target.changable
· target.constraints
· target.element.name
· target.element.stereotype
· target.metatype
· target.multiplicity
· target.multiplicityisordered
· target.qualifiers
· target.stereotype
· target.targetscope
· type.

5.3.1.3.3.8 Sub-Shapes
Shapes can contain - and be composed of - other shapes.

Subshape Layout
To set the layout type, the layoutType attribute must be set in the initialization attributes section of the script;
in other words, before any of the methods are called. Valid values for this attribute are:

LeftRight
Shapes with leftright layout position subshapes side by side, with the first added on the left, and subsequent
subshapes to the right.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1161

TopDown
TopDown places subshapes in a vertical arrangement, with the first shape added to the top and subsequent
shape added below.

Border
Border layout requires an additional argument to the addsubshape method to specify which region of the
containing shape the subshape is to occupy: N, E, S, W or CENTER. Each region can only be occupied by
one subshape.
A subshape that is assigned to the E or W region must have its preferredwidth attribute specified in its
declaration. Similarly, subshapes added to N or S must have their preferredheight attribute set. In this case,
the values for these attributes are treated as static lengths and do not scale glyphs.

For example:
shape main
{
layouttype="topdown";
setfillcolor{0,0,255};
rectangle{0,0,100,100};
addsubshape{"sub",50,100,20,0};
addsubshape{"sub",50,100,30,-100};
addsubshape{"sub",50,100,40,-200};
addsubshape{"sub",50,100,50,-300};

shape sub
{
setfillcolor{0,255,0};
ellipse{0,0,100,100};
}
}

The above script provides the following shape:

5.3.1.3.3.9 Reserved Names

Elements
Elements (such as Class, State or Event) have the following reserved names for parts of the shape.

Name Description

shape main The main shape is the whole shape.

shape label The shape label gives the shape a detached label.

decoration Decoration gives the shape a decoration as defined by the

<identifier> name in <identifier>.

Connectors
Connectors (such as Association, Dependency or Generalization) have the following reserved names for parts

© 1998-2010 Sparx Systems Pty Ltd

 1162 Modeling Languages | Build Your Own Modeling Language

of the shape.

Name Description

shape main The main shape is the whole shape.

shape source The source shape is an extra shape at the source end of the
connector.

shape target The target shape is an extra shape at the target end of the
connector.

shape <labelID> The <labelID> gives the connector a detached label, where
<labelID> is one of the following:
· LeftTopLabel
· MiddleTopLabel
· RightTopLabel
· LeftBottomLabel
· MiddleBottomLabel
· RightBottomLabel

5.3.1.3.3.10 Miscellaneous

Return Command
Execution of the script can be terminated by using the return command. Please see Example Scripts 1163 for an
example.

Looping
The Shape Script feature does not support looping constructs.

Comments
C-style comments are supported. For example:
// C Style Single Line comment
/* Multi Line
comment supported */

String Manipulation
Not Supported.

Arithmetical Operations
Not Supported.

Variables Declaration
Not Supported.

Change ShapeScript Fonts

Not possible.

Can I apply a Shapescript without using Stereotypes?

No.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1163

5.3.1.3.4 Example Scripts

Below is a selection of example Shape Scripts.

Code Result
//BASIC SHAPES
shape main
{
setfillcolor(255,0,0); // (R,G,B)
rectangle(0,0,90,30); // (x1,y1,x2,y2)

setfillcolor(0,255,0); // (R,G,B)
ellipse(0,30,90,60); // (x1,y1,x2,y2)

setfillcolor(0,0,255); // (R,G,B)
rectangle(0,60,90,90); // (x1,y1,x2,y2)
}

//SINGLE CONDITIONAL SHAPE

shape main
{
if (HasTag("Trigger","Link"))
{// Only draw if the object has a Tagged Value
// Trigger=Link
// Set the fill color for the path
setfillcolor(0,0,0);
startpath(); // Start to trace out a path
moveto(23,40);
lineto(23,60);
lineto(50,60);
lineto(50,76);
lineto(76,50);
lineto(50,23);
lineto(50,40);
endpath(); // End tracing out a path
// Fill the traced path with the fill color
fillandstrokepath();
return;
}
}
//MULTI CONDITIONAL SHAPE
shape main
{
startpath();
ellipse(0,0,100,100);
endpath();
fillandstrokepath();
ellipse(3,3,27,27);

if (HasTag("Trigger","None"))
{
return;
}

if (HasTag("Trigger","Error"))
{
setfillcolor(0,0,0);
startpath();
moveto(23,77);
lineto(37,40);
lineto(60,47);
lineto(77,23);
lineto(63,60);
lineto(40,53);
lineto(23,77);
endpath();
fillandstrokepath();
return;
}
if (HasTag("Trigger","Message"))

© 1998-2010 Sparx Systems Pty Ltd

 1164 Modeling Languages | Build Your Own Modeling Language

Code Result
{
rectangle(22,22,78,78);
moveto(22,22);
lineto(50,50);
lineto(78,22);
return;
}
}

//SUB SHAPES
shape main
{
rectangle(0,0,100,100);

addsubshape("red", 10, 20);

addsubshape("blue", 30, 40);
addsubshape("green", 50, 20);
addsubshape("red", 100, 20);

shape red
{
setfillcolor(200, 50, 100);
rectangle(0,0,100,100);
}

shape blue
{
setfillcolor(100, 50, 200);
rectangle(0,0,100,100);
}

shape green
{
setfillcolor(50, 200, 100);
rectangle(0,0,100,100);
}
}
//Editable Field Shape
shape main
{
rectangle(0,0,100,100);

addsubshape("namecompartment", 100, 20);

addsubshape("stereotypecompartment", 100, 40);

shape namecompartment
{
h_align = "center";
editablefield = "name";

rectangle(0,0,100,100);
println("name: #name#");
}

shape stereotypecompartment
{
h_align = "center";
editablefield = "stereotype";

rectangle(0,0,100,100);
println("stereotype: #stereotype#");
}
}

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1165

Code Result
//Return Statement Shape
shape main
{
if(hasTag("alternatenotation", "false"))
{
//draw ea's inbuild glyph
drawnativeshape();
//exit script with the return statement
return;
}

//alternate notation commands

//...
rectangle(0,0,100,100);
}

//Cloud Path Example Shape

shape main
{
StartCloudPath();
Rectangle(0,0,100,100);
EndPath();
FillAndStrokePath();
}

// Connector Example
shape main
{
// draw a dashed line
noshadow=true;
setlinestyle("DASH");
moveto(0,0);
lineto(100,0);
}

shape source
{
// draw a circle at the source end
rotatable = true;
startpath();
ellipse(0,6,12,-6);
endpath();
fillandstrokepath();
}

shape target
{
// draw an arrowhead at the target end
rotatable = true;
startpath();
moveto(0,0);
lineto(16,6);
lineto(16,-6);
endpath();
fillandstrokepath();
}
// Double Line
shape main
{
noshadow=true;
moveto(0,-10);
lineto(100,-10);
moveto(0,10);
lineto(100,10);

© 1998-2010 Sparx Systems Pty Ltd

 1166 Modeling Languages | Build Your Own Modeling Language

Code Result
}

5.3.1.4 Tagged Value Types

Enterprise Architect provides a number of predefined Tagged Value Types that enable you to create your own:
· Tagged Values that are structured 1166 with a specific format, with or without tag filters 1167 , or
· Tagged Values that return values from the various reference data 1169 tables.
You can also use a masking parameter to create your own customized masked Tagged Value Type 1171 .

Note:
You can transport Tagged Value Type definitions between models, using the Export Reference Data 223 and
Import Reference Data 225 options on the Tools menu. Tagged Value Types are exported as Property
Types.

5.3.1.4.1 Predefined Structured Types

This table details the predefined structured Tagged Value types, along with the syntax used to create the initial
values for their use. You use these to create your own structured Tagged Values 1168 .

Note:
Tagged Value Type and Format entries are case-sensitive.

Tagged Value Type Format Description

Boolean Type=Boolean; Enables input of True or False, either of which can be

Default=Val; the default value.

Classifier Type=Classifier; Deprecated. Use RefGUID and RefGUIDList.

Values=Type1,Type2;
Returns the name of a user-selected element from the
Stereotypes=Stereotype
model, where Type1 and Type2 specify one or more
1;
allowed element types and Stereotype1 represents an
allowed stereotype.

Color Type=Color; Enables input of a color value from a color chooser

Default=Val; menu, where the value is the decimal integer
translation of the color's Hex RGB value. For example,
the RGB for Red is FF, and the decimal value is 255.

Const Type=Const; Enables creation of a read-only constant value.

Default=Val;

Custom Type= Custom; Enables you to create your own template for predefined
types; more information is provided in the Create
Custom Tagged Value Type 1171 topic.

DateTime Type=DateTime; Enables input of the date and time for the Tagged
Value from a calendar menu.

Directory Type=Directory; Enables entry of a directory path from a browser.

Default=Val;
You can set a default directory path as a string value.

Enum Type=Enum; Enables definition of a comma-separated list, where

Values=Val1,Val2,Val3; Val1, Val2 and Val3 represent values in the list and
Default=Val2; Default represents the default value of the list.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1167

Tagged Value Type Format Description

File Type=File; Enables input of a filename from a file browser dialog.

Default=Val; The named file can be launched in its default
application.
You can set a default file as a string containing the file
path and file name.

Float, Decimal, Double Type=Float; Enable entry of a Float, Decimal or Double value.
Type=Decimal; These types all map to the same type of data.
Type=Double; You can set a default for any or all of these.
Default=Val;

Integer Type=Integer; Enables entry of an Integer value, and a default.

Default=Val;

Memo Type=Memo; Enables input of large and complex Tagged Values.

RefGUID Type=RefGUID; Enables the Tagged Value to reference an element

Values=Type1,Type2; from the model by specifying the element's GUID,
Stereotypes=Stereotype where Type1 and Type2 specify one or more allowed
1; diagram objects (such as Class, Component,
Attribute or Operation) and Stereotype1 represents
an allowed stereotype.
Set the classifier 515 , attribute or operation 748 for a
Tagged Value of this type by clicking on the [ ... ]
button against the Tagged Value in the Tagged Value
window.

RefGUIDList Type=RefGUIDList; Enables the Tagged Value to reference a list of

Values=Type1,Type2; elements from the model by specifying each element's
Stereotypes=Stereotype GUID, where Type1 and Type2 specify one or more
1; allowed diagram objects (such as Class or
Component) and Stereotype1 represents an allowed
stereotype.
Set the classifier 515 , attribute or operation 748 for a
Tagged Value of this type by clicking on the [ ... ]
button against the Tagged Value in the Tagged Value
window.

Spin Type=Spin; Enables creation of a spin control with the value of

LowerBound=x; LowerBound being the lowest value and UpperBound
UpperBound=x; being the highest value.
Default=Val; You can also set a default within that range.

String Type=String; Enables entry of a string value, up to 255 characters in

Default=Val; length, and a default text string.
For longer texts, use Type=Memo 1167 .

URL Type=URL; Enables entry of a web URL. The URL should start
Default=Val; with:
· 'http://'
· 'https://' or
· 'www.'.
You can set a default URL as a string value.

Tag Filters
The following table details filters that can be used to restrict where a Tagged Value can be applied.

© 1998-2010 Sparx Systems Pty Ltd

 1168 Modeling Languages | Build Your Own Modeling Language

Filter Format Description

AppliesTo AppliesTo=Type1, Restricts the element types this filter can be applied to,
Type2; where Type1 and Type2 are the valid types.
Possible values are:
· all element types
· all connector types
· Attribute
· Operation and
· OperationParameter.
BaseStereotype BaseStereotype=S1,S2; Restricts the stereotypes that this tag belongs to,
where S1 and S2 are the allowed stereotypes.

5.3.1.4.2 Create Structured Tagged Values

To create your own Tagged Value based on a predefined structured Tagged Value Type 1166 , follow the steps
below:
1. Select the Settings | UML menu option. The UML Types dialog displays. Select the Tagged Value
Types tab.

2. Click on the New button.

3. In the Tag Name field type an appropriate Tagged Value name.
4. In the Description field type the purpose of the Tagged Value, if required.
5. In the Detail field copy-and-paste or type the syntax of the predefined structured Tagged Value Type.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1169

In the example above (which is used in the definition of a field to enable a user to set a sports handicap)
the predefined type is Spin, with the Upper and Lower Bounds set for the field values. (Spin is the
Microsoft term for selection arrows in a variable field - the user clicks on the arrows to increase or
decrease the value between the upper and lower bound limits.)
6. Click on the Save button.
The Tagged Value type displays in the Defined Tag Types list.

5.3.1.4.3 Predefined Reference Data Types

This table details the predefined Reference Data Tagged Value types that are used to return the values held in
a relevant table in Enterprise Architect, along with the syntax required for their use. You use these to create
your own Reference Data Tagged Values 1170 .

Tagged Value Format Drop-Down List Returned

Type

Authors Type=Enum; Authors that have been defined for the Enterprise Architect
List=Authors; model.

Cardinality Type=Enum; Cardinality types that have been defined for the Enterprise
List=Cardinality; Architect model.

Clients Type=Enum; Clients that have been defined for the Enterprise Architect
List=Clients; model.

ComplexityTypes Type=Enum; Complexity types that have been defined for the Enterprise
List=ComplexityTypes; Architect model.
Whilst complexity types can be exported and imported as
project reference data 644 , they cannot be updated and so
are effectively standard across all projects.

ConstraintTypes Type=Enum; Constraint types that have been defined for the Enterprise
List=ConstraintTypes; Architect model.

EffortTypes Type=Enum; Effort types that have been defined for the Enterprise
List=EffortTypes; Architect model.

MaintenanceType Type=Enum; Maintenance types that have been defined for the
s List=MaintenanceTypes Enterprise Architect model.
;

ObjectTypes Type=Enum; Object types that have been defined for the Enterprise
List=ObjectTypes; Architect model.

Phases Type=Enum; Phases that have been defined for the Enterprise Architect
List=Phases; model.

ProblemTypes Type=Enum; Problem types that have been defined for the Enterprise
List=ProblemTypes; Architect model.

RoleTypes Type=Enum; Role types that have been defined for the Enterprise
List=RoleTypes; Architect model.

RequirementType Type=Enum; Requirement types that have been defined for the
s List=RequirementTypes Enterprise Architect model.
;

Resources Type=Enum; Resources that have been defined for the Enterprise
List=Resources; Architect model.

RiskTypes Type=Enum; Risk types that have been defined for the Enterprise
List=RiskTypes; Architect model.

© 1998-2010 Sparx Systems Pty Ltd

 1170 Modeling Languages | Build Your Own Modeling Language

Tagged Value Format Drop-Down List Returned

Type

RTFTemplates Type=Enum; RTF Templates that have been defined for the Enterprise
List=RTFTemplates; Architect model.

ScenarioTypes Type=Enum; Scenario types that have been defined for the Enterprise
List=ScenarioTypes; Architect model.

TestTypes Type=Enum; Test types that have been defined for the Enterprise
List=TestTypes; Architect model.

5.3.1.4.4 Create Reference Data Tagged Values

To create your own Tagged Value based on a predefined Reference Data Tagged Value Type 1169 , follow the
steps below:
1. Select the Settings | UML menu option. The UML Types dialog displays; select the Tagged Value
Types tab.

2. In the Tag field type an appropriate Tagged Value name.

3. In the Description field type a description of the purpose of the Tagged Value, if required.
4. In the Detail field copy-and-paste or type the syntax of the predefined Reference Data Tagged Value
Type. In the example above, the Tagged Value returns the values for all of the Authors in the Enterprise
Architect model.

This enables you to assign any of the previously defined Authors to a model feature (model features
that can have Tagged Values applied to them are detailed in the Model Elements and Features with
Tagged Values 633 topic.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1171

Note:
If the values in the reference data are changed after the Tagged Value Type is created, Enterprise Architect
must be reloaded in order to reflect the changes in the Tagged Value Type.

5.3.1.4.5 Create Custom Tagged Value Type

Custom masked Tagged Values give you great flexibility in designing model components that accept data
entries.
To create a masked Tagged Value follow the steps below:
1. Select the Settings | UML menu option. The UML Types dialog displays; select the Tagged Value
Types tab.
2. In the Tag field type an appropriate name for the Tagged Value.
3. In the Description field type the purpose of the Tagged Value, if required.
4. In the Detail field type Type=Custom;
The type Custom enables you to set up the appropriate mask, using the following characters to define the
format of the mask:

Mask Description

D Enables the Tagged Value to display digits only.

d Enables the Tagged Value to display digits or spaces.

+ Enables the use of +, - or spaces.

C Enables the use of alpha characters only.

c Enables the Tagged Value to be an alpha character or a space.

A Enables the use of alphanumeric characters.

a Enables the Tagged Value to use alphanumeric values or a space.

In the diagram below the Mask configuration option shows syntax that first defines seven blank spaces, which
are occupied by characters determined by the template option. The first two visible characters in the Mask
option are represented by a lower case c indicating that the enableable information can entered as either an
alpha character or as a space. The following blank spaces again indicate space defined by the template option
and the remaining characters are defined by the d character, which represents the enableable characters as
digits or spaces. The hyphen is present in the final output, splitting up the digits.
With the Template configuration option, the syntax defines the template of the masked option by occupying
the blank spaces that are present in the Mask option. The template is used to ensure that this information is

© 1998-2010 Sparx Systems Pty Ltd

 1172 Modeling Languages | Build Your Own Modeling Language

present with every use of this custom Tagged Value. The underscored values indicate the area that is to be
occupied by data input by the user as defined in the Mask option.

5.3.1.5 Code Template Framework

The Code Template Framework (CTF) is used during forward engineering of UML models. This section
discusses how you customize the way in which Enterprise Architect generates source code, using the Code
Template Editor. 1202
Enterprise Architect's code templates specify the transformation from UML elements to the various parts of a
given programming language. The templates are written as plain text with a syntax 1172 that shares some
aspects of both mark-up languages and scripting languages. The Base Templates provided in Enterprise
Architect are described in the Base Templates 1302 topic.

5.3.1.5.1 Code Template Syntax

Code Templates are written as plain text, using Enterprise Architect's code template editor (see The Code
Template Editor 1202 ). The template syntax centers on three basic constructs:
· Literal Text 1172
· Macros 1173
· Variables 1200
Templates can contain any or all of these constructs.

5.3.1.5.1.1 Literal Text

All text within a given template that is not part of a macro or a variable definition/reference, is considered literal
text. With the exception of blank lines, which are ignored, literal text is directly substituted from the template
into the generated code.
Consider the following excerpt from the java Class Declaration template:
%PI=" "%
%CONVERT_SCOPE(classScope)%

%classStereotype=="static" ? "static": ""%

%classStereotype=="final" ? "final": ""%
%classStereotype=="static final" ? "static final": ""%
%classAbstract=="T" ? "abstract": ""%
%PI=""%
class %className%$bases

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1173

On the final line, the word class, including the subsequent space, would be treated as literal text and thus
reproduced in the output. The blank line following the CONVERT_SCOPE macro, however, would have no
effect on the output.
The %, $ and " characters have special meaning in the template syntax and cannot always be used as literal
text. If these characters must be generated from within the templates, they can be safely reproduced using the
following direct substitution macros:

Macro Use to

%dl% Produce a literal $ character.

%pc% Produce a literal % character.

%qt% Produce a literal " character.

5.3.1.5.1.2 Macros
Macros provide access to element fields within the UML model and are also used to structure the generated
output. All macros are enclosed within percent (%) signs. The CTF contains six basic types of macros:
· Template substitution macros 1173
· Field substitution macros 1174
· Tagged Value substitution macros 1186

· Control macros 1190

· Function macros 1187
· EASL code generation macros 1193
In general, macros (including the % delimiters) are substituted with literal text in the output. For example
consider the following item from the Class Declaration template:
... class %className% ...
The field substitution macro, %className%, would result in the current Class name being substituted in the
output. So if the Class being generated was named Foo, the output would be:
... class Foo ...

Template substitution macros correspond to Base templates 1302 . These macros result in the execution of the
named template. By convention, template macros are named according to Pascal casing.
Structure: %<TemplateName>%
where <TemplateName> can be one of the templates listed below.
When a template is referenced from within another template, it is generated with respect to the elements
currently in scope. The specific template is selected based on the stereotypes of the elements in scope.
As noted previously, there is an implicit hierarchy among the various templates. Some care should be taken in
order to preserve a sensible hierarchy of template references. For example, it does not make sense to use
the %ClassInherits% macro within any of the attribute or operation templates. Conversely, the Operation and
Attribute templates are designed for use within the ClassBody template.
The CTF contains the following template substitution macros:

· AttributeDeclaration · ClassParameter · NamespaceBody

· AttributeNotes · File · NamespaceDeclaration
· Attribute · FileImpl · NamespaceImpl
· Class · ImportSection · Operation
· ClassImpl · ImportSectionImpl · OperationBody
· ClassBase · InnerClass · OperationBodyImpl
· ClassBody · InnerClassImpl · OperationDeclaration
· ClassBodyImpl · LinkedAttribute · OperationDeclarationImpl

© 1998-2010 Sparx Systems Pty Ltd

 1174 Modeling Languages | Build Your Own Modeling Language

· ClassDeclaration · LinkedAttributeNotes · OperationImpl

· ClassDeclarationImpl · LinkedAttributeDeclaration · OperationNotes
· ClassInherits · LinkedClassBase · Parameter
· ClassInterface · LinkedClassInterface
· ClassNotes · Namespace

The field substitution macros provide access to data in the model. In particular, they are used to access data
fields from:
· Packages
· Classes
· Attributes
· Operations
· Parameters.
Field substitution macros are named according to Camel casing. By convention, the macro is prefixed with an
abbreviated form of the corresponding model element. For example, attribute-related macros begin with att, as
in the %attName% macro, to access the name of the attribute in scope.
The following table lists each of the field substitution macros with a description of the result.

Note:
Macros that represent checkboxes return a value of T if the box is selected. Otherwise the value is empty.

Macro Name Description

attAlias Attributes dialog: Alias.

attAllowDuplicates Attributes Detail dialog: Allow Duplicates checkbox.

attClassifierGUID The unique GUID for the classifier of the current attribute.

attCollection Attributes Detail dialog: Attribute is a Collection checkbox.

attConst Attributes dialog: Const checkbox.

attContainerType Attributes Detail dialog: Container Type.

attContainment Attributes dialog: Containment.

attDerived Attributes dialog: Derived checkbox.

attGUID The unique GUID for the current attribute.

attInitial Attributes dialog: Initial.

attIsEnumLiteral Attributes dialog: Is Literal checkbox.

attLength Column dialog: Length.

attLowerBound Attributes Detail dialog: Lower Bound.

attName Attributes dialog: Name.

attNotes Attributes dialog: Notes.

attOrderedMultiplicity Attributes Detail dialog: Ordered Multiplicity checkbox.

attProperty Attributes dialog: Property checkbox.

attQualType The attribute type qualified by the namespace path (if generating
namespaces) and the classifier path (dot delimited). If the attribute

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1175

Macro Name Description

classifier has not been set, is equivalent to the attType macro.

attScope Attributes dialog: Scope.

attStatic Attributes dialog: Static checkbox.

attStereotype Attributes dialog: Stereotype.

attType Attributes dialog: Type.

attUpperBound Attributes Detail dialog: Upper Bound.

attVolatile Attributes Detail dialog: Transient checkbox.

classAbstract Class dialog: Abstract checkbox.

classAlias Class dialog: Alias.

classArguments Class Detail dialog: C++ Templates: Arguments.

classAuthor Class dialog: Author.

classBaseName Type Hierarchy dialog: Class Name (for use where no connector exists
between child and base Classes).

classBaseScope The scope of the inheritance as reverse engineered. (For use where no
connector exists between child and base Classes.)

classBaseVirtual The virtual property of the inheritance as reverse engineered. (For use
where no connector exists between child and base Classes.)

classComplexity Class dialog: Complexity.

classCreated The date and time the Class was created.

classGUID The unique GUID for the current Class.

classHasConstructor Looks at the list of methods in the current object and, depending on the
conventions of the current language, returns T if one is a default
constructor. Typically used with the genOptGenConstructor 1180 macro.

classHasCopyConstructor Looks at the list of methods in the current object and, depending on the
conventions of the current language, returns T if one is a copy
constructor. Typically used with the genOptGenCopyConstructor 1180
macro.

classHasDestructor Looks at the list of methods in the current object and, depending on the
conventions of the current language, returns T if one is a destructor.
Typically used with the genOptGenDestructor 1180 macro.

classHasParent True, if the Class in scope has one or more base Classes.

classImports Code Gen dialog: Imports.

classIsActive Class Advanced dialog: Is Active checkbox.

classIsInstantiated True, if the Class is an instantiated template Class.

classIsLeaf Class Advanced dialog: Is Leaf checkbox.

classIsRoot Class Advanced dialog: Is Root checkbox.

classIsSpecification Class Advanced dialog: Is Specification checkbox.

© 1998-2010 Sparx Systems Pty Ltd

 1176 Modeling Languages | Build Your Own Modeling Language

Macro Name Description

classKeywords Class dialog: Keywords.

classLanguage Class dialog: Language.

classMacros A space separated list of macros defined for the Class.

classModified The date and time the Class was last modified.

classMultiplicity Class Advanced dialog: Multiplicity.

className Class dialog: Name.

classNotes Class dialog: Note.

classParamDefault Class Detail dialog.

classParamName Class Detail dialog.

classParamType Class Detail dialog.

classPersistence Class dialog: Persistence.

classPhase Class dialog: Phase.

classQualName The Class name prefixed by its outer Classes. Class names are
separated by double colons (::).

classScope Class dialog: Scope.

classStereotype Class dialog: Stereotype.

classStatus Class dialog: Status.

classVersion Class dialog: Version.

connectorAlias Connector Properties dialog: Alias.

connectorDestAccess Connector Properties dialog, Target Role tab: Access.

connectorDestAggregation Connector Properties dialog, Target Role tab: Aggregation.

connectorDestAlias Connector Properties dialog, Target Role tab: Alias.

connectorDestAllowDuplicates Connector Properties dialog, Target Role tab: Allow Duplicates

checkbox.

connectorDestChangeable Connector Properties dialog, Target Role tab: Changeable.

connectorDestConstraint Connector Properties dialog, Target Role tab: Constraint(s).

connectorDestContainment Connector Properties dialog, Target Role tab: Containment.

connectorDestDerived Connector Properties dialog, Target Role tab: Derived checkbox.

connectorDestDerivedUnion Connector Properties dialog, Target Role tab: DerivedUnion checkbox.

connectorDestElem* A set of macros that access a property of the element at the target end
of a connector. The * (asterisk) is a wildcard that corresponds to any
class substitution macro in this list; for example:
connectorDestElemAlias (classAlias), connectorDestElemAuthor (
classAuthor).

connectorDestElemType The element type of the connector destination element. (Separate from
the connectorDestElem* macros because there is no classType

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1177

Macro Name Description

substitution macro.)

connectorDestMemberType Connector Properties dialog, Target Role tab: Member Type.

connectorDestMultiplicity Connector Properties dialog, Target Role tab: Multiplicity.

connectorDestNavigability Connector Properties dialog, Target Role tab: Navigability.

connectorDestNotes Connector Properties dialog, Target Role tab: Role Notes.

connectorDestOrdered Connector Properties dialog, Target Role tab: Ordered checkbox.

connectorDestOwned Connector Properties dialog, Target Role tab: Owned checkbox.

connectorDestQualifier Connector Properties dialog, Target Role tab: Qualifier(s).

connectorDestRole Connector Properties dialog, Target Role tab: Role.

connectorDestScope Connector Properties dialog, Target Role tab: Target Scope.

connectorDestStereotype Connector Properties dialog, Target Role tab: Stereotype.

connectorDirection Connector Properties: Direction.

connectorEffect Transition Constraints dialog: Effect.

connectorGuard Object Flow and Transition Constraints dialog: Guard.

connectorGUID The unique GUID for the current connector.

connectorName Connector Properties: Name.

connectorNotes Connector Properties: Notes.

connectorSourceAccess Connector Properties dialog, Source Role tab: Access.

connectorSourceAggregation Connector Properties dialog, Source Role tab: Aggregation.

connectorSourceAlias Connector Properties dialog, Source Role tab: Alias.

connectorSourceAllowDuplicates Connector Properties dialog, Source Role tab: Allow Duplicates

checkbox.

connectorSourceChangeable Connector Properties dialog, Source Role tab: Changeable.

connectorSourceConstraint Connector Properties dialog, Source Role tab: Constraint(s).

connectorSourceContainment Connector Properties dialog, Source Role tab: Containment.

connectorSourceDerived Connector Properties dialog, Source Role tab: Derived checkbox.

connectorSourceDerivedUnion Connector Properties dialog, Source Role tab: DerivedUnion

checkbox.

connectorSourceElem* A set of macros that access a property of the element at the source end
of a connector. The * (asterisk) is a wildcard that corresponds to any
class substitution macro in this list; for example:
connectorSourceElemAlias (classAlias), connectorSourceElemAuthor (
classAuthor).

connectorSourceElemType The element type of the connector source element. (Separate from the
connectorSourceElem* macros because there is no classType
substitution macro.)

© 1998-2010 Sparx Systems Pty Ltd

 1178 Modeling Languages | Build Your Own Modeling Language

Macro Name Description

connectorSourceMemberType Connector Properties dialog, Source Role tab: Member Type.

connectorSourceMultiplicity Connector Properties dialog, Source Role tab: Multiplicity.

connectorSourceNavigability Connector Properties dialog, Source Role tab: Navigability.

connectorSourceNotes Connector Properties dialog, Source Role tab: Role Notes.

connectorSourceOrdered Connector Properties dialog, Source Role tab: Ordered checkbox.

connectorSourceOwned Connector Properties dialog, Source Role tab: Owned checkbox.

connectorSourceQualifier Connector Properties dialog, Source Role tab: Qualifier(s).

connectorSourceRole Connector Properties dialog, Source Role tab: Role.

connectorSourceScope Connector Properties dialog, Source Role tab: Target Scope.

connectorSourceStereotype Connector Properties dialog, Source Role tab: Stereotype.

connectorStereotype Connector Properties dialog: Stereotype.

connectorTrigger Transition Constraints dialog: Trigger.

connectorType The connector type; for example, Association or Generalization.

connectorWeight Object Flow Constraints dialog: Weight.

constraintName Class dialog, Constraints tab: Name.

constraintNotes Class dialog, Constraints tab: Notes.

constraintStatus Class dialog, Constraints tab: Status.

constraintType Class dialog, Constraints tab: Type.

constraintWeight Class dialog, Constraints tab: ordering (hand up/down) keys.

eaDateTime The current time with format: DD-MMM-YYYY HH:MM:SS AM/PM.

eaGUID A unique GUID for this generation.

eaVersion Program Version (Located in an Enterprise Architect dialog by

selecting Help | About EA.).

effortName Project Management window: Effort.

effortNotes Project Management window: Notes (unlabelled).

effortTime Project Management window: Time.

effortType Project Management window: Type.

elemType The element type: Interface or Class.

fileExtension The file type extension of the file being generated.

fileName The name of the file being generated.

fileNameImpl The filename of the implementation file for this generation, if applicable.

fileHeaders Code Gen dialog: Headers.

fileImports Code Gen dialog: Imports. For supported languages this also includes

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1179

Macro Name Description

dependencies derived from associations.

filePath The full path of the file being generated.

filePathImpl The full path of the implementation file for this generation, if applicable.

genOptActionScriptVersion ActionScript Specifications dialog: Default Version.

genOptCDefaultAttributeType C Specifications dialog: Default Attribute Type.

genOptCGenMethodNotesInBody C Specifications dialog: Method Notes In Implementation.

genOptCGenMethodNotesInHead C Specifications dialog: Method Notes In Header.

er

genOptCSynchNotes C Specifications dialog: Synchronize Notes in Generation.

genOptCSynchCFile C Specifications dialog: Synchronise Implementation file in

Generation.

genOptCDefaultSourceDirectory C Specifications dialog: Default Source Directory.

genOptCNamespaceDelimiter C Specifications dialog: Namespace Delimiter.

genOptCOperationRefParam C Specifications dialog: Reference as Operation Parameter.

genOptCOperationRefParamStyle C Specifications dialog: Reference Parameter Style.

genOptCOperationRefParamNam C Specifications dialog: Reference Parameter Name.

e

genOptCConstructorName C Specifications dialog: Default Constructor Name.

genOptCDestructorName C Specifications dialog: Default Destructor Name.

genOptCPPCommentStyle C++ Specifications dialog: Comment Style.

genOptCPPDefaultAttributeType C++ Specifications dialog: Default Attribute Type.

genOptCPPDefaultReferenceType C++ Specifications dialog: Default Reference Type.

genOptCPPDefaultSourceDirector C++ Specifications dialog: Default Source Directory.

y

genOptCPPGenMethodNotesInHe C++ Specifications dialog: Method Notes In Header checkbox.

ader

genOptCPPGenMethodNotesInBo C++ Specifications dialog: Method Notes In Body checkbox.

dy

genOptCPPGetPrefix C++ Specifications dialog: Get Prefix.

genOptCPPHeaderExtension C++ Specifications dialog: Header Extension.

genOptCPPSetPrefix C++ Specifications dialog: Set Prefix.

genOptCPPSourceExtension C++ Specifications dialog: Source Extension.

genOptCPPSynchCPPFile C++ Specifications dialog: Synchronize Notes.

genOptCPPSynchNotes C++ Specifications dialog: Synchronize CPP File.

genOptCSDefaultAttributeType C# Specifications dialog: Default Attribute Type.

© 1998-2010 Sparx Systems Pty Ltd

 1180 Modeling Languages | Build Your Own Modeling Language

Macro Name Description

genOptCSSourceExtension C# Specifications dialog: Default file extension.

genOptCSGenDispose C# Specifications dialog: Generate Dispose.

genOptCSGenFinalizer C# Specifications dialog: Generate Finalizer.

genOptCSGenNamespace C# Specifications dialog: Generate Namespace.

genOptCSDefaultSourceDirectory C# Specifications dialog: Default Source Directory.

genOptDefaultAssocAttName Attribute Specifications dialog: Default name for associated attrib.

genOptDefaultConstructorScope Object Lifetimes dialog: Default Constructor Visibility.

genOptDefaultCopyConstructorSc Object Lifetimes dialog: Default Copy Constructor Visibility.

ope

genOptDefaultDatabase Code Editors dialog: Default Database.

genOptDefaultDestructorScope Object Lifetimes dialog: Default Destructor Constructor Visibility.

genOptGenCapitalisedProperties Source Code Engineering dialog: Capitalize Attribute Names for

Properties checkbox.

genOptGenComments Source Code Engineering dialog: Generate Comments checkbox.

genOptGenConstructor Object Lifetimes dialog: Generate Constructor checkbox.

genOptGenConstructorInline Object Lifetimes dialog: Constructor Inline checkbox.

genOptGenCopyConstructor Object Lifetimes dialog: Generate Copy Constructor checkbox.

genOptGenCopyConstructorInline Object Lifetimes dialog: Copy Constructor Inline checkbox.

genOptGenDestructor Object Lifetimes dialog: Generate Destructor checkbox.

genOptGenDestructorInline Object Lifetimes dialog: Destructor Inline checkbox.

genOptGenDestructorVirtual Object Lifetimes dialog: Virtual Destructor checkbox.

genOptGenImplementedInterface Attribute/Operations Specifications dialog: Generate methods for

Ops implemented interfaces checkbox.

genOptGenPrefixBoolProperties Source Code Engineering dialog: Use is prefix for boolean property
Get().

genOptGenRoleNames Source Code Engineering dialog: Autogenerate role names when

creating code.

genOptGenUnspecAssocDir Source Code Engineering dialog: Do not generate members where

Association direction is unspecified checkbox.

genOptJavaDefaultAttributeType Java Specifications dialog: Default attribute type.

genOptJavaGetPrefix Java Specifications dialog: Get Prefix.

genOptJavaDefaultSourceDirector Java Specifications dialog: Default Source Directory.

y

genOptJavaSetPrefix Java Specifications dialog: Set Prefix.

genOptJavaSourceExtension Java Specifications dialog: Source code extension.

genOptPHPDefaultSourceDirector PHP Specifications dialog: Default Source Directory.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1181

Macro Name Description

genOptPHPGetPrefix PHP Specifications dialog: Get Prefix.

genOptPHPSetPrefix PHP Specifications dialog: Set Prefix.

genOptPHPSourceExtension PHP Specifications dialog: Default file extension.

genOptPHPVersion PHP Specifications dialog: PHP Version.

genOptPropertyPrefix Source Code Engineering dialog: Remove prefixes when generating

Get/Set properties.

genOptVBMultiUse VB Specifications dialog: Multiuse checkbox.

genOptVBPersistable VB Specifications dialog: Persistable checkbox.

genOptVBDataBindingBehavior VB Specifications dialog: Data binding behavior checkbox.

genOptVBDataSourceBehavior VB Specifications dialog: Data source behavior checkbox.

genOptVBGlobal VB Specifications dialog: Global namespace checkbox.

genOptVBCreatable VB Specifications dialog: Creatable checkbox.

genOptVBExposed VB Specifications dialog: Exposed checkbox.

genOptVBMTS VB Specifications dialog: MTS Transaction Mode.

genOptVBNetGenNamespace VB.Net Specifications dialog: Generate Namespace.

genOptVBVersion VB Specifications dialog: Default Version.

genOptWrapComment Source Code Engineering dialog: Wrap length for comment lines.

importClassName The name of the Class being imported.

importFileName The filename of the Class being imported.

importFilePath The full path of the Class being imported.

importFromAggregation T if the Class has an Aggregation connector to a Class in this file, F

otherwise.

importFromAssociation T if the Class has an Association connector to a Class in this file, F

otherwise.

importFromAtt T if an attribute of a Class in the current file is of the type of this Class,
F otherwise.

importFromDependency T if the Class has a Dependency connector to a Class in this file, F

otherwise.

importFromGeneralization T if the Class has a Generalization connector to a Class in this file, F

otherwise.

importFromMeth T if a method return type of a Class in the current file is the type of this
Class, Fotherwise.

importFromParam T if an method parameter of a Class in the current file is of the type of

this Class, Fotherwise.

importFromRealization T if the Class has a Realization connector to a Class in this file, F

otherwise.

© 1998-2010 Sparx Systems Pty Ltd

 1182 Modeling Languages | Build Your Own Modeling Language

Macro Name Description

importInFile T if the Class is in the current file, F otherwise.

importPackagePath The package path with a '.' separator of the Class being imported.

ImportRelativeFilePath The relative file path of the Class being imported from the file path of
the file being generated.

linkAttAccess Association Properties Target Role dialog: Access.

linkAttCollectionClass The collection appropriate for the linked attribute in scope.

linkAttContainment Association Properties Target Role dialog: Containment.

linkAttName Association Properties dialog: Target.

linkAttNotes Association Properties Target Role dialog: Role Notes.

linkAttQualName The Association target qualified by the namespace path (if generating
namespaces) and the classifier path (dot delimited).

linkAttRole Association Properties Target Role dialog: Role.

linkAttStereotype Association Properties Target Role dialog: Stereotype.

linkAttTargetScope Association Properties Target Role dialog: Target Scope.

linkCard Link Properties Target Role dialog: Multiplicity.

linkedFileLastWrite Class Properties dialog: Last Write.

linkedFileNotes Class Properties dialog: Notes.

linkedFilePath Class Properties dialog: File Path.

linkedFileSize Class Properties dialog: Size.

linkedFileType Class Properties dialog: Type.

linkGUID The unique GUID for the current connector.

linkParentName Generalization Properties dialog: Target.

linkParentQualName The Generalization target qualified by the namespace path (if

generating namespaces) and the classifier path (dot delimited).

linkStereotype The stereotype of the current connector.

linkVirtualInheritance Generalization Properties dialog: Virtual Inheritance.

metricName Project Management dialog, Metrics tab: Metric field.

metricNotes Project Management dialog, Metrics tab: (Notes) field.

metricType Project Management dialog, Metrics tab: Type field.

metricWeight Project Management dialog, Metrics tab: Weight field.

opAbstract Operation dialog: Virtual checkbox.

opAlias Operation dialog: Alias.

opBehavior Operation Behavior dialog: Behavior.

opCode Operation Behavior dialog: Initial Code.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1183

Macro Name Description

opConcurrency Operation dialog: Concurrency.

opConst Operation dialog: Const checkbox.

opGUID The unique GUID for the current operation.

opImplMacros A space-separated list of macros defined in the implementation of this

operation.

opIsQuery Operation dialog: IsQuery checkbox.

opMacros A space-separated list of macros defined in the declaration for this

operation.

opName Operation dialog: Name.

opNotes Operation dialog: Notes.

opPure Operation dialog: Pure checkbox.

opReturnArray Operation dialog: Return Array checkbox.

opReturnClassifierGUID The unique GUID for the classifier of the current operation.

opReturnQualType The operation return type qualified by the namespace path (if
generating namespaces) and the classifier path (dot delimited). If the
return type classifier has not been set, is equivalent to the
opReturnType macro.

opReturnType Operation dialog: Return Type.

opScope Operation dialog: Scope.

opStatic Operation dialog: Static checkbox.

opStereotype Operation dialog: Stereotype.

opSynchronized Operation dialog: Synchronized checkbox.

packageAbstract Package dialog: Abstract.

packageAlias Package dialog: Alias.

packageAuthor Package dialog: Author.

packageComplexity Package dialog: Complexity.

packageGUID The unique GUID for the current package.

packageKeywords Package dialog: Keywords.

packageLanguage Package dialog: Language.

packageName Package dialog: Name.

packagePath The string representing the hierarchy of packages, for the Class in
scope. Each package name is separated by a dot (.).

packagePhase Package dialog: Phase.

packageScope Package dialog: Scope.

packageStatus Package dialog: Status.

© 1998-2010 Sparx Systems Pty Ltd

 1184 Modeling Languages | Build Your Own Modeling Language

Macro Name Description

packageStereotype Package dialog: Stereotype.

packageVersion Package dialog: Version.

paramClassifierGUID The unique GUID for the classifier of the current parameter.

paramDefault Operation Parameters dialog: Default.

paramFixed Operation Parameters dialog: Fixed checkbox.

paramGUID The unique GUID for the current parameter.

paramIsEnum True, if the parameter uses the enum keyword (C++).

paramKind Operation Parameters dialog: Kind.

paramName Operation Parameters dialog: Name.

paramNotes Operation Parameters dialog: Notes.

paramQualType The parameter type qualified by the namespace path (if generating
namespaces) and the classifier path (dot delimited). If the parameter
classifier has not been set, is equivalent to the paramType macro.

paramType Operation Parameters dialog: Type.

problemCompletedBy Maintenance dialog, Element Issues tab: Completed by.

problemCompletedDate Maintenance dialog, Element Issues tab: Completed.

problemHistory Maintenance dialog, Element Issues tab: History.

problemName Maintenance dialog, Element Issues tab: Name.

problemNotes Maintenance dialog, Element Issues tab: Description.

problemPriority Maintenance dialog, Element Issues tab: Priority.

problemRaisedBy Maintenance dialog, Element Issues tab: Raised by.

problemRaisedDate Maintenance dialog, Element Issues tab: Raised.

problemStatus Maintenance dialog, Element Issues tab: Status.

problemVersion Maintenance dialog, Element Issues tab: Version.

requirementDifficulty Properties dialog: Require tab: Difficulty.

requirementLastUpdated Properties dialog: Require tab: Last Update.

requirementName Properties dialog: Require tab: Short Description.

requirementNotes Properties dialog: Require tab: Notes.

requirementPriority Properties dialog: Require tab: Priority.

requirementStatus Properties dialog: Require tab: Status.

requirementType Properties dialog: Require tab: Type.

resourceAllocatedTime Project Management window, Resource Allocation tab: Allocated Time.

resourceEndDate Project Management window, Resource Allocation tab: End Date.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1185

Macro Name Description

resourceExpectedTime Project Management window, Resource Allocation tab: Expected Time.

resourceExpendedTime Project Management window, Resource Allocation tab: Time Expended

.

resourceHistory Project Management window, Resource Allocation tab: History.

resourceName Project Management window, Resource Allocation tab: Resource.

resourceNotes Project Management window, Resource Allocation tab: Description.

resourcePercentCompleted Project Management window, Resource Allocation tab: Completed(%).

resourceRole Project Management window, Resource Allocation tab: Role.

resourceStartDate Project Management window, Resource Allocation tab: Start Date.

riskName Project Management window, Risks tab: Risk.

riskNotes Project Management window, Risks tab: (Notes).

riskType Project Management window, Risks tab: Type.

riskWeight Project Management window, Risks tab: Weight.

scenarioGUID The unique ID for a scenario. Identifies the scenario unambiguously

within a model.

scenarioName Properties dialog, Scenario tab: Scenario.

scenarioNotes Properties dialog, Scenario tab: (Notes).

scenarioType Properties dialog, Scenario tab: Type.

testAcceptanceCriteria Testing window: Acceptance Criteria.

testCheckedBy Testing window: Checked By.

testDateRun Testing window: Last Run.

testClass The Testing window tab (the type of test defined): Unit, Integration,
System, Acceptance, Scenario.

testInput Testing window: Input.

testName Testing window: Test.

testNotes Testing window: Description.

testResults Testing window: Results.

testRunBy Testing window: Run By.

testStatus Testing window: Status.

testType Testing window: Type.

Field substitution macros can be used in one of two ways:

Use 1: Direct Substitution

This form directly substitutes the corresponding value of the element in scope into the output.

© 1998-2010 Sparx Systems Pty Ltd

 1186 Modeling Languages | Build Your Own Modeling Language

Structure: %<macroName>%

Where <macroName> can be any of the macros listed above.

Examples:
· %className%
· %opName%
· %attName%

Use 2: Conditional Substitution

This form of the macro enables alternative substitutions to be made depending on the macro's value.

Structure: %<macroName> [ == "<test>"] ? <subTrue> [ : <subFalse> ]%

Where:
· [ <text> ] denotes that <text> is optional
· <test> is a string representing a possible value for the macro
· <subTrue> and <subFalse> can be a combination of quoted strings and the keyword value; where the value is
used, it is replaced with the macro's value in the output.

Examples:
· %classAbstract=="T" ? "pure" : ""%
· %opStereotype=="operator" ? "operator" : ""%
· %paramDefault != "" ? " = " value : ""%
The above three examples output nothing if the condition fails. In this case the false condition can be omitted,
resulting in the following usage:

Examples:
· %classAbstract=="T" ? "pure"%
· %opStereotype=="operator" ? "operator"%
· %paramDefault != "" ? " = " value%
The third example of both blocks shows a comparison checking for a non-empty value or existence. This test
can also be omitted.
· %paramDefault ? " = " value : ""%
· %paramDefault ? " = " value%
All of the above examples containing paramDefault are equivalent. If the parameter in scope had a default
value of 10, the output from each of them would normally be:
= 10

Note:
In a conditional substitution macro, any white space following <macroName> is ignored. If white space is
required in the output, it should be included within the quoted substitution strings.

Tagged Value macros are a special form of field substitution macros, which provide access to element tags
and the corresponding Tagged Values.

Use 1: Direct Substitution

This form of the macro directly substitutes the value of the named tag into the output.
Structure: %<macroName>:"<tagName>"%
<macroName> can be one of:
· attTag
· classTag
· connectorDestElemTag
· connectorDestTag
Enterprise Architect User Guide
 Modeling Languages | Build Your Own Modeling Language 1187

· connectorSourceElemTag
· connectorSourceTag
· connectorTag
· linkAttTag
· linkTag
· opTag
· packageTag
· paramTag
This corresponds to the tags for attributes, Classes, operations, packages, parameters, connectors with both
ends, elements at both ends of connectors and connectors including the attribute end.
<tagName> is a string representing the specific tag name.

Examples:
%opTag:"attribute"%

Use 2: Conditional Substitution

This form of the macro mimics the conditional substitution defined for field substitution macros.
Structure: %<macroName>:"<tagName>" [ == "<test>"] ? <subTrue> [ : <subFalse> ]%
Where:
· <macroName> and <tagName> are as defined above
· [ <text> ] denotes that <text> is optional
· <test> is a string representing a possible value for the macro
· <subTrue> and <subFalse> can be a combination of quoted strings and the keyword value. Where the
value is used, it gets replaced with the macro's value in the output.

Examples:
%opTag:"opInline" ? "inline" : ""%
%opTag:"opInline" ? "inline"%
%classTag:"unsafe" == "true" ? "unsafe" : ""%
%classTag:"unsafe" == "true" ? "unsafe"%
Tagged Value macros use the same naming convention as field substitution macros.

Function macros are a convenient way of manipulating and formatting various element data. Each function
macro returns a result string. There are two primary ways to use the results of function macros:
· Direct substitution of the returned string into the output, such as: %TO_LOWER(attName)%
· Storing the returned string as part of a variable definition such as: $name = %TO_LOWER(attName)%
Function macros can take parameters, which can be passed to the macros as:
· String literals, enclosed within double quotation marks
· Direct substitution macros without the enclosing percent signs
· Variable references
· Numeric literals.
Multiple parameters are passed using a comma-separated list.
The available function macros are described below. Parameters are denoted by angle brackets, as in:
FUNCTION_NAME(<param>).

Note:
Function macros are named according to the All-Caps style, as in: %CONVERT_SCOPE(opScope)%

CONVERT_SCOPE(<umlScope>)
For use with supported languages. Converts <umlScope> to the appropriate scope keyword for the language
being generated. The following table shows the conversion of <umlScope> with respect to the given language.

© 1998-2010 Sparx Systems Pty Ltd

 1188 Modeling Languages | Build Your Own Modeling Language

Language Package Public Private Protected

C++ public public private protected

C# internal public private protected

Delphi protected public private protected

Java public private protected

PHP public public private protected

VB Protected Public Private Protected

VB .Net Friend Public Private Protected

COLLECTION_CLASS(<language>)
Gives the appropriate collection Class for the language specified for the current linked attribute.

CSTYLE_COMMENT(<wrap_length>)
Converts the notes for the element currently in scope to plain C-style comments, using /* and */.

DELPHI_PROPERTIES(<scope>, <separator>, <indent>)

Generates a Delphi property.

DELPHI_COMMENT(<wrap_length>)
Converts the notes for the element currently in scope to Delphi comments.

EXEC_ADD_IN(<addin_name>, <function_name>, <prm_1>, ..., <prm_n>)

Invokes an Enterprise Architect Add-In function, which can return a result string. <addin_name> and
<function_name> specify the names of the Add-In and function to be invoked. Parameters to the Add-In
function can be specified via parameters <prm_1> to <prm_n>. For example:
$result = %EXEC_ADD_IN("MyAddin","ProcessOperation",classGUID, opGUID)%
Any function that is to be called by the EXEC_ADD_IN macro must have two parameters: an EA.Repository
object, and a Variant array that contains any additional parameters from the EXEC_ADD_IN call. Return type
should be Variant. For example:
Public Function ProcessOperation(Repository As EA.Repository, args As Variant) As Variant

FIND(<src>, <subString>)
Position of the first instance of <subString> in <src>; -1 if none.

GET_ALIGNMENT()
Returns a string where all of the text on the current line of output is converted into spaces and tabs.

JAVADOC_COMMENT(<wrap_length>)
Converts the notes for the element currently in scope to javadoc-style comments.

LEFT(<src>, <count>)
The first <count> characters of <src>.

LENGTH(<src>)
Length of <src>.

MID(<src>, <count>)
MID(<src>, <start>, <count>)
Substring of <src> starting at <start> and including <count> characters. Where <count> is omitted the rest of

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1189

the string is included.

PI(<option>, <value>, ...)

Sets the PI for the current template to <value>. <option> controls when the new PI takes effect. Valid values
are:
· I, Immediate: the new PI is generated before the next non-empty template line
· N, Next: the new PI is generated after the next non-empty template line.
Multiple pairs of options are allowed in one call. For more details, see the description of PI. 1192

PROCESS_END_OBJECT(<template_name>)
Enables the Classes that are one Class further away from the base Class, to be transformed into objects
(such as attributes, operations, packages, parameters and columns) of the base Class. <template_name>
refers to the working template that temporarily stores the data.

REMOVE_DUPLICATES(<source>, <separator>)
Where <source> is a <separator> separated list; this removes any duplicate or empty strings.

REPLACE(<string>, <old>, <new>)

Replaces all occurrences of <old> with <new> in the given string <string>.

RESOLVE_OP_NAME()
Resolves clashes in interface names where two method-from interfaces have the same name.

RESOLVE_QUALIFIED_TYPE()
RESOLVE_QUALIFIED_TYPE(<separator>)
RESOLVE_QUALIFIED_TYPE(<separator>, <default>)
Generates a qualified type for the current attribute, linked attribute, linked parent, operation, or parameter.
Enables the specification of a separator other than . and a default value for when some value is required.

RIGHT(<src>, <count>)
The last <count> characters of <src>.

TO_LOWER(<string>)
Converts <string> to lower case.

TO_UPPER(<string>)
Converts <string> to upper case.

TRIM(<string>)
TRIM(<string>, <trimChars>)
Removes trailing and leading white spaces from <string>. If <trimChars> is specified, all leading and trailing
characters in the set of <trimChars> are removed.

TRIM_LEFT(<string>)
TRIM_LEFT(<string>, <trimChars>)
Removes the specified leading characters from <string>.

TRIM_RIGHT(<string>)
TRIM_RIGHT(<string>, <trimChars>)
Removes the specified trailing characters from <string>.

VB_COMMENT(<wrap_length>)
Converts the notes for the element currently in scope to Visual Basic style comments.

© 1998-2010 Sparx Systems Pty Ltd

 1190 Modeling Languages | Build Your Own Modeling Language

WRAP_COMMENT(<comment>, <wrap_length>, <indent>, <start_string>)

Wraps the text <comment> at width <wrap_length> putting <indent> and <start_string> at the beginning of
each line. For example:
$behavior = %WRAP_COMMENT(opBehavior, "40", " ", "//")%

Note:
<wrap_length> must still be passed as a string, even though WRAP_COMMENT treats this parameter as an
integer.

WRAP_LINES(<text>, <wrap_length>, <start_string>[, <end_string])

Wraps <text> as designated to be <wrap_length>, adding <start_string> to the beginning of every line and
<end_string> to the end of the line if it is specified.

XML_COMMENT(<wrap_length>)
Converts the notes for the element currently in scope to XML-style comments.

Control macros are used to control the processing and formatting of the templates. The basic types of control
macro include:
· The list macro, for generating multiple element features, such as attributes and operations
· The branching macros, which form if-then-else constructs to conditionally execute parts of a template
· The PI macro, which takes effect from the next non-empty line
· A PI function macro 1187 that enables setting PI to a variable and adds the ability to set the PI that is
generated before the next line
· The PI macro for formatting new lines in the output
· The synchronization macros.
In general, control macros are named according to Camel casing.

List
The list macro is used to generate multiple elements. The basic structure is:
%list=<TemplateName> @separator=<string> @indent=<string> [<conditions>]%
where <string> is a double-quoted literal string and <TemplateName> can be one of the following template
names:
· Attribute
· Class
· ClassBase
· ClassImpl
· ClassInterface
· Constraint
· Custom Template (custom templates enable you to define your own templates; for more information see
Custom Templates) 1202 .
· Effort
· InnerClass
· InnerClassImpl
· LinkedFile
· Metric
· Namespace
· Operation
· OperationImpl
· Parameter
· Problem
· Requirement
· Resource
· Risk

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1191

· Scenario
· Test
<conditions> is optional and appears the same as the conditions for if and elseIf statements.

Example:
%list="Attribute" @separator="\n" @indent=" "%
The separator attribute, denoted above by @separator, specifies the space that should be used between the
list items. This excludes the last item in the list.
The indent attribute, denoted by @indent, specifies the space by which each line in the generated output
should be indented.
The above example would output the result of processing the Attribute template, for each attribute element of
the Class in scope. The resultant list would separate its items with a single new line and indent them two
spaces respectively. If the Class in scope had any stereotyped attributes, they would be generated using the
appropriately specialized template.
There are some special cases to consider when using the list macro:
· If the Attribute template is used as an argument to the list macro, this also generates attributes derived
from associations by executing the appropriate LinkedAttribute template
· If the ClassBase template is used as an argument to the list macro, this also generates Class bases
derived from links in the model by executing the appropriate LinkedClassBase template
· If the ClassInterface template is used as an argument to the list macro, this also generates Class bases
derived from links in the model by executing the appropriate LinkedClassInterface template
· If InnerClass or InnerClassImpl is used as an argument to the list macro, these Classes are generated
using the Class and ClassImpl templates respectively. These arguments tell Enterprise Architect that it
should process the templates based on the inner Classes of the Class in scope.

Branching (if-then-else Constructs)

The CTF supports a limited form of branching through the following macros:
· if
· elseIf
· endIf
· endTemplate
The basic structure of the if and elseIf macros is:
%if <test> <operator> <test>%
where <operator> can be one of:
· ==
· !=
and <test> can be one of:
· a string literal, enclosed within double quotation marks
· a direct substitution macro, without the enclosing percent signs
· a variable reference.
Branches can be nested, and multiple conditions can be specified using one of:
· and
· or.

Note:
When specifying multiple conditions, and and or have the same order of precedence, and conditions are
processed left to right.

The endif or endTemplate macros must be used to signify the end of a branch. In addition, the endTemplate
macro causes the template to return immediately, if the corresponding branch is being executed.

Example:
%if elemType == "Interface"%
;
%else%

© 1998-2010 Sparx Systems Pty Ltd

 1192 Modeling Languages | Build Your Own Modeling Language

%OperationBody%
%endIf%

Example:
$bases=%list="ClassBase" @separator=", "%
$interfaces=%list="ClassInterface" @separator=", "%
%if $bases != "" and $interfaces != ""%
: $bases, $interfaces
%elseIf $bases != ""%
: $bases
%elseIf $interfaces != ""%
: $interfaces
%endIf%

The PI Macro
There are two primary means of generating whitespace from the templates:
· Explicitly using the newline, space and tab characters (\n, ,\t) as part of Literal Text
· Using the PI macro to format lines in the template that result in non-empty substitutions in the output.
By default, each template line that generates a non-empty substitution also results in a newline being
produced in the output. This behavior can be changed through the PI macro.
To demonstrate the use of the PI macro, consider the default C# Operation template:
%opTag:"Attribute"% Default PI is \n, so any attributes would be on their
own line
Blank lines have no effect on the output
%PI=" "%
%opTag:"unsafe"=="true" ? "unsafe" : ""% Set the PI, so keywords are separated by a space
%CONVERT_SCOPE(opScope)%
%opTag:"new"=="true" ? "new" : ""% Any keyword that does not apply - that is, the macro
%opAbstract=="T" ? "abstract" : ""% produces an empty result - does not result in a space
%opConst=="T" ? "sealed" : ""%
%opStatic=="T" ? "static" : ""%
%opTag:"extern"=="true" ? "extern" : ""%
%opTag:"delegate"=="true" ? "delegate" : ""%
%opTag:"override"=="true" ? "override" : ""%
%opTag:"virtual"=="true" ? "virtual" : ""% Only one space is generated for this line
%opReturnType%%opReturnArray=="T" ? "[]" : ""%
%opStereotype=="operator" ? "operator" : ""%
%opName%(%list="Parameter" @separator=", "%)
The final line in the template does not generate a
space

In the above example macros for the various keywords are to be arranged vertically for readability. In the
output, however, each relevant keyword is to be separated by a single space. This is achieved by the line:
%PI=" "%
Notice how you do not specify the space between each of the possible keywords. This space is already
implied by setting the PI to a single space. Essentially the PI acts as a convenience mechanism for formatting
the output from within the templates.
The structure for setting the processing instruction is:
%PI=<value>%
where <value> can be a literal string enclosed by double quotes.
The following points apply to the PI macro:
· The value of the PI is not accessed explicitly
· Only template lines that result in a non-empty substitution cause the PI to be generated
· The last non-empty template line does not cause the PI to be generated
· The PI is not appended to the last substitution, regardless of which template line caused that substitution.

Synchronization Macros
The synchronization macros are used to provide formatting hints to Enterprise Architect when inserting new
sections into the source code, during forward synchronization. The values for synchronization macros must be
set in the File templates.
The structure for setting synchronization macros is:

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1193

%<name>=<value>%
where <name> can be one of the macros listed below and <value> is a literal string enclosed by double
quotes.

Macro Name Description

synchNewClassNotesSpace Space to append to a new Class note. Default value: \n.

synchNewAttributeNotesSpace Space to append to a new attribute note. Default value: \n.

synchNewOperationNotesSpac Space to append to a new operation note. Default value: \n.

e

synchNewOperationBodySpace Space to append to a new operation body. Default value: \n.

synchNamespaceBodyIndent Indent applied to Classes within non-global namespaces. Default value:

\t.

Enterprise Architect provides two Enterprise Architect Simulation Library (EASL) code generation macros to
generate code from behavioral models. These are:
· EASL_GET and
· EASLList.

EASL_GET
The EASL_GET macro is used to retrieve a property or a collection of an EASL object. The EASL objects and
the properties and collections for each object are identified in the EASL Collections 1194 and EASL Properties
1196 topics.

Syntax
$result = %EASL_GET(<<Property>>, <<Owner ID>>, <<Name>>)
where:
· <<Property>> is either "Property" or "Collection"
· <<OwnerID>> is the ID of the owner object for which the property/collection is to be retrieved
· <<Name>> is the name of the property or Collection being accessed
· $result is the returned value; this is “” if not a valid property.

Example
$sPropName = %EASL_GET("Property", $context, "Name")%

EASLList
The EASLList macro is used to render each object in an EASL collection using the appropriate template.

Syntax
$result = %EASLList=<<TemplateName>> @separator=<<Separator>>
@indent=<<indent>> @owner=<<OwnedID>>
@collection=<<CollectionName>> @option1=<<OPTION1>>
@option2=<<OPTION2>>......... @optionN=<<OPTIONN>>%

where:
· <<TemplateName>> is the name of any behavioral model template 1194 or custom template 1202
· <<Separator>> is a list separator (such as “\n”)
· <<indent>> is any indentation to be applied to the result
· <<owner>> is the ID of the object that contains the required collection
· <<CollectionName>>is the name of the required collection
· <<OPTION1>....<<OPTION99>> are miscellaneous options that might be passed on the template; each
option is given as an additional input parameter to the template
· $result is the resultant value; this is “” if not a valid collection.

© 1998-2010 Sparx Systems Pty Ltd

 1194 Modeling Languages | Build Your Own Modeling Language

Example
$sStates = %EASLList="State" @separator="\n" @indent="\t"
@owner=$StateMachineGUID @collection="States" @option=$sOption%

Behavioral Model Templates

· Action
· Action Assignment
· Action Break
· Action Call
· Action Create
· Action Destroy
· Action If
· Action Loop
· Action Opaque
· Action Parallel
· Action RaiseEvent
· Action RaiseException
· Action Switch
· Behavior
· Behavior Body
· Behavior Declaration
· Behavior Parameter
· Call Argument
· Guard
· Property Object
· Property Declaration
· Property Notes
· State
· State CallBack
· State Enumerate
· State EnumeratedName
· StateMachine
· StateMachine HistoryVar
· Transition
· Transition Effect
· Trigger.
This topic lists the EASL collections for each of the EASL objects, as retrieved by the EASL_GET 1193 code
generation macro.

Action
Collection Name Description

Arguments The Action's arguments.

SubActions The sub-actions of the Action.

Behavior
Collection Name Description

Actions The Behavior's Actions.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1195

Collection Name Description

Nodes The Behavior's nodes.

Parameters The Behavior's parameters.

Variables The Behavior's variables.

Classifier
Collection Name Description

AllStateMachines All State Machines for the Classifier.

AsynchProperties The asynchronous properties of the Classifier.

AsynchTriggers The asynchronous triggers of the Classifier.

Behaviors The behaviors of the Classifier.

Properties The properties of the Classifier.

TimedProperties The timed properties of the Classifier.

TimedTriggers The timed triggers of the Classifier.

Construct
Collection Name Description

AllChildren The Construct's children.

ClientDependencies The client dependencies on the Construct.

StereoTypes The stereotypes of the Construct.

SupplierDependencies The supplier dependencies on the Construct.

Node
Collection Name Description

IncomingEdges The Node's incoming edges.

OutgoingEdges The Node's outgoing edges.

SubNodes The sub-nodes of the Node.

State
Collection Name Description

DoBehaviors The State's Do behaviors.

EntryBehaviors The State's Entry behaviors.

ExitBehaviors The State's Exit behaviors.

© 1998-2010 Sparx Systems Pty Ltd

 1196 Modeling Languages | Build Your Own Modeling Language

StateMachine
Collection Name Description

AllFinalStates The State Machine's final States.

AllStates All States within the State Machine, including those within Submachine
States.

DerivedTransitions The State Machine's derived transitions with the associated valid effect.

States The States within the State Machine.

Transitions The transitions within the State Machine.

Vertices The State Machine's vertices.

Transition
Collection Name Description

Effects The Transition's effects.

Guards The Transition's guards.

Triggers The Transition's triggers.

Trigger
Collection Name Description

TriggeredTransitions The triggered transitions associated with the Trigger.

Vertex
Collection Name Description

DerivedOutgoingTransitions The Vertex's derived outgoing transitions after traversing the pseudo-nodes.

IncomingTransitions The Vertex's incoming transitions.

OutgoingTransitions The Vertex's outgoing transitions.

This topic lists the EASL properties for each of the EASL objects, as retrieved by the EASL_GET 1193 code
generation macro.

Action
Property Name Description

Behavior The Action's associated behavior (Call Behavior Action or Call Operation Action).

Body The Action's body.

Context The Action's context.

Guard The Action's guard.

IsFinal A check on whether the action is a final Action.

IsGuarded A check on whether the action is a guarded Action.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1197

Property Name Description

IsInitial A check on whether the action is an initial Action.

Kind The Action's kind.

Next The Action's next action.

Node The Action's associated node in the graph.

Argument
Property Name Description

Parameter The ID of the Argument's associated parameter.

Value The default value of the argument.

Behavior
Property Name Description

InitialAction The Behavior's initial action.

isReadOnly The isReadOnly of the Behavior.

isSingleExecution The isSingleExecution of the Behavior.

Kind The kind of Behavior.

ReturnType The return type of the Behavior.

CallEvent
Property Name Description

Operation The operation of the CallEvent.

ChangeEvent
Property Name Description

ChangeExpression The change expression of the ChangeEvent.

Classifier
Property Name Description

HasBehaviors A check on whether the Classifier has behavioral models (Activity and
Interaction).

Language The Classifier's language.

StateMachine The State Machine of the Classifier.

© 1998-2010 Sparx Systems Pty Ltd

 1198 Modeling Languages | Build Your Own Modeling Language

Condition
Property Name Description

Expression The Condition's expression.

Lower The Condition's lower value.

Upper The Condition's upper value.

Construct
Property Name Description

GetTaggedValue The Property's Tagged Value.

IsStereotypeApplied A check on whether a particular stereotype is applied to the Property.

Notes Notes on the Property.

UMLType The UML type of the Property.

Visibility The visibility of the Property.

Edge
Property Name Description

From The ID of the node from which the Edge arises.

To The ID of the node at which the Edge is targeted.

EventObject
Property Name Description

EventKind The event kind of the Event Object.

Instance
Property Name Description

Classifier The classifier of the Instance.

Value The value of the Instance.

Parameter
Property Name Description

Direction The direction of the Parameter.

Type The type of the Parameter.

Value The value of the parameter.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1199

Primitive
Property Name Description

FQName The FQ name of the Primitive.

ID The ID of the Primitive.

Name The name of the Primitive.

ObjectType The object type of the Primitive.

Parent The IDParent of the Primitive.

PropertyObject
Property Name Description

BoundSize The bound size of the PropertyObject (if it is a collection).

ClassifierStereoType The stereotype of the PropertyObject's classifier.

IsAsynchProp A check on whether the PropertyObject is an asynchronous property.

IsCollection A check on whether the PropertyObject is a collection.

IsOrdered A check on whether the PropertyObject is ordered (if it is a collection).

IsTimedProp A check on whether the PropertyObject is a timed property.

Kind The PropertyObject's kind.

LowerValue The PropertyObject's lower value (if it is a collection).

Type The PropertyObject's type.

UpperValue The PropertyObject's upper value (if it is a collection).

Value The PropertyObject's value.

SignalEvent
Property Name Description

Signal The signal of the SignalEvent.

State
Property Name Description

HasSubMachine A check on whether the State is a Submachine state.

IsFinalState A check on whether the State is a final state.

SubMachine Get the ID of the Submachine contained by the State (if applicable).

StateMachine
Property Name Description

HasSubMachineState A check on whether the State Machine has a Submachine state.

© 1998-2010 Sparx Systems Pty Ltd

 1200 Modeling Languages | Build Your Own Modeling Language

Property Name Description

InitialState The State Machine's initial state.

SubMachineState The State Machine's Submachine state.

TimeEvent
Property Name Description

When The 'when' property of the TimeEvent.

Transition
Property Name Description

HasEffect A check on whether the transition has a valid effect.

IsDerived A check on whether the transition is a derived transition.

IsTranscend A check on whether the transition transcends from one State Machine
(Submachine state) to another.

IsTriggered A check on whether the transition is triggered.

Source The Transition's source.

Target The Transition's target.

Trigger
Property Name Description

AsynchDestinationState The asynchronous destination state of the Trigger (if it is an asynchronous

trigger).

DependentProperty The ID of the property associated with the Trigger.

Event The Trigger's event.

Name The Trigger's name.

Type The Trigger's type.

Vertex
Property Name Description

IsHistory A check on whether the vertex is a history state.

IsPseudoState A check on whether the vertex is a pseudo state.

PseudoStateKind The Vertex's pseudo-state kind.

5.3.1.5.1.3 Variables
Template variables provide a convenient way of storing and retrieving data within a template. This section
explains how variables are defined 1200 and referenced 1201 .

Variable Definitions
Variable definitions take the basic form:

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1201

$<name> = <value>
where <name> can be any alpha-numeric sequence and <value> is derived from a macro or another variable.
A simple example definition would be:
$foo = %className%
Variables can be defined, using values from:
· Substitution, function or list macros
· String literals, enclosed within double quotation marks
· Variable references.

Definition Rules
The following rules apply to variable definitions:
· Variables have global scope within the template in which they are defined and are not accessible to other
templates
· Each variable must be defined at the start of a line, without any intervening whitespace
· Variables are denoted by prefixing the name with $, as in $foo
· Variables do not have to be declared, prior to being defined
· Variables must be defined using either the assignment operator (=), or the addition-assignment operator
(+=)
· Multiple terms can be combined in a single definition using the addition operator (+).

Examples
Using a substitution macro:
$foo = %opTag:"bar"%
Using a literal string:
$foo = "bar"
Using another variable:
$foo = $bar
Using a list macro:
$ops = %list="Operation" @separator="\n\n" @indent="\t"%
Using the addition-assignment operator (+=):
$body += %list="Operation" @separator="\n\n" @indent="\t"%
The above definition is equivalent to the following:
$body = $body + %list="Operation" @separator="\n\n" @indent="\t"%
Using multiple terms:
$templateArgs = %list="ClassParameter" @separator=", "%
$template ="template<" + $templateArgs + ">"

Variable References
Variable values can be retrieved by using a reference of the form:
$<name>
where <name> can be a previously defined variable.
Variable references can be used in one of the following ways:
· As part of a macro, such as the argument to a function macro
· As a term in a variable definition
· As a direct substitution of the variable value into the output.

Note:
It is legal to reference a variable before it is defined. In this case, the variable is assumed to contain an empty
string value: ""

Example 1
Using variables as part of a macro. The following is an excerpt from the default C++ ClassNotes template.

© 1998-2010 Sparx Systems Pty Ltd

 1202 Modeling Languages | Build Your Own Modeling Language

$wrapLen = %genOptWrapComment% Define variables to store the style and wrap length
$style = %genOptCPPCommentStyle%
options.
%if $style == "XML.NET"%
%XML_COMMENT($wrapLen)% Reference to $style as part of a condition.
%else%
%CSTYLE_COMMENT($wrapLen)%
%endIf% Reference to $wrapLen as an argument to function macro.

Example 2
Using variable references as part of a variable definitions:
$foo = "foo" Define our variables.
$bar = "bar"
$foobar now contains the value foobar.
$foobar = $foo + $bar

Example 3
Substituting variable values into the output
$bases=%classInherits% Store the result of the ClassInherits template in $bases.
Class %className%$bases Now output the value of $bases after the Class name.

5.3.1.5.2 The Code Template Editor in MDG Development

The following topics describe how you use the Code Template Editor window to create custom templates:
· Custom Templates 1202
· Override Default Templates 1204
· Add New Stereotyped Templates 1205
· Create Templates For Custom Languages 1206

The Code Template Editor provides the facilities of the Common Code Editor, including intellisense for the
code generation template macros 1173 . For more information on intellisense and the Common Code Editor, see
the Code Editors 1428 topic.

5.3.1.5.2.1 Custom Templates

Custom templates enable you to generate an element in many different ways. Enterprise Architect enables
you to define custom templates that are associated with given elements and call these templates from existing
templates. You can even add stereotype overrides to your custom templates. For example, you might list all of
your parameters and their notes in your method notes.
To create a new custom template, follow the steps below:
1. Select the Settings | Code Generation Templates menu option, or press [Ctrl]+[Shift]+[P]. The Code
Templates Editor tab opens.
2. In the Language field, click on the drop-down arrow and select the appropriate language.
3. Click on the Add New Custom Template button. The Create New Custom Template dialog displays.

4. In the Template Type field, click on the drop-down arrow and select the appropriate element. The
elements currently supported are:
· Attribute
· Class
· Class Base

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1203

· Class Interface
· Class Parameter
· Connector
· Import
· Linked Attribute
· Linked Class Base
· Linked Class Interface
· Namespace
· Operation
· Parameter.

Note:
<None> requires special treatment. It enables the definition of a function macro that doesn't actually
apply to any of the types, but must be called as a function to define variables $parameter1,
$parameter2 and so on for each value passed in.

5. In the Template Name field, type an appropriate name, then click on the OK button.
6. On the Code Templates Editor tab, the new template displays in the Templates list with the value Yes in
the Modified field. The template is called <Template Type>_<Template Name>.
7. Select the appropriate template from the Templates list and edit the contents in the Template field to
meet your requirements.

© 1998-2010 Sparx Systems Pty Ltd

 1204 Modeling Languages | Build Your Own Modeling Language

8. Click on the Save button. This stores the new stereotyped template in the .EAP file. The template is
now available from the list of templates and via direct substitution for use.

5.3.1.5.2.2 Override Default Templates

Enterprise Architect has a set of built-in or default code generation templates. The Code Templates Editor
enables you to modify these default templates, hence customizing the way in which Enterprise Architect
generates code. You can choose to modify any or all of the base templates to achieve your required coding
style.
Any templates that you have overridden are stored in the .EAP file. When generating code, Enterprise
Architect first checks whether a template has been modified and if so, uses that template. Otherwise the
appropriate default template is used.

Enterprise Architect User Guide

 Modeling Languages | Build Your Own Modeling Language 1205

Procedure
To override a default code generation template, follow the steps below.
1. Select the Configuration | Code Generation Templates menu option. The Code Templates Editor
displays.
2. Select the appropriate language from the Language list.
3. Select one of the base templates from the Templates list.
4. If the base template has stereotyped overrides, you can select one of these from the Stereotype
Overrides list.
5. In the Code Templates Editor, make the required modifications.
6. Click on the Save button. This stores the modified version of the template to the .EAP file. The template
is marked as modified.
When generating code, Enterprise Architect now uses the overridden template, instead of the default
template.

5.3.1.5.2.3 Add New Stereotyped Templates

Sometimes it is useful to define a specific code generation template for use with elements of a given
stereotype. This enables different code to be generated for elements, depending on their stereotype.
Enterprise Architect provides some default templates, which have been specialized for commonly used
stereotypes in supported languages. For example the Operation Body template for C# has been specialized
for the property stereotype, so that it automatically generates its constituent get and set methods. Users can
override the default stereotyped templates as described in the previous topic. Additionally users can define
templates for their own stereotypes, as described below.

Add a New Stereotyped Template

To override a default code generation template, follow the steps below.
1. Select the Configuration | Code Generation Templates menu option to open the Code Templates
Editor.
2. Select the appropriate language, from the Language list.
3. Select one of the base templates, from the Templates list.
4. Click on the Add New Stereotyped Override button. The New Template Override dialog displays.

5. Select the required Feature and/or Class stereotype and click on the OK button.
6. The new stereotyped template override displays in Stereotype Overrides list, marked as modified.
7. Make the required modifications in the Code Templates Editor.
8. Click on the Save button. This stores the new stereotyped template in the .EAP file.
Enterprise Architect can now use the stereotyped template, when generating code for elements of that
stereotype.
Note that Class and feature stereotypes can be combined to provide a further level of specialization for
features. For example, if properties should be generated differently when the Class has a stereotype
MyStereotype, then both property and MyStereotype should be specified in the New Template Override dialog.

© 1998-2010 Sparx Systems Pty Ltd

 1206 Modeling Languages | Build Your Own Modeling Language

5.3.1.5.2.4 Create Custom Language Template

Enterprise Architect can forward generate code for languages that it does not specifically support, if the
appropriate code generation templates are defined for that language. This topic outlines the steps required to
define templates for custom languages.

Define a Template for a Custom Language

1. Create the custom language as a new product. To do this:
· Select the Settings | Code Datatypes menu option. The Programming Languages Datatypes dialog
displays.
· In the Product Name field type the name of the new language, and in the Datatype field type a
datatype (one is enough to declare that the new language exists). See the Data Types 666 topic for
more details.
2. Select the Settings | Code Generation Templates menu option. The Code Templates Editor view
displays.
3. In the Language field, click on the drop-down arrow and select the custom language.
4. From the Templates list, select one of the base templates.
5. Define the template using the Code Templates Editor.
6. Click on the Save button. This stores the template in the .EAP file.
7. Repeat steps 1 to 6 for each of the relevant base templates for the custom language.

Note:
The File template must be defined for the custom language. The File template can then see the Import
Section, Namespace and Class templates.

Enterprise Architect User Guide

Part

VI
 1208 Navigate, Search and Trace |

6 Navigate, Search and Trace

This section explains how you navigate through the model structures in Enterprise Architect, locate and
display specific data and structures, and trace the origins and development of the model components.
The section describes:
· The Enterprise Architect Project Browser 1209
· The use of Model Views 1222 to provide different perspectives
· The Model Search 1231 facility
· Support for Traceability 1245 during model development
· Use of the Element List 1255 to review model components
· Use of the Relationship Matrix 1261 to review relationships between model components.

Enterprise Architect User Guide

 Navigate, Search and Trace | The Project Browser 1209

6.1 The Project Browser

The Project Browser enables you to navigate through the Enterprise Architect project space. It displays
packages, diagrams, elements and element properties.
You can drag and drop elements between folders, or drop (paste) 430 elements from the Project Browser
directly into the current diagram.
If you right-click on an item in the Project Browser to display the context menus, you can perform additional
actions such as adding new packages, creating diagrams, renaming items, creating documentation and other
reports, and deleting model elements. You can also edit the name of any item in the Project Browser by
selecting the item and pressing [F2].

© 1998-2010 Sparx Systems Pty Ltd

 1210 Navigate, Search and Trace | The Project Browser

Tip:
The Project Browser is the main view of all model elements in your model; use the mouse to navigate the
project.

Note:
You can hide and show the Project Browser by pressing [Alt]+[0].

Views
The Project Browser can be divided into Views 383 , each of which contains diagrams, packages and other
elements. A default View hierarchy is described below, but you can create different Views to suit your
requirements:

View Description

Use Case View The functional and early analysis View. Contains Business Process and Use Case
models.

Dynamic View Contains State Charts, Activity and Interaction diagrams. The dynamics of your system.

Logical View The Class Model and Domain Model View.

Component View A View for your system components. The high level view of what software is to be built
(such as executables, DLLs and components).

Deployment The physical model; what hardware is to be deployed and what software is to run on it.
View

Custom View A work area for other Views, such as formal requirements, recycle bin, interview notes
and non-functional requirements.

Selective Collapse
When you are working on an expanded project in the Project Browser, you might want to locate the parent
element or package of an item, and/or collapse the structure under that parent element or package. To do this,
follow the steps below:
1. Position the cursor on an item within the element or package.
2. Press [!] on the keyboard to highlight the parent.
3. Press the key again to collapse the structure under that parent element or package.

See Also
· Project Browser Icon Overlays 1213

6.1.1 Order Package Contents

Enterprise Architect enables you to change the order of elements listed in the Project Browser.
Elements by default are first listed in order of type, then in order of set position, then alphabetically. You can
use the context menu options to move an element up or down within its type, but not outside its type. This
means you can re-sequence Packages or Diagrams or Use Cases, but you cannot mix elements up. However,
you can change this default behavior 1210 to allow elements to be re-ordered within the package, regardless of
type.
Ordering elements is very important when it comes to structuring your model, especially packages. RTF
documents honor any custom ordering when printing documentation.

6.1.2 Set Default Behavior

The General page of the Options dialog provides several options for altering the look and behavior of the
Project Browser.
To access the General page, select the Tools | Options | General menu option.

Enterprise Architect User Guide

 Navigate, Search and Trace | The Project Browser 1211

Double-click Behavior
In the Double click on browser panel, select the appropriate radio button.

· Shows Properties - double-clicking an item in the Project Browser opens a Property dialog (if available)
for that element
· Opens Branch - double-clicking an item in the Project Browser expands the tree to show the item's
children; if there are no children, nothing happens
· Opens Branch & Diagram - as above, but also opens the first diagram beneath the item, if applicable.

Enable Free Sorting

The General page of the Options dialog, in the Project Browser panel, select the Allow Free Sorting
checkbox. This enables you to re-order elements 1210 within a package regardless of type, within the Project
Browser.
For example, below, the element Class3 has been moved from its original position with the other Class
elements, to a point amongst the Action elements.

You move elements using the icon (moves the element further up the tree) and icon (moves the
element further down the tree) in the Project Browser toolbar.

Show Stereotypes
1. On the Options dialog, in the Project Browser panel, select the Show Stereotypes checkbox.
2. When prompted, shut down and restart Enterprise Architect to enable this change to take effect.
As shown in the above screen, when a stereotype is defined for an element, the stereotype name then
displays in front of the element name (see Action4 and Activity1).
You set the stereotype of an element in its Properties dialog.

© 1998-2010 Sparx Systems Pty Ltd

 1212 Navigate, Search and Trace | The Project Browser

6.1.3 Project Browser Toolbar

The Project Browser toolbar enables you to perform a range of operations on your project structures.

The functions of each icon in the toolbar are, from left to right:
· Create a new Model Package 372 in the project, from a predefined UML or Technology pattern
· Create a new child package 387 under the selected package
· Create a new child diagram 422 under the selected package or element
· Create a new child element 524 under the selected package or element
· Perform a simple search for a text string in the Project Browser
· Provide options to generate an RTF report 1570 , HTML report 1647 or Diagram Only 1625 report on the selected
package in the Project Browser
· Provide options to generate source code 1311 or DDL 1369 , import a source directory 1332 , binary module 1334
or database schema 1363 , generate package contents 1313 to synchronize with package code, or reset the
source code language 1361 , all for the selected package
· Move the selected package or element further up the Project Browser, within its parent package
· Move the selected package or element further down the Project Browser, within its parent package
· Open the Enterprise Architect Help on the Project Browser.

Enterprise Architect User Guide

 Navigate, Search and Trace | The Project Browser 1213

6.1.4 Project Browser Icon Overlays

The Project Browser displays the status of each package in the model by overlaying status icons on the
package icon. The following table describes what each overlaid icon means.

Icon Overlay Indicates that...

This package is controlled 293 and is represented by an XMI file on disk. Version control
either is not being used or is not available. You can edit the package.

This package is version controlled and checked out 261 to you, therefore you can edit the
package.

This package is version controlled and not checked out to you, therefore you cannot edit
the package (unless you check the package out).

This package is version controlled, but you checked it out whilst not connected to the
version control 268 server. You can edit the package but there could be version conflicts
when you check the package in again.

This package is a namespace root. It denotes where the namespace structure starts;
packages below this point are generated as namespaces 1313 to code.

<MDG Add-In MDG Add-Ins 1821 specify their own icon to denote that this branch of the model belongs
icon> to that Add-In. All packages connected to an MDG Add-In correspond to a namespace
root, so the namespace root icon is not displayed.

Similarly, the Project Browser indicates attribute and operation scope status with icons. The following table
describes what each indicator icon means.

Icon Overlay Indicates that...

The attribute or operation is scoped as protected.

The attribute or operation is scoped as private.

In the Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions, if Project
User Security 188 is on, the Project Browser also has element locking indicators (red and blue exclamation
marks) that indicate the lock status of individual elements and packages. The availability of these elements for
editing depends on whether user locks are required or not. For further information, see the Locked Element
Indicators 206 topic.

6.1.5 Project Browser Context Menus

This section describes the many options available to work on objects in the Project Browser, selected from the
following context menus:
· Model (Root Node) context menu 1213

· Package Context Menu 1214

· Element Context Menu 1218
· Diagram Context Menu 1220
· Operation Context Menu 1221 .

6.1.5.1 Model (Root Node) Context Menu

The Root Node in the Project Browser is the Model element. You can have more than one model element.
The first level packages beneath the Model node are sometimes referred to as Views as they commonly divide
a model into categories such as Use Case Model and Logical Model.
Right-click on the Root Node to display the Model context menu.

© 1998-2010 Sparx Systems Pty Ltd

 1214 Navigate, Search and Trace | The Project Browser

Menu Option & Function Keys Use to

Add-In Access the facilities of each Add-In currently enabled for the project.

Scripts List the scripts enabled for execution directly from the Project Browser
.
(Does not display if no Project Browser scripts exist.)

Package Control Display the Package Control 294 submenu.

Rename Model Rename the current model.

New Model (root node) Create a new model root.

New View Create a new View (package).

Add a New Model using Wizard Add further models using the Model Wizard 372 .

Copy Package to Clipboard Copy the selected package 388 to the clipboard, to be copied into
another package in the same .eap file or a different .eap file.

Paste Package from Clipboard Paste a package 388 from the clipboard into the selected package.

Find in Project Browser Find a specified term in the Project Browser.

[Ctrl]+[Shift]+[F]

Expand Branch Expand all items.

Collapse Branch Collapse all items.

Import Model from XMI Import a model 288 from an XMI file.
[Ctrl]+[Alt]+[I]

Export Model to XMI Export a model 288 to XMI.

[Ctrl]+[Alt]+[E]

Rich Text Format (RTF) Report Produce RTF documentation 1569 for the model.
[F8]

HTML Report Produce HTML documentation 1647 for the model.

[Shift]+[F8]

Diagrams Only Report Produce a Diagrams Only 1625 report (in RTF) for the model.
[Ctrl]+[Shift]+[F8]

Copy Reference Copy a reference to the root node to the Enterprise Architect
clipboard. Select the appropriate sub-option to copy the:
· selected package hierarchy structure (node path) or
· node GUID.
Delete Project Root Delete the Model node and all subordinate Views and packages.

Help Display the Help topic for the Project Browser.

6.1.5.2 Package Menu

Right-click on a View or Package in the Project Browser. The context menu displays, providing the following
options:

Menu Option & Function Use to

Keys

Add-In Access the facilities of each Add-In currently enabled for the project.

Enterprise Architect User Guide

 Navigate, Search and Trace | The Project Browser 1215

Menu Option & Function Use to

Keys

Scripts List the scripts 1663 enabled for execution directly from the Project Browser.
(Does not display if no Project Browser scripts exist.)

Properties Add new packages to the model.

Package Control Submit packages to package control 294 and version control 257 .

Add Add 1216 a new diagram, element or another package to the current package.

View Package As List Display the Element List 1255 , showing the elements contained in the selected
package.

Turn On Level Numbering Add a sequence number to each element in the package, based on the
element's position in the package hierarchy 923 .
(Turn Off Level Numbering)
For nested elements, the numbering indicates level; that is:
3.2
3.2.1
3.2.1.1.
This option is only available for packages, and the numbering only applies to
the elements in the package, not diagrams.
If elements are added, moved or deleted from the package, the numbering
automatically adjusts.

Linked Document Create or display a linked document 597 for the package or view.
[Ctrl]+[Alt]+[D]

Delete Linked Document Delete the linked document attached to the package. The system prompts
you to confirm the deletion.

Paste Diagram If you have copied a diagram from another package, paste the diagram into
the currently-selected package.

Documentation Produce a variety of reports and documentation 1216 in RTF format.

Code Engineering Perform Code Engineering 1217 functions.

Execution Analyzer Perform build, run 1217 and execution analysis functions.

Import/Export Import and export 1218 using XMI text files.

Transform Current Perform a model transformation 1387 on the selected package.

Package
[Ctrl]+[Shift]+[H]

Contents Reorganize the package contents 1218 after making changes.

Bookmarks Bookmark 341 all elements in the selected folder.

Find in Project Browser Search the Project Browser for specific elements.
[Ctrl]+[Shift]+[F]

Copy Reference Copy a reference to the package to the Enterprise Architect clipboard. Select
the appropriate sub-option to copy the:
· selected package hierarchy structure (node path) or
· node GUID.
Copy Package to Clipboard Copy the selected package 388 to the clipboard, to be copied into another
package in the same .eap file or a different .eap file.

© 1998-2010 Sparx Systems Pty Ltd

 1216 Navigate, Search and Trace | The Project Browser

Menu Option & Function Use to

Keys

Paste Package from Paste a package 388 from the clipboard into the selected package.
Clipboard

Paste Element(s) from Paste elements copied to the clipboard 531 into the selected package.
Clipboard

Save Package as UML Save the selected package as a Profile 906 .

Profile

Set View Icon Change the display icon for the selected package (View level).

Move up Move the package up in the list.

Move down Move the package down the list.

Delete <packagename> Delete the selected package and its contents.

Help Display the Help topic for the Project Browser.

6.1.5.2.1 Add Sub-Menu

In the Project Browser, right-click on a package and select the Add context menu option.

Menu Option & Function Keys

Add Diagram 422

Add Element 524 [Ctrl]+[M]

Add Package 387 [Ctrl]+[W]

Add a New Model using Wizard

372

6.1.5.2.2 Documentation Sub-Menu

In the Project Browser, right-click on a package and select the Documentation context menu option.

Menu Option & Function Keys

Rich Text Format (RTF) Report 1569 [F8]

HTML Report 1647 [Shift]+[F8]

Diagrams Only Report 1625 [Ctrl]+[Shift]

+[F8]

Testing Report 1550

Open in Relationship Matrix 1261

RTF Report Options 1573

Copy RTF Bookmark 1639

Implementation Report 1626

Dependency Report 1624

Testing Details 1549

Enterprise Architect User Guide

 Navigate, Search and Trace | The Project Browser 1217

Menu Option & Function Keys

Resource Allocation 318

Package Metrics 338

6.1.5.2.3 Code Engineering Sub-Menu

In the Project Browser, right-click on a package and select the Code Engineering context menu option.

Menu Option & Function Keys

Generate Source Code 1308 [Ctrl]+[Alt]+[K]

Import Source Directory 1332 [Ctrl]+[Shift]+[U]

Import Binary Module 1334

Synchronize Package With Code 1327 [Ctrl]+[Alt]

+[M]

Generate DDL 1369

Import DB schema from ODBC 1363

Generate XML Schema 1376

Import XML Schema 1373

Generate WSDL 1379

Import WSDL 1376

Reset Options for this Package 1361

Reset DBMS Options 1036

Set as Namespace Root/ 1313 Clear Namespace

Root

6.1.5.2.4 Execution Analyzer Sub-Menu

In the Project Browser, right-click on a package and select the Execution Analyzer 1488 context menu option.

Menu Option & Function Keys

Package Build Scripts 1426 [Shift]+[F12]

Build 1444 [Ctrl]+[Shift]+[F12]

Test 1483 [Ctrl]+[Alt]+[T]

Run 1482 [Ctrl]+[Alt]+[N]

Deploy 1484 [Ctrl]+[Shift]+[Alt]+[F12]

Debug 1447 [F6]

Step Into 1473 [Shift]+[F6]

Step Over 1472 [Alt]+[F6]

© 1998-2010 Sparx Systems Pty Ltd

 1218 Navigate, Search and Trace | The Project Browser

Menu Option & Function Keys

Step Through 1480

Step Out 1473 [Ctrl+[F6]

Stop Debugging 1446 [Ctrl]+[Alt]+[F6]

Start Recording 1505

Stop Recording 1505

Create Diagram From History 1507

Create Diagram From Stack 1480

6.1.5.2.5 Import/Export Sub-Menu

In the Project Browser, right-click on a package and select the Import/Export context menu option.

Menu Option & Function Keys

Import package 290 from XMI file [Ctrl]+[Alt]

+[I]

Export package 289 to XMI file [Ctrl]+[Alt]+[E]

CSV Import 305 / Export 303

6.1.5.2.6 Contents Sub-Menu

In the Project Browser, right-click on a package and select the Contents context menu option.

Menu Option Use to

Expand Branch Expand all of the items in the Project Browser.

Collapse Branch Collapse all of the items in the Project Browser.

Reset Sort Order Return sorting of package contents to list in alphabetical order.

Reload current package Refresh the current package 267 in the Project Browser.

6.1.5.3 Element Menu - Project Browser

Right-click on an element (such as Class, Object, Activity, State) in the Project Browser to display the
element's context menu.

Menu Option & Function Use to

Keys

Add-In Access the facilities of each Add-In currently enabled for the project.

Scripts List the scripts 1663 enabled for execution directly from the Project Browser.
(Does not display if no Project Browser scripts exist.)

Properties View and modify the element properties.

Custom Properties Customize the properties.

[Ctrl]+[Shift]+[Enter]

Enterprise Architect User Guide

 Navigate, Search and Trace | The Project Browser 1219

Menu Option & Function Use to

Keys

Add Create 1219 a child element and diagram (Classifier elements) or a

connector to another element.

Rule Composer For a Rule Task element, invoke the Rule Composer 945 tab in Business
Rule Modeling.

Attributes Display the Attribute dialog ready to create a new attribute.

Operations Display the Operations dialog ready to create a new operation.

Create Workbench Instance Create workbench variables 1521 from the selected Class. When you select
[Ctrl]+[Shift]+[J] this option, Enterprise Architect prompts you to name the variable. It then
displays in the Workbench 1519 window.

Generate Code [F11] Generate the source code for this element. See Generate Source Code 1308

Synchronize with Code [F7] Synchronize the element in the diagram with the source code. See Import
Source Code 1328 .

View Source Code [F12] View the source code 1441 of the element.

Open Source Directory Open the source directory.

[Ctrl]+[Alt]+[Y]

In Diagrams [Ctrl]+[U] Locate the element in all open diagrams.

Locate in Current Diagram Select the element in the currently-visible diagram.

If the element is not in the diagram, this option is grayed out.

Copy RTF Bookmark Copy a bookmark 1639 in RTF format to the clipboard.

Linked Document Create a Linked Document (Corporate, Business and Software

[Ctrl]+[Alt]+[D] Engineering, Systems Engineering and Ultimate editions). See the Linked
Documents 597 topic.

Delete Linked Document Delete the linked document attached to the selected element.

Add Custom Reference Set up cross references 527 between elements in a diagram and the
[Ctrl]+[J] selected element in the Project Browser.

Copy Element(s) to Copy the selected element 531 or elements to the clipboard to be pasted
Clipboard into another package in this .eap file or another .eap file.

Copy Reference Copy a reference to the element to the Enterprise Architect clipboard.
Select the appropriate sub-option to copy the:
· selected element hierarchy structure (node path) or
· node GUID.
Move Up Move the element up in the list of elements within this package.

Move Down Move the element down in the list of elements within this package.

Delete '<element Name>' Delete the element.

Help Display the Help topic for the Project Browser.

6.1.5.3.1 Add Sub Menu

To display the Add submenu, either click on the element in the Project Browser and press [Insert], or right-
click on the element and select the Add context menu option.

The Add sub-menu enables you to:

© 1998-2010 Sparx Systems Pty Ltd

 1220 Navigate, Search and Trace | The Project Browser

· Add a Behavior element (Activity 753 , Interaction 780 or State Machine 796 ) and one of its associated
diagrams to the selected Classifier 519 element
· Add a Rule Flow Activity 939 element to a Class, in Business Rule Modeling
· Create a diagram to explain or expand on the selected Classifier element, using the New Diagram 422
dialog, or
· Create a connector 618 to another element.
Elements such as Actors, Classes and Activities can define a large amount of information that can be
conveniently represented by or expanded in a child diagram. The Add sub-menu for these elements provides
all of the options listed above.
Other elements, such as Timing, Exit and History have much more specific functions that do not require
expansion. Therefore, the Add sub-menu for these elements only provides the option to create a connector to
another element, and does not offer options for adding child elements and diagrams.

6.1.5.4 Diagram Menu - Project Browser

Right-click on a diagram in the Project Browser to open the Diagram context menu. The example below
illustrates the functions available from this menu.

Menu Option & Function Use to

Keys

Add-In Access the facilities of each Add-In currently enabled for the project.

Scripts List the scripts 1663 enabled for execution directly from the Project Browser.
(Does not display if no Project Browser scripts exist.)

Properties [F5] View and modify a diagram's properties.

Open Open the diagram in the Diagram View.

View Diagram As List Display the Element List 1255 , listing the elements in the selected diagram.

Copy Diagram Copy the diagram for pasting into another location (see Copy a Diagram 436 ).

Copy RTF Bookmark Copy a bookmark 1639 in RTF format to the clipboard.

Add Custom Reference Add this diagram as a cross reference 527 to other elements.

Print Diagram(s) Print the currently-selected diagram or diagrams (hold [Ctrl] or [Shift] while
selecting).

Copy Reference Copy a reference to the diagram node to the Enterprise Architect clipboard.
Select the appropriate sub-option to copy the:
· selected hierarchy structure (node path) or
· node GUID.
Move up Move the diagram up in the list of diagrams within this package.

Move down Move the diagram down in the list of diagrams within this package.

Delete '<diagram name>' Delete the selected diagram.

Delete selected items Delete several selected diagrams (hold [Ctrl] or [Shift] while selecting).

Help Display the Help topic for the Project Browser.

Enterprise Architect User Guide

 Navigate, Search and Trace | The Project Browser 1221

6.1.5.5 Operation Menu - Project Browser

To display the Operation (or Method) context menu, right-click on an Operation in the Project Browser.

Menu Option & Function Keys Use to

Add-In Access the facilities of each Add-In currently enabled for the project.

Scripts List the scripts 1663 enabled for execution directly from the Project
Browser.
(Does not display if no Project Browser scripts exist.)

Generate Code [F11] Generate code for the operation.

Synchronize With Code Synchronize the operation with the code.

[F7]

View Source Code [F12] Open the Source Code Viewer 1441 and display the operation.

Operation Properties Display the Properties dialog for the operation.

Copy Reference Copy a reference to the operation to the Enterprise Architect clipboard.
Select the appropriate sub-option to copy the:
· selected hierarchy structure (node path) or
· node GUID.
Delete Operation Delete the operation.

Help Display the Help topic for the Project Browser.

You can display an equivalent context menu for an attribute by right-clicking on the attribute in the Project
Browser.

© 1998-2010 Sparx Systems Pty Ltd

 1222 Navigate, Search and Trace | Model Views

6.2 Model Views

The Model Views window enables you to encapsulate your model into the areas you are interested in. You
display the window by selecting the View | Model Views menu option.

View Root Nodes

There are three types of View root-node available:
· Model Views - stored in the model and visible to all users; you can have many of these
· My Views - stored locally on your machine and visible only to you; you can have only one of these
· Technology-defined Views - read only; each View is stored with and populated by 1227 the corresponding
active MDG Technology.
Additionally, there is a Recent Discussions folder that contains current correspondence from the Team Review
208 concerning items that are held in any of the Views. The folder has a separate repository of postings for
each team review server connection 218 you access through the model. You can control how recent 1224 these
postings must be, and how many are to be listed.
When you open the Model Views window for the first time on a project, a Model Views root section, My Views
root section and Recent Discussions folder are added for you. These can not be deleted or renamed. However
you can create further Model View root nodes which you can modify and delete.

Subordinate Folders
Under the My Views root node you can add a single level of View folders, which enable you to group Search
View folders as best suit your requirements.
· A Search View is a folder of elements or structures that you assemble by assigning a model search to the
folder. When you double-click or expand the folder, the search runs and refreshes the folder contents.
You can also set a search to refresh at a defined interval, and to notify you if new results 1226 are found.
Under a Model View root node you can create Views folders that can contain Search View folders, Slideshow
folders and Favorites folders.
· A Slideshow folder contains diagrams only, which you can display as a slide show 1228 with diagrams being
shown in the sequence in which they are listed in the folder. One folder represents one slide show. You can
run the slide show automatically or manually; in either case the diagrams are closed after they have been
displayed.
· A Favorites folder gives you easy access to commonly-used items in the Project Browser. To create
hyperlinks in a Favorites folder to the required items in the Project Browser, drag items from the Project
Browser into the Favorites folder.
You can also export 1227 all of the View folders containing Views from any root section as an XML file, and
import 1227 a Views XML file as an additional, editable Model View root node.

Note:
These are single-level items; if you drag a package into the Favorites folder, you cannot expand that package
there. To select specific items inside a package, expand it in the Project Browser and then drag the items into
the Favorites folder.

Enterprise Architect User Guide

 Navigate, Search and Trace | Model Views 1223

Key to Model View Contents

Model Views toolbar 1223

- A Model View root node

- A View Folder

- A Favorites Folder

- A View (search-based)

- A Slideshow Folder

- The My Views root node

- The DoDAF-MODAF View (a

Technology-defined View)

- The Recent Discussions folder

- A repository of postings from a

selected team review, concerning elements
in the Model Views

- The recent posts folder for the

selected team review
Each level of the Model Views hierarchy has
a slightly different context menu. 1224

6.2.1 Model Views Toolbar

The availability of the Model Views toolbar options depends on the type of object selected. The options are,
from left to right:

© 1998-2010 Sparx Systems Pty Ltd

 1224 Navigate, Search and Trace | Model Views

Displays the appropriate Properties dialog for the item selected. Alternatively, double-click on the
item, or press [Enter].
Locates the selected object in any diagrams in which it has been used in the model, and either
displays the single diagram with the object highlighted or lists the several diagrams in which the
object has been located.
Locates and highlights the selected object in the Project Browser.

Creates a new Model View root node, and displays the New Model View dialog in which you enter
the root node name.
Creates a new Views folder in the currently-selected root node.

Creates a new Favorites folder in the currently-selected Views folder.

Creates a new Slideshow 1228 folder in the currently-selected Views folder.

Creates a new View in the currently-selected Views folder, and displays the Create New View
dialog to define the search 1226 that populates the View.
Refreshes the selected Model Views root node, folder, View or Favorites. For a View, this runs the
Model Search defined in the View properties. 1226
Moves the currently-selected object up or down within its type; you cannot move - for example - a
package below a diagram, or a View above a Favorites folder.
Displays a prompt to confirm deletion of the selected object and - if appropriate - its contents. You
cannot delete the original Model Views, My Views or Recent Discussions root nodes, or any
technology-defined Views.

Displays Help on Model Views.

6.2.2 Model Views Context Menus

The Model Views window context menus display different options, depending on which level of the Model
Views hierarchy you right-click on. The options are described below:

Menu Option Use to

Properties Display the appropriate Properties dialog for the selected object. (Not the My Views,
Recent Discussions, initial Model Views or Technology-defined root nodes.)
You can edit any of the properties, if required. Changes to objects populated from the
model are reflected in all other views (Properties window, diagrams, reports) of that
object.
The Properties option for the Recent Posts folder displays the Recent Post Options
dialog, which enables you to specify the number of days back from which to extract
postings from the Team Review, and the number of postings to list.
The Properties option for a Slideshow folder displays the Slideshow Properties 1228
dialog, which enables you to automate the slide show and set the number of seconds for
which each diagram is displayed.
If you deselect the Enable checkbox, you must press [Spacebar] to display each
diagram.

New Views Display a prompt for the Views folder name and create the folder in the selected root
Folder node. (Root node only.)

Import Views Prompt for the XML file location and create a new Model Views node to hold the imported
From XML 1227 Views. (Root node only.)

Export to XML Prompt for a file path and name, and copy all Views under the selected root node to an
(Views Only) XML file at that location. (Root node only.)
1227

Enterprise Architect User Guide

 Navigate, Search and Trace | Model Views 1225

Menu Option Use to

Remove Model Display a prompt to delete the selected user-defined Model View and, if confirmed, delete
View the root node and all contents. (Not for the My Views, initial Model Views or Technology-
defined root nodes.)

New Search Display the Create New View dialog (similar to the View Properties dialog) for you to
Folder define the search that populates the View 1226 . (View folder only.)

New Favorites Display the Create a new favorites based folder dialog, which prompts for the folder
Folder name. (View folder only.)

New Slideshow Display the Create a new slideshow 1228 dialog, in which you type the name of the slide
show. You must use the Properties dialog to define the properties of the slide show.
(Model View, View folder only)

Open Search Display the Model Search tab in the main work area, listing the full results of the search
and giving access to all the facilities of the Model Search 1233 (View only).
Alternatively, press [Shift]+[Space].

Refresh Refresh the search and open the View or Postings Repository to show the elements or
Posts retrieved by the search.
Alternatively, press [Space].

Double Click Enable you to perform the Open Search function by double-clicking on the View.
Opens Search
If you deselect this option, double-click refreshes the search and opens the View to show
the elements retrieved by the search.

Find Post Open the Project Team Review and highlight the selected post.

Open Team Open the Project Team Review at the top level (Category).
Review

Edit Display the Team Review Server Connections 218 dialog, to select which review to open.
Connections

Remove Folder Display a prompt to delete the selected Views folder and, if confirmed, delete the folder
and all contents. (View folder only.)

Remove View Display a prompt to delete the selected View and, if confirmed, delete the View and all
contents.

Remove Display a prompt to delete the selected Favorites folder and, if confirmed, delete the
Favorites folder and all contents.

Remove Display a prompt to confirm deletion of the selected slide show and, if confirmed, delete
Slideshow the slide show and all its diagrams.

Run Slideshow Run the slide show 1228 in the Diagram View.

Run Slideshow Run the slide show 1228 in full screen mode, so that the slide show fills the whole screen.
Full Screen

Stop Slideshow Cancel execution of the slide show 1228 running in the Diagram View. Alternatively, press
[Esc].

In Project Highlight the selected item in the Project Browser. (Element / Diagram / Package object
Browser only.)

In Diagrams Locate the selected object in any diagrams in which it has been used in the model, and
either display the single diagram with the object highlighted or list the several diagrams in
which the object has been located.(Element / child Package object only.)

Remove Linked Display a prompt to delete the selected object and, if confirmed, remove the object from

© 1998-2010 Sparx Systems Pty Ltd

 1226 Navigate, Search and Trace | Model Views

Menu Option Use to

Item the folder. This has no effect on the object in the Project Browser or any diagrams.
(Element / Diagram / Package object only.)

Note:
You would not delete an object in a View, as it is replaced the next time the View is
refreshed.

Help Display Help on Model Views.

6.2.3 Model Views Operations

Define View Search

When you:
· First create a View, the Create New View dialog displays
· Select to display the View properties, the View Properties dialog displays.
These two dialogs are identical. However, in the Corporate, Business and Software Engineering, Systems
Engineering and Ultimate editions of Enterprise Architect, a work flow 342 feature is added to the dialogs
(second illustration).

In the Name field, type a name for the View.

In the Search field, either:

· Click on the drop-down arrow and select an existing search from the lists, or
· Click on the [ ... ] (Browse) button to display the Manage Searches 1235 dialog, edit an existing search or
define a new one, then Close the dialog and select that search name in the Search field.

Enterprise Architect User Guide

 Navigate, Search and Trace | Model Views 1227

Note:
For a custom SQL search statement, the statement should return the guid and type of the object found so
that Enterprise Architect can search for the selected item in the Project Browser. For example:
SELECT ea_guid AS CLASSGUID, Object_Type AS CLASSTYPE, Name FROM t_object

If required, in the Search Term field type a specific value to search for.
If you are working with the Corporate or extended versions of Enterprise Architect, and you want the search to
run automatically and refresh the results, select the Refresh this search checkbox. The Frequency field has
three sections, for hours, minutes and seconds. Click on the appropriate section and use the up and down
arrows at the end of the field to set the interval for refreshing the search results. You can also set the refresh
to display a pop-up notification if the search results change. To do this, select the Notify me when new
results found checkbox.

Click on the OK button. The View is created (or updated) in a collapsed state. When you expand the View, the
search executes and populates the View.

Display Recent Postings

If a new post is added to the Team Review, and that post refers to any Model View items, that post is also
added automatically to the Recent Discussions | <Connection> | Recent Posts 1222 folder in the Model View. To
open a post, double-click on the entry; the Team Review tab displays, showing the selected message. You
can control how many posts are displayed, and for what period of time, using the Model Views context menu
1224 for the Recent Discussions folder.

Move Objects Into Favorites

Drag any required package, diagram or element from the Project Browser into the required Favorites folder.

Move Objects Between Views

Views and Favorites folders are fixed in the Views folder in which you create them, and you cannot move
them. However, you can copy (by dragging) objects from any View into any Favorites folder, and move (by
dragging) objects between any two Favorites folders.

Use Objects From Model Views

To make use of the elements, diagrams and packages held in any View or Favorites folder, click on the item
and drag it into a diagram or a Team Review 208 posting. The item behaves in the same way as if you dragged
it from the Project Browser.

Export/Import Views
You export Views to create an XML file that you can:
· Import into another model as a user-created Model View or
· Call from an MDG Technology Selection (MTS) file to access the Technology-defined View provided by the
active MDG Technology.
The export and import functions are available from the Model Views root-node context menus.
When you use the export function, it acts on the complete set of View folders in the selected My Views root
node, Model Views root node, or user-generated root node. You cannot export individual Views, nor can you
export Favorites folders. The function displays the Save As dialog, on which you browse for the directory
location for the exported XML file, and specify the file name.
When you use the import function, it displays the Select Import Filename dialog on which you browse for the
directory and XML file you want to import. The import creates a new Model View folder with the same name as
the copied root node.

Set Up a Technology-Defined View

To set up the Technology-defined View for an MDG Technology, you:
1. Create a user-generated Model View in Enterprise Architect while using the technology
2. Populate it with the required View folders and Views.
3. Export the Views from that Model View as an XML file to an appropriate location

© 1998-2010 Sparx Systems Pty Ltd

 1228 Navigate, Search and Trace | Model Views

4. Create a call to the file from the technology's MTS file 1133 .
Thereafter, any model for which the MDG Technology is active automatically displays those Views in a
Technology-defined View.

6.2.4 Diagram Slide Show

The Slide show facility in the Model Views window enables you to:
· Create screen-based presentations of sets of diagrams
· Run a slide show manually
· Run a slide show automatically with each diagram displaying for a period that you define
· Display the slide show within the Enterprise Architect work area
· Display the slide show in full screen mode.
You create each slide show as a folder 1223 within a Views folder under a Model View node. When you run a
slide show, it displays the diagrams in the folder in the sequence in which they are listed in the folder. After
each diagram has been displayed, it is closed.

Create a Slide Show

To create a slide show, follow the steps below.
1. Under a Model Views node, click on the Views folder to contain the slide show.
2. Either:
· Right-click on the Views folder and select the New Slideshow context menu option or
· Click on the New Slideshow folder icon in the Model Views toolbar.
The Create a new slideshow folder dialog displays.

3. In the Name field, type the name of the slide show.

4. Click on the OK button. The new slide show folder is added to the selected View folder.
5. Dock 76 the Project Browser window separately from the Model Views window.
6. Drag the diagrams to be displayed as part of the slide show from the Project Browser into the new slide
show folder. Organize the diagrams in the order in which they are to be displayed.

Note:
The diagram items in the slide show folder are links to the diagrams in the Project Browser, not copies
of the diagrams or the diagrams themselves. Any actions you take in the slide show have no impact on
the original diagrams.

7. Close the folder.

You can reorganize the diagrams in the slide show using the up/down green arrows 1223 in the Model Views
toolbar.
To remove a diagram that is not required, right-click on it in the slide show folder and select the Remove
Linked Item context menu option.

Define Slide Show Operation

Slide show operation can be automated or manual. To define how the slide show is to operate, follow the
steps below.
1. Right-click on the slide show folder. The context menu displays.
2. Select the Properties context menu option. The Slideshow Properties dialog displays.

Enterprise Architect User Guide

 Navigate, Search and Trace | Model Views 1229

3. If you intend to automate the slide show, select the Enable checkbox. To run the slide show manually,
deselect the checkbox.
4. If you intend to automate the slide show, in the Time field type the number of seconds that each
diagram is to remain on display.
5. Click on the OK button.

Run Slide Show

To run a slide show of diagrams, either in the Diagram View or full screen, follow the steps below:
1. Right-click on the slide show folder. The context menu displays.
2. Select either the:
· Run Slideshow option, to run the slideshow in the Diagram View
· Run Slideshow Fullscreen option to run the slideshow using the full screen.
The first diagram in the slide show displays.
3. If you have set up the slide show to run automatically, you can leave it to display the diagrams as
defined. You can also moderate the slide show using manual commands.
4. If you are controlling the slide show manually, right-click on a slide. A small toolbar displays.

5. Control the slide show using the toolbar icons and other aids, as follows:

To: Click On, or Press

Display the next slide

[Spacebar] or [#]

Display the previous slide

[!]

Display the first slide

[#]

Display the final slide

[$]

Pause the slide show

Resume the slide show

© 1998-2010 Sparx Systems Pty Ltd

 1230 Navigate, Search and Trace | Model Views

To: Click On, or Press

Stop the slide show

(In Diagram View) right-click on the slide show

folder and select the Stop Slideshow context
menu option.

Delete Slide Show

To delete a slide show, right-click on the slide show folder and select the Remove Slideshow context menu
option. Enterprise Architect prompts you to confirm the deletion. The folder and its list of links to diagrams in
the model is removed.

Enterprise Architect User Guide

 Navigate, Search and Trace | Model Search 1231

6.3 Model Search

The Model Search generates a report list that you can view in the main workspace. It lists each object in the
Project Browser that meets the search criteria you specify within the search terms and search type.
For more information on conducting searches see the Use the Model Search 1233 topic.
When you have generated your search results, you can print them or generate an RTF report 1234 on them.
To access the Model Search:
· Select the Edit | Model Search menu option
· Click on a package in the Project Browser and press either [Ctrl]+[Alt]+[A] or [Ctrl]+[F].
The Model Search tab displays.

Sorting and Selecting

In the Model Search you can:
· Sort the items by any column value in ascending or descending order, by clicking on the column header
· Display element or diagram properties, by double-clicking on the item
· Select:
· An element or diagram by clicking on it
· Several individual elements or diagrams by holding [Ctrl] as you click on them
· A range of elements or diagrams by holding [Shift] as you click on the first and last in the range
· All elements or diagrams in the list by pressing [Ctrl]+[A].

The Options Button

The Options button displays the Search Options submenu, which enables you to display the search results
as a tab of the Output 102 window[****] 102 rather than in the Model Search View. An advantage of moving the
search results to the Output window is that you can select items from the search results and drag them onto a
diagram, which you cannot do when the results are in the Model Search View. If you select the Dock in

© 1998-2010 Sparx Systems Pty Ltd

 1232 Navigate, Search and Trace | Model Search

Output Bar menu option, when you next display the menu this option becomes Dock in Main View.

The Search Options submenu also provides the means of performing advanced searches 1235 on your project,
and displaying project metrics 338 . The arrow button to the right of the Options button also enables you to
perform advanced searches.

The Toolbar
The Model Search toolbar enables you to quickly select a number of operations on the search list as a whole,
or selected items.

The options are, from left to right:

· Edit Notes ([Ctrl]+[Spacebar]) - For the selected item, opens the Notes window (if it is not already open)
so that you can edit the text of the notes.
· Delete ([Ctrl]+[D]) - For a selected item or group of items, deletes them from the model; refresh the project
to check that the items have been deleted.
· Print - Prints the complete set of search results.
· Rich Text Report - For a selected item or group of items, generates and prints an RTF report.
· View Notes - Displays a short menu that enables you to select whether, for all items, to:
· Hide any Notes text from display in the search results
· Display the first few words of the Notes text in the search results
· Display the full Notes text in the search results.
· Help - Displays the Enterprise Architect Help, starting with the Model Search Help topic.

The View Header

The View header defines the columns of information that are presented by the Model Search, and the order in
which data items are presented. By right-clicking on the header you display the Field Chooser context menu
option, which in turn displays the Field Chooser dialog. This enables you to add columns from the output.
Between them, the View header and Field Chooser dialog show the full range of column headers available.

Enterprise Architect User Guide

 Navigate, Search and Trace | Model Search 1233

To add a column heading to the View header, drag it from the Field Chooser
dialog onto the header, to the position you want the column of data to display.
When you have selected the column headings you require, click on the red
cross in the top right corner of the Field Chooser dialog to close it.
To remove a column from the output, drag the column heading downwards out
of the View header. A black cross displays on the heading as you move it, and
then both heading and cross disappear when you release the mouse button.
You can also change the sequence of columns, by dragging column headers left
or right.
You can organize the reported data hierarchically according to the value of one
or more of the column categories. For example, you could organize the data by
Type, and within each Type by Status. If you then click on any of the other
column headings, the data within this grouping is further sorted with the values
of the selected column (for example, Created) in ascending or descending order.
To set up the hierarchical grouping, drag the column heading representing the
primary grouping (such as Type) onto the Drag a column header here to
group by that column field. Then drag the column heading for the next level of
grouping (such as Status) to the right of the first heading. The two heading titles
display as connected blocks, as shown below.

You can, if required, add further levels of grouping by dragging other column headings onto the hierarchy, and
restructure the hierarchy by dragging existing or additional headings into the level you want them to hold. For
example, you could make Type the secondary grouping by dragging it to the right of Status, or extend the
hierarchy by dropping Object between Type and Status.
To remove a grouping level, drag the appropriate column heading out of the hierarchy and below the View
header. Any subordinate groupings move up a level.

6.3.1 Use the Model Search

You perform searches within your project using the Model Search 1231 . You search the whole model, unless
you have selected the Current Tree Selection option in the search management panel 1235 . In that case, you
can search within a specific package selected from the Project Browser.

© 1998-2010 Sparx Systems Pty Ltd

 1234 Navigate, Search and Trace | Model Search

In the Search Term field type the text to search for, and in the Search field select the type of search to
perform 1241 (the default being Simple). Click on the Run button to display your results.
You can perform more complex searches and create your own search definitions 1239 . To begin these tasks:
1. Click on the arrow button to the right of the Options button. The search manager panel 1235 displays just
above the search results panel.

External Access to Model Search

You can access the Model Search facilities and perform specific searches indirectly, from Add-Ins, MDG
Technologies, from a hyperlink and from a shortcut to access your model. This entails setting up a search
profile either in the appropriate tool, or as an XML file accessed by the tool.

For information on performing a search See

from:

An MDG Technology Selection (MTS) File Working With MTS Files 1133

(using an exported search definition 1237 )

A Login Shortcut Shortcuts To .EAP Files 115

An Add-In Add-In Search 1781

A Hyperlink Hyperlinks 840

6.3.2 Work On Objects In Search

You can select elements or diagrams in the Model Search and perform various operations on them, as well as
simply dragging the item into a Team Review 213 post.
Right-click on the required object to display the following context menu:

Note:
Not all options are available for a diagram.

Menu Option Use to

Properties Display the Properties dialog for the element.

Enterprise Architect User Guide

 Navigate, Search and Trace | Model Search 1235

Menu Option Use to

Copy Selected to Copy the selected item to the MS Windows clipboard so that it can be pasted to a
Clipboard document, spreadsheet or email.

Documentation Generate an RTF report. You have two options:

· Generate a separate report on each selected object in the Model Search.
· Generate one report on all selected objects.
In either case, the Generate RTF Documentation 1573 dialog displays.

Note:
If you generate the report using a custom SQL search, the SQL must include 1239

ea_guid AS CLASSGUID and the object type.

Create Linked Create 599 (or edit 600 ) a linked document (Corporate, Business and Software
Document [Ctrl] Engineering, Systems Engineering and Ultimate editions).
+[Alt]+[D]
See the Linked Documents 597 topic.
(Edit Linked
Document)

Delete Linked Delete an existing linked document. (Only displays if the element has a linked
Document document.)

Print Print out the filtered results.

Clear Results Clear the search results from the Model Search.

Find in Diagrams Display the diagram that uses the element or, if the element is used in multiple
diagrams, display a list of diagrams to choose from.

Find in Project Highlight the element in the Project Browser.

Browser

Bookmark Selected Bookmark the element.

Delete Selected Delete the selected element from the Model Search.

Close Close the Model Search.

Help Display this Help topic on the Model Search.

6.3.3 Search Definitions

You provide search filters and create new search definitions using the search manager panel. To display this
panel:
1. On the Model Search tab, click on the arrow button to the right of the Options button 1233 . The search
manager panel displays underneath the Search Term and Search fields.

© 1998-2010 Sparx Systems Pty Ltd

 1236 Navigate, Search and Trace | Model Search

Search filters enable you to perform customized searches on a Search Term in order to locate model
elements having specific characteristics. The Search drop-down list provides several pre-defined searches 1241

For ease of use, the list of available searches is separated into built-in searches, user-defined searches 1239

and Add-In searches.

The default is a Simple search, which searches all elements, looking at the Name and Notes fields only. If the
search term is found in the Name field or the Notes field, those elements are displayed.

Important:
The fields listed in a search have an OR relationship when none of the Required checkboxes are ticked; that
is, if the search term is found in any one of those fields, then the element is displayed.
If the search definition includes one field only, the Required checkbox must be selected, otherwise the
search produces incorrect results.

In the Simple search below, the Name and Notes fields both have the Required checkbox ticked, so the two
fields have an AND relationship. The search displays only those elements that contain the search term in both
the Name and Notes fields.

Enterprise Architect User Guide

 Navigate, Search and Trace | Model Search 1237

Note:
Any field having the Required checkbox ticked overrides fields where the Required checkbox is not ticked.

The following search finds elements that must have the search term in the Name field and that might or might
not have the search term in the Notes field.

The search manager toolbar enables you to configure the system-provided searches, and to create and edit
your own searches. The toolbar icons, from left to right, provide access to the following functions:

Option Use to

New Search Create a new search definition, with new search criteria. See Create Search Definitions
1239 .

Save Search Save a modified or new search.

Copy Search Copy the existing search selected in the Search field, to modify.

Restore Default Restore any changed parameters to the default settings and format.

Delete Search Delete the search definition from the Search drop-down list.

Add Filter Add a new set 1242 of parameters to filter the search on.

Remove Filter Delete the selected filter from the search.

Export Search Display a selection box that enables you to select searches to export to an external
directory as an XML Search file.

Import Search Display the Windows Directory Explorer Open dialog to enable you to import searches
as XML Search files from an external directory.

Search Options Display the Advanced Options 1238 dialog, to define where the search should operate and
how the search should match filters.
This icon is available only for searches created with the Query-Builder 1239 , and not for
those created with the SQL Editor 1239 .

You use the main body of the search manager panel to configure the element search filters that are contained
in the selected search. A filter item consists of the element field name (Search In), the conditions placed on
the field value, the actual value or delimiting value to search on, and whether the filter item is required

© 1998-2010 Sparx Systems Pty Ltd

 1238 Navigate, Search and Trace | Model Search

(mandatory). The components are defined in greater detail in the following table:

Column Use to

Search In Select the type and name of each element feature to search on.

Condition 1243 Select the condition of the search parameter. The available options are Contains, Equal
To, Not Equals and One Of.

Look for 1243 Specify the search term to perform the conditional search on. This value can pertain to
the selected element type. For example, the value could be a date for DateCreated or a
text value for other fields. The search term can contain multiple values, separated by
commas.

Required Indicate that the search results must include elements with your search term in that field.

You add the filters by clicking on the Add Filter toolbar icon, to display the Add Filters 1242 dialog.

6.3.3.1 Advanced Search Options

When you click on the Search Options icon on the Manage Searches toolbar, the Advanced Options dialog
displays.

In the Search Scope panel, select either:

· Return matching items for the entire model - the default, to run the search across the entire model, or
· Return matching items for the selected Package - to run the search on a specific package, which you
select in the Project Browser.
Note:
If you select Return matching items for the selected Package, navigating the Project Browser does not
change your search results until you click on the Run button. That is, to search different areas of the project,
click on the first required package in the Project Browser and click on the Run button, check the results, and
then click on another package in the Project Browser and click on the Run button again.

In the Table Filters panel, select either:

· All Tables - to ensure that the search only retrieves elements that match every check in the search
· At least one Table - the default, to ensure that the search retrieves elements that match at least one of the
checks in the search.

Enterprise Architect User Guide

 Navigate, Search and Trace | Model Search 1239

6.3.3.2 Create Search Definitions

Search definitions 1235 are created using the search manager panel. To display this panel:
1. On the Model Search tab, click on the arrow button to the right of the Options button 1233 . The search
manager panel displays underneath the Search Term and Search fields.
To create a new search definition, follow the steps below:
1. Click on the New Search icon in the toolbar. The Create New Search Query dialog displays.

2. In the Search Name field, type a name for your new search.
3. Select the radio button for the type of search you require:
· The Query Builder 1239 option provides an interface that enables you to design your own search.
· The SQL Editor 1239 option enables advanced users to directly write SQL Select statements.
· The Add-In Search 1241 option enables you to supply the name of your Add-In and a method (for
example MyAddin.RunThisMethod). This method is called whenever the search is run. This search
can be exported and distributed as a part of your Add-In. For more information, see Enterprise
Architect Add-In Model 1776 .
4. Click on the OK button.

Note:
User-defined searches are stored in the Program Files directory, and not in the project repository.

Query Builder
Your search definition now appears as being selected in the Search drop-down field. You can now click on
the Add Filter toolbar icon to Add Filters 1242 .

SQL Editor
The Custom SQL dialog displays, enabling you to input your SELECT statement. The SQL editor is based on
the common Code Editor, and provides an intellisense autocompletion list populated with Enterprise
Architect's repository structure. You can display the autocompletion list by pressing [Ctrl]+[Spacebar].
For more details on intellisense and the common Code Editor, see the Code Editors 1428 topic.

© 1998-2010 Sparx Systems Pty Ltd

 1240 Navigate, Search and Trace | Model Search

Enterprise Architect also enables you to use #xxx# macros as string replacers in WHERE statements, so that
the same search can be used by different people in different environments. These macros include:
· #WC# - Gets the appropriate wild card for the current database, and so enables the search to be
performed on models on different databases; for example, t_object.Name LIKE '#WC#Test#WC#'
· #Author# - Takes the value of the Author field in the Options dialog General page, and enables the defined
search to be performed on objects created by that user (this value can be manually re-set in the Options
dialog)
· #DB=<DBNAME># where <DBNAME> can be one of the following:
· MYSQL
· JET
· ORACLE
· SQLSVR
· ASA
· OPENEDGE
· POSTGRES.
For example, #DB=ORACLE# t_object.ModifiedDate >= (SYSDATE - INTERVAL '<Search Term>'
DAY)
· #UserName# - Gets the name of the person logged into version control; for example,
t_package.PackageFlags LIKE '#WC#VCCFG=#WC#CheckedOutTo=#UserName##WC#' (this is from
Enterprise Architect's built in search My Checked Out Packages).

Note:
For all Enterprise Architect functions in which you use a custom SQL statement (such as RTF reporting or
Model Views) the statement must return the guid and type of the object found so that Enterprise Architect can
search for the selected item in the Project Browser. For example:
SELECT ea_guid AS CLASSGUID, Object_Type AS CLASSTYPE, Name FROM t_object

You can extend the usability of your SQL searches using the aliases CLASSGUID and CLASSTYPE. These
enable Enterprise Architect to display the Properties dialog and icon for elements, connectors, attributes or
operations, as well as selecting them in the Project Browser. Some simple examples for using these aliased
fields are provided below:
SELECT ea_guid AS CLASSGUID, Object_Type AS CLASSTYPE, Name FROM t_object
SELECT ea_guid AS CLASSGUID, Connector_Type AS CLASSTYPE, Name FROM t_connector
SELECT ea_guid AS CLASSGUID, 'Operation' AS CLASSTYPE, Name FROM t_operation
SELECT ea_guid AS CLASSGUID, 'Attribute' AS CLASSTYPE, Name FROM t_attribute.
When you have defined the SELECT statement, click on the Save button to save this search. The search is

Enterprise Architect User Guide

 Navigate, Search and Trace | Model Search 1241

then available from the Search drop-down list.

Add-In Search
Type in the field the name of your Add-In, a period (full stop) and then the name of the method to be called (for
example, MyAddin.RunThisMethod). Your search is automatically saved and available from the Search drop-
down list.

6.3.3.3 Pre-defined Searches

The following pre-defined searches are provided with Enterprise Architect, and are listed in the Built-In
category in the Search drop-down list.
· Simple - Searches the Name, Alias and Notes fields of all elements for the given Search Term.
· Element Name - Searches for an exact match against the element name, alias, method or operation; the
default search in the Search in Model 1437 menu option.
· Extended - Searches many additional fields relating to the element, including Attributes, Operations,
Tagged Values and Test Cases.
· Attribute Details - Searches for elements with attributes relating to the Search Term, including Tagged
Values, constraints, and common attribute data fields.
· Find Orphans - Searches for orphaned elements throughout the model, with the ability to filter on common
element fields using a search term. An 'orphaned' element is an element that does not appear on any
diagram in the model.
· Failed Internal Tests - Searches for elements containing internal test cases where the Search Term is in
any common Test Case field and the Status value is 'Fail'.
· Method Details - Searches for elements with operations and methods relating to the Search Term,
including Tagged Values, constraints and common operation and method data fields.
· Responsibility - Searches for elements with internal responsibilities/requirements where the Search Term
relates to any common Responsibility/Requirement field.
· Resources - Searches for elements with assigned resources where the search term relates to any
common Resource field.
· Requirements - Searches for Requirement element types where the search term relates to any common
element field.
· Find Bookmarked Elements - Searches for elements that have been bookmarked, anywhere in the
project.
· Recently Modified Elements - Searches for elements that have been recently modified, anywhere in the
project. The Search Term relates to any common element field. The default is to show elements modified
in the last three days, but you can set an alternative interval by typing the appropriate number of days in
the Search Term field.
· Recently Modified Diagrams - Searches for diagrams that have been recently modified, anywhere in the
project. The Search Term relates to any common diagram properties field. The default is to show diagrams
modified in the last three days, but you can set an alternative interval by typing the appropriate number of
days in the Search Term field.
· My Checked Out Packages - Searches for packages that are marked as checked out by the
currently-logged in user.

© 1998-2010 Sparx Systems Pty Ltd

 1242 Navigate, Search and Trace | Model Search

6.3.3.4 Add Filters

Click on the Add Filter icon in the search manager panel 1235 or the Add Filter button on the Generate RTF
Documentation 1573 dialog. The Add Filters dialog displays.

Option Use to

Search On Select items to build up search filters on any information about an object.
The following is a list of what is available, before you have defined a search.

If you are adding filters to an existing search, the list contains only items appropriate
to the initial filter. For example, if the initial filter is on diagram properties, the list for
any subsequent filters for the search only contains the Diagram option.

Include Select each field item to include in your search (select the checkbox).

Field Identify the name of the field to search. See Fields and Conditions 1243 . The list
presents items specific to the filter Search On item.

Enterprise Architect User Guide

 Navigate, Search and Trace | Model Search 1243

Option Use to

Condition Specify the condition of the search parameter. See Fields and Conditions 1243 .

Value Type a value pertaining to the selected element field. For example, the value could
be a date for DateCreated or a text value for other fields. The search term can
contain multiple values separated by commas; see Fields and Conditions 1243 .

Required Select a particular field to generate a result set that must contain your search term in
that field.

Check All Select all the items to include them in the search definition.

Uncheck All Deselect all the items to omit them from the search definition.

OK Apply the filter. The fields selected are added to the search definition.

You can add multiple search definitions as necessary. Note that if you select the Required field in multiple
definitions the search rapidly becomes impractical. Multiple search definitions are better for 'and/or' searches.

See Also
· Create Search Definitions 1239

6.3.3.4.1 Fields and Conditions

When you click on a condition for a particular field, a selection of condition options becomes available, as
shown in the following example:

For some conditions, the value field contains an ellipsis ( ). Click on this to display a selection dialog.
Examples of selection dialogs are shown below.

Example Selection dialog for One Of section Date Selection dialog for Before or After section

Date selection from the drop-down

© 1998-2010 Sparx Systems Pty Ltd

 1244 Navigate, Search and Trace | Model Search

See Also
· Create Search Definitions 1239

· Add Filters 1242

Enterprise Architect User Guide

 Navigate, Search and Trace | Traceability 1245

6.4 Traceability

Traceability identifies the way a given process has been, or is to be, developed in a system. The process can
be an internal, model-management process, where you monitor work by asking questions such as 'what work
has been done to realize this Requirement or Use Case?', or a business or system process that is being
modeled, where you ask questions such as 'what Requirements, Use Cases, Classes, Components, Test
Cases and other elements define the implementation and deployment of this process?'
Traceability also helps to clarify the aspects of a process that the model does not address. A process typically
includes a range of manual, automated and external procedures. A correctly-structured model illustrates
exactly what requirements and functionality service a particular process; any missing functionality must come
from other systems, developments or procedures.
There are various tools in Enterprise Architect that enable you to trace the definition and implementation of a
process from initial requirement to generated code or technical deployment, or vice versa. If you have
performed any Transformations 1385 in developing your model and code, Enterprise Architect automatically
creates Transformation Dependency 1385 connectors that you can trace - with the Traceability 1253 window - to
establish what objects and code have been generated from each PSM element, or what the initial PSM
element was for a generated object. Whether you use transformations or develop the stages of the model in
other ways, you can build up a range of Traceability diagrams 1250 (Custom diagrams) to identify the
development pathway and the dependencies between entities such as Requirements, Use Cases, Classes,
Packages, Test Cases and other model artefacts, or possibly between these entities and the overall business
process model 933 .

Maintaining Traceability
The following Project Browser hierarchy represents a model that is structured to enable traceability. Notice
firstly that themes are developed in the structure - the Requirements Model, Use Case Model and Abstract
Implementation Model each contain units with the same functional names, such as Manage Users and
Manage Inventory. These units help you to quickly develop a Traceability Model within your project, to trace
development and implementation.

© 1998-2010 Sparx Systems Pty Ltd

 1246 Navigate, Search and Trace | Traceability

Traceability in this model is examined further in the following topics:

· Packages and Elements 1246
· Create Traceability Diagrams 1250

· Traceability Tools 1251

6.4.1 Packages and Elements

Analyzing the requirements of a system or process helps you identify units of functional activity in that system
or process. You can represent these units with Packages, which you then populate with elements of relevance
to the functional units and to the stage of development.
In the following four diagrams, you can see how Requirements and Use Case Packages are created to group
the Requirements elements and Use Case elements that define and start to implement each of several
functional areas. By maintaining the same structure in each model in the project (as discussed in the
Traceability 1245 topic), you also make it easy to trace the project development through the stages.

Enterprise Architect User Guide

 Navigate, Search and Trace | Traceability 1247

Requirement Packages for Online Bookstore Process

Requirements in Manage Users Unit of Online Bookstore Process

The Requirements diagram also makes it clear what Requirements form subsets of others, or are components
of more than one other Requirement.

© 1998-2010 Sparx Systems Pty Ltd

 1248 Navigate, Search and Trace | Traceability

Use Case Packages For Online Bookstore Process

Enterprise Architect User Guide

 Navigate, Search and Trace | Traceability 1249

Use Cases in Manage Users Unit of Online Bookstore Process

The Use Case diagrams can also clarify what aspects of a process require or enable human intervention, and
which require or enable system intervention.

Implementation Stage
For completeness, you could also consider the next stage, the implementation of some of these Use Cases,
as represented by Class elements associated with this functional unit.

© 1998-2010 Sparx Systems Pty Ltd

 1250 Navigate, Search and Trace | Traceability

6.4.2 Create Traceability Diagrams

Having structured the models of a project to indicate directions and theoretical relationships between the
models and packages, you can formalize these directions on a Traceability diagram, using Realize 889 , Trace
892 and similar relationships.

You initially create a Traceability diagram as a Custom 734 diagram, but if you are creating the diagram
manually you can use elements and relationships from other Toolbox pages to develop the diagram as broadly
as is necessary.

Enterprise Architect User Guide

 Navigate, Search and Trace | Traceability 1251

You can also generate the diagram using the Add | Related Elements context menu option 551 to
automatically bring in elements linked to the selected element. It is probably better to add the elements in
stages, one level at a time, but you could add several levels in one go to see how far the hierarchy extends
and to identify relationship and element types to exclude from the 'clean' diagram. You could perform a similar
operation, one element at a time, using the Relationships 1269 window.
The above diagram instantly shows how two levels of Requirements are realized by Use Cases, and which
Requirement is realized by which Use Case(s). It also shows how some of the Use Cases are implemented by
Class elements. Further, you can drill down on the Use Cases (or, in other Traceability diagrams, any other
composite elements) to display more detailed diagrams showing how the Use Case meets the Requirement.
The Close Account Use Case, for example, contains a Communication diagram and a Sequence diagram.
You can tailor your Traceability diagrams to depict any level of granularity and any stages of development that
are appropriate. You might narrow the above diagram, for example, to show development from just the
Remove User Requirement, and extend it to include Interfaces, Components, Test Case elements or any other
facet of the system or process.
Whilst the Traceability diagram itself provides information on the definition, design and implementation of a
business process feature, much more information can be obtained using tools 1251 such as the Relationships
Matrix and relationships Traceability window.

6.4.3 Traceability Tools

The model structure 1246 and Traceability diagram 1250 act as starting points for tracing the definition, design
and implementation of a feature of a system or process. By applying tools such as the Relationship Matrix and
Traceability window to these, you can follow threads throughout the model to determine how the feature is
implemented and tested. You can also obtain information on what elements realize and are realized by the
elements in a given package, using the Dependency report 1624 and Implementation report 1626 , respectively.

© 1998-2010 Sparx Systems Pty Ltd

 1252 Navigate, Search and Trace | Traceability

Traceability Window
The Traceability 1253 window is a most useful and versatile traceability tool. Starting with a Traceability diagram
or a package structure in the Project Browser, you can use the Traceability window to quickly explore the
relationship chain of which any element is a component. When you click on the element, it immediately
becomes the top point in the Traceability window. When you click on the background of a diagram, all
elements in the diagram are listed in the Traceability window, and you can follow the threads starting at each
element through the diagram.
If you require a rapid, broad-brush view of relationship flows in the project structure, starting with a general list
of - say - all functional Requirements, you can use a combination of Model Search 1231 , Project Browser and
Traceability window; this is a powerful tool for scanning your project, identifying how elements have been
organized, and how they interact. For example, the Model Search would list all the requirements, you could
rapidly click on each element and immediately see in the Project Browser where it has been grouped, and at
the same time - in the Traceability window - how that element interacts with other elements in the model.
You can select any or all of the relationship types available in the Traceability window toolbox. The single type
selected below is Realizes (Implements), and the selected element is the Delete User Use Case. The
Traceability window then shows that Delete User implements REQ017, but this is also partially realized by the
Close Account Use Case.

By moving the cursor around a diagram or the Project Browser, and/or changing the relationship type
combinations in the Traceability window, you can quickly see how elements are connected and how they
influence each other. For example, you can see that REQ017 is realized by two Use Cases, so you might then
explore what else influences and is influenced by these two Use Cases. The Traceability window takes you
well beyond what is likely to be depicted on any single diagram.
If you have used transformations to develop your model, the T icon displays the transformation dependencies
that exist between an element in a PIM and elements in the PSMs.

Relationship Matrix
Using the Relationship Matrix 1261 , you can both create and study the relationships between, for example, the
Requirements and Use Cases for a module. You might identify the 'theme' package (in this case, Manage
Users) in the Requirements model and the Use Case model as the source and target packages, and explore
the likely element and connector types in the packages. This, like the Traceability diagram, identifies which
Requirements are (or should be) realized by which Use Cases. You can then perform similar checks with the
Manage Users packages in, say, the Use Case and Implementation models.
The Source and Target field browsers ([ ... ]) enable you to examine child packages within the 'theme'
package, and obtain further detail on how the feature at this stage is defined.

Enterprise Architect User Guide

 Navigate, Search and Trace | Traceability 1253

Other Tools
You can also obtain information on what elements realize and are realized by the elements in a given
package, using the Dependency report 1624 and Implementation report 1626 , respectively.
You can trace how a Class or Interface element in a diagram or the Project Browser is implemented in code
or, for tables, in DDL, using the Source Code viewer 1441 . For code, as you click on features in the element, the
corresponding code is highlighted in the viewer.
From the perspective of model management or project management, you could also use the Audit View 270 as
a means of tracing the change history of a package or element. The Relationship Matrix also assists in this
respect, indicating the impact of changes in one element on others. A Use Case exists because it defines how
a Requirement is met; if the Requirement is changed, the Use Case and its dependent diagrams and
elements should probably be changed, if not deleted.

6.4.4 The Traceability Window

Access: View | Traceability.
The Traceability window shows a mini picture of the composition of the current element with respect to other
elements.
This information is derived from relationships with child or related Classes. Relationships shown in the
hierarchy include Aggregation, Inheritance and Dependency; embedded elements are also shown. This helps
extend the picture of where an element exists in the model space.
Display of each type of relationship is optional, and can be toggled using the window toolbar. Roll the cursor
over each toolbar icon to display the types of relationship that the icon filters. For example, T filters the
hierarchy to display Transformation Dependencies 1385 , and R filters for Custom References 527 .

© 1998-2010 Sparx Systems Pty Ltd

 1254 Navigate, Search and Trace | Traceability

If you open a diagram and click on the diagram background, the Traceability window lists all the elements in
the diagram. As above, you can expand the display for each individual element to show the relationships and
related elements for that element. This is useful, especially in large and complex diagrams, for exposing
threads through the diagram and indicating what might be impacted by changing or deleting the element or a
connector.

Enterprise Architect User Guide

 Navigate, Search and Trace | Element List 1255

6.5 Element List

The Element List is a tabular, editable view of elements that can be displayed in the main workspace. You can
use the Element List to streamline the process of creating and updating elements in a package or diagram
selected from the Project Browser. This can be particularly useful for analysts to create and maintain formal
requirement definitions within the model. You can also print the list or generate an RTF document 1259 directly
from the entries on the Element List.
To access the Element List, either:
· Select a diagram or package in the Project Browser and select the View | Element List main menu option
· Select a diagram or package in the Project Browser and press [Ctrl]+[Alt]+[R]
· Right-click on a diagram or package in the Project Browser and select the View Diagram As List or View
Package As List menu option
· Right-click on the background of an open diagram and select the Switch to List View context menu option
The Element List tab displays, showing the element information for the selected package or diagram. There
are two possible formats that you can switch between using the Show Hierarchy button ( ) in the toolbar:
· User-Defined format - as shown below, where you determine how the element information is structured on
the screen, using the value-grouping 1258 band below the toolbar

© 1998-2010 Sparx Systems Pty Ltd

 1256 Navigate, Search and Trace | Element List

· Model Hierarchy format - as shown below, where the package and element hierarchies are represented in
the display.

In the Element List you can:

· Sort the items by any column value in ascending or descending order, by clicking on the column header;
initially the elements are listed in numerical order (if level numbering is turned on in the Project Browser) or
alphabetical order within type

Enterprise Architect User Guide

 Navigate, Search and Trace | Element List 1257

· In User Defined format, change the filtered structure of the information in the list; see Value Grouping 1258 ,
below
· Change the sequence of columns, by dragging column headers left or right
Note:
In Model Hierarchy format, the Name column is always on the left; you cannot move any other column into
that position, although you can rearrange the order of the rest of the columns. Because of this, if you
group or sort information in User Defined format and switch to Model Hierarchy format your information
structure is altered, and it is not restored when you switch back to User Defined format.

· Display the Properties dialog for an item by double-clicking on the item entry
· Select:
· an element by clicking on it
· a specific value by clicking twice on it (not double-clicking); either the value becomes directly
editable or the Properties dialog displays in which you can edit the value
· several individual elements by holding [Ctrl] as you click on them
· a range of elements by holding [Shift] as you click on the first and last in the range.
· Add new items to the package covered by the Element List, by clicking on a listed element and pressing
[Ctrl]+[N] or [Insert], or right-clicking and selecting the Add New context menu option
· in Model Hierarchy format, new elements are inserted in the order in which they appear in the
Project Browser
· in User Defined format, new items are inserted to comply with any sort order and/or grouping; if the
list is not sorted or grouped, the items are added to the end.
· In Model Hierarchy format, you can add a child element to the selected element by pressing [Esc] and
then [Ctrl]+[N]; otherwise, elements are added as siblings of the selected element
Note:
You can add child elements only when the whole row is selected, with none of the row cells or fields
highlighted. Press [Esc] to remove selection from an individual cell.

· Automatically add elements to a diagram by generating the Element List on the diagram and adding
elements to the list
· Delete elements from the list by selecting the item and pressing [Ctrl]+[D].
Note:
In Model Hierarchy format, you cannot delete a parent element until all its child elements have been
removed or deleted.

You can also include each element's notes 1259 (documentation), which are shown underneath the element.
You can add or edit notes by clicking on the item and pressing [Ctrl]+[Space]. This transfers control to the
Notes window, in which you create or edit the note text.
If it is necessary to review the element's custom (advanced) properties, click on the item and press [Ctrl]
+[Enter]. This displays the Custom Properties dialog for the element.
You can do further work on the Element List using the toolbar and context menu options 1258 .

The View Header

© 1998-2010 Sparx Systems Pty Ltd

 1258 Navigate, Search and Trace | Element List

The View header defines the columns of information that are presented by the
Element List, and the order in which data items are presented. By right-clicking
on the header you display the Field Chooser context menu option, which in turn
displays the Field Chooser dialog. This enables you to add or remove columns
from the output. Between them, the View header and Field Chooser dialog show
the full range of column headers available.
To add a column heading to the View header, drag it from the Field Chooser
dialog onto the header, to the position you want the column of data to display.
When you have selected the column headings you require, click on the red
cross in the top right corner of the Field Chooser dialog to close it. If you want to
remove a column from the output, drag the column heading to below the View
header.
You can also change the sequence of columns, by dragging column headers left
or right.

Value Grouping
You can organize the reported data according to the value of one or more of the column categories. As in the
illustration at the start of this topic, you might organize the data by Type, and within each Type by Name. If you
then click on any of the other column headings, the data within this grouping is further sorted with the values of
the selected column (for example, Created) in ascending or descending order.
To set up the value grouping, drag the column heading representing the primary grouping (such as Type) onto
the Drag a column header here to group by that column field. Then drag the column heading for the next
level of grouping (such as Name) to the right of the first heading. The two heading titles display as connected
blocks, as shown below.

You can, if required, add further levels of grouping by dragging other column headings onto the hierarchy
(such as Status), and restructure the order by dragging existing or additional headings into the level you want
them to hold. For example, you could make Type the secondary grouping by dragging it to the right of Name,
or drop Status between Type and Name.
To remove a grouping level, drag the appropriate column heading out of the sequence and below the View
header. Any subordinate groupings move up a level.

6.5.1 Element List Options

Toolbar Options
You can also add to or influence what information is displayed on the Element List by clicking on the following
icons in the toolbar to:

· - add a new element 524 to the diagram and/or package ([Ctrl]+[N])

· - display the Notes window, to add or edit notes for the selected element ([Ctrl]+[Space])

· - delete the selected element ([Ctrl]+[D])

· - print the current contents of the Element List

· - display the Generate RTF Documentation dialog, to create an RTF report 1573 on the selected element
(s)

· - select the appropriate element type from a list (click on the drop-down
arrow), or All to list all objects; the report then lists only elements of that specific type

· - select a UML, Extended or MDG Toolbox category to specify the category of elements shown in the
filter list (above)

Enterprise Architect User Guide

 Navigate, Search and Trace | Element List 1259

· - toggle between including child packages and their contents in the list, and showing only the first-
level contents of the selected diagram or package

· - toggle the display between model hierarchy format and user-defined value-grouping 1257 format

· - display a short menu from which you can select to hide the contents of the Notes compartment of
each element, display the first few words, or display the full text.

· - display Help on the Element List.

Audit History
In the Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of
Enterprise Architect, if Auditing 270 is turned on and the Element List is open, you can view a history of
changes to any selected element or connector, in the Audit History 278 tab of the Output 102 window. (If
security is enabled, you must have at least Audit View 198 permissions to display the audit history).

Work on Elements in the Element List

You can also use the context menu to perform operations on elements in the Element List. Right-click on the
required element to display the context menu. The menu options are described below:

Menu Option & Use to

Function Keys

Properties Display the Properties dialog for the selected element.

Edit Notes [Ctrl] Add or edit notes on the element, in the Notes window.
+[Space]
Add New If the Filter List field in the toolbar is set to All, display the New Element dialog,
through which you create an element of the required type.
If the Filter List field is set to a specific element type, this option adds an element
of that type to the package or diagram in the Element List, the Project Browser and
the Diagram View.
Switch to Diagram If you have opened the list for a diagram in the Project Browser, show the elements
View as the diagram instead of as the Element List.

Find in Diagrams Display the diagram that uses the element or, if the element is used in multiple
diagrams, display the Element Usage 526 dialog, which lists the diagrams that
contain the element.
Find In Project Highlight the selected element in the Project Browser.
Browser
Bookmark Item Bookmark the element.
Create Linked Create 599 (or edit 600 ) a Linked Document (Corporate, Business and Software
Document [Ctrl]+[Alt] Engineering, Systems Engineering and Ultimate editions).
+[D]
See the Linked Documents 597 topic.
(Edit Linked
Document)
Delete linked Delete an existing linked document. (Only displays if the element has a linked
document document.)

Documentation Generate an RTF report. You have two options:

· Generate a separate report on each selected object in the report
· Generate one report on all selected objects.
In either case, the Generate RTF Documentation 1573 dialog displays.
You also have the option to print out the Element List itself.
Alternatively, select the Rich Text Report icon in the Element List toolbar. This
generates one report for all selected items.

© 1998-2010 Sparx Systems Pty Ltd

 1260 Navigate, Search and Trace | Element List

Menu Option & Use to

Function Keys

Diagram Properties Display the Diagram Properties 423 dialog for the diagram.
Sort Contents In Model Hierarchy format, synchronize the list with the Project Browser hierarchy,
to ensure that all element and package hierarchies and sequences are - if
necessary - updated. (Normally changes are updated automatically, but there can
be delays if changes are made outside the Element List).
Reload Reload the element list to refresh the order and content with any recent changes.
Print Print the Element List.
Delete Selected Delete the selected element from the Element List.
Alternatively, select the Delete Selected icon in the Element List toolbar.

Enterprise Architect User Guide

 Navigate, Search and Trace | Relationship Matrix 1261

6.6 Relationship Matrix

The Relationship Matrix is a spreadsheet display of relationships between model elements within packages.
You select a source package and a target package, the relationship type and direction, and Enterprise
Architect identifies all the relationships between source and target elements by highlighting a grid square and
displaying an arrow indicating the direction of the relationship.

Note:
The direction is a reflection of which elements are the source elements and which are the target. It does not
indicate the Direction property of the connector, as defined in the connector Properties dialog.

The Relationship Matrix is a convenient method of visualizing relationships quickly and definitively. It also
enables you to create, modify and delete relationships between elements with a single mouse click - another
quick way to set up complex sets of element relationships with a minimum of effort.

If you click on a square in the matrix, the square, the row headers and the column headers are highlighted, as
shown in the example above. The example also illustrates the 'bent arrow' icon, indicating that connectors
exist in both directions between the source and target elements.
The relationship squares in the example are green. This indicates that the source element is not locked
(because the parent package has not been checked in under version control 263 ). If the element is locked (the
parent package has been checked in) the highlight is pink, as follows:

© 1998-2010 Sparx Systems Pty Ltd

 1262 Navigate, Search and Trace | Relationship Matrix

For information on accessing the Relationship Matrix, see the Open the Relationship Matrix 1262 topic.
You can also:
· Select options 1265 for modifying the type of information the Relationship Matrix displays
· Update, delete and create 1266 relationships through the Relationship Matrix
· Export the contents of the Relationship Matrix to a CSV file 1267 or to a .png or .emf 1265 file
· Print the contents 1265 of the Relationship Matrix, scaled down if required
· Save a profile 1267 of the Relationship Matrix settings to monitor development of the same source and target
packages
· Investigate the Source and Target elements 1268 in the relationship.

6.6.1 Open the Relationship Matrix

To open the Relationship Matrix you can:
· Select the View | Relationship Matrix menu option
· Right-click on any package in the Project Browser, and select the Documentation | Open in Relationship
Matrix | As Source or As Target context menu option.
Once the Relationship Matrix opens you can:
· Set the source and target packages 1264
· Select which element type to show 1262
· Select connector type and direction to show 1263

The Relationship Matrix refreshes after every change you make to the input parameters.

Tip:
The Relationship Matrix includes ALL child elements in a hierarchy. Sometimes in a large model this can be a
lot of elements, possibly too many to be useful. Take care in selecting the source and target package.

6.6.2 Set Element Type

The Relationship Matrix can show all element types, or you can specify which type to show.
To set the element type, follow the steps below:
1. Click on the Type drop-down arrow for the Source or Target package.
2. Find the required connector in the list and click on it. Enterprise Architect refreshes the Relationship
Matrix content.

Enterprise Architect User Guide

 Navigate, Search and Trace | Relationship Matrix 1263

6.6.3 Set Connector Type and Direction

The Relationship Matrix requires that you set the connector type to report on and the connector direction. To
do this, follow the steps below:
1. Click on the Link Type drop-down arrow to display a list of connector types.

2. Scroll through the list and click on the appropriate connector type.
3. Click on the Direction drop-down arrow to display a list of directions.
4. Scroll through the list and click on the appropriate direction.
Enterprise Architect refreshes the Relationship Matrix content.

Notes:
· If you set Direction to Both, each relationship is indicated by two arrows - a From-To arrow and a To-From
arrow. See the screen illustration in the Relationship Matrix 1261 topic.
· The direction is a reflection of which elements are the source elements and which are the target. It does
not indicate the Direction property of the connector, as defined in the connector Properties dialog.

© 1998-2010 Sparx Systems Pty Ltd

 1264 Navigate, Search and Trace | Relationship Matrix

6.6.4 Set Source and Target Package

You must set both the source and target packages for the Relationship Matrix before relationships can be
displayed.

Tip:
You set the source and target packages AFTER setting the connector and element types/details; as
Enterprise Architect refreshes the content after each change, this is usually faster.

Set the Source or Target Package

To set the source or target package, follow the steps below:
1. In the Project Browser, click on the required source package, then press [Ctrl] and click on the required
target package, to select the two packages together.
2. Drag the selected packages over the Source and Target fields; the first-selected package name
displays in the Source field, and the second-selected package name displays in the Target field.
You can also select and drag a single package name over the required field, to change just the source or the
target package. If you drop the package name anywhere else on the Relationship Matrix, the system prompts
you to specify whether to add it to the Source or Target field.
Alternatively:

1. Click on the [ ... ] (Browse) button at the end of the Source or Target field.

2. The Browse Project dialog displays.

3. Select the required package and click on the OK button.

Enterprise Architect User Guide

 Navigate, Search and Trace | Relationship Matrix 1265

6.6.5 Relationship Matrix Options

The Relationship Matrix provides a menu of options that enable you to:
· Output 1265 the information on the Relationship Matrix to the printer or to a metafile, .png file or .csv file 1267

· Create and update profiles of the configurations of the matrix 1267 that you have designed
· Define local settings 1265 to control what the Relationship Matrix displays.

Output Relationship Matrix Information

Click on the Options button on the Relationship Matrix and click on the Matrix menu option. The following
submenu displays:

Print Relationship Matrix

To print a WYSIWYG representation of the Relationship Matrix contents, click on the Print option. The Print
dialog displays, on which you select the output printer and specify the printer properties, the range of pages to
print, and the number of copies.
If you want to check what the matrix might look like on the page before you print, click on the Print Preview
menu option. This displays the Print Preview 395 screen.

Scale Printout
When you print the Relationship Matrix, by default it prints on as many pages wide and long as the matrix
requires. You can scale the printout into a fixed number of pages wide, and the row height is automatically
adjusted to maintain the proportions of the matrix. This reduces the overall size of the printout and improves
appearance, especially when used in conjunction with the Landscape option in the printer properties. For
example, a 16-page printout without scaling can, with a scaling of 2 pages wide, be reduced to 6 pages.
To set the page scaling, click on the Scale Setting menu option. The Scale Matrix dialog displays.

Select the Scale Matrix Width Into Pages checkbox, and type or select the number of pages in width to scale
to. Click on the OK button to apply the setting.

Save Relationship Matrix as Graphic File

To save the current Relationship Matrix output as a graphic, click on the Save as Metafile or Save as PNG
options. A Browser dialog displays that enables you to select the target file location and specify the filename of
the .emf or .png file in which to save the output.
You can incorporate these files in an RTF or HTML report, as a hyperlinked file or an included file.

Manage Display Content

Click on the Options button on the Relationship Matrix and click on the Options menu option. The Matrix

© 1998-2010 Sparx Systems Pty Ltd

 1266 Navigate, Search and Trace | Relationship Matrix

Options dialog displays.

Select from the following options:

· Include Source Children - to recursively include child packages and contents under the Source
· Include Target Children - to recursively include child packages and contents under the Target
· Include All Extended Meta Types - to include elements that are extensions of a specified meta-type. For
example, if there are Block elements (extending Class) in the package, selecting this option and specifying
the type Class includes Class and Block elements, and any further derivatives of Block in the matrix.
· Sort Axes - to ensure package elements display in alphabetical order
· Show Package Names - to hide or show package names in the Relationship Matrix; this is useful for
shortening the displayed texts, especially in circumstances where packages have long names
· Use Element Alias If Available - to display an element's alias instead of the element name, if an alias has
been defined
· Show Level Numbering If Available - to reproduce level numbering in the Relationship Matrix, if it is
turned on in the Project Browser; see the screen illustration in the Relationship Matrix 1261 topic.

6.6.6 Modify Relationships in Matrix

You can modify or delete relationships, or create new relationships, directly from the Relationship Matrix.

To Modify or Delete Relationships

Right-click on a highlighted relationship to open the context menu, and select from the following options:
· View relationship - opens the Properties dialog for the selected relationship
· Source element properties - opens the Properties dialog for the source element
· Target element properties - opens the Properties dialog for the target element
· Delete relationship.
If you have selected Delete relationship, Enterprise Architect prompts you to confirm this action.

Note:
The Delete relationship option does not work if:
· The source element (that is, the owner) is locked
· You have selected Both in the Direction field - you are effectively trying to delete half a relationship.

If you have selected one of the other options, modify any properties as required, and click on the OK button to
save the changes.

To Create a New Relationship

1. Select the required relationship type in the Link Type field.
2. Right-click on the empty intersection of the source row and target column to display the context menu.

Enterprise Architect User Guide

 Navigate, Search and Trace | Relationship Matrix 1267

3. Select the Create new relationship... option; a submenu displays, listing the types of relationship you
can create.
4. Click on the required type of relationship to create a new connector between the two elements.

Tip:
Use the matrix relationship management features to quickly create and manage relationships like Realization
and Aggregation between Requirements and implementation elements (such as Use Cases).

6.6.7 Export to CSV

The contents of the Relationship Matrix can be exported to a CSV file. This provides a convenient mechanism
for moving the matrix data to a spreadsheet environment such as Microsoft Excel. (This option is also active in
the 'Lite 15 ', read-only version of Enterprise Architect.)
To export to CSV, follow the steps below:
1. Click on the Options button on the Relationship Matrix to display the context menu.
2. Select the Matrix | Export to CSV menu option. The Windows Browser dialog displays.
3. Browse to the required file location and type in a .CSV filename to export to.
4. Click on the Save button to export the data.

6.6.8 Matrix Profiles

To save a certain Relationship Matrix configuration as a named profile for later recall, follow the steps below:
1. Set up the Relationship Matrix as required, with source and target, element types and relationship
types.
2. Click on the Options button on the Relationship Matrix to display the context menu, then select the
Profiles | Save as New Profile menu option.
3. In the Enter Value field, type a profile name of up to 12 characters. Click on the OK button.
Once you have created a profile, you can select it from the drop-down list in the Profile field at the top of the
Relationship Matrix screen.
You can also select an existing profile, modify it on the Relationship Matrix screen, then save it under the
same profile name by selecting the Profiles | Update Current Profiles menu option.

To delete an existing profile, select it in the drop-down list and select the Profile | Delete Current Profile
menu option.

© 1998-2010 Sparx Systems Pty Ltd

 1268 Navigate, Search and Trace | Relationship Matrix

6.6.9 Review Source and Target Elements

As well as providing information on connectors and relationships, the Relationship Matrix enables you to
obtain information on the source and target elements in a relationship.
To help you quickly identify which source or target elements have relationships with a particular element, you
can highlight the entire row or column for the element by clicking on the element name in the row or column
titles. If the list of elements is long, you can scroll across or down the highlighted row or column and quickly
identify where the relationships are.
If you right-click on an element name in the row or column titles, the following context menu displays:

This enables you to:

· Display the Properties dialog for the selected element
· Display either the only diagram in which the element is used, with the element highlighted, or a list of the
diagrams in which the element is used; you then select and open a diagram from the list
· Locate and highlight the element name in the Project Browser
· Make the selected element the context or focus in any docked screens or windows that are open, such as
the Tagged Values window.

Enterprise Architect User Guide

 Navigate, Search and Trace | The Relationships Window 1269

6.7 The Relationships Window

Access: View | Other Element Tools | Relationships.

The Relationships window displays all connectors between the currently selected element and other elements.
This provides a quick overview of an element's relationships in the model.

For each connector, the connector type and target element are displayed. If a 'Yes' appears in the Target in
Diagram column, the target element is visible in the currently loaded diagram. This is useful when you are
dragging related elements from the relationships list onto the current diagram.
Double-click on a connector in the list to open the <connector type> Properties dialog, where you can edit the
connector attributes. Right-click on a connector to open the context menu.
You can locate the related element, view the related element properties or delete the connector. You can also
hide certain connectors from appearing in diagrams, and show hidden connectors (first example of the menu,
below).
If an element is not visible in the current diagram, the context menu has an option to place the selected
element in the current diagram (second example of the menu, below). This is useful when you are building a
picture of what an element interacts with, especially when reverse engineering an existing code base.

© 1998-2010 Sparx Systems Pty Ltd

 1270 Navigate, Search and Trace | The Relationships Window

Tip:
In the Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of
Enterprise Architect, with security 188 on, the diagram and the source and target elements must be free for
editing before some of these options are available for use.

Enterprise Architect User Guide

 Navigate, Search and Trace | Diagram Filters 1271

6.8 Diagram Filters

Diagram Filters (Dynamic Visual filters) enable you to modify the display of diagram components, so that the
relevant items are immediately identified for the reader's attention without damaging the structure and integrity
of the model. Currently the feature operates on elements, and filters according to element properties such as
Author, Status, Date Created or Stereotype.
Diagram Filters are useful in tailoring the display of diagrams:
· For different users, so that - for example - technical staff and stakeholders each have a view that highlights
the information pertinent to them
· To show what elements have been recently developed or changed
· To show which part of a model was developed by a particular person
· To show which parts of a diagram are at a particular phase, status or version.

You create and define 1272 as many filters as you require, setting up each filter by defining which element
properties to specifically check for and (depending on how you set up the filter parameters) whether to include
or exclude elements having particular property values. You can select to:
· Mute the irrelevant items in grayscale or a faded color
· Hide the irrelevant items completely, or
· Highlight (with a hashed border) the elements that are relevant.
If you select to mute or hide elements, the action of the filters is to exclude elements that do not match the
parameters rather than include elements that do. If, for example, you selected to filter on element name,
looking for elements with the word Class in the name, the filter would apply the following logic:
Does Name contain string Class? If No, apply effect. If Yes, take no action.
The elements you want are therefore what is left on the diagram, rather than what was operated on. The filter
effect 1272 remains in force while you do other work on the diagram, until such time as you disable 1272 the filter.
In you select the Highlight effect, however, the logic is reversed:
Does Name contain string Class? If No, take no action. If Yes, apply effect.
In this case, the filter effect is not permanent, and clicking off the elements deselects them. This effect is,
however, excellent for selecting elements having the same characteristics across a large diagram, to be
processed in a single task. Instead of having to locate the elements and select them with [Ctrl]+click
individually, you can apply the filter. If you inadvertently lose the selection by clicking off the elements, you can
get it back again almost immediately by re-applying the filter.

You can use filters singly, in sequence, or in combination; for example, you could:
· Set up a filter for immediate use on a diagram, and modify that filter as you review the diagram so that you
highlight elements with different values for the same properties - perhaps, by filtering on Phase, to compare
'as-is' and 'to-be' elements
· Set up a filter and leave it active so that all diagrams you display are automatically filtered the same way
· Set up a series of filters to use:
· in one or more sequences to progressively highlight a diminishing set of elements, or
· alternately to highlight contrasting views of the diagram.

© 1998-2010 Sparx Systems Pty Ltd

 1272 Navigate, Search and Trace | Diagram Filters

A quick-start guide to using Diagram Filters is provided on the Sparx Systems Community Site.

6.8.1 Work With Diagram Filters

Access Diagram Filters

You create, list and activate Diagram Filters using the Diagram Filters window, which you display by selecting
the View | Diagram Filters menu option.

This is a dockable window, which you can move around or fix next to the Diagram View while you activate,
deactivate and edit the filters.

Create a Diagram Filter

To create a filter to be applied to your diagrams, follow the steps below:
1. On the Diagram Filter toolbar, click on the New Filter icon - the first on the left. Alternatively, right click
on the list panel and select the New Filter context menu option. The Create New Diagram Filter dialog
displays.

2. In the Enter Filter Name field, type a name for the filter, then click on the OK button. The Diagram Filter
dialog displays, with the Search On field fixed on Element.

Enterprise Architect User Guide

 Navigate, Search and Trace | Diagram Filters 1273

3. Scroll through the element properties to filter on, and select the checkbox against each property you
require.
4. For each property, click on the Condition field and select, from the drop-down list, the comparison
condition to be applied. (Be aware of how the combination of Condition - Equal To / Not Equal To -
and Filter Effect 1271 might affect the results on the diagram.)
5. For each property, double-click on the Value field and type or select any specific value to filter on.
6. Click on the OK button to save the filter and return to the Diagram Filters window.

Edit a Filter
To edit an existing filter on the Diagram Filters window, either double-click on the filter name, click on it and
select the Properties icon from the toolbar (the second icon from the left), or right-click on the name and
select the Properties context menu option. The Diagram Filter dialog displays; adjust the filtered fields as
described above.
To just change the name of the filter, right-click on the name and select the Change Name context menu
option. The Create New Diagram Filter dialog displays. Type over the existing name with the new name, and
click on the OK button.

Set Effect of Filters

To set how your filters identify selected elements on your diagrams, click on the drop-down arrow of the Filter
Effect field in the toolbar, and select one of the following options:
· Fade - display all elements that do not match the filter criteria in a pale version of the diagram background
color.
· Gray Scale - display all elements that do not match the filter criteria in pale gray.
· Hide - conceal all elements that do not match the filter criteria.
· Select - select and highlight (with a hashed border) all those elements that do match the filter criteria.

Enable Filters
To enable a filter so that it takes immediate effect on your diagrams, select the check box against the filter
name. You can select more than one filter at a time, to combine their effects.

© 1998-2010 Sparx Systems Pty Ltd

 1274 Navigate, Search and Trace | Diagram Filters

Disable/Clear Filters
To disable a filter, clear the checkbox. This clears the effect of the filter on the diagram, so that it displays in
full.
To disable all filters, click on the Reload Filters icon in the toolbar (third option from the left), or right-click on
the list panel and select the Reload Filters context menu option.

Delete a Filter
To remove a filter from the Diagram Filters window, either click on the filter name and click on the Delete icon
in the toolbar, or right-click on the filter name and select the Delete Filter context menu option.

Enterprise Architect User Guide

 Navigate, Search and Trace | The Pan & Zoom Window 1275

6.9 The Pan & Zoom Window

Access: View | Pan & Zoom.

The Pan & Zoom window provides a 'birds-eye' view of diagrams. It enables you to navigate quickly around
large diagrams.

The shaded box represents the viewed area on the open diagram. The toolbar provides the following functions
(in order):
· Zoom In
· Zoom Out
· Zoom to fit diagram
· Zoom to fit page
· Zoom to 100%
· Zoom Slider.
Move the cursor inside the window and hold down the mouse button to pan over the open diagram by moving
the shaded box. To zoom, use either the Zoom Slider or the buttons located on the tool bar.

© 1998-2010 Sparx Systems Pty Ltd

Part

VII
 Software Development | 1277

7 Software Development

The Model Driven Development Environment (MDDE) provides tools to design, build and debug an
application.
The MDDE integrates code and model by providing options to either generate source code from the model or
reverse engineer existing source code into a model. Source code and model can be synchronized in either
direction.

The MDDE provides development environments for popular languages including:

· C++
· C
· Java
· Microsoft .NET family
· ADA
· Python
· Perl
Toolboxes provide for different modeling technologies.

© 1998-2010 Sparx Systems Pty Ltd

 1278 Software Development |

Note:
Although you can generate and reverse engineer code in a range of languages, Execution Analysis
debugging and recording are supported for the following platforms / languages only:
· Microsoft Windows Native C
· Microsoft Windows Native C++
· Microsoft Windows Visual Basic
· Microsoft .NET Family (C#, J#, VB)
· Sun Microsystems Java.

To use the MDDE, work through the following sections:

· Getting Started 1424
· Basic Setup 1425
· Software Engineering 1281
· Using Code Editors 1428
· Build Application 1443
· Debug 1470
· Test 1483
· Run 1482
· Deploy 1484

Enterprise Architect User Guide

 Software Development | Overview of Development 1279

7.1 Overview of Development

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 the Software Engineering 1281 topic.

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 Model Transformations - MDA 1385 topic.

Visual Execution Analysis

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 the Visual Execution Analysis 1488 topic.

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.
For more information, see the Data Models 1011 topic.

XML Technology Engineering

Enterprise Architect enables you to rapidly model, forward engineer and reverse engineer two key W3C

© 1998-2010 Sparx Systems Pty Ltd

 1280 Software Development | Overview of Development

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.3 and XML provides the natural mechanism for implementing XML-based SOA
artifacts within an organization.
For more information, see the XML Schema - XSD 1039 and Web Services - WSDL 1049 topics.

Enterprise Architect User Guide

 Software Development | Software Engineering 1281

7.2 Software Engineering

Software Engineering is a process that includes automated code generation, reverse engineering of source
code and synchronization between the source code and model.
Enterprise Architect also enables you to rapidly model, generate - or forward engineer - and reverse engineer:
· XML Technologies, namely XML Schema (XSD) 1039 and Web Service Definition Language (WSDL) 1049
· Database schema 1011 , keys, triggers, constraints, RI and other relational database features, for and from a
range of database products.
Software Engineering is available in the Professional, Corporate, Business and Software Engineering, System
Engineering and Ultimate editions of Enterprise Architect.

Code Generation
Enterprise Architect enables you to generate source code 1308 from UML model elements, creating a source
code equivalent of the Class or Interface element for future elaboration and compilation. In particular you can
generate C, C++, C#, Delphi, Java, PHP, Python, ActionScript, Visual Basic and VB.NET 1347 source code. The
source code generated includes Class definitions, variables and function stubs for each attribute and method
in the UML Class. You can use the Source Code Viewer 1441 to view any source code you are opening.

Note:
You view source code for an element by selecting it and pressing either [Ctrl]+[E] or [F12]. If the element
does not have a generation file (that is, code has not been or cannot be generated, such as for a Use Case),
Enterprise Architect checks whether the element has a link 611 to either an operation or an attribute of
another element. If such a link exists, and that other element has source code, the code for that element
displays.

You can also generate code from three UML behavioral modeling paradigms:
· State Machine diagrams 1316 (SW & HW)
· Interaction (Sequence) diagrams 1322 (SW)
· Activity diagrams 1323 (SW).
The Code Template Framework (CTF) 1301 enables you to customize the way Enterprise Architect generates
source code. It also enables you to generate languages that Enterprise Architect does not specifically support,
by helping you define the appropriate code generation templates for that language.
You can integrate the facilities of Enterprise Architect with other development environments. The MDG
Integration for Eclipse and MDG Integration for Visual Studio 1334 are standalone products that provide an
enhanced code engineering functionality between Enterprise Architect and the development environments.

Reverse Engineering
Reverse Engineering 1328 is the import of existing source code into model elements, mapping the source code
structures onto their UML representations. This enables you to examine legacy code and the functionality of
code libraries for reuse, or to bring the UML model up to date with the code. You can reverse engineer in the
same languages as you perform code generation with Enterprise Architect.
Enterprise Architect is also able to reverse engineer binary files, namely Java .jar files and .NET PE files.

Note:
Reverse Engineering of other languages including CORBA IDL is also currently available through the use of
the MDG Technologies. See www.sparxsystems.com/resources/mdg_tech/.

© 1998-2010 Sparx Systems Pty Ltd

 1282 Software Development | Software Engineering

Synchronization
Synchronization 1327 is when changes in the model are exported to the source code and changes to source
code are imported into the model. This enables you to keep your model and source up to date as the project
develops.

Round-Trip Engineering
Round trip engineering is a combination of reverse and forward generation of code and includes
synchronization between the source code and the model in all but the most trivial of code engineering
projects. In order to get the most out of round trip engineering in Enterprise Architect, you should be familiar
with the modeling conventions 1282 used when generating and reverse engineering the languages you use.

7.2.1 Modeling Conventions

In order to get the most out of the round trip engineering in Enterprise Architect, you must be familiar with the
modeling conventions used when generating and reverse engineering the languages you use. This topic
describes the stereotypes, Tagged Values and other conventions used in code engineering in Enterprise
Architect for the following supported languages:
· ActionScript 1283
· Ada 2005 1284 (for Systems Engineering and Ultimate editions of Enterprise Architect)
· C 1285
· C# 1287
· C++ 1289
· Delphi 1292
· Java 1293
· PHP 1294
· Python 1295
· System C 1295
· VB.Net 1296
· Verilog 1298
· VHDL 1299
· Visual Basic 1301

Enterprise Architect User Guide

 Software Development | Software Engineering 1283

Note:
Enterprise Architect incorporates a number of visibility indicators or scope values for its supported languages.
These include, for:
· All languages - Public (+), Protected (#) and Private (-)
· Java - Package (~)
· Delphi - Published (^)
· C# - Internal (~), Protected Internal (^)
· ActionScript - Internal (~)
· VB.NET - Friend (~), Protected Friend (^)
· PHP - Package (~)
· Python - Package (~)
· C - Package (~)
· C++ - Package (~).

7.2.1.1 ActionScript Conventions

Enterprise Architect supports round trip engineering of ActionScript 2 and 3, where the following conventions
are used.

Stereotypes
Stereotype Applies To Corresponds To

literal Operation A literal method referred to by a variable.

property get Operation A read property.

property set Operation A write property.

Tagged Values
Tag Applies To Corresponds To

attribute_name Operation with stereotype property The name of the variable behind this
get or property set property.

dynamic Class or Interface The dynamic keyword.

final ActionScript 3: Operation The final keyword.

intrinsic ActionScript 2: Class The intrinsic keyword

namespace ActionScript 3: Class, Interface, The namespace of the current element.

Attribute, Operation

override ActionScript 3: Operation The override keyword.

prototype ActionScript 3: Attribute The prototype keyword.

rest ActionScript 3: Parameter The rest parameter ( ... ).

Common Conventions
· Package qualifiers (ActionScript 2) and Packages (ActionScript 3) are generated when the current package
is not a namespace root 1313
· An unspecified type is modeled as var or an empty Type field.

© 1998-2010 Sparx Systems Pty Ltd

 1284 Software Development | Software Engineering

ActionScript 3 Conventions
· The Is Leaf property of a Class corresponds to the sealed keyword
· If a namespace tag is specified it overrides the Scope that is specified.

See Also
· Import Source Code 1329
· Generate Source Code 1308
· ActionScript Options 1348

7.2.1.2 Ada 2005

Ada 2005 support is available in the System Engineering and Ultimate editions of Enterprise Architect.
Enterprise Architect supports round trip engineering of Ada 2005, where the following conventions are used.

Stereotypes
Stereotype Applies To Corresponds To

adaPackage Class A package specification in Ada 2005 without a

tagged record.

adaProcedure Class A procedure specification in Ada 2005.

delegate Operation Access to a subprogram.

enumeration Inner Class An enum type.

struct Inner Class A record definition.

typedef Inner Class A type definition, subtype definition, access type

definition, renaming.

Tagged Values
Tag Applies To Corresponds To

Discriminant Inner Class with stereotype typedef The type's discriminant.

IsAccess Parameter Determination of whether the parameter is an

access variable.

InstantiatedUnitTy Inner Class with stereotype typedef The instantiated unit's type (Package /
pe Procedure / Function).

PartType Inner Class with stereotype typedef The part type (renames or new).

Type Inner Class with stereotype typedef If Value = SubType, set subtype.
If Value = Access, set access type.

Other Conventions
· Appropriate type of source files: Ada specification file, .ads.
· Ada 2005 imports packages defined as either <<adaPackage>>Class or Class, based on the settings in
the Ada 2005 options 1348 .
· A package in the Ada specification file is imported as a Class if it contains a Tagged Record, the name of
which is governed by the options Use Class Name for Tagged Record and Alternate Tagged Record
Name. All attributes defined in that Tagged Record are absorbed as the Class's attributes.
· A procedure / function in an Ada specification file is considered as the Class's member function if its first
parameter satisfies the conditions specified in the options Ref Param Style, Ignore Reference parameter
name and Ref parameter name.

Enterprise Architect User Guide

 Software Development | Software Engineering 1285

· The option Define Reference for Tagged Record, if enabled, creates a reference type for the Class, the
name of which is determined by the option Reference Type Name.

For example: HelloWorld.ads

package HelloWorld is
type HelloWorld is tagged record
Att1: Natural;
Att3: Integer;
end record;

-- Public Functions
function MyPublicFunction (P: HelloWorld) return String;
procedure MyPublicFunction (P1: in out HelloWorld; AFlag: Boolean);
private
-- Private Functions
function MyPrivateFunction (P: HelloWorld) return String;
procedure MyPrivateFunction (P1: in out HelloWorld; AFlag: Boolean);

end HelloWorld;

See Also
· Import Source Code 1329
· Generate Source Code 1308

7.2.1.3 C Conventions
Note:
Separate conventions apply to Object Oriented programming in C 1286 .

Enterprise Architect supports round trip engineering of C, where the following conventions are used:

Stereotype
Stereotype Applies To Corresponds To

enumeration Inner Class An enum type.

struct Inner Class A struct type.

Attribute A keyword struct in variable definition.

© 1998-2010 Sparx Systems Pty Ltd

 1286 Software Development | Software Engineering

Stereotype Applies To Corresponds To

typedef Inner Class A typedef statement, where the parent is the

original type name.

union Inner Class A union type.

Attribute A keyword union in variable definition.

Tagged Values
Tag Applies To Corresponds To

anonymous Class also containing the The name of this class being defined only by
Tagged Value typedef the typedef statement.

bodyLocation Operation The location the method body is generated

to. Expected values are header, classDec
or classBody.

typedef Class with stereotype other This Class being defined in a typedef
than typedef statement.

C Code Generation for UML Model

UML C Code Notes

A Class A pair of C files (.h + .c) File name is the same as Class name.

Operation (public & Function declaration in .h file

protected) and definition in .c file

Operation (private) Function definition in .c file

only

Attribute (public & protected) Variable definition in .h file

Attribute (private) Variable definition in .c file

Inner Class (without (N/A) This inner Class would be ignored

stereotype)

See Also
· Import Source Code 1329
· Generate Source Code 1308
· C Options 1349

7.2.1.3.1 Object Oriented Programming In C

The following conventions are used for Object-Oriented programming in C.
To configure Enterprise Architect to support Object-Oriented programming using C, you must set the Object
Oriented Support option to True on the C Specifications 1349 page of the Options dialog.

Stereotype
Stereotype Applies To Corresponds To

enumeration Class An enum type.

struct Class A struct type.

Enterprise Architect User Guide

 Software Development | Software Engineering 1287

Stereotype Applies To Corresponds To

Attribute A keyword struct in variable definition.

typedef Class A typedef statement, where the parent is the original

type name.

union Class A union type.

Attribute A keyword union in variable definition.

Tagged Values
Tag Applies To Corresponds To

anonymous Class with stereotype of The name of this Class being defined only by the
enumeration, struct or union. typedef statement.

bodyLocation Operation The location the method body is generated to.

Expected values are header, classDec or classBody.

define Attribute #define statement.

typedef Class with stereotype of This Class being defined in a typedef statement.
enumeration, struct or union.

Object-Oriented C Code Generation for UML Model

The basic idea of implementing a UML Class in C code is to group the data variable (UML attributes) into a
structure type. This structure is defined in a .h file so that it can be shared by other classes and by the client
that referred to it.
An operation in a UML Class is implemented in C code as a function. The name of the function must be a fully
qualified name that consists of the operation name, as well as the Class name to indicate that the operation is
for that Class. A delimiter (specified in the Namespace Delimiter option on the C Specifications 1349 page) is
used to join the Class name and function (operation) name.
The function in C code must also have a reference parameter to the Class object. You can modify the
Reference as Operation Parameter, Reference Parameter Style and Reference Parameter Name options
on the C Specifications page to support this reference parameter.

Limitations of Object-Oriented Programming in C

1. No scope mapping for an attribute: an attribute in a UML Class is mapped to a structure variable in C
code, and its scope (private, protected or public) is ignored.
2. Currently an inner Class is ignored: if a UML Class is the inner Class of another UML Class, it is ignored
when generating C code.
3. Initial value is ignored: the initial value of an attribute in a UML Class is ignored in generated C code.

See Also
· Import Source Code 1329
· Generate Source Code 1308
· C Options 1349

7.2.1.4 C# Conventions
Enterprise Architect supports the round trip engineering of C#, where the following conventions are used.

Stereotypes
Stereotype Applies To Corresponds To

enumeration Class An enum type.

© 1998-2010 Sparx Systems Pty Ltd

 1288 Software Development | Software Engineering

Stereotype Applies To Corresponds To

event Operation An event.

extension Operation A Class extension method, represented in code by a this

parameter in the signature.

indexer Operation A property acting as an index for this Class.

partial Operation The partial keyword on an operation.

property Operation A property possibly containing both read and write code.

struct Class A struct type.

Tagged Values
Tag Applies To Corresponds To

argumentName Operation with stereotype The name given to the this parameter.
extension

attributeName Operation with stereotype The name of the variable behind this property or event.
property or event

className Operation with stereotype The Class that this method is being added to.
extension

const Attribute The const keyword.

definition Operation with stereotype Whether this is the declaration of the method, or the
partial definition.

delegate Operation The delegate keyword.

enumType Operation with stereotype The datatype that the property is represented as.
property

extern Operation The extern keyword.

fixed Attribute The fixed keyword.

generic Operation The generic parameters for this Operation.

genericConstraint Templated Class or The constraints on the generic parameters of this type
s Interface, Operation with or operation.
tag generic

Implements Operation The name of the method this implements, including the
interface name.

ImplementsExplici The presence of the source interface name in this

Operation
t method declaration.

initializer Operation A constructor initialization list.

new Class, Interface, Operation The new keyword.

override Operation The override keyword.

params Parameter A parameter list using the params keyword.

partial Class, Interface The partial keyword.

readonly Operation with stereotype This property only defining read code.

Enterprise Architect User Guide

 Software Development | Software Engineering 1289

Tag Applies To Corresponds To

property

sealed Operation The sealed keyword.

static Class The static keyword.

unsafe Class, Interface, Operation The unsafe keyword.

virtual Operation The virtual keyword.

Operation with stereotype

writeonly This property only defining write code.
property

Other Conventions
· Namespaces are generated for each package below a namespace root 1313
· The Const property of an attribute corresponds to the readonly keyword, while the tag const corresponds to
the const keyword
· The value of inout for the Kind property of a parameter corresponds to the ref keyword
· The value of out for the Kind property of a parameter corresponds to the out keyword
· Partial Classes can be modeled as two separate Classes with the partial tag
· The Is Leaf property of a Class corresponds to the sealed keyword.

See Also
· Import Source Code 1329
· Generate Source Code 1308
· C# Options 1350

7.2.1.5 C++ Conventions

Enterprise Architect supports round trip engineering of C++, including the Managed C++ 1290 and C++/CLI 1291

extensions, where the following conventions are used.

Stereotypes
Stereotype Applies To Corresponds To

enumeration Class An enum type.

friend Operation The friend keyword.

property get Operation A read property.

property set Operation A write property.

struct Class A struct type.

A typedef statement, where the parent is the original type

typedef Class
name.

union Class A union type.

Tagged Values
Tag Applies To Corresponds To

afx_msg Operation The afx_msg keyword.

anonymous Class also containing the The name of this class being only defined by the typedef

© 1998-2010 Sparx Systems Pty Ltd

 1290 Software Development | Software Engineering

Tag Applies To Corresponds To

Tagged Value typedef statement.

attribute_name Operation with stereotype The name of the variable behind this property.
property get or property
set

bitfield Attribute The size, in bits, allowed for storage of this attribute.

bodyLocation Operation The location the method body is generated to; expected
values are header, classDec or classBody.

callback Operation A reference to the CALLBACK macro.

explicit Operation The explicit keyword.

initializer Operation A constructor initialization list.

inline Operation The inline keyword and inline generation of the method body.

mutable Attribute The mutable keyword.

throws Operation The exceptions that are thrown by this method.

typedef Class with stereotype This Class being defined in a typedef statement.
other than typedef

typeSynonyms Class The typedef name and/or fields of this type.

volatile Operation The volatile keyword.

Other conventions
· Namespaces are generated for each package below a namespace root 1313
· By Reference attributes correspond to a pointer to the type specified
· The Transient property of an attribute corresponds to the volatile keyword
· The Abstract property of an attribute corresponds to the virtual keyword
· The Const property of an operation corresponds to the const keyword, specifying a constant return type
· The Is Query property of an operation corresponds to the const keyword, specifying the method doesn't
modify any fields
· The Pure property of an operation corresponds to a pure virtual method using the "= 0" syntax
· The Fixed property of a parameter corresponds to the const keyword.

See Also
· Import Source Code 1329
· Generate Source Code 1308
· C++ Options 1351

7.2.1.5.1 Managed C++ Conventions

The following conventions are used for managed extensions to C++ prior to C++/CLI 1291 . In order to set
Enterprise Architect to generate managed C++ you must modify the C++ version in the C++ Options 1351 .

Stereotypes
Stereotype Applies To Corresponds To

property Operation The __property keyword.

property get Operation The __property keyword and a read property.

Enterprise Architect User Guide

 Software Development | Software Engineering 1291

Stereotype Applies To Corresponds To

property set Operation The __property keyword and a write property.

reference Class The __gc keyword.

value Class The __value keyword.

Tagged Values
Tag Applies To Corresponds To

managedType Class with stereotype reference, The keyword used in declaration of this type.
value or enumeration; Interface Expected values are class or struct.

Other Conventions
· The typedef and anonymous tags from native C++ are not supported
· The Pure property of an operation corresponds to the keyword __abstract.

See Also
· Import Source Code 1329
· Generate Source Code 1308

7.2.1.5.2 C++/CLI Conventions

The following conventions are used for modeling C++/CLI extensions to C++. In order to set Enterprise
Architect to generate managed C++/CLI you must modify the C++ version in the C++ Options 1351 .

Stereotypes
Stereotype Applies To Description

event Operation Defines an event to provide access to the event handler for
this Class.

property Operation, Attribute This is a property possibly containing both read and write
code.

reference Class Corresponds to the ref class or ref struct keyword.

value Class Corresponds to the value class or value struct keyword.

Tagged Values
Tag Applies To Description

attribute_name Operation with The name of the variable behind this property or event.
stereotype property or
event

generic Operation Defines the generic parameters for this Operation.

genericConstraint Templated Class or Defines the constraints on the generic parameters for this
s Interface, Operation Operation.
with tag generic

initonly Attribute Corresponds to the initonly keyword.

literal Attribute Corresponds to the literal keyword.

managedType Class with stereotype Corresponds to either the class or struct keyword.

© 1998-2010 Sparx Systems Pty Ltd

 1292 Software Development | Software Engineering

Tag Applies To Description

reference, value or
enumeration; Interface

Other Conventions
· The typedef and anonymous tags are not used
· The property get/property set stereotypes are not used
· The Pure property of an operation corresponds to the keyword abstract.

See Also
· Import Source Code 1329
· Generate Source Code 1308

7.2.1.6 Delphi Conventions

Enterprise Architect supports round trip engineering of Delphi, where the following conventions are used.

Stereotypes
Stereotype Applies To Corresponds To

constructor Operation A constructor.

destructor Operation A destructor.

dispinterface Class, Interface A dispatch interface.

enumeration Class An enumerated type.

metaclass Class A metaclass type.

object Class An object type.

operator Operation An operator.

property get Operation A read property.

property set Operation A write property.

struct Class A record type.

Tagged Values
Tag Applies To Corresponds To

attribute_name Operation with stereotype The name of the variable behind this property.
property get or property set

overload Operation The overload keyword.

override Operation The override keyword.

packed Class The packed keyword.

property Class A property. See Delphi Properties 1353 for more

information.

reintroduce Operation The reintroduce keyword.

Enterprise Architect User Guide

 Software Development | Software Engineering 1293

Other Conventions
· The Static property of an attribute or operation corresponds to the class keyword
· The Fixed property of a parameter corresponds to the const keyword
· The value of inout for the Kind property of a parameter corresponds to the Var keyword
· The value of out for the Kind property of a parameter corresponds to the Out keyword.

See Also
· Import Source Code 1329
· Generate Source Code 1308
· Delphi Options 1352

7.2.1.7 Java Conventions

Enterprise Architect supports round trip engineering of Java - including AspectJ 1294 extensions - where the
following conventions are used.

Stereotypes
Stereotype Applies To Corresponds To

annotation Interface An annotation type.

enum Attributes within a Class stereotyped An enumerated option, distinguished from

enumeration other attributes that have no stereotype.

enumeration Class An enum type.

operator Operation An operator.

property get Operation A read property.

property set Operation A write property.

static Class or Interface The static keyword.

Tagged Values
Tag Applies To Corresponds To

annotations Anything The annotations on the current code feature.

arguments Attribute with stereotype enum The arguments that apply to this
enumerated value.

attribute_name Operation with stereotype property get or The name of the variable behind this
property set property.

dynamic Class or Interface The dynamic keyword.

generic Operation The generic parameters to this operation.

parameterList Parameter A parameter list with the ... syntax.

The exceptions that are thrown by this

throws Operation
method.

transient Attribute The transient keyword.

Other Conventions
· Package statements are generated when the current package is not a namespace root 1313

· The Const property of an attribute or operation corresponds to the final keyword

© 1998-2010 Sparx Systems Pty Ltd

 1294 Software Development | Software Engineering

· The Transient property of an attribute corresponds to the volatile keyword

· The Fixed property of a parameter corresponds to the final keyword.

See Also
· Import Source Code 1329
· Generate Source Code 1308
· Java Options 1355

7.2.1.7.1 AspectJ Conventions

The following are the conventions used for supporting AspectJ extensions to Java.

Stereotypes
Stereotype Applies To Corresponds To
advice Operation A piece of advice in an AspectJ aspect.
aspect Class An AspectJ aspect.
pointcut Operation A pointcut in an AspectJ aspect.

Tagged Values
Tag Applies To Corresponds To

className Attribute or operation within a Class The Classes this AspectJ intertype member belongs to.
stereotyped aspect

Other Conventions
· The specifications of a pointcut are included in the Behavior field of the method.

See Also
· Import Source Code 1329
· Generate Source Code 1308

7.2.1.8 PHP Conventions

Enterprise Architect supports the round trip engineering of PHP 4 and 5, where the following conventions are
used.

Stereotypes
Stereotype Applies To Corresponds To

property get Operation A read property.

property set Operation A write property.

Tagged Values
Tag Applies To Corresponds To

attribute_name Operation with stereotype property The name of the variable behind this
get or property set property.

final Operations in PHP 5. The final keyword.

Common Conventions
· An unspecified type is modeled as var
· Methods returning a reference are generated by setting the Return Type to var*
Enterprise Architect User Guide
 Software Development | Software Engineering 1295

· Reference parameters are generated from parameters with the parameter Kind set to inout or out.

PHP 5 Conventions
· The final Class modifier corresponds to the Is Leaf property
· The abstract Class modifier corresponds to the Abstract property
· Parameter type hinting is supported by setting the Type of a parameter
· The value of inout or out for the Kind property of a parameter corresponds to a reference parameter.

See Also
· Import Source Code 1329
· Generate Source Code 1308
· PHP Options 1356

7.2.1.9 Python Conventions

Enterprise Architect supports the round trip engineering of Python, where the following conventions are used.

Tagged values
Tag Applies To Corresponds To

decorators Class, Operation The decorators applied to this element in the source.

Other Conventions
· Model members with Private Scope correspond to code members with two leading underscores
· Attributes are only generated when the Initial value is not empty
· All types are reverse engineered as var.

See Also
· Import Source Code 1329
· Generate Source Code 1308
· Python Options 1356

7.2.1.10 System C Conventions

Enterprise Architect supports round-trip engineering of SystemC, where the following conventions are used.

Stereotypes
Stereotype Applies To Corresponds To

delegate Method A delegate.

enumeration Inner Class An enum type.

friend Method A friend method.

property Method A property definition.

sc_ctor Method A SystemC constructor.

sc_module Class A SystemC module.

sc_port Attribute A port.

sc_signal Attribute A signal

struct Inner Class A struct or union.

© 1998-2010 Sparx Systems Pty Ltd

 1296 Software Development | Software Engineering

Tagged Values
Tag Applies To Corresponds To

kind Attribute (Port) Port kind (clocked, fifo, master, slave, resolved, vector).

mode Attribute (Port) Port mode (in, out, inout).

overrides Method The Inheritance list of a method declaration.

throw Method The exception specification of a method.

Other Conventions
· SystemC also inherits most of the stereotypes and Tagged Values of C++ 1289 .

SystemC Toolbox Pages

To access the SystemC pages of the Toolbox, select the More tools | HDL | SystemC Constructs menu
option. Drag these icons onto a diagram to model a SystemC design.

Page Item Use To

SystemC Module Define a SystemC Module.

An sc_module-stereotyped Class element.

Enumeration Define an Enumerated Type.

An enumeration-stereotyped Enumeration element.

Struct Define a Structure.

A struct-stereotyped Class element.

SystemC Features Port Define a SystemC Port.

An sc_port-stereotyped attribute.

Signal Define a SystemC Signal.

An sc_signal-stereotyped attribute.

Constructor Define a SystemC Constructor.

An sc_ctor-stereotyped method.

See Also
· Import Source Code 1329
· Generate Source Code 1308
· SystemC Options 1357 .

7.2.1.11 VB.Net Conventions

Enterprise Architect supports round-trip engineering of Visual Basic.Net, where the following conventions are
used. Earlier versions of Visual Basic 1301 are supported as a different language.

Stereotypes
Stereotype Applies To Corresponds To

event Operation An event declaration.

import Operation An operation to be imported from another library.

module Class A module.

Enterprise Architect User Guide

 Software Development | Software Engineering 1297

Stereotype Applies To Corresponds To

operator Operation An operator overload definition.

partial Operation The partial keyword on an operation.

property Operation A property possibly containing both read and

write code.

Tagged Values
Tag Applies To Corresponds To

Alias Operation with stereotype import The alias for this imported operation.

attribute_name Operation with stereotype property The name of the variable behind this property.

Charset Operation with stereotype import The character set clause for this import. One of
the values Ansi, Unicode or Auto.

delegate Operation The Delegate keyword.

enumTag Operation with stereotype property The datatype that this property is represented
as.

Handles Operation The handles clause on this operation.

Implements Operation The implements clause on this operation.

Lib Operation with stereotype import The library this import comes from.

MustOverride Operation The MustOverride keyword.

Narrowing Operation with stereotype operator The Narrowing keyword.

NotOverrideable Operation The NotOverrideable keyword.

Overloads Operation The Overloads keyword.

Overrides Operation The Overrides keyword.

parameterArray Parameter A parameter list using the ParamArray keyword.

partial Class, Interface The Partial keyword.

readonly Operation with stereotype property This property only defining read code.

shadows Class, Interface, Operation The Shadows keyword.

Shared Attribute The Shared keyword.

Widening Operation with stereotype operator The Widening keyword.

writeonly Operation with stereotype property This property only defining write code.

Other Conventions
· Namespaces are generated for each package below a namespace root 1313
· The Is Leaf property of a Class corresponds to the NotInheritable keyword
· The Abstract property of a Class corresponds to the MustInherit keyword
· The Static property of an attribute or operation corresponds to the Shared keyword
· The Abstract property of an operation corresponds to the MustOverride keyword
· The value of in for the Kind property of a parameter corresponds to the ByVal keyword

© 1998-2010 Sparx Systems Pty Ltd

 1298 Software Development | Software Engineering

· The value of inout or out for the Kind property of a parameter corresponds to the ByRef keyword.

See Also
· Import Source Code 1329
· Generate Source Code 1308
· VB.Net Options 1358

7.2.1.12 Verilog Conventions

Enterprise Architect supports round-trip engineering of Verilog, where the following conventions are used.

Stereotypes
Stereotype Applies To Corresponds To

asynchronous Method A concurrent process.

enumeration Inner Class An enum type.

initializer Method An initializer process.

module Class A module.

part Attribute A component instantiation.

port Attribute A port.

synchronous Method A sequential process.

Tagged Values
Tag Applies To Corresponds To

kind Attribute (signal) The signal kind (such as register, bus).

mode Attribute (port) The port mode (in, out, inout).

Portmap Attribute (part) The generic / port map of the component instantiated.

sensitivity Method The sensitivity list of a sequential process.

type Attribute The range or type value of an attribute.

Verilog Toolbox Pages

To access the Verilog pages of the Toolbox, select the More tools | HDL | Verilog Constructs menu option.
Drag these icons onto a diagram to model a Verilog design.

Page Item Use To

Verilog Module Define a Verilog Module.

A module-stereotyped Class element.

Enumeration Define an Enumerated Type.

An enumeration-stereotyped Class element.

Verilog Features Port Define a Verilog Port.

A port-stereotyped attribute.

Part Define a Verilog component instantiation

A part-stereotyped attribute.

Enterprise Architect User Guide

 Software Development | Software Engineering 1299

Page Item Use To

Attribute Define an attribute.

Procedure Define a Verilog process:

· Concurrent · An asynchronous-stereotyped method
· Sequential · A synchronous-stereotyped method
· Initializer. · An initializer-stereotyped method.

See Also
· Import Source Code 1329
· Generate Source Code 1308
· Verilog Options. 1358

7.2.1.13 VHDL Conventions

Enterprise Architect supports round-trip engineering of VHDL, where the following conventions are used.

Stereotypes
Stereotype Applies To Corresponds To

architecture Class An architecture.

asynchronous Method An asynchronous process.

configuration Method A configuration.

enumeration Inner Class An enum type.

entity Interface An entity.

part Attribute A component instantiation.

port Attribute A port.

signal Attribute A signal declaration.

struct Inner Class A record definition.

synchronous Method A synchronous process.

typedef Inner Class A type or subtype definition.

Tagged Values
Tag Applies To Corresponds To

isGeneric Attribute (port) The port declaration in a generic interface.

isSubType Inner Class A subtype definition.

(typedef)

kind Attribute (signal) The signal kind (such as register, bus).

mode Attribute (port) The port mode (in, out, inout, buffer, linkage).

portmap Attribute (part) The generic / port map of the component instantiated.

Method The sensitivity list of a synchronous process.

sensitivity
(synchronous)

© 1998-2010 Sparx Systems Pty Ltd

 1300 Software Development | Software Engineering

Tag Applies To Corresponds To

type Inner Class The type indication of a type declaration.

(typedef)

typeNameSpace Attribute (part) The type namespace of the instantiated component.

VHDL Toolbox Pages

To access the VHDL pages of the Toolbox, select the More tools | HDL | VHDL Constructs menu option.
Drag these icons onto a diagram to model a VHDL design.

Page Item Use To

VHDL Architecture Define an architecture to be associated with a VHDL entity.

An architecture-stereotyped Class element.

Entity Define a VHDL entity to contain the Port definitions.

An entity-stereotyped interface element.

Enumeration Define an Enumerated Type.

An enumeration-stereotyped enumeration element.

Struct Define a VHDL record.

A struct-stereotyped Class element.

Typedef Define a VHDL type or subtype

A typedef-stereotyped Class element.

VHDL Features Port Define a VHDL Port.

A port-stereotyped attribute.

Part Define a VHDL component instantiation

A part-stereotyped attribute.

Signal Define a VHDL signal.

A signal-stereotyped attribute.

Procedure Define a VHDL process:

· Concurrent · An asynchronous-stereotyped method
· Sequential · A synchronous-stereotyped method
· Configuration · A configuration-stereotyped method.
.

See Also
· Import Source Code 1329
· Generate Source Code 1308
· VHDL Options. 1359

Enterprise Architect User Guide

 Software Development | Software Engineering 1301

7.2.1.14 Visual Basic Conventions

Enterprise Architect supports the round trip engineering of Visual Basic 5 and 6, where the following
conventions are used. Visual Basic .Net 1296 is supported as a different language.

Stereotypes
Stereotype Applies To Corresponds To

global Attribute The Global keyword.

import Operation An operation to be imported from another

library.

property get Operation A property get.

property set Operation A property set.

property let Operation A property let.

with events Attribute The WithEvents keyword.

Tagged Values
Tag Applies To Corresponds To

Alias Operation with stereotype import The alias for this imported operation.

attribute_name Operation with stereotype property get The name of the variable behind this property.
, property set or property let

Lib Operation with stereotype import The library this import comes from.

New Attribute The New keyword.

Other Conventions
· The value of in for the Kind property of a parameter corresponds to the ByVal keyword
· The value of inout or out for the Kind property of a parameter corresponds to the ByRef keyword.

See Also
· Import Source Code 1329
· Generate Source Code 1308
· Visual Basic Options 1360

7.2.2 Code Template Framework

The Code Template Framework (CTF) is used during forward engineering of UML models. The CTF enables
you to:
· Generate source code from UML models
· Customize the way in which Enterprise Architect generates source code
· Forward engineer languages not specifically supported by Enterprise Architect.
The CTF consists of:

© 1998-2010 Sparx Systems Pty Ltd

 1302 Software Development | Software Engineering

· Default Code Templates 1302 which are built into Enterprise Architect for forward engineering supported
languages
· A Code Template Editor 1305 for creating and maintaining user-defined Code Templates
· Code Templates to synchronize code 1307 .

7.2.2.1 Code Templates

Code templates enable you to customize code generation of existing languages. For example:
· Modify the file headers created when generating new files
· Change the style of the generated code (such as indenting or brace position) to match the required coding
standards
· Handle particular stereotypes to generate things like specialized method bodies and extra methods.
They also enable you to add code generation of entirely new languages that Enterprise Architect would
otherwise not be able to handle. In this situation it is most useful to combine code templates with an MDG
technology file 1128 that includes the datatypes, and options for default file extensions.
Enterprise Architect's base code templates 1302 specify the transformation from UML elements to the various
parts of a given programming language. The templates are written as plain text with a syntax that shares some
aspects of both mark-up languages and scripting languages. A simple example of a template used by
Enterprise Architect is the 'Class template'. It is used to generate source code from a UML Class:
%ClassNotes%
%ClassDeclaration%
%ClassBody%
The above template simply refers to three other templates, namely ClassNotes, ClassDeclaration and
ClassBody. The enclosing percent (%) signs indicate a macro. Code Templates consist of various types of
macros, each resulting in a substitution in the generated output. For a language such as C++, the result of
processing the above template might be:
/**
* This is an example class note generated using code templates
* @author Sparx Systems
*/
class ClassA: public ClassB
{
...
}

Execution of Code Templates

A reference to a template (such as the %ClassNotes% macro, from our example above) results in the
execution of that template.
Each template is designed for use with a particular element. For example the ClassNotes template is to be
used with UML Class elements.
The element that is currently being generated is said to be in scope. If the element in scope is stereotyped
Enterprise Architect looks for a template that has been defined for that stereotype. If a match is found, the
specialized template is executed. Otherwise the default implementation of the base template is used.
Templates are processed sequentially, line by line, replacing each macro with its underlying text value from
the model.

7.2.2.1.1 Base Templates

The Code Template Framework consists of a number of base templates. Each base template transforms
particular aspects of the UML to corresponding parts of object-oriented languages.
The following table lists and briefly describes the base templates used in the CTF.

Template Description

Attribute A top-level template to generate member variables from UML attributes.

Attribute Declaration Used by the Attribute template to generate a member variable declaration.

Attribute Notes Used by the Attribute template to generate member variable notes.

Enterprise Architect User Guide

 Software Development | Software Engineering 1303

Template Description

Class A top-level template for generating Classes from UML Classes.

Class Base Used by the Class template to generate a base Class name in the inheritance list
of a derived Class, where the base Class doesn't exist in the model.

Class Body Used by the Class template to generate the body of a Class.

Class Declaration Used by the Class template to generate the declaration of a Class.

Class Interface Used by the Class template to generate an interface name in the inheritance list
of a derived Class, where the interface doesn't exist in the model.

Class Notes Used by the Class template to generate the Class notes.

File A top-level template for generating the source file. For languages such as C++,
this corresponds to the header file.

Import Section Used in the File template to generate external dependencies.

Linked Attribute A top-level template for generating attributes derived from UML Associations.

Linked Attribute Notes Used by the Linked Attribute template to generate the attribute notes.

Linked Attribute Used by the Linked Attribute template to generate the attribute declaration.
Declaration

Linked Class Base Used by the Class template to generate a base Class name in the inheritance list
of a derived Class, for a Class element in the model that is a parent of the
current Class.

Linked Class Interface Used by the Class template to generate an Interface name in the inheritance list
of a derived Class, for an Interface element in the model that is a parent of the
current Class.

Namespace A top-level template for generating namespaces from UML packages. (Although
not all languages have namespaces, this template can be used to generate an
equivalent construct, such as packages in Java.)

Namespace Body Used by the Namespace template to generate the body of a namespace.

Namespace Declaration Used by the Namespace template to generate the namespace declaration.

Operation A top-level template for generating operations from a UML Class's operations.

Operation Body Used by the Operation template to generate the body of a UML operation.

Operation Declaration Used by the Operation template to generate the operation declaration.

Operation Notes Used by the Operation template to generate documentation for an operation.

Parameter Used by the Operation Declaration template to generate parameters.

The second table lists templates used for generating code for languages that have separate interface and
implementation sections.

Template Description

Class Impl A top-level template for generating the implementation of a Class.

Class Body Impl Used by the Class Impl template to generate the implementation of Class
members.

File Impl A top-level template for generating the implementation file.

© 1998-2010 Sparx Systems Pty Ltd

 1304 Software Development | Software Engineering

Template Description

File Notes Impl Used by the File Impl template to generate notes in the source file.

Import Section Impl Used by the File Impl template to generate external dependencies.

Operation Impl A top-level template for generating operations from a UML Class's operations.

Operation Body Impl Used by the Operation template to generate the body of a UML operation.

Operation Declaration Used by the Operation template to generate the operation declaration.
Impl

Operation Notes Impl Used by the Operation template to generate documentation for an operation.

The base templates form a hierarchy, which varies slightly across different programming languages. A typical
template hierarchy relevant to a language like C# or Java (which do not have header files) is shown in the
example diagram below. In this diagram the templates are modeled as Classes (in reality they are just plain
text). This hierarchy would be slightly more complicated for languages like C++ and Delphi, which have
separate implementation templates.
Each of the base templates must be specialized to be of use in code engineering. In particular, each template
is specialized for the supported languages (or 'products'). For example, there is a ClassBody template defined
for C++, another for C#, another for Java, and so on. By specializing the templates, you can tailor the code
generated for the corresponding UML entity.
Once the base templates are specialized for a given language, they can be further specialized based on:
· A Class's stereotype
· A feature's stereotype (where the feature can be an operation or attribute)
This type of specialization enables, for example, a C# operation that is stereotyped as «property» to have a
different Operation Body template from an ordinary operation. The Operation Body template can then be
specialized further, based on the Class stereotype.

Enterprise Architect User Guide

 Software Development | Software Engineering 1305

Note:
The above Class Model shows the hierarchy of Code Generation templates for a language such as C# or
Java. The Aggregation connectors denote references between templates.

7.2.2.2 The Code Template Editor

The Code Template Editor provides the facilities of the Common Code Editor, including intellisense for the
various macros. For more information on intellisense and the Common Code Editor, see the Code Editors 1428
topic.
To access the Code Template Editor window, select the Settings | Code Generation Templates menu
option.

© 1998-2010 Sparx Systems Pty Ltd

 1306 Software Development | Software Engineering

Option Use to

Language Select the programming language.

New Language Display the Programming Languages Datatypes 666 dialog, which enables you to
include programming languages other than those supported for Enterprise
Architect, for which to create or edit code templates.

Template Display the contents of the active template, and provides the editor for modifying
templates.

Templates List the base code templates. The active template is highlighted. The Modified
field indicates whether you have changed the default template for the current
language.

Stereotype Overrides List the stereotyped templates, for the active base template.
The Modified field indicates whether you have modified a default stereotyped
template.

Add New Custom Invoke a dialog for creating a custom stereotyped template.
Template

Add New Stereotyped Invoke a dialog for adding a stereotyped template, for the currently selected base
Override template.

Get Default Template Update the editor display with the default version of the active template.

Enterprise Architect User Guide

 Software Development | Software Engineering 1307

Option Use to

Save Overwrite the active templates with the contents of the editor.

Delete If you have overridden the active template, the override is deleted and replaced
by the corresponding default code template.

For information on creating and editing code templates using the Code Template Editor window, see The
Code Template Editor in MDG Development 1202 . 1202

Note:
User-modified and user-defined Code Templates can be imported and exported as Reference Data (see the
Sharing Reference Data 223 topic. The templates defined for each language are indicated in the Export
Reference Data dialog by the language name with the suffix _Code_Templates. If no templates exist for a
language, there is no entry for the language in the dialog.

7.2.2.3 Synchronize Code

Enterprise Architect uses code templates during the forward synchronization of the following programming
languages:
· ActionScript
· C
· C++
· C#
· Delphi
· Java
· PHP
· Python
· VB
· VB.Net
Only a subset of the code templates are used during synchronization. This subset corresponds to the distinct
sections that Enterprise Architect recognizes in the source code. The following table lists the code templates
and their corresponding code sections, which can be synchronized.

Code Template Code Section

Class Notes Comments preceding Class declaration.

Class Declaration Up to and including Class parents.

Attribute Notes Comments preceding Attribute declaration.

Attribute Declaration Up to and including terminating character.

Operation Notes Comments preceding operation declaration.

Operation Notes Impl As for Operation Notes.

Operation Declaration Up to and including terminating character.

Operation Declaration Impl Up to and including terminating character.

Operation Body Everything between and including the braces.

Operation Body Impl As for Operation Body.

Three types of change can occur in the source when it is synchronized with the UML model:
· Synchronize Existing Sections 1308 : for example, changing the return type in an operation declaration
· Add New Sections to Existing Features 1308 : for example, adding notes to a Class declaration, where there
were previously none

© 1998-2010 Sparx Systems Pty Ltd

 1308 Software Development | Software Engineering

· Add New Features and Elements 1308 : for example, adding a new operation to a Class.
Each of these changes must be handled differently by Enterprise Architect; their effect on the CTF is
described in the linked topics above.

7.2.2.3.1 Synchronize Existing Sections

When an existing section in the source code differs from the result generated by the corresponding template,
that section is replaced. Consider for example, the following C++ Class declaration:
[asm] class A: public B
Now assume you add an inheritance relationship from Class A to Class C; the entire Class declaration would
be replaced with something like:
[asm] class A: public B, public C

7.2.2.3.2 Add New Sections

The following can be added as new sections, to existing features in the source code:
· Class Notes
· Attribute Notes
· Operation Notes
· Operation Notes Impl
· Operation Body
· Operation Body Impl
Assume Class A from the previous example had no note when you originally generated the code. Now
assume that you specify a note in the model for Class A. Enterprise Architect attempts to add the new note
from the model during synchronization. It does this by executing the Class Notes template.
To make room for the new section to be inserted, you can specify how much white space to append to the
section via synchronization macros. These macros are described in the Control Macros 1192 topic.

7.2.2.3.3 Add New Features and Elements

The following features and elements can be added to the source code during synchronization:
· Attributes
· Inner Classes
· Operations.
These are added by executing the relevant templates for each new element or feature in the model. Enterprise
Architect attempts to preserve the appropriate indenting of new features in the code, by finding the indents
specified in list macros of the Class. For languages that make use of namespaces, the
synchNamespaceBodyIndent macro is available. Classes defined within a (non-global) namespace are
indented according to the value set for this macro, during synchronization. This value is ignored for Classes
defined within a package setup as a root namespace, or if the Generate Namespace option is set to False in
the appropriate language page (C#, C++ or VB.Net) on the Options dialog (Tools | Options | Source Code
Engineering | <language>).

7.2.3 Generate Source Code

Generating source code (forward engineering) takes the UML Class or Interface model elements and creates
a source code equivalent for future elaboration and compilation. By forward engineering code from the model,
the mundane work involved with having to key in Classes and attributes and methods is avoided, and
symmetry between model and code is ensured.
Code is generated from Class or Interface model elements, so you must create the required Class and
Interface elements to generate from. Add attributes (which become variables) and operations (which become

Enterprise Architect User Guide

 Software Development | Software Engineering 1309

methods).
Before you generate code, you should ensure the default settings for code generation match your
requirements. The default generation settings are located in the Source Code Engineering page of the Options
dialog (select the Tools | Options | Source Code Engineering menu option). Set up the defaults to match
your required language and preferences. Preferences that you can define include default constructors and
destructors, methods for interfaces and the Unicode options for created languages. Languages such as Java
support namespaces 1313 and can be configured to specify a namespace root. In addition to the default
settings for generating code, Enterprise Architect supports the following code languages with their own
specific code generation options:
· ActionScript 1348
· C 1349
· C# 1350 (for both .NET 1.1 and .NET 2.0)
· C++ 1351 (standard, plus .NET managed C++ extensions)
· Delphi 1352
· Java 1355 (including Java 1.5, Aspects and Generics)
· PHP 1356
· Python 1356
· Visual Basic 1360
· Visual Basic .NET 1358
The Code Template Framework (CTF) 1301 enables you to customize the way Enterprise Architect generates
source code and also enables generation of languages that are not specifically supported by Enterprise
Architect.
Before generating code, you should also familiarize yourself with the way Enterprise Architect handles local
path names. Local path names enable you to substitute tags for directory names (for example %SRC% = C:
\Source).

When you have completed the design of your Classes, you can generate source code.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Generate Source Code and DDL 198 permission to
generate source code.

Use Live Code Generation

On the Package Build Scripts 1426 dialog, you have the option to update your source code instantly as you
make changes to your model.

Tasks
When you generate code, you perform one or more of the following tasks:
· Generate a Single Class 1309
· Generate a Group of Classes 1311
· Generate a Package 1311
· Update Package Contents 1313

7.2.3.1 Generate a Single Class

To generate code for a single Class, first ensure the design of the model element (Class or Interface) is
complete. Also ensure you have added Inheritance connectors to parents and associations to other Classes
that are used. Also add Inheritance connectors to Interfaces that your Class implements; Enterprise Architect
offers the option to generate function stubs for all interface methods that a Class implements. Once the design
is satisfactory, follow the steps below.

Generate Code for a Single Class

1. Open the diagram containing the Class or Interface for which to generate code.
2. Right-click on the required Class or Interface to display the context menu and select the Generate
Code menu option, or press [F11]. The Generate Code dialog displays, which enables you to control
how and where your source code is generated.
© 1998-2010 Sparx Systems Pty Ltd
 1310 Software Development | Software Engineering

3. On the Path field, click on [ ... ] (Browse) and select a path name for your source code to be generated
to.
4. In the Target Language field, click on the drop-down arrow and select the language to generate; this
becomes the permanent option for that Class, so change it back if you are only doing one pass in
another language.
5. Click on the Advanced button. The Object Options dialog displays.

Enterprise Architect User Guide

 Software Development | Software Engineering 1311

6. Set any custom options (for this Class alone), then click on the Close button to return to the Generate
Code dialog.
7. In the Import(s) / Header(s) fields, type any import statements, #includes or other header information.
(Note that in the case of Visual Basic this information is ignored; in the case of Java the two import text
boxes are merged; and in the case of C++ the first import text area is placed in the header file and the
second in the body (.cpp) file.)
8. Click on the Generate button to create the source code.
9. When complete, click on the View button to see what has been generated. Note that you should set up
your default viewer 1441 /editor for each language type first. You can also set up the default editor on the
Code Editors page of the Options dialog (Tools | Options | Source Code Engineering | Code Editors
).

7.2.3.2 Generate a Group of Classes

In addition to being able to generate code for an individual Class, you can also select a group of Classes for
batch code generation. When you do this, you accept all the default code generation options for each Class in
the set.

To Generate Multiple Classes

1. Select a group of Classes and/or interfaces in a diagram.
2. Right-click on an element in the group to display the context menu.
3. Select the Code Generation | Generate Selected elements menu option. The Save As dialog
displays, on which you specify the file path and name for each code file. Enter this information and click
on the Save button.
4. The Batch Generation dialog displays, showing the status of the process as it executes (the process
might be too fast to see this dialog).

Note:
If any of the elements selected are not Classes or interfaces the option to generate code is not
available.

7.2.3.3 Generate a Package

In addition to generating source code from single Classes and groups of Classes, you can also generate code
from a package. This feature provides options to recursively generate child packages and automatically
generate directory structures based on the package hierarchy. This enables you to generate a whole branch of
your project model in one step.

Generate a Package
To generate a package, follow the steps below:
1. In the Project Browser, right-click on the package to generate code for. The context menu displays.
2. Select the Code Engineering | Generate Source Code menu option. The Generate Package Source
Code dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1312 Software Development | Software Engineering

3. In the Synchronize field, click on the drop-down arrow and select the appropriate synchronize option:
· Synchronize model and code: Classes with existing files are forward synchronized with that file;
Classes with no existing file are generated to the displayed target file
· Overwrite code: All selected target files are overwritten (forward generated)
· Do not generate: Only selected Classes that do not have an existing file are generated; all other
Classes are ignored.
4. Highlight the Classes to generate. Leave unselected any to not generate. If you want to display the
information in a more readable layout, you can resize the dialog and its columns.
5. To make Enterprise Architect automatically generate directories and filenames based on the package
hierarchy, select the Auto Generate Files checkbox. This then enables the Root Directory field, in
which you select a root directory under which the source directories are to be generated. By default,
the Auto Generate Files feature ignores any file paths that are already associated with a Class. You
can change this behavior by also selecting the Retain Existing File Paths checkbox.
6. To include all sub-packages in the output, select the Include Child Packages checkbox.
7. Click on the Generate button to start generating code.
As code generation proceeds Enterprise Architect displays progress messages. If a Class requires an output
filename Enterprise Architect prompts you to enter one at the appropriate time (assuming Auto Generate
Files is not selected). For example, if the selected Classes include partial Classes, a prompt displays to enter
the filename for the second partial Class.
For additional information on the options on the Generate Package Source Code dialog, see the following
table:

Option Use to

Root Package Check the name of the package to be generated.

Synchronize Select options that specify how existing files should be generated.

Auto Generate Files Specify whether Enterprise Architect should automatically generate file
names and directories, based on the package hierarchy.

Root Directory If Auto Generate Files is selected, display the path under which the
generated directory structures are created.

Retain Existing File Paths If Auto Generate Files is selected, specify whether to use existing file paths
associated with Classes. If unselected, Enterprise Architect generates

Enterprise Architect User Guide

 Software Development | Software Engineering 1313

Option Use to

Classes to automatically determined paths, regardless of whether source

files are already associated with Classes.

Include all Child Packages Include all Classes from all sub-packages of the target package in the list.
This option facilitates recursive generation of a given package and its sub-
packages.

Select Objects to Generate List all Classes that are available for generation under the target packages.
Only selected (highlighted) Classes are generated. Classes are listed with
their target source file.

Select All Mark all Classes in the list as selected.

Select None Mark all Classes in the list as unselected.

Generate Start the generation of all selected Classes.

Cancel Exit the Generate Package Source Code dialog. No Classes are generated.

7.2.3.4 Update Package Contents

Enterprise Architect enables you to synchronize a directory tree. Follow the steps below:
1. In the Project Browser, right-click on the root package of the tree to synchronize. The context menu
displays.
2. Select the Code Engineering | Synchronize Package With Code menu option. The Synchronize
Package Contents dialog displays.

3. In the Update Type panel, select the radio button to Forward Engineer or Reverse Engineer the
package Classes.
4. To include child packages in the synchronization, select the Include child packages in generation
checkbox.
5. Click on the OK button to start.
Enterprise Architect uses the directory names specified when the project source was first imported/generated
and updates either the model or the source code depending on the option chosen.

7.2.3.5 Namespaces
Languages such as Java support package structures or namespaces. Enterprise Architect lets you specify a
package as a namespace root, which denotes where the namespace structure starts; all subordinate
packages below this point are generated as namespaces to code.
To define a package as a namespace root, right-click on the package in the Project Browser and select the
Code Engineering | Set as Namespace Root context menu option. The package icon in the Project Browser
changes to include a colored corner ( ).

© 1998-2010 Sparx Systems Pty Ltd

 1314 Software Development | Software Engineering

When you have set the namespace root, the menu option changes to Clear Namespace Root; click on this
option to take the namespace root status off the package. (Also, see the context menu described below.)
Once you have set a namespace root, Java code generated beneath this root automatically adds a package
declaration at the head of the generated file indicating the current package location.
To view a list of namespaces, select the Settings | Namespaces menu option. The Namespaces dialog
displays.

If you double-click on a namespace in the list, the package is highlighted in the Project Browser. Alternatively,
right-click on the namespace to display a context menu, and select the Locate Package in Browser menu
option.

You can also clear the selected namespace, by selecting the Clear Namespace Attribute option.

7.2.4 Generate From Behavioral Models

Enterprise Architect User Guide

 Software Development | Software Engineering 1315

Notes:
· Software code generation from behavioral models is available in the Business and Software Engineering,
Systems Engineering and Ultimate editions of Enterprise Architect.
· Hardware code generation from State Machine models is available in the Systems Engineering and
Ultimate editions of Enterprise Architect.
· For C(OO), please ensure that, on the C Specifications page of the Options dialog, you have set the
Object Oriented Support option to True.
· To be able to generate code from behavioral models, all behavioral constructs should be contained within a
Class.

Enterprise Architect's system engineering capability facilitates code generation from each of the following UML
behavioral diagrams:
· State Machine diagrams 1316 (SW & HW)
· Interaction (Sequence) diagrams 1322 (SW)
· Activity diagrams 1323 (SW).
You can generate code in various software and hardware 1319 languages, including C(OO), C++, C#, Java,
VB.Net, VHDL, Verilog and SystemC.
To experiment with code generation from these diagrams, use the EAExample project provided with your
Enterprise Architect installer, as follows:
1. Open the EAExample.eap file by selecting the Help | Open Example Model menu option.
2. From the Project Browser, select any of the following packages:

Software Language Examples:

· Project Models > System Model > Implementation Model (PSM) > Java Model With Behaviors.
Generate the Account and Order classes.
· Project Models > Systems Engineering Model > Implementation Model > Software > C#. Generate
the DataProcessor Class.
· Project Models > Systems Engineering Model > Implementation Model > Software > C++.
Generate the IO Class.
· Project Models > Systems Engineering Model > Implementation Model > Software > Java.
Generate the IO Class.
· Project Models > Systems Engineering Model > Implementation Model > Software > VBNet.
Generate the IO Class.

Hardware Language Examples:

· Project Models > Systems Engineering Model > Implementation Model > Hardware > SystemC.
Generate the PlayBack Class.
· Project Models > Systems Engineering Model > Implementation Model > Hardware > VHDL.
Generate the PlayBack Class.
· Project Models > Systems Engineering Model > Implementation Model > Hardware > Verilog.
Generate the PlayBack Class.

3. When completed, press [Ctrl]+[E] to open the generated source code. You should see methods
generated in the code.

© 1998-2010 Sparx Systems Pty Ltd

 1316 Software Development | Software Engineering

7.2.4.1 SW Code Generation - State Machine Diagrams

Note:
To be able to generate code from behavioral models, all behavioral constructs should be contained within a
Class.

A State Machine 678 in a Class internally generates the following constructs in software languages to enable
effective execution of the States' behaviors (do, entry and exit) and also to code the appropriate transition's
effect when necessary.

Enumerations
· StateType - comprises an enumeration for each of the States contained within the State Machine
· TransitionType – comprises an enumeration for each transition that has a valid effect associated with it; for
example ProcessOrder_Delivered_to_ProcessOrder_Closed
· CommandType – comprises an enumeration for each of the behavior types that a State can contain (Do,
Entry, Exit).

Attributes
· currState:StateType - a variable to hold the current State's information
· nextState:StateType – a variable to hold the next State's information, set by each State's transitions
accordingly
· currTransition:TransitionType – a variable to hold the current transition information; this is set if the
transition has a valid effect associated with it
· transcend:Boolean - a flag used to advise if a transition is involved in transcending between different State
Machines (or Submachine states)
· xx_history:StateType – a history variable for each State Machine/Submachine State, to hold information
about the last State from which the transition took place.

Operations
· StatesProc - a States procedure, containing a map between a State's enumeration and its operation; it
de-references the current State's information to invoke the respective State's function
· TransitionsProc - a Transitions procedure, containing a map between the Transition's enumeration and its
effect; it invokes the respective effect
· <<State>> - an operation for each of the States contained within the State Machine; this renders a State's
behaviors based on the input CommandType, and also executes its transitions
· initializeStateMachine – a function that initializes all the framework-related attributes
· runStateMachine - a function that iterates through each State, and executes their behaviors and transitions

Enterprise Architect User Guide

 Software Development | Software Engineering 1317

accordingly.
Click here 1317 to display an example of Java code generated from the State Machine diagram above.

7.2.4.1.1 Java Code Generated From State Machine Diagram

private enum StateType : int

{
ProcessOrder_Delivered,
ProcessOrder_Packed,
ProcessOrder_Closed,
ProcessOrder_Dispatched,
ProcessOrder_New,
ST_NOSTATE
}
private enum TransitionType : int
{
ProcessOrder_Delivered_to_ProcessOrder_Closed,
TT_NOTRANSITION
}
private enum CommandType
{
Do,
Entry,
Exit
}
private StateType currState;
private StateType nextState;
private TransitionType currTransition;
private boolean transcend;
private StateType ProcessOrder_history;
private void processOrder_Delivered(CommandType command)
{
switch(command)
{
case Do:
{
// Do Behaviors..
setStatus(Delivered);
// State's Transitions
if((status==Delivered))
{
nextState = StateType.ProcessOrder_Closed;
currTransition =
TransitionType.ProcessOrder_Delivered_to_ProcessOrder_Closed;
}
break;
}
default:
{
break;
}
}
}

private void processOrder_Packed(CommandType command)

{
switch(command)
{
case Do:
{
// Do Behaviors..
setStatus(Packed);
// State's Transitions
nextState = StateType.ProcessOrder_Dispatched;
break;
}
default:
{
break;
}
}
}

private void processOrder_Closed(CommandType command)

{

© 1998-2010 Sparx Systems Pty Ltd

 1318 Software Development | Software Engineering

switch(command)
{
case Do:
{
// Do Behaviors..
// State's Transitions
break;
}
default:
{
break;
}
}
}

private void processOrder_Dispatched(CommandType command)

{
switch(command)
{
case Do:
{
// Do Behaviors..
setStatus(Dispatched);
// State's Transitions
nextState = StateType.ProcessOrder_Delivered;
break;
}
default:
{
break;
}
}
}

private void processOrder_New(CommandType command)

{
switch(command)
{
case Do:
{
// Do Behaviors..
setStatus(new);
// State's Transitions
nextState = StateType.ProcessOrder_Packed;
break;
}
default:
{
break;
}
}
}
private void StatesProc(StateType currState, CommandType command)
{
switch(currState)
{
case ProcessOrder_Delivered:
{
processOrder_Delivered(command);
break;
}

case ProcessOrder_Packed:
{
processOrder_Packed(command);
break;
}

case ProcessOrder_Closed:
{
processOrder_Closed(command);
break;
}

case ProcessOrder_Dispatched:
{
processOrder_Dispatched(command);

Enterprise Architect User Guide

 Software Development | Software Engineering 1319

break;
}

case ProcessOrder_New:
{
processOrder_New(command);
break;
}
default:
break;
}
}
private void TransitionsProc(TransitionType transition)
{
switch(transition)
{
case ProcessOrder_Delivered_to_ProcessOrder_Closed:
{
setStatus(closed);
break;
}
default:
break;
}
}
private void initalizeStateMachine()
{
currState = StateType.ProcessOrder_New;
nextState = StateType.ST_NOSTATE;
currTransition = TransitionType.TT_NOTRANSITION;
}

private void runStateMachine()

{
while(true)
{
if ( currState == StateType.ST_NOSTATE )
{
break ;
}

currTransition = TransitionType.TT_NOTRANSITION;
StatesProc(currState, CommandType.Do);
// then check if there is any valid transition assigned after the do behavior
if ( nextState == StateType.ST_NOSTATE)
{
break;
}

if ( currTransition != TransitionType.TT_NOTRANSITION )
{
TransitionsProc( currTransition );
}
if ( currState != nextState)
{
StatesProc(currState, CommandType.Exit);
StatesProc(nextState, CommandType.Entry);
currState = nextState ;
}
}
}

7.2.4.2 State Machine Modeling For HDLs

Note:
To be able to generate code from behavioral models, all behavioral constructs should be contained within a
Class.

For efficient code generation from State Machine models into Hardware Description Languages (HDL) such as
VHDL, Verilog and Systems C, apply the design practices outlined in this topic.
In an HDL State Machine model, the following are expected:
· Designate Driving Triggers
© 1998-2010 Sparx Systems Pty Ltd
 1320 Software Development | Software Engineering

· Establish Port–Trigger Mapping

· Active State Logic

Designate Driving Triggers

The top level State Machine diagram should be used to model the different modes of a hardware component,
and the associated triggers that drive them, as shown in the following diagram.

Asynchronous Triggers
Asynchronous triggers should be modeled according to the following pattern:
1. The trigger should be of type Change (specification: true / false)
2. The active state (Submachine State) should have a transition trigger by it.
3. The target state of the triggered transition should have a self transition with the same trigger

Clock
A trigger of type time, which triggers the transitions to the active state (Submachine State) is deemed as the
Clock. The specification of this trigger should be specific to the target language.
Clock Trigger Specifications

Trigger Type Language Specification

Positive Edge Triggered Negative Edge Triggered

Enterprise Architect User Guide

 Software Development | Software Engineering 1321

VHDL rising_edge falling_edge

Time
Verilog posedge negedge

SystemC positive negative

Establish Port – Trigger Mapping

After successfully modeling the different operating modes of the component, and the triggers associated with
them, you must associate the triggers with the component's ports as shown in the following diagram.

A Dependency relationship from the Port to the associated trigger should be used to signify their association.

See Also:
· State Machine Diagram 678
· Transition 892
· SW Code Generation - State Machine Diagrams 1316 .

Active State Logic

The first two aspects, above, put in place the preliminaries required for efficient interpretation of the hardware
components. The actual State Machine logic is now modeled within the Active (Submachine) state.

© 1998-2010 Sparx Systems Pty Ltd

 1322 Software Development | Software Engineering

Note:
The current code generation engine supports only one clock trigger for a component.

7.2.4.3 Code Generation - Interaction Diagrams

Note:
To be able to generate code from behavioral models, all behavioral constructs should be contained within a
Class.
For an Interaction (Sequence) diagram, the behavioral code generation engine expects the Sequence
diagram and all its associated messages and interaction fragments to be encapsulated within an Interaction
779 element.

During code generation from Interaction (Sequence) diagrams 706 in a Class, Enterprise Architect applies its
system engineering graph optimizer to transform the Class constructs into programmatic paradigms.
Messages and Fragments are identified as one of the several action types based on their functionality, and
Enterprise Architect uses the EASL code generation templates to render their behavior accordingly. For
example:
· A Message that invokes an operation is identified as an Action Call and is rendered accordingly
· Combined Fragments are identified by their types and conditions; for instance, an Alt fragment is identified
as an Action If, and a loop fragment is identified as an Action Loop.
For more information on the EASL code generation macros and templates Enterprise Architect uses to
generate code from behavioral models see the EASL Code Generation Macros 1193 topic.

The above diagram contains:

· A Combined Fragment 759 (alt ), which is identified as an Action If
· An Interaction Occurrence 780 , which is identified as an Action Call with all argument information
associated with it, and
· A message (Action Opaque).
The Java code generated from this diagram resembles the following:
public void newTransaction()
{
// behavior is an Interaction
if (bValidUser) // Alt combined fragment

Enterprise Architect User Guide

 Software Development | Software Engineering 1323

{
placeOrder(101); //Interaction Occurrence

}
else
{
return;
}
}

7.2.4.4 Code Generation - Activity Diagrams

Note:
To be able to generate code from behavioral models, all behavioral constructs should be contained within a
Class.

Code generation from an Activity diagram 674 in a Class requires a validation phase, during which Enterprise
Architect uses the system engineering graph optimizer to analyze the diagram and render it into various
code-generatable constructs. Enterprise Architect also transforms the constructs into one of the various action
types (if appropriate), similar to the Interaction diagram constructs. Enterprise Architect then uses the EASL
code generation macros to generate code from these constructs.
For more information on the EASL code generation macros and templates Enterprise Architect uses to
generate code from behavioral models see the EASL Code Generation Macros 1193 topic.
To provide a comprehensive analysis of these features several diagrams from the EAExample project are
shown as examples.

Conditional Statements
To model a conditional statement, you use Decision/Merge nodes. Alternatively, you can imply
Decisions/Merges internally. The graph optimizer expects an associated Merge node for each Decision node,
to facilitate efficient tracking of various branches and analysis of the code constructs within them.
The following diagram is interpreted as a nested IF statement.

© 1998-2010 Sparx Systems Pty Ltd

 1324 Software Development | Software Engineering

The Java code that might be generated from this diagram is as follows:

public boolean doValidateUser(String Password,String UserName)

{
loadAccountDetails();
boolean bRet;
if (Username==name)
{
if (Password == password)
{
bRet = true;
bValidUser = true;
}
else
{
bRet = false;
}

}
else
{

Enterprise Architect User Guide

 Software Development | Software Engineering 1325

bRet = false;
}

return bRet;
}

Invocation Actions (Call Operation Action, Call Behavior Action)

Call Actions are handled more efficiently. Each action has arguments relating to the parameters of the
associated behavior (use the Synchronize button of the Arguments dialog to synchronize arguments and
parameters).
The following diagram demonstrates the use of a Call Behavior Action and a Call Operation Action
interspersed with a conditional statement.

The generated Java code might appear as follows:

public void doMarkAccountClosed()

{
doValidateUser(password,name);
if (bValiduser)
{
setClosed(true);

}
else
{
System.out.println("Invalid user");
}
return;
}

© 1998-2010 Sparx Systems Pty Ltd

 1326 Software Development | Software Engineering

Loops
Enterprise Architect's system engineering graph optimizer is also capable of analyzing and identifying loops.
An identified loop is internally rendered as an Action Loop, which is translated by the EASL code generation
macros to generate the required code.
The following diagram demonstrates how a loop can be modeled.

The generated Java code might appear as follows:

public void doCheckForOutstandingOrders()

{
if (status != closed)
{
initializeStateMachine();
while (status != closed)
{
runStateMachine();
}
}
else

Enterprise Architect User Guide

 Software Development | Software Engineering 1327

{
//No Outstanding orders;
}
return;
}

7.2.5 Synchronize Model and Code

In addition to generating and importing code, Enterprise Architect provides the option to synchronize the
model and source code, creating a model that represents the latest changes in the source code and vice
versa. You can use either the model as the source, or the code as the source.
For example: you generated some source code, but made subsequent changes to the model. When you
generate code again, Enterprise Architect adds any new attributes or methods to the existing source code,
leaving intact what already exists. This means developers can work on the source code and then generate
additional methods as required from the model, without having their code overwritten or destroyed.

Note:
Code synchronization does not change method bodies. Behavioral code generation 1314 only works when
generating the entire file.

Similarly, you might have made changes to a source code file, but the model has detailed notes and
characteristics you do not want to lose. By synchronizing from the source code into the model, you import
additional attributes and methods but do not change other model elements.
Using the two synchronization methods above, it is simple to keep source code and model elements up to
date and synchronized.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Generate Source Code and DDL 198 permission to
synchronize source code with model elements.

Synchronize Classes on Forward Generation

When there are features present in the code but not in the model you can use the following buttons during
forward synchronization:

Note:
These buttons are only available when the On forward synch, prompt to delete code features not in
model checkbox is selected in the Options - Attributes and Operations 1341 dialog.

· Delete: when you click on this button the selected code features are removed from the code.
· Reassign: when you click on this button the code elements are reassigned to elements in the model (this
is only possible when an appropriate model element is present that is not already defined in the code).
· Ignore: when you click on this button the code elements not present in the model are ignored completely.
· Reset to Default: when you click on this button the settings for synchronizing during forward generation
are set to Ignore, meaning that the elements present in the code but not in the model are ignored
completely.

© 1998-2010 Sparx Systems Pty Ltd

 1328 Software Development | Software Engineering

7.2.6 Import Source Code

Reverse Engineering in Enterprise Architect enables you to import existing source code from a variety of code
languages into a UML model. Existing source code structures are mapped into their UML representations, for
example a Java Class is mapped into a UML Class element with the variables being defined as attributes,
methods are modeled as operations and the interactions between the Java Classes being displayed in the
UML model Class diagram with the appropriate connectors.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Reverse Engineer From DDL And Source Code
198 permission to reverse engineer source code and synchronize model elements against code.

Reverse Engineering enables users to examine legacy code and examine the functionality of code libraries for
reuse or to bring the UML model up to date with the code that has been developed as part of a process called
synchronization. Examining the code in a UML model enables user to identify the critical modules contained
the code, enabling a starting point for understanding of the business and system requirements of the pre-
existing system and to enable the developers to gain a better overall understanding of the source code.
To begin the process of importing existing code into Enterprise Architect, an existing source of code must be
imported into Enterprise Architect 1329 , which can be a single directory or a directory structure 1332 . Several
options are available when performing the reverse engineering process. The Source Code Engineering
Options 1336 topic contains several options that affect the reverse engineering process. These include:
· If comments are reverse engineered into notes fields, and how they are formatted if they are
· How property methods are recognized
· If dependencies should be created for operation return and parameter types.
It is important to note that when a legacy system is not well designed, simply importing the source into
Enterprise Architect does not create an easily understandable UML model. When working with a legacy

Enterprise Architect User Guide

 Software Development | Software Engineering 1329

system that is poorly designed it is useful to break down the code into manageable components by examining
the code elements individually. This can be achieved by importing a specific Class of interest into a diagram
and then inserting the related elements 551 at one level to determine immediate relationship to other Classes.
From this point it is possible to create Use Cases that identify the interaction between the legacy Classes,
enabling an overview of the legacy system's operation.
Copyright ownership is an important issue to take into account when undertaking the process of reverse
engineering. In some cases, software might have specific limitations that prohibit the process of reverse
engineering. It is important that a user address the issue of copyright before beginning the process of reverse
engineering code. Situations that typically lend themselves to reverse engineering source code include source
code that:
· You have already developed
· Is part of a third-party library that you have obtained permission to use
· Is part of a framework that your organization uses
· Is being developed on a daily basis by your developers.
Enterprise Architect currently supports reverse engineering in the following programming languages:
· ActionScript 1283
· Ada 2005 1284 (Systems Engineering and Ultimate editions)
· C 1285
· C# 1287
· C++ 1289
· Delphi 1292
· Java 1293
· PHP 1294
· Python 1295
· SystemC 1295 (Systems Engineering and Ultimate editions)
· Verilog 1298 (Systems Engineering and Ultimate editions)
· VHDL 1299 (Systems Engineering and Ultimate editions)
· Visual Basic 1301
· Visual Basic .NET 1296
Enterprise Architect is also able to reverse engineer certain types of binary files: Java .jar files and .NET PE
files. See Import Binary Module 1334 for more information.

Note:
Reverse Engineering of other languages is currently available through the use of MDG Technologies from
www.sparxsystems.com/resources/mdg_tech/.

7.2.6.1 Import Source Code

To import source code (reverse engineer) follow the steps below:
1. In the Project Browser, select (or add) a diagram into which to import the Classes.
2. Right-click on the diagram background to open the context menu and either:
· Select the language to import from the Import from source file(s) submenu, or
· Click on the Import Language drop-down arrow in the Code Generation toolbar and select the
Import | Import xxx files menu option, where xxx represents the language to import.
3. From the file browser that appears, select one or more source code files 1331 to import.

© 1998-2010 Sparx Systems Pty Ltd

 1330 Software Development | Software Engineering

4. Click on the Open button to start the import process.

As the import proceeds, Enterprise Architect provides progress information. When all files are imported,
Enterprise Architect makes a second pass to resolve associations and inheritance relationships between the
imported Classes.

Enterprise Architect User Guide

 Software Development | Software Engineering 1331

7.2.6.2 Notes on Source Code Import

Enterprise Architect enables you to import code 1329 into your project, in the following programming languages:
· ActionScript 1331
· C 1331
· C# 1331
· C++ 1331
· Delphi 1331
· Java 1331
· PHP 1332
· Python 1332
· Visual Basic 1332
· Visual Basic .NET 1332

Enterprise Architect supports most constructs and keywords for each coding language.
If there is a particular feature you require support for that you feel is missing, please contact Sparx Systems.
You must select the appropriate type of source file for the language, as the source code to import.

ActionScript
Appropriate type of source file: .as.

C
Appropriate type of source file: .h header files and/or .c files.

When you select a header file Enterprise Architect automatically searches for the corresponding .c
implementation file to import based on the options for extension and search path specified in the C options 1349

.
Enterprise Architect does not expand macros that have been used, these must be added into the internal list
of Language Macros 1344 .

C++
Appropriate type of source file: .h header file.

Enterprise Architect automatically searches for the .cpp implementation file based on the extension and
search path set in the C++ options 1351 . When it finds the implementation file it can use it to resolve parameter
names and method notes as necessary.
When importing C++ source code, Enterprise Architect ignores function pointer declarations. To import them
into your model you could create a typedef to define a function pointer type, then declare function pointers
using that type. Function pointers declared in this way are imported as attributes of the function pointer type.
Enterprise Architect does not expand macros that have been used; these must be added into the internal list
of Language Macros 1344 .

C#
Appropriate type of source file: .cs.

Delphi
Appropriate type of source file: .pas.

Java
Appropriate type of source file: .java.
Enterprise Architect supports the AspectJ language extensions.

© 1998-2010 Sparx Systems Pty Ltd

 1332 Software Development | Software Engineering

Aspects are modeled using Classes with the stereotype aspect. These aspects can then contain attributes and
methods as for a normal Class. If an intertype attribute or operation is required, you can add a tag className
with the value being the name of the Class it belongs to.
Pointcuts are defined as operations with the stereotype of pointcut. These can occur in any Java Class,
Interface or aspect. The details of the pointcut are included in the behavior field of the method.
Advice is defined as an operation with the stereotype advice. The pointcut this advice operates on is in the
behavior field and acts as part of the method's unique signature. After advice can also have one of the
Tagged Values returning or throwing.

PHP
Appropriate type of source file: .php, .php4, or .inc.

Python
Appropriate type of source file: .py.

Visual Basic
Appropriate type of source file: .cls Class file.

Visual Basic .NET

Appropriate type of source file: .vb Class file.

7.2.6.3 Import a Directory Structure

You can import from all source files in a complete directory structure. This process enables you to import or
synchronize multiple files in a directory tree in one pass. Enterprise Architect creates the necessary packages
and diagrams during the import process.
To import a directory structure, follow the steps below:
1. In the Project Browser, right-click on the target package for the import.
2. From the context menu, select the Code Engineering | Import Source Directory menu option. The
Import Source Directory dialog displays.

Enterprise Architect User Guide

 Software Development | Software Engineering 1333

3. Select the options you require. You can configure:

· The source directory
· The source type
· The file extensions to look at
· Whether to recurse sub directories
· Whether to create a diagram for each package
· Whether to import additional files as described in the Import Component Types dialog
· Whether to exclude private members from libraries being imported from the model
· Whether to create a package for every directory, namespace or file; this might be restricted
depending on the source type selected
· Whether to Synchronize or Overwrite existing Classes when found (if a model Class is found
matching the one in code, Synchronize updates the model Class to include the details from the one
in code, which preserves information not represented in code such as the location of Classes in
diagrams; Overwrite deletes the model Class and generates a new one from code, which deletes
and does not replace the additional information)
· How to handle Classes not found during the import (Prompt for action enables you to review
Classes individually 1335 )
· What is shown on diagrams created by the import.
4. Click on the OK button to start.

© 1998-2010 Sparx Systems Pty Ltd

 1334 Software Development | Software Engineering

7.2.6.4 Import Binary Module

Enterprise Architect enables you to reverse-engineer certain types of binary modules. To import a binary
module, right-click on the target package in the Project Browser and select the Code Engineering | Import
Binary Module context menu option.

Currently the permitted types are as follows:

· Java Archive (.jar)
· .Net PE file (.exe, .dll); native Windows DLL and EXE files are not supported, only PE files containing .NET
assembly data
· Intermediate Language file (.il).
Enterprise Architect creates the necessary packages and diagrams during the import process. Selecting the
Do not import private members checkbox excludes private members from libraries from being imported into
the model.
When importing .Net files,you can import via reflection or via disassembly, or let Enterprise Architect decide
the best method - this might result in both types being used. The reflection-based importer relies on a .Net
program, and requires the .Net runtime environment to be installed. The disassembler-based importer relies
on a native Windows program called Ildasm.exe, which is a tool provided with the MS .Net SDK. The SDK can
be downloaded from the Microsoft website.
A choice of import methods is available because some files are not compatible with reflection (such as
mscorlib.dll) and can only be opened using the disassembler. However, the reflection-based importer is
generally much faster.
You can also configure:
· Whether to Synchronize or Overwrite existing Classes when found (if a model Class is found matching
the one in the file, Synchronize updates the model Class to include the details from the one in the file,
which preserves information not represented in the file such as the location of Classes in diagrams;
Overwrite deletes the model Class and generates a new one from the file, which deletes and does not
replace the additional information)
· Whether to create a diagram for each package
· What is shown on diagrams created by the import.

7.2.6.5 MDG Integration and Code Engineering

MDG Integration for Eclipse and MDG Integration for Visual Studio are standalone products that provide an
enhanced code engineering functionality between Enterprise Architect and the development environments.
The MDG Integration programs provide a lightweight bridge between Enterprise Architect and the
development environment, offering enhanced code generation, reverse engineering and synchronization

Enterprise Architect User Guide

 Software Development | Software Engineering 1335

between code and the UML model. Merging changes can be achieved with minimal effort, and navigation
between model and source code is significantly enhanced.
A trial version of MDG Integration for Eclipse can be downloaded from www.sparxsystems.com/products/mdg/
int/eclipse/index.html and MDG Integration for Visual Studio can be downloaded from www.sparxsystems.com/
products/mdg/int/vs/index.html.

7.2.6.6 Classes Not Found During Import

When reverse synchronizing from your code, there are times when some Classes might be deliberately
removed from your source code. Enterprise Architect's import source directory functionality keeps track of the
Classes it expects to synchronize with and, on the Import Directory Structure dialog, provides options for how
to handle the Classes that weren't found. You can select the appropriate action so that, at the end of the
import, Enterprise Architect either ignores the missing Classes, automatically deletes them or prompts you to
handle them.
If you select the Prompt For Action 1332 radio button on the Import Directory Structure dialog, to manually
review missing Classes, the following dialog displays:

By default, all Classes are marked for deletion. To keep one or more Classes, select them and click on the
Ignore button.

7.2.7 Other Settings

You can set the default code options such as the editors for each of the programming languages available for
Enterprise Architect and special options for how source code is generated.

See Also
· General Options 1336
· Local Paths 1343
· Local Path Dialog 1343
· Language Macros 1344
© 1998-2010 Sparx Systems Pty Ltd
 1336 Software Development | Software Engineering

· Set Collection Classes 1345

7.2.7.1 Source Code Engineering

The following topics describe general options that apply to all languages when generating code from
Enterprise Architect. These options are all available under the Source Code Engineering section of the
Options dialog (select the Tools | Options | Source Code Engineering menu option).
· Source Code Options 1336
· Options - Code Editors 1337
· Options - Object Lifetimes 1340
· Options - Attribute/Operations 1341
· Synchronize Model and Code 1327
· Code Page for Source Editing 1342

7.2.7.1.1 Source Code Options

When you generate code for a particular language, you can set certain options. These include:
· Create a default constructor
· Create a destructor
· Generate copy constructor
· Select default language
· Generate methods for implemented interfaces
· Set the unicode options for code generation.
These options are accessed the Source Code Engineering page of the Options dialog (select the Tools |
Options | Source Code Engineering menu option).

Most of the settings are self-explanatory. The Remove prefixes when generating Get/Set properties field
enables you to specify prefixes used in your variable naming conventions, if those prefixes should be removed
in the variables' corresponding get/set functions.
Click on the Component Types button to configure what elements 1337 should be created for files of any
extension found while importing a source code directory.

Enterprise Architect User Guide

 Software Development | Software Engineering 1337

Note:
It is worthwhile to configure these settings, as they serve as the defaults for all Classes in the model. You can
override these on a per-Class basis using the custom settings (from the Code Generation dialog).

7.2.7.1.1.1 Import Component Types

The Import Component Types dialog enables you to configure what elements you would like to be created for
files of any extension found while importing a source code directory.
To access the Import Component Types dialog select the Tools | Options | Source Code Engineering menu
option to display the Source Code Engineering page of the Options dialog, and click on the Component
Types button.

For each extension you can specify:

· The element type to be created
· The stereotype to apply to these objects.

Note:
You can transport these import component types between models, using the Export Reference Data 223 and
Import Reference Data 225 options on the Tools menu.

7.2.7.1.2 Options - Code Editors

You access the source code editor options via the Code Editors page of the Options dialog (select the Tools |
Options | Source Code Engineering | Code Editors menu option). They enable you to configure options for
Enterprise Architect's internal editor, as well as the default editor for DDL scripts. You can configure external
editors for code languages on each language options page.

© 1998-2010 Sparx Systems Pty Ltd

 1338 Software Development | Software Engineering

The options for the inbuilt editor are:

Option Use to

Use inbuilt editor if no Specify the editor for code in a language if no external editor is defined for
external editor set that language.

Show Line Numbers Show line numbers in the editor.

Show Structure Tree Show a tree with the results of parsing the open file (requires that the file is
parsed successfully).

Don't parse files larger than Specify an upper limit on file size for parsing. Used to prevent performance
decrease due to parsing very large files.

Syntax Highlighting Options Specify both global and language-specific editor language properties 1338 .

7.2.7.1.2.1 Editor Language Properties

Enterprise Architect enables you to specify syntax highlighting 1429 properties for all the programming
languages that Enterprise Architect supports at installation. (You cannot currently set properties for any
additional languages you include through an MDG Technology 1128 ).
On the Code Editors 1337 page of the Options dialog, click on the [ ... ] (Browse) button next to the Syntax
Highlighting Options field. The Editor Language Properties dialog displays. You can resize this dialog, if
required.

Enterprise Architect User Guide

 Software Development | Software Engineering 1339

General Features
The panel on the left of the dialog lists the languages for which you can set properties. The (Global) item at
the top of the list enables you to set properties that apply to all programming languages; however, you can
reset a global property to a different value for a specific language, on the page for that language. Resetting a
global property for one language does not affect that property's value for the other languages.
Click on the required language in the list, to display the properties for that language. Those properties shown
in bold indicate that this is the highest level at which this property can be defined (for most language options
other than Global, this is effectively the only point at which the property is defined). Properties shown in
normal font are generally the global properties that you can reset just for the current language.
Scroll through the property categories and individual properties for the language. You can collapse and
expand categories as necessary, using the expansion box next to the category name ( ).
When you click on a property name, an explanation of that property displays in the panel at the bottom right of
the dialog, as shown for Tabs Use Spaces in the screen example above.

Define Properties
To define a property, click on the value field following the property name. Depending on the type of property,
either the field is enabled for direct editing or a drop-down arrow or Browse button displays (as described for
the Tagged Values 635 window) to enable you to select the values to define the property. Select or type in the
required values.
The Toolbar icons enable you to:
· Save your changes to the properties
· Reset ALL properties fields to the default settings shipped with Enterprise Architect
· Reset the current style field to the default setting (not enabled for non-style fields).

Assign Keys to Macros

On the Editor Language Properties dialog, the Macros category enables you to assign [Ctrl]+[Alt] keystrokes
to coding macros that you have created yourself in the Source Code Viewer 1442 . When you click on the
Browse button in one of the Macro fields, the Open Macro dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1340 Software Development | Software Engineering

This dialog lists the existing macros and, if a key combination has been assigned to a macro, what that key
combination is. These keys are [Ctrl]+[Alt]+[n] combinations.

Click on the name of the macro and on the Open button to assign the selected keys to the macro.

7.2.7.1.3 Options - Object Lifetimes

This set of options enables you to configure:
· Constructor details when generating code
· Whether to create a copy constructor
· Destructor details.
These options are accessed via the Object Lifetimes page of the Options dialog (select the Tools | Options |
Source Code Engineering | Object Lifetimes menu option).

Enterprise Architect User Guide

 Software Development | Software Engineering 1341

7.2.7.1.4 Options - Attribute/Operations

This set of options enables you to:
· Configure the default name generated from imported attributes
· Generate methods for implemented interfaces
· Delete model attributes not included in the code during reverse synchronization
· Delete model methods not included in the code during reverse synchronization
· Delete code from features contained in the model during forward synchronization
· Delete model associations and aggregations that correspond to attributes not included in the code during
reverse synchronization
· Define whether or not the bodies of methods are included and saved in the Enterprise Architect model
when reverse engineering
· Create attributes in quick succession, clearing the dialog when you click on Save so that you can enter
another attribute name.
These options are accessed via the Attribute/Operations page of the Options dialog (select the Tools |
Options | Source Code Engineering | Attribute/Operations menu option).

© 1998-2010 Sparx Systems Pty Ltd

 1342 Software Development | Software Engineering

7.2.7.1.5 Code Page for Source Editing

Enterprise Architect enables you to define the Unicode character set for code generation. To set the Unicode
character set follow the steps below:
1. Select the Tools | Options | Source Code Engineering menu option. The Source Code Engineering
page of the Options dialog displays.

Enterprise Architect User Guide

 Software Development | Software Engineering 1343

2. In the Code page for source editing field, click on the drop-down arrow and select the appropriate
Unicode character set.
3. Click on the Close button.

7.2.7.2 Local Paths

Sometimes a team of developers could be working on the same Enterprise Architect model. Each developer
might store their version of the source code in their local file system, but not always at the same location as
their fellow developers. To handle this scenario, Enterprise Architect enables you to define local paths for each
Enterprise Architect user, using the Local Paths 1343 dialog (select the Settings | Local Paths menu option).
As well as generating code and reverse engineering, you can use local paths in version control, developing
XML schemas, and generating RTF and HTML reports.
Local paths take a bit of setting up, but if you want to work collaboratively on source and model concurrently,
the effort is well worth while.
For example: developer A stores their .java files in a C:\Java\Source directory, while developer B stores theirs
in D:\Source. Meanwhile, both developers want to generate and reverse engineer into the same Enterprise
Architect model located on a shared (or replicated) network drive.
Developer A might define a local path of:
JAVA_SOURCE = "C:\Java\Source"
All Classes generated and stored in the Enterprise Architect project are stored as:
%JAVA_SOURCE%\<xxx.java>.
Developer B now defines a local path as:
JAVA_SOURCE ="D:\Source".
Now, Enterprise Architect stores all java files in these directories as:
%JAVA_SOURCE%\<filename>
On each developer's machine, the filename is expanded to the correct local version.

7.2.7.3 Local Paths Dialog

The Local Paths dialog enables you to set up local paths for a single user on a particular machine. For a
description of what Local Paths are used for, see the Local Paths 1343 topic. To open the Local Paths dialog,
select the Settings | Local Paths option.

The Local Paths dialog enables you to define:

· Path - the local directory in the file system (for example, d:\java\source)
· ID - the shared ID that is substituted for the Local Path (for example, JAVA_SRC)
· Type - the language type (for example, Java).

© 1998-2010 Sparx Systems Pty Ltd

 1344 Software Development | Software Engineering

And also to:

· Apply Path - Select a path and click on this button to update any existing paths in the model (with full path
names) to the shared relative path name (so d:\java\source\main.java might become %JAVA_SRC%\main.java)
· Expand Path - The opposite of Apply Path. This enables you to remove a relative path and substitute the
full path name.
Using the two options you can update and change existing paths.

Note:
You can also set up a hyperlink 840 on a diagram to access the Local Paths dialog, to switch, update or
expand your current Local Path.

7.2.7.4 Language Macros

When reverse engineering a language such as C++, you might find preprocessor directives scattered
throughout the code. This can make code management easier, but can hamper parsing of the underlying C++
language.
To help remedy this, you can include any number of macro definitions, which are ignored during the parsing
phase of the reverse engineering. It is still preferable, if you have the facility, to preprocess the code using the
appropriate compiler first; this way, complex macro definitions and defines are expanded out and can be
readily parsed. If you don't have this facility, then this option provides a convenient substitute.

Note:
You can transport these language macro (or preprocessor macro) definitions between models, using the
Export Reference Data 223 and Import Reference Data 225 options on the Tools menu. The macros are
exported as a Macro List.

Define a Macro
1. Select the Settings | Preprocessor Macros menu option. The Language Macros dialog displays.

2. Click on the Add New button.

3. Enter details for your macro.
4. Click on the OK button.

Macros Embedded Within Declarations

Macros are sometimes used within the declaration of Classes and operations, as in the following examples:
class __declspec Foo
{
int __declspec Bar(int p);
};

Enterprise Architect User Guide

 Software Development | Software Engineering 1345

If declspec is defined as a C++ macro, as outlined above, the imported Class and operation contain a Tagged
Value called DeclMacro1 with value __declspec. (Subsequent macros would be defined as DeclMacro2,
DeclMacro3 and so on.) During forward engineering, these Tagged Values are used to regenerate the macros
in code.

Define Complex Macros

It is sometimes useful to define rules for complex macros that can span multiple lines. Enterprise Architect
ignores the entire code section defined by the rule. Such macros can be defined in Enterprise Architect as in
the following two examples. Both types can be combined in one definition.
Block Macros
BEGIN_INTERFACE_PART ^ END_INTERFACE_PART
where the ^ symbol represents the body of the macro. This enables skipping from one macro to another.

Note:
The spaces surrounding the ^ symbol are required.

Function Macros
RTTI_EMULATION()
where Enterprise Architect skips over the token including everything inside the parentheses.

7.2.7.5 Set Collection Classes

Enterprise Architect enables you to define Collection Classes for generating code from Association connectors
where the target role has a multiplicity setting greater than 1. There are two options for doing this:
1. On the Source Code Engineering section of the Options dialog (select the Tools | Options | Source
Code Engineering option), on each language page click on the Collection Classes button.

The Collection Classes for Association Roles dialog displays.

On this dialog, you can define:

· The default Collection Class for 1..* roles
· The ordered Collection Class to use for 1..* roles
· The qualified Collection Class to use for 1..* roles.
2. On the Detail tab of the Class Properties dialog (accessible from the right-click context menu of any
Class), click on the Collection Classes button.

© 1998-2010 Sparx Systems Pty Ltd

 1346 Software Development | Software Engineering

The Collection Classes for Association Roles dialog again displays, but here you define for when only
this Class is used:
· The default Collection Class for 1..* roles
· The ordered Collection Class to use for 1..* roles
· The qualified Collection Class to use for 1..* roles.
When Enterprise Architect generates code for a connector that has a multiplicity role >1, the Collection Class
is calculated as follows:
1. If the Qualifier is set use the qualified collection:
· for the Class if set
· else use the code language qualified collection.
2. If the Order option is set use the ordered collection:
· for the Class if set
· else use the code language ordered collection.
3. Else use the default collection:
· for the Class if set
· else use the code language default collection.

Note:
You can include the marker #TYPE# in the collection name; Enterprise Architect replaces this with the name
of the Class being collected at source generation time (for example, Vector<#TYPE#> would become
Vector<foo>).

Additionally, on both the Source Role and Target Role tabs of the Association Property dialog (accessible from
the right-click context menu of any Association) there is a Member Type field. If you set this, the value you
enter overrides all the above options. The example below shows a defined PersonList; when code is
generated, because this has a Multiplicity greater than 1 and the Member Type is defined, the variable
created is of type PersonList.

Enterprise Architect User Guide

 Software Development | Software Engineering 1347

7.2.7.6 Language Options

You can set up various options for how Enterprise Architect handles a particular language when generating
code. These options are accessible on the Options dialog (select the Tools | Options menu option).

Under the Source Code Engineering option, select the required language. The following topics outline the
options available for each language.
· ActionScript 1348
· Ada 2005 1348 (in the System Engineering and Ultimate editions of Enterprise Architect)
· ANSI C 1349
· C# 1350
· C++ 1351
· Delphi 1352
· Delphi Properties 1353
· Java 1355
· PHP 1356
· Python 1356
· SystemC 1357
· VB.Net 1358
· Verilog 1358
· VHDL 1359
· Visual Basic 1360
· MDG Technology Languages 1360
· Reset Options 1361

© 1998-2010 Sparx Systems Pty Ltd

 1348 Software Development | Software Engineering

7.2.7.6.1 ActionScript Options

Configure options for ActionScript code generation using the ActionScript Specifications page of the Options
dialog (select the Tools | Options | Source Code Engineering | ActionScript menu option). The options you
can specify include the:
· Default ActionScript version to generate (AS2.0 or AS3.0)
· Default file extensions (header and source)
· Default source directory
· Editor for ActionScript code.

7.2.7.6.2 Ada 2005 Options

Note:
Ada 2005 support is available in the System Engineering and Ultimate editions of Enterprise Architect.

Configure options for Ada 2005 code generation using the Ada page of the Options dialog (select the Tools |
Options | Source Code Engineering | Ada menu option). The options you can specify include:
· Use Class Name for Tagged Record - to inform the reverse engineering process whether the name of the
Tagged Record is the same as the package name
· Alternate Tagged Record Name - to advise the engine of the alternate Tagged Record name to locate
· Define Reference for Tagged Record - to specify whether the engine should create a reference type for the
Tagged Record ( if one is not defined)
· Reference Type Name - to supply the name of the reference type to be created (default is Ref)
· Ref Parameter Style - to specify the reference parameter of a Reference / Access type
· Ignore Reference Parameter Name - to tell the engine to ignore the name of the reference parameter
· Ref Parameter Name - to indicate the name of the reference parameter to locate

Enterprise Architect User Guide

 Software Development | Software Engineering 1349

7.2.7.6.3 C Options
Configure options for C code generation using the C Specifications page of the Options dialog (select the
Tools | Options | Source Code Engineering | C menu option). The options you can specify include:
· Support for Object Oriented coding
· Default file extensions (header and source)
· Default source directory
· Editor for C code
· Path that Enterprise Architect uses to search for the implementation file; the first path in the list is the
default path when generating.

© 1998-2010 Sparx Systems Pty Ltd

 1350 Software Development | Software Engineering

7.2.7.6.4 C# Options
Configure options for C# code generation using the C# Specifications page of the Options dialog (select the
Tools | Options | Source Code Engineering | C# menu option). The options you can specify include the
default:
· File extension
· 'Get' prefix
· 'Set' prefix
· Directory for opening and saving C# source code.

Enterprise Architect User Guide

 Software Development | Software Engineering 1351

7.2.7.6.5 C++ Options

Configure options for C++ code generation using the C++ Specifications page of the Options dialog (select
the Tools | Options | Source Code Engineering | C++ menu option). The options you can specify include:
· The version of C++ to generate; this controls the set of templates used and how properties are created
· The default reference type used when a type is specified by reference
· The default file extensions
· Default Get/Set prefixes
· Default source directory
· The path that Enterprise Architect uses to search for the implementation file. The first path in the list is the
default path when generating new implementation files and parsing existing files; if you add further
directories, Enterprise Architect also searches these when parsing existing files.

For example, you have a directory inc that contains all of your headers, while the source code is mixed
through directories src, srca, and srcb. You therefore set the Source Path option to ../src/;../srca/;../srcb/.
This ensures that new implementation files are generated into src, but when parsing existing files
Enterprise Architect looks in all three source directories (but never in the inc directory). You must still
ensure that the implementation file name matches the header file name, and that the file extension
matches the extension specified in the options. If these conditions are not met, Enterprise Architect cannot
handle that code.

© 1998-2010 Sparx Systems Pty Ltd

 1352 Software Development | Software Engineering

7.2.7.6.6 Delphi Options

Configure options for Delphi code generation using the Delphi Specifications page of the Options dialog
(select the Tools | Options | Source Code Engineering | Delphi menu option). The options you can specify
include the:
· Default file extension
· Default source directory
You can also set a default directory for opening and saving Delphi source code.

Enterprise Architect User Guide

 Software Development | Software Engineering 1353

You should also set Delphi properties 1353 within each Class element.

7.2.7.6.6.1 Delphi Properties

Enterprise Architect has comprehensive support for Delphi properties. These are implemented as Tagged
Values, with a specialized property editor to help create and modify Class properties. The Class image below
illustrates the appearance of a Delphi Class that has had properties added to it. These are stored as Tagged
Values, and by using the Feature Visibility element context menu option, you can display the 'tags'
compartment that contains the properties. Imported Delphi Classes with properties have this feature
automatically made visible for your convenience.

Note:
When you use the Create Property dialog from the Attribute screen, Enterprise Architect generates a pair of
Get and Set functions, together with the required property definition as Tagged Values. You can manually edit
these Tagged Values if required.

To manually activate the property editor

1. Ensure the Class you have selected has the code generation language set to Delphi
2. Right-click on the Class and select the Delphi Properties context menu option to open the editor.
© 1998-2010 Sparx Systems Pty Ltd
 1354 Software Development | Software Engineering

The Delphi Properties editor enables you to build properties in a simple and straightforward manner. From
here you can:
· Change the name and scope (only Public and Published are currently supported)
· Change the property type (the drop-down list includes all defined Classes in the project)
· Set the Read and Write information (the drop-down lists have all the attributes and operations from the
current Class; you can also enter free text)
· Set Stored to True or False
· Set the Implements information
· Set the Default value, if one exists.

Notes:
· Public properties are displayed with a '+' symbol prefix and published with a '^'.
· When creating a property in the Create Property Implementation dialog (accessed through the Attributes
dialog), you can set the scope to Published if the property type is Delphi - see the example below.

Enterprise Architect User Guide

 Software Development | Software Engineering 1355

Limitations
· Only Public and Published are supported
· If you change the name of a property and forward engineer, a new property is added, but the old one must
be manually deleted from the source file.

7.2.7.6.7 Java Options

Configure options for Java code generation using the Java Specifications page of the Options dialog (select
the Tools | Options | Source Code Engineering | Java menu option). The options you can specify include
the:
· Default file extension
· Default 'Get' prefix
· Default 'Set' prefix
You can also set a default directory for opening and saving Java source code.

© 1998-2010 Sparx Systems Pty Ltd

 1356 Software Development | Software Engineering

7.2.7.6.8 PHP Options

Configure options for PHP code generation using the PHP Specifications page of the Options dialog (select
the Tools | Options | Source Code Engineering | PHP menu option). The options you can specify include
the:
· Default source extension - specify the extension to be used when creating files for PHP source
· Default import extension - a semi-colon separated list of extensions to look at when doing a directory code
import 1332 for PHP
· Default PHP version - the version of PHP to generate.
You can also set a default directory for opening and saving PHP source code.

7.2.7.6.9 Python Options

Configure options for Python code generation using the Python Specifications page of the Options dialog
(select the Tools | Options | Source Code Engineering | Python menu option). The options you can specify
include the:
· Default file extension(s)
· Default source directory.
You can also set the editor for Python code.

Enterprise Architect User Guide

 Software Development | Software Engineering 1357

7.2.7.6.10 SystemC Options

Configure options for SystemC code generation using the SystemC page of the Options dialog (select the
Tools | Options | Source Code Engineering | SystemC menu option). The options you can specify include
the:
· Default file extension(s)
· Default source directory
· Editor for changing code.

© 1998-2010 Sparx Systems Pty Ltd

 1358 Software Development | Software Engineering

7.2.7.6.11 VB.Net Options

Configure options for VB.Net code generation using the VB.Net Specifications page of the Options dialog
(select the Tools | Options | Source Code Engineering | VB.Net menu option). The options you can specify
include the:
· Default file extension
· Default source directory.

7.2.7.6.12 Verilog Options

Configure options for Verilog code generation using the Verilog page of the Options dialog (select the Tools |
Options | Source Code Engineering | Verilog menu option). The options you can specify include the:
· Default file extension(s)
· Default source directory
· Editor for changing code.

Enterprise Architect User Guide

 Software Development | Software Engineering 1359

7.2.7.6.13 VHDL Options

Configure options for VHDL code generation using the VHDL page of the Options dialog (select the Tools |
Options | Source Code Engineering | VHDL menu option). The options you can specify include the:
· Default file extension(s)
· Default source directory
· Editor for changing code.

© 1998-2010 Sparx Systems Pty Ltd

 1360 Software Development | Software Engineering

7.2.7.6.14 Visual Basic Options

Configure options for Visual Basic code generation using the VB Specifications page of the Options dialog
(select the Tools | Options | Source Code Engineering | Visual Basic menu option). The options you can
specify include the:
· Default file extension when reading/writing
· Default Visual Basic version
· MTS transaction mode for MTS objects
· Multi use (true or false)
· Persistable
· Data binding
· Global namespace
· Exposed
· Data source behavior
· Creatable.

7.2.7.6.15 MDG Technology Language Options

If you have loaded an MDG Technology 1118 that specifies a code module 1128 into your Sparx Systems > EA >
MDG Technologies folder, the language is included in the Source Code Engineering list on the Options
dialog. The language is only listed on the Options dialog if an MDG Technology file actually uses it in your
model.
The options for each language are based on what is defined in the technology code module, but are limited to
the following:
· Default Extension
· Default extension for generated source files
· Shown if the option is in the technology
· Saved per project.
· Import File Extensions
· Default folder to import source files from
· Shown if there is a grammar set in the technology

Enterprise Architect User Guide

 Software Development | Software Engineering 1361

· Saved once for all projects.

· Generate Namespaces
· Option to generate namespaces or not
· Shown if the technology supports namespaces
· Saved once for all projects.
· Default Source Directory
· The default directory to save generated source files
· Always shown
· Saved once for all projects.
· Editor
· The editor that is loaded to edit the source files
· Always shown
· Saved once for all projects.
· Att Type
· Default type for attributes
· Always shown
· Saved once for all projects.

These options are set in the technology inside the <CodeOptions> tag of a code module, as follows:
<CodeOption name="DefaultExtension">.rb</CodeOption>

7.2.7.6.16 Reset Options

Enterprise Architect stores some of the options for a Class when it is first created. Some are global; for
example $LinkClass is stored when you first create the Class, so it won't automatically pick up the global
change in the Options dialog in existing Classes. You must modify the options for the existing Class.

Modify Options for Single Class

To modify options for a single Class, follow the steps below:

© 1998-2010 Sparx Systems Pty Ltd

 1362 Software Development | Software Engineering

1. Right-click on the Class to change, and select the Generate Code menu option from the context menu.
The Generate Code dialog displays.
2. Click on the Advanced button. The Object Options dialog displays.
3. Click on the Attributes/Operations button.
4. Change the options, and click on the Close button to apply changes.

Modify Options for All Classes

To modify options for all Classes within a package, follow the steps below:
1. Right-click on the package in the Project Browser. The context menu displays.
2. Select the Code Engineering | Reset Options for this Package menu option. The Manage Code
Generation dialog displays.

3. Reset the required defaults for each existing Class.

4. Click on the OK button to apply changes.

Enterprise Architect User Guide

 Software Development | Database Engineering 1363

7.3 Database Engineering

This section describes database engineering, explaining:

· How to import database schema 1363 , and
· How to generate DDL 1367 for the model.
For information on database modeling, see the Data Models 1011 topic.

7.3.1 Import Database Schema

Analysis of legacy database systems is possible using Enterprise Architect’s reverse engineering 1328
capabilities. By connecting to a live database via ODBC, you can import the database schema into a standard
UML model. Subsequent imports enable you to maintain synchronization between the data model and the live
database.
Enterprise Architect supports importing database tables from an ODBC data source. Tables are imported as
stereotyped Classes with suitable data definitions for the source DBMS.

Notes:
· Import of stored procedures and views is supported for: DB2; SQL Server; Firebird/Interbase; Informix;
Ingres; Oracle 9i, 10g and 11g; MySQL; PostgreSQL; Sybase Adaptive Server Enterprise (ASE) and
Sybase Adaptive Server Anywhere (ASA).
· If you are importing database schema from an MS Access Jet 4.0 database, please ensure that you have
selected the Use Jet 4.0 checkbox on the General 351 page of the Options dialog. Otherwise, the Jet 3.5
routines are loaded. You must restart Enterprise Architect after selecting the checkbox.
· The ODBC connection should use the ODBC driver available from the DBMS vendor. For example,
MySQL's ODBC driver for MySQL, and Oracle's ODBC driver for Oracle. Drivers provided by third-party
vendors are not supported - this includes the Microsoft ODBC driver for Oracle.
· If setting up a ODBC connection for reverse engineering, the default settings are sufficient.
· Additional data types are available from the Datamodeling Data Types section of the Resources page on
the Sparx Systems website.

Import Database Tables and Stored Procedures

To import database tables and stored procedures, follow the steps below:
1. Select any package in the Logical View.
2. To import into:
· The package only, right-click on the package to display the context menu, and select the Code
Engineering | Import DB Schema from ODBC menu option.
· A diagram, right-click on the diagram in the selected package to open the context menu, and select
the Import DB schema from ODBC menu option.

Note:
Alternatively you can select the Project | Database Engineering | Import DB Schema from ODBC
menu option.

The Import DB Schema from ODBC Source dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1364 Software Development | Database Engineering

3. In the Database field, click on the [ ... ] (Browse) button and select a suitable ODBC data source 1365

from the ODBC dialog (ODBC must be installed and configured on your machine for this to work
correctly).

When you have selected the data source, the Database field shows the DBMS, the database server ID
and the database name, separated by full stops; that is:
dbms.dbserver.database.
4. If importing from Oracle, to restrict the import to a specific owner, type the owner name in the
Schema/Owner field. By default, Enterprise Architect inserts the Oracle user name in this field.

For imports from other types of database, leave this field blank.
5. In the Filter panel, select the appropriate checkboxes for additional items to include in the import.

Select the appropriate checkboxes to import system tables and views, user views, triggers and/or
Oracle packages.

If you select to import User Functions and/or User Sequences as individual Classes, then they are
imported as separate elements and the Properties dialog is solely concerned with the Function or
Sequence definition. For Stored Procedures, always select this option

Enterprise Architect User Guide

 Software Development | Database Engineering 1365

If you select to import User Functions and/or User Sequences as Class operations, then they are
imported as operations (methods) and you view and edit them through the Operations Properties dialog
of the parent Class.
6. When synchronizing existing Classes, select the appropriate checkbox in the Synchronization panel to
determine whether the model comments, default values or constraints are to be synchronized with the
ODBC tables, or as new objects.

Note:
It is only possible to import into a diagram if it is in the selected package. If a diagram from another
package is open, a message displays to give the option to cancel the import or to continue importing
into the package only. The Import DB Schema from ODBC Source dialog includes checkbox options to
import into the diagram and package, or into the package only.
If no diagram is open, the Package Only radio button defaults to selected and the options are
disabled. If the open diagram is in the selected package, you can select either option.

7. Click on the Import button to start the import.

8. Select the tables 1366 and - if appropriate - stored procedures to import.
This completes the procedure. See the Imported Class Elements 1367 topic.

7.3.1.1 Select a Data Source

To import DDL from existing data sources, you must have a suitable ODBC connection installed and
configured 147 . From the Import DB Schema from ODBC Source dialog you can select the ODBC data source
using the standard windows ODBC set-up dialog. Click on the data source name and then click on the OK
button.

© 1998-2010 Sparx Systems Pty Ltd

 1366 Software Development | Database Engineering

7.3.1.2 Select Tables

When you have opened the ODBC data source, Enterprise Architect acquires a list of tables and stored
procedures suitable for importing. This is presented in a list form for you to select from.

Highlight the tables and stored procedures to import and clear those you do not require.
Selection shortcuts:
· To select all tables and procedures, click on the Select All button
· To clear all tables and procedures, click on the Select None button
· Hold down [Ctrl] while clicking on tables and procedures to select multiple objects
· Hold down [Shift] and click on tables and procedures to select a range.
When you have selected the tables and procedures, click on the OK button.

Enterprise Architect User Guide

 Software Development | Database Engineering 1367

7.3.1.3 The Imported Class Elements

When you import DDL table definitions they are converted to stereotyped Classes according the UML Data
Modeling Profile.
The image below shows some example tables imported into the model using an ODBC data connection.

7.3.2 Generate DDL

The following topics describe how to generate DDL from your model for:
· Tables 1367 and
· Packages 1369 .

7.3.2.1 Generate DDL For a Table

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Generate Source Code and DDL 198 permission to
generate DDL.

To generate simple DDL scripts to create the tables in your model, follow the steps below:
1. In the diagram, right-click on the table for which to generate DDL. The context menu displays.
2. Select the Generate DDL option. The Generate DDL dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1368 Software Development | Database Engineering

3. In the Path field, use the [ ... ] (Browse) button to select the filename of the script to create.
4. To include comments in the DDL, in the Comment Level field select the appropriate level. For
example, Column for comments on columns, or All for comments on all structures.
5. Select the checkboxes for the appropriate inclusions. For example, to include a 'drop table' command in
the script, select the Create Drop SQL checkbox. Deselect the checkboxes for inclusions you do not
require.

Notes:
· Some checkboxes display only if the appropriate database is defined for the table. For example, IF
EXISTS displays only if the database for the table is PostgreSQL.
· For a PostgreSQL database, you must select the Generate Sequences checkbox to enable auto
increment columns to be created.
· If generating Oracle sequences, you must always select the Generate Triggers and Generate
Sequences checkboxes; this ensures that a pre-insert trigger is generated to select the next
sequence value to populate the column. Also set the AutoNum 1021 property to True in the column
properties.

6. To create the DDL, click on the Generate button.

7. To view the output, click on the View button (you must configure a DDL viewer in the Local Settings
dialog first).

Enterprise Architect User Guide

 Software Development | Database Engineering 1369

Note:
You can transport these DDL scripts between models, using the Export Reference Data 223 and Import
Reference Data 225 options on the Tools menu.

7.3.2.2 Generate DDL for a Package

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Generate Source Code and DDL 198 permission to
generate DDL.

In this procedure, you can generate DDL for a package, and also compare the DDL with the database.

Generate DDL
To generate DDL for a package, follow the steps below:
1. Right-click on the required package in the Project Browser. The context menu displays.
2. Select the Code Engineering | Generate DDL menu option. The Generate Package DDL dialog
displays.

© 1998-2010 Sparx Systems Pty Ltd

 1370 Software Development | Database Engineering

Note:
Alternatively you can select the Project | Database Engineering | Generate Package DDL menu
option.

3. Select the checkbox against each inclusion required. Deselect the checkboxes for inclusions you do not
require.

Enterprise Architect User Guide

 Software Development | Database Engineering 1371

Notes:
· Some checkboxes display only if the appropriate database is defined for the tables in the package.
For example, IF EXISTS displays only if the database for the tables is PostgreSQL.
· If generating Oracle sequences, you must always select the Generate Triggers and Generate
Sequences checkboxes; this ensures that a pre-insert trigger is generated to select the next
sequence value to populate the column. Also set the AutoNum 1021 property to True in the column
properties.

4. To recursively generate DDL, select the Include All Child Packages checkbox.
5. Click on the Generate button to proceed. Enterprise Architect prompts you for file names as the
process executes.

Compare DDL For a Database

When you have generated the DDL, you can compare it with the database. To do this, follow the steps below:
1. On the Generate Package DDL dialog, click on the Compare button. The Compare With Database
dialog displays.

2. Click on the [ ... ] button and locate the required database on the Select Data Source dialog.
3. For an Oracle database, if required you can also specify the Owner in the Schema/Owner field.
4. Click on the View button to perform the comparison. The Comparison Database dialog displays with the
results of the comparison. Click on each table name to review information on that table.

© 1998-2010 Sparx Systems Pty Ltd

 1372 Software Development | Database Engineering

Enterprise Architect User Guide

 Software Development | XML Engineering 1373

7.4 XML Engineering

This section explains how to import:

· XSD 1373
· WSDL 1376
and how to generate:
· XSD 1376
· WSDL 1379
It also describes how to generate and export Meta-Object Facility (MOF 1380 ) models.

7.4.1 Import XSD

The XML Schema Import facility is used to reverse engineer a W3C XML Schema (XSD) file as a UML Class
model. An XSD file is imported into Enterprise Architect as a UML package. To import an XSD file, follow the
steps below:
1. In the Project Browser, right-click on the package to contain the imported XSD package. The context
menu displays.
2. Select the Code Engineering | Import XML Schema menu option. The Import XML Schema dialog
displays.

© 1998-2010 Sparx Systems Pty Ltd

 1374 Software Development | XML Engineering

3. In the Directory field, click on the [ ... ] (Browse) button. The Select XML Schema(s) dialog displays.
4. Click on the required input file. To select several individual files, press [Ctrl] as you click on each one.
To select a range of files, press [Shift] and click on the first and last file in the range.
5. Click on the Open button to return to the Import XML Schema dialog, which now shows the selected
files in the Selected File(s) field.
6. The Import global elements with "Type" postfix 1375 checkbox defaults to unselected to import a
global element, and the ComplexType to which it refers, as a single ComplexType Class.
7. The Import referenced XML Schema(s) checkbox defaults to selected, to import any other Schema file
referenced by the selected input XML Schema file or files.

Note:
If an XML Schema file being imported already exists in the model, Enterprise Architect skips importing
the file.

8. The Create Diagram for XML Schema(s) checkbox defaults to selected, to display the imported
elements on the diagram. If necessary, deselect the checkbox.
9. For the Import XSD Elements/Attributes as: field, select the appropriate radio button to import
elements and attributes in the XML Schema as:
· UML Association connectors or
· UML Class attributes.
10. Click on the Import button to import the schema.
11. The progress of the schema import is shown in the Progress status bar.

Enterprise Architect User Guide

 Software Development | XML Engineering 1375

Tip:
The Import XML Schema dialog can also be accessed for the active diagram by selecting the Project | XML
Schema | Import XML Schema menu option.

Note:
Enterprise Architect uses the schemaLocation attribute in the Import and Include elements of an XML
Schema to determine the dependencies between the files. Ensure that this attribute is set to a valid file path
(and not a URL) for the dependent XML Schema(s) to be imported correctly.

7.4.1.1 Global Element and ComplexType

Some XML Schemas have ComplexType elements with the same name as the referring global elements, but
with the suffix Type as shown below:
<xs:element name="Address" type="AddressType"/>
<xs:complexType name="AddressType">
<xs:sequence/>
</xs:complexType>
On XSD import, Enterprise Architect treats this global element and its bounding ComplexType as a single
entity and creates a single XSDcomplexType stereotyped Class with the same name as the global element as
shown below:

You can change this default behaviour by selecting the Import global elements with "Type" postfix
checkbox. When you select this option, Enterprise Architect treats the global element and the ComplexType it
is referring to as two separate entities. So, for the above example, Enterprise Architect creates an
XSDtopLevelElement stereotyped Class for the global element and an XSDcomplexType stereotyped Class
for the ComplexType, and connects them as follows:

Note:
Enterprise Architect treats the following as two separate entities irrespective of whether the Import global
elements with "Type" postfix checkbox is selected or unselected:
<xs:element name="HomeAddress" type="AddressType"/>
<xs:complexType name="AddressType">
<xs:sequence/>
</xs:complexType>

© 1998-2010 Sparx Systems Pty Ltd

 1376 Software Development | XML Engineering

7.4.2 Import WSDL

The WSDL Import facility is used to reverse engineer WSDL files into UML Class models.

Note:
Enterprise Architect cannot import a WSDL file that references WSDL constructs existing outside the target
file. For example, Enterprise Architect can import a WSDL as shown in
http://www.w3.org/TR/wsdl.html#_example1 but not a file as shown in http://www.w3.org/TR/wsdl.html#_style.
Attempting to import the second WSDL file would result in the following error message:
Cannot Import Split Files.
To avoid this limitation, combine the split WSDL files into a single file and then import it into Enterprise
Architect.

To import a WSDL file, follow the steps below:

1. In the Project Browser, right-click on the package to contain the imported WSDL package. The context
menu displays.
2. Select the Code Engineering | Import WSDL menu option. The Import WSDL dialog displays.

3. In the Filename field, select the input file.

4. The Target Package field is automatically set to the name of the selected input file. If required, change
this name.
5. Click on the Import button to import the schema.
6. The progress of the WSDL import is shown in the Progress status bar.

7.4.3 Generate XSD

The Generate XML Schema feature forward engineers a UML Class model to a W3C XML Schema (XSD) file.
An XML schema corresponds to a UML package in Enterprise Architect, therefore XML schema generation is
a package-level operation. To generate an XML schema from a package, follow the steps below:
1. In the Project Browser, right-click on the package to be converted to XSD. The context menu displays.
2. Select the Code Engineering | Generate XML Schema menu option. The Generate XML Schema
dialog displays, showing the name of the selected package in the Source Package field.

Enterprise Architect User Guide

 Software Development | XML Engineering 1377

3. In the Encoding field, set the required XML encoding.

4. In the XSD Style panel, the Generate global element for all global ComplexTypes checkbox is
selected by default to generate schema in the Garden of Eden style 1378 .
5. In the Referenced Package Options panel, select the:
· Generate XSD for Referenced packages checkbox to generate schema for packages that are
referenced by any of the packages selected in the list box
· Prompt when missing Filename checkbox to enable Enterprise Architect to prompt for a filename
for a referenced package during schema generation, if the filename is missing.
6. In the Child Package Options panel, select the:
· Generate XSD for Child Packages checkbox to generate schema for child packages of the
selected package
· Include all packages radio button to list all child packages under the parent package in the list box
· Include <XSDschema> packages radio button to list only those packages that have the stereotype
«XSDschema».
The list box displays, for each package, the package name and the file path where the schema file is to
be generated.
7. If it is necessary to change the file path for a package, double-click on the entry in the list box and, on
the Select XML File dialog, type or select the appropriate file path.

© 1998-2010 Sparx Systems Pty Ltd

 1378 Software Development | XML Engineering

8. Ensure that the checkbox is selected for each package required for generation.
9. Click on the Generate button to generate the schema for each of the selected packages.
10. The progress of the schema generator is shown in the Progress box.
11. When schema generation is complete, click on an entry in the list box and click on the View Schema
button to review the generated schema.

Tip:
The Generate XML Schema dialog can also be accessed from the active diagram by selecting the Project |
XML Schema | Generate XML Schema menu option.

7.4.3.1 Generate Global Element

Enterprise Architect, by default, generates XML Schema in the Garden of Eden style. For every global
XSDcomplexType stereotyped Class, Enterprise Architect generates a global element. For example, the
following model by default generates the XSD shown:

You can change this default behaviour by deselecting the Generate global element for all global
ComplexTypes checkbox on the Generate XML Schema 1376 dialog. Then, the generated XSD no longer
contains the global element, as shown below:

Enterprise Architect User Guide

 Software Development | XML Engineering 1379

7.4.4 Generate WSDL

The Generate WSDL feature forward engineers a UML model to a Web Service Definition Language (WSDL)
file. The Generate WSDL feature acts on a package stereotyped with WSDLnamespace. It is used to generate
any or all of the WSDL stereotyped components owned by the target WSDLnamespace structure. To generate
one or more WSDL files from a WSDLnamespace, follow the steps below:
1. In the Project Browser, right-click on the target WSDLnamespace package to display the context menu.
2. Select the Code Engineering | Generate WSDL menu option. The Generate WSDL dialog displays.

3. For each WSDL component, set the required output file using the Target File column.
4. Using the Encoding field, set the required XML encoding.
5. Click on the Generate button to generate the WSDL files.
6. The progress of the WSDL generator is shown in the Progress edit box.

Tip:
The Generate WSDL dialog can also be accessed from the active diagram by selecting the Project |
Generate WSDL menu option.

© 1998-2010 Sparx Systems Pty Ltd

 1380 Software Development | XML Engineering

7.4.5 Generate MOF

Enterprise Architect offers support for exporting packages to XMI under the Meta-Object Facility (MOF) 1.3
and 1.4 standards. MOF models are created by assigning the stereotype metamodel to the package. MOF
models can be exported to MOF 1.3 or MOF 1.4 XMI file specification.

Background Knowledge
MOF is an Object Management Group (OMG) standard that originated in the UML, when the OMG required a
Meta-Modeling architecture to define the UML. MOF is designed as a four-layered architecture, as illustrated in
the following diagram.

Enterprise Architect User Guide

 Software Development | XML Engineering 1381

Because of the similarities between the MOF-model and UML structure models, MOF meta-models are usually
modeled as UML Class diagrams 721 . You can also use the Metamodel 415 page of the Toolbox to create MOF
model elements and connectors. A supporting standard of MOF is XMI, which defines an XML-based
exchange format.
MOF is a closed, strict meta-modeling architecture; every model element on every layer is strictly an instance
of a model element of the layer above. MOF only provides a means to define the structure or abstract syntax
of a languages or of data.
Simplified, MOF uses the notion of Classes, as known from object orientation, to define concepts (model
elements) on a meta-layer. These Classes (concepts) can then be instantiated through objects (instances) of
the model layer below. Because an element on the M2 layer is an object (instance of an M3 model element)
as well as a Class (an M2 layer concept) the notion of a clabject is used. Clabject is a merge of the words
Class and object.
Another related standard is OCL, which describes a formal language that can be used to define model
constraints by means of predicate logic.

See Also
· Getting Started 1381
· Export MOF to XMI 1383

7.4.5.1 Getting Started

MOF diagrams are Class 721 diagrams that are contained in packages with a metamodel stereotype. To create
a MOF diagram, follow the steps below.
1. Create a package to contain your MOF elements.
2. Double-click on the package name to display the Properties dialog.

© 1998-2010 Sparx Systems Pty Ltd

 1382 Software Development | XML Engineering

3. In the Stereotype field type the value metamodel.

4. Click on the OK button.
5. Right-click on the package in the Project Browser and select the Add | Add Diagram context menu
option. Create a Class diagram (the default diagram).
6. Give your MOF Class diagram an appropriate name.
7. In the Toolbox, select the More tools | Metamodel menu option and add the required Metamodel 415
elements to the diagram.
The following is an example of a MOF diagram. A MOF diagram can typically contain Package, Class,
Enumeration and Primitive elements, and Generalization, Association, Compose and Aggregate relationships.

Enterprise Architect User Guide

 Software Development | XML Engineering 1383

7.4.5.2 Export MOF to XMI

Once you have created your MOF diagram you can export the diagram to XMI, specifying the MOF 1.3 or MOF
1.4 standard.
1. Right-click on the package in the Project Browser. The context menu displays.
2. Select the Import/Export | Export Package to XMI file menu option. The Export Package to XMI
dialog displays:

© 1998-2010 Sparx Systems Pty Ltd

 1384 Software Development | XML Engineering

3. In the Filename field, type a name for the XMI file.

4. De-select the Enable full EA Roundtrip checkbox.
5. In the XMI Type field, click on the drop-down arrow and select MOF 1.3 or MOF 1.4.
6. Click on the Export button and wait until the Progress bar reads 100%.
7. Once your file has been created, you can view it by clicking on the View XMI button.
MOF diagrams exported to XMI can be imported using the regular import XMI features of Enterprise Architect.
See Import from XMI 290 .

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1385

7.5 Model Transformations - MDA

Model Driven Architecture (MDA) Transformations provide a fully configurable way of converting model
elements and model fragments from one domain to another. This typically involves converting Platform-
Independent Model (PIM) elements to Platform-Specific Model (PSM) elements. A single element from the PIM
can be responsible for creating multiple PSM elements across multiple domains.
Transformations are a huge productivity boost, and reduce the necessity of manually implementing stock
Classes and elements for a particular implementation domain: for example, database tables generated from
persistent PIM Classes. Enterprise Architect includes some basic built-in Transformations, such as PIM to
Data Model, PIM to C#, PIM to Java and PIM to XSD. Sparx Systems will make further Transformations
available over time, either as built in Transformations or as downloadable modules from the Sparx Systems
website.
For a further productivity boost, Enterprise Architect can automatically generate code for your transformed
Classes that target code languages. See the Generate Code on result 1388 option on the Model
Transformation dialog.
A Transformation is defined using Enterprise Architect's simple code generation template language, and
involves no more than writing a template to create a simple intermediary source file. Enterprise Architect reads
the source file and binds that to the new PSM.

Enterprise Architect also creates internal bindings (Transformation Dependencies) between each PSM created
and the original PIM. This is essential, as it enables you to forward synchronize from the PIM to the PSM many
times, adding or deleting features as you go. For example, adding a new attribute to a PIM Class can be
forward synchronized to a new column in the Data Model. You can observe the Transformation Dependencies
for a package using the Traceability window. This enables you to check the impact of changes to a PIM
element on the corresponding elements in each generated PSM, or to verify where a change required in a
PSM should be initiated in the PIM (and also to reflect back in other PSMs). The Transformation
Dependencies are a valuable tool in managing the traceability 1245 of your models.
Enterprise Architect does not delete or overwrite any element features that were not originally generated by
the transform. Therefore, you can add new methods to your elements, and Enterprise Architect does not act
on them during the forward generation process.

Note:
If you are using the Corporate, Business and Software Engineering, System Engineering or Ultimate edition,
if security is enabled you must have Transform Package 198 access permission to perform an MDA
Transform on a package.

The following diagram highlights how Transformations work and how they can significantly boost your
productivity:

© 1998-2010 Sparx Systems Pty Ltd

 1386 Software Development | Model Transformations - MDA

Transformations that are currently built-in include:

· C# - Converts a PIM to a standard C# implementation set
· Data Model to ERD - Transforms a Data Model to an Entity Relationship Diagram (ERD)
· DDL - Transforms platform-independent Class elements to platform-specific table elements
· EJB Entity - Transforms platform-independent Class elements to packages containing the Class and
Interface elements that comprise an EJB Entity Bean
· EJB Session - Transforms platform-independent Class elements to packages containing the Class and
Interface elements that comprise an EJB Session Bean
· ERD to Data Model - Transforms an Entity Relationship Diagram into a Data Model
· Java - Transforms platform-independent elements to Java language elements

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1387

· JUnit - Converts a Java model to a model where test methods are created for each public method of any
original Class
· NUnit - Converts a .Net language specific model to a model where test methods are created for each
public method of any original Class
· WSDL - Converts a simple representation of a WSDL interface into the elements required to generate that
interface
· XSD - Transforms platform-independent elements to XSD elements.

Transformations are described in the following topics:

· Transform Elements 1387
· Import Transformations 1414
· Transformation Templates 1412
· Built-in Transformations 1388
· Write Transformations 1414
· Chaining Transformations 1388

7.5.1 Transform Elements

There are two modes for initiating a Model Transformation, each of which can be started in two ways.
· To transform selected elements on a diagram, either:
· Select the Project | Transformations | Transform Selected Elements menu option, or
· From the context menu for the Classes on the diagram, select the Transform option.
· To transform elements in the package currently selected in the Project Browser, either:
· Select the Project | Transformations | Transform Current Package menu option, or
· From the context menu of the package in the Project Browser, select the Transform Current Package
option.
The Model Transformation dialog displays.

When the dialog displays, all elements are selected and all transformations previously performed from any of
these Classes are checked.

© 1998-2010 Sparx Systems Pty Ltd

 1388 Software Development | Model Transformations - MDA

Option Use to

Elements Select (click on) the individual elements to be included in the transformation.

All Select all of the elements from the list to be included in the transformation.

None Deselect all of the elements from the list.

Include child packages Select to include elements in child packages of the selected package.

Transformations Select which transformations to perform and the package each of them
should be transformed to. (Use the [ ... ] button to select the package in
which the transformed elements are being created.)

Generate Code on result Specify whether or not to automatically generate code for transformed
Classes that target code languages.
Automatically generating code helps boost productivity in development. With
this option selected, the first time you transform to the selected Class
Enterprise Architect enables you to select a filename to generate to.
Subsequent transformations automatically generate any Class with a
filename set.

Perform Transformations Specify if transformations previously done on target Classes should be

on result automatically executed. See Chaining Transformations 1388 for more
information.

Intermediary File Specify the filename of the intermediary file (if any).

Write Always Write the intermediary file to disk.

Write Now Generate the intermediary file but do not perform the transform.

Do Transform Execute the transform command.

7.5.1.1 Chaining Transformations

Chaining transformations provide an extra degree of flexibility and power to transformations. For example, you
might have a situation where two transformations have a common element. This can be separated out into
one transformation, and then the original transformations can be transformed from the common point. The
separated transform could even produce a useful model itself.
Enterprise Architect provides for chaining transformations, by enabling transformations that have already been
performed on target Classes to be performed automatically next time that Class is transformed to. To enable
this, select the Perform Transformations on result checkbox in the Model Transformation dialog.

7.5.2 Built-in Transformations

Enterprise Architect provides a number of built-in transformation types. These transformations have been
designed to be useful to as many users as possible, acting as a good base to modify to include the specifics
of your custom domain, and to be good examples of how to write transformations.
The following transformations are included in Enterprise Architect.

· C# 1389 · EJB Session 1397 · NUnit 1407

· DDL 1393 · ERD to Data Model 1399 · WSDL 1408

· Data Model to ERD 1390 · Java 1403 · XSD 1409

· EJB Entity 1397 · JUnit 1405

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1389

7.5.2.1 C# Transformation
The C# transformation converts Platform-Independent Model (PIM) elements to language-specific C# Class
elements. The transformation converts PIM model types to C# types and creates encapsulation according to
Enterprise Architect's options for creating properties from C# attributes, which you set on the C# Specifications
1350 page 1350 of the Options dialog.

The Platform-Independent Model (PIM):

© 1998-2010 Sparx Systems Pty Ltd

 1390 Software Development | Model Transformations - MDA

After transformation, becomes the PSM:

7.5.2.2 Data Model To ERD Transformation

The Data Model to ERD transformation is a reverse engineering of the ERD to Data Model 1399

transformation.
The transformation uses and demonstrates support in the intermediary language for the following
database-specific concepts:

Entity Mapped one-to-one onto table elements.

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1391

Attribute Mapped one-to-one onto columns.

Primary Key Comes from the PrimaryKey type of column.

The source Data Model diagram:

© 1998-2010 Sparx Systems Pty Ltd

 1392 Software Development | Model Transformations - MDA

After transformation becomes the Entity Relationship Diagram:

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1393

Tip:
Sometimes you might want to limit the stretch of the diamond-shape Relationship connectors. Simply pick a
Relationship connector, right-click to display the context menu, and select the Bend Line at Cursor option.

7.5.2.3 DDL Transformation

The purpose of the DDL transformation is to create a data model from the logical model, generating a model
targeted at the default database type that is ready for DDL generation. The data model can then be used to
automatically generate DDL statements to run in one of the Enterprise Architect supported database products.
The DDL Transformation uses and demonstrates support in the intermediary language 1415 for the following
database-specific concepts:

Table Mapped one-to-one onto Class elements.

Column Mapped one-to-one onto attributes.

Primary Key Lists all the columns involved; this ensures that they exist in the Class and creates a primary
key method for them.

Foreign Key This is a special sort of connector. The Source and Target sections list all of the columns
involved; this ensures that they exist and that a matching primary key exists in the destination
Class, and that the transformation creates the appropriate foreign key.

The following two diagrams show a typical PIM to Data Model Transformation.

© 1998-2010 Sparx Systems Pty Ltd

 1394 Software Development | Model Transformations - MDA

The Platform-Independent Model (PIM):

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1395

After transformation becomes the PSM:

Generalizations are handled by providing the child element with a foreign key to the parent element, as in the
following diagram. Copy-down inheritance is not supported.

© 1998-2010 Sparx Systems Pty Ltd

 1396 Software Development | Model Transformations - MDA

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1397

7.5.2.4 EJB Transformations

The purpose of the EJB Session Bean transformation and the EJB Entity Bean transformation is to
reduce the work required in generating the internals of Enterprise Java Beans, thus enabling you to
concentrate on modeling at a higher level of abstraction.
The EJB Session Bean transformation generates the following from a single Class element containing the
attributes, operations and references required for code generation by the javax.ejb.* package:
· An implementation Class element
· A home interface element
· A remote interface element.
The EJB Entity Bean transformation generates the following from a single Class element containing the
attributes, operations and references required for code generation by the javax.ejb.* package:
· An implementation Class element
· A home interface element
· A remote interface element
· A primary key element.
Both transformations also generate a META-INF package containing a deployment descriptor element.
The Platform-Independent Model (PIM):

After transformation generates a set of Entity Beans, where each one takes the following form (for the

© 1998-2010 Sparx Systems Pty Ltd

 1398 Software Development | Model Transformations - MDA

Account Class):

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1399

7.5.2.5 ERD To Data Model Transformation

The purpose of the Entity Relationship Diagram (ERD) to Data Model transformation is to create a data
model from the ERD logical model, generating a model targeted at the default database type ready for DDL
generation. Before doing the transformation, make sure you have defined the common data type for each
attribute and selected a database type as the default database. The data modeling diagram can then be
automatically generated. This data model can be used for generating DDL statements to run in one of the
Enterprise Architect supported database products.
The transformation uses and demonstrates support in the intermediary language for the following
database-specific concepts:

Table Mapped one-to-one onto Entity elements.

Column Mapped one-to-one onto attributes.

Primary Key Comes from the primaryKey type of attribute.

Make sure the primary key exists in the source Entity; the transformation then creates the
Foreign Key
appropriate foreign key.

© 1998-2010 Sparx Systems Pty Ltd

 1400 Software Development | Model Transformations - MDA

The Source Entity Relationship Diagram:

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1401

After transformation becomes the Data Model Diagram (for an Oracle DBMS):

Tip:
Sometimes you might go back to the ERD, make some changes and then want to do another transformation.
To achieve better results, always delete the previous transformation package before doing the next
transformation.

Generalization
Generalization can be handled in ERD technology, as illustrated by the following example. Note that the
copy-down inheritance is currently supported with two levels only.

© 1998-2010 Sparx Systems Pty Ltd

 1402 Software Development | Model Transformations - MDA

This transforms to:

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1403

7.5.2.6 Java Transformation

The purpose of the Java transformation is to convert Platform-Independent Model (PIM) elements to
language-specific Java Class elements. The transformation converts the PIM model types to Java types and
creates encapsulation according to Enterprise Architect's options for creating properties from Java attributes;
that is, producing the getters and setters according to the rules you have defined. Notice that the public
attributes in the PIM are converted to private attributes in the PSM.
You set the code generation options for Java code generation on the Java Specifications 1355 page of the
Options dialog.
The Platform-Independent Model (PIM):

© 1998-2010 Sparx Systems Pty Ltd

 1404 Software Development | Model Transformations - MDA

After transformation becomes the PSM:

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1405

7.5.2.7 JUnit Transformation

The purpose of the JUnit transformation is to create a Class with test methods for all public methods of an
existing Java Class. The resulting Class can then be generated and the tests filled out and run by JUnit.
The Java model originally transformed from the PIM:

© 1998-2010 Sparx Systems Pty Ltd

 1406 Software Development | Model Transformations - MDA

After transformation becomes the PSM:

Note that for each Class in the Java model, a corresponding test Class has been created. Each of these test
Classes contains a test method for every public method in the source Class, plus the methods required to
appropriately set up the tests 1512 . It is your responsibility to fill in the details of each test.

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1407

7.5.2.8 NUnit Transformation

The purpose of the NUnit transformation is to create a Class with test methods for all public methods of an
existing .Net compatible Class. The resulting Class can then be generated and the tests filled out and run by
NUnit.
The C# model originally transformed from the PIM:

© 1998-2010 Sparx Systems Pty Ltd

 1408 Software Development | Model Transformations - MDA

After transformation becomes the PSM:

Note that for each Class in the C# model, a corresponding test Class has been created. Each of these test
Classes contains a test method for every public method in the source Class, plus the methods required to
appropriately set up the tests 1512 . It is your responsibility to fill in the details of each test.

7.5.2.9 WSDL Transformation

The purpose of the WSDL transformation is to create from a simple model an expanded model of a WSDL
interface 1050 that is suitable for generation.
Take the following example interface:

This generates the corresponding WSDL component, service, port type, binding and messages as follows.
· Classes are handled in the same way as the XSD Transformation 1409
· All in parameters are transformed into messageParts in the Request message
· The return value and all out and return parameters are transformed into messageParts in the Request
message
· All methods where a value is returned are transformed into Request-Response operations while all
methods not returning a value are transformed into OneWay operations
· The transformation does not handle generation of Solicit-Response and Notification methods or faults.

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1409

The resulting package can then have the specifics filled out using the WSDL editing capabilities of Enterprise
Architect, and finally be generated using WSDL generation 1379 .

7.5.2.10 XSD Transformation

The purpose of the XSD transformation is to convert Platform-Independent Model (PIM) elements to UML
Profile for XML elements as an intermediary step to creating an XML Schema. Each selected PIM Class
element is converted to an «XSDcomplexType» element.
For more information, see the Generate XSD 1376 topic.

© 1998-2010 Sparx Systems Pty Ltd

 1410 Software Development | Model Transformations - MDA

The Platform-Independent Model (PIM):

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1411

After transformation becomes the PSM:

Which in turn generates the following XSD:

<?xml version="1.0" encoding="ISO-8859-1"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="Account" type="Account"/>
<xs:complexType name="Account">
<xs:sequence>
<xs:element name="name" type="xs:string"/>
<xs:element name="billingAddress" type="xs:string"/>
<xs:element name="emailAddress" type="xs:string"/>
<xs:element name="closed" type="xs:boolean"/>
<xs:element name="deliveryAddress" type="xs:string"/>
<xs:element ref="Order"/>
<xs:element ref="ShoppingBasket"/>
</xs:sequence>
</xs:complexType>
<xs:element name="LineItem" type="LineItem"/>
<xs:complexType name="LineItem">
<xs:sequence>
<xs:element name="quantity" type="xs:integer"/>
<xs:element ref="StockItem"/>
</xs:sequence>
</xs:complexType>
<xs:element name="Order" type="Order"/>
<xs:complexType name="Order">
<xs:sequence>
<xs:element name="date" type="xs:date"/>
<xs:element name="deliveryInstructions" type="xs:string"/>
<xs:element name="orderNumber" type="xs:string"/>

© 1998-2010 Sparx Systems Pty Ltd

 1412 Software Development | Model Transformations - MDA

<xs:element ref="LineItem"/>
<xs:element name="status" type="OrderStatus"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="OrderStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="new"/>
<xs:enumeration value="packed"/>
<xs:enumeration value="dispatched"/>
<xs:enumeration value="delivered"/>
<xs:enumeration value="closed"/>
</xs:restriction>
</xs:simpleType>
<xs:element name="ShoppingBasket" type="ShoppingBasket"/>
<xs:complexType name="ShoppingBasket">
<xs:sequence>
<xs:element ref="LineItem"/>
</xs:sequence>
</xs:complexType>
<xs:element name="StockItem" type="StockItem"/>
<xs:complexType name="StockItem">
<xs:sequence>
<xs:element name="catalogNumber" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:element name="Transaction" type="Transaction"/>
<xs:complexType name="Transaction">
<xs:sequence>
<xs:element name="date" type="xs:date"/>
<xs:element name="orderNumber" type="xs:string"/>
<xs:element ref="Account"/>
<xs:element ref="LineItem"/>
</xs:sequence>
</xs:complexType>
</xs:schema>

7.5.3 Transformation Templates

Note that the Transformation Template mechanism is based very strongly on the Code Generation Template
mechanism. For further information on Transformation Templates see the Code Template Editor 1305 section
and also - for information on the Common Code Editor and intellisense - the Code Editors 1428 topic.
To modify Transformation templates:
1. Select the Settings | Transformation Templates menu option. The Transformation Templates Editor
displays.
2. In the Language field, type or select the name of the transformation to modify.
3. Select a template from the Templates list, and edit its contents in the editor pane.
4. Click on the Save button.

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1413

Option Use to

Language Select the name of the transformation.

Template Display the contents of the active template. Provide the editor for modifying
templates.

Templates List the base transformation templates. The active template is highlighted.
The Modified field indicates whether you have changed the default template
for the current transformation.

New Transformation Type Create a new transformation.

Stereotype Overrides List the stereotyped templates, for the active base template.
The Modified field indicates whether you have modified a default stereotyped
template.

Add New Stereotyped Invoke a dialog for adding a stereotyped template, for the currently selected
Override base template.

Add New Custom Invoke a dialog for creating a custom stereotyped template.
Template

Help Launch the Enterprise Architect Help topic for this dialog.

Get Default Template Update the editor display with the default version of the active template.

Save Overwrite the active templates with the contents of the editor.

Delete If you have overridden the active template, delete the override and replace it

© 1998-2010 Sparx Systems Pty Ltd

 1414 Software Development | Model Transformations - MDA

Option Use to

with the corresponding default transformation template.

7.5.3.1 Import Transformations

You can transfer Transformation templates between models. To import a Transformation template, follow the
steps below:
1. Select the Tools | Import Reference Data menu option. The Import Reference Data dialog displays.

2. Click on the Select File button and browse to a .XML file containing the required Transformation
template.
3. Select the name of one or more template datasets and click on the Import button.

7.5.4 Write Transformations

This topic provides help in writing your own transformations. Subjects covered are:
· Default Transformation Templates 1415
· General Syntax for the Intermediary Language 1415

· Syntax for Creating Objects 1415

· Syntax for Creating Connectors 1419
· Transforming Duplicate Information 1421
· Converting Types 1421
· Converting Names 1422
· Cross References 1423
Further hints and tips can be gleaned from a close study of the Transformation Templates provided with
Enterprise Architect. Note also that writing transformations is very similar to writing code generation templates,
so an understanding of the Code Template Framework 1301 can greatly assist in understanding
transformations.
The Transformation Template editor provides the facilities of the Common Code Editor. For more information
on the Common Code Editor, see the Code Editors 1428 topic.
Transformation Templates are accessed from the Settings | Transformation Templates menu option.

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1415

7.5.4.1 Default Transformation Templates

In most transformations, there is a lot of information that is simply copied to the target model. In order to make
writing new transformations simpler Enterprise Architect provides a default set of transformation templates.
These templates perform a simple copy of the source model to the target model. This means that in order to
write a new transformation you can modify the default templates to make the required changes.

Note:
When creating a new transformation you must modify at least one template before the transformation
becomes available.

7.5.4.2 Intermediary Language

All transformations in Enterprise Architect work by generating a text form of the model to generate.
Any element is represented in this language by the type of element (for example, Class, Action, Method,
Generalization or Tag) followed by the properties of the element and the elements that it is made from. The
grammar for this resembles the following.
element:
elementName { (elementProperty | element)* }

elementProperty:
packageName
stereotype
propertyName = " propertyValueSymbol* "

packageName:
name = " propertyValueSymbol* " ( . " propertyValueSymbol* " )*
stereotype:
stereotype = " propertyValueSymbol* " (, " propertyValueSymbol* " )*

propertyValueSymbol:
\\
\"
Any character except " (U+0022), \ (U+005C)

· elementName is any one of the set of element types as described in Objects 1415 and Connectors 1419
· propertyName is any one of the set of properties as described in Objects 1415 and Connectors 1419 .
Literal strings can be included in property values by escaping a quote character. For example:
default = "\"Some string value.\""

7.5.4.3 Objects
Objects are created in Enterprise Architect by generating text in the following form:
objectType
{
objectProperties
}
where:
objectType is one of the following object types:
· Action
· ActionPin
· Activity
· ActivityParameter
· ActivityPartition
· ActivityRegion
· Actor
· Association
· Change
· Class
· Collaboration
· CollaborationOccurrence

© 1998-2010 Sparx Systems Pty Ltd

 1416 Software Development | Model Transformations - MDA

· Component
· DeploymentSpecification
· DiagramFrame
· Decision
· EntryPoint
· Event
· ExceptionHandler
· ExecutionEnvironment
· ExitPoint
· ExpansionNode
· ExpansionRegion
· ExposedInterface
· GUIElement
· InteractionFragment
· InteractionOccurrence
· InteractionState
· Interface
· InterruptibleActivityRegion
· Issue
· Iteration
· Object
· ObjectNode
· MessageEndpoint
· Node
· Package
· Parameter
· Part
· Port
· ProvidedInterface
· RequiredInterface
· Requirement
· Sequence
· State
· StateMachine
· StateNode
· Synchronization
· Table
· TimeLine
· Trigger
· UMLDiagram
· UseCase.

objectProperties is zero, or one or more of the following properties:

· Abstract
· Alias
· Arguments
· Author
· Cardinality
· Classifier
· Complexity
· Concurrency

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1417

· Filename
· Header
· Import
· IsActive
· IsLeaf
· IsRoot
· IsSpecification
· Keyword
· Language
· Multiplicity
· Name
· Notes
· Persistence
· Phase
· Scope
· Status
· Stereotype
· Version
· Visibility.

and zero, or one or more of the following elements:

· Attribute
· Classifier
· Parameter
· Operation
· Parent
· Tag
· XRef
· Any object.

Notes:
· Some of the above only apply to certain object types.
· Every object created in a transformation should include an XRef element 1423 , as it enables Enterprise
Architect to synchronize with the element and makes it possible to create a connector to that Class in a
transformation.

Classes
A simple Class can be created as follows:
Class
{
name = "Example"
}
It is then easy to add to this. The following example sets the language to C++, and adds a Tagged Value and
an attribute:
Class
{
name = "Example"
language = "C++"
Tag
{
name = "defaultCollectionClass"
value = "List"
}
Attribute
{
name = "count"

© 1998-2010 Sparx Systems Pty Ltd

 1418 Software Development | Model Transformations - MDA

type = "int"
}
}

Attributes
Attributes are created with the same structure as objects, and include the following properties:
· Alias
· Classifier
· Collection
· Container
· Containment
· Constant
· Default
· Derived
· LowerBound
· Name
· Notes
· Ordered
· Scope
· Static
· Stereotype
· Type
· UpperBound
· Volatile.
and the following elements:
· Classifier
· Tag
· XRef.

Operations
Operations are created with the same structure as objects, and include the following properties:
· Abstract
· Alias
· Behavior
· Classifier
· Code
· Constant
· IsQuery
· Name
· Notes
· Pure
· ReturnArray
· Scope
· Static
· Stereotype
· Type.
and the following elements:
· Classifier
· Parameter
· Tag
· XRef.

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1419

Parameters
Parameters are created with the same structure as objects, and include the tag element and the following
properties:
· Classifier
· Default
· Fixed
· Name
· Notes
· Kind
· Stereotype.

Packages
Packages differ from other objects in the following ways:
· A reduced set of properties of alias, author, name, namespaceRoot, notes, scope, stereotype and version
· The extra property namespaceRoot
· Must have a name specified
· Name can be a qualified name; when a qualified name is specified the properties given are applied only to
the final package
· Can contain other packages
· Can't contain attributes and operations.

Tables
Tables are a special sort of object, with the following differences from other object types:
· Can include columns and primary keys
· Can't include attributes.

Columns
Columns are similar to attributes, but have an autonumber element containing Startnum and increment, and
the following added properties:
· Length
· NotNull
· Precision
· PrimaryKey
· Scale
· Unique.

Note:
In the column definition, you cannot assign a value to the NotNull, PrimaryKey or Unique properties.

7.5.4.4 Connectors
Creating connectors in a transformation can be complex, but the process has the same form as creating
elements. The difference is that you must also specify each end.
The different connectors that can be created are as follows.
· Aggregation
· Assembly
· Association
· Collaboration
· ControlFlow
· Connector
· Delegate
· Dependency
© 1998-2010 Sparx Systems Pty Ltd
 1420 Software Development | Model Transformations - MDA

· Deployment
· ForeignKey
· Generalization
· InformationFlow
· Instantiation
· Interface
· InterruptFlow
· Manifest
· Nesting
· NoteLink
· ObjectFlow
· Package
· Realization
· Sequence
· Transition
· UseCase
· Uses

Note:
· ForeignKey is a special case where not just a connector is created; you must also list the columns involved
in the transformation. In addition, tags specified on the connector are actually created on the foreign key
operation in the source Class, and a cascade property can be added; for example,
cascade="update","delete".
· Each connector is transformed at both end objects, therefore the connector might appear twice in the
transformation. This is nothing to be concerned about, but you should check carefully that the connector is
generated exactly the same way, regardless of which end is on the current Class.

There are two different types of Class that you can use as a connector end: one created by a transformation,
and one for which you already know the GUID.

Connect to a Class Created by a Transformation

The most common connection is to connect to a Class created by a transformation. To do this you must have
three items of information:
· The original Class GUID
· The name of the transformation
· The name of the transformed Class.
This type of connector is created using the TRANSFORM_REFERENCE 1423 function macro. When the
element is in the current transformation, it can be safely omitted from the transformation. The simplest
example of this is when you have created multiple Classes from a single Class in a transformation and want a
connector between them. Consider this example from the EJB Entity transformation:
Dependency
{
%TRANSFORM_REFERENCE("EJBRealizeHome",classGUID)%
stereotype="EJBRealizeHome"
Source
{
%TRANSFORM_REFERENCE("EJBEntityBean",classGUID)%
}
Target
{
%TRANSFORM_REFERENCE("EJBHomeInterface",classGUID)%
}
}
There are three uses of the TRANSFORM_REFERENCE macro: one to identify this connector for
synchronization purposes and the other two to identify the ends. All three use the same source GUID,
because they all come from the one original Class. None of the three have to specify the transformation
because the two references are referencing something in the current transformation. Each of them then only
has to identify the transform name.

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1421

Of course it is also possible to create a connector from another connector.

You can create a connector template and list over all connectors connected to a Class from the Class level
templates. You don't have to worry about only generating it once, because if you have created a
TRANSFORM_REFERENCE for the connector then Enterprise Architect automatically synchronizes them.
The following copies the source connector.
%connectorType%
{
%TRANSFORM_CURRENT()%
%TRANSFORM_REFERENCE("Connector",connectorGUID)%
Source
{
%TRANSFORM_REFERENCE("Class",connectorSourceGUID)%
%TRANSFORM_CURRENT("Source")%
}
Target
{
%TRANSFORM_REFERENCE("Class",connectorDestGUID)%
%TRANSFORM_CURRENT("Target")%
}
}

Connecting to a Class For Which You Know the GUID

The second type of Class that you can use as a connector end is one for which you know the current GUID.
To do this, specify the GUID of the target Class in either the source or target end. The following example
creates a dependency from a Class created in a transformation, to the Class it was transformed from.
Dependency
{
%TRANSFORM_REFERENCE("SourceDependency",classGUID)%
stereotype="transformedFrom"
Source
{
%TRANSFORM_REFERENCE("Class",classGUID)%
}
Target
{
GUID=%qt%%classGUID%%qt%
}
}

7.5.4.5 Copy Information

In many transformations there is a substantial amount of information to be copied. It would be tedious to type
all of the common information into a template so that it is copied to the transformed Class. The alternative is to
use the TRANSFORM_CURRENT function macro to do exactly this.
· TRANSFORM_CURRENT(<listOfExcludedItems>) - Generates an exact copy of all the properties of the
current item, except for the items named in <listOfExcludedItems>.

Another form of this is available when transforming connectors that enables either end of the connector to be
copied:
· TRANSFORM_CURRENT(<connectorEnd>,<listOfExcludedItems>) - Generates an exact copy of the
connector end specified by <connectorEnd> except for the items named in <listOfExcludedItems>, where
<connectorEnd> is either Source or Target.

7.5.4.6 Convert Types

Different target platforms almost certainly require different types, so you often require a method of converting
between types. The following macro offers this.
· CONVERT_TYPE(<destinationLanguage>, <originalType>) - Converts <originalType> to the
corresponding type in <destinationLanguage> using the datatypes and common types defined in the
model, where <originalType> is assumed to be a platform independent common type.

A similar macro is available when transforming common datatypes to the datatypes for a specified database.
· CONVERT_DB_TYPE(<destinationDatabase>, <originalType>) - Converts <originalType> to the
corresponding datatypes in <destinationDatabase>, which is defined in the model. The <originalType>
refers to a platform independent common datatype.

© 1998-2010 Sparx Systems Pty Ltd

 1422 Software Development | Model Transformations - MDA

7.5.4.7 Convert Names

Different target platforms use different naming conventions. As a result you might not want to copy the names
of your elements directly into the transformed models. To facilitate this requirement, Enterprise Architect's
transformation templates provide a CONVERT_NAME 1422 function macro.
Another way in which you can transform a name is to remove a prefix from the original name, with the
REMOVE_PREFIX 1422 macro.

CONVERT_NAME(<originalName>, <originalFormat>, <targetFormat>)

This macro converts <originalName>, which is assumed to be in <originalFormat>, to <targetFormat>.
The supported formats are:
· Camel Case: New words start with a capital letter except for the first word, which begins with a lower case
letter; for example, myVariableTable
· Pascal Case: Same as Camel Case but the first letter of the first word is upper case; for example,
MyVariableTable
· Spaced: Words are separated by spaces; the case of letters is ignored
· Underscored: Words are separated by underscores; the case of letters is ignored.

Note:
Acronyms are not supported when converting from Camel Case or Pascal Case.

The original format might also specify a list of delimiters to be used. For example a value of ' _' breaks words
whenever either a space or underscore is found.
The target format might also use a format string that specifies the case for each word and a delimiter between
them. It takes the following form:
<firstWord>(<delimiter>)<otherWords>
· <firstWord> controls the case of the first word (see below)
· <delimiter> is the string generated between words
· <otherWords> applies to all words after the first word.
<firstWord> and <otherWords> are both a sequence of two characters. The first character represents the case
of the first letter of that word, and the second character represents the case of all subsequent letters. An upper
case letter forces the output to upper case, a lower case letter forces the output to lower case, and any other
character preserves the original case.
Example 1: To capitalize the first letter of each word and separate multiple words with a space:
"Ht( )Ht" to output "My Variable Table"

Example 2: To generate the equivalent of Camel Case, but reverse the roles of upper and lower case; that is,
all characters are upper case except for the first character of each word after the first word:
"HT( )hT" to output "MY vARIABLE tABLE"

REMOVE_PREFIX(<originalName>, <prefixes>)
This macro removes any prefix found in <prefixes> from <originalName>. The prefixes are specified in a semi-
colon separated list.
The macro is often used in conjunction with the CONVERT_NAME macro. For example, this code creates a
get property name according to the options for Java.
$propertyName=%REMOVE_PREFIX(attName,genOptPropertyPrefix)%
%if genOptGenCapitalisedProperties=="T"%
$propertyName=%CONVERT_NAME($propertyName, "camel case", "pascal case")%
%endIf%

Enterprise Architect User Guide

 Software Development | Model Transformations - MDA 1423

7.5.4.8 Cross References

Cross References are an important part of transformations. They are used to:
· Find the transformed Class to synchronize with
· Create connectors between transformed Classes
· Specify a classifier of a type
· Determine where to transform to for future transformations.
Each cross reference has three different parts:
· A Namespace, corresponding to the transformation that generated the element
· A Name, which is a unique reference to something that can be generated in the above transformation
· A Source, which is the GUID of the element that this element was created from.
When writing the templates for a transformation, it is easiest to create the cross references using the
TRANSFORM_REFERENCE macro that is defined for this purpose. It has three optional parameters.

TRANSFORM_REFERENCE(<name>, <sourceGuid>, <namespace>)

Generates a reference that can be used in the ways described above. It resembles the following.
XRef{namespace="<namespace>" name="<name>" source="<sourceGuid>"
Where:
· If <name> is not specified it gets the name of the current template
· If <sourceGUID> is not specified it gets the GUID of the current Class
· If <namespace> is not specified it gets the name of the current transformation.

Note:
The only time that this should be specified is when creating a connector to a Class created in a different
transformation.

A good example of the use of cross references is in the DDL 1393 templates provided with Enterprise Architect.
In the Class template a cross reference is created with the name table. Then up to two different connectors
can be created, each of which must identify the two Classes it connects using cross references while having
its own unique cross reference.

Specify Classifiers
Objects, attributes, operations and parameters can all reference another element in the model as their type.
When this type is created from a transformation you must use a cross reference to specify it, using the
TRANSFORM_CLASSIFIER macro.

TRANSFORM_CLASSIFIER(<name>, <sourceGuid>, <namespace>)

Generates a cross reference within a classifier element, where the parameters are identical to the
TRANSFORM_REFERENCE macro but the name Classifier is generated instead of XRef.

If the target classifier already exists in the model before the transformation, a TRANSFORM_CLASSIFIER is
inappropriate and instead the GUID can be given directly to a classifier attribute.

Note:
If a classifier is specified for any type it overrides the type specified.

© 1998-2010 Sparx Systems Pty Ltd

 1424 Software Development | Integrated Development

7.6 Integrated Development

This section discusses the Enterprise Architect Integrated, or Model Driven, Development Environment
(MDDE).
It describes:
· Getting started 1424 with the prerequisites and tools of the MDDE
· How to set up 1425 the scripts to control actions
· How to use the code editors 1428 across the development environment
· How to build 1443 , debug 1446 , run 1482 , test 1483 and deploy 1484 your application code
· How to search files 1485 for data names and structures.

7.6.1 Getting Started

To quickly start development in the Model Driven Development Environment, check through the following
topics:
· Prerequisites 1424
· Available Tools 1424
· Workspace Layouts 1424
· General Workflow 1425

7.6.1.1 Prerequisites
Before using the Model Driven Development Environment:
· You should be using the correct edition: Enterprise Architect Professional, Corporate or Suite Editions.
· You should be connected to the required model.
· Relevant source code should be imported into the model.
· Basic Setup 1425 should be complete.

7.6.1.2 Available Tools

This section describes the tools available in the Model Driven Development Environment:
· Workspace Layouts 1424
· Code Engineering 1281
· Using Code Editors 1428
· Intellisense 1432
· Application Management 1425
· Debugger Management 1446

7.6.1.3 Workspace Layout

You can choose from many predefined workspace layouts 86 depending on the tasks you perform. When you
are familiar with the environment and controls available to you, you can create your own.

Workspace Toolbar

Enterprise Architect User Guide

 Software Development | Integrated Development 1425

Predefined Workspace Layouts

7.6.1.4 General Workflow

In working with the Model Driven Development Environment, you apply the following workflow as a circular
process, refining as necessary in each iteration.
· Configure and set up scripts 1426
· Model - Edit - Build - Debug - Test - Profile - Deploy - Document and Analyze.

7.6.1.5 Code Generation and Synchronization - Safeguards

It is important that the model and source code are kept synchronized for the Visual Execution Analyzer to
produce useful results.
Use the Code Generation tools to synchronize 1327 your model after any design changes or code editing.
Always build the application prior to any Execution Analysis session - debugging, recording or profiling.

7.6.1.6 Code Editing For MDDE

See the Code Editors 1428 topic.

7.6.2 Setup
To use the execution tools of the Model Driven Development Environment - debugging, build and recording - it
is necessary to record information about the application.This is achieved in Enterprise Architect through the
use of Package Scripts.
A Package Script, when created, is naturally associated with the package that is currently selected.
A Package Script houses all the information the MDDE requires in order to provide support for tasks such as
building the application, debugging and performing unit testing. A model can contain many Package Scripts.
Each can build a separate application, or perhaps the same application but with different compilation options.
When you select a package or child Class in the Project Explorer, the Debug Management window displays
any Package Scripts associated with that package. When you select a package root, the Debug Management
window displays the scripts for the first package it finds under the root that has Scripts.
When you selected another package, the scripts displayed in the Debug Management window change also.
You can force the scripts for a particular package to remain visible at all times by 'pinning 1428 ' the package in
the Debug Management window.

External Tools and Environment

If you plan on using any of the debugging features of the MDDE, you must have the appropriate Framework

© 1998-2010 Sparx Systems Pty Ltd

 1426 Software Development | Integrated Development

installed on your machine:

· The Java Runtime Environment for Java
· The .NET Framework for managed applications
Any Operating System Environment Variables such as $PATH required by these kits should also be
established.

7.6.2.1 Managing Scripts

In Enterprise Architect, any package within the UML Model can be configured to act as the 'root' of a source
code project. By setting compilation scripts, xUnit commands, debuggers and other configuration settings for a
package, all contained source code and elements can be built, tested or debugged according to the currently
active configuration. Each package can have multiple scripts, but only one is active at any one time. The
Package Build Scripts dialog enables you to create and manage those scripts.
To access the Package Build Scripts dialog, either:
· Press [Shift]+[F12]
· On the Debug toolbar, click on the drop-down arrow on theScripts icon (the first icon on the left) and select
the Package Build Scripts option
· Select the Project | Execution Analyzer | Package Build Scripts menu option, or
· Right-click on a package in the Project Browser, and select the Execution Analyzer | Package Build
Scripts context menu option.

The Package Build Scripts dialog shows which script is active for the current package, and whether or not the
script contains Build, Test, Run, Debug and Deploy components. The current package is as selected in the
Project Browser; if a different package is selected, different scripts are available and different breakpoints and
markers are applied.
Note that you must close the Package Build Scripts dialog to select a different package in the Project Browser.
However, if the Debug window is open ([Alt]+[8]) you can see which debugging configuration is available and
selected, and which breakpoints and markers are displayed, as you change packages in the Project Browser.
· To create a new script, click on the Add button; the Build Script dialog 1427 displays.
· To modify an existing script, highlight the script name in the list and click on the Edit button.
· To copy a script with a new name, highlight the script name to copy and click on the Copy button;
Enterprise Architect prompts you to enter a name for the new copy. Enter the new name in the dialog and

Enterprise Architect User Guide

 Software Development | Integrated Development 1427

click on the OK button. The new copy appears in the list and can be modified as usual.
· To delete a script, highlight the script name to delete, click on the Delete button, and click on the OK
button.
· To export your scripts, click on the Export button to choose the scripts to export for this package.
· To import build scripts, click on the Import button to choose a .xml file of the scripts to import.
The Default Language field enables you to set the default language for generating source code for all new
elements within this package and its descendents.
Select the Use Live Code Generation checkbox to update your source code instantly as you make changes
to your model.
Click on the All Package Scripts button to open a new window that displays all scripts in the current project.

Once you have created new scripts or made changes to existing ones, click on the OK button to confirm the
changes, otherwise click on the Cancel button to quit the Package Build Scripts dialog without saving any
changes.

7.6.2.2 Defining Script Actions

Scripts are associated with a Package. When you create a Package Script you can define a number of
actions.
If you plan to use any of the features of the Execution Analyzer, you must complete at least the Build and
Debug tabs.
· Build 1443
· Debug 1446
· Test 1483
· Run 1482
· Deploy 1484

© 1998-2010 Sparx Systems Pty Ltd

 1428 Software Development | Integrated Development

7.6.2.3 Setting the Default Script

Normally the target for any debugging session changes, tracking the package selected in the Project Explorer.
You can change this behaviour so that the scripts for a package remain selected in the Debug window. Use
the context menu on the Scripts folder in the Debug window to either Pin or Unpin the currently-selected
package.

When a package is pinned, the Debug window always displays the scripts defined for that package, and the
debugger always uses the selected Package Script.

7.6.3 Code Editors

Enterprise Architect provides a number of editors that you can use to maintain scripts, code and templates.
Specifically, these are the:
· Shape Script Editor* 1150
· Code Generation Template Editor* 1305
· Transformation Template Editor* 1412
· Custom SQL Search Filter Editor* 1239
· Database View Editor* 1032
· HTML Report Template Editor 1649
· Source Code Viewer* 1441
· Script Editor* 1439
Each editor has its own features, but they are all based on a common Code Editor control.
You can have several code editors (or files within a code editor) open at the same time, as separate tabs 397

Enterprise Architect User Guide

 Software Development | Integrated Development 1429

in the central view area of the Enterprise Architect work area. You can also close the editors individually or all
together, leaving views of other types (such as diagrams or RTF reports) still open.
The Code Editor provides a variety of functions to assist with the code editing process, including:
· Syntax Highlighting 1429
· Bookmarks 1430
· Cursor history 1430
· Brace matching 1430
· Automatic indentation 1431
· Commenting selections 1431
· Scope guides 1431
· Zooming 1432
· Line selection 1432
· intellisense 1432
· File Search 1485 .
A range of these functions is available through keyboard key combinations and/or context menu options; see
the Code Editor Key Bindings 1433 and Code Editor Context Menu 1437 topics.

You can customize several of the Code Editor features by setting properties in the Code Editor configuration
files. For example, by default the line containing the cursor is always highlighted, but you can turn the
highlighting off. For more information see the Code Editor Configuration Guide, located as a PDF file in the
Config directory under your Enterprise Architect installation directory.

7.6.3.1 Syntax Highlighting

The Code Editor highlights - in colored text - the standard code syntax of most language file formats supported
by Enterprise Architect, namely:
· Ada (.ada, .ads, .adb)
· ActionScript (.as)
· BPEL Document (.bpel)
· C++ (.h, .hh, .hpp, .c, .cpp, .cxx)
· C# (.cs)
· Delphi/Pascal (.pas)
· Diff/Patch Files (.diff, .patch)
· Document Type Definition (.dtd)
· DOS Batch Files (.bat)
· DOS Command Scripts (.cmd)
· HTML (.html)
· Interface Definition Language (.idl, .odl)
· Java (.java)
· Javascript (.javascript)
· JScript (.js)
· Modified Backus-Naur Form Grammar (.mbnf)
· PHP (.php, .php4, .inc)
· Python (.py)
· Standard Generalized Markup Language (.sgml)
· Structured Query Language (.sql)
· SystemC (.sc)
· Visual Basic 6 (.bas)
· VB.NET (.vb)
· VBScript (.vbs)
· Verilog (.v)
· VHSIC Hardware Description Language (.vhdl)
· Visual Studio Resource Configuration (.rc)
· eXtensible Markup Language (.xml)

© 1998-2010 Sparx Systems Pty Ltd

 1430 Software Development | Integrated Development

You can define 1338 how the Code Editor implements syntax highlighting, through the Code Editors page of the
Options dialog.

7.6.3.2 Bookmarks
Bookmarks denote a line of interest in the document. You can toggle them on and off for a particular line by
pressing [Ctrl]+[F2]. Additionally, you can press [F2] and [Shift]+[F2] to navigate to the next or previous
bookmark in the document.
In the following diagram, a bookmark has been set on line 17.

7.6.3.3 Cursor History

The Code Editor Control keeps a history of the previous 50 cursor positions. An entry in the history list is
created when:
· The cursor is moved more than 10 lines from its previous position
· The cursor is moved in a find/replace operation.
You can navigate to an earlier point in the cursor history by pressing [Ctrl]+[-], and a to later point by pressing
[Ctrl]+[Shift]+[-].

7.6.3.4 Brace Matching

When you place the cursor over a brace or bracket, the Code Editor highlights its corresponding partner. You
can then navigate to the matching brace by pressing [Ctrl]+[E].

Enterprise Architect User Guide

 Software Development | Integrated Development 1431

7.6.3.5 Automatic Indentation

For each supported language, the Code Editor adjusts the indentation of a new line according to the presence
of control statements or scope block tokens in the lines leading up to the cursor position.
For more information on customizing automatic indentation for a language, see the Configuration 1429 Guide.

7.6.3.6 Commenting Selections

For languages that support comments, the Code Editor can comment entire selections of code. The Code
Editor recognizes two types of commenting:
· Line Commenting - entire lines are commented from the start (for example, // This is a comment)
· Stream Commenting - sections of a line are commented from a specified start point to a specified end point
(for example, /* This is a comment */).
You can toggle comments on the current line or selection by pressing [Ctrl]+[Shift]+[C] for line comments, or
[Ctrl]+[Shift]+[X] for stream comments.

For more information on customizing selection commenting for each language, see the Configuration 1429

Guide.

7.6.3.7 Scope Guides

If the mouse is placed over an indentation marker, the Code Editor performs a 'look back' to find the line that
started the scope at that indentation level. If the line is found and is currently on screen, it is highlighted in light
blue.

© 1998-2010 Sparx Systems Pty Ltd

 1432 Software Development | Integrated Development

Alternatively if the line is off screen, a calltip is displayed advising of the line number and contents.

7.6.3.8 Zooming
You can zoom into and out of the contents of the Code Editor using [Ctrl]+mousewheel or [Ctrl]+keypad[+] /
[Ctrl]+keypad[-].

Zoom can be restored to 100% by using [Ctrl]+keypad[/].

7.6.3.9 Line Selection

If you want to move the cursor to a specific line of code, press [Ctrl]+[G] and, in response to the prompt, type
in the line number. Press the OK button. The editor displays the specified line of code with the cursor at the
left.

7.6.3.10 Intellisense
Intellisense is a feature that provides choices of code items and values as you type. Not all code editors use
intellisense; those that do are indicated by an asterisk in the list 1428 of Enterprise Architect code editors.
Intellisense provides you with context-based assistance through autocompletion lists, calltips and mouseover
information.
Intellisense is also disabled while you record a macro in the Source Code Viewer 1441 .

Autocompletion List
An autocompletion list provides a list of possible completions for the current text. The list is automatically
invoked when you enter an accessor token (such as a period or pointer accessor) after an object or type that
contains members.

You can also invoke the autocompletion list manually by pressing [Ctrl]+[Spacebar]; the Code Editor then
searches for matches for the word leading up to the invocation point.

Enterprise Architect User Guide

 Software Development | Integrated Development 1433

Select an item from the list and press [Enter] or [Tab] to insert the item into the code. To dismiss the
autocompletion list, press [Escape].

Calltips
Calltips display the current method's signature when you type the parameter list token (for example, opening
parenthesis). If the method is overloaded, the calltip displays arrows that you can use to navigate through the
different method signatures.

Mouseover Information
You can display supporting documentation for code elements (for example, attributes and methods) by
hovering the cursor over the element in question.

7.6.3.11 Code Editor Key Bindings

Note:
In addition to the following keys, you can assign 1338 [Ctrl]+[Alt]+[n] key combinations to macros that you
define 1442 within the Source Code Editor.

Key Description

[Ctrl]+[G] Move cursor to a specified line

[â] Move cursor down one line

[Shift]+[â] Extend selection down one line

[Ctrl]+[â] Scroll down one line

[Alt]+[Shift]+[â] Extend rectangular selection down one line

[á] Move cursor up one line

[Shift]+[á] Extend selection up one line

© 1998-2010 Sparx Systems Pty Ltd

 1434 Software Development | Integrated Development

Key Description

[Ctrl]+[á] Scroll up one line

[Alt]+[Shift]+[á] Extend rectangular selection up one line

[Ctrl]+[ [ ] Move cursor up one paragraph

[Ctrl]+[Shift]+[ [ ] Extend selection up one paragraph

[Ctrl]+[ ] ] Move cursor down one paragraph

[Ctrl]+[Shift]+[ ] ] Extend selection down one paragraph

[ß] Move cursor left one character

[Shift]+[ß] Extend selection left one character

[Ctrl]+[ß] Move cursor left one word

[Ctrl]+[Shift]+[ß] Extend selection left one word

[Alt]+[Shift]+[ß] Extend rectangular selection left one character

[à] Move cursor right one character

[Shift]+[à] Extend selection right one character

[Ctrl]+[à] Move cursor right one word

[Ctrl]+[Shift]+[à] Extend selection right one word

[Alt]+[Shift]+[à] Extend rectangular selection right one character

[Ctrl]+[/] Move cursor left one word part

[Ctrl]+[Shift]+[/] Extend selection left one word part

[Ctrl]+[\] Move cursor right one word part

[Ctrl]+[Shift]+[\] Extend selection right one word part

[Home] Move cursor to the start of the current line

[Shift]+[Home] Extend selection to the start of the current line

[Ctrl]+[Home] Move cursor to the start of the document

[Ctrl]+[Shift]+[Home] Extend selection to the start of the document

[Alt]+[Home] Move cursor to the absolute start of the line

[Alt]+[Shift]+[Home] Extend rectangular selection to the start of the line

Enterprise Architect User Guide

 Software Development | Integrated Development 1435

Key Description

[End] Move cursor to the end of the current line

[Shift]+[End] Extend selection to the end of the current line

[Ctrl]+[End] Move cursor to the end of the document

[Ctrl]+[Shift]+[End] Extend selection to the end of the document

[Alt]+[End] Move cursor to the absolute end of the line

[Alt]+[Shift]+[End] Extend rectangular selection to the end of the line

[Page Up] Move cursor up a page

[Shift]+[Page Up] Extend selection up a page

[Alt]+[Shift]+[Page Up] Extend rectangular selection up a page

[Page Down] Move cursor down a page

[Shift]+[Page Down] Extend selection down a page

[Alt]+[Shift]+[Page Down] Extend rectangular selection down a page

[Delete] Delete character to the right of the cursor

[Shift]+[Delete] Cut selection

[Ctrl]+[Delete] Delete word to the right of the cursor

[Ctrl]+[Shift]+[Delete] Delete until the end of the line

[Insert] Toggle overtype

[Shift]+[Insert] Paste

[Ctrl]+[Insert] Copy selection

[Backspace] Delete character to the left of the cursor

[Shift]+[Backspace] Delete character to the left of the cursor

[Ctrl]+[Backspace] Delete word to the left of the cursor

[Ctrl]+[Shift]+[Backspace] Delete from the start of the line to the cursor

[Alt]+[Backspace] Undo delete

[Tab] Indent cursor one tab

[Ctrl]+[Shift]+[I] Indent cursor one tab

© 1998-2010 Sparx Systems Pty Ltd

 1436 Software Development | Integrated Development

Key Description

[Shift]+[Tab] Unindent cursor one tab

[Ctrl]+keypad[+] Zoom in

[Ctrl]+keypad[-] Zoom out

[Ctrl]+keypad[/] Restore Zoom

[Ctrl]+[Z] Undo

[Ctrl]+[Y] Redo

[Ctrl]+[X] Cut selection

[Ctrl]+[C] Copy selection

[Ctrl]+[V] Paste

[Ctrl]+[L] Cut line

[Ctrl]+[Shift]+[L] Delete line

[Ctrl]+[T] Transpose line

[Ctrl]+[Shift]+[T] Copy line

[Ctrl]+[A] Select entire document

[Ctrl]+[D] Duplicate selection

[Ctrl]+[U] Convert selection to lowercase

[Ctrl]+[Shift]+[U] Convert selection to uppercase

[Ctrl]+[E] Move cursor to matching brace

[Ctrl]+[Shift]+[E] Extend selection to matching brace

[Ctrl]+[Shift]+[C] Toggle line comment on selection

[Ctrl]+[Shift]+[X] Toggle stream comment on selection

[Ctrl]+[F2] Toggle bookmark

[F2] Go to next bookmark

[Shift]+[F2] Go to previous bookmark

Enterprise Architect User Guide

 Software Development | Integrated Development 1437

Key Description

[Ctrl]+[Shift]+[W] Toggle whitespace characters

[Ctrl]+[Shift]+[L] Toggle EOL characters

[Ctrl]+[Spacebar] Invoke autocomplete

[Ctrl]+[-] Go backwards in cursor history

[Ctrl]+[Shift]+[-] Go forwards in cursor history

[F12] Start/Cancel search for keyword in file(s).

[Ctrl]+[F] Find text

[Ctrl]+[R] Replace

7.6.3.12 Code Editor Context Menu

When working on a file with a code editor, you can access a number of options through the context menu.
Right-click on a text string to display the menu.

The first six context menu options provide simple editing functions. Other options on the menu can vary
depending on which editor 1428 you are using, but should include most or all of the following:
· Search for '<string>' - Displays a submenu that enables you to locate the search string in a range of
locations:
· Find in Project Browser finds the object containing the selected text in the Project Browser

© 1998-2010 Sparx Systems Pty Ltd

 1438 Software Development | Integrated Development

· Go to Declaration locates the declaration of a symbol in the source code

· Go to Definition locates the definition of a symbol in the source code (applicable to languages
where symbols are declared and defined in separate places e.g. C++, Delphi)
· Search in Open Files opens the Execution Analyzer File Search 1485 facility, then searches for the
selected text string in other code files of the same type and in the same folder as the current file that
are open, displaying the results in Tree View; you can change the folder path, search text and file
type as required within the File Search window
· Search in Files performs the same search as Search in Open Files, except that the search is in all
comparable files whether they are open or not
· Search in Model performs an Element Name 1241 search in the Model Search 1231 facility, and
displays the results on the Model Search tab
· EA User Guide displays the description of the code item in the Enterprise Architect User Guide
· Google displays the results of a search on the text from a Google search
· MSDN displays the results of a search on the text in the Microsoft Developer Network (MSDN)
· Sun Java SE displays the results of a search on the text in the Sun Microsystems 'Sun Search'
facility
· Wikipedia displays any entry on the object on the Wikipedia web site.
· Koders displays the results of the search for the text string on Koders.com
Note:
The options in the lower half of the menu (after Search in Model) are configurable. You can add
new search tools or remove existing ones by editing the searchProviders.xml file in the Sparx
Systems > EA > Config folder. This file is in OpenSearch description document format.

· Open (Close) IME - opens the Input Method Editor to enable you to enter text in your selected foreign
language script (such as Japanese); you set the keyboard language using the Windows Control Panel -
Regional and Language Options facility
· Line Numbers - shows or hides the line numbers against the lines of code
· Structure Tree - (in the Source Code viewer only) shows or hides the element hierarchy panel
· Set Debugger to Line - (if the debugger is executing and has reached a breakpoint) moves the execution
point to the current line; ensure that you do not skip over any code or declarations that affect the next
section of code being debugged
· Display Variable - (if the debugger is executing) opens the Locals 1474 window and highlights the local
variable for the current point in the code.

Script Editor
If you select the Search for '<string>' context menu option while working in the Script Editor 1439 , a slightly
different submenu displays:

The Search in Scripts option opens the Execution Analyzer File Search 1485 facility, setting the Search Path
field to Search in Scripts and the Search Text field to the selected text, then searching all scripts for the text
string and displaying the results of the search in Tree View.

Enterprise Architect User Guide

 Software Development | Integrated Development 1439

7.6.3.13 Script Editor

The Script Editor enables you to edit scripts, and to run and stop an open script.

Note:
This facility is available in the Corporate, Business and Software Engineering, Systems Engineering and
Ultimate editions.

The editor is based on, and provides the facilities of, the common Code Editor 1428 .
To open the Script Editor, double-click on the required script in the Scripts tab of the Scripter window 1661 . The
editor opens in the main work area.
The VBScript example below is a script that iterates all the packages in the current model and prints their
names.

Note:
In the example, note the syntax of declaring variables representing Enterprise Architect's script objects. This
syntax enables the editor to present intellisense 1440 , but is not necessary for executing the script.

The toolbar options enable you to:

· Save changes to the current script
· Save the current script under a different name
· Run the script
· Stop the executing script
· View the script output in the Scripts tab of the Output window.

© 1998-2010 Sparx Systems Pty Ltd

 1440 Software Development | Integrated Development

Enterprise Architect Script Objects

Enterprise Architect adds to the available functionality and features of the editor script language by providing
inbuilt objects. These are either Type Libraries, providing intellisense for editing purposes, or Runtime objects,
providing access to objects of the types described in the Type Libraries.
The available intellisense scripting objects are:
· EA
· MathLib
· System
· The runtime scripting objects (below).
The available runtime scripting objects are:
· Repository [Type: IDualRepository] - this is the Enterprise Architect automation interface 1666

· Maths [Type: IMath ]

· Session [Type: ISession ].

Script Editing Intellisense (Required Syntax)

Intellisense is available not only in the Script Editor, but also in the Script Console. Intellisense at its most
basic is presented for the inbuilt functionality of the script engine. For intellisense on the additional Enterprise
Architect scripting objects listed above, you must declare variables according to syntax that specifies a type. It
is not necessary to use this syntax to execute a script properly. It is only present so that the correct intellisense
can be displayed for an item. The syntax can be seen in the above diagram in, for example:
Dim e as EA.Element
Then, when you type, in this case, e. the editor displays a list of member functions and properties of e's type.

You select one of these to complete the line of script. You might, therefore, type:
VBTrace( e.
As you type the period, the editor presents the appropriate list and you might double-click on, for example,
Abstract. This is inserted in the line, and you continue to type or select the rest of the statement. In this case,
adding the end space and parenthesis.
VBTrace( e.Abstract )

Keystrokes
In the Script Editor or Console, intellisense is presented on the following keystrokes.
· Press [.] (period) after an item to list any members for that item's type.
· Press [Ctrl]+[Spacebar] on a word to list any intellisense items with a name starting with the string at the
point keystroke was pressed.
· Press [Ctrl]+[Spacebar] when not on a word to display any available top level intellisense items - these
are the intellisense objects described above plus any built-in methods and properties of the current
scripting language.

Enterprise Architect User Guide

 Software Development | Integrated Development 1441

7.6.3.14 The Source Code Viewer

Access: View | Other Element Tools | Source Code.
Use the Source Code viewer to view any source code files for an element. If a Class is selected, the Source
Code viewer shows the source code for that Class, provided it has already been generated 1308 . For C++ a
second tab displays to show the implementation file.
The Source Code viewer also displays any DDL generated for a selected table in your diagram.

Note:
You view source code for an element by selecting menu options in a number of places, or by pressing either
[Ctrl]+[E] or [F12]. If the element does not have a generation file (that is, code has not been or cannot be
generated, such as for a Use Case), Enterprise Architect checks whether the element has a link 611 to either
an operation or an attribute of another element. If such a link exists, and that other element has source code,
the code for that element displays.

A number of options change the way the Source Code viewer works. They can be altered via the Options
dialog (select the Tools | Options | Source Code Engineering | Code Editors 1337 menu option). There are
also many options for developing the code, available through the code editor context menu 1437 and through
the Toolbar 1442 .
By default the Source Code viewer is set to:
· Parse all opened files, and show a tree of the results
· Show line numbers.

If you are editing an XML file, the structure tree is presented in a folder hierarchy rather than a Class structure
hierarchy, as follows:

© 1998-2010 Sparx Systems Pty Ltd

 1442 Software Development | Integrated Development

External File Editor

If you intend to edit external code, XML and DDL files (that is, code not selected from the Project Browser) use
the File | Open Source File menu option, or press [Ctrl]+[Alt]+[O].
If you try to close the window or select another file, the editor prompts you to save your changes.

File Parsing
The Source Code viewer parses files for a number of reasons. The first is to enable it to jump to the location in
the file at which the currently selected item is found (but not when editing external files).
Additionally, parsing displays a structure tree showing an overview of the file in a similar fashion to the main
Project Browser. You can also select anything in that and jump to the appropriate line in the editor.
The viewer cannot parse DDL, and therefore does not show the structure tree for a DDL file.

7.6.3.14.1 Source Code Viewer Toolbar

The toolbar buttons in the Source Code viewer enable you to edit, view and interact with the code contained in
the Source Code viewer. The function of each button, from left to right, is described below:

· Structure Tree - shows or hides the element hierarchy panel (the left panel of the Source Code viewer)
· Line Numbers - shows or hides the line numbers against the lines of code
· Source Code Engineering Properties - displays the Source Code Engineering 1336 page of the Options
dialog, from which you can configure display and behavior options for source code engineering
· Editor Functions - provides quick access to the following functions:
· Open Corresponding File - opens the header or implementation file associated with the currently-
open file
· Go to Matching Brace - for a selected opening or closing brace, highlights the corresponding
closing or opening brace in the pair
· Go to Line - displays a small dialog on which you select the number of the line to highlight; click on
the OK button to move the cursor to that line
· Cursor History Previous - the Source Code viewer keeps a history of the previous 50 cursor
positions, creating a record when the cursor is moved either more than 10 lines away from its
previous position, or in a find-and-replace operation; the menu option moves the cursor to the
position in the immediately-previous cursor history record
· Cursor History Next - moves the cursor to the position in the immediately-following cursor history
record

Enterprise Architect User Guide

 Software Development | Integrated Development 1443

· Record Macro - record the subsequent keystrokes to be saved as a macro

· Stop Recording and Save Macro - stop recording the keystrokes and specify a name for the
macro, on the Save Macro dialog
· Play Macro - execute the macro to repeat the saved keystrokes, if necessary selecting the macro
from the Open Macro dialog
Notes:
· The Record Macro function disables Intellisense 1432 while the macro is being recorded.
· You can assign key strokes 1338 to execute the macro, instead of using the toolbar drop-down
and Open Macro dialog.

· Toggle Line Comment - comments out (//) or re-establishes the code for each full line in which text
is highlighted
· Toggle Stream Comment - inserts a stream comment (/* */) at the cursor position or comments out
the highlighted characters and lines, or re-establishes the commented text as code
· Toggle Whitespace Characters - shows or hides the spacing characters: --> (tab space) and .
(character space)
· Toggle EOL Characters - shows or hides the end-of-line characters: CR (carriage return) and LF
(line feed)
· Save Source and Resynchronize Class - saves the source code and resynchronizes the Class
· Code Templates - accesses the Code Templates Editor 1305
· Find in Project Browser - for a selected line of code, highlights the appropriate structure in the Project
Browser; if there is more than one possibility the Possible Matches dialog displays, listing the occurrences
of the appropriate structure from which you can select the required one
· Search in Files - searches for the selected object name in associated files and displays the results of the
search on the File Search 1485 window
· Search in Model - searches for the selected text throughout the model, and displays the results of the
search on the Model Search 1231 window.
· Go to Declaration - locates the declaration of a symbol in the source code
· Go to Definition - locates the definition of a symbol in the source code (applicable to languages where
symbols are declared and defined in separate files e.g. C++, Delphi)
· Autocomplete List - displays the autocompletion list of possible values; double-click on a value to select it
· Parameter Information - when the cursor is between the parentheses of an operation's parameter list,
displays the operation's signature, highlighting the current parameter
· Find Current Class in Project Browser - displays the name of the currently-selected Class in the code,
and highlights that name in the Project Browser; if there is more than one possibility the Possible Matches
dialog displays, listing the occurrences of the Class from which you can select the required one
· Find Member - displays the name of the currently-selected attribute or method in the code, and highlights
that name in the Project Browser; if there is more than one possibility the Possible Matches dialog displays,
listing the occurrences of the feature from which you can select the required one.

7.6.4 Build
The topics in this section describe how you specify the commands to build the project / package:
· Add Comands 1444
· Recursive Builds 1446

© 1998-2010 Sparx Systems Pty Ltd

 1444 Software Development | Integrated Development

7.6.4.1 Add Commands

The Build tab enables you to enter multiple commands for building the current package. These commands are
executed when you select the Project | Execution Analyzer | Build menu option. The following examples are
for Java and .NET respectively.

Enterprise Architect User Guide

 Software Development | Integrated Development 1445

Write your script in the large text box using the standard Windows Command Line commands. You can
specify, for example, compiler and linker options, and the names of output files. The format and content of this
section depends on the actual compiler, make system, linker and so on that you use to build your project. You
can also wrap up all these commands into a convenient batch file and call that here instead.
If you select the Capture Output checkbox, output from the script is logged in Enterprise Architect's Output
window. This can be activated by selecting the View | System Output menu option.

The Output Parser field enables you to define a method for automatically parsing the compiler output. If you
have selected the Capture Output checkbox, Enterprise Architect parses the output of the compiler so that by
clicking on an error message in the Output window, you directly access the corresponding line of code.

Notes:
· The command listed in this field is executed as if from the command prompt. Therefore, if the executable
path or any arguments contain spaces, they must be surrounded by quotes.
· Throughout this dialog, you can use Local Paths 1343 in specifying paths to executables.

When you run the compile command inside Enterprise Architect, output from the compiler is piped back to the
Output window and displayed as in the following illustration:

If you double-click on an error line, Enterprise Architect loads the appropriate source file and positions the
cursor on the line where the error has been reported.

© 1998-2010 Sparx Systems Pty Ltd

 1446 Software Development | Integrated Development

7.6.4.2 Recursive Builds

For any project you can apply the command entered in the build script to all sub folders of the initial directory
by specifying the token %r immediately preceding the files to be built. The effect of this is Enterprise Architect
iteratively replaces the token with any subpath found under the root and executes the command again.

The output from this Java example is shown below:

Note:
The path being built is displayed along with the exit code.

7.6.5 Debugging
This section describes how you define the debugging actions:
· How it works 1446
· Setup for Debugging 1447
· Breakpoint and Marker Management 1468

· Debugging Actions 1470

· Recording Actions 1480

7.6.5.1 How it Works

The Model Driven Development Environment provides Debuggers for the following frameworks:
· Microsoft Native Code applications
· Microsoft .NET applications
· Java applications
To begin debugging:
1. Ensure the model is open.
2. Ensure Basic Setup 1425 has been completed for the Package or Project.

Enterprise Architect User Guide

 Software Development | Integrated Development 1447

3. Ensure any source code for the areas of interest have been generated, or imported into the Model.
4. Ensure the application has been built. You can do this internally using the Build 1443 Script or you can
build the application externally. The important thing is that the application is built on the latest versions
of the source.
5. Ensure that the model and source are synchronized 1327 .
6. Set breakpoints 1469 .
7. Start 1471 the Debugger.

7.6.5.2 Setup for Debugging

To begin debugging you must specify
· The Debugger to use
· The Application path
· Runtime options, if applicable
The following example shows a .NET Debug script.

7.6.5.2.1 Operating System Specific Requirements

Important:
Please read the information provided in this topic.

Prerequisites
Creation of a Package Build Script and configuration of the Debug command in that script.

Supported Platforms
Enterprise Architect supports debugging on these platforms:

.Net
· MicrosoftÔ .NET Framework 1.1 and later
· Language support: C, C#, C++, J#, Visual Basic

Note:
Debugging under Windows Vista (x64) - If you encounter problems debugging with Enterprise Architect on a
64-bit platform, you should build a Win32 platform configuration in Visual Studio; that is, do not specify
ANY-CPU, specify WIN32.

© 1998-2010 Sparx Systems Pty Ltd

 1448 Software Development | Integrated Development

Java
· Java 2 Platform Standard edition (J2SE) version 5.0
· J2EE JDK 1.4 and above
· Requires previous installation of the Java Runtime Environment and Java Development Kit from Sun
MicrosystemsÔ.
Debugging is implemented through the Java Virtual Machine Tools Interface (JVMTI), which is part of the Java
Platform Debugger Architecture (JPDA). The JPDA is included in the J2SE SDK 1.3 and later.

Windows for Native Applications

Enterprise Architect supports debugging native code (C, C++ and Visual Basic) compiled with the MicrosoftÔ
compiler where an associated PDB file is available. Select Microsoft Native from the list of debugging
platforms in your package script.
You can import native code into your model, and record the execution history for any Classes and methods.
You can also generate Sequence diagrams from the resulting execution path.

Note:
Enterprise Architect currently does not support remote debugging.

7.6.5.2.1.1 UAC-Enabled Operating Systems

The Microsoft operating systems Windows Vista and Windows 7 provide User Account Control (UAC) to
manage security for applications.
The Enterprise Architect Visual Execution Analyser is UAC-compliant, and users of UAC-enabled systems can
perform operations with the Visual Execution Analyser and related facilities under accounts that are members
of only the Users group.
However, when attaching to processes running as services on a UAC-enabled operating system, it might be
necessary to log in as an Administrator. To do this, follow the step below:
1. Before you run Enterprise Architect, right-click on the Enterprise Architect icon on the desktop and
select the Run as administrator option.

Alternatively, edit or create a link to Enterprise Architect and configure the link to run as an administrator;
follow the steps below:
1. Right-click on the Enterprise Architect icon and select the Properties menu option. The Enterprise
Architect Properties dialog displays.

Enterprise Architect User Guide

 Software Development | Integrated Development 1449

2. Click on the Advanced button. The Advanced Properties dialog displays.

3. Select the Run as administrator checkbox.

4. Click on the OK button, and again on the Enterprise Architect Properties dialog.

© 1998-2010 Sparx Systems Pty Ltd

 1450 Software Development | Integrated Development

7.6.5.2.1.2 WINE Debugging

At the command line, run $ winecfg.
Set the library overrides for dbghelp to (native, builtin), and accept the warning about overriding this DLL:

Note:
If WINE crashes, the back traces may not be correct.

1. Set dbghelp to native by using winecfg.

2. Copy the application source code plus executable(s) to your bottle. (The path must be the same as the
compiled version; that is:

If Windows source = C:\Source\SampleApp, under Crossover it must be C:\Source\SampleApp.)

3. Copy any Side-By-Side assemblies that are used by the application.
4. Import the source code into Enterprise Architect. (Optional.)
5. Create a build script 1443 on a package.

Set the path of the application on the Debug tab, and set Use Debugger to Microsoft Native.
6. Open the Profiler 1514 (View | Execution Analyzer | Profiler).
7. Click on the Launch button (first button on the Profiler window).

If the sample didn't start, click on the Sampling button (third button on the Profiler window).
8. Once you have finished profiling, shut down the application (not Enterprise Architect).
9. View the Sampler report by clicking the View Report button (fifth button on the Profiler window).

Tips:
· If you are using MFC remember to copy the debug side-by-side assemblies to the C:\window\winsxs
directory.
· To add a windows path to WINE, modify the Registry entry:

HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Session Manager\Environment

Access Violation Exceptions

Due to the manner in which WINE handles direct drawing and access to DIB data, an additional option is
provided on the Debug window toolbar drop-down menu to ignore or process access violation exceptions
thrown when your program directly accesses DIB data.

Enterprise Architect User Guide

 Software Development | Integrated Development 1451

Select this option to catch genuine (unexpected) access violations; deselect it to ignore expected violations.
As the debugger cannot distinguish between expected and unexpected violations, you might have to use trial
and error to capture and inspect genuine program crashes.

7.6.5.2.2 Microsoft C++ and Native (C, VB)

The example script below is configured to enable debugging of a C++ project built in Microsoft Visual Studio
2005 or 2008.
You can debug native code only if there is a corresponding PDB file for the executable. You normally create
the PDB file as a result of building the application.
The build should include full debug information and there should be no optimizations set.

The script must specify two things to support debugging:

· The path to the executable
· Microsoft Native as the debugging platform.

© 1998-2010 Sparx Systems Pty Ltd

 1452 Software Development | Integrated Development

7.6.5.2.2.1 Debug Symbols

For Applications built using Microsoft Platform SDK Debug Symbols are written to an Application PDB file
when the Application is built.
The Debugging Tools for Windows, an API used by the Visual Execution Debugger, uses these symbols to
present meaningful information to Execution Analyzer controls.
These symbols can easily get out of date and cause errant behaviour. The debugger might highlight the wrong
line of code in the editor whilst at a breakpoint. It is therefore best to ensure the application is built prior to any
debugging or recording session.
The debugger must inform the API how to reconcile addresses in the image being debugged. It does this by
specifying a number of paths to the API that tell it where to look for PDB files. The API automatically picks up
the path to the main image PDB from the image itself.
For system DLLs (kernel32, mfc90ud ...) for which no debug symbols are found, the Call Stack shows some
frames with module names and addresses only .
You can supplement the symbols translated by passing additional paths to the API. To do this there must be a
Package Script selected and it must have the Native debugger specified.
You pass additional symbol paths in a semi-colon separated list in the Enter any runtime variables... field of
the Debug tab, as illustrated below.

7.6.5.2.3 Java
This section describes how to set up 1453 Enterprise Architect for debugging Java applications and Web
Servers 1456 .

Enterprise Architect User Guide

 Software Development | Integrated Development 1453

7.6.5.2.3.1 General Setup for Java

This is the general setup for debugging Java applications:

Option Use to

Application (Enter path) Identify the fully qualified Class name to debug, followed by any arguments.
The Class must have a method declared with the following signature:
public static void main(String[]);
The debugger calls this method on the Class you name. In the example above,
the parameters 1, 2 and 3 are passed to the method.
You can also debug a Java application by attaching to an existing Java
process 1454 .

Enter any run time Type any required command line options to the Java Virtual Machine.
variables below
You also must provide a parameter (jre) that is a path to be searched for the
jvm.dll. This is the DLL supplied as part of the Java runtime environment or
Java JDK from Sun MicrosystemsTM (see Debugging 1490 ).
In the example above, a virtual machine is created with a new Class path
property that comprises any paths named in the environment variable
classpath 1603 plus the single path "C:\benchmark\java\example1".
If no Class path is specified, the debugger always creates the virtual machine
with a Class path property equal to any path contained in the environment
variable plus the path entered in the default working directory of this script.

Note:
If source files and .class files are located under different directory trees, the
Class path property MUST include both root path(s) to the source and root
path(s) to binary class files.

Show Console Create a console window for Java. If no console window is required, leave

© 1998-2010 Sparx Systems Pty Ltd

 1454 Software Development | Integrated Development

Option Use to

blank.

Use Debugger Select Java.

7.6.5.2.3.2 Advanced Techniques

In addition to the standard Java debugging techniques, you can also:
· Attach to a Virtual Machine 1454
· Debug Internet Browser Java Applets. 1454

You can debug a Java application by attaching to an existing Java process.

However, the Java process requires a specific startup option specifying the Sparx Systems Java Agent. The
format of the command line option is:
-agentlib:SSJavaProfiler75
or:
-agentpath:"c:\program files\sparx systems\ea\SSJavaProfiler75"
The example below is for attaching to the Tomcat Webserver. Select the Attach to process radio button, and
then the keyword Attach is all that you have to enter. This keyword causes the debugger to prompt you for a
process at runtime.

Note:
The Show Console checkbox has no effect when attaching to an existing virtual machine.

No run time variables are necessary when attaching as these are specified as startup parameters to the
process.

This topic describes the configuration requirements and procedure for debugging Java Applets running in a
browser from Enterprise Architect.
The procedure requires you to attach to the browser process hosting the Java Virtual Machine (JVM) from
Enterprise Architect, as summarized below:

Enterprise Architect User Guide

 Software Development | Integrated Development 1455

1. Ensure binaries for the applet code to be debugged have been built with debug information.
2. Configure the JVM using the Java Control Panel.

3. In the Java Applet Runtime Settings panel, click on the View button. The Java Runtime Settings dialog
displays.

© 1998-2010 Sparx Systems Pty Ltd

 1456 Software Development | Integrated Development

4. Click on the appropriate entry and click on the OK button to load the Sparx Systems Agent.
5. Import source code 1329 into the Enterprise Architect model, or synchronize existing code 1327 .
6. Create or modify the Package Build Script 1425 to specify the option for attaching to the process.
5. Set breakpoints 1468 .
6. Launch the browser.
7. Attach to the browser process from Enterprise Architect.
Note that the class.path property specified for the JVM includes the root path to the applet source files. This is
necessary for the Enterprise Architect debugger to match the execution to the imported source in the model.

7.6.5.2.3.3 Working with Java Web Servers

This topic describes the configuration requirements and procedure for debugging Java web servers such as
JBOSS 1458 and Apache Tomcat (both Server 1459 configuration and Windows Service 1460 configuration) in
Enterprise Architect.
The procedure involves attaching to the process hosting the Java Virtual Machine from Enterprise Architect,
as summarized below:
1. Ensure binaries for the web server code to be debugged have been built with debug information.
2. Launch the server with the Virtual Machine startup option 1456 described in this topic.
3. Import source code into the Enterprise Architect Model, or synchronize existing code.
4. Create or modify the Package Build Script 1456 to specify the Debug option for attaching to the process.
5. Set breakpoints. 1468

6. Launch the client.

7. Attach to the process from Enterprise Architect.

Server Configuration
The configuration necessary for the web servers to interact with Enterprise Architect must address the
following two essential points:
· Any VM to be debugged, created or hosted by the server must have the Sparx Systems Agent
SSJavaProfiler75 command line option specified in the VM startup option (that is: -agentlib:SSJavaProfiler75)
· The CLASSPATH, however it is passed to the VM, must specify the root path to the package source files.
The Enterprise Architect debugger uses the java.class.path property in the VM being debugged, to locate the
source file corresponding to a breakpoint occurring in a Class during execution. For example, a Class to be
debugged is called:
a.b.C
This is located in physical directory:
C:\source\a\b
So, for debugging to be successful, the CLASSPATH must contain the root path:
c:\source.

Package Script Configuration

Using the Debug tab 1453 of the Build Script dialog, create a script for the code you have imported and specify
the following:
· Select the Attach to process radio button, and in the field below type attach.
· In the Use Debugger field, click on the drop-down arrow and select Java.

Enterprise Architect User Guide

 Software Development | Integrated Development 1457

All other fields are unimportant. The Directory field is normally used in the absence of any Class path
property.

Debugging
First ensure that the server is running, and that the server process has loaded the Sparx Systems Agent DLL
SSJavaProfiler75.DLL (use Process Explorer or similar tools to prove this).

Launch the client and ensure the client executes. This must be done before attaching to the server process in
Enterprise Architect.
After the client has been executed at least once, return to Enterprise Architect, open the source code you
imported and set some breakpoints 1468 .
Click on the Run Debugger 1471 button in Enterprise Architect. The Attach To Process dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1458 Software Development | Integrated Development

Click on the OK button. A confirmation message displays in the Debug Output window, stating that the
process has been attached.
The breakpoints should remain enabled (bright red). If the breakpoints fail, and contain either an exclamation
mark or a question mark, then either the process is not hosting the SSJavaprofiler75 Agent or the binaries being
executed by the server are not based on the source code. If so, check your configuration.

Consider the JBoss example below. The source code for a simple servlet is located in the directory location:

The binaries executed by JBOSS are located in the JAW.EAR file in this location:

The Enterprise Architect debugger has to be able to locate source files during debugging. To do this it also
uses the CLASSPATH, searching in any listed path for a matching JAVA source file, so the CLASSPATH must
include a path to the root of the package for Enterprise Architect to find the source during debugging.
The following is an excerpt from the command file that executes the JBOSS server. Since the Class to be
debugged is at com/inventory/dto/carDTO, the root of this path is included in the JBOSS classpath.

Enterprise Architect User Guide

 Software Development | Integrated Development 1459

RUN.BAT
-------------
set SOURCE=C:\Benchmark\Java\JBOSS\Inventory

set JAVAC_JAR=%JAVA_HOME%\lib\tools.jar

if "%JBOSS_CLASSPATH%" == ""
(
set JBOSS_CLASSPATH=%SOURCE%;%JAVAC_JAR%;%RUNJAR%;
)
else
(
set JBOSS_CLASSPATH=%SOURCE%;%JBOSS_CLASSPATH%;%JAVAC_JAR%;%RUNJAR%;
)

set JAVA_OPTS=%JAVA_OPTS% -agentpath:"c:\program files\sparx systems\ssjavaprofiler75"

This configuration is for the same application as outlined in the JBOSS server 1458 configuration topic.
There are two things to notice of importance.
· The Java VM option: -agentpath:c:\program files\sparx systems\ea\ssjavaprofiler75
· The addition to the Class path property of the path to the source code: C:\JBOSS\03b-dao\common\src;

© 1998-2010 Sparx Systems Pty Ltd

 1460 Software Development | Integrated Development

For users running Apache Tomcat as a WindowsTM service, it is important to configure the service to enable
interaction with the Desktop. Failure to do so causes debugging to fail within Enterprise Architect.

Select the Allow service to interact with desktop checkbox.

7.6.5.2.4 .NET
This section describes how to configure Enterprise Architect for debugging .NET applications. It covers:
· General Setup 1461
· Debug Assemblies 1461
· Debug CLR Versions 1462
· Debug COM Interop 1463
· Debug ASP .NET 1463

Enterprise Architect User Guide

 Software Development | Integrated Development 1461

7.6.5.2.4.1 General Setup for .NET

This is the general setup for debugging .NET applications:

Option Use to

Application (Enter path) Select and enter either the full or the relative path to the application
executable, followed by any command line arguments.

Enter any runtime variables Type any required command line options, if debugging a single .NET
below Assembly 1461 .

Show Console Create a console window for the debugger. Not applicable for attaching
to a process.

Use Debugger Select the debugger to suit the .NET Framework under which your
application runs.

Note:
If you intend to debug managed code using an unmanaged application, please see the Debug - CLR
Versions 1462 topic.

7.6.5.2.4.2 Debug Assemblies

Enterprise Architect permits debugging of individual assemblies.
The assembly is loaded and a specified method invoked. If the method takes a number of parameters, these
can be passed.

Constraints
Debugging of assemblies is only supported for .NET version 2.
The following image is of a Build Script configured for debugging a .NET assembly.

© 1998-2010 Sparx Systems Pty Ltd

 1462 Software Development | Integrated Development

Notice the Enter any run time variables below field. This field is a comma-delimited list of values that must
present in the following order:
type_name, method_name, { method_argument_1, method_argument2,....}
where:
· type_name is the qualified type to instantiate
· method_name is the unqualified name of the method belonging to the type that is invoked
· the argument list is optional depending on the method invoked.
The information in this field is passed to the debugger.

7.6.5.2.4.3 Debug - CLR Versions

Please note that if you are debugging managed code using an unmanaged application, the debugger might
fail to detect the correct version of the Common Language Runtime (CLR) to load. You should specify a config
file if you don’t already have one for the debug application specified in the Debug command of your script. The
config file should reside in the same directory as your application, and take the format:
name.exe.config
where name is the name of your application.
The version of the CLR you should specify should match the version loaded by the managed code invoked by
the debuggee.
Sample config file:
<configuration>
<startup>
<requiredRuntime version="version "/>
</startup>
</configuration>
where version is the version of the CLR targeted by your plugin or COM code.
For further information, see http://www.msdn2.microsoft.com/en-us/library/9w519wzk.aspx.

Enterprise Architect User Guide

 Software Development | Integrated Development 1463

7.6.5.2.4.4 Debug COM Interop

Enterprise Architect enables you to debug .NET managed code executed using COM in either a Local or an
In-Process server.
This feature is useful for debugging Plugins and ActiveX components.
1. Create a package in Enterprise Architect and import the code to debug. See Software Engineering 1281 .
2. Ensure the COM component is built with debug information.
3. Create a Script for the Package.
4. In the Debug tab, you can elect to either attach to an unmanaged process or specify the path to an
unmanaged application to call your managed code.

5. Add breakpoints in the source code to debug.

Attach to an Unmanaged Process

· If an In-Process COM server, attach to the client process or
· If a Local COM Server, attach to the server process.
Click on the Debug window Run button (or press [F6]) to display a list of processes from which you can
choose.

Important:
Detaching from a COM interop process you have been debugging terminates the process. This is a known
issue for Microsoft .NET Framework, and information on it can be found on many of the MSDN .NET blogs.

7.6.5.2.4.5 Debug ASP .NET

Debugging for web services such as ASP requires that the Enterprise Architect debugger is able to attach to a
running service.
Begin by ensuring that the directory containing the ASP .NET service project has been imported into
Enterprise Architect and, if required, the web folder containing the client web pages. If your web project
directory resides under the website hosting directory, then you can import from the root and include both ASP
code and web pages at the same time.
The following image shows the project tree of a web service imported into Enterprise Architect.

© 1998-2010 Sparx Systems Pty Ltd

 1464 Software Development | Integrated Development

It is necessary to launch the client first, as the ASP .NET service process might not already be running. Load
the client by using your browser. This ensures that the web server is running. The only difference to a debug
script for ASP is that you specify the attach keyword in your script, as follows:

Enterprise Architect User Guide

 Software Development | Integrated Development 1465

When you start the debugger (click on the Debug window 1471 Run button) the Attach To Process dialog
displays.

© 1998-2010 Sparx Systems Pty Ltd

 1466 Software Development | Integrated Development

Note that the name of the process varies across Microsoft operating systems.; check the ASP .NET SDK for
more information. The image above shows the IIS process w3wp.exe, which is the name of the process that
runs under Windows Vista.
On Windows XP, the name of the process is something like aspnet_wp.exe, although the name could reflect
the version of the .NET framework that it is supporting. There can be multiple ASP.NET processes running
under XP; you must ensure that you attach to the correct version, which would be the one hosting the .NET
framework version that your application runs on. Check the web.config file for your web service to verify the
version of .NET framework it is tied to.
The Debug window Stop button should be enabled and any breakpoints 1468 should be red, indicating they
have been bound.

Note:
Some breakpoints might not have bound successfully, but if none at all are bound (indicated by being dark
red with question marks) something has gone out of sync. Try rebuilding and re-importing source code.

You can set breakpoints at any time in the web server code. You can also set breakpoints in the ASP web
page(s) if you imported them.

Enterprise Architect User Guide

 Software Development | Integrated Development 1467

7.6.5.3 The Debug Window

The Debug window gives access to the scripts and windows of the debug facility.
To access the Debug window, select the View | Execution Analyzer | Debugger menu option.

The Debug window has three top-level folders:

· The Scripts <Package Name> folder lists the scripts available for the currently-selected package, the first in
the list being, by default, the active script that is executed when you start debugging, as indicated by the
selected checkbox. If you are using recording markers, this is also the script that determines what
recording options are applied 1492 . If you want to execute a different script, select the appropriate checkbox.
The context menu for each script provides further scripting options, such as Debug, Build, Test and Edit.

You can pin the package scripts so that they remain listed in the Debug window even if you select a
different package. To do this, right-click on the folder title and select the Pin Package context menu option;
the Scripts folder icon changes. To unpin the scripts, right-click on the folder title and deselect the Pin
Package option.

You can also drag a script onto a diagram to automatically create a hyperlink 842 that executes the script.

· The Debugger Windows folder lists the debug windows, which you can display or hide by selecting or
deselecting the checkbox against each one. If the window is docked, you can bring it to the front by clicking
on the window name:
· Breakpoints & Markers 1468 - lists any breakpoints placed in the package source code, along with
their status (enabled/disabled), line number, and the physical source file in which they are located
· Call Stack 1473 - shows the position of the debugger in the code; clicking on the > button advances
the stack through the code until the next breakpoint is reached
· Locals 1474 - shows the local variables defined in the current code segment, their type and value
· Watches 1475 - shows the values of static and globally scoped expressions you have entered
· Modules 1478 - displays all the modules loaded during a debug session
· Debug Output 1478 - displays output from the debugger including any messages output by the
debugged process, such as writes to standard output.

· The Analyzer Windows folder lists the advanced control windows of the Execution Analyzer, which you can
display or hide by selecting or deselecting the checkbox against each one:
· Record & Analyze 1506 - records any activity that takes place during a debug session; once the
activity has been logged, Enterprise Architect can use it to create a new Sequence diagram

© 1998-2010 Sparx Systems Pty Ltd

 1468 Software Development | Integrated Development

· Profiler 1514 - opens the Profiler window to sample an application

· Workbench 1519 - enables you to create instances of .NET and Java Classes
· Search 1485 - enables you to search for text in files.

You can dock and combine 76 the windows to suit your working requirements.

7.6.5.4 Breakpoint and Marker Management

Breakpoints work in Enterprise Architect much like in any other debugger. Adding a breakpoint notifies the
debugger to trap code execution at the point you have specified. When a breakpoint is encountered by a
thread of the application being debugged, the source code is displayed in an editor window, and the line of
code where the breakpoint occurred is highlighted.
Selecting a different package in the project affects which breakpoints are displayed.

Note:
The debugger does not stop automatically. It runs to completion unless it encounters a breakpoint.

An Enterprise Architect model maintains breakpoints for every package having a Build Script - Debug
command. Breakpoints themselves are listed in their own Breakpoints & Markers window (View | Execution
Analyzer | Breakpoints & Markers).

Breakpoint States
DEBUGGER STATE

Running Not running

Bound Enabled

Disabled Disabled

Not bound - this usually means that the DLL is not yet N/a
loaded or was not built with debug information

Failed - this usually means a break could not be set at N/a

this time (see Breakpoint Failures below).

Breakpoint Failures
A breakpoint failure occurs if there is a problem in binding the breakpoint. A warning message displays in the
Details column of the Breakpoints & Markers window, identifying the type of problem. For example:
· The source file for the breakpoint does not match the source file used to build the application image
· The time date stamp on the file is greater than that of the image.

Enterprise Architect User Guide

 Software Development | Integrated Development 1469

A warning message is also output to the Debug Output window.

Delete, Disable and Enable Breakpoints

To delete a specific breakpoint, either:
· If the breakpoint is enabled, click on the red breakpoint circle in the left margin of the Source Code Editor
· Right-click on the breakpoint marker in the editor and select the appropriate context menu option, or
· Select the breakpoint in the Breakpoints & Markers tab and press [Delete].
Whether you are viewing the Breakpoints folder or the Breakpoints & Markers window, you can right-click on
an existing breakpoint and select a context menu option either to delete it or to convert it to a start recording
marker or end recording marker 1499 .
You can also delete all breakpoints by clicking on the Delete all breakpoints button on the Breakpoints &

Markers window toolbar ( ).

To disable a breakpoint, deselect its checkbox on the Breakpoints & Markers window or, to disable all
breakpoints, click on the Disable all breakpoints button in the toolbar ( ). The breakpoint is then shown
as an empty grey circle. Select the checkbox or use the Enable all breakpoints button to enable it again (

).

7.6.5.4.1 How Markers are Stored

Breakpoints created that are not part of any set are maintained in an external file for the current model.
The file format is as follows:
path\guid.brkpt
where:
· path = The O/S application data directory for each user
· guid = model Guid.
Marker Sets are stored in the model and are available to all users of the Model.

7.6.5.4.2 Setting Code Breakpoints

To set breakpoints for a code segment:
1. Open the model code to debug.
2. Find the appropriate code line and click in the left margin column. A solid red circle in the margin
indicates that a breakpoint has been set at that position.

© 1998-2010 Sparx Systems Pty Ltd

 1470 Software Development | Integrated Development

If the code is currently halted at a breakpoint, that point is indicated by a blue arrow next to the marker.

7.6.5.4.3 Setting Data Breakpoints

Data breakpoints can currently only be set by right-clicking on the variable in the Locals 1474 window and
selecting the Set Data Breakpoint context menu option. This means that in order to establish a data
breakpoint you must first set a normal breakpoint 1468 at a point in the code that presents the required scope of
local variables to choose from.

7.6.5.5 Debugging Actions

This section describes the actions you perform in running a debug session. It covers:
· Displaying Windows 1471
· Starting and Stopping the Debugger 1471
· Debugging a Subsequent Process 1472
· Stepping Over Lines of Code 1472
· Stepping Into Function Calls 1473
· Stepping Out of Functions 1473
· Viewing the Call Stack 1473
· Viewing the Local Variables 1474
· Viewing the Content of Long Strings 1474
· Viewing Variables in Other Scopes 1475
· Inspecting Process Memory 1476
· Setting Breaks for When a Variable Changes Value 1477

· Showing Loaded Modules 1478

Enterprise Architect User Guide
 Software Development | Integrated Development 1471

· Showing Output from the Debugger 1478

· Debugging Tooltips in Code Editors. 1479

7.6.5.5.1 Displaying Windows

Debugger Actions - Displaying Windows

The Debugger windows 1467 are available from the View | Execution Analyzer menu options.
These windows can also be displayed and hidden from the debug management control checkboxes shown
below:

7.6.5.5.2 Start & Stop Debugger

Debugging Actions - Start & Stop

If Basic Setup 1425 has been completed, pressing [F6] starts the application using the configured Debugger.

If not, debugging is still possible by using the Attach button on either one of the Debugger toolbars.

To stop debugging, click on the Stop button in the Debug window toolbar, or press [Ctrl]+[Alt]+[F6].

Notes:
In most situations, the debugger ends:
· when it encounters breakpoints (which should be set beforehand)
· when the debug process terminates or
· when the Java Class thread exits.
However, due to the nature of the Java Virtual Machine, it is necessary at times for Java developers to stop
the debugger manually with the Stop button.

© 1998-2010 Sparx Systems Pty Ltd

 1472 Software Development | Integrated Development

7.6.5.5.3 Debug Another Process

Debugging Actions - Debug Another Process
When debugging another process, the Attach To Process dialog is displayed.
You can limit the processes displayed using the radio buttons at the top of the dialog. To find a service such
as Apache Tomcat or ASP.NET, select the System radio button.
You must choose the debugger when you select a process. However, if the selected Package has already
been configured for debugging then the Debugger listed is the one specified in the Script.

Once Enterprise Architect is attached to the process, any breakpoints encountered are detected by the
debugger and the information is available in the Debugger windows.
To detach from a process, click on the Debug Stop button.

7.6.5.5.4 Step Over Lines of Code

Debugging Actions - Step Over
You can step over the lines of a function using the Debug toolbar buttons.
When you step to the end of the function, you step back to the caller.

Alternatively, press [Alt]+[F6] or select the Project | Execution Analyzer | Step Over context menu option.

Enterprise Architect User Guide

 Software Development | Integrated Development 1473

7.6.5.5.5 Step Into Function Calls

Debugging Actions - Step In

The Step In function is executed by clicking on the Step In button.

Alternatively, press [Shift]+[F6] or select the Project | Execution Analyzer | Step In context menu option.
If no source is available for the function then the debugger continues stepping until it either enters a new
function or reaches the next line of the current one.

7.6.5.5.6 Step Out of Functions

Debugging Actions - Step Out

The Step Out function is executed by clicking on the Step Out button.

Alternatively, press [Ctrl]+[F6] or select the Project | Execution Analyzer | Step Out context menu option.
If no source is available for the function then the debugger will continue stepping till it either enters a new
function or reaches the
next line of the current one.

7.6.5.5.7 View the Call Stack

Debugging Actions - View the Call Stack
The Call Stack window shows all currently running threads. A Stack trace is displayed whenever a thread is
suspended, through one of the step actions or through encountering a breakpoint 1468 .
· A green or yellow arrow highlights the current stack frame
· A blue arrow indicates a thread that is running
· A red arrow indicates a thread for which a stack trace history is being recorded
· Double-clicking a frame takes you to that line of code in the Source Code Editor; local variables are also
refreshed for the selected frame.

Toolbar

- Save Stack to file

© 1998-2010 Sparx Systems Pty Ltd

 1474 Software Development | Integrated Development

- Generate Sequence diagram from Stack

- Copy Stack to recording history

- Toggle Stack View

- Stop recording

7.6.5.5.8 View the Local Variables

Debugging Actions - Viewing Local Variables
Whenever a thread encounters a breakpoint 1468 , this window displays all the local variables for the thread at
its current stack 1473 frame.
The value and the type of any in-scope variables are displayed in a tree, as shown in the following screen:

Local variables are displayed with colored box icons with the following meanings:

· Blue Object with members

· Green Arrays

· Pink Elemental types

· Yellow Parameters

· Red Workbench Instance

7.6.5.5.9 View Content Of Long Strings

Debugging Actions - View Entire Content Of Long Strings
For efficiency, the Locals window only shows partial strings. The size of any variable value displayed in the
window can be up to 256 characters.
To view the entire value of a variable, right-click on it and select the View in Editor context menu option. The

Enterprise Architect User Guide

 Software Development | Integrated Development 1475

String Viewer dialog displays.

7.6.5.5.10 View Variables in Other Scopes

Debugging Actions - Viewing the Variables in Other Scopes
The Watches window is most useful for native code (C, C++, VB) where it can be used to evaluate data items
that are not available as Local Variables 1474 - data items with module or file scope and static Class member
items.
You can also use the window to evaluate static Class member items in Java and .NET.

© 1998-2010 Sparx Systems Pty Ltd

 1476 Software Development | Integrated Development

To use the Watches window, type the name of the variable to examine in the field in the window toolbar, and
either press [Enter] or click on the Add new watched item icon.
To examine a static Class member variable in C++, Java or Microsoft .NET enter its fully qualified name. For
example:
CMyClass::MyStaticVar
To examine a C++ data symbol with module or file scope, just enter its name. Note, items are evaluated only if
the package in whose scope the item resides is currently loaded by the process being debugged. If the
debugger is not running, no items are listed.
The names of the items to evaluate persist for the package and user ID, so the next time you debug the same
project, the items evaluate automatically whenever a breakpoint occurs. They do not appear if another user
debugs the same code.
If necessary, you can delete items using the Delete all watched items icon in the toolbar, or the right-click
context menu options inside the window.

7.6.5.5.11 Inspect Process Memory

Debugging Actions - Inspecting Process Memory Debugging
You can display the raw values at a memory address or for a variable in a window using the Memory Viewer -
select the View Memory at Address context menu option.

Enterprise Architect User Guide

 Software Development | Integrated Development 1477

The Memory Viewer displays the raw values at a memory address

The Memory Viewer is available for debugging Microsoft Native Code Applications (C,C++,VB) running on
Windows or within WINE on Linux.

7.6.5.5.12 Break When a Variable Changes Value

Debugging Actions - Break when a Variable Changes Value
An invalid or uninitialised variable can cause the program behaviour to differ from expected. This tool enables
you to halt execution whenever a certain variable has its value changed.

Note:
This feature is not presently supported by the Microsoft .NET platform.

The example below creates a notification on a variable from the Watches window. The item being watched is
an integer in the SSP namespace scope.

© 1998-2010 Sparx Systems Pty Ltd

 1478 Software Development | Integrated Development

7.6.5.5.13 Show Loaded Modules

Debugging Actions - Show loaded modules
The debugger Modules window lists the modules loaded by the process being debugged.

The columns on this window are described below:

Column Use To

Path Determine the file path of the loaded module.

Modified Date Determine the local file date and time the module was modified.

Debug Symbols Establish the debug symbols type, whether debug information is present in the
module and whether line information is present for the module (required for
debugging).

Symbol File Match Check the validity of the symbol file; if the value is false, the symbol file is out of
date.

Symbol Path Determine the file path of the symbol file, which must be present for debugging to
work.

Modified Date Determine the local file date and time the symbol file was created.

7.6.5.5.14 Show Output from Debugger

Debugging Actions - Show Output From Debugger
During a debug session the Debugger emits messages detailing both startup and termination of session, to its
Output tab. Details of exceptions and any errors are also output to this tab. Any trace messages such as those
output using Java System.out or .NET System.Diagnostics.Debug are also captured and displayed here.

Enterprise Architect User Guide

 Software Development | Integrated Development 1479

7.6.5.5.15 Debug Tooltips in Code Editors

Debugging Actions - Viewing Variable Values in Code Editors
During debugging, whenever a thread is suspended at a line of execution, you can inspect member variables
in the Editor window.
To evaluate a member variable, use the mouse to move the cursor over the variable in the Editor window, as
shown in the following examples.

© 1998-2010 Sparx Systems Pty Ltd

 1480 Software Development | Integrated Development

7.6.5.6 Recording Actions

This section describes how to perform the following debug recording actions:
· Step through function calls 1480
· Create a Sequence diagram of the Call Stack 1480

· Save the Call Stack. 1482

7.6.5.6.1 Step Through Function Calls

Debugging Actions - Step Through

The Step Through function can be executed by clicking on the Step Through button on the Record & Analyze
window toolbar.

Alternatively, press [Shift]+[F6] or select the Project | Execution Analyzer | Step Into context menu option.
The Step Through command causes a Step Into command to be executed. If any function is detected, then
that function call is recorded in the History window. The debugger then steps out, and the process can be
repeated.
This button enables you to record a call without having to actually step into a function. The button is only
enabled when at a breakpoint and in manual recording mode.

7.6.5.6.2 Create Sequence Diagram of Call Stack

Debugging Actions - Create Sequence Diagram from Current Call Stack

To generate a Sequence diagram from the current Stack, click on the Generate Sequence Diagram of Stack
button on the Call Stack window toolbar.

This immediately generates a Sequence diagram in the Diagram View.

Enterprise Architect User Guide

Software Development | Integrated Development 1481

© 1998-2010 Sparx Systems Pty Ltd

 1482 Software Development | Integrated Development

7.6.5.6.3 Saving the Call Stack

Debugging Actions - Saving the Call Stack
On the Call Stack window, you can save the current Stack to file or copy the Stack to the recording history.

Toolbar

- Save Stack to file

- Copy Stack to recording history

7.6.6 Run
This section describes how to create a command for running 1482 your executable code.

7.6.6.1 Add Run Command

This topic explains how you enter a command for running your executable.
This is the command that is executed when you select the Project | Execution Analyzer | Run menu option.
At its simplest, the script would contain the location and name of the file to be run.

Note:
Enterprise Architect provides the ability to start your application normally OR with debugging from the same
script. The Execution Analyzer menu has separate options for starting a normal run and a debug run.

The following two examples show scripts configured to run a .Net and a Java application in Enterprise

Enterprise Architect User Guide

 Software Development | Integrated Development 1483

Architect.

Note:
The command listed in this field is executed as if from the command prompt. As a result, if the executable
path or any arguments contain spaces, they must be surrounded in quotes.

7.6.7 Testing
This section describes how to create a command for performing unit testing 1483 on your code.

7.6.7.1 Add Testing Command

This topic explains how you enter a command for performing unit testing on your code.
The command is entered in the text box using the standard Windows Command Line commands. A sample
script would contain a line to execute the testing tool of your choice, with the filename of the executable
produced by the Build command as the option. To execute this test select the Project | Execution Analyzer |
Test menu option.
Testing could be integrated with any test tool using the command line provided, but in these examples you can
see how to integrate NUnit and JUnit testing with your source code. Enterprise Architect provides an inbuilt
MDA Transform from source to Test Case, plus the ability to capture xUnit output and use it to go directly to a
test failure. xUnit integration with your model is now a powerful means of delivering solid and well-tested code
as part of the complete model-build-test-execute-deploy life-cycle.

Note:
NUnit and JUnit must be downloaded and installed prior to their use. Enterprise Architect does not include
these products in the base installer.

The Capture Output checkbox enables Enterprise Architect to show the output of the program in the Output
window, while the Output Parser field specifies what format output is expected. When parsing is enabled,
double-clicking on a result in the Output window opens the corresponding code segment in Enterprise
Architect's code window.
Selecting the Build before Test checkbox ensures that the package is recompiled each time you run the test.
Two example test scripts are included below. The first is an NUnit example that shows the Build before Test
checkbox selected. As a result, every time the test command is given it runs the build script first.

© 1998-2010 Sparx Systems Pty Ltd

 1484 Software Development | Integrated Development

Note:
The command listed in this field is executed as if from the command prompt. As a result, if the executable
path or any arguments contain spaces, they must be surrounded in quotes.

The second example is for JUnit. It doesn't have the Build before Test checkbox selected, so the build script
won't be executed before every test, but as a result it could test out of date code. This also shows the use of %
N, which is replaced by the fully namespace-qualified name of the currently selected Class when the script is
executed.

7.6.8 Deploying
This section describes how to create a command for deploying 1484 the current package.

7.6.8.1 Add Deploy Command

This topic enables you to create a command for deploying the current package.
These are the commands that are executed when you select the Project | Execution Analyzer | Deploy
menu option.
Write your script in the large text box using the standard Windows Command Line commands.

Enterprise Architect User Guide

 Software Development | Integrated Development 1485

7.6.9 Searching Files

This topic describes how to use the File Search 1485 facility.

7.6.9.1 Search in Files

This topic describes the File Search control.
File Text Searches are provided by the Search Window and from within the Code Editors.
The Search window enables you to search for text in code files and scripts. You can select to display the
results of the search in one of two formats:
· List View - each result line consists of the file path and line number, followed by the line text; multiple lines
from one file are listed as separate entries

· Tree View - each result line consists of the file path that matches the search criteria, and the number of
lines matching the search text within that file; you can expand the entry to show the line number and text of
each line.

© 1998-2010 Sparx Systems Pty Ltd

 1486 Software Development | Integrated Development

Search Toolbar
You can use the toolbar options in the Search window to control the search operation. The state of all buttons
persists over time to always reflect your previous search criteria.

The options, from left to right, are as follows:

Option Use to

Search Path list box Specify the folder to search.

You can type the path to search directly into the text box, or click on the folder icon
to browse for the path. Any paths you enter are automatically saved in the
drop-down list, up to a maximum of ten; paths added after that overwrite the oldest
path in the list.
A fixed option in the drop-down list is Search in Scripts, which sets the search to
operate on all local and user-defined scripts in the Scripts tab of the Scripter
window. This option disables the Search File Types list box.

Search Text list box Specify the text to look for.

You can type the text directly into the text box or click on the drop-down arrow to
select from a previous entry in the list. The search text you enter is automatically
saved in the list when you click on the Search button.
The list box saves up to ten search queries. Search queries added after that
overwrite the oldest query in the list.

Search File Types list Limit the search to specific types of files. You can select multiple file types in a
box string, separated by either a comma or a semi-colon as shown in the image above.

Search button Begin the search.

During the course of the search all other buttons in the toolbar are disabled. You
can cancel the search at any time by clicking on the Search button again.
If you switch any of the toggle buttons below, you must run the search again to
change the output.

Enterprise Architect User Guide

 Software Development | Integrated Development 1487

Option Use to

Case Sensitivity Toggle the case sensitivity of the search. The tooltip message identifies the
button current status of the button.

Word Match button Toggle between searching for any match and searching for only those matches
that form an entire word. The tooltip message identifies the current status of the
button.

SubFolders button Toggle between limiting the search to a single path and including all subfolders
under that path. The tooltip message identifies the current status of the button.

Result View button Select the presentation format of the search results - List View or Tree View
format.

Clear Results button Clear the results.

Clear Search Criteria Remove all the entries in the Search Path, Search Text and Search File Types
button list boxes, if required.

Help button Display this Help topic.

© 1998-2010 Sparx Systems Pty Ltd

 1488 Software Development | Visual Execution Analysis

7.7 Visual Execution Analysis

The Visual Execution Analyzer provides facilities to model, develop, debug, profile and manage an application
from within the modeling environment.
The Visual Execution Analyzer can generate a number of outputs, including:
· Sequence Diagrams, recording live execution of an application, or specific call stacks
· State Transition Diagrams, a Sequence diagram with states, illustrating changes in data structures
· Profiler reports, showing application sequences and operation call frequency.
These outputs provide a better understanding of how your system works, enabling you to document system
features and providing information on the sequence of events that lead to an erroneous event or an
unexpected system behavior.

Note:
The Visual Execution Analyzer is available in the Enterprise Architect Professional, Corporate, Business and
Software Engineering, System Engineering, and Ultimate editions.

7.7.1 Introducing the Visual Execution Analyzer

With the Visual Execution Analyzer, you can create and store custom scripts that specify how to build, test,
run and deploy code associated with a package. You can investigate and manipulate the output of the debug
process. The Analyzer also includes an Execution Profiler, which enables you to determine how the functions
in an application are called and executed.
You access the Visual Execution Analyzer using the Project | Execution Analyzer menu option, or the
context menu of the required package in the Project Browser. These menus provide a number of options to
facilitate debugging, such as setting recording options or breakpoints.
The Visual Execution Analyzer can be used to:
· Optimize existing system resources and understand resource allocation
· Ensure that the system is following the rules as designed
· Produce high quality documentation that more accurately reflects system behavior
· Understand how and why systems work
· Train new employees in the structure and function of a system
· Provide a comprehensive understanding of how existing code works
· Identify costly or unnecessary function calls
· Illustrate interactions, data structures and important relationships within a system
· Trace problems to a specific line of code, system interaction or event
· Visualize why a sequence of events is important
· Establish the sequence of events that occur immediately prior to system failure.

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1489

7.7.2 Structure of the Visual Execution Analyzer

The Visual Execution Analyzer comprises a Model Driven Development Environment and an Execution
Analyzer.
The Model Driven Development Environment 1277 (MDDE) provides tools to design, build and debug an
application:
· UML technologies 1066 and tools to model software 370
· Code generation 1308 tools to generate/reverse engineer source code
· Tools to import source code 1329 and binaries 1334
· Code editors that support different programming languages 1425
· Intellisense to aid coding 1432
· Package scripts that enable a user to describe how to build, debug, test and deploy the application 1426 .

The Execution Analyzer 1490 (EA) provides tools to visualize an existing application's behaviour:
· Record sequence diagrams of application activities 1490
· Capture State Transitions for a particular State Machine 1507

· Capture Stacktraces at points in execution 1468

· Profiling tool to sample application activity 1514
· Object Workbench 1519
· Unit Testing 1512

© 1998-2010 Sparx Systems Pty Ltd

 1490 Software Development | Visual Execution Analysis

7.7.3 Execution Analysis

This section describes the Visual Analysis of executing applications by recording application execution and
generating:
· Sequence Diagrams
· Sequence/State Diagrams
· Profile (execution) Reports
Execution analysis is configured by creating a debug script 1447 for the packages to be tested. One of the
primary objectives of this feature is to enable you to perform a debug walk-through executing code, and
capture your stack trace for direct conversion into a Sequence diagram. This is a great way to document and
understand what your program is doing during its execution phase.
Execution Analysis debugging and recording are supported for the following platforms / languages:
· Microsoft Windows Native C
· Microsoft Windows Native C++
· Microsoft Windows Visual Basic
· Microsoft .NET Family (C#, J#, VB)
· Sun Microsystems Java.

7.7.3.1 Recording Sequence Diagrams

This section explains how to use the Visual Execution Analyzer to record execution data in the form of a
Sequence Diagram. It covers:
· An overview of how the process works 1491

· Setup for recording 1492

· Placing recording markers 1499
· Controlling the recording session 1504

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1491

· Generating Sequence diagrams 1505

· Adding State Transitions. 1507

7.7.3.1.1 How it Works

The Visual Execution Analyzer enables you to generate a Sequence Diagram. The diagram below illustrates
the output of a Sequence Diagram for a program that calculates the price of books. The diagram creates a
visual representation of the execution of an application, outlining what functions are being called, types of
messages being sent, key data structure used and the relationships between different classes. The diagram
makes it much simpler to Understand how information is moved throughout the system and what values are
being passed by various functions. The first loop structure is executed four times and is being used to add
four books to the book database. The arrows indicate information flow and demonstrate the change of states
over time.

A Sequence diagram provides easy to understand visual information including:

· An understanding of how information is passed throughout a system.
· The sequence of various functions and their corresponding parameters.
· A clear understanding of how different classes interact to create behavior.
· A visual overview of how data structures are used to produce results.
If an application crashes, data corruption such as a stack overflow can prevent you from diagnosing and
rectifying the problem. However the Visual Execution Analyzer allows you to record a given execution
sequence and provide a reliable source of information that may further explain why a crash occurred.
Enterprise Architect can record arguments to functions, record calls to external modules or capture state

© 1998-2010 Sparx Systems Pty Ltd

 1492 Software Development | Visual Execution Analysis

transitions based on any given constraint. This information can be integrated with existing system knowledge
and test data to optimize code execution, reduce errors and understand why application failure and system
crashes occur.
A Sequence Diagram extends traditional analysis to help identify errors in logic, explain unexpected system
behavior and identify data flow inconsistencies. The Visual Execution Analyzer extends analysis through the
use of a comprehensive array of reports that detail everything from state transitions through to the contents of
the stack at a given time. A Sequence Diagram can convey more detail and provide greater understanding
than reading unfamiliar code that has potentially been written by someone else. It also makes it easier to
document existing code when a Sequence Diagram illustrates functions are being called and the specific
sequence of events that occur to produce a particular type of system behavior.

7.7.3.1.2 Setup for Recording

This section explains how you prepare to record execution of the application. It covers:
· Prerequisites 1492
· Configuring Recording Detail 1492

· Advanced Techniques 1497

7.7.3.1.2.1 Pre-Requisites
Recording is available to users of all editions of Enterprise Architect except the Desktop edition.
Basic setup 1425 must be completed.
You should first be able to successfully debug 1446 the application.

7.7.3.1.2.2 Configure Recording Detail

The Sequence Diagram Recording tab enables you to set various options for generating Sequence diagrams
from the debugger.

These options are not all available for each platform, as indicated in the following table:

Option .NET Java Native

Enable Filter 1493 X X X

Record arguments to function calls 1494 X X X

Record calls to external modules 1494 X X X

Record calls to dynamic modules 1495 X - -

Capture state transitions using constraint 1507 X X X

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1493

Option .NET Java Native

Limit auto recording to stack frame threshold 1496 X X X

Enable diagnostic messages 1496 X X X

If the Enable Filter option is selected on the Sequence Diagram Recording tab, the debugger excludes calls
to matching methods from the generated sequence history and diagram. The comparison is case-sensitive.
To add a value, click on the New (Insert) icon in the right corner of the Filters box, and type in the comparison
string. Each filter string takes the form:

class_name_token::method_name_token

The class_name_token excludes calls to all methods of a Class or Classes having a name that matches the
token. The string can contain the wildcard character * (asterisk). The token is optional.
The method_name_token excludes calls to methods having a name that matches token. The string can
contain the wildcard character *. The token is optional.
Where no Class token is present, the filter is applied only to global or public functions; that is, methods not
belonging to any Class.

To Filter Use Filter Entry

All public functions having a name beginning with Get from the recording
::Get*
session (GetClientRect for example in Windows API).

All methods beginning with Get for every Class member method.
*::Get*

All methods beginning with Get from the Class CClass.

CClass::Get*

All methods for Class CClass.

CClass::*

All methods for Classes belonging to Standard Template and Active Template
Libraries. · ATL*
· std*

The specific method GetName for Class CClass.

CClass::GetName

In the Java example in the screen below, the debugger would exclude:
· Calls to the OnDraw method for the Class Example.common.draw.DrawPane
· Calls to any method of any Class having a name beginning with Example.source.Collection
· Calls to any constructor for any Class (ie: <clint> and <init>).

In the Native code example below, the debugger would exclude:

© 1998-2010 Sparx Systems Pty Ltd

 1494 Software Development | Visual Execution Analysis

· Calls made to Standard Template Library namespace

· Calls to any Class beginning with TOb
· Calls to any method of Class CLock
· Calls to any Global or Public Function with a name beginning with Get
· Calls to the method GetLocation for Class Ctrain.

When recording the sequence history, Enterprise Architect can record the arguments passed to method calls.

When the Record Arguments to function calls option is selected on the Build Script dialog Sequence
Diagram Recording tab, the resulting Sequence diagram shows the values of elemental and string types
passed to the method. See the following Java example.

Where the argument is not an elemental type, the type name is recorded instead.

On the Sequence Diagram Recording tab, the Record calls to external modules option causes function calls
to external modules outside the model to be included in the sequence history and generated diagram.
For applications built in a Microsoft Native code (C, C++) you can record calls to the WIN32 API if required,
using the Record calls to external modules option. This option can also be used to record calls to
functions in modules that have a PDB file but for which there is no source.

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1495

Only calls originating within the model to functions external to the model are recorded.

Note:
External calls are displayed with a blue connector, as shown below.

This example shows three external calls (ToString()) to the Microsoft .NET framework assembly function
System.Single.

(Available only for .NET platforms.)

On the Sequence Diagram Recording tab, the Record calls to dynamic modules option causes the
debugger to record execution of dynamic or 'In Memory' function calls, in transitions between normal
assemblies and those emitted dynamically.

© 1998-2010 Sparx Systems Pty Ltd

 1496 Software Development | Visual Execution Analysis

Where the Stack window shows recording to be involved in function calls that are not particularly useful, and
that are not being excluded in a filter, you can achieve a quicker and more general picture of a sequence by
limiting the stack depth being recorded. You can do this on the Sequence Diagram Recording tab, by selecting
the Limit auto recording to stack frame threshold: option.
If you use this option, be aware that the threshold value you set is a relative frame count; that is, the count is
relative to the frame at which recording begins. For example:
A breakpoint has occurred, and the Stack window shows five frames. If the stack frame threshold is set
to 3 and you begin auto-recording at this breakpoint, the debugger records all function calls between the
current frame 5 and a maximum stack frame depth of 8 inclusive.
For situations during auto-recording where the stack is very large, it is recommended that you first use a low
stack frame threshold of 2 or 3, gradually increasing it if necessary to expand the picture. You can also use the
threshold to work out which filters you could add to the script in order to further clarify the Sequence diagram
that is ultimately produced.

The Enable diagnostic messages checkbox triggers the debugger to output more self-reporting, diagnostic
messages as it executes. For example, the debugger might output messages about method calls that are
being excluded from the recording history due to a filter also having been set in the Sequence Diagram
Recording tab of the Build Script dialog.

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1497

7.7.3.1.2.3 Advanced Techniques

This section describes the advanced techniques for configuring recording detail:
· Recording Activity for a Class 1497
· Recording Activity for a single method 1498

In addition to setting breakpoints and markers in the code editor, you record all the operations of a class, or a
subset by using the Class Markup Feature.
This feature is available from the Project Browser context menu while on a Class. Select the operations to
record, choose the marker type and enter a name for the set. When you click on the OK button the markers
are stored as a marker set using the name you specify.
This set can then be loaded either before or during a session.
The marker type specifies the action to take when the process encounters that marker.
· Record function
· Record Stack Trace
· Break execution
You can also specify a recording depth. This limits the recording, which if uncontrolled can ultimately produce
Sequence Diagrams that are too complicated to read. When you specify a depth, the Debugger does not
record beyond this depth.
The depth is relative to the stack depth where the Debugger first encountered the recording marker. So, if the
stack depth is 7 when recording begins, and the Limit Depth is set to 3, the Debugger does not record
beyond a Stack depth of 10.

© 1998-2010 Sparx Systems Pty Ltd

 1498 Software Development | Visual Execution Analysis

A Method Auto Record 1499 marker enables you to record activity for a particular function during a debug
session. The debugger records any function calls executed after the marker point, and always stops recording
when this function exits. The function marker combines a Start Recording marker and an End Recording
marker in one.

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1499

7.7.3.1.3 Place Recording Markers

This section explains how to deploy recording markers:
· Marker types 1499
· Setting Recording Markers 1502
· The Breakpoint and Markers window 1503
· Activate and Disable Markers 1503
· Working with Marker Sets 1503
· Differences between breakpoints and markers. 1503

7.7.3.1.3.1 Marker Types

Trace marking is a feature that enables you to silently record code executed between two points, and
incorporate it in a Sequence diagram. The feature also enables you to capture the execution of multiple
threads. It can be particularly useful in capturing event driven sequences (such as mouse and timer events)
without any user intervention.
The recording markers are breakpoints; however, instead of stopping, the debugger behaves according to the
type of marker. If the marker is denoted as a recording start point, the debugger immediately begins to trace
all executed calls from that point for the breaking thread. Recording is stopped again when either the thread
that is being captured terminates or the thread encounters a recording end point.
Recording markers are set in the source code editor. If you right-click on the breakpoint margin at the point to
begin recording, a context menu displays:

Select the Add Start Recording Marker option, then right-click on the breakpoint margin at the point to stop
recording and select the Add End Recording Marker context menu option. The markers are shown below:

When the debugger is run it continues to run the thread, recording a stack history, until either the End

© 1998-2010 Sparx Systems Pty Ltd

 1500 Software Development | Visual Execution Analysis

Recording marker is encountered or the thread terminates, unlike normal breakpoints where the debugger
halts and displays the line of code.
It is useful to limit the stack depth 1496 when recording particularly high-level points in an application, as the
stack frame count can result in too much information being collected. You can limit stack depth using the
Sequence Diagram Recording tab on the Build Script dialog.

Running this Calendar example with the one function record marker in CRecurrenceDlg::OnInitDialog()
produced the following output in the Recording History window:

Stack Auto-Capture Marker

(Native Code only.) Stack markers enable you to capture any unique stack traces that occur at a point in an
application. To insert a marker at the required point in code, right-click on the line and select the Add Stack
Auto Capture Marker context menu option.
Each time the debugger encounters the marker it performs a stack trace. If the stack trace is not in the
recording history, it is copied. The application then continues running. Stack markers provide a quick and
useful picture of where a point in an application is being called from.

Enterprise Architect User Guide

Software Development | Visual Execution Analysis 1501

© 1998-2010 Sparx Systems Pty Ltd

 1502 Software Development | Visual Execution Analysis

7.7.3.1.3.2 Setting Recording Markers

Recording markers are set in the source code editor. If you right-click on the breakpoint margin at the point to
begin recording, a context menu displays:

Select the Add Start Recording Marker option, then right-click on the breakpoint margin at the point to stop
recording and select the Add End Recording Marker context menu option. The markers are shown below:

When the debugger is run it continues to run the thread, recording a stack history, until either the End
Recording marker is encountered or the thread terminates, unlike normal breakpoints where the debugger
halts and displays the line of code.

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1503

7.7.3.1.3.3 The Breakpoints and Markers Window

The Breakpoints and Markers window allows you to manage control of the process. Here you can enable,
disable, delete markers and also manage them as sets. You can organize how they are displayed, either in list
view or grouped by file or class.

7.7.3.1.3.4 Activate and Disable Markers

To delete a specific breakpoint, either:
· If the breakpoint is enabled, click on the red breakpoint circle in the left margin of the Source Code Editor
· Right-click on the breakpoint marker in the editor and select the appropriate context menu option, or
· Select the breakpoint in the Breakpoints & Markers tab and press [Delete].
Whether you are viewing the Breakpoints folder or the Breakpoints & Markers window, you can right-click on
an existing breakpoint and select a context menu option either to delete it or to convert it to a start recording
marker or end recording marker 1499 .
You can also delete all breakpoints by clicking on the Delete all breakpoints button on the Breakpoints &

Markers window toolbar ( ).

To disable a breakpoint, deselect its checkbox on the Breakpoints & Markers window or, to disable all
breakpoints, click on the Disable all breakpoints button in the toolbar ( ). The breakpoint is then shown
as an empty grey circle. Select the checkbox or use the Enable all breakpoints button to enable it again (

).

7.7.3.1.3.5 Working with Marker Sets

Marker sets enable you to group markers into collections.
A set can be used to record a specific Use Case, which might involve the operations of various Classes. Once
a set is created it is saved with the Model. Any other user using the Model has access to that set.
Sets are normally loaded prior to the point at which an action is to be captured. For example, to record a
sequence involving a particular dialog, you might set markers for the areas to record, saving the markers as a
set. When you begin debugging, prior to invoking the dialog you would then load the set. Once you bring up
the dialog in the application, the operations you have marked are recorded. Review the recording history and
create a Sequence diagram.

7.7.3.1.3.6 Differences to Breakpoints

Breakpoints differ from Markers in that they always break execution whereas Markers operate silently without
intervention.

© 1998-2010 Sparx Systems Pty Ltd

 1504 Software Development | Visual Execution Analysis

7.7.3.1.4 Control the Recording Session

This section describes how you control the recording session:
· Auto Recording 1504
· Manual Recording 1504
· Pause Recording 1505
· Resume Recording 1505
· Stop Capture. 1505

7.7.3.1.4.1 Auto-Recording
Auto-Recording is available when the process being debugged is at a breakpoint.
You can use the record button on the Record & Analyze window toolbar.

Alternatively, select the thread in the stack window:

7.7.3.1.4.2 Manual Recording

Manual Recording is available when the process being debugged is at a breakpoint.
Display the Stack window and use the context menu to switch to record mode.

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1505

Thereafter you must issue debug commands {StepIn, StepOver, StepOut, Stop} manually.
Each time you issue a step command and the thread stack changes, the sequence of execution is logged.

When you have finished tracing, click on the Stop button ( ).

7.7.3.1.4.3 Pause Recording

You can pause recording by using the Pause/Resume Execution button on the Debug window toolbar or in
the Debug Management window ([Alt]+[8]).

7.7.3.1.4.4 Resume Recording

You can resume recording using the Pause/Resume Execution button on the Debug window toolbar or in
the Debug Management window ([Alt]+[8]).

7.7.3.1.4.5 Stop Capture

To stop recording at any time click on the Stop Recording button on the Record & Analyze window toolbar.

7.7.3.1.5 Generating Sequence Diagrams

Once you have captured activity and are about to generate the diagram, firstly select a package in the Project
Browser where you intend the Sequence diagram to be stored. Then use the toolbar on the Record & Analyze
window to generate the diagram.

© 1998-2010 Sparx Systems Pty Ltd

 1506 Software Development | Visual Execution Analysis

7.7.3.1.5.1 The Recording History

All information recorded as a result of the application encountering recording markers set by the user is held in
the Record & Analyze window.

The columns in this window are as follows:

· Sequence - The unique sequence number
Note:
The checkbox against each number is used to control whether or not this call should be used to create a
Sequence diagram from this history. In addition to enabling or disabling the call using the checkbox, you
can use context menu options to enable or disable an entire call, all calls to a given method, or all calls to
a given Class.

· Threads - The operating system thread ID

· Delta - The elapsed thread CPU time since the start of the sequence
· Method - There are two Method columns: the first shows the caller for a call or for a current frame if a
return; the second shows the function called or function returning
· Direction - Stack Frame Movement, can be Call, Return, State, Breakpoint or Escape (Escape is used
internally when producing a Sequence diagram, to mark the end of an iteration)
· Depth - The stack depth at the time of a call; used in the generation of Sequence diagrams
· State - The state between sequences
· Source - There are two Source columns: the first shows the source filename and line number of the caller
for a call, or for a current frame if a return; the second shows the source filename and line number of the
function called or function returning.
· Instance - There are two Instance columns; these columns only have values when the Sequence diagram
produced contains State transitions. The values consist of two items separated by a comma - the first item
is a unique number for the instance of the Class that was captured, and the second is the actual instance
of the Class.

For example: supposing a Class CName has an internal value of 4567 and the program created two
instances of that Class; the values might be:
· 4567,1
· 4567,2
The first entry shows the first instance of the Class and the second entry shows the second instance.

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1507

7.7.3.1.5.2 Generate a Diagram

To generate a Sequence diagram for all history click on the toolbar Create Sequence Diagram icon ( ).

To generate a Sequence diagram for a single sequence, select it and then click the toolbar Create Sequence

Diagram icon ( ).

7.7.3.1.5.3 Diagram Features

The Sequence diagram produced includes the following:
References
When the Visual Execution Analyzer cannot match a function call to an operation within the model, it still
creates the sequence, but it creates a reference for any Class that it cannot locate. It does this for all
languages.
Fragments
Fragments displayed in the Sequence diagram represent loops or iterations of a section(s) of code. The Visual
Execution Analyzer attempts to match function scope with method calls to as accurately as possible represent
the execution visually.
States
If a State Machine has been used during the recording process, any transitions in State are presented after
the method call that caused the transition to occur. States are calculated on the return of every method to its
caller.

7.7.3.1.5.4 Saving Recording

To save a sequence to an XML file, click on the sequence and on the toolbar Save button ( ).

To access an existing sequence file, either:

· Click on the toolbar Open icon ( ), or

· Right-click on a blank area of the screen and click on the Load Sequence From File context menu option.
The Windows Open dialog displays, from which you select the file to open.

7.7.3.1.6 Add State Transitions

This topic describes how to add State Transitions. It covers:
· Setup for Capturing State Changes 1508
· The State Machine 1509
· Recording and Mapping State Changes. 1511

© 1998-2010 Sparx Systems Pty Ltd

 1508 Software Development | Visual Execution Analysis

7.7.3.1.6.1 Setup for Capturing State Changes

You can generate Sequence diagrams that show transitions in state as a program executes. The illustration
below shows a project that has, in its State Machine, a number of States that correspond to stations in the
Melbourne underground railway system.

Showing State transitions on your debug-generated Sequence diagrams is optional; you set an option in the
package script associated with the Class for which you intend to record States.

Note:
If you do not have a package script for the Class or package you must create one. Sequence diagrams can
only be generated for a package that has been configured for debug.

Next, you create a State Machine under the Class. On the State Machine you create the State elements that
correspond to any states to be captured for your Class. The debugger evaluates your States by checking
constraints on the States you create. The States on this diagram are then used by the debugger and State
transitions are incorporated into the diagram.

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1509

This figure shows the Class CXTrain with a State Machine called Stations. It has a child diagram also called
Stations, on which the States {Central,Flinders,Lonsdale...} are placed.

7.7.3.1.6.2 The State Machine

A State Transition diagram can be used to illustrate how States change during the execution of an application.
The Visual Execution Analyzer can build a State Machine to model all the valid system states and explicitly
describe the transitions between each state. The diagram below is a State Machine that shows the different
States within the Melbourne Underground Loop subway system. A train traveling on the subway network can
be stopped at any of the stations represented on the State Machine below.

© 1998-2010 Sparx Systems Pty Ltd

 1510 Software Development | Visual Execution Analysis

This State Machine diagram is a child of the CXTrain Class.

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1511

7.7.3.1.6.3 Recording and Mapping State Changes

The State Properties dialog below is for the State Parliament. The Constraints tab is open to show how the
State is linked to the Class CXTrain. A State can be defined by a single constraint or by many; in the example
below the State Parliament has two constraints.

The CXTrain Class has a member called Location of type int, and a member called Departing.Name of type
CString.
The values of constraints can only be compared for elemental, enum and string types. What this constraint
means is:
· when an instance of the CXTrain Class exists and
· its member variable Location has the value 0 and
· the member variable Departing.Name has the value Parliament then
· this State is evaluated to true.

Operators in Constraints
There are two types of operators you can use on constraints to define a State:
· Logical operators AND and OR can be used to combine constraints
· Equivalence operators {= and !=} can be used to define the conditions of a constraint.
All the constraints for a State are subject to an AND operation unless otherwise specified. You can use the OR
operation on them instead, so you could rewrite the constraints in the above example as:
Location=0 OR

Location=1 AND

Departing.Name!=Central

Below are some examples of using the equivalence operators:

Departing.Name!=Central AND

© 1998-2010 Sparx Systems Pty Ltd

 1512 Software Development | Visual Execution Analysis

Location!=1

Note:
Quotes around strings are optional. The comparison for strings is always case-sensitive in determining the
truth of a constraint.

7.7.3.2 Unit Testing

Enterprise Architect supports integration with unit testing tools in order to make it easier to develop good
quality software.
Firstly, Enterprise Architect helps you to create test Classes with the JUnit 1405 and NUnit 1407 transformations.
Then you can set up 1512 a test script 1483 against any package and run 1513 it. Finally, all tests results are
automatically recorded 1514 inside Enterprise Architect.

7.7.3.2.1 Set Up Unit Testing

In order to use unit testing in Enterprise Architect, you must first set it up. This happens in two parts.
Firstly the appropriate tests must be defined 1483 . Enterprise Architect is able to help with this. By using the
JUnit 1405 or NUnit 1407 transformations and code generation 1308 you can create test method stubs for all of the
public methods in each of your Classes.
The following is an NUnit example in C# that is followed through the rest of this topic, although it could also be
any other .Net language or Java and JUnit.
[TestFixture]
public class CalculatorTest
{

[Test]
public void testAdd(){
Assert.AreEqual(1+1,2);
}

[Test]
public void testDivide(){
Assert.AreEqual(2/2,1);
}

[Test]
public void testMultiply(){
Assert.AreEqual(1*1,1);
}

[Test]
public void testSubtract(){
Assert.AreEqual(1-1,1);
}
}
This code can be reverse engineered into Enterprise Architect so that Enterprise Architect can record all test
results against this Class.
Once the unit tests are set up, you can then set up the Build and Test scripts to run the tests. These scripts
must be set up against a package.
The sample above can be called by setting up the Package Build Scripts 1444 dialog as follows.

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1513

If Enterprise Architect is to handle unit testing, it is important that you select the Capture Output checkbox
and select the appropriate Output Parser for the testing. Without doing this you won't see the program output
and therefore you cannot open the source at the appropriate location.

7.7.3.2.2 Run Unit Tests

You can run the test script you set up previously, by selecting the Project | Execution Analyzer | Test menu
option.
The following output is generated.

Notice how NUnit reports that four tests have run, including one failure. It also reports what method failed and
the file and line number the failure occurred at. If you double-click on that error, Enterprise Architect opens the
editor to that line of code.

© 1998-2010 Sparx Systems Pty Ltd

 1514 Software Development | Visual Execution Analysis

This enables you to quickly find and fix the error.

Enterprise Architect also records the run status of each test as described in Record Test Results 1514 .

7.7.3.2.3 Record Test Results

Enterprise Architect is able to automatically record all results from tests by a testing script 1512 in Enterprise
Architect. In order to use this feature, you just reverse engineer 1328 the test Class into the package containing
your test script.
Once your model contains your test Class, on the next run of the test script 1513 Enterprise Architect adds test
cases to the Class for each test method found. On this and all subsequent test runs all test cases are updated
with the current run time and if they passed or failed as shown in the following illustration.

The error description for each failed test is added to any existing results for that test case, along with the
current date and time. Over time this provides a log of all test runs where each test case has failed. This can
then be included in generated documentation and could resemble the following.
Failed at 05-Jul-2006 1:02:08 PM
expected: <0>
but was: <1>

Failed at 28-Jun-2006 8:45:36 AM

expected: <0>
but was: <2>

7.7.3.3 Profiling Native Applications

The Visual Execution Profiler enables you to quickly report on:
· The most frequently called functions in a running application
· Tasks in an application that are taking more time than expected
· Which functions are taking the most time in an application.
The Profiler, or sampler, is available in the Enterprise Architect Professional, Corporate, Business and
Software Engineering, System Engineering and Ultimate editions.

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1515

Note:
The Profiler only works with MS Native Windows applications, but can be used under WINE (Linux and Mac)
to debug standard Windows applications deployed in a WINE environment.

The Profiler can generate a report that shows how these functions are called in relation to the application, as
illustrated below:

See Also
· Profiler System Requirements 1516

© 1998-2010 Sparx Systems Pty Ltd

 1516 Software Development | Visual Execution Analysis

· Profiler Operation 1517

7.7.3.3.1 System Requirements

Prerequisites
The Profiler window 1514 becomes available when a model is opened. Options 1516 on the Profiler window
toolbar enable you to attach to an existing process or launch a new application if a Package Script been
specified.

Supported Platforms
Enterprise Architect supports profiling on native Windows applications (C, C++ and Visual Basic) compiled
with the MicrosoftÔ native compiler where an associated PDB file is available. Select Microsoft Native from
the list of debugging platforms in your package script.
The Profiler can sample both Debug and Release configurations of an application, providing the PDB for each
executable exists and is up to date.

7.7.3.3.2 Getting Started

The Profiler window can be accessed by selecting the View | Execution Analyzer | Profiler menu option, or
by selecting it from the Analysis Windows folder on the Debugger window ([Alt]+[8]). The toolbar options are
explained in the table below.
The Profiler operates by taking samples of a process at intervals of up to 250 milliseconds. At these intervals
the Profiler interrupts the process and collects stack information for all threads running at that time. This
information is sent back to Enterprise Architect where it is collected sorted and and stored.
You can Pause and Resume profiling at any time during the session. You can also clear any sample data
collected and begin again.
If you stop the Profiler and the process is still running, you can quickly attach to it again.

Icon Use to

(When an application is configured for the package) 1426 create the Profiler process, which
launches the configured application.

Profile an application that is already running.

When the application is running, pause and resume sample capture. Pausing sampling enables
the Report and Erase buttons.

Stop the Profiler process. If any samples have been collected, the Report button is enabled.

Generate a report 1514 on the current number of samples collected.

Set the interval 1518 , in milliseconds, at which samples are taken of the target process. The range of
possible values is 1 - 250.

Set Profiler options, using a drop-down menu. The options are:

· Load Report from Disk - load and display a previously-generated report from an xml disk file
· Package Build Scripts ([Shift]+[F12]) - display the Build Script 1443 dialog to enable creation or
editing of package scripts and debug configuration
· Start Sampling Immediately - begin sample collection immediately upon either process start
(main thread entry point executed) or attachment of process by Profiler
· Capture Debug output - capture any appropriate debug output and redirect it to the Enterprise
Architect Output window

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1517

Icon Use to

· Stop Process on Exit - select to terminate the target process when the Profiler is stopped.

Erase the collected data.

Display the Help topic for this window.

7.7.3.3.3 Start & Stop the Profiler

For most debugging operations it is necessary to have first configured a Package Script that typically defines
the application to build, test and debug as well as sequence recording options.
It is possible to use the Profiler without doing any of this by using the Attach to Process button.

If the Application to Profile is the one defined in the current Package, use the Launch button.

(When an application is configured for the package) 1426 create the Profiler process, which
launches the configured application.

Profile an application that is already running.

Stop the Profiler process.

7.7.3.3.4 Profiler Operation

Enterprise Architect creates a Profiler process whenever you click on the Launch or Attach to Process
button on the Profiler window toolbar. This process operates by collecting samples from the stacks of every
thread in the target process.

The sampler process exits if you click on the Stop button, if the target application terminates, or if you close
the current model.
You can turn sample collection on and off at any time during a session. When sampling is turned on or
resumed, the Profiler process becomes active and samples are collected from the target. Resuming sampling
collects completely new samples.
The Profiler process idles if sampling is turned off or paused during a session. The Report and Erase buttons
then become enabled.
Click on the Report button to produce a call graph summary similar to that in the Profile Native Applications
1514 topic. This report can be saved to file.

Click on the Erase button to discard any samples currently collected for the target.

© 1998-2010 Sparx Systems Pty Ltd

 1518 Software Development | Visual Execution Analysis

7.7.3.3.5 Setting Options

Interval
Set the interval, in milliseconds, at which samples are taken of the target process. The range of
possible values is 1 - 250.

Set Profiler options, using a drop-down menu. The options are:

· Start Sampling Immediately - begin sample collection immediately upon either process start
(main thread entry point executed) or attachment of process by Profiler
· Capture Debug output - capture any appropriate debug output and redirect it to the Enterprise
Architect Output window
· Stop Process on Exit - select to terminate the target process when the Profiler is stopped.

7.7.3.3.6 Save and Load Reports

The Profiler Reports can be saved in either binary format or xml format. Save the report using the toolbar
above the report (Stack) view.

To load a report use the Profiler Toolbar Options button and select the Load Report From Disk
option.

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1519

7.7.3.3.7 Save Report in Team Review

You can save any current report as a resource for a Category, Topic or Post in the Team Review. The report
can then be shared and reviewed at any time as it is saved with the model.

7.7.3.4 Object Workbench

This section describes the Object Workbench:
· How it works 1520
· Workbench Variables 1521
· Create Workbench Variables 1521

· Invoke Methods. 1522

© 1998-2010 Sparx Systems Pty Ltd

 1520 Software Development | Visual Execution Analysis

7.7.3.4.1 How it Works

The Workbench is a tool in Enterprise Architect Debugging, enabling you to create your own variables 1521 and
invoke methods 1522 on them. Stack trace can be recorded and Sequence diagrams produced from the
invocation of such methods. It provides a quick and simple way to debug your code.

Platforms Supported
The Workbench supports the following workbench platforms:
· Microsoft .NET (version 2.0 or later)
· Java (JDK 1.4 or later)

Note:
The Workbench does not currently support the creation of Class instances written in native C++, C or VB.

Mode
The Workbench operates in two modes:

Idle mode
When the Workbench is in idle mode, instances can be created and viewed and their members inspected.

Active mode
When methods are invoked on an instance, the Workbench enters Active mode, and the variables displayed
change if the debugger encounters any breakpoints. If no breakpoints are set, then the variables do not
change. The Workbench immediately returns to Idle mode.

Logging
The results of creating variables and the results of calls on their methods are displayed in the Debug Output
window.

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1521

7.7.3.4.2 Workbench Variables

You can create (and delete) workbench variables from any Class in your model. When you do so, you are
asked to name the variable. It then displays in the Workbench window. It shows the variable in a hierarchy,
displaying its type and value and those of any members.

Workbench Requirements
· NET framework version 2 is required to workbench any .NET model.
· The package from which the variable is created must have a debugger configured (see the Set Up For
Debugging 1447 topic).

Constraints (.NET)
· Members defined as struct in managed code are not supported.
· Classes defined as internal are not supported.

Delete Workbench Variables

You can delete variables using the Delete shortcut menu on any instance on the Workbench. If all instances
are deleted the debugger is shut down, and the Workbench window is closed.

7.7.3.4.3 Create Workbench Variables

Right-click on the required Class node in the Project Browser and select the Create Workbench Instance
context menu option, or press [Ctrl]+[Shift]+[J]. The menu option is also available from within a Class
diagram.

Naming the Workbench

When you elect to create an instance of a type Enterprise Architect prompts you with the Workbench dialog to
name the variable. Each instance name must be unique for the workbench.

© 1998-2010 Sparx Systems Pty Ltd

 1522 Software Development | Visual Execution Analysis

Choosing a Constructor
Having given the variable a name, you must now choose which constructor to use.
If you do not define a constructor, or define a single constructor taking no arguments, the default constructor
or the defined constructor is automatically invoked.
Otherwise the following dialog displays. Select the constructor from the drop-down list and fill in any
parameters required.

7.7.3.4.4 Invoke Methods

On the Workbench window, right-click on the instance on which to execute a method, and select the Invoke
context menu option.

Choose Method
A list of methods for the type are presented in a dialog. Select a method from the list and click on the Invoke

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1523

button. Note that all methods listed are public; private methods are not available.

Supply Arguments
In this example, you have created an instance or variable named Rob of type MyClassLibrary.CRobert, and
have invoked a method named AddFriends that takes an array of CPerson objects as its only argument. What
you now supply to it are the three other Workbench instances Fred, John and William.

© 1998-2010 Sparx Systems Pty Ltd

 1524 Software Development | Visual Execution Analysis

Arguments
In the dialog above, type any parameters required by the constructor.
· Literals as arguments
· Text: abc or "abc" or "a b c"
· Numbers: 1 or 1.5
· Objects as arguments
If an argument is not a literal then you can supply it in the list only if you have already created an
instance of that type in the workbench. You do this by typing the name of the instance as the
argument. The debugger checks any name entered in an argument against its list of workbench
instances, and substitutes that instance in the actual call to the method.
· Strings as arguments
Surrounding strings with quotes is unnecessary as anything you type for a string argument becomes
the value of the string; for example, the only time you should surround strings with quotes is in
supplying elements of a string array, or where the string is equal to the name of an existing
workbench instance.
"A b c"
"a b $ % 6 4"
Abcd
As 5 7 ) 2 === 4
· Arrays as arguments
Enter the elements that compose the array, separated by commas.
Type Arguments
String[] one,two,three,"a book","a bigger book"
CPerson[] Tom,Dick,Harry

Enterprise Architect User Guide

 Software Development | Visual Execution Analysis 1525

Note:
If you enter text that matches the name of an existing instance, surround it in quotes to avoid the debugger
passing the instance rather than a string.

Invoke
Having chosen the constructor and supplied any arguments, click on the Invoke button to create the variable.
Output confirming this action is displayed in the Output tab 1478 .

© 1998-2010 Sparx Systems Pty Ltd

Part

VIII
 Test and Quality Control | 1527

8 Test and Quality Control

This section discusses quality control in your project with Enterprise Architect, describing:
· Model Validation 1528 checks
· Testing 1536
· Spell Checking 1552 .

© 1998-2010 Sparx Systems Pty Ltd

 1528 Test and Quality Control | Model Validation

8.1 Model Validation

You use Model Validation to check UML models against known UML rules 1530 (which you identify in
configuring validation 1530 ) as well as any constraints defined within the model, using the Object Constraint
Language (OCL).
You can run Model Validation against a single UML element, a diagram or an entire package. Validating a
UML:
· Element validates the element and its children, features (attributes and operations) and relationships
(connectors)
· Diagram validates the diagram itself (for correctness) as well as any elements and connectors within the
diagram
· Package validates the package and all subpackages, elements, connectors and diagrams within it.
To use Model Validation, follow the steps below:
1. Select the package, diagram or element either from the Project Browser or within an open diagram.
2. Select the Project | Model Validation | Validate Selected menu option, or press [Ctrl]+[Alt]+[V].
Enterprise Architect performs the validation, and displays the results in the Output 102 window (if the Output
window does not automatically display, select the View | System Output menu option).

While performing the validation, Enterprise Architect also displays a progress window containing the Cancel
Validation button, which enables you to cancel the validation process at any time.

Alternatively, select the Project | Model Validation | Cancel Validation menu option.

Example Model Violations

The following UML diagram contains several basic violations.

Enterprise Architect User Guide

 Test and Quality Control | Model Validation 1529

If you run Model Validation on this diagram, Enterprise Architect lists the following violations in the Output
window:

The validation results show that the diagram:

· Contains a UML ExpansionRegion (ExpansionRegion1) that is missing its child input ExpansionNode
· Contains an invalid self-generalization on Class2 (UML elements cannot be self-generalized)
· Contains an OCL violation for the anonymous Association (between Class2 and Object1)
· Contains a UML ExceptionHandler (ExceptionHandler1) that is missing its child input ObjectNode.

Note:
If you double-click on an error in the Output window, you select the diagram element that the error message
refers to.

© 1998-2010 Sparx Systems Pty Ltd

 1530 Test and Quality Control | Model Validation

8.1.1 Configure Model Validation

Use the Model Validation Configuration dialog to enable and disable the rules 1530 that are run with the model
validator. You can define additional rules in this dialog from any additional Add-Ins that might be installed
besides Enterprise Architect.
To display the Model Validation Configuration dialog, select the Project | Model Validation | Configure menu
option.

Click on the checkbox against each Validation Rule to apply in performing a model validation 1528 .

Tip:
To disable UML syntax ("The requested connection is not UML compliant"), select the Tools | Options menu
option, click on Diagram in the hierarchy, and in the General panel deselect the Strict UML Syntax
checkbox.

When you perform a validation, each violation listed on the Output 1529 window has a violation ID of the format
MVRxxnnnn, where:
· MVR stands for Model Validation Rule
· xx is a hexadecimal number corresponding to the position of the validation rule in the Model Validation
Configuration dialog, thus indicating which rule is applied and violated
· nnnn is the number of the violation message.
Therefore, messages with the ID MVR01nnnn indicate that the Element: Well-Formedness checkbox is
selected and a violation of that rule has been detected. Messages with the ID MVR0Annnn indicate that the
Feature: OCL Conformance checkbox (10th in order on the dialog, or Ath in hexadecimal) is selected and a
violation of that rule has been detected.

8.1.2 Rules Reference

Model Validation works against a set of validation rules, arranged in the following groups:
· (Element, Relationship, Feature, Diagram): Well-Formedness 1531
Checks whether or not an element, relationship, feature or diagram is well-formed. This group of rules
includes checks such as whether the item is a valid UML item and whether a diagram contains valid
elements within it
· Element: Composition 1531
Checks whether or not a UML element contains valid children, whether it contains the right number of valid
children, and whether or not the element is missing any required children
· (Element, Relationship, Feature): Property Validity 1532

Enterprise Architect User Guide

 Test and Quality Control | Model Validation 1531

Checks whether or not the item has the correct UML properties defined, and whether the properties contain
incorrect or conflicting values; for more information on these properties see the Custom Properties 550 topic
· (Element, Relationship, Feature): OCL Conformance 1532
Validates an item against any defined constraints in OCL.

8.1.2.1 Well-Formedness
The well-formedness group of rules checks whether or not an element, relationship, feature or diagram is well
formed.
The rules includes checks such as whether the item is a valid UML item and whether a diagram contains valid
elements within it. Reported violations include:

Violation ID Description Information

MVR010001 «Element» is not a valid UML The element is not a recognized UML 2.3 element.
Element

MVR050001 «Relationship» is not a valid UML The relationship is not a recognized UML 2.3
Relationship relationship.

MVR050002 «Relationship» is not legal for The relationship between the given start and end
«Start Element» --> «End elements is not valid for those elements.
Element»

MVR050003 «Parent Element»:isLeaf=true and The Generalization relationship cannot exist between
cannot be generalized by «Child parent and child elements because the parent element
Element» is defined as a leaf element.

MVR050004 «Child Element»:isRoot=true and The Generalization relationship cannot exist between
cannot generalize «Parent parent and child elements because the child element
Element» is defined as a root element.

MVR050005 «Element» cannot generalize self The element cannot be self-generalized.

MVR0B0001 Statechart violation: «extended The State diagram contains a UML violation; see the
information» extended information for more information about the
detected violation.

8.1.2.2 Element Composition

The element composition group of rules checks whether or not a UML element contains valid children,
whether it contains the right number of valid children, and whether or not the element is missing any required
children.

Error ID Description Information

MVR020001 «Element» is missing required The element is missing a child element of type Child
child element «Child Element». Element.

MVR020002 Invalid UML package child. The element cannot be a direct package child and must
be a child of another element (for example: Ports must
be children of other elements, and not direct UML
package members).

MVR020003 Invalid child «Child Element The child element is invalid on the tested parent
name» («Child Element Type»). element.

© 1998-2010 Sparx Systems Pty Ltd

 1532 Test and Quality Control | Model Validation

8.1.2.3 Property Validity

The property validity group checks whether or not an element, relationship or feature has the correct UML
properties defined for it and whether they contain incorrect or conflicting values.
For more information about these properties see the Custom Properties 1730 topic.

Error ID Description Information

MVR030001 «Element»:«Property» property The element property contains no value.

is undefined

MVR030002 «Element»:«Property» property The element property contains an invalid value.

has invalid value: "«Value»"

MVR030003 «Element»:isLeaf=true and The element's isLeaf and isAbstract properties are
cannot be abstract both set to true, which is invalid.

MVR060001 «Relationship»:«Property» The relationship property contains no value.

property is undefined

«Relationship»:«Property»
MVR060002 property has invalid value: " The relationship property contains an invalid value.
«Value»"

MVR090001 Attribute/AssociationEnd The given attribute has an associationEnd of the same

mismatch, «Attribute»: name but they differ in the listed details.
«Mismatch description»,...

8.1.2.4 OCL Conformance

The OCL conformance group validates an element, relationship or attribute against any defined constraints in
the Object Constraint Language (OCL).
OCL is used to describe expressions on UML models, and to express side-effect free constraints. You can add
OCL constraints to any element, relationship or attribute in Enterprise Architect.

Error ID Description Information

MVR040001 OCL violation: «violated OCL» The element violates the OCL constraint specified.

MVR070001 OCL violation: «violated OCL» The relationship violates the OCL constraint
specified.

MVR0A0001 OCL violation: «violated OCL» The attribute violates the OCL constraint specified.

Important:
To have a valid OCL constraint, the syntax must be correctly formed. If the expression is not correct,
Enterprise Architect displays a message stating that the OCL constraint is not valid.

Define OCL Constraints for an Element

You can add OCL constraints to an element using the Properties dialog (Element | Properties). Select the
Constraints tab, click on the Type drop-down arrow and select OCL.

Enterprise Architect User Guide

 Test and Quality Control | Model Validation 1533

To perform an OCL Validation, display the Model Validation Configuration 1530 dialog and select the Element:
(OCL) Conformance checkbox. Any OCL violations are recorded in the Model Validation tab of the Output 1529
window.

Define OCL Constraints for a Relationship

You can add OCL constraints to a relationship using the Properties dialog (right-click and select the <type>
Properties context menu option). Select the Constraints tab, click on the Type drop-down arrow and select
OCL.

© 1998-2010 Sparx Systems Pty Ltd

 1534 Test and Quality Control | Model Validation

To perform an OCL Validation, display the Model Validation Configuration dialog and select the Relationship:
(OCL) Conformance checkbox. Any OCL violations are recorded in the Model Validation tab of the Output
window.

Define OCL Constraints for an Attribute

You can add OCL constraints to a feature using the Properties dialog (Element | Attributes). Select the
Constraints tab, click on the Type drop-down arrow and select OCL.

Enterprise Architect User Guide

 Test and Quality Control | Model Validation 1535

To perform an OCL Validation, display the Model Validation Configuration dialog and select the Feature:
(OCL) Conformance checkbox. Any OCL violations are recorded in the Model Validation tab of the Output
window.

© 1998-2010 Sparx Systems Pty Ltd

 1536 Test and Quality Control | Testing

8.2 Testing

Introduction to Testing
In addition to the integrated JUnit and NUnit testing 1512 capabilities, Enterprise Architect enables you to create
and manage test scripts for model elements, covering unit, integration, scenario, system and acceptance
tests.
You can import tests from other elements, generate them from scenarios, and generate test documentation
and reports. You can also indicate the presence of tests on an element by displaying test information on the
element in a diagram.
Enterprise Architect enables you to attach arbitrarily complex tests to any model element. Keeping the model
elements and the testing documentation in one integrated model significantly improves the communication
between the test-team and the software developers and architects. The detailed search facilities make it easy
to find failing test cases, test cases not run and tests cases that have been passed. Using the testing and
search capabilities, it is easy to navigate through the model and quickly locate problem spots, design flaws
and other critical issues. Enterprise Architect is not only a UML Modeling environment, it is also a complete
Test Management environment.

Basic Tasks
Simple tasks that you might perform include:
· Open the Testing Workspace 1537
· Use the Test Details Dialog 1538 .

Categories
Typically you create:
· Unit tests 1539 for things that are being built, such as Classes and components
· Integration tests 1540 to test how components work together
· System tests 1541 to ensure the system meets business requirements
· Acceptance tests 1542 to test user satisfaction, and
· Scenario tests 1543 to test the end-to-end suitability and functionality of the application.

Using Tests
Other tasks that you might perform when working with tests include:
· Import a Scenario as a Test 1544
· Move or Copy Tests Between Test Types 1544
· Import a Test from Other Elements 1546
· Import a Responsibility or Constraint as a Test 1547

· Create a Maintenance Item from a Test 1548

· Generate Test Details Report 1549
· Show Test Script Compartments 1549
· Create Test Documentation 1550 .

Note:
Most of the tasks identified above relate to a tests for a single element. You can make a set of tests available
to a number of elements by performing the above tasks on a Test Case 848 element and then associating that
Test Case with each of the other elements. The Test Case element also helps to make tests more visible in
diagrams, the Project Browser, windows and searches.

Enterprise Architect User Guide

 Test and Quality Control | Testing 1537

8.2.1 The Testing Workspace

The Testing window, or Workspace, provides a quick and convenient method of working with element tests.
When you select an element in a diagram or in the Project Browser, if the Testing window is visible the lists of
tests for that element are loaded ready for modification or addition.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Manage Tests 198 permission to update and delete
test records.

To open the Testing window, select the View | Testing menu option. Alternatively, press [Alt]+[3]. The
window can be docked to the application workspace.
The window has two formats, as illustrated below - Item mode and List mode respectively.

To toggle between the modes, click on the Show/Hide Properties button in the window toolbar.

Click on the New icon in the window toolbar to add new items. In Item mode, this clears the fields for new
data. In List mode, this displays the Test details 1538 dialog. By clicking on the Auto button in Item mode or on
the Test details dialog, you can apply an automatic naming/numbering nomenclature that you have previously
defined 525 .
There are five tabs along the base of the window; one for each of the following types of testing:
· Unit testing 1539
· Integration testing 1540

© 1998-2010 Sparx Systems Pty Ltd

 1538 Test and Quality Control | Testing

· System testing 1541

· Acceptance testing 1542
· Scenario testing 1543
The asterisk on a tab indicates that the tab contains saved information. If there is no information for a type of
test, or the information has not yet been saved, its tab has no asterisk.
The tabs toggle between Item mode and List mode independently.

8.2.2 The Test Details Dialog

The Test details dialog opens from the Testing window in List mode. (The Testing window displays as shown
below in List mode. If it does not display like this, click on the Show/Hide Properties icon in the window
toolbar.)

Double-click on an existing test case or click on the New icon in the window toolbar. The Test Details dialog
displays.

Notes:
· Add multiple test cases in one batch by using the New and Apply buttons.
· You can format the text in the Description, Input, Acceptance Criteria and Results tabs using the Notes 642
toolbar at the top of the field. This text is also reflected in the Notes window, but cannot be edited there.

Enterprise Architect User Guide

 Test and Quality Control | Testing 1539

8.2.3 Unit Testing

Use Unit Testing to test Classes, Components and other elements as programmers build them.
The Unit testing tab displays in the Testing window by default. To open the Testing window, select the View |
Testing menu option. Open a diagram or the Project Browser and select the required element.
If any Unit tests exist, the first Test item for the element is shown in the Testing window in Item mode, and all
items are listed either in the panel to the left of the window, or in the window in List mode.

Option Use to

Test Specify the name of the test.

Status Click on the drop-down arrow and select the current status of the test.

Type Click on the drop-down arrow and select the type of test.

Run By Click on the drop-down arrow and select the name of the person who ran the test.

Checked By Click on the drop-down arrow and select the name of the person who checked the test
run.

Last Run Click on the drop-down arrow and select the date on which the test was last run.

Description Type a description of the test. You can format the text using the Notes 642 toolbar at
the top of the field. This text is also reflected in the Notes window, but cannot be
edited there.

Input Type in the input data.

Acceptance Criteria Type the acceptance or test success conditions.

Results Type the results of the last test.

To edit existing Unit Test items for this element:

· Click on the item in the left-hand panel in Item mode
· Double-click on the item in List mode to display the Test Details 1538 dialog, or
· Click on the required item in the Testing folder in the Element Browser 510 window; if this window is not

displayed, click on the icon in the Testing window toolbar. Unit Test item icons have a U in the bottom
right corner.
To change the element for which to create test items, click on the required element in the Project Browser.

© 1998-2010 Sparx Systems Pty Ltd

 1540 Test and Quality Control | Testing

8.2.4 Integration Testing

Use Integration Testing to test how the constructed components work together.
To display Integration Testing details select the View | Testing menu option to display the Testing window.
Open a diagram or the Project Browser and select the required element. Click on the Integration tab.
If any Integration tests exist, the first Test item for the element is shown in the Testing window in Item mode,
and all items are listed either in the panel to the left of the window, or in the window in List mode.

Option Use to

Test Specify the name of the test.

Status Click on the drop-down arrow and select the current status of the test.

Type Click on the drop-down arrow and select the type of test.

Run By Click on the drop-down arrow and select the name of the person who ran the test.

Checked By Click on the drop-down arrow and select the name of the person who checked the test
run.

Last Run Click on the drop-down arrow and select the date on which the test was last run.

Description Type a description of the test. You can format the text using the Notes 642 toolbar at
the top of the field. This text is also reflected in the Notes window, but cannot be edited
there.

Input Type in the input data.

Acceptance Type the acceptance or test success conditions.

Criteria

Results Type the results of the last test.

To edit existing Integration Test items for this element:

· Click on the item in the left-hand panel in Item mode
· Double-click on the item in List mode to display the Test Details 1538 dialog, or
· Click on the required item in the Testing folder in the Element Browser 510 window; if this window is not

displayed, click on the icon in the Testing window toolbar. Integration Test item icons have an I in the
bottom right corner.
To change the element for which to create test items, click on the required element in the Project Browser.

Enterprise Architect User Guide

 Test and Quality Control | Testing 1541

8.2.5 System Testing

Use System Testing to test that the system performs the right business functions correctly.
To display System Testing details select the View | Testing menu option to display the Testing window. Open
a diagram or the Project Browser and select the required element. Click on the System tab.
If any System Tests exist, the first Test item for the element is shown in the Testing window in Item mode, and
all items are listed either in the panel to the left of the window, or in the window in List mode.

Option Use to

Test Specify the name of the test.

Status Click on the drop-down arrow and select the current status of the test.

Type Click on the drop-down arrow and select the type of test.

Run By Click on the drop-down arrow and select the name of the person who ran the test.

Checked By Click on the drop-down arrow and select the name of the person who checked the test
run.

Last Run Click on the drop-down arrow and select the date on which the test was last run.

Description Type a description of the test. You can format the text using the Notes 642 toolbar at
the top of the field. This text is also reflected in the Notes window, but cannot be
edited there.

Input Type in the input data.

Acceptance Criteria Type the acceptance or test success conditions.

Results Type the results of the last test.

To edit existing System Test items for this element:

· Click on the item in the left-hand panel in Item mode
· Double-click on the item in List mode to display the Test Details 1538 dialog, or
· Click on the required item in the Testing folder in the Element Browser 510 window; if this window is not

displayed, click on the icon in the Testing window toolbar. System Test item icons have an Sy in the
bottom right corner.
To change the element for which to create test items, click on the required element in the Project Browser.

© 1998-2010 Sparx Systems Pty Ltd

 1542 Test and Quality Control | Testing

8.2.6 Acceptance Testing

Use Acceptance Testing to ensure that users are satisfied with the system.
To display Acceptance Testing details select the View | Testing menu option to display the Testing window.
Open a diagram or the Project Browser and select the required element. Click on the Acceptance tab.
If any Acceptance Tests exist, the first Test item for the element is shown in the Testing window in Item mode,
and all items are listed either in the panel to the left of the window, or in the window in List mode.

Option Use to

Test Specify the name of the test.

Status Click on the drop-down arrow and select the current status of the test.

Type Click on the drop-down arrow and select the type of test.

Run By Click on the drop-down arrow and select the name of the person who ran the test.

Checked By Click on the drop-down arrow and select the name of the person who checked the test
run.

Last Run Click on the drop-down arrow and select the date on which the test was last run.

Description Type a description of the test. You can format the text using the Notes 642 toolbar at
the top of the field. This text is also reflected in the Notes window, but cannot be edited
there.

Input Type in the input data.

Acceptance Criteria Type the acceptance or test success conditions.

Results Type the results of the last test.

To edit existing Acceptance Test items for this element:

· Click on the item in the left-hand panel in Item mode
· Double-click on the item in List mode to display the Test Details 1538 dialog, or
· Click on the required item in the Testing folder in the Element Browser 510 window; if this window is not

displayed, click on the icon in the Testing window toolbar. Acceptance Test item icons have an A in
the bottom right corner.
To change the element for which to create test items, click on the required element in the Project Browser.

Enterprise Architect User Guide

 Test and Quality Control | Testing 1543

8.2.7 Scenario Testing

Use Scenario Testing to test the application with real-world situations and scenarios. An end-to-end test of all
functions.
To display Scenario Testing details select the View | Testing menu option to display the Testing window.
Open a diagram or the Project Browser and select the required element. Click on the Scenario tab.
If any Scenario Tests exist, the first Test item for the element is shown in the Testing window in Item mode,
and all items are listed either in the panel to the left of the window, or in the window in List mode.

Option Use to

Test Specify the name of the test.

Status Click on the drop-down arrow and select the current status of the test.

Type Click on the drop-down arrow and select the type of test.

Run By Click on the drop-down arrow and select the name of the person who ran the test.

Checked By Click on the drop-down arrow and select the name of the person who checked the test
run.

Last Run Click on the drop-down arrow and select the date on which the test was last run.

Description Type a description of the test. You can format the text using the Notes 642 toolbar at
the top of the field. This text is also reflected in the Notes window, but cannot be edited
there.

Input Type in the input data.

Acceptance Type the acceptance or test success conditions.

Criteria

Results Type the results of the last test.

To edit existing Scenario Test items for this element:

· Click on the item in the left-hand panel in Item mode
· Double-click on the item in List mode to display the Test Details 1538 dialog, or
· Click on the required item in the Testing folder in the Element Browser 510 window; if this window is not

displayed, click on the icon in the Testing window toolbar. Scenario Test item icons have an Sc in the
bottom right corner.
To change the element for which to create test items, click on the required element in the Project Browser.

© 1998-2010 Sparx Systems Pty Ltd

 1544 Test and Quality Control | Testing

8.2.8 Move or Copy Tests Between Categories

When you define a test on the Unit, Integration, System, Acceptance or Scenario tab of the Testing window,
you might decide that the test either is better suited to another category of tests, or forms a good template for
tests in other categories. Enterprise Architect enables you to move or copy tests between categories.
To move or copy a test, follow the steps below:
1. Open either:
· The Testing window, and the tab that contains the test you want to move or copy, or
· The Testing folder of the Element Browser 510 window.
2. Right-click on the required test item in the list. The item context menu displays.
3. Click on the appropriate option - Move to or Copy to. A list of test categories displays.
4. Click on the test category to which to move or copy the test. A confirmatory prompt displays.

Note:
If you move or copy a test into the Scenario category, some unassociated data could be lost.

5. Click on the Yes button to confirm the move or copy.

6. Click on the target tab of the Testing window to ensure that the test has been added, and make any
required changes.

8.2.9 Import Scenario as Test

You can import a scenario from a Use Case or other element, or from all elements in a package, into the
Testing window Scenario tab. This avoids having to duplicate the scenario information manually.
The scenario description is copied to the Scenario Test Description tab in the Testing window. If a scenario
contains a Structured Specification, its Action steps are also copied to the Description tab under the heading
Structured Specification.

Import Element Scenarios

To import one or more scenarios from a specific element, follow the steps below:
1. Open a diagram or the Project Browser and select the element into which to import the scenario.
2. Open either:
· The Testing window and the Scenario tab, or
· The Testing folder of the Element Browser 510 window.
3. Right-click on the list of tests to display the context menu, and select the Import element scenario(s)
menu option. The Import Scenario dialog displays.

Enterprise Architect User Guide

 Test and Quality Control | Testing 1545

4. You can import scenarios from any element in the model by clicking on the Select element drop-down
arrow and selecting the required element. Select the scenarios to import from the Select items to
import list.
5. Click on the OK button to import the selected scenario(s).
The Import Scenario dialog has the following additional options:

Option Use to

Show related elements only Filter selection to apply only to related elements.

Limit selection to these Object Types Type in specific element types, separated by commas, to filter
only for only those element types.

Refresh Refresh the list of available scenarios.

Import Package Scenarios

To import scenarios from all elements in a package, follow the steps below:
1. Open a diagram or the Project Browser and select the parent package element or an element within the
package.
2. Open either:
· The Testing window and the Scenario tab, or
· The Testing folder of the Element Browser 510 window.
3. Right-click on the list of tests to display the context menu, and select the Import Package Scenario(s)
menu option. The Import Scenario dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1546 Test and Quality Control | Testing

This version of the Import Scenario dialog lists all scenarios against all elements in the package. It does
not enable you to select a specific element, but does enable you to filter the list of scenarios to those
from specific types of element.
4. In the Limit selection to these Object Types only field, type a comma-separated list of the object
types for which to show scenarios. Click on the Refresh button.
5. Click on the OK button to import the scenarios from each element as test scenarios for that element.

8.2.10 Import Test From Other Elements

You can import any test from a Use Case or other element into the Testing window. This avoids having to
duplicate the test information manually.

Import a Test
To import a test, follow the steps below:
1. Open a diagram or the Project Browser and select the element into which to import the tests.
2. Open either:
· The Testing window, or
· The Testing folder of the Element Browser 510 window.
3. Right-click on the list of tests to display the context menu, and select the Import Tests from Other
Element menu option. The Import Element Tests dialog displays.

Enterprise Architect User Guide

 Test and Quality Control | Testing 1547

4. You can import tests from any element in the model by clicking on the Select element drop-down arrow
and selecting the required element. Select the test to import from the Select items to import list.
5. Click on the OK button to import the selected test(s).
The Import Element Tests dialog has the following additional options:

Option Use to

Show related elements only Filter selection to apply only to related elements.

Limit Selection to these Object Types only Type in specific element types, separated by commas, to
filter for only those element types.

Refresh Refresh available options.

8.2.11 Import Responsibility or Constraint as Test

In the same way as you can import a scenario from an element as a test, you can also import an internal
requirement (responsibility) or internal constraint as a test.
To import a requirement or constraint as a test, follow the steps below:
1. Open a diagram or the Project Browser and select the element into which to import the responsibility or
constraint.
2. Open either:
· The Testing window and the tab into which to import the test, or
· The Testing folder of the Element Browser 510 window.
3. Right-click on the list of tests to display the context menu (if in the Element Browser, click on a test of
the appropriate type).
4. Click on the appropriate option, either:
· Import element constraint(s) or
· Import element requirement(s).
The Import Constraint or Import Requirements dialog displays (the two dialogs are identical):

© 1998-2010 Sparx Systems Pty Ltd

 1548 Test and Quality Control | Testing

The dialog lists all of the internal requirements or constraints in the selected element.
5. Select one or more of the items to import as tests, and click on the OK button. Each item is added to
the list of tests in the Testing window, as a standard, 'Not Run' test.
6. Edit the items to complete their definition as tests.

8.2.12 Create Maintenance Item From Test

If an element fails a test, one likely consequence is that a Defect (Issue) item has to be raised in model
maintenance to correct the problem. You can generate this Defect item directly from the test that failed.
To create a Maintenance item from a test, follow the steps below.
1. In the Testing window, or the Testing folder of the Element Browser window, right-click on the test item
from which to generate the Maintenance item.
2. On the context menu, select the Create a Maintenance Defect from this test menu option. The
following message box displays.

3. Click on the OK button to clear the message.

4. Open the Maintenance window and select the Defects tab. Notice that the window displays a defect
item having the same name as the test, and the test Description, Input, Acceptance Criteria and Results
texts are displayed in the defect Description tab.
5. Update the defect item as required 1559

Note:
You can create Maintenance Defect items from several Test items at once. Press and hold [Shift] as you
select the Test items, and then right-click and proceed as above. Each selected Test item then generates a
Defect item.

Enterprise Architect User Guide

 Test and Quality Control | Testing 1549

8.2.13 Testing Details Report

You can view the Testing Details dialog for a package, which enables you to run filtered reports on all
elements in the package hierarchy under your selection. You can also print the report details.
To access the Testing Details dialog, right-click on a package in the Project Browser to display the context
menu, and select the Documentation | Testing Details menu option.

The Testing Details dialog includes the following options:

Options Use to

Run By Select a name to filter for tests run by that person. Click on the x button to
clear the field.

Checked By Select a name to filter for tests checked by that person. Click on the x
button to clear the field.

Test Type Select the radio button for the required test type.

Status Select the radio button for the required status.

Locate Object (After clicking on an element in the Test Details list) locate the element in
the Project Browser.

Refresh Re-run the report query.

Print Print a summary of the test results.

8.2.14 Show Test Script Compartments

Any element that is capable of displaying a compartment can be used to show test scripts in a diagram. To
make use of the feature the element must have an attached test. To use this feature follow the steps below:
1. Open a diagram containing the element with the attached test items.
2. Double-click on the diagram background to display the Diagram Properties dialog. Click on the
Elements tab.

© 1998-2010 Sparx Systems Pty Ltd

 1550 Test and Quality Control | Testing

3. In the Show Compartments panel, select the Testing checkbox.

4. Click on the OK button to save the setting.
The tests now appear as an item in the test scripts compartment of the diagram element.

8.2.15 Test Documentation

Enterprise Architect enables you to output the test scripts and results you have entered against elements in
the model, in Rich Text format. For more information on entering test scripts and details see the previous
sections of the Testing 1536 topic.
To create the documentation, right-click on a package in the Project Browser and select the Documentation |
Testing Report context menu option. The Generate Test Documentation dialog displays.

Enterprise Architect User Guide

 Test and Quality Control | Testing 1551

Note:
You can also access the Generate Test Documentation dialog by selecting the Project | Documentation |
Testing Report menu option.

The Generate Test Documentation dialog enables you to set up your report. You can configure which tests to
include or exclude in the report, whether to include child packages and what file to output to.

© 1998-2010 Sparx Systems Pty Ltd

 1552 Test and Quality Control | Spell Checking

8.3 Spell Checking

Enterprise Architect provides a powerful spell checking facility. This operates at the project level and enables
you to quickly spell check an entire project.
The spell checker can be set to run automatically, so that it highlights possible errors in text as it is created or
pasted in. To turn automatic spell checking on and off, select the Tools | Options menu option, click on the
Objects option in the page hierarchy, and then deselect or select the Disable spelling checkbox.

See Also
· Using the Spell Checker 1552
· Correcting Words 1553
· Select a Different Language 1554

8.3.1 Using the Spell Checker

Enterprise Architect has an inbuilt spell checker.

Notes:
· Enterprise Architect currently supports checking an entire model, and spell checking by single package. A
future release will support more detailed spell checking at the element and diagram level.
· In the Corporate, Business and Software Engineering, Systems Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Spell Check 198 permission to spell check a
package and set the spell check language.

To perform a spell check, follow the steps below:

1. Select the Tools | Spell Check Project or Tools | Spell Check Current Package menu option,
depending on which level of spell check you require. The Spell Check dialog displays.

Enterprise Architect User Guide

 Test and Quality Control | Spell Checking 1553

Note:
The Spell Check Project menu option enables you to check spelling for the entire project, whereas
the Spell Check Current Package option only checks the package currently open, and does not
enable you to select the options shown above.

2. Select the checkbox against each of the items to spell check within your model.
3. Click on the Start button to begin the spell check.
4. As the spell check proceeds, the text being checked displays in the text panel at the bottom of the
screen. If an error is detected, the Check Spelling dialog displays, offering several options 1553 to correct
the error.

8.3.2 Correcting Words

As the spell check progresses, Enterprise Architect highlights any errors or unknown words in the Check
Spelling dialog. This enables you to correct the spelling of a word, ignore the error, add the word to the User
Dictionary, suggest alternatives or otherwise assist in the spelling correction process.
The inbuilt spell check stores user-defined words in the User Dictionary (userdict.tlx) stored in the Enterprise

© 1998-2010 Sparx Systems Pty Ltd

 1554 Test and Quality Control | Spell Checking

Architect installation directory. During the spell check process, if you add a word, it is written into this file for
later reference.

To correct the current word you can:

· Modify the spelling by hand and click on the Change or Change All button to change the word to that
spelling
· Click on a suggested alternative and click on the Change or Change All button to change the word to that
spelling
· Click on the Ignore or Ignore All button to exclude the word from the spell check
· Click on the Add button to add the word to the user dictionary
· Click on the Suggest button to list alternative spellings or words
· Click on the Cancel button to abort the spell check entirely.

8.3.3 Select a Different Language

Enterprise Architect is supplied with two dictionaries, for US English and British English. Additional dictionaries
are available as a set, for download from the registered area of the Sparx Systems website. Once you have
downloaded and installed the language pack of dictionaries, you can select another language in which to
perform the spell check.
To download the additional language dictionary pack:
1. Access this registered user page on the Sparx Systems web site.
2. At the end of the page, download the (EADict.zip) file from the Enterprise Architect Dictionary section.
3. Unzip the file into the Enterprise Architect install directory (C:\Program Files\Sparx Systems\EA).
This makes the non-English spelling dictionaries available to the Enterprise Architect spell checker.

To select another language for the spell checker in Enterprise Architect, follow the steps below:
1. Select the Tools | Spelling Language menu option. The Spell Check Language dialog displays.

Enterprise Architect User Guide

 Test and Quality Control | Spell Checking 1555

2. Click on the radio button for the required language dictionary to use.
3. Click on the OK button. The selected language remains the current language until changed.

© 1998-2010 Sparx Systems Pty Ltd

Part

IX
 Maintenance and Bug Tracking | 1557

9 Maintenance and Bug Tracking

This section discusses the Enterprise Architect facilities for:

· Creating and monitoring maintenance 1558 items on project elements
· Creating and monitoring change and issue 1563 items on the project.

© 1998-2010 Sparx Systems Pty Ltd

 1558 Maintenance and Bug Tracking | Maintenance

9.1 Maintenance

Maintenance Items
Maintenance items are defects, changes, issues and tasks. They all apply to individual model elements and
can be used to record and capture problems, changes, issues and tasks as they arise, and document the
solution and associated details. They are defined as follows:
· A defect can be considered as a failure to meet a requirement for the current model element
· A change can be considered as a change in requirement for the current model element
· An issue records a risk factor that might affect the project being recorded for the current model element
· A task is a means of recording work in progress and work outstanding for the current model element.
Note that each of these maintenance items applies at the model element level. For changes, defects and
issues that apply to the whole system, see the Changes and Defects 1563 topic; for tasks that apply to the
whole system, see the Project Tasks 329 topic.
The following topics explain how to create and edit Maintenance items:
· The Maintenance Workspace 1558 - describes the Maintenance window
· Maintenance Item Properties 1559 - describes how to complete the Maintenance window tabs for the various
maintenance items
· Move or Copy Maintenance Items 1561 - describes how to move items between maintenance categories or
generate items from an item in a different category
· Create Elements From Maintenance Items 1561 - describes how to generate elements from maintenance
items
· Show Maintenance Script in Diagram 1561 - describes how to display maintenance items in elements on
diagrams
· Insert Maintenance Feature 594 - describes how to add a maintenance item directly to an element via in-
place editing.

9.1.1 The Maintenance Workspace

Enterprise Architect makes it easy to record and capture problems and issues as they arise, and document
the solution and associated details. The Maintenance window provides a quick method of viewing and
modifying the changes, issues defects and 'to do' items 1558 associated with a particular model element. You
can include the maintenance items in the main RTF documentation and HTML produced by Enterprise
Architect. The RTF Setup dialog has checkboxes to show or hide element maintenance items.
You access the Maintenance window by selecting the View | Other Element Tools | Maintenance menu
option, or by pressing [Alt]+[4]. Click on the required tab - Defects, Changes, Issues or Tasks - and select
model elements in diagrams or in the Project Browser to see the associated maintenance items.
You can also use the Element Browser 510 window to select and display specific items on the Maintenance

window. Click on the icon in the Maintenance window toolbar to display the Element Browser, open the
Maintenance folder and select the required item. In the folder, the 'page' icon contains a C for Change items,
D for Defect items, T for Task items, or I for Issue items.
The window has two formats, as illustrated below - Item mode and List mode respectively.

Enterprise Architect User Guide

 Maintenance and Bug Tracking | Maintenance 1559

To toggle between the modes, click on the Show/Hide Properties button in the window toolbar. Item mode
displays a single item with others of the same type listed in the left-hand panel. You can also either switch to
List mode or select another item from the Element Browser window. List mode displays all items of one type in
the selected element; it does not, however, display as much detail on an item as Item mode does.
Using the toolbar, you can add or delete 1559 items and show or hide the Properties window to enable you to
edit 1559 each item in the list. Click on the New icon in the window toolbar to add new items. In Item mode, this
clears the fields for new data. In List mode, this displays the <item type> details for <element type> <element
name> dialog. By clicking on the Auto button in Item mode or on the details dialog, you can apply an
automatic naming/numbering nomenclature that you have previously defined 525 .
An asterisk on a tab (as for the Defects tab, above) indicates that the tab contains saved information. If the tab
has no information or the information has not yet been saved, there is no asterisk, as shown for the Tasks tab.
You can also display the maintenance items in a compartment 1561 of each appropriate element in a diagram.

9.1.2 Maintenance Item Properties

Note:
For information on element-level Defects, Issues, Changes and Tasks, see the Maintenance 1558 topic. For
information on the Maintenance window, see the Maintenance Workspace 1558 topic.

To create, edit or delete maintenance items, follow the steps below:

1. Select the View | Other Element Tools | Maintenance menu option. The Maintenance window
displays.

© 1998-2010 Sparx Systems Pty Ltd

 1560 Maintenance and Bug Tracking | Maintenance

2. Open a diagram or the Project Browser and select an element. In Item mode, the oldest maintenance
item of each type for that element is shown in the Maintenance window, on the appropriate tab. The
other items are listed either in the left hand panel or in List mode.
3. Click on the Browse Element icon in the window toolbar. The Element Browser window displays.
4. To:
· Add a new item, select the appropriate tab, click on the New icon in the Maintenance window toolbar
and complete the fields as described in the table below
· Modify an existing item, select the item from the left-hand list panel or from the Maintenance folder of
the Element Browser window and edit the fields as described in the table below
· Delete an existing item, select the item from the left-hand list panel or the Maintenance folder of the
Element Browser window and click on the Delete icon in the Maintenance window toolbar.
5. Click on the Save button in the window toolbar.
Complete or edit the following fields on the Maintenance window

Note:
This table describes the fields of the Defects tab of the Maintenance window. The Changes, Issues and
Tasks tabs differ only in minor details.

Option Use to

Name Type the name or a short description of the defect.

Reported by Select the name of the person who reported the defect.

Reported Select the date on which the defect was reported.

Status Select the defect status, such as New or Complete.

Resolved by Select the name of the person who fixed the defect.

Resolved Select the date on which the defect was resolved.

Priority Select the priority assigned to resolving the defect.

Version Type the version number associated with this fix.

Description Type a longer description of the defect. You can format the text using the Notes 642
toolbar at the top of the field. This text is also reflected in the Notes window, but cannot
be edited there.

History Enter any notes or references to previous occurrences of this defect. You can format the
text using the Notes 642 toolbar at the top of the field. This text is also reflected in the
Notes window, but cannot be edited there.

Enterprise Architect User Guide

 Maintenance and Bug Tracking | Maintenance 1561

9.1.3 Move or Copy Maintenance Items

When you define an item on the Defects, Changes, Issues or Tasks tab of the Maintenance window, you might
decide that the item either is better suited to another Maintenance category, or forms a good template for
items in other categories. Enterprise Architect enables you to move or copy items between categories.
To move or copy a maintenance item, follow the steps below:
1. Open the Maintenance window 1558 and select the tab that contains the item you want to move or copy.
2. Right-click on the required maintenance item. The item context menu displays.
3. Click on the appropriate option - Move to or Copy to. A list of maintenance categories displays.
4. Click on the category to which to move or copy the item. A confirmatory prompt displays.
5. Click on the Yes button to confirm the move or copy.
6. Click on the target tab to ensure that the item has been added, and make any required changes 1559 .

9.1.4 Create Elements From Maintenance Item

A maintenance item identifies a defect, change, issue or task concerning an element. The maintenance item
could itself be represented by an element if it has wider implications for the project or identifies - for example -
an actor, activity or action that requires further definition.
You can create one or more elements from any maintenance item, using the Maintenance window. The new
element is connected to the maintenance item's parent element by a Dependency connector. The item itself
remains unchanged as a characteristic of its parent element.
To create an element from a maintenance item, follow the steps below:
1. Open the Maintenance window 1558 and select the tab that contains the item you want to create the
element from.
2. Right-click on the required maintenance item. The item context menu displays. select the Create as
new Element context menu option. The New Element 524 dialog displays.
3. In the Name field, type a name for the new element.
4. In the Type field, click on the drop-down arrow and select the required element type. For example, you
might create an Issue element for a Defect or Issue maintenance item, a Change element for a Change
item, or an Action for a Task item.

You can, however, create a wide range of other element types should any of these be appropriate, and
use the Select Group button to select a profile, MDG Technology or Add-In to create an element
specific to that element group.
5. If necessary, in the Stereotype field click on the drop-down arrow and select a stereotype to apply to
the new element.
6. If you want to immediately define the properties of the element, select the Open Properties Dialog on
Creation checkbox.
7. If you are adding multiple elements in one session, deselect the Close dialog on OK checkbox.
8. If you want to add the element to the currently-open diagram, select the Add to Current Diagram
checkbox.
9. Click on the OK button to create the element.
The element is added to the Project Browser and - if requested - to the current diagram.

9.1.5 Show Maintenance Script in Diagram

Any element that is capable of displaying a compartment can show maintenance scripts 1558 in a diagram. To
make use of the feature the element must have an attached maintenance item.
To use this feature follow the steps below:
1. Open a diagram containing the element with the attached maintenance items.
2. Double-click on the diagram background to display the Diagram Properties dialog. Click on the
Elements tab.

© 1998-2010 Sparx Systems Pty Ltd

 1562 Maintenance and Bug Tracking | Maintenance

3. In the Show Compartments panel, select the Maintenance checkbox.

4. Click on the OK button to save the setting.
The maintenance Items now appear as items in the maintenance scripts compartment of the diagram element.

Enterprise Architect User Guide

 Maintenance and Bug Tracking | Changes and Defects 1563

9.2 Changes and Defects

Change and Defect Elements

Changes 1564 and Defects 1563 are structured comments that can be used in managing change in a project. A
Defect element (also known as an Issue element) corresponds to a failure to match the requirements for the
current system. A Change element corresponds to a change in requirements for the current system.

Using Structured Comments

You can track changes and defects (issues) in an Enterprise Architect model. Change and Defect elements
can be created in UML diagrams and connected using Realization, Dependency, Aggregation and other
relationships to show what model element each affects and how each is resolved. You can edit the element
properties 1565 , and assign people 1566 (as Actor elements) to changes and defects.

9.2.1 Defects (Issues)

A Defect (or Issue) element is a structured comment that contains information about defects and issues that
relate to the system or model. This corresponds in some sense to a failure to meet defined requirements for
the current system. An Issue element looks the same as a Requirement element:

Enterprise Architect enables you to generate and handle issues in much the same way as you can handle
and color code 920 Requirements. For more information, see the Requirements 917 topic.
You can link Issues using Realize connectors to model elements that are responsible for the defect. You can
even structure a hierarchy of Issues using aggregation.

Note:
Issue elements can be created with or without an identifying I in the top right corner of the element. To toggle
the display of this letter, select or deselect the Show stereotype icon for requirements checkbox on the
Options dialog, Objects 362 page.

Add an Issue Using the Toolbox

To add an Issue to the model using the Toolbox:
1. Open a Custom diagram.
2. From the Custom 417 pages or Common 405 page of the Toolbox, drag the Issue icon onto the diagram.
3. Enter the details as required.

Add an Issue Using the Insert New Element Dialog

To add an Issue to the model using the Insert New Element dialog, follow the steps below:
1. Right-click on a package in the Project Browser.
2. Select the Insert | New Element context menu option. The New Element dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1564 Maintenance and Bug Tracking | Changes and Defects

3. In the Type field, click on the drop-down arrow and select Issue.
4. In the Name field, type a name for the element.
5. Click on the OK button.

9.2.2 Changes
A Change element is a structured comment that contains information about requested changes to the system/
model. This corresponds in some sense to a change in requirements for the current system. A Change
element looks the same as a Requirement element:

Enterprise Architect enables you to generate and handle Changes in much the same way as you can handle
and color code 920 Requirements. For more information, see the Requirements 917 topic.
You can connect Changes using Realization connectors to model elements that implement the Change, and
you can structure a hierarchy of changes using Aggregation.

Note:
Change elements can be created with or without an identifying C in the top right corner of the element. To
toggle the display of this letter, select or deselect the Show stereotype icon for requirements checkbox on
the Options dialog, Objects 362 page.

Add a Change Using the Toolbox

To add a Change to the model using the Toolbox:
1. Open a Custom diagram.
2. From the Custom 417 pages or Common 405 page of the Toolbox, drag the Change icon onto the
diagram.
3. Enter the details as required.

Add a Change Using the Insert New Element Dialog

To add a Change to the model using the Insert New Element dialog, follow the steps below:
1. Right-click on a package in the Project Browser.
2. Select the Insert | New Element context menu option. The New Element dialog displays.

Enterprise Architect User Guide

 Maintenance and Bug Tracking | Changes and Defects 1565

3. In the Type field, click on the drop-down arrow and select Change.
4. In the Name field, type a name for the element.
5. Click on the OK button.

9.2.3 Element Properties

The Properties dialog for Changes and Issues is similar to that used by Requirements. It has a Properties tab
containing the name of the Issue and relevant management details (such as owner and dates). You can also
associate files 507 with the issue and add Tagged Values 634 .

© 1998-2010 Sparx Systems Pty Ltd

 1566 Maintenance and Bug Tracking | Changes and Defects

9.2.4 Assign People to Defects or Changes

As an example of how you might use the Relationship Matrix to monitor issues or changes, the screen below
illustrates staff (actors) being linked through Realization connectors to Issues. Each highlighted square
indicates a responsibility of a staff member to work on or correct a named issue. This same approach can be
used for any mix of model elements.

Enterprise Architect User Guide

Part

X
 1568 Report Generation |

10 Report Generation

Model documentation is essential to realizing the full benefit of Enterprise Architect. Enterprise Architect
provides a powerful mechanism for generating high quality, customized documentation directly from your
model, in either RTF or HTML format.
There are many ways to specify the Enterprise Architect content being documented. You can:
· Document a package and/or its child packages by manually highlighting the package and selecting a
documentation control
· Specify embedded packages for exclusion 1573 if child packages are recursively documented
· Link a package to an RTF document template to simplify generating consistent types of documentation (eg
Use Case Reports) using the Documents feature 1636
· Select, group and order packages together in a different manner from the Project Browser by creating '
Virtual' Documents 1616 , either linked through a master document with headers, footers and contents list, or
as separate individual documents.

RTF Documentation
Rich text reports are documents produced by Enterprise Architect in Rich Text Format (RTF). RTF formatting
can be modified directly with RTF Style templates to alter the look and feel of generated output. Using MS
Word you can further enhance the separate RTF documents output from the model by connecting and
interweaving them into a linked master document 1638 with headers, footers and contents list.
Enterprise Architect has a fully-featured RTF Document Generator that features:
· Powerful WYSIWYG RTF style template editor support
· An easy-to-use document generator
· An embedded RTF viewer that enables you to view RTF documents generated by Enterprise Architect
within Enterprise Architect.
For further information, see:
· RTF Documents 1569
· Use MS Word. 1638

RTF Reports
You can also generate a number of RTF reports on different aspects of your model. See the Other Documents
1624 topic.

HTML Documentation
Enterprise Architect provides automated web-based publishing of models, making it simple to explore large
models efficiently on-line. Enterprise Architect enables the export of an entire model or a single branch of the
model to HTML Web pages. You can also create web style templates to customize the HTML output.
For further information, see the HTML Reports 1647 topic.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1569

10.1 RTF Documents

Rich Text Format Documentation

Rich text reports are documents produced by Enterprise Architect in Rich Text Format (RTF), a format
common to many word processors.
RTF is particularly targeted at Microsoft Word™, which enables you to link a number of rich text documents
into a single master document 1638 .
Typically you create a Word master document, then some Enterprise Architect RTF reports. You link the
reports back into sub-sections of the master document, and refresh them as required during project
development. In this way the project document becomes an easily-managed and feature-rich work product.
You can also populate a Word document from specific sections of reports, based on bookmarks 1639 . For
example, a Word document might have a section for a small part of your component model. Using bookmarks
you can generate a full component model, and then link into just one section of the report. This way you can
maintain a complex Word document from parts of Enterprise Architect reports. The RTF Generator performs
one pass for one template, but using a Word master document and Enterprise Architect bookmarks enables
you to incorporate material from several RTF documents with different formats based on different templates.
By adding tables of contents, figure tables, sections, and headers and footers, you can manage a complex
document with relative ease. Simply update the Enterprise Architect RTF reports then refresh the links in MS
Word.
You can also maintain complex documents by creating virtual documents 1616 in Enterprise Architect, setting
up a Master Document (package) element and/or Model Document elements (Class elements of stereotype
Model Document) and linking packages into the document, in whatever order or combination is most
appropriate to your requirements. You can select packages from different areas of the model, arrange them in
any order, and edit or delete the packages. The virtual document automatically incorporates the changes each
time you generate it.
You can have several RTF reports open at the same time, as separate tabs 397 in the central view area of the
Enterprise Architect work area. You can also close the reports individually or all together, leaving views of
other types (such as diagrams or code editors) still open.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Generate Documents 198 permission to generate
RTF documents.

The RTF Generator

Enterprise Architect has an enhanced RTF Document Generator that features:
· Powerful WYSIWYG RTF style template editor support, enabling:
· Headers and Footers
· Images
· Indexes
· Tabular Sections
· Nested Sections
· All model elements, connectors, diagrams and their properties
· Template import and export using XML
· Basic templates supplied for customization.
· A document generator that:
· Provides simplified options

© 1998-2010 Sparx Systems Pty Ltd

 1570 Report Generation | RTF Documents

· Generates complex documents based on RTF templates.

· An embedded RTF viewer that you use to view RTF documents generated in Enterprise Architect directly
within Enterprise Architect.

More Information
A tutorial on using the RTF Generator and creating RTF documentation is provided on the Sparx Systems
website. Click on the following link:
http://www.sparxsystems.com/resources/whitepapers/
For more information, see:
· Generate RTF Documents 1570
· Generate RTF Documentation Dialog 1573
· RTF Document Options 1607
· RTF Templates Tab 1576
· Custom Language Settings 1637
· Include or Exclude a Package from Report 1573

10.1.1 Generate RTF Documents

Creating a Rich Text Format (RTF) document is a simple and flexible process. An RTF document is based on
a package or an element in your project (more usually a package). To produce a document, you must select
the package or element to report on in the Project Browser, Element List or Model Search.

Tip:
Reports can be configured to include all packages within a parent package, or just the top level.

You should also set the diagram properties 1571 to determine how the diagrams in the package are set out in
the RTF document. When you have prepared and selected your package, use the context menu to open the
Generate RTF Documentation dialog and configure the details of your document. The next topic guides you
through creating a rich text report.

Open the Generate RTF Documentation Dialog

Use one of the following methods:
· Select the Project | Documentation | Rich Text Format (RTF) Report menu option
· In the Project Browser, right-click on the required package and, on the context menu, select the
Documentation | Rich Text Format (RTF) Report menu option
· In the Project Browser or a diagram, click on the required package or element and press [F8]
· In a diagram, click on a specific element and select the Element | Rich Text Format (RTF) Report menu
option
· In the Element List or Model Search, select one or more items, right-click and, from the context menu,
select either the RTF Report | Generate report for each selected object option or the RTF Report |
Generate one report for all selected option.
See the Generate RTF Documentation Dialog 1573 topic for more information.

Quick Start
To generate and view an example RTF report right now, follow the steps below:
1. Open the EAExample project.
2. Open the QA Model package and right-click on the Testing package.
3. Select the Documentation | Rich Text Format (RTF) Report context menu option. The Generate RTF
Documentation dialog displays.
4. In the Output to file field, select a convenient file location in which to hold the generated report.
5. In the Use Template field, click on the drop-down arrow and select (basic template).
6. Click on the Generate button.
7. When the report has been generated, click on the View button.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1571

Generate RTF Report From Element List or Model Search

When you select to create an RTF Report from the Element List 1255 or Model Search 1231 tools, you can
generate an element-level report rather than a package-level report, and you have additional flexibility in
selecting:
· The type of element to report on
· The specific elements to report on, together or separately, whether in the same package or not.
For example, you might want to find all elements with test cases, with the intention of reporting on some or
possibly all such elements. With the Element List, you would identify these elements yourself within the list of
all elements in a selected package, but with the Model Search you could specifically identify the elements
across a section of the model or across the whole model, as required. The search filtering could be for specific
test cases; however, the results are by element so if there are test cases outside the range in any element that
has a filtered test, these elements are listed as well.
Having generated the list of elements, you can select individual elements, blocks of elements, or all elements,
and then (as above) use the context menu to generate a report on all of the elements, or separate reports on
each element.

10.1.1.1 Diagram Options

This topic refers to options on the Diagram page of the Diagram Properties dialog, used when generating RTF
reports for a particular diagram (using either the extended 1573 or Legacy 1628 RTF Report Generator). Display
the dialog page by double-clicking on the diagram background, and select the Diagram tab.

Exclude Image from RTF Documents

Select this checkbox to exclude the image of the current diagram from any RTF reports.

Document Each Contained Element in RTF

Select this checkbox to ensure the RTF report generator includes details of elements that belong in other -
external - packages but that are linked into this diagram within the package being reported on. The report
includes external elements for each diagram on which you have selected the checkbox.
On the Generate RTF Documentation 1573 dialog, the Include all Diagram Elements in Report checkbox
defaults to selected, to include external elements for every diagram covered by the report. Therefore, to
include external elements only for selected diagrams, deselect this checkbox.
In either case, you must enable the Package.Diagram.Element or Package.Element section in your (
customized) document generation templates in order to include this external element information in the report.
To enable the template section:
1. Select the Project | Documentation | Rich Text Format (RTF) Report menu option.
2. Select the appropriate customized template (not a system-provided one) in the Use Template field.
3. Click on the Edit Template button to display the RTF Template Editor.
4. In the Sections panel on the left-hand side of the editor window, select the Package::Diagram::
Element checkboxes.

© 1998-2010 Sparx Systems Pty Ltd

 1572 Report Generation | RTF Documents

Notes:
· If using the Legacy RTF generator, the Element checkbox is automatically checked in your customized
template, when you select the Document each contained element in RTF checkbox.
· Package::Diagram::Element, if left blank, replicates the format of Package::Element including
sub-element sections (for example, Package::Element::Scenario). Package::Diagram::Element does not
have an option to add these sections.

Selecting the checkboxes adds the following set of sections to your report template:

To report on the linked elements in:

· the same style as defined in the Package::Elements section, delete the
[right-click-to-insert-Element-field(s)] text to leave a blank area
· a different style to the elements within the selected package, set up the style as appropriate.

Divide Diagram Into Multiple Pages

Select this checkbox to divide each large diagram into separate pages in the RTF document.

Note:
This option is only effective when the Scaled Printing 456 option is set to None on the Print Advanced dialog.

Rotate Images
Select this checkbox to rotate each diagram image by 90 degrees in the RTF document.

Note:
Only valid for bitmap (.bmp) images.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1573

10.1.1.2 Exclude Package from Report

You can exclude a particular package from any RTF reports by marking it for exclusion.

Notes:
· By default, packages are included in any RTF reports.
· When you exclude a package from RTF reports, all of the selected package's subpackages are also
excluded.

To Mark a Package for Exclusion

1. In the Project Browser, right-click on the required package. The context menu displays.
2. Select the Documentation | RTF Report Options menu option. The RTF Generation Options dialog
displays.

3. Select the Exclude Package from RTF Reports radio button.

4. Click on the OK button to save changes.

10.1.1.3 Generate RTF Documentation Dialog

Note:
For an introduction to generating RTF documentation, see RTF Documents 1569 .

The Generate RTF Documentation dialog enables you to set the exact contents and look and feel of your
report.

© 1998-2010 Sparx Systems Pty Ltd

 1574 Report Generation | RTF Documents

Each tab of the dialog offers a number of RTF document generation options, as described in the following
sections:
· Generate Tab (see below)
· RTF Templates 1576
· Document Options 1607
· Advanced Options 1609
· Element Filters 1611
· Other Filters 1612
· Project Constants 1614
· Word Substitution 1615
· Language Substitution (Codepage) 1615

When you have worked through these tabs and set the options you require, return to the Generate tab and
click on the Generate button to produce your report.

Note:
If you have never selected the Optimize for Open Office checkbox, the document generator prompts you to
confirm which document style you want to adopt - Microsoft Office or Sun Open Office. Once you have made
a selection in this prompt, the document generator always acts on the status of the checkbox and does not
display the prompt again.

Generate Tab Options

The Generate tab of the dialog has the following fields:

Option Use to

Model Document Confirm the name of the element selected from the Project Browser, Element List

Enterprise Architect User Guide

 Report Generation | RTF Documents 1575

Option Use to

or Model Search.
Root Element If this is the specially-created model document element for a Virtual Document
Root Package 1616 , the field is Model Document.

Otherwise, this field identifies the selected element of the hierarchy to be reported
on; that is, the Root Element or Root Package.

Output to File Type or select the location and filename for the generated documentation. The
[ ... ] (Browse) button enables you to navigate to the location.

Use Template Type or select the name of the RTF template to apply to document generation.
You can select either a standard template (enclosed in parentheses) or a user-
generated template.
The standard templates include the following:

Use Language Switch custom language word substitutions 1615 on.

Substitutions
Deselect to switch custom language word substitutions off.

View Document On Open the document as soon as it has been generated.

Completion

Use Internal Viewer Enable the View button to launch the generated RTF Documentation in the
Enterprise Architect internal viewer.
Deselect to enable the View button to launch the generated RTF Documentation
in the MS Windows default RTF file viewer.

Note:
If you use Open Office as your default document editor, you must select the
Overwrite Document Fields checkbox in the document options 1607 in order to
show field value text. Open Office defaults to showing field codes only, and you
cannot toggle to the field values.

Include all Diagram Include elements in the report from external packages that are referenced from a
Elements in Report diagram, for every diagram covered by the report. Defaults to selected. The
Package.Diagram.Element or Package.Element checkbox must be selected in
the current template.
If external elements are to be included only for selected diagrams, deselect this
checkbox and select the Document each contained element in RTF checkbox
in the diagram properties 1571 for each required report.
When both options are deselected, or when neither of the Package.Diagram.
Element or Package.Element checkboxes are selected in the template, only
elements in the current package are documented.

© 1998-2010 Sparx Systems Pty Ltd

 1576 Report Generation | RTF Documents

Option Use to

Optimize for Open Generate reports where diagrams are adjusted for clean rendering in Sun Open
Office Office. The option also overwrites the value fields defined in a document section
with the actual value text. If you open a generated report in Word, you can format
the text but you cannot display the original field code.
If the checkbox is deselected, diagrams displayed in Open Office are less distinct.
Value fields remain and are populated with the appropriate values; when you
display a generated report in Word, you can right-click on the field and toggle
between the value text and the field code.

Note:
If you use Open Office as your text editor, you must select this checkbox to
show the field values. Open Office defaults to showing the field codes only, and
you cannot toggle to the field values.

Generate Generate the document (after you have set all the options you require, on all tabs
of the dialog).

View Launch the generated RTF Documentation in the MS Windows default RTF file
viewer, or in the Enterprise Architect internal viewer if you have selected the Use
Internal Viewer checkbox.

Edit Template Edit the currently-named template using the RTF Style Template Editor 1578 .
You can only edit user-defined templates, not the standard templates provided
with Enterprise Architect. Standard template names are enclosed in parentheses.

Resource Document Save the current options as a document definition 1606 .

Abort Cancel report generation.

10.1.1.4 RTF Templates Tab

The Templates tab of the Generate RTF Documentation dialog enables you to create, edit and delete your
own RTF style templates. You can also import RTF templates saved as XML files.
In versions of Enterprise Architect later than 7.1, a Normal.rtf template is provided as a system template, as an
external file stored with the Enterprise Architect system directory (in C:\Program Files\Sparx
Systems\EA\DocTemplates). This provides user-editable defaults of styles, numbering and other base
formats. Any styles modified in the Normal.rtf file reflect in newly created templates. One useful style is the
default list numbering, MasterList.

To edit the Normal.rtf template, use the RTF Style Template Editor 1578 to create a new template called, for
example, Normal, and use the File | Import 1588 menu option to import the Normal.rtf file into the Normal
template. Modify the Normal template as required, but ensure there is no text when you save it, just style
definitions. Export 1588 the modified template back into the Normal.rtf file in the RTFTemplates folder.
A related feature in the RTF Style Template Editor is the File | Update Styles 1589 menu option. This enables
you to update existing templates to reflect any changes to Normal.rtf.

Note:
· In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is switched on, you must have Configure Resources 198 access
permission to create RTF templates.
· In the Normal.rtf template, you must not edit the SSbookmark style. This defines the section styles and
must be preserved.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1577

The tab has the following functions:

To Do this...

Delete a template Click on the template name and click on the Delete button.

Create a new template Click on the New button. The New Document Template dialog displays, on
which you specify the template name and the name of any existing
template to act as the base for the new template.
To make it easier to get up and running, Enterprise Architect provides a
basic template with default settings on which you can base new templates.
Modify the template as required, using the RTF Style Template Editor.

Open the RTF Style Template Click on the template name and click on the Edit button. The Document
Editor Template Editor screen displays, presenting the facilities of the RTF Style
Template Editor.

Import RTF Templates saved to 1. Click on the Import From Reference File button.
XML files using the Tools |
2. On the Import Reference Data dialog, click on the Select File
Export Reference Data menu
button and browse for and select the required file.
option
3. In the Select Datasets to Import panel, click on the required
datasets.
4. Click on the Import button to import the template.
The imported template displays in the list on the Templates tab of the
Generate RTF Documentation dialog.

© 1998-2010 Sparx Systems Pty Ltd

 1578 Report Generation | RTF Documents

Note:
There are two methods of exporting and importing RTF templates out of and into models:
· If the template is in a batch file, export it using the Tools | Export Reference Data menu option and import
it using the Templates tab, as above.
· If the template is a one-off copy, use the RTF Template Editor File 1588 menu options, Export and Import.

10.1.1.4.1 RTF Style Template Editor

The RTF Style Editor enables you to create and edit custom RTF templates to define output RTF
documentation associated with various sections of the RTF Report facility in Enterprise Architect. You typically
use this facility to customize the look and feel of a report for your company or client. You access the RTF Style
Editor by:
· Opening the Resources window (View | Other Project Tools | Resources), expanding the Templates >
Document Templates > System or Model folders, and selecting to view or modify a template
· Selecting to edit the current template on the Generate tab of the Generate RTF Documentation dialog, or
· Selecting to edit a style template on the Templates tab of the Generate RTF Documentation dialog.
You select particular model 1579 components and specify, from the component type, the fields to include in the
generated document. You can define formatting styles in the RTF Style Template Editor, and add a range of
items such as tables of contents or headers to the document.
For information regarding specific commands to alter the format of the RTF documentation, see the entries
under the RTF Style Template Editor Options 1587 topic.

Note:
You can transport these RTF templates between models, using the Export Reference Data 223 and Import
Reference Data 225 options on the Tools menu.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1579

10.1.1.4.2 Select Components for Reporting

To select model components to be documented in the report, using the RTF Style Template Editor:
1. Expand the Sections tree on the <template name> screen.
2. Select the checkbox next to the component name; the component name is then displayed as a section
tag in the Content panel. Guidance in selecting some of the components is provided in:
· Linked Documents and Document Artifact Contents 1580
· Tabular Sections 1581
· Child Sections 1584
· Constraint and Scenario Sections 1585
3. Add content 1586 to each report component.
The position of the section tags within the Sections tree determines the position of the model component in
the Content panel. For encapsulated components, selecting a child component automatically selects the
parent also.
To move a model component to a different position in the documentation template:
1. Select the component in the Sections panel.

2. Click on and to move the component up and down the Sections panel.
For example, the section tag for Package | Diagram | Element is displayed in the Sections panel above the
section tag for Package | Diagram | Connector.

© 1998-2010 Sparx Systems Pty Ltd

 1580 Report Generation | RTF Documents

Note:
If the Package.Diagram.Element checkboxes are selected, you must select either the Document each
contained element in RTF checkbox in the Diagram Properties 1571 dialog for at least one included diagram,
or the Include all diagram elements in report checkbox on the Generate RTF Documentation 1573 dialog.

Linked Documents and Document Artifact Contents

Linked documents 597 and documents created via the Document Artifact 599 element are rendered into RTF
Documentation by selecting the Linked Document checkbox in the RTF Style Template Editor.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1581

The Linked Document checkbox is within the Element hierarchy, towards the end. Remember that
checkboxes can be moved up and down the hierarchy (as has been done above) to position information in the
generated document as you require. In some templates, the Linked Document checkbox is only available as
a child of the External Requirements checkbox.
The linked document is rendered into the RTF documentation at:

linked document >

<linked document

10.1.1.4.3 Tabular Sections

The RTF Style Template Editor supports rendering a document section as a table. A tabular section is defined
as a table containing any number of columns, but with only two rows:
· The first row is used to describe the headings of the columns, which you type in and format yourself
· The second row defines the output, which you specify by right-clicking in each cell and selecting the output
type from the field list; the output is then generated iteratively for every occurrence of the section in
question.

© 1998-2010 Sparx Systems Pty Ltd

 1582 Report Generation | RTF Documents

Notes:
· Under some circumstances, a table might repeat the header row rather than the output row; if this occurs,
create another row in the table between the header row and the output row, and leave this blank.
· If you type a carriage return between the end of the table and the section terminator, the table you
generate has a line space between the rows. For example:

This generates the following table:

Element Name Author

Choose Recipient John Redfern

Line Space

Manage Contacts Walter Frederick

To avoid this, ensure that there is no carriage return between the end of the table and the section
terminator, as follows:

This generates a table with no space between the rows, as follows:

Element Name Author

Choose Recipient John Redfern

Manage Contacts Walter Frederick

Example Tabular Section

In the following example, the Model> Glossary> section is defined as a tabular section:

Enterprise Architect User Guide

 Report Generation | RTF Documents 1583

This renders the following document output:

© 1998-2010 Sparx Systems Pty Ltd

 1584 Report Generation | RTF Documents

10.1.1.4.4 Child Sections

Child sections can be rendered in RTF documentation using one of the following two methods:
· Render model components directly into the RTF as defined by the section's content and fields.
· Render indirectly to the RTF by using a parent section to describe the content.
The second option occurs as a result of creating a section that has a placeholder section tag (that is, no
content within the tags). This method is used to create recursive documentation of child packages.

Example: Rendered Subsection

This example shows a template with content between the Child Element tags. In this example child elements
of the parent are rendered using the Child Elements section because it contains valid content and fields.

Example: Non-rendered Subsection

This example shows a template with no content between the child element tags. In this example, child
elements of the parent are rendered using the element section because the child element section is empty.
The child element section is used as a placeholder.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1585

Child Document Sections and Their Corresponding Parent Sections

Child Section Section Rendered when used as a placeholder

Package->Child Package Package

Package->Element->Child Element Package->Element

Package->Element->Diagram Package->Diagram

Package->Diagram->Element Package->Element

Package->Diagram->Connector Package->Element->Connector

10.1.1.4.5 Constraint and Scenario Sections

The template content options 1579 enable you to include sections in your reports for:
· constraints on Package Elements, Elements, Connectors and Attributes, and
· scenarios for Package Elements and Elements.
There are additional options in these types of section that enable you to determine what types of constraint or
scenario are included in your reports, as described below.

Constraints
The following constraint options are available for selection, as checkboxes in the Sections panel of the RTF
Style Template Editor:
· Pre-Constraint - select this checkbox to include all constraints of the type 'pre-condition' in this section of
the report.
· Post-Constraint - select this checkbox to include all constraints of the type 'post-condition' in this section

© 1998-2010 Sparx Systems Pty Ltd

 1586 Report Generation | RTF Documents

of the report.
· Constraint - select this checkbox to include all constraints that have not been generated in the Pre-
Constraint and Post-Constraint sections of the report.

Scenarios
The following scenario options are available for selection, as checkboxes in the Sections panel of the RTF
Style Template Editor:
· Element > Scenario - select this checkbox to include all scenarios in this section of the report; if any of the
following sections are also selected, the report includes all scenarios that are not exception paths.
· Element > Scenario > Exception - select this checkbox to include all exceptions for each scenario
· Element > Scenario > Structured Scenarios - select this checkbox to include all scenario steps in the
scenario sections of the report.
· Element > Scenario > Structured Scenarios > Exception - select this checkbox to include the steps for
each exception path in the scenario sections of the report.

10.1.1.4.6 Add Content

The RTF Style Template Editor uses pairs of tags to define the layout of the documentation content. To insert
a pair of model component tags into the Content section of the Editor, use the Sections 1579 panel of the RTF
Style Template Editor.
The beginning of a model component is represented by a yellow highlighted sectionname > tag; the end of the
model component is represented by < sectionname.
To add model component content, right-click in the area between the opening and closing tags. This displays
a context menu that enables you to:
· perform simple text editing (cut, copy and paste)
· select from a list of defined Project Constants 1614 to insert at the cursor position; if no project constants
have been defined, the menu option is not available
· select from a context-sensitive list of fields to add to this component section of the RTF Documentation;
any additional information entered between the tags is also included in the generated RTF Documentation.
For example, in the connector> section shown below, the user has right-clicked in the fourth column of the
table, underneath the <constraint tag. They can then select to add another field to the Notes on each
connector listed in the table.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1587

Note:
If you select a field with short date format (such as Pkg.DateCreatedShort, Diagram.DateModifiedShort or
Element.DateCreatedShort) the format is actually drawn from the MS Windows settings. To use a different
short date format, click on the Start icon on the Windows desktop and select the Control Panel | Regional
and Language Options | Customize option.

The valueOf Field

For certain sections, you can add a field to capture a special characteristic of a model component, as defined
by a specific Tagged Value. This is the valueOf field, shown in the list for a connector section in the above
graphic. The sections that provide the valueOf field are:
· Package
· Element
· Connector
· Attribute
· Operation
· External Requirement.
When you select the valueOf field from the context menu, the template editor prompts you to specify the tag
(Tagged Value) from which to extract the value for the report output. This tag should be one of the tags
associated with the model component, such as ConnectorAltName for a connector. When you provide the tag
name, the template editor adds the field at the cursor position, in the format:
{Connector.valueOf(tagname)} for example: {Connector.valueOf(ConnectorAltName)}
For clarity, you could type some lead-in text or the meaning of the Tagged Value immediately preceding the
value field; for example:
Alternative Name: {Connector.valueOf(ConnectorAltName)}

10.1.1.4.7 RTF Style Template Editor Options

The following topics provide assistance on using the RTF Style Template Editor.
· Scroll Through Text 1588
· File and Print Options 1588
· Cut and Paste Options 1589
· View Options 1590
· Image and Object Inserts 1591
· Character Formatting 1592
· Paragraph Formatting 1593
· Tab Support 1595
· Page Breaks and Repagination 1595
· Headers and Footers 1596
· Hyperlinks and Bookmarks 1597
· Table Commands 1597
· Sections and Columns 1599
· Stylesheets and Table of Contents 1600
· User-Defined Section Numbering 1601
· Frame and Drawing Objects 1604
· Search/Replace Commands 1605

Note:
Throughout your template editing, be aware that:
· To undo one or more immediately previous edits, press [Ctrl]+[Z], or select the Edit | Undo menu option.
You can still undo a change even after you have saved the change.
· To redo one or more immediately previous undone edits, press [Ctrl]+[Y], or select the Edit | Redo menu
option.

© 1998-2010 Sparx Systems Pty Ltd

 1588 Report Generation | RTF Documents

10.1.1.4.7.1 Scroll Through Text

Scroll Using Options

Keyboard Keys Press

· [#], [$], [!] or ["] to scroll up or down a line, or left or right one character
· [Home] to move to the beginning of the current line
· [End] to move to the end of the current line
· [Ctrl]+[Page Up] to move to the beginning of a file
· [Ctrl]+[Page Down] to move to the end of a file
· [Page Up] to display the previous page
· [Page Down] to display the next page
· [Ctrl]+[!] to move to the previous word
· [Ctrl]+["] to move to the next word
· [Ctrl]+[#] to move to the first column of the current line (if not already on the first
column) or the first column of the previous line
· [Ctrl]+[$] to move to the first column of the next line
· [F10] (or select the Other | Jump menu option), type in a line number to jump to, and
click on the OK button.
Mouse Click on the vertical and horizontal scroll bar to perform various scrolling functions. These
functions are available only if the horizontal or the vertical bar has been enabled by the
startup parameters.
Vertical Scroll Bar: Click on the arrows on either end to scroll the screen up or down by
one line.
Click above the elevator to scroll the screen up by one page. Similarly, click below the
elevator to scroll the screen down by one page.
You can also drag the elevator to any position in the bar. As the elevator is dragged, the
editor scrolls the screen up or down accordingly.
Horizontal Scroll Bar: Click on the arrows on either end to scroll the screen left or right by
one column. Click on either side of the elevator to scroll the screen left or right by 1/2
screen.
You can also drag the elevator to any position in the bar. As the elevator is dragged, the
editor scrolls the screen left or right accordingly.

10.1.1.4.7.2 File and Print Options

Menu Option & Use to

Function Keys

New Clear an existing template from the edit window and start an empty, unnamed
template.
The editor prompts you to save any modification to the previous template.

Revert Revert to the previously-saved copy of the template.

Save [Ctrl]+[S] Save the text to the current file name.

If a file is not yet specified, the editor prompts you for a template name.

Save As [Ctrl] Similar to Save File, but you specify a new template name for saving the template.
+[Shift]+[S]

Import Import an existing RTF document 1606 into the Template Editor, so as to insert model
elements from that document into the template.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1589

Menu Option & Use to

Function Keys

Note:
This option is useful when creating templates from a predefined document with a
particular 'look and feel'.

Export Save the template as an RTF document rather than as a template.

This can be useful for saving the template for other models.

Update Styles Imports the styles from Normal.rtf, found in the Doc Templates directory.

Note:
This option is useful when creating a Master Document / Sub Documents that
require consistent user-defined styles across multiple templates (including such
things as numbering formats).

Document Options Display the Document Options 1607 dialog which enables you to set the filter and
order the elements.

Page Layout Specify the page layout, before selecting the Print option. You can specify the
margins (left, right, top and bottom) in inches.

Printer Setup Invoke a printer-specific dialog for the default printer (the default printer selection is
[Ctrl]+[Shift]+[P] made from the Windows Control panel). You select the parameters from a set of
printer-specific options. These options include page size, page orientation,
resolution and fonts.

Print [Ctrl]+[P] Print the contents of the current file. The editor displays a dialog where you can
select the scope of the printing. You can also choose to print only a selected part of
the file.
To print a block of text, highlight the required text before invoking the Print function.
This command prints a highlighted:
· Line block
· Character block
The Print function prints on a default printer selected from the Windows Control
panel. You can alter the printer setup or page layout prior to invoking the Print
function.

Print Preview Preview the document before printing. The editor displays up to two pages at a time.
You can scroll to a different page using [Page Up], [Page Down] or the scroll bar.
By default the preview rectangle is sized to fit the current window. However, you can
use the zoom option to enlarge or shrink the preview rectangle as required.
Click on the Edit button or the File | Print Preview menu option again to return to
editing mode.

Close Close the Template Editor. The editor prompts you to save any unsaved information.

10.1.1.4.7.3 Cut and Paste Options

To Do this...

Highlight a word Double-click on the word.

Highlight a line Move the cursor onto the line and press [F8].

Select all file Press [Ctrl]+[A] or select the Edit | Select All menu option.
content

© 1998-2010 Sparx Systems Pty Ltd

 1590 Report Generation | RTF Documents

To Do this...

Copy a block Highlight the lines of text to be copied and press [Ctrl]+[C], or select the Edit | Copy
menu option.
Move the cursor to the point at which to insert the text and press [Ctrl]+[V] or select the
Edit | Paste menu option.

Move a block Highlight the lines of text to be moved and press [Ctrl]+[X], or select the Edit | Cut
menu option. The selected text is removed from the page.
Move the cursor to the point at which to insert the text and press [Ctrl]+[V] or select the
Edit | Paste menu option.

Delete a block Highlight the lines of text to be deleted and press [Delete]

Delete a line Press [Shift]+[F9] to delete the current line. The remaining lines close up.

Paste special Select the Edit | Paste Special menu option. The Paste Special dialog displays, listing
objects the appropriate data type formats for pasting the copied object, as listed below.
Click on the Paste button to embed the data into your application, or click on the Paste
Link button to create a link to the original file.
Native Object Format
If available, this is the first format in the list box. You can edit data in this format using
the original application, by double-clicking the object.
Formatted Text
A text format. This option offers the most suitable format if the data is pasted from
another text output application, as the font and formatting attributes are reproduced
accurately.
Unformatted Text
Another text format. This option pastes the text without retaining the formatting
information.
Picture Format
The data is available in Picture format. You can later edit the object, by double-clicking
on it and invoking the Microsoft MS Draw application.

Note:
This format is preferred over the Bitmap and the Device Independent Bitmap formats.

Device Independent Bitmap and Regular Bitmap formats

The data is available in bitmap formats. You can later edit the object, by double-clicking
on it and invoking the Microsoft MS Draw application.
The editor converts these formats into the Picture format before calling the drawing
application.

10.1.1.4.7.4 View Options

Menu Option Use to

Page Mode Turn Page Mode on (the equivalent of Print View in Word) or off (the equivalent of Normal
View in Word).
In Page Mode, the editor displays one page at a time. It is most useful for documents
containing multiple columns, as the columns are displayed side by side.

Fitted View Turn Fitted View on or off. This is a special case of Page Mode, in which the text wraps to
the window width and the soft page breaks are not displayed.
If you select Fitted View, Page Mode is automatically selected too. If you deselect Page

Enterprise Architect User Guide

 Report Generation | RTF Documents 1591

Menu Option Use to

Mode, Fitted View is automatically deselected too.

Ruler Display or hide the ruler at the top of the page.

The ruler shows tab stops and paragraph indentation marks; it can also be used to create
or delete tab stops.

Tool Bar Display or hide the tool bar above the ruler.
The tool bar provides a convenient method of selecting fonts, point sizes, character styles
and paragraph properties. The tool bar also shows the current selection for font, point size
and character styles.

Status Ribbon Display or hide the status ribbon at the bottom of the editing panel.
The status ribbon displays the current page number, line number, column number and row
number. It also indicates the current insert/overtype mode.

Paragraph Display or hide the paragraph marker (an inverted 'P') at the end of each paragraph.
Marker
This option is useful when working with lines with many different heights.

Hidden Text Show or hide 'hidden' text.

Text formatted with the hidden attribute (see Character Formatting Options 1592 ) is shown
with a dotted underline. When the option is turned off, the hidden text is not visible.

Field Names Insert, show and hide field names.

As you develop your RTF document, you right-click on sections to insert field markers. You
cannot insert these markers unless you have selected the Field Names option.
When you deselect the option, existing field names are obscured.

Page Header/ Display or hide the text of page headers and footers. If Page Mode is not selected, this
Footer option turns Page Mode on.
When Page Mode is selected, you cannot edit the header or footer text unless you also
select the Edit | Edit Page Header/Footer menu option. See Headers and Footers 1596 .
When Page Mode is deselected, you can see and edit page headers and footers at the
start of the document.

Page Border Display or hide a page outline in Page Mode.

When Page Mode is deselected, this option is not available.
When Page Border is selected, the document contents are shown within a page outline.
When Page Border is deselected, the document contents are formatted within the
boundaries of the editing screen.

Zoom Shrink or enlarge the display of the document text, by selecting the appropriate percentage
enlargement.
The editor supports zoom percentages from 25 to 200.

10.1.1.4.7.5 Image and Object Inserts

To Do this...

Embed a picture Position the cursor at the point at which to insert the picture bitmap or Windows metafile,
in the document and either:
· Select the Insert | Embed Picture menu option, or
· Press [Alt]+[F8].
A browser dialog displays, through which you select the picture to embed in the
document. The picture displays at the current cursor location.

© 1998-2010 Sparx Systems Pty Ltd

 1592 Report Generation | RTF Documents

To Do this...

The embedded picture is saved within the document.

Link a picture Position the cursor at the point at which to link the picture bitmap or Windows metafile,
file to the and select the Insert | Link Picture menu option.
document
A browser dialog displays, through which you select the picture to link to the document.
The picture displays at the current cursor location.
Linked picture data is not saved with the document, only the filename is stored within the
document.

Embed an Ole Position the cursor at the point at which to embed the object, and select the Insert | Ole
object in the text Object menu option. The Insert Object dialog displays, listing the applications that are
available to create the object.
When you select an application, the editor launches it and you create the required object
using this application. When you save the application, the editor inserts an icon that
indicates the inserted object. You can later edit the object using the application, by
double-clicking on the object.

Note:
You can also use the Edit | Paste Special 1589 menu option to import the OLE objects,
provided that the object is available in the clipboard.

Edit an Click on the picture and select the Edit | Edit Picture menu option. The Edit Current
embedded Picture Parameters dialog displays, through which you can change the width and height
picture of the picture, in inches. You can also align the top, bottom, or middle of the picture with
the base line of the text.

Edit an Double-click on the icon that indicates the inserted Ole object. Alternatively, position the
embedded Ole cursor on the icon and select the Edit | Edit Ole Object menu option. The editor opens
object the object in the application used to create it, and you can edit the object.

Insert a Select the Other | Background Picture menu option. A browser dialog displays,
background through which you select the bitmap or metafile file to insert as a background picture.
picture for the The picture occupies the entire text area.
text
To remove the background picture, deselect the Background Picture menu option.

Insert an RTF Position the cursor at the point at which to insert the file, and select the Insert | Insert
File RTF File menu option.

10.1.1.4.7.6 Character Formatting

When you change the format of existing text, any new characters you type immediately following automatically
assume the formatting characteristics of the existing text.

To Do this...

Apply character Highlight the text to which to apply the format, and use one or more of the following
format menu options or key combinations, as required:
· Font | Normal, or press [Alt]+[0]
· Font | Bold, or press [Ctrl]+[B]
· Font | Underline, or press [Ctrl]+[U]
· Font | Double Underline, or press [Ctrl]+[D]
· Font | Italic, or press [Ctrl]+[I]
· Font | Superscript, or press [Alt]+[4]
· Font | Subscript, or press [Alt]+[5]
· Font | Strike, or press [Alt]+[6] (puts a line through the text)
· Font | All Caps
· Font | Small Caps

Enterprise Architect User Guide

 Report Generation | RTF Documents 1593

To Do this...

To reset any character format, highlight the text and select the Font | Normal menu
option, or press [Alt]+[0].

Change font Highlight the text to change and select the Font | Fonts menu option, or press [Alt]+
typeface and [F10]. The Font Selection dialog displays, from which you select the required typeface
point size and point size. Click on the OK button.

Change Highlight the text to change and select the Font | Style menu option. The Select a Style
character style dialog displays, listing the currently-defined character styles in the template stylesheet
1600 .

Select the required style and click on the OK button.

Change the color Highlight the text to change and select one or more of the following options, as required:
of text, · Font | Text Color
background · Font | Background Color
(permanent · Font | Underline Color
highlight) or
underline In each case, the Color dialog displays, through which you can select or define the
required color. When you have selected a color, click on the OK button.

Change Normal character spacing is 20 Twips. If you want to change this (or return to it),
character highlight the text to adjust, and select the Font | Spacing menu option. The Character
spacing Spacing dialog displays.
Select the radio button to expand or compress spacing, or to return to normal spacing. If
you are changing from normal spacing, enter the number of Twips to set the spacing to.
Click on the OK button.

Hide text Hidden text is not displayed on the screen or printer, but remains in the document and is
not deleted.
Highlight the text to hide and select the Font | Hidden menu option, or press [Ctrl]+[H].
The highlighted text is not displayed and the rest of the text closes up.
To view hidden text, select the View | Hidden Text menu option. You can then make
the text normal again by highlighting it and deselecting the Font | Hidden menu option.

Box text Highlight the text to box and select the Font | Boxed menu option. This creates a
broken-line border around the selected text.

Insert a non- Move the cursor to the point at which to insert the non-breaking space and select the
breaking space Insert | Non-breaking Space menu option.

Insert a non- Move the cursor to the point at which to insert the non-breaking dash and select the
breaking dash Insert | Non-breaking Dash menu option.

Insert an Move the cursor to the point at which to insert the hyphen and select the Insert |
optional hyphen Optional Hyphen menu option.

10.1.1.4.7.7 Paragraph Formatting

The functions described below operate on the current paragraph, or on a highlighted 1589 block of text.

To Do this...

Clear all Select the Paragraph | Normal menu option. The editor pushes the paragraph back
paragraph up to the page margin.
formatting

Set text flow in To set the text flow for:

document
· A selected block of text, select the Paragraph | Text Flow menu option; the
Paragraph Text Flow dialog displays
· The entire document, select the Edit | Document Text Flow menu option; the

© 1998-2010 Sparx Systems Pty Ltd

 1594 Report Generation | RTF Documents

To Do this...

Document Text Flow dialog displays.

In either case, select the required text flow direction and click on the OK button.

Center text Select the Paragraph | Center menu option or press [Alt]+[8].

Right-justify text Select the Paragraph | Right Justify menu option or press [Alt]+[9].

Justify both sides Select the Paragraph | Justify Both menu option.
of text

Set double line Select the Paragraph | Double Space menu option. A double-spaced paragraph has
spacing a blank line between each text line.

Indent paragraph Select the Paragraph | Indent Left menu option or press [Alt]+[L]. Select the option
left again to increase the indent.

Indent paragraph Select the Paragraph | Indent Right menu option or press [Alt]+[R]. Select the option
right again to increase the indent.

Create hanging Select the Paragraph | Hanging Indent menu option or press [Alt]+[T]. Select the
indent option again to increase the indent of all lines below the first.

Keep paragraph Select the Paragraph | Keep Together menu option. The editor attempts to keep all
lines together lines within the paragraph on the same page.

Keep paragraph Select the Paragraph | Keep with Next menu option. The editor attempts to keep the
with next last line of the current paragraph and the first line of the next paragraph on the same
page.

Prevent 'widow' Select the Paragraph | Widow/Orphan Control menu option. The editor attempts to
and 'orphan' lines avoid having:
· the first line of the paragraph on the previous page ('widow' line)
· the last line of the paragraph on the next page ('orphan' line).
Start text on new Move the cursor to the point at which to start the new page, and select the Paragraph
page | Page Break Before menu option.

Insert border and Highlight the required text and select the Paragraph | Border and Shading menu
shading for text option. The Paragraph Box Parameters dialog displays, on which you specify which
block sides of the box to display (including a line between text lines), whether the lines are
thick or doubled, the degree of gray shading behind the text, and the color of the lines.

Define line Highlight the required lines and select the Paragraph | Paragraph Spacing menu
spacing option. The Paragraph Spacing Parameters dialog displays, on which you specify the
line spacing and the point spacing before and after lines.

Set a background Highlight a text string or block of text and select the Paragraph | Background Color
color for text menu option. The Color dialog displays, on which you select the background color.
space The editor highlights the full width of the page in that color, for the selected lines.

Create a bulleted Highlight the required lines of text and select the Paragraph | Bullet menu option. The
list editor formats the lines into a simple bullet list.

Create a Highlight the required lines of text and select the Paragraph | Numbering menu
numbered list option. The editor formats the lines into a simple numbered list.

Apply numbering Set up a numbering list and overrides 1601 (Edit | List and Overrides) and apply the
to paragraphs numbering levels 1603 to the template sections (Paragraph | List Numbering).

Apply a paragraph Select the Paragraph | Style menu option. The Select a Style dialog displays, listing
style from the the currently-defined paragraph styles in the template stylesheet 1600 .
template

Enterprise Architect User Guide

 Report Generation | RTF Documents 1595

To Do this...

stylesheet Select the required style and click on the OK button.

10.1.1.4.7.8 Tab Support

The RTF Style Template Editor supports left, right, center and decimal tabs. Tabs are very useful for creating
columns and tables. A paragraph can have as many as twenty tab positions.
A tab usually applies to every line of the current paragraph. However, if you highlight a block of text before
setting a tab, the tab then applies to every line in the highlighted text.
You can create tabs quickly and easily using the ruler at the top of the screen. To create a:
· Left tab, click on the required tab position on the ruler; the left tab is indicated on the ruler by an L shape.
· Right tab, right-click on the required tab position on the ruler; the right tab is indicated on the ruler by a
reversed L shape.
· Center tab, press [Shift] and click on the required tab position on the ruler; the center tab is indicated on
the ruler by an inverted T shape.
· Decimal tab, press [Shift] and right-click on the required tab position on the ruler; the decimal tab stop is
indicated on the ruler by an inverted T shape with a dot on the right hand side. This tab is for numbers with
a decimal point; numbers scroll left from the tab until you type a point, then numbers scroll right.
You can also set tabs using the Paragraph | Set Tab menu option, which displays the Set a Tab Position
dialog. This enables you to specify the tab type, and provides two advantages over the ruler: you can set the
tab position with more precision and with a clear value that you can duplicate; and you can add a tab leader
line (dot, hyphen, or underline).
· To clear a single tab position for selected text, select the Paragraph | Clear Tab menu option. The Clear a
Tab Position dialog displays, on which you select the tab to clear.
· To clear all tab stops for selected text, select the Paragraph | Clear All Tabs menu option.
· To move a tab position using the mouse, click on the tab symbol on the ruler and drag it to the new
position.

Note:
The Other | Snap To Grid menu option affects the movement of the tabs (and the paragraph indentation
markers) on the ruler. When you select this option, the movements of the tab markers are locked on to an
invisible grid at intervals of 1/16 inch (half a ruler division).

10.1.1.4.7.9 Page Breaks and Repagination

You can force a page break in the document by selecting the Insert | Insert Break | Page Break menu option,
or by pressing [Ctrl]+[Enter]. The forced page break is indicated by a solid line in the editing window.

If Page Mode is off, the editor also marks automatic page breaks when the text overflows a page; these are
indicated by a dotted line.
You can repaginate your document, using the Edit | Repaginate menu option. This updates the Page
Number and Page Count fields, and recompiles the table of contents.

You insert the Page Number and Page Count fields as follows:

To Do this...

Insert the page Position the cursor at the point at which to display the page number, and select the
number Insert | Page Number menu option. The page number is displayed in gray.

Insert the page Position the cursor at the point at which to display the total number of pages in the
count document, and select the Insert | Page Count menu option. The page count is
displayed in gray.

© 1998-2010 Sparx Systems Pty Ltd

 1596 Report Generation | RTF Documents

10.1.1.4.7.10 Headers and Footers

To Do this...

Edit the page header In Page Mode, select the Edit | Edit Page Header/Footer menu option. A paragraph
and footer text marker displays at the top and bottom of each page, and you can type in, format or
delete the appropriate text.
If Page Mode is turned off, all page headers and footers are displayed in a block at
the start of the document, with identifying labels. You can also edit the text here.
Each section in a document can have its own page header and footer.

Create the header In Page Mode, select the Edit | Edit Page Header/Footer menu option and then
and footer for the select the Edit | First Page Header/Footer | Create First Page Header or Create
initial page of the First Page Footer menu option. A paragraph marker displays at the top or bottom of
document the first page, and you can type in and format the appropriate text.
If Page Mode is turned off, all page headers and footers are listed in a block at the
start of the document, with identifying labels. You can also edit the text here.

Delete the header Whilst you can delete the first page header or footer text by simple editing, you must
and footer for the specifically delete the 'first page' assignment in order to display the header and
initial page of the footer text of the next section on the first page.
document In Page Mode, select the Edit | Edit Page Header/Footer menu option and then
select the Edit | First Page Header/Footer | Delete First Page Header or Delete
First Page Footer menu option. This removes the first page text and assignment,
and displays the next-defined header and footer text.

Create a footnote Move the cursor to the position at which to insert the footnote marker, and select
the Insert | Footnote/Endnote | Footnote menu option. The Footnote Parameters
dialog displays, on which you enter the footnote marker and footnote text, and select
whether to make the marker a superscript.
Click on the OK button. The editor inserts the footnote marker at the current cursor
location and, in Page Mode, displays the footnote text at the bottom of the page.

Edit footnote text Select the Edit | Edit Footnote/Endnote | Edit Footnote Text menu option. The
text of each footnote displays in the document text where its marker was inserted.
Locate the text and make the required changes. In Page Mode, the modified
footnote displays at the bottom of the page.
When you have finished editing footnote text, deselect the Edit | Edit Footnote/
Endnote | Edit Footnote Text menu option. The footnote text is no longer shown in
the document text.

Create an endnote Move the cursor to the position at which to insert the endnote marker, and select
the Insert | Footnote/Endnote | Endnote menu option. The Endnote Parameters
dialog displays, on which you enter the endnote marker and endnote text, and select
whether to make the marker a superscript.
Click on the OK button. The editor inserts the endnote marker at the current cursor
location and, in Page Mode, displays the endnote text at the end of the section or
document.

Edit endnote text Select the Edit | Edit Footnote/Endnote | Edit Endnote Text menu option. The text
of each endnote displays in the document text where its marker was inserted.
Locate the text and make the required changes. In Page Mode, the modified
endnote displays at the bottom of the page.
When you have finished editing endnote text, deselect the Edit | Edit Footnote/
Endnote | Edit Endnote Text menu option. The endnote text is no longer shown in
the document text.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1597

10.1.1.4.7.11 Hyperlinks and Bookmarks

To Do this...

Manage bookmarks Each template contains a number of bookmarks that mark the sections. You can
apply these bookmarks to related sections, create and assign your own, delete
those that are not required, and locate specific bookmarks in the document.
In Page Mode, select the Insert | Bookmark menu option. The Bookmark dialog
displays.
· To assign a bookmark to the current cursor position, either type a new
bookmark in the top field or select one from the list, and click on the Insert
button.
· To delete an existing bookmark, click on it in the list and click on the Delete
button.
· To mark a bookmark with the number of the page it is on, click on the bookmark
in the list and click on the Set Page Reference button.
· To locate a bookmark in the text, click on it in the list and click on the Go to
button.
Insert hyperlinks Right-click on the point at which to create the hyperlink and select the Insert |
Hyperlink context menu option. The Insert Hyperlink dialog displays. You can create
a hyperlink within an RTF document to an external document, Help topic or web
page.
In the Link Text field type the text to be hyperlinked, and in the Link Code field type
or paste the web page URL, help topic file or external file path and name.

Tip:
To capture the help topic file name, right-click on the displayed topic, select the
Properties context menu option, and copy the file name. When you insert the file
name in the Link Code field, ensure that the file name has the prefix $Help:/ /.

Click on the OK button.The hyperlinked text displays in the document. Double-click

on the link to display the web page or external document.

10.1.1.4.7.12 Table Commands

The Table menu enables you to create a new table, or to edit an existing table's attributes.

To Do This...

Insert a table in Position the cursor at the appropriate point, and select the Table | Insert Table menu
the document option. The New Table Parameters dialog displays, in which you specify the number of
table rows and columns.
The editor initially creates cells of equal width. You can, however, change the cell width
by dragging the cell borders using the mouse. When Page Mode is deselected, the table
structure is not visible.

Add a header Select the rows to act on, and then select the Table | Header Row menu option. Apply
row any heading settings and formatting to the rows in the highlighted block.

Insert a new Select the Table | Insert Row menu option.

row above the
current row

Insert a new Select the Table | Insert Column menu option.

column to the
left of the
current column

Merge cells Select the cells to merge and select the Table | Merge Cells menu option. The width of

© 1998-2010 Sparx Systems Pty Ltd

 1598 Report Generation | RTF Documents

To Do This...

the resulting cell is equal to the sum of the merged cells. You can merge cells across a
row, down a column, and in a block spanning both rows and columns.

Split a cell Select the cell to split and select the Table | Split Cell menu option. The selected cell is
split into two cells of equal width. Any text in the original cell is assigned to the first cell.
The second cell is created empty.

Delete cells Select the cells to delete and select the Table | Delete Cells menu option. The Delete
Table Cells dialog displays, on which you specify whether to delete:
· Cells - deletes the highlighted cells
· Columns - deletes all the cells in the highlighted column or columns
· Rows - deletes all the cells in the highlighted row or rows.
If you delete all cells in a table, the table itself is automatically deleted.

Position the Click on any part of the table and select the Table | Row Position menu option. The
table on the Table Row Alignment dialog displays, on which you select to left-align, center or right-
page align the table on the page.
This option has little effect if the table is wide enough to span the page or text column.

Set the height of Select the row to adjust and select the Table | Row Height menu option
a row, or all
The Row Height Parameters dialog displays, enabling you to set an automatic row
rows
height, a minimum row height, or an exact row height. You can apply the setting to the
selected rows only, or to all rows in the table.

Keep row text Select the rows to protect (preferably all rows in the table) and select the Table | Keep
together if it Row Together menu option. If the row continues over the end of the page, the whole
continues over row is moved to the top of the next page.
a page

Set text flow in Select the rows and select the Table | Row Text Flow menu option. The Table Text
rows Flow dialog displays, on which you select the direction of flow of the text and select to
apply the setting to the selected rows or all rows in the table.
This option also moves the whole row over to the appropriate side of the page or column.

Set the width of Select the cells to act on and select the Table | Cell Width menu option. The Set Cell
selected cells Width dialog displays, on which you set the cell width and text margin and apply them to:
· All cells in a highlighted block
· The selected cells only
· All cells in the selected column or columns, or
· All cells in the selected row or rows.
Define the cell Select the cells to act on and select the Table | Cell Border Width menu option. The Set
border width Cell Border dialog displays, on which you set the width of the line at any or all of the top,
bottom, left and right of a cell, or whether to draw a uniform border around the cells. You
can also set the text margin, and apply all the settings to:
· All cells in a highlighted block
· The selected cells only
· All cells in the selected column or columns, or
· All cells in the selected row or rows.
Define the cell Select the cells to act on and select the Table | Cell Border Color menu option. The Set
border color Cell Border Color dialog displays, on which you set the color of the line at any or all of
the top, bottom, left and right of a cell, or whether to have a uniformly colored border
around the cells. You then apply the settings to:
· All cells in a highlighted block
· The selected cells only
· All cells in the selected column or columns, or

Enterprise Architect User Guide

 Report Generation | RTF Documents 1599

To Do This...

· All cells in the selected row or rows.

Define the cell Select the cells to act on and select the Table | Cell Shading menu option. The Cell
shading Shading Parameters dialog displays, on which you set the shading percentage. The
value 0 indicates the palest background, whereas the value 100 indicates a black
background. You then apply the setting to:
· All cells in a highlighted block
· The selected cells only
· All cells in the selected column or columns, or
· All cells in the selected row or rows.
Define the cell Select the cells to act on and select the Table | Cell Color menu option. The Cell Color
background Parameters dialog displays, on which you set the cell background color. You then apply
color the color to:
· All cells in a highlighted block
· The selected cells only
· All cells in the selected column or columns, or
· All cells in the selected row or rows.
Vertically align Select the cells to act on and select the Table | Cell Vertical Align menu option. The
cells Cell Vertical Alignment dialog displays, on which you select to align the selected cells by
top, center, bottom or baseline. You then select to align:
· All cells in a highlighted block
· The selected cells only
· All cells in the selected column or columns, or
· All cells in the selected row or rows.
Rotate cell text Select the cells to act on and select the Table | Cell Rotate Text menu option. The Cell
Text Rotation dialog displays. On which you select to display text horizontally across the
cell, vertically up the cell, or vertically down the cell. You then select to apply the rotation
to:
· All cells in a highlighted block
· The selected cells only
· All cells in the selected column or columns, or
· All cells in the selected row or rows.
Select column Click on a cell and select the Table | Select Current Column menu option. The whole
column is highlighted and selected for further formatting.

Show / hide Click on a table cell and select the Table | Show Gridlines menu option. This displays
table outline or hides the grid lines around the table cells. The grid lines are for display purpose only
and do not appear on the printed document.

10.1.1.4.7.13 Sections and Columns

The editor enables you to divide a document into multiple sections. A multiple section document is useful to:
· Vary the page margins from one page to another
· Create multiple columns of text.

To Do this...

Create a new section Select the Insert | Insert Break | Section Break menu option. This creates a new
section on a new page.

Note:
This option is not available when Edit | Edit Page Header/Footer is active.

© 1998-2010 Sparx Systems Pty Ltd

 1600 Report Generation | RTF Documents

To Do this...

Edit the section Select the Edit | Edit Section menu option. The Section Parameters dialog
parameters displays. Define:
· The number of columns and column spacing; text in a multiple column section
wraps at the end of the column. When the text reaches the end of the page, it
resumes in the next column. When Page Mode is off, the page contains a
single very thin and long column. When Page Mode is on, the correct column
layout is shown.
· The orientation - Portrait or Landscape
· Whether to start the new section on the next page
· The direction of text flow
· Any special printing characteristics for the section.
You can also define any special page margins by selecting the File | Page Layout
1588 menu option.

Delete a section break Move the cursor onto the section break line and press [Delete].

Create a column Move the cursor to the appropriate point in the text and select the Insert | Insert
break Break | Column Breakmenu option.
Normally in a multiple column section, the text flows from the end of one column to
the top of the next column. A column break forces the text to the next column
before the current column is completely filled.
A column break is indicated by a line with a 'dot and dash' pattern. To delete the
column break, simply position the cursor on the column break line and press
[Delete].

10.1.1.4.7.14 Stylesheets and Table of Contents

The editor supports Character and Paragraph-type stylesheet style items. The Character stylesheet style
constitutes a set of character formatting attributes and is applied to a character string. The Paragraph
stylesheet style constitutes both a set of character formatting attributes and a set of paragraph formatting
attributes, and is applied to one or more paragraphs.
You can also include special, structured text in the document, such as page number 1595 , date and time and
text input fields.

To Do this...

Use double-byte Select the Edit | Inline Ime menu option. This enables you to enter double-byte
characters characters without using an external IME application

Create and edit Select the Edit | Edit Style menu option. The Edit Stylesheet dialog displays.
styles
Select the appropriate radio button to define a character style or a paragraph style.
Either select an existing style to modify from the list box, or type in a name for a new
style. Click on the OK button to begin recording the style properties. You can use the
ruler, toolbar or menu selections to modify the style items. These also reflect the
currently-selected properties for the stylesheet item. Please note that the paragraph
properties are enabled only for the paragraph stylesheet items.
After you have defined the required style, either select the Edit | Edit Style menu
option again or click anywhere in the document. If you modified an existing stylesheet
item, the document automatically reflects the updated style. If you created a new
stylesheet item, you can apply the style to highlighted text by selecting the Font | Style
or Paragraph | Style menu options.

Apply character Select the Font | Style menu option to apply a stylesheet style to a highlighted
styles character string.

Apply paragraph Select the Paragraph | Style menu option to apply a stylesheet style to a highlighted
styles paragraph or range of paragraphs.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1601

To Do this...

Insert a table of Create and apply the required heading styles using the Edit | Edit Style menu option,
contents as above.
Move the cursor to the point at which to insert the table of contents and select the
Insert | Table of Contents menu option.
The table of contents is automatically updated whenever repagination 1595 occurs.

Insert date and Move the cursor to the point at which to insert the current date and time, and select
time fields the Insert | Date and Time menu option. The Insert Current Date/Time dialog
displays, from which you select the required date and time format.
The date and time are automatically updated whenever the page text is refreshed.

Insert your own Not Supported In The Enterprise Architect RTF Generator.
data fields
Move the cursor to the point at which to insert the data field and select the Insert |
Data Field menu option. The Data Field Parameters dialog displays, in which you
enter the field name and data value.

Insert a text entry Move the cursor to the point at which to insert the text entry field and select the Insert |
field Text Input Field menu option. The Input Field Parameters dialog displays, in which
you enter the field name, initial value, maximum field length and text font, and specify
whether or not the field has a border.

Insert a selectable Move the cursor to the point at which to insert the checkbox and select the Insert |
checkbox Checkbox Field menu option. The Checkbox Field Parameters dialog displays, in
which you enter the field name, whether it defaults to selected, and the size of the box
surrounding the check.

Define level Select the Edit | List and Overrides menu option, set up the numbering list and the
numbering in list overrides 1601 , then apply the numbering list to the headings set for packages and
generated elements, using paragraph numbering.
document

10.1.1.4.7.15 User-Defined Section Numbering

You might want to define the numbering format for the section levels in your generated RTF document.
For example:
1. Package level 1
1.1 Package level 2 (child package)
1.1.1 Element Level 1
1.1.1.1 Element (child element)

To define the numbering format you first create a numbering list and then create a set of list overrides for this
list. The overrides must also have the initial 1.0.0 setting altered to 1.1.1. You can then apply the numbering
list to the headings set for packages and elements, using paragraph numbering.
(See Section Numbering in Virtual Documents 1623 for further information on applying continuous section
numbering throughout a Virtual Document 1616 .)

Procedure
To define the numbering format, follow the steps below.
1. In the Template Editor, select the Edit | List and Overrides | Create List Item menu option. The List
Properties dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1602 Report Generation | RTF Documents

2. In the List Name field, type a name for the list. Click on the OK button to close the dialog.
3. Select the Edit | List and Overrides | Create List Override menu option. The List Override Properties
dialog displays.

4. In the List to Override field, type or select the name of the list you have just created. Click on the OK
button to close the dialog.
5. To set the list level properties for each level, select the Edit | List and Overrides | Edit List Level
menu option. The List Level Properties dialog displays.

6. To set the first level numbering (used in the Package Section), select the List override radio button and
type or select the list override item you have just created.
7. Ensure that the List Level field is set to 1 (for Packages) and the Number text field is set to ~1~. Click
Enterprise Architect User Guide
 Report Generation | RTF Documents 1603

on the OK button to save the values and close the dialog.

8. Open the dialog again (Edit | List and Overrides | Edit List Level) and set:
· List Level to 2 (for the Element Section or Child Package Section, for example)
· Start at to 1 (to ensure that numbering at this level begins at 1.1 rather than 1.0).
9. Click on the OK button to close the dialog and save the changes.
10. Repeat steps 5 to 9 as required, incrementing the list level number and resetting Start at to 1 each
time.

Use Numbering Levels

To apply the numbering levels you have defined (above), follow the steps below:
1. In the Content window of the Template Editor, select the first item of text to be numbered (for example,
Package).

2. Set the text style, using the style drop-down field in the Template Editor toolbar.

3. Click on the Paragraph | List Numbering menu option. The Apply paragraph numbering using Lists
dialog displays.

4. Select the required Numbering List and Override, and set the Level field to the required level (1, for the
top level). Click on the OK button to close the dialog, and check that the required level has been applied
to the selected text.

5. Repeat steps 1 to 4 for the next level (Element), but at step 4 change the Level field to 2.

© 1998-2010 Sparx Systems Pty Ltd

 1604 Report Generation | RTF Documents

6. Continue applying the overrides for lower section levels as necessary, then save the template and
generate your RTF report. The output should now resemble the following example:

10.1.1.4.7.16 Frames and Drawing Objects

A frame is a rectangular area that can contain both text and pictures on the page. The text outside the frame
flows around it. A drawing object can be a text box, rectangle or a line. The drawing object overlays the text
around it. You can see frames and drawing objects only if View | Page Mode is selected. However, the
content of a frame or text box is still visible if Page Mode is deselected.

To Do this...

Embed a frame or Select the Insert | Frame or Insert | Drawing Object menu option.
drawing object at the
cursor position

Insert text into the Click inside the outline and type the text at the cursor position.
frame or drawing
object text box

Rotate text to display Select the Edit | Edit Frame/Drawing Object | Rotate Text menu option and select
it down the side of the the text direction.
frame or text box

Insert a picture into a Copy the picture, click inside the outline and paste the picture at the cursor position.
frame or drawing
object text box

Size a frame or Click inside the outline, click on a sizing tab on the outline and drag the tab to the
drawing object required position.
If the frame or text box contains only a picture, the picture size is automatically
adjusted to fill the outline. Any text inside the outline is automatically wrapped to
adjust to the new width.
In a frame the frame height is automatically adjusted, if necessary, to enclose all

Enterprise Architect User Guide

 Report Generation | RTF Documents 1605

To Do this...

lines. In a text box, you must adjust the height manually to enclose the text.

Move the frame or Click inside the outline and then move the cursor just outside the outline so that the
drawing object cursor changes to a plus-shape. Drag the plus shape (and hence the outline) to the
new location.

Edit the relationship Click on the outline and select the Edit | Edit Frame/Drawing Object | Vertical
between a frame or Base Position menu option. Select the point to lock the outline to. Outlines locked
drawing object and a to the top of the page or the top of the margin retain their vertical position when you
point on the page (the insert text before them.
vertical base position)

Edit the border and Select the Edit | Edit Frame/Drawing Object | Edit Drawing Object menu option.
the background of a On the Line and fill attributes dialog, select the options for the preferred border, line
drawing object color, fill color and wrapping effect on the template text.

Delete a frame or Click on the outline and press [Delete]. The editor prompts you to confirm the
drawing object deletion. Click on the OK button. Note that the deletion is actually reversible - press
[Ctrl]+[Z] or select the Edit | Undo menu option.

10.1.1.4.7.17 Search and Replace Commands

The first three menu options below all invoke the Search String Parameters dialog, if no search term has been
defined.

Specify the term to search for, whether to search from the start of the file or forwards or backwards from the
current cursor position, and whether the search should exactly match the case of the search term.

To Do this...

Search for a text Select the Other | Search menu option, or press [F5]. The Search String
string Parameters dialog displays.
The editor searches for the first instance of the specified character string as defined
by the parameters.

Find the next Select the Other | Search Forward menu option, or press [Ctrl]+[F]. The editor
instance of a searches forwards for the next instance of the specified text string in the file, and
previously-defined highlights it.
text string in the file

Find the previous Select the Other | Search Backward menu option, or press [Ctrl]+[Shift]+[F]. The
instance of the editor searches backwards for the previous instance of the text string in the file, and
previously-defined highlights it.
text string in the file

Replace a text string Select the Other | Replace menu option, or press [F6].
The Replace String Parameters dialog displays, in which you specify the text string
to locate and the text string to replace it with, whether to search the whole document
or a highlighted block of text, and whether to confirm each replacement before

© 1998-2010 Sparx Systems Pty Ltd

 1606 Report Generation | RTF Documents

To Do this...

making the change.

10.1.1.5 Import RTF Template

Enterprise Architect provides a number of RTF document templates, and enables you to create others.
However, you might already have corporate formats and templates in use in your organization, so Enterprise
Architect also enables you to import existing templates into the RTF Generator.
To import an external template, follow the steps below:
1. Save the external template as an RTF document.
2. In Enterprise Architect, create a new blank template 1577 . Name the template but do not specify an
existing template to copy from.
3. When the template is listed on the Templates tab of the Generate RTF Documentation dialog, click on
the name and click on the Edit button. The RTF Document Template Editor dialog displays.
4. Select the File | Import menu option. The Microsoft Word file Open dialog displays.
5. Locate your template RTF file, and click on the Open button. The Open dialog closes, returning you to
the Document Template Editor dialog. This now contains your imported template.
6. Select the File | Save menu option. If necessary, make any changes 1587 to the template and select File
| Save again before selecting File | Close to exit the dialog.

Note:
Standard graphical images (such as a logo in the header, main text or footer) are imported. However, any
Word-based meta-file graphics are not imported.

You can select the new template to use in generating an RTF document, either on the Generate RTF
Documentation 1570 dialog or in a Master Document 1618 or Model Document 1619 element.

10.1.1.6 Resource Documents

The Resource Document feature enables a particular documentation configuration to be 'remembered', linking
the loaded template within the Generate RTF Documentation dialog to the current highlighted package. If a
particular template is always used with a specific package, and multiple cases of documentation exist to be
propagated, saving these as Resource Documents can ease document generation later.

Note:
Resource Documents, saved into the Resources window, save only the package, output file destination and
template name from the Generate tab of the Generate RTF Documentation 1573 dialog. They do not retain the
RTF data separately defined in the Options, Advanced 1607 and Element Filter 1611 tabs of the dialog.
To save and re-use the options data, edit the template directly in the template editor and use the File |
Document options 1588 option to set the values as part of the template.

To create and use Resource Documents, follow the steps below:

1. Open the Generate RTF Documentation dialog. 1570

2. Click on the Resource Document button. The Save current as document definition dialog displays:

3. In the Enter Value field, type a name for the document and click on the OK button. The document is
added to the Resources window for easy future access (as for the usecasedoc entry in the illustration
below).

Enterprise Architect User Guide

 Report Generation | RTF Documents 1607

4. To generate documentation from the Resources window, right-click on the required document. The
context menu displays.
5. Select the required option.
The context menu options are:
· Open Document - Opens the corresponding .RTF file, as specified by the RTF template Filename property
· Generate Document - Opens the Generate RTF Documentation dialog, loaded with the specified template
· Auto Generate Document - Generates documentation, with the document located at the path specified by
the template's Filename property
· Delete Document - Removes the specified document.

Batch Generate Resource Documents

To generate a number of RTF documents at the same time, right-click on the RTF Documents folder name
and select the Generate Documents context menu option. The Batch Document Generation dialog displays.

The dialog lists all resource documents in the RTF Documents folder, defaulted to selected. Deselect the
checkbox against each document that you do not want to generate (or click on the Deselect All button to clear
all selections, then select those you require). Click on the OK button to generate each of the remaining reports
into their respective target file locations.
The Generate All Documents context menu option automatically generates every document in the RTF
Documents folder, without displaying the Batch Document Generation dialog.

10.1.1.7 Document Options

The RTF report options enable you to set type filters and order the elements. You can access the options from
two different places; the start point affects the persistence of options selected:
1. If you access the options on the Options and Advanced tabs of the Generate RTF Documentation 1573
dialog, you can define settings for the current report to be run. Selections are non-persistent, and are

© 1998-2010 Sparx Systems Pty Ltd

 1608 Report Generation | RTF Documents

reset when you exit the dialog or select a different template.

2. If you access the options by clicking on the File | Document Options 1588 menu option on the RTF Style
Template Editor 1578 dialog, the settings are saved with the template as the default settings for any run
of this report; the Document Options dialog provides the options from both of the Options and
Advanced tabs of the Generate RTF Documentation dialog, plus the Element Filters 1611 and Other
Filters 1612 tabs, with three minor differences 1610 .
The Options tab of the Generate RTF Documentation dialog has the following fields:

Option Use to

Filter

Only include objects Filter elements according to date created or modified. In the first two fields,
select the qualifiers from the drop-down lists. In the third field, select the
appropriate date.

Where Package Phase Filter elements according to the value of the Package Phase field. In the first
field select the qualifier, and in the second type the required phase (or leave
the default value All).

With element status Filter elements according to status. In the first field, select the qualifier (like,
not like, in, not in) and in the second field type the value to be used. Values
should be enclosed in quotes; for example: "Proposed". If you type more than
one value, separate them with a comma; for example: "Proposed",
"Implemented".

Connector Direction Filter connectors according to direction.

If you select Both, the connector is documented twice; once for the source
element and once for the target. For the remaining two values, the connector
is documented only for the source or target element, as appropriate.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1609

Option Use to

Order

Packages by Order packages in the generated documentation in either ascending or

descending order of Name, Tree Order, Modified Date or Created Date.

Elements by Order elements in the generated documentation in either ascending or

descending order of Name, Tree Order, Modified Date or Created Date.

Diagrams by Order diagrams in the generated documentation in either ascending or

descending order of Name, Tree Order, Modified Date or Created Date.

Exclude details for Exclude all elements of the selected type or types from the generated
document.

Exclude connector type Exclude all connectors of the selected type or types from the generated
document.

The Advanced tab of the Generate RTF Documentation dialog has the following fields:

Option Use to

Hide 'note-less' elements Exclude all elements without notes from the documentation.

Diagram Format Set the diagram format for the images included within the documentation to
either Metafile or Bitmap.

Skip root package Exclude the parent package from the documentation and include only the
child packages.

© 1998-2010 Sparx Systems Pty Ltd

 1610 Report Generation | RTF Documents

Option Use to

No bookmarks Stop RTF bookmarks being inserted into the generated document.

Adjust Heading Levels Enable the RTF Generator to automatically restrict the levels of heading
generated for nested sub-packages in a document.
The generator reproduces heading levels down to the value you set. For
example, if you have four nested levels of sub-packages and you set this field
to:
· Heading 2, all sub-packages in the report are documented under level 2
headings.
· Heading 4, the first level of subpackages are documented under level 2
headings, the next level under level 3 headings, and the remainder all
under level 4 headings.
· Heading 6, the first level of subpackages are documented under level 2
headings, the next level under level 3 headings, the next under level 4
headings, and the next under level 5 headings. If you added further levels
of sub-package they would all be documented under level 6 headings.
The field defaults to Heading 9 to accommodate the maximum number of
levels of nested subpackages.

Hide <Anonymous> Hide anonymous elements in the documentation.

elements

Use style defined in Change where the style definition for Notes is drawn from, so that you use
template for notes the style for notes that is defined in your template, instead of the RTF style
applied in the element Notes field.
If you use this option, you should have a style for notes defined in your
template, otherwise the Notes text is printed in the default font with no
formatting.

Disable large OLE file Disable support for large Object Linking and Embedding (OLE) files.
support

Insert page breaks when Insert a page break after each Model Document in a Master Document 1616 .
generating a Master
Document

Switch generator Switch from this Generate RTF Documentation dialog (the Enhanced
Template Driven Generator) to the Rich Text Format Report dialog 1628
(Legacy Generator).

Note:
This button is not available if you displayed the dialog from the Element List
or Model Search.

The Document Options dialog provides both sets of options, except for:
· The Switch generator button
· The Disable large OLE file support option
· The Insert page breaks when generating a Master Document option.
The dialog also contains the Optimize for Open Office option, as described for the Generate RTF
Documentation 1573 dialog, and tabs for setting Element Filters 1611 and Other Filters 1612 .
Click on the OK button to save your changes.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1611

10.1.1.8 Element Filters

The Element Filters tab enables you to define a set of filters to restrict your report to specific elements. If an
element does not have the defined characteristic, it is not reported.
As with the Document Options tabs, you can access the filter details from two different places; the start point
affects the persistence of the filter definition.
1. If you define the filters on the Element Filters tab of the Generate RTF Documentation 1573 dialog, you
can create filter settings for the current report to be run. Selections are non-persistent, and are reset
when you close the dialog or select a different template.
2. If you access the filter definitions by clicking on the File | Document Options 1588 menu option on the
RTF Style Template Editor 1578 dialog, the settings are saved with the template as the default settings
for any run of this report.
You add filters by clicking on the Add Filters 1242 button. To edit the filters, either double-click on the panel
contents or click on the Edit Filter button, to display the Edit Filters dialog. The format is the element field
name, the conditions placed on the field value, any actual value or delimiting value to search on, and whether
the filter item is required (mandatory).

The fields and options on this dialog are described below.

Column/Button Use to

Search In Select the type and name of each element field to search on.

Condition 1243 Select the condition of the search parameter. The available options are
Contains, Equal To, Not Equals and One Of.

Look For 1243 Specify the search term to perform the conditional search on. This value can
pertain to the selected element field. For example, the value could be a date
for DateCreated or a text value for other fields. The search term can contain
multiple values, separated by commas.

© 1998-2010 Sparx Systems Pty Ltd

 1612 Report Generation | RTF Documents

Column/Button Use to

Required Indicate that the search results must include elements with your search term in
that field. You select these checkboxes on the Add Filters 1242 dialog

Important:
The fields listed as filters have an OR relationship when no Required
checkboxes are selected; that is, if the search term is found in any one of
those fields, then the element is displayed.
Any field having the Required checkbox ticked overrides fields where the
Required checkbox is not ticked.

Element Features Specify whether element features are optional or required. These appear as a
new branch underneath the root element term in the Search In column.
- Optional
If you scroll down the Search In column, you see sub-branches such as
- Required Attribute, Change and Custom Property. These are the element features.
You can add these features by clicking on the Add Filter button. The Add
Filters dialog displays, with a list of all the filters you can choose for an
element or element feature. Click on the Search On drop-down arrow to see a
list of the element features you can search on. Each feature has its own set of
filters such as Name, Notes and Alias, which you can add to your search. To
search on an element attribute name, you would add the Attribute feature with
a Name filter to your search.
The Optional radio button enables you to generate a list of elements that
meet one of the element features (Element Type = Object), or one of the
feature filters (Attribute Name = Class1). For example, if your search is:
Element Name = Class11, Attribute Name = m_Att1 or Scope = Public
the search results would list all the elements that have the name of Class11
and all the elements that have an Attribute Name of m_Att1 or a Scope of
Public.
The Required radio button enables you to generate a list of elements that
must have the element features you have added. For example, if your search
is:
Element Name = Class, Attribute Name = m_Att1 or Scope = Public
you would get elements that must have the name of Class AND an Attribute
with a name of m_att1 or a Scope of Public.

Add Filter Add a new set 1242 of parameters to filter the search on.

Edit Filter Open the Edit Filters dialog, which enables you to change the search
parameters.

Remove Filter Remove the selected filter from the search.

10.1.1.9 Other Filters

The Other Filters tab enables you to define a set of filters to restrict your report to specific features of elements
(sub-element components such as attributes, responsibilities or constraints). If the feature does not have the
defined characteristics, it is not reported for the element.
As with the Document Options tabs, you can access the filter details from two different places; the start point
affects the persistence of the filter definition.
1. If you define the filters on the Other Filters tab of the Generate RTF Documentation 1573 dialog, you can
create filter settings for the current report to be run. Selections are non-persistent, and are reset when
you close the dialog or select a different template.
2. If you access the filter definitions by clicking on the File | Document Options 1588 menu option on the
RTF Style Template Editor 1578 dialog, the settings are saved with the template as the default settings
for any run of this report.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1613

You add filters by clicking on the Add Filters 1242 button. To edit the filters, either double-click on the panel
contents or click on the Edit Filter button, to display the Edit Filters dialog. The format is the feature field
name, the conditions placed on the field value, the actual value or delimiting value to search on, and whether
the filter item is required (mandatory).

The fields and options on this dialog are described below.

Column/Button Use to

Search In Select the name of each feature field to search on.

Condition 1243 Select the condition of the search parameter. The available options are
Contains, Equal To, Not Equals and One Of.

Look For 1243 Specify the search term to perform the conditional search on. This value can
pertain to the selected field. For example, the value could be a date for
DateCreated or a text value for other fields. The search term can contain
multiple values, separated by commas.

Required Indicate that the search results must include elements with your search term in
that field. You select these checkboxes on the Add Filters 1242 dialog.

Important:
The fields listed as filters have an OR relationship when no Required
checkboxes are selected; that is, if the search term is found in any one of
those fields, then the element is displayed.
Any field having the Required checkbox ticked overrides fields where the
Required checkbox is not ticked.

Add Filter Add a new set 1242 of parameters to filter the search on.

© 1998-2010 Sparx Systems Pty Ltd

 1614 Report Generation | RTF Documents

Column/Button Use to

Edit Filter Open the Edit Filters dialog, which enables you to change the search
parameters.

Remove Filter Remove the selected filter from the search.

10.1.1.10 Project Constants

The Project Constants tab enables you to add values for your own project-specific fields in a report, to be
inserted during compilation. The fields can be inserted into any template, in the text, headers or page headers
and footers, using the RTF Style Template Editor context menu 1586 .

Option Use to

Add Add a new field and value to the list. A prompt displays for the two data items.

Delete Remove the selected field from the list. A prompt displays to confirm the deletion.

Import Import a set of fields from an external XML file. A browser displays to select the source file
and location.

Export Export all fields to an external XML file. A browser displays to specify the target file and
location.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1615

10.1.1.11 Word Substitution

The Word Substitution tab of the Generate RTF Documentation dialog enables you to define translations of
technical terms used in Enterprise Architect, in particular field names, into a language other than English for
direct substitution into RTF documentation.

To add a translation for a term:

1. Double-click on the term in the English column in the Word Substitution List; the Enter Value field
displays.

2. Type the foreign language translation in the Enter Value field, and click on the OK button.

10.1.1.12 Language Substitution

The Codepage tab of the Generate RTF Documentation dialog enables you to define languages other than
English for direct substitution into RTF documentation.
If you export RTF-format documents from Enterprise Architect in languages other than English, you can
customize the codepage, default language ID and character set that Enterprise Architect uses when
generating RTF. This makes it much easier to generate documentation appropriate to your country or locale.

© 1998-2010 Sparx Systems Pty Ltd

 1616 Report Generation | RTF Documents

To define the language substitution, follow the steps below:

1. From the drop-down lists in the Language, Codepage and Charset fields, select the language,
codepage and character set that most closely match your location.
2. If required, modify the Substitute Tag by double-clicking on each and manually setting the value (for
advanced use only).
3. To clear the substitution list, double-click on each item in turn and delete the substitute value.
Now when you generate RTF documents, the substitute tags are used in the output.

Note:
You can transport these tag definitions between models, using the Export Reference Data 223 and Import
Reference Data 225 options on the Tools menu.

10.1.2 Virtual Documents

Virtual documents enable you to structure and filter your RTF reports by selecting, grouping and ordering
individual packages independent of the organization of the Project Browser. You can create separate virtual
documents defining, say, Requirements, Use Cases or Design elements of a project, or you can combine
these separate reports - retaining their own different formats - into a single generated document with common
headers and footers and a central contents list. This combined document could apply your corporate
standards.
You generate virtual documents in Enterprise Architect from individual Model Document 1619 elements. You
can also, if required, combine several Model Documents under a Master Document 1618 package element.
Each Model Document element identifies its own template; for example, a specifically-designed Requirements
template for a Requirements document, or a Use Case template for a section on Use Cases. The template is
identified in a Tagged Value, and defines the content as either:
· A list of packages (defined as attributes) in whatever order or combination is most appropriate to your
requirements - you can easily add 1620 or delete 1621 packages as necessary; or
· A standard model search (defined as Tagged Values) created within the Model Search 1235 facility - note
Enterprise Architect User Guide
 Report Generation | RTF Documents 1617

that diagram searches are not supported; when you generate the document, this search captures the
required data throughout the model, and populates the document.

Notes:
· In a Model Document, you should not define both a list of packages and a search; if both are present,
when you generate the document Enterprise Architect works from the package list only.
· You cannot use RTF Bookmarking 1639 in Master Document elements, which effectively replace RTF
Bookmarking in Word.

RTF Bookmarking requires each bookmark to be unique. When you generate a report with a standard RTF
template (including in a single Model Document element), each bookmark is unique and there is a 1:1
association between the Elements-details being generated and the elements in the repository. As Master
Documents are intended to contain multiple sub-documents, the association ceases to be 1:1. There is no
simple method that enables the generated data to be uniquely identified directly in association with the
original element.

You can control the sequence in which information is presented in the document; see the Document Order 1622

topic.

Tip:
You can create as many Model Documents as required, for as many combinations of information as required.

The Master Document element contains its own template Tagged Value, which defines the headers, footers
and central contents list. You can import your corporate standards template 1606 and edit the Tagged Value to
identify that.

Tip:
The template in the Master Document overrides the templates in the Model Documents. For example,
headers and footers in the Master Document template override any header and footer definitions in the Model
Document templates. This enables you to apply consistent and continuous styles and page numbering
throughout the report generated through the Master Document.
If you want the Model Documents to have their own styles, applied through their own RTFTemplate Tagged
Values, either leave the Master Document RTFTemplate Tagged Value blank (for completely separate overall
styles) or remove the definition of specific styles from the Master Document template.

Document Elements
The Master Document and Model Document elements are available from the Documentation page of the
Toolbox; on the Toolbox, select More Tools | Documentation. (This Toolbox page also provides the
Document Artifact 819 element, used for linked documents.)

When you drag the Master Document and Model Document elements onto a diagram, the following symbols
display, respectively:

© 1998-2010 Sparx Systems Pty Ltd

 1618 Report Generation | RTF Documents

10.1.2.1 Create Master Document

Whilst you can create Model Document elements separately and generate individual documents from each
one, you have added flexibility and scope if you organize Model Documents under a Master Document. You
can generate a document with a corporate template 1606 for the covers, contents, headers and footers, whilst
each section (generated from a separate Model Document) has its own appearance defined by a template
appropriate to the section content.
To create a Master Document element, follow the steps below:
1. Open or create the diagram in which to create the Master Document.
2. In the Toolbox, select More Tools | Documentation.
3. Drag the Master Document icon onto the diagram. The system prompts you for the name of the Master
Document.
4. Type the element name and click on the OK button. The system creates the Master Document element
and a child Custom diagram of the same name.
5. Open the Tagged Values window (View | Tagged Values) and click on the Master Document element.
The RTFTemplate Tagged Value displays in the window.

6. The RTFTemplate Tagged Value defaults to (model document: master template). If you want to use an
alternative master template, click on the drop down arrow at the right of the field and click on that
template in the list.
7. Return to the Project Browser and open the Master Document child diagram.
At this point, you create the Model Document 1619 elements in the child diagram, to provide the content for the
generated document.
When you have added all your Model Document elements to the Master Document diagram, the Master
Document element resembles the following:

Enterprise Architect User Guide

 Report Generation | RTF Documents 1619

Your completed Master document element and child diagram display in the Project Browser as shown below:

10.1.2.2 Create Model Document

You can create as many Model Document elements as are necessary to provide the sections of your
generated document (under a Master Document) or to provide the independent documents you require.
To create a Model Document element, follow the steps below:
1. Open the Master Document child diagram 1618 or (if you are creating independent Model Documents)
create a new diagram.

Tip:
The new diagram can live anywhere outside the packages you are adding to the document; you could
create a Class diagram called Documentation within a specific Documentation package, and use this
to hold the independent Model Document elements for your virtual documents.

2. From the Documentation page of the Toolbox (More Tools | Documentation) drag the Model
Document icon onto the diagram to create a new Model Document element. Give the element an
appropriate name: for example, if the documentation is relevant to the shopping cart requirements of a
model, you could call it ShoppingCartReqDocumentation. Click on the OK button.
3. Open the Tagged Values window (View | Tagged Values) and click on the Model Document element.
The RTFTemplate, SearchName and SearchValueTagged Values display in the window.
4. Click on the drop-down arrow to the right of the RTFTemplate field, and click on the template to use for
this Model Document.
5. If you are creating a list of packages for the Model Document, go now to Add Packages to Model
Document 1620 . Otherwise, click on the drop-down arrow to the right of the SearchName field, and click
on the model search type to populate this Model Document.

© 1998-2010 Sparx Systems Pty Ltd

 1620 Report Generation | RTF Documents

Notes:
· Diagram Searches are not supported.
· Custom SQL searches are supported if they are returning elements. The SQL must include 1239

ea_guid AS CLASSGUID and the object type.

6. If necessary, type a search term in the SearchValue field.

7. Create further Model Document elements as required.
Your Model Document element appears in the Project Browser with a Class icon, as shown below:

When you have created all the required Model Document elements, see the Document Order 1622 topic.

10.1.2.3 Add Packages to Model Document

To add packages to your Model Document element, follow the steps below. As the example Model Document
element here is called ShoppingCartDocumentation, the steps indicate how to add shopping cart-related
packages to the element.
1. Keeping the documentation diagram open, find a package in the Project Browser to add to the
documentation. For example, a Resources package in a Dynamic view.

2. Drag and drop the package from the Project Browser onto the Model Document element as shown
below:

Enterprise Architect User Guide

 Report Generation | RTF Documents 1621

3. The title of the package displays in the Model Document element in the Attributes compartment, as
shown below:

4. This means that the Resources package is included in the document when you generate it. Using the
above method, you can add as many packages from as many different views as required.
The next step is to generate your document 1623 , but consider the impact of your package list on the Document
Order 1622 . You can also delete packages 1621 if required.

10.1.2.4 Delete Package in Model Document

You can delete a package from your Model Document element.
This example includes four packages:
· Resources Package
· Activity Diagram Package
· View Cart Package
· Sequence Diagram Package.

To delete a package from a Model Document element, follow the steps below:
1. In the Project Browser, expand the element to list the package attributes.
2. Right-click on the package to delete, and select the Delete Attribute context menu option.
Alternatively:
1. In either the Project Browser or the diagram, right-click on the Model Document element and select the
Attributes context menu option. The Attributes dialog displays.
2. On the Attributes list, click on the package to delete.

© 1998-2010 Sparx Systems Pty Ltd

 1622 Report Generation | RTF Documents

3. Click on the Delete button to remove the package from the document element.

10.1.2.5 Document Order

The order in which information is compiled into an RTF document depends on:
· The sequence of Model Document elements in a Master Document element
· Whether you define a Model Search in a Model Document element
· Whether you define a package list in a Model Document element.
When you have considered and, if necessary, amended the order in which information is compiled, you can
generate the document 1623 .

Model Document Sequence

When you generate a document from a Master Document element, the sequence in which the sections are
generated is determined by the order in which the child Model Document elements are listed in the Project
Browser. You can create elements anywhere in a diagram, therefore the generator refers to the Project
Browser sequence.
If necessary, change the sequence using the green Up and Down arrows in the Project Browser toolbar to
move an element up or down within the package.

Model Search
A Model Search operates on the database, and accesses records in the order in which they are stored. This
order depends on many factors, and can change with database maintenance. Therefore, the sequence of
information provided by the search is unpredictable.

Package Order
When you create a package list in a Model Document element, the sequence of information is determined by
the order in which the package attributes are listed within the element. You can change the sequence using
the Attributes dialog, and if you prefer a package to be in a different section of the document, you can move
the attribute from one Model Document element to another. Both these procedures are described below.

Change Sequence of Packages In List

To rearrange the order of packages in a Model Document element, refer to the example element and follow
the steps below:

1. Right-click on the Model Document and select the Attributes option from the context menu. The
Attributes dialog displays.
2. On the Attributes list, click on a package to move and click on the Up or Down (hand) buttons to change
the order in which the packages are included in the documentation.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1623

In this case, Fact Model is being moved to follow Release Plan.

3. When you are satisfied with the order of your packages, click on the Close button.

Move Package Between Elements

To move a package attribute from one Model Document to another, follow the steps below:
1. Expand the Model Document elements in the Project Browser, so that both list their package attributes.
2. Click-and-hold on the attribute to move, and drag it onto the name of the target Model Document
element.
3. Release the mouse button. The attribute is removed from the source element and added to the top of
the list of attributes in the target element.
4. If necessary, move the attribute down the attribute list, as described in Change Sequence of Packages
in List, above.

10.1.2.6 Section Numbering in Virtual Documents

Virtual documents can contain several sections based on separate templates. To ensure that section and
subsection numbering continues sequentially through the sections, you can either use:
· The MasterList style from the Normal.rtf 1576 file (which is the default applied to all new templates, such as
those used in each master Document and Model Document element); this provides a simple but consistent
list numbering style that you can start off with. Alternatively, use:
· Your own numbering style.
If you design your own styles in the template used in each model document, each template must use the
same List Overrides 1601 for section numbering. These have a unique ID, so to propagate the List Overrides
across multiple templates, you must:
1. Set up the common List Overrides in the Normal.rtf template (your own customized override list).
2. Within each of the other templates used in the virtual document, using the template editor, select File |
Update Styles 1588 to update the templates to include the common List Overrides.
3. In each template use this common List Level for progressive numbering throughout the virtual
document.

10.1.2.7 Generate the Document

To generate the documentation defined in the Master Document and/or Model Documents, follow the steps
below:
1. On the documentation diagram, click on the Master Document element (or on an independent Model
Document element).
2. Select the Element | Rich Text Format ( RTF) Report menu option. The Generate RTF Documentation
dialog displays.

© 1998-2010 Sparx Systems Pty Ltd

 1624 Report Generation | RTF Documents

3. Set the options for your RTF document as required. See the Generate RTF Documentation Dialog 1573

and related topics for further information on these settings.

4. Click on the Generate button to create the documentation.
5. If you have not selected the View Document on Completion checkbox, click on the View button to
view the documentation.
The RTF Report Generator works through the defined content of the Master Document element and/or the
Model Document elements and pulls in the information from either the listed packages or the executed
searches, formatted according to the templates identified in the RTFTemplate Tagged Value for each
document element.

10.1.3 Other Documents

Enterprise Architect has other RTF based documentation that you can output:
· Dependency Report 1624
· Diagrams Only Report 1625
· Implementation Report 1626
· Resource Report 318
· Testing Report 1627
· Testing Details Report 1549

10.1.3.1 Dependency Report

A Dependency Report shows, for the selected package, a list of any elements that are dependent on another
element for their specification. For example, a Use Case derives its specification from the Requirement that it
realizes. Each of the elements in the first column is the source or dependent in a Dependency 861 connector
to the corresponding target element in the second column.
To view a Dependency report, follow the steps below:
1. In the Project Browser, right-click on the package to report on; the report includes all sub-packages of
this package. The context menu displays.
2. Select the Documentation | Dependency Report menu option.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1625

3. The Dependency Details dialog displays, showing the results of the report. Save or print the results if
required.

Option Use to

Root Package Confirm the root package. All elements and packages under this package appear in the
report.

Locate Object Locate the selected element in the Project Browser.

Refresh Run the report again.

Details List dependency details; lists the elements in the current package and the elements that
they implement.

Print Print the list.

10.1.3.2 Diagrams Only Report

You can also produce an RTF report that contains only the relevant diagrams from the target package. This is
convenient for printing or handling a lot of diagrams in batch, rather than exporting or printing each one at a
time.

To Produce a Diagrams Only Report

1. Right-click on a package in the Project Browser. The context menu displays.
2. Select the Documentation | Diagrams Only Report menu option. The Export Diagrams to RTF
Document dialog displays.

3. In the Output Path field, type or browse for the output location to create the report in.
© 1998-2010 Sparx Systems Pty Ltd
 1626 Report Generation | RTF Documents

4. Select the options you require, as follows:

· Select the Embed Diagrams in Document checkbox to ensure the diagrams are created within the
RTF file, not as linked image files
· Select the Include all child packages checkbox to document all of the diagrams included in any
child package
· Select the Include Diagram Name checkbox to include the diagram name within the generated
documentation
· Select the Order Diagrams Alphabetically checkbox to generate the documentation in alphabetical
order.
5. Click on the Generate button to run the report.
6. When the report is generated, click on the View button to show the RTF output.

10.1.3.3 Implementation Report

An Implementation report lists, for a specified package, the elements that require implementers, together with
any source elements in Realize 889 (Implements) relationships with those elements.
To view an Implementation report, follow the steps below:
1. In the Project Browser, right-click on the package to report on; the report includes all sub-packages of
this package. The context menu displays.
2. Select the Documentation | Implementation Report menu option.
3. The Implementation Details dialog displays with the results for the package. Save or print the results if
required.

Option Use to

Root Package Confirm the root package. All elements and packages under this package appear in
the report.

Show Show non-implemented elements. Non-implemented elements are those that don't
Unimplemented have any other element to realize them (for example, a Use Case has no
Component or Class to implement the Use Case behavior).

Show Implemented Show implemented elements. These are elements that do have some element
associated with them in a Realization relationship. For example a Use Case has a
Component that implements it.

Locate Object Locate the selected element in the Project Browser.

Refresh List Run the report again.

Details List elements in the current hierarchy and elements that implement them.

Print Print the list.

Set Target Types Set the list of types to report on. By default Enterprise Architect only reports on a
limited number of element types, such as Use Cases and Requirements. For

Enterprise Architect User Guide

 Report Generation | RTF Documents 1627

Option Use to

further information see the Set Target Types Dialog 1627 topic.

10.1.3.3.1 Set Target Types Dialog

The Set Target Types dialog is accessed by clicking on the Set Target Types button on the Implementation
dialog. This dialog enables you to set the types of elements that appear in the report as requiring
implementation. Double-click on an element in either list to move it to the other list.

10.1.3.4 Testing Report

To view a testing report, follow the steps below:
1. In the Project Browser, right-click on the package to report on (you can configure the report to include
all sub-packages as well) to open the context menu.
2. Select the Documentation | Testing Report menu option.
3. The Generate Test Documentation dialog specifies which test types are documented in the report, and
the output file location. You can also select the Include child packages checkbox to report on all child
packages of the selected package. The test data originates in the docked testing window, where tests
are created and attached to the respective object.

© 1998-2010 Sparx Systems Pty Ltd

 1628 Report Generation | RTF Documents

10.1.4 The Legacy RTF Report Generator

Note:
The Legacy Generator is available if you have RTF templates created in releases of Enterprise Architect prior
to 4.1, and you prefer to generate RTF reports using the original generator. However, as you can generate
reports from these templates using the post-Enterprise Architect 4.1 RTF Generator, the Legacy Generator
and instructions for its use are no longer updated.
However, reports produced using the Legacy RTF Generator do reflect the Notes 642 formatting feature in
any text associated with elements.

Creating a Rich Text Format (RTF) document is a simple and flexible process. An RTF document is based on
a package or an element in your project (more usually a package). To produce a document, you select the
package or element to report on in the Project Browser, Element List or Model Search, then press [F8] to
display the Generate RTF Documentation dialog. 1573 On the Advanced tab, click on the Switch generator
button to access the Legacy Rich Text Format Report dialog.

The Rich Text Format Report dialog enables you to set the exact contents and look and feel of your report.
You enter the file name of the report, a heading, additional notes, template name (for saving the set-up) and
other options. You can also select the style of the report; either plain or formal.
Optionally, you can set up a filter, the details to include, element types to exclude, whether to process child
packages, whether to show diagrams and the diagram format.
You can switch back to the Generate RTF Documentation dialog by clicking on the Switch RTF Generator
button.

Note:
The Rich Text Format Report dialog panels are individually described in the subsequent topics of this section
(listed below). The dialog has a lot of options; get to know them all to produce output at the level of detail
suited to your project.

· Document a Single Element 1629

· Set the Main RTF Properties 1629

Enterprise Architect User Guide

 Report Generation | RTF Documents 1629

· Apply a Filter 1630

· Exclude Elements 1630
· RTF Diagram Format 1631
· Model Include 1631
· RTF Report Options 1632
· RTF Report Selections 1633
· Generate the Report 1634
· Diagrams Only Report 1625
· Report Templates 1634
· Include or Exclude a Package from Report 1573

· Save as Document 1636

10.1.4.1 Document a Single Element

RTF documentation can also be generated for a single element.
Select the element to generate the documentation for, and then select the Element | Rich Text Format (RTF)
Report menu option. The Generate RTF Documentation dialog 1573 displays.

Click on the Switch Generator button to display the Rich Text Format Report dialog. See The Legacy RTF
Report Generator 1628 and its related topics for further information.

10.1.4.2 Set the Main RTF Properties

The main section of the Rich Text Format Report dialog enables you to set the output location and
appearance of the final RTF document.

Setting Options for the RTF Document

1. Open the Rich Text Format Report dialog (see The Legacy RTF Report Generator 1628 topic for how to
do this). The main section of this dialog is shown below.

2. Supply an Output Filename to save the report into; always include the extension .RTF as part of the
filename.
3. Provide a Template Name to save this report set-up.
4. Select a report Style: Formal or Basic.
5. Type a Heading for your report; this appears as the first heading item in your output.
6. Select your required Heading Style and Initial Heading Level Indent from the drop-down lists.

© 1998-2010 Sparx Systems Pty Ltd

 1630 Report Generation | RTF Documents

Note:
It is recommended that you enter a full path name for your report. The images in your report are saved
externally in an images directory, and supplying the full directory path avoids confusion over the location of
these images. Also, if you move your report you must also move the images directory.

10.1.4.3 Apply a Filter

You can apply a filter on the Rich Text Format Report dialog to include or exclude elements by date modified,
phase or status. This helps to track changes and break a document into multiple delivery phases.
Open the Rich Text Format Report dialog (see The Legacy RTF Report Generator 1628 for how to do this). The
Filter section of this dialog is shown below.

· To enable the date filter, select the checkbox in the date field.
· In the first two Only include objects fields, click on the drop-down arrows and select the appropriate
criteria (Modified/Created, Before/After).
· The package phase filter applies at the package level (not the element level) and ignores the phase of the
root package that you are documenting. To enable the phase filter, in the Where Package Phase field click
on the drop-down arrow and select an operator; Enterprise Architect filters out all packages that do not
meet the selection criteria. All elements in the package are ignored, regardless of their individual phase.
· The element status filter enables you to limit the output by element status. Unlike the package phase filter,
this filter applies to every element. You can filter against a status of like or unlike a criterion, for example,
like proposed, or against the in and not in operators, such as in approved, not in validated. When using
the in and not in operators, enter a comma-separated list of status types as your criteria expression.

10.1.4.4 Exclude Elements

The Rich Text Format Report dialog enables you to exclude elements of any type from your final output. This
is useful when you want to highlight particular items and not clutter up a report with too much detail.
Open the Rich Text Format Report dialog (see The Legacy RTF Report Generator 1628 for how to do this). Look
at the Exclude details for panel on the right of the dialog.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1631

Click on each element to exclude, or click on the All button to exclude all elements. Click on the None button
to clear your selections.

10.1.4.5 RTF Diagram Format

You can output diagrams to Bitmap files, GIF files or Windows Metafiles.
Open the Rich Text Format Report dialog (see The Legacy RTF Report Generator 1628 for how to do this). In
the Diagram format panel (bottom center of the dialog) select the required format for the report.

· Bitmap files are raster images with a high level of detail but large size; they do not scale up or down very
well
· GIF files are raster images with reasonable detail and small size; they scale a little better than bitmaps
· Metafiles are vector images with high detail and small size (but can have compatibility problems with some
printers or software); metafiles scale very well
· PNG files are raster images with reasonable level of detail and smaller file sizes than GIF
· JPEG are lossy raster images with average levels of detail, they do not work very well with line drawings
and lose clarity when re sized; JPEG file sizes are typically very small.

Note:
Generally metafiles are the best option, although it sometimes pays to experiment.

10.1.4.6 Model Include

The Model Include panel of the Rich Text Format Report dialog has the following options:
· Glossary to include the project glossary 323

· Tasks to include project tasks 329

· Issues to include project issues 331 .

© 1998-2010 Sparx Systems Pty Ltd

 1632 Report Generation | RTF Documents

Select the appropriate checkbox to include the items in the generated RTF documentation.

10.1.4.7 RTF Report Options

Additional RTF report options you can select from the Options panel on the Rich Text Format Report dialog
are shown below.

You can select whether or not to recursively document packages, show diagrams or add a page break before
each new package. Select the:
· Process all Children checkbox to recursively process all child packages within the main package
· Show Diagrams checkbox to include diagrams in your document. Clear this item for no diagrams
· New page per package checkbox to force a page break on each new package (excepting empty
packages)
· Document all elements checkbox to include all elements included in the project
· Document Packages checkbox to document the package as an element in addition to the documentation
that would normally be produced for package documentation
· Hide 'note-less' elements checkbox to exclude all elements without notes from the documentation
· Embed Diagrams in Document checkbox to ensure that the diagram images are contained within the RTF
document rather than stored in a linked external file
· Skip root package checkbox to exclude the parent package from the documentation and include only the
child packages
· Document Linked Elements checkbox to include the object details for linked elements that do not
originate from the selected package
· Use Heading styles for Details checkbox to ensure that the details are formatted as heading styles rather
than formatted text; this option is only available when the Heading Style field in the Main section 1629 of the
Rich Text Format Report dialog is set to Max 9 levels - elements are package + 1.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1633

10.1.4.8 RTF Report Selections

The For each Object Include section of the Rich Text Format Report dialog enables you to select the
documentation sections to include in your report.

What you include or exclude governs how simple or detailed your report is. You can create multiple reports at
different levels of detail for different audiences. Experiment with these options to see what effect inclusion or
exclusion has. Most items are self-explanatory.
Selecting the checkbox against a category item in the list selects all of the options that are contained in the
category. To expand a category, click on the +symbol next to the category name. To exercise greater control
over a category of options expand the top level item and then select the required individual items from the list.
Sometimes an item applies only to a certain type of element; for example, Attributes only applies to Class
elements and a few other element types. The Child Diagrams option shows or hides any diagrams that are
attached under a model element; for example, a Use Case might have a Scenario diagram attached.

Note:
Use this feature to produce the right level of detail for your audience. Technical readers might want to see
everything, whilst management might require only the general outline.

© 1998-2010 Sparx Systems Pty Ltd

 1634 Report Generation | RTF Documents

10.1.4.9 Generate the Report

Once you have set up the document properties as required, click on the Generate button to generate the
report. When you have generated the document, click on the View button to open the report in MS Word.

10.1.4.10 Legacy RTF Style Templates

The Legacy RTF Style Editor enables you to edit the RTF associated with various sections of the RTF Report
facility in Enterprise Architect. You would typically use this functionality to customize a report's look and feel for
your company or client.

Notes:
· The RTF Style Editor discussed here automatically displays when you modify or create a Legacy RTF
template. If you select a template created in the enhanced RTF Style Template Editor 1578 , that editor
opens automatically instead.
· You can transport these RTF templates between models, using the Export Reference Data 223 and
Import Reference Data 225 options on the Tools menu.

If you have previously defined and saved a template, click on the Load button on the Rich Text Format Report
dialog to open the list of defined templates. Select one in order to load it as the current template; all the
features saved become the current features. This enables you to define a set of standard report types that
streamline document production.

Create or Edit RTF Style Templates

1. Select the View | Other Project Tools | Resources menu option to display the Resources window.
2. Expand the Templates folder.

3. To edit an existing Legacy template, expand the Legacy Templates tree and double-click on the
template name, or right-click and select the Modify Document Template context menu option. The
RTF Style Editor displays. See RTF Style Editor 1635 for further details.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1635

4. Alternatively, to create a new Legacy template, right-click on Legacy Templates and select the Create
RTF Style Template (Legacy) context menu option. Enterprise Architect displays a prompt for the new
template name.
5. Type the name of the new template and click on the OK button. The RTF Style Editor displays. See RTF
Style Editor 1635 for further details.

Tip:
To delete a template, right-click on it and select the Delete Document Template context menu option.

RTF Style Editor

The RTF Style Editor contains a list of all available RTF fragments for modification and customization.

Each fragment typically contains RTF plus one or more special tag names that Enterprise Architect replaces
with information during generation. Currently you cannot alter the content within the tag names, but you can
omit a complete tag by removing it, or alter its basic display properties in the surrounding RTF.
Special tag names are delimited by # characters; for example, #NOTES#
Click on the:
· Get Default button to retrieve the default Enterprise Architect template for the currently-selected template
item in the left hand list
· Save button to save the version of the template for this style only
· Delete button to remove your modified version of the template, which causes Enterprise Architect to use
the default template during report generation.
To select a template during report generation, click on the Style drop-down arrow on the Rich Text Format
Report 1628 dialog. Once a style is selected, Enterprise Architect applies that to the current report. Select
<Basic> for the inbuilt style.

© 1998-2010 Sparx Systems Pty Ltd

 1636 Report Generation | RTF Documents

Tip:
You can also alter the custom language settings 1637 .

10.1.4.11 Save as Document

The Document feature enables a particular documentation configuration to be 'remembered', linking the
loaded template within the Rich Text Format Report dialog to the current highlighted package. If a particular
template is always used with a specific package, and multiple cases of documentation exist to be propagated,
saving these as Documents can ease document generation later.
To create and use Documents, follow the steps below:
1. Open the Rich Text Format Report dialog (see The Legacy RTF Report Generator 1628 for instructions
on how to do this).
2. Click on the Save as Document button. The Save current as document definition dialog displays:

3. In the Enter Value field, type a name for the document and click on the OK button. The document is
added to the Resources window for easy future access (as for the usecasedoc entry in the illustration
below).

4. To generate documentation from the Resources window, right-click on the required document. The
context menu displays.
5. Select the required option.
The context menu options are:
· Open Document - Opens the corresponding .RTF file, as specified by the RTF template Filename property
· Generate Document - Opens the Rich Text Format Report dialog, loaded with the specified template
· Auto Generate Document - Generates documentation, with the document located at the path specified by

Enterprise Architect User Guide

 Report Generation | RTF Documents 1637

the template's Filename property

· Delete Document - Removes the specified document.

10.1.4.12 Custom Language Settings

If you export RTF-format documents from Enterprise Architect in languages other than English, you can
customize the codepage, default language ID and character set that Enterprise Architect uses when
generating RTF. This makes it much easier to generate documentation appropriate to your country or locale.
You can also set up a list of word substitutions. For instance, where Enterprise Architect would include the
word Figure, you can specify another word to replace it that is either in your language or more meaningful to
your readers.

To Set Up Substitutions
1. Open the Rich Text Format Report dialog (see The Legacy RTF Report Generator 1628 for how to do
this).
2. In the Language panel (bottom left of dialog) click on the Adjust button. The Customize RTF Language
dialog displays.

3. Double-click on an item to set or clear its Substitute word.

4. When you have finished, click on the OK button.

To Set Up Codepage and Character Set

1. From the drop-down lists in the Language, Codepage and Charset fields, select the language,
codepage and character set that most closely match your location.
2. If required, modify the Substitute Tags by double-clicking on each and manually setting the value (for
advanced use only).
© 1998-2010 Sparx Systems Pty Ltd
 1638 Report Generation | RTF Documents

3. To clear the substitution list, double-click on each item in turn and delete the substitute value.
4. When you have completed the settings, click on the OK button to save them.
Now when you generate RTF documents, the substitute tags are used in the output.

Note:
You can transport these language and tag definitions between models, using the Export Reference Data 223
and Import Reference Data 225 options on the Tools menu.

10.1.5 Use MS Word

To further enhance and customize RTF documentation it is possible to create a custom master document,
which can be used to add a table of contents, table of figures, headers and footers and to refresh linked files.
In addition it is possible to create documents with sustainable links to generated 'pieces' of Enterprise
Architect output, pre-divided by Enterprise Architect using bookmarks 1639 .
As an alternative to the Word master document, internal to Enterprise Architect, see Virtual Documents 1616 .
In addition to creating Word master documents, you can:
· Open a Report in Microsoft Word 1638
· Change Linked Images to Embedded 1638

· Apply Other Features of Word 1641 .

Note:
You can develop a report using the combined facilities of Word and Enterprise Architect with few problems,
as long as you leave definition of the section styles to the final stages in Enterprise Architect just prior to
report generation. Word truncates the section bookmarks, as it uses a smaller field length for sections. In
Word, you can review and edit reports generated by Enterprise Architect, but you cannot import them back
into Enterprise Architect without damaging the section style definition.

10.1.5.1 Open a Report in Microsoft Word

To open an RTF file in MS Word, simply load Word and open the file as a normal document. Word converts
the file. If Word is the default handler of RTF files, then double-click on the output file to load up and view the
report.

Tip:
If you have Word configured to view RTF files, you can also click on the View Output button on the Generate
RTF Documentation dialog.

10.1.5.2 Change Linked Images to Embedded

One of the options available when generating RTF documentation is the ability to store image files in a
separate directory to the RTF document. If at a later stage it becomes desirable to embed the images in the
RTF documentation, this is especially important when the document is to be distributed. If the images are
stored in a separate directory recipients of document see only the placeholder of images rather than the actual
images.
If you import an RTF document into Word with the images not embedded into the document, you have the
option of breaking the links to the images and saving the image in the document.

Break Image Links in Word

1. Open the required RTF file in Word.
2. Select the Edit | Links menu option.
3. Highlight all links in the Links list.
4. Select the Save Picture in Document checkbox.
5. Click on the Break Link button.
6. When prompted, click on the Yes button to break links.
Word breaks the links and saves copies of the images inside the document. You can distribute this document

Enterprise Architect User Guide

 Report Generation | RTF Documents 1639

without the image directory.

10.1.5.3 RTF Bookmarks

Bookmarks are markers that are automatically placed in your rich text document when you generate it. You
can create a master document in Word and link to sections of an Enterprise Architect report based on
bookmarks. For example, a Word document might have a section for a small part of your component model.
Using bookmarks you can generate a full component model, and then link into just one section of the report.
This way you can maintain a complex Word document from parts of Enterprise Architect reports. If you link
into Enterprise Architect reports, then you can regenerate the report and refresh Word links to update the
master document without having manually changed anything. For more information on refreshing links, see
the Refresh Links 1646 topic.
Bookmarks are GUID-based numbers that can be created for packages, diagrams and elements. A package
bookmark applies from the beginning of a package to the end, and includes all child packages and elements
underneath.

Note:
You cannot use RTF Bookmarking in Master Document 1618 elements, which effectively replace RTF
Bookmarking in Word.

RTF Bookmarking requires each bookmark to be unique. When you generate a report with a standard RTF
template (including in a single Model Document element), each bookmark is unique and there is a 1:1
association between the Elements-details being generated and the elements in the repository. As Master
Documents are intended to contain multiple sub-documents, the association ceases to be 1:1. There is no
simple method that enables the generated data to be uniquely identified directly in association with the
original element.

Bookmark a Section of Enterprise Architect for RTF Documentation

1. In the Enterprise Architect Project Browser, right-click on the package to include in the documentation.
The context menu displays.
2. Select the Documentation | Copy RTF Bookmark menu option to paste the package into the clipboard
as a bookmark for use in Word.

© 1998-2010 Sparx Systems Pty Ltd

 1640 Report Generation | RTF Documents

Insert a Bookmarked Section of an Enterprise Architect RTF Document into Word

1. Open the Word document and position the cursor at the point at which to insert the file.
2. Select the Word Insert | File menu option. The Insert dialog displays.

3. Locate and click on the file to insert, then click on the Range button.
4. In the Range cell type or paste the information from the clipboard.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1641

5. Click on the OK button.

6. Click on the drop-down arrow next to the Insert button. Select the Insert as Link option.

The Insert option sets a permanent copy; the Insert as Link option creates a link that is updateable on
altering the source document. For Insert as Link to operate you must first set Refresh Links 1646 .
Every package is bookmarked in the RTF document according to the following rules:
· All alphabetic and numeric characters remain the same
· All other characters (including spaces) are converted to underscores.
For example UC01: Use Case Model becomes UC01__Use_Case_Model.

10.1.5.4 Other Features of Word

Word offers a considerable number of document enhancement tools to complete your project documentation.
Here are some of the things you can do with Word in Enterprise Architect generated RTF documentation:
· Add a Table of Contents 1641
· Add a Table of Figures 1642
· Add Headers and Footers 1643
· Manipulating Tables in Word 1644
· Refresh Linked Files 1646

Tip:
Enterprise Architect provides the basic content for your document - use Word to add the presentation and
linkages.

10.1.5.4.1 Add Table of Contents

Among the features of MS word that can be incorporated into generated Enterprise Architect reports is the
option to include a table of contents. A table of contents can be used to aid navigation of documentation and
enhance the readability of Enterprise Architect RTF reports. This option provides hyperlinks to the diagrams
included in the RTF documentation in the electronic version, and page numbers for both the printed and
electronic documentation. To include a Table of Contents in the RTF documentation follow the steps below:
1. Open the Enterprise Architect RTF report to which to add a Table of Contents in MS Word.
2. Select the Insert | Reference | Index and Tables menu option.
3. Click on the Table of Contents tab to set the options that are available for formatting the table of
contents.

© 1998-2010 Sparx Systems Pty Ltd

 1642 Report Generation | RTF Documents

The format of the table of contents is dependant on the heading levels created when the RTF is generated. To
set the heading style for details in Enterprise Architect RTF documentation, see the RTF Document Options
1607 topic.

10.1.5.4.2 Add Table of Figures

Among the features of MS word that can be incorporated into generated Enterprise Architect reports is the
option to include a table of figures. A table of figures can be used to aid the navigation of the documentation
and enhance the readability of Enterprise Architect RTF reports. This option provide hyperlinks to the
diagrams included in the RTF documentation in the electronic version and page numbers for both the printed
and electronic documentation.
To include a Table of Figures in the RTF documentation, follow the steps below:
1. Open the Enterprise Architect RTF report to which to add a Table of Figures in MS Word.
2. Select the Insert | Reference | Index and Tables menu option.
3. Click on the Table of Figures tab to set the options that are available for formatting the table of figures.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1643

10.1.5.4.3 Add Headers and Footers

Among the features of MS word that can be used to enhance the appearance of Enterprise Architect RTF
reports is the ability to add headers and footers to the documentation. To include headers and footers in the
RTF documentation follow the steps below:
1. In MS Word, open the Enterprise Architect RTF report to which to add headers and footers.
2. Select the View | Header and Footer menu option.

This enables you to enter information into the header section and the footer section of the RTF
Documentation.

© 1998-2010 Sparx Systems Pty Ltd

 1644 Report Generation | RTF Documents

10.1.5.4.4 Manipulate Tables in Word

When generating RTF documentation from Enterprise Architect, tables are included when items such as
Attributes and Methods are selected in the For each Object section in the Rich Text Format Report dialog.
MS Word offers several levels of customization for tables and can be used to tidy the formatting of the tables
in situations where the margins of the table exceed the dimensions of the page size selected in Word for
printing.

Resize Tables
When the amount of detail for a documented item such as an attribute or operation exceeds the margins of
the page in MS Word it is necessary to manually resize the table in order to view all of the details. To manually
resize the table follow the steps below:
1. Select the table that exceeds the margin size.
2. Mouse over the border of the table until the mouse pointer changes into the icon shown below.

Enterprise Architect User Guide

 Report Generation | RTF Documents 1645

3. Drag the cursor to the left to reduce the width of the table and then select the File | Print Preview menu
option to confirm that the table borders are within the page margins.
4. Resize all of the tables that overhang the margins of the page by using the steps detailed above.

Applying Styles to Tables

One of the customizable properties of MS Word when working with tables is the ability to apply a style to a
table, which enables you to rapidly change the appearance of the table. To achieve this effect follow the steps
below:
1. Open the Enterprise Architect RTF report in which to change the table styles.
2. Locate and select the table for which to adjust the appearance.
3. Select the Table | Table Auto Format menu option. The Table Autoformat dialog displays.
From here you can specify a predefined table style from the Table styles list, or create a new style by clicking
on the New button. The table styles defined in the Table Autoformat dialog only apply to one table at a time so
you must apply the style to each table created individually.

© 1998-2010 Sparx Systems Pty Ltd

 1646 Report Generation | RTF Documents

10.1.5.4.5 Refresh Links

If you link into Enterprise Architect reports, then you can regenerate the report and refresh MS Word links to
update the Word master document without having manually changed anything.
To ensure that links are refreshed in the master document, you must select the Update automatic links at
Open checkbox in Word. To ensure that this setting is established follow the steps below:

1. From within MS Word select the Tools | Options menu option.

2. Select the General tab and select the Update automatic links at Open checkbox.

Enterprise Architect User Guide

 Report Generation | HTML Reports 1647

10.2 HTML Reports

Enterprise Architect provides automated web-based publishing of models. A new outline structure closely
mirrors the model hierarchy and makes it very simple to explore models on-line. With a great new look and the
ability to explore very large models efficiently on-line, the new web-publishing capability is a significant
enhancement.
Enterprise Architect enables export of an entire model or a single branch of the model to HTML Web pages.
The HTML report 1647 provides an easy to use, highly detailed, Javascript based model tree. In addition,
hyperlinked elements make browsing to related information very simple.
The current implementation is based on internal and external templates and generated Javascript. The ability
to edit all templates is to be added in a future version of Enterprise Architect.

Tip:
You can create Web Style Templates 1649 to customize your HTML output.

Note:
In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of
Enterprise Architect, if security is enabled you must have Generate Documents 198 permission to generate
HTML documents.

10.2.1 Create an HTML Report

To create an HTML report:
1. In the Project Browser, right-click on the root package for the report (all child packages are included in
the output). The context menu displays.
2. Select the Documentation | HTML Report menu option. The Generate HTML Report dialog 1648

displays.
3. In the Output to field, select an output directory for your report. Set any other required options.
4. Click on the Generate button to generate the report. The Progress field shows total percentage
complete.
5. Once the report is complete, click on the View button to launch your default HTML viewer and view the
web pages.

Note:
If you are using Microsoft Internet Explorer 7.0 or later, and you do not have it open, its security profile might
block the report display. Click on the explanation banner at the top of the screen and select the Allow
Blocked Content context menu option.

The web report produced is compatible with any standard web server, on either Unix or Windows platforms.
Simply bundle up the entire output directory and place it within the context of your web server. All path names
should be relative and case sensitive.
When you view the HTML report in your HTML viewer, you can switch directly to a page for a specific diagram
or element by specifying the appropriate GUID after the report web address. That is:
http://path/path/path/Index.htm?guid=xxxxxxxxxxxx
The word guid must be in lower case, and the value must not include braces { }. For example:
http:// .../path/Index.htm?guid=DC62B0DA-0D60-4447-85E6-B9BBAE7FC90F
You can obtain the GUID for the diagram or element using the Copy Reference option on the Project Browser
Diagram 1220 , Element 1218 and Package 1214 context menu options.

© 1998-2010 Sparx Systems Pty Ltd

 1648 Report Generation | HTML Reports

Note:
The page locator does not work directly in Internet Explorer. Firefox automatically converts the path to file:///
C:/path protocol, and actions it. That protocol also works in Internet Explorer. Therefore, to use the absolute
references without a web server you must access the path using the file:/// protocol.

Quick Start
To generate an HTML report right now, follow the steps above on the System Model package of the
EAExample project.

10.2.2 The Generate HTML Report Dialog

The Generate HTML Report dialog is used to generate documentation about your model in HTML format.
There are various settings to choose from to control the output, as described below.

Option Use to

Package Display the name of the package you are creating documentation for.

Title Type the title for your HTML documentation; defaults to Package.

Output to Type the directory path your documentation is saved to.

Style Select a web style template 1649 to apply to your documentation (optional).

File Specify the file extension for your HTML documentation files; the default
is .htm.

Enterprise Architect User Guide

 Report Generation | HTML Reports 1649

Option Use to

Header Image Enter or select the file path for the header image graphic to display on
your HTML output. If you do not specify a file path, the image defaults to
the Enterprise Architect logo.

Preserve White space in Notes Preserve existing white space in your notes; deselect to remove white
space.

No page for Note and Text Omit the page for your notes and text items in the HTML report.
items

Default Diagram Select the diagram the report should open to when the generated
documentation is loaded.

Image Format Select the image file format to save your images in, either PNG or GIF.

Include Select each area of your model to include in your report.

System Select each section to generate in your report.

Click on the Generate button to generate the HTML report with the settings you have defined.

Click on the View button to display the report you have generated.

10.2.3 Web Style Templates

The HTML and CSS Style Editor enables you to edit the HTML associated with various sections of the HTML
Report facility in Enterprise Architect. You would typically use this functionality to customize a report's look and
feel for your company or client. The editor is derived from, and provides the facilities of, the common Code
Editor 1428 .
To create or edit web style templates, follow the steps below:
1. In the Resources window, expand the Templates folder.
2. To create a new template, right-click on the Web Style Templates folder and select the Create HTML
Template context menu option. Enter a name for the new template when prompted to do so. The HTML
and CSS Style Editor displays. See below for further details.
3. To edit an existing template, expand the Web Style Templates folder and either double-click on the
template name, or right-click and select the Modify HTML Style Template context menu option. The
HTML and CSS Style Editor displays. See below for further details.

Note:
To delete a template, right-click on it and select the Delete HTML Template context menu option.

The HTML and CSS Style Editor contains a list of all available HTML fragments for modification and
customization. These fragments are defined in the HTML Template Fragments 1651 topic.
Each fragment typically contains HTML plus one or more special tag names that Enterprise Architect replaces
with information during generation. Currently you cannot alter the content within the tag names, but you can
omit a complete tag by removing it, or alter its basic display properties in the surrounding HTML.
Special tag names are delimited by # characters - for example, #NOTES#.

© 1998-2010 Sparx Systems Pty Ltd

 1650 Report Generation | HTML Reports

· Get Default retrieves the default Enterprise Architect template for the currently selected template item in
the left hand list
· Save saves your version of the template for this style only
· Delete removes your modified version of the template, which causes Enterprise Architect to use the default
template during report generation.
To select a template during generation, use the Style drop-down arrow on the Generate HTML Report dialog.
Once a style is selected, Enterprise Architect applies that to the current report. Select <default> for the inbuilt
style.

Enterprise Architect User Guide

 Report Generation | HTML Reports 1651

Note:
Each time Enterprise Architect generates the web report it overwrites these files, so you must back up your
modified versions and copy them back in after every update.

10.2.4 HTML Template Fragments

This topic identifies each of the HTML Template fragments available through the HTML and CSS Style Editor
1649 , and defines the fields of each fragment.

Section Fields

Body - Diagram · #AUTHOR# - Diagram author

· #CREATEDATE# - Diagram created date
· #CSS# - Style Sheet to use
· #GUID# - Diagram GUID
· #IMAGE# - Image of the diagram
· #IMAGES# - Image path
· #LOCKED# - Is the diagram locked (true or false)
· #MODDATE# - Diagram modified date
· #NAME# - Diagram name
· #NOTE# - Diagram notes
· #STEREOTYPE# - Diagram stereotype
· #TITLE# - Diagram title
· #TYPE# - Diagram type
· #VERSION# - Diagram version.

© 1998-2010 Sparx Systems Pty Ltd

 1652 Report Generation | HTML Reports

Section Fields

Body – Object · #ABSTRACT# - Element abstract (if true, = abstract)

· #ACTIVE# - Element isActive (true or false)
· #ALIAS# - Element alias ("#ALIAS#")
· #AUTHOR# - Element author
· #BEHAVIOR# - Returns the object behavior.
· #CLASSIFIER# - Element classifier
· #COMPLEXITY# - Element complexity
· #CREATEDATE# - Element created date
· #CSS# - Style Sheet to use
· #DIAGRAMS# - List of diagrams the element is on
· #GUID# - Element GUID
· #IMAGES# - Image path
· #KEYWORDS# - Element keywords
· #LEAF# - Element isLeaf (true or false)
· #LEVELNUMBER# - Element level number
· #MODDATE# - Element modified date
· #MULTIPLICITY# - Element multiplicity ("Multiplicity:
#MULTIPLICITY#")
· #NAME# - Element name
· #NOTE# - Element notes
· #PHASE# - Element phase
· #ROOT# - Element isRoot (true or false)
· #SCOPE# - Element scope
· #STATUS# - Element status
· #STEREOTYPE# - Element stereotype(s)
· #TYPE# - Element type; for example, Class, Object
· #VERSION# - Element version.

Body – Project Glossary · #CONTENT# - Loops Content – Project Glossary Item for each
Project Glossary item.

Body – Project Issues · #CONTENT# - Loops Content – Project Issue Item for each
Project Issue item.

Body – Project Tasks · #CONTENT# - Loops Content – Project Task Item for each
Project Task item.

Content – Attributes · #CONTENT# - Loops Content – Attributes Item for each attribute
on an element.

Content – Attributes Item · #ALIAS# - Attribute alias ("<i>Alias:</i> #ALIAS#<br>")

· #CONST# - Attribute is constant value ("const " <-- Note Space)
· #CONSTRAINT# - Attribute constraint
· #DEFAULT# - Attribute default value ("<i>Initial:</i>
#DEFAULT<br>")
· #NAME# - Attribute name
· #NOTE# - Attribute notes
· #ORDERED# - Attribute Is ordered value ("Ordered <br />")
· #RANGE# - If lower != 1 ("Range:<lower> to <upper>")

Enterprise Architect User Guide

 Report Generation | HTML Reports 1653

Section Fields

· #SCOPE# - Attribute scope ("#SCOPE# " <-- Note space)

· #STATIC# - Attribute is static value (“static ” <-- Note Space)
· #STEREOTYPE# - Attribute stereotype(s)
· #TAGS# - Attribute tags ("Property Name=Property Value<br>")
· #TYPE# - Attribute type (if Column, “#TYPE(Column Precision,
Scale)").

Content – Constraints · #CONTENT# - Loops Content – Constraints Item for each

constraint on an element.

Content – Constraints Item · #CONSTRAINT# - Constraint name

· #NOTES# - Constraint notes
· #STATUS# - Constraint status
· #TYPE# - Constraint type.

Content – Custom Properties · #CONTENT# - List of all Content – Custom Properties - Item.

Content – Custom Properties - · #PROPERTY# - Custom property name

Item · #VALUE# - Custom property value
( if type equal boolean
true or false
else
#VALUE#).

Content – Files · #CONTENT# - List of Content - Files Item.

Content – Files Item · #DATE# - File date

· #NAME# - File filename (<a href=”#FILENAME#”</a>)
· #NOTES - File notes
· #SIZE# - File size
· #TYPE# - File type.

Content – Notes · #VALUE#>- Notes Text.

Content – Operations · #CONTENT# - List of Content - Operations Item.

Content – Operations Item · #ABSTRACT# - Operation abstract (abstract)

· #ALIAS# - Operation alias (“<i>Alias:</i> #ALIAS#<br>”)
· #CONCURRENCY# - Operation concurrency (blank if not set)
· #CONST# - Operation constant (const)
· #CONSTRAINTS# - List of Method Constraint
· #ISQUERY# - Operation IsQuery (isQuery)
· #NAME# - Operation name
· #NOTE# - Operation notes.
· #PARAMS# - List of Content – Operations Item Parameters
· #SCOPE# - Operation Scope
· #STATIC# - Operation IsStatic (static)
· #STEREOTYPE# - Operation stereotype
· #TAGLABEL# - static text (Tags)

© 1998-2010 Sparx Systems Pty Ltd

 1654 Report Generation | HTML Reports

Section Fields

· #TAGS# - Attribute tags ("Property Name=Property Value<br>")

· #TYPE# - Operation type.

Content – Operations Item · #DEFAULT# - Op Parameter default

Parameters · #GUID# - Op Parameter GUID
· #KIND# - Op Parameter kind
· #NAME# - Op Parameter name
· #NOTES# - Op Parameter notes
· #STEREOTYPE# - Op Parameter stereotype
· #TYPE# - Op Parameter type.

Content – Project Glossary Item · #MEANING# - Glossary Meaning

· #TERM# - Glossary Term
· #TYPE# - Glossary Type.

Content – Project Issues Item · #DATERESOLVED# - Project Issue resolved date (blank if no date
entered)
· #ISSUE# - Project Issue name
· #ISSUEDATE# - Project Issue issue date
· #NOTES# - Project Issue notes
· #OWNER# - Project Issue owner
· #RESOLUTION# - Project Issue resolution
· #RESOLVER# - Project Issue resolver
· #STATUS# - Project Issue status.

Content – Project Tasks Item · #ENDDATE# - Project Task end date

· #NAME# - Project Task name
· #NOTES# - Project Task notes
· #OWNER# - Project Task owner
· #PHASE# - Project Task phase
· #PRIORITY# - Project Task priority
· #STARTDATE# - Project Task start date
· #STATUS# - Project Task status
· #TYPE# - Project Task type.

Content – Resource Allocation · #CONTENT# - List of Content – Resource Allocation Item.

Content – Resource Allocation · #ACTUAL# - Resource actual time

Item · #ENDDATE# - Resource end date
· #EXPECTED# - Resource expected date
· #NOTES# - Resource notes
· #PERCENT# - Resource percent complete
· #RESOURCE# - Resource name
· #ROLE# - Resource role
· #STARTDATE# - Resource start date
· #TIME# - Resource time.

CSS – Main · None.

Enterprise Architect User Guide

 Report Generation | HTML Reports 1655

Section Fields

CSS – ToC · None.

Feature Notes · #FIELD#

· #VALUE#.

Javascript · None.

Link (Association) · #CONTENT#

· #DIAGRAMS# - List of diagrams the link is on.

Linked Document · #LINKDOC# - Linked Document.

Linked Requirement · #CONTENT# - List of Linked Requirement Item.

Linked Requirement Item · #DIFF# - Linked Requirement difficulty

· #NAME# - Linked Requirement name
· #PRIORITY# - Linked Requirement priority
· #STATUS# - Linked Requirement status.

Linked Section · #ITEMS#

· #TITLE#.

Link Line Item · #CONNECTION# - Connector type

· #IMAGE# - The file path of the images
· #LINK# - (<a href= "path to element"> "Connection Name"
</a>)
· #NOTES# - The connector notes
· #NUMBER# - A unique number used to identify div elements
· #SOURCEROLE# - Source role
· #SOURCEROLENOTES# - Source role notes
· #STEREOTYPE# - Connector stereotype
· #TARGETROLE# - Target role
· #TARGETROLENOTES# Target role notes
· #TYPE# - Connector type.

Maintenance · #CONTENT# - List of Maintenance Line Item.

Maintenance Line Item · #DATEREPORTED# - Maintenance date reported

· #DATERESOLVED# - Maintenance date resolved
· #IMAGE# - The file path of the images
· #NOTES# - Maintenance notes
· #NUMBER# - A unique number used to identify div elements
· #PRIORITY# - Maintenance priority
· #PROBLEM# - Maintenance name
· #REPORTEDBY# - Maintenance reported by
· #RESOLVEDBY# - Maintenance resolved by
· #RESOLVERNOTES# - Maintenance resolved notes
· #STATUS# - Maintenance status
· #TYPE# - Maintenance type

© 1998-2010 Sparx Systems Pty Ltd

 1656 Report Generation | HTML Reports

Section Fields

· #VERSION# - Maintenance version.

Message (Applies only to Sequence messages.)

· #CONTENT# - Loops the Message Item for each attribute on an
element
· #DIRECTION# - Contains the value To or From.

Message Item · #KIND# - The Message Kind field

· #MESSAGE# - Connector Message
· #NAME# - Name of the Message (<a href="<path>">#NAME#)
If Message has a classifier: #NAME#="#NAME# :Classifier"
· #NOTES# - The Message notes (<strong>Type:</strong> #Item
Type#<br /> #NOTES#)
· #SYNCH# - The Message Synch field
· #TYPE# - The type of Message.

Method Constraint · #NAME# - Method Constraint name

· #NOTES# - Method Constraint notes
· #TYPE# - Method Constraint type.

Object Requirement · #CONTENT# - List of Object Requirement Item.

Object Requirement Item · #DIFF# - Requirement difficulty

· #NAME# - Requirement name
· #NOTES# - Requirement notes
· #PRIORITY# - Requirement priority
· #STABILITY# - Requirement stability
· #STATUS# - Requirement status
· #TYPE# - Requirement type.

Package Content · #CONTENT# - List of Package Content Row.

Package Content Row · #NAME# - Link to Package (<a href="#Link to file#">#Package

name#</a>)
· #TYPE# - Link to Image (<img src="#path to image#">).

Page - Basic template · #CONTENT# - Contains Body - Diagram through to Body - Object
· #TITLE# - Current package name.

Page - Index · #CSS# - Style Sheet to use

· #HOME# - A link to the Start page
· #JS# - Javascript to use
· #TITLE# - Current package name
· #TOC# - To be established.

Page - ToC · None.

Scenario · #CONTENT# - List of Scenario Item

· #EXCEPTIONS# - List of Structured Scenario exceptions
· #STRUCTURED# - List of Structured Scenarios.

Enterprise Architect User Guide

 Report Generation | HTML Reports 1657

Section Fields

Scenario Item · #IMAGE# - The file path of the images

· #NOTES# - Scenario notes
· #NUMBER# - A unique number used to identify div elements
· #SCENARIO# - Scenario name
· #TYPE# - Scenario type.

Scenario Exception · #CONTENT# - Loops Scenario Exception Item for each exception.

Scenario Exception Item · #NAME# - Exception name

· #STEPNO# - Exception step number
· #TYPE# - Exception Type.

Scenario Structured · #CONTENT# - Loops Scenario Structured Items for each

Structured Scenario item.

Scenario Structured Items · #ACTION# - Name of the scenario

· #STEPNO# - Scenario step number
· #RESULT# - Step result value
· #USES# - Step uses value
· #STATE# - Step state value.

Tagged Value · #CONTENT# - List of Tagged Value Line Item.

Tagged Value Line Item · #IMAGE# - The file path of the images
· #NOTES# - Tagged Value notes
· #NUMBER# - A unique number used to identify div elements
· #PROPERTY# - Tagged Value name
· #VALUE# - Tagged Value if type is boolean (value is true or false).

Test Cases · #CONTENT# - List of Test Cases Line Item.

Test Cases Line Item · #ACCEPTANCE# - Test case acceptance notes

· #CHECKEDBY# - Test case checked by
· #CLASS# - Test case class (Unit, Integration, System,
Acceptance, Scenario)
· #IMAGE# - The file path of the images
· #INPUT# - Test case input notes
· #NOTES# - Test case notes
· #NUMBER# - A unique number used to identify div elements
· #RESULTS# - Test case result notes
· #RUNBY# - Test case run by
· #RUNDATE# - Test case last run
· #STATUS# - Test case status
· #TEST# - Test case name
· #TYPE# - Test case type.

© 1998-2010 Sparx Systems Pty Ltd

Part

XI
 Automation and Scripts | 1659

11 Automation and Scripts

This section describes how you can automate and extend the facilities of Enterprise Architect through:
· Scripts 1660
· The Enterprise Architect Object Model 1666
· The Enterprise Architect Add-In Model. 1776

© 1998-2010 Sparx Systems Pty Ltd

 1660 Automation and Scripts | Scripting

11.1 Scripting

Notes:
· This facility is available in the Corporate, Business and Software Engineering, Systems Engineering and
Ultimate editions.
· If you intend to use the Scripting facility under Crossover/WINE, you must also install Internet Explorer
version 6.0 or above.

Scripts executed in Enterprise Architect have access to the currently open model and are a powerful tool for
querying and updating the model in situations that would otherwise require you to perform time consuming
and repetitive GUI tasks. Enterprise Architect supports management of scripts using the following script
engines:
· JavaScript
· Microsoft JScript
· Microsoft VBScript
The management interface for Scripting is the Scripter window, which contains the:
· Script Tree View 1661 (Scripts tab), which you use to review, create and edit scripts
· Script Console 1663 (Console tab), which you use to operate on an executing script.

Scripts are managed in groups. The first group in the list is always Local Scripts, which are available to any
model. You cannot create, edit, drag-and-drop or delete these scripts. Local Scripts are files in the Scripts
subdirectory of the Enterprise Architect installation - any instance of Enterprise Architect that has a currently
open model can see these scripts.
All other groups are User Scripts, which you create yourself. A user group can be one of four types 1663 , each
of which applies a template and certain conditions to the scripts you create within that group. User scripts are
only visible inside the model in which they were created; the contents of the scripts are stored with the model,

Enterprise Architect User Guide

 Automation and Scripts | Scripting 1661

although they can be saved to the file system easily using the Script Editor 1439 .

11.1.1 Scripts Tab

Note:
This facility is available in the Corporate, Business and Software Engineering, Systems Engineering and
Ultimate editions.

The Scripts tab is composed of a toolbar and a view of all scripts according to group.

© 1998-2010 Sparx Systems Pty Ltd

 1662 Automation and Scripts | Scripting

To execute a script, press [Ctrl] while you double-click on the script name.
To write or edit a user script, double-click on the script name to display the Script Editor 1439 . This usually
displays a script template, determined by the user group type as assigned on the Script Group Properties
dialog 1663 .
You can move or copy a script from one user scripts folder to another. To:
· Move a script, highlight it in the Scripts tab and drag it into the user scripts folder it now belongs to
· Copy a script, highlight it in the Scripts tab and press [Ctrl] while you drag it into the user scripts folder in
which to duplicate it.

The Scripts tab toolbar provides the following options:

Icon Use to

Create a new script group. The new group is added to the end of the list in the Scripter window, with
the 'New group' text highlighted so that you can type in the group name.

Create a new script file in the selected script group; displays a short menu of the types of script you
can create, namely:

· VBScript ( )
· JScript ( )
· JavaScript ( )
The new script is added to the end of the list in the selected group, with the 'New script' text
highlighted so that you can type in the script name.

Refresh the script tree in the Scripter window. This icon also reloads any changes made to a
workflow script.

Compile and execute the selected script. The output from the script is written to the Script tab of the
Output window, which you display using the View Script Output button (below).

Stop an executing script. The icon is disabled if no script is executing.

Delete a script from the model. You cannot use this icon to delete a script group (see the Context
Menu 1662 section, below), scripts in the Local Scripts group, or a script that is executing.

Important:
The system prompts you to confirm the deletion only if the Confirm Deletes checkbox is selected
in the Project Browser panel of the General page 351 of the Options dialog. If this option is not
selected, no prompt is displayed. Script deletion is permanent - scripts cannot be recovered.

Display the Output window with the results of the most recently executed script displayed in the
Script tab.

Context Menus
The script groups and their scripts also have context menus that provide some or all of the following options:
· Group Properties - to display or edit script group properties in the Script Group Properties 1663 dialog
· Run Script - to execute the selected script
· Rename Script - to change the name of the selected group or script
· New VBScript/JScript/JavaScript - add a new script to the selected user group
· Import Workflow Script - to display the Browser dialog through which you locate and select a workflow
script source (.vbs) file to import into the Workflow script folder
· Delete Group/Script - to delete the selected user group or script.

Enterprise Architect User Guide

 Automation and Scripts | Scripting 1663

Note:
If you select to delete a script group that contains scripts, the system always prompts you to confirm the
action regardless of any system settings for delete operations. Be certain that you intend to delete the group
and its scripts before confirming the deletion - deletion of script groups and scripts is permanent.

11.1.1.1 Script Group Properties

The Script Group Properties dialog enables you to set the following properties of the script group:
· Name - The name of the script group; the dialog also displays the automatically-assigned GUID of the
group
· Group Type - The type of scripts contained in the group. This can be one of:
· Normal - ( ) Ordinary scripts
· Project Browser - ( ) Scripts that are listed in and can be executed from the Project Browser
Scripts 1214 context menu option 1214
· Workflow - ( ) Scripts executed by Enterprise Architect's workflow engine 220 ; you can create only
VB scripts of this type)
· Search - ( ) Scripts that can be executed as model searches 1231 ; these scripts are listed in the
Search field of the Model Search window.
· Notes - Your own notes on the script group.

11.1.2 Console Tab

Note:
This facility is available in the Corporate, Business and Software Engineering, Systems Engineering and
Ultimate editions.

The script console is a tab of the Scripter window. It is a command line interpreter with which you can quickly
enable a script engine and enter commands to act on the script.

© 1998-2010 Sparx Systems Pty Ltd

 1664 Automation and Scripts | Scripting

You type the commands in the field at the bottom of the tab; when you press the [Enter] key, the script
console executes the commands and displays any output immediately.
You can input two types of command:
· Console commands
· Script commands.

Console Commands
Console commands are preceded by the ! character and instruct the console to perform an action. The
available console commands are listed below; to list these commands on the Console tab itself (as shown
above) type? in the console field (without the preceding ! character) .
· c(lear) - clears the console display
· sa(ve) - saves the console display to a file
· h(elp) - prints a list of commands, as for ?
· VB - opens a VBScript console
· JA - opens a JavaScript console
· JS - opens a JScript console
· st(op) - closes any script running console
· i(nclude) name - executes the named script item; name is of the format GroupName.ScriptName (spaces
are allowed in names)
· ? - (without the !) lists commands
· ?name - Outputs the value of a variable name (only if a script console is opened).

Script Commands
A script command is script code that depends on the script engine. Script commands can be executed only
once a script console has been created.
Examples:
The following lines, entered into the console, create a VBScript console and then execute the script MyScript
in the user group MyGroup.
>!VB
>!i MyGroup.MyScript
The following lines, entered into the console, create a JScript console and then create a variable called x with
the value 1.
>!JS
>var x = 1
The following diagram shows the result of entering the above JScript example. Remember that you can use

Enterprise Architect User Guide

 Automation and Scripts | Scripting 1665

?<variable name> to get the current value of any item you have created during the console session.

Console Tab Toolbar

The Console tab has two operations available through the toolbar:

· Open Console ( ) - click on the down-arrow and select to open a VBScript console, JScript console or
JavaScript console

· Stop Script ( ) - click to stop an executing script and close the current console.

© 1998-2010 Sparx Systems Pty Ltd

 1666 Automation and Scripts | Enterprise Architect Object Model

11.2 Enterprise Architect Object Model

Introduction
Automation provides a way for other applications to access the information in an Enterprise Architect model
using Windows OLE Automation (ActiveX). Typically this involves scripting clients such as MS Word or Visual
Basic, or using scripts created within Enterprise Architect using the Scripter window 1660 .
The Automation Interface provides a way of accessing the internals of Enterprise Architect models. Examples
of things you can do using the Automation Interface include:
· Perform repetitive tasks, such as update the version number for all elements in a model
· Generate code from a State Machine diagram
· Produce custom reports
· Perform ad hoc queries.

Connecting to the Automation Interface

All development environments capable of generating ActiveX Com clients should be able to connect to the
Enterprise Architect Automation Interface. This guide provides detailed instructions on connecting to the
interface 1666 using Microsoft Visual Basic 6.0, Borland Delphi 7.0, Microsoft C# and Java. There are also more
detailed steps on how to set-up Visual Basic 1668 ; the principles are applicable to other languages.

Examples and Tips

Instruction on how to use the Automation Interface is provided by means of sample code. See pointers to the
samples 1669 and other available resources 1671 . Also, consult the extensive Reference Section 1671 .

Calling Executables from Enterprise Architect

Enterprise Architect can be set up to call an external application. You can pass parameters on the current
position selected in the Project Browser to the application being called. For instructions, go to the Call from
Enterprise Architect 1670 topic. A more sophisticated method is to create Add-Ins 1776 , which are discussed in a
separate topic.

11.2.1 Using the Automation Interface

This section provides instructions on how to connect to and use the Automation Interface, including:
· Connecting to the Interface 1666
· Setting References In Visual Basic 1668

· Examples and Tips 1669

11.2.1.1 Connect to the Interface

All development environments capable of generating ActiveX Com clients should be able to connect to the
Enterprise Architect Automation Interface.
By way of example, the following sections describe how to connect using several such tools. The procedure
might vary slightly with different versions of these products.

Microsoft Visual Basic 6.0

1. Create a new project.
2. Select the Project | References menu option.
3. Select Enterprise Architect Object Model 2.0 from the list. (If this does not appear, go to the command
line and re-register Enterprise Architect using

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1667

EA.exe /unregister

then

EA.exe /register).
4. See the general library documentation on the use of Classes. The following example creates and opens
a repository object:

Public Sub ShowRepository()

Dim MyRep As New EA.Repository
MyRep.OpenFile "c:\eatest.eap"
End Sub

Borland Delphi 7.0

1. Create a new project.
2. Select the Project | Import Type Library menu option.
3. Select Enterprise Architect Object Model 2.0 from the list. (If this does not appear, go to the
command line and re-register Enterprise Architect using

EA.exe /unregister

then

EA.exe /register).
4. Click on the Create Unit button.
5. Include EA_TLB in Project1's Uses clause.
6. See the general library documentation on the use of Classes. The following example creates and opens
a repository object:

procedure TForm1.Button1Click(Sender: TObject);

var
r: TRepository;
b: boolean;
begin
r:= TRepository.Create(nil);
b:= r.OpenFile('c:\eatest.eap');
end;

Microsoft C#
1. Select the Visual Studio Project | Add Reference menu option.
2. Click on the Browse tab.
3. Navigate to the folder in which you installed Enterprise Architect (usually Program Files/Sparx Systems/EA)
and select Interop.EA.dll.
4. See the general library documentation on the use of Classes. The following example creates and opens
a repository object:

private void button1_Click(object sender, System.EventArgs e)

{
EA.Repository r = new EA.RepositoryClass();
r.OpenFile("c:\\eatest.eap");
}

Java
1. Copy the file SSJavaCOM.dll from the Java API subdirectory of your installed directory (usually Program
Files/Sparx Systems/EA) into any location within the Windows PATH. For example, the windows\system32
directory.
2. Copy the eaapi.jar file from the Java API subdirectory of your installed directory (usually Program Files/
Sparx Systems/EA) to a location in the Java CLASSPATH or where the Java class loader can find it at run
time.
3. All of the Classes described in the documentation are in the package org.sparx. See the general library
documentation 1671 for their use. The following example creates and opens a repository object.

public void OpenRepository()

© 1998-2010 Sparx Systems Pty Ltd

 1668 Automation and Scripts | Enterprise Architect Object Model

{
org.sparx.Repository r = new org.sparx.Repository();
r.OpenFile("c:\\eatest.eap");
}

11.2.1.1.1 Set References In Visual Basic

This topic describes how to use the Enterprise Architect ActiveX interface with Visual Basic (VB). Use is
ensured for Visual Basic version 6. This might vary slightly with versions other than version 6.
It is assumed that you have accessed VB through a Microsoft Application such as VB 6.0, MS Word or MS
Access. If the code is not called from within Word, the Word VB reference must also be set.
On creating a new VB project, set a reference to an Enterprise Architect Type Library and a Word Type
Library. Follow the steps below:
1. Select the Tools | References menu option. The following dialog displays:

2. Select the Enterprise Architect Object Model 2.10 checkbox from the list.
3. Do the same for VB or VB Word: select the checkbox for the Microsoft Word 10.0 Object Library.
4. Click on the OK button.

Note:
If Enterprise Architect Object Model 2.10 does not appear in the list, go to the command line and manually re-
enter Enterprise Architect using the following:
· To unregister Enterprise Architect: ea.exe /unregister

· To register Enterprise Architect: ea.exe /register.

Visual Basic 5/6 users should also note that the version number of the Enterprise Architect interface is stored
in the VBP project file in a form similar to the following:
Reference=*\G{64FB2BF4-9EFA-11D2-8307-C45586000000}#2.2#0#..\..\..\..\Program Files\Sparx Systems\EA\EA.
TLB#Enterprise Architect Object Model 2.02
If you experience problems moving from one version of Enterprise Architect to another, open the VBP file in a
text editor and remove this line. Then open the project in Visual Basic and use Project-References to create
a new reference to the Enterprise Architect Object model.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1669

Reference to objects in Enterprise Architect and Word should now be available in the Object Browser. This
can be accessed from the main menu by selecting View | Object Browser, or by pressing [F2].
The drop-down list on the top-left of the window should now include Enterprise Architect and Word. If MS-
Project is installed this must also be set up.

11.2.1.2 Examples and Tips

Instructions for using the interface are provided through sample code. There are several sets of examples:
· VB 6 and C# examples are available in the Code Samples folder under your Enterprise Architect
installation (default: C:\Program Files\Sparx Systems\EA\Code Samples)
· Enterprise Architect can be set up to call an external application 1670
· Several VB.NET code snippets are provided in the reference section 1765
· A comprehensive example of using Visual Basic to create MS Word documentation is available from the
internet at www.sparxsystems.com/resources/developers/autint_vb.html
· Additional samples are available from the Sparx Systems website; see the Available Resources 1671 topic.

Additionally, you should note the following tips and tricks:

· An instance of the Enterprise Architect (EA.exe) process is executed when you initialize a new repository
object. This process must remain running in order to perform automation tasks. If the main window is
visible, you can safely minimize it, but it must remain running.
· The Enterprise Architect ActiveX Interface is a functional interface rather than a data interface. When you
load data through the interface there is a noticeable delay as Enterprise Architect user interface elements
(such as Windows, menus) are loaded and the specified database connection is established.
· Collections use a zero-based index; for example, Repository.Models(0) represents the first model in the
repository.
· During the development of your client software your program might terminate unexpectedly and leave EA.
exe running in such a state that it is unable to support further interface calls. If your program terminates
abnormally, ensure that Enterprise Architect is not left running in the background (see the Windows Task
Manager / Process tab).
· A handle to a currently running instance of Enterprise Architect can be obtained through the use of a
GetObject() call. For more information, refer to the reference page for the App 1674 object. Accessing your

© 1998-2010 Sparx Systems Pty Ltd

 1670 Automation and Scripts | Enterprise Architect Object Model

Enterprise Architect model via the App object enables querying the current User Interface status, such as
using GetContextItem() on the Repository 1680 object to detect the current selection by the user, allowing for
rapid prototyping and testing.

Enterprise Architect Not Closing

If your automation controller was written using the .NET framework, Enterprise Architect does not close even
after you release all your references to it. To force the release of the COM pointers, call the memory
management functions as shown below:
GC.Collect();
GC.WaitForPendingFinalizers();
There are additional concerns when controlling a running instance of Enterprise Architect that loads Add-Ins -
see the Tricks and Traps 1779 topic for details.

11.2.1.2.1 Call from Enterprise Architect

Enterprise Architect can be set up to call an external application. You can pass parameters on the current
position selected in the Project Browser to the application being called.
To define an application that you can run from Enterprise Architect, select the Tools | Customize menu
option. The Customize dialog displays. Select the Tools tab.

With this you can:

· Add a command line for an application
· Define parameters to pass to this application
The parameters required for running the AutInt executable are:
· The Enterprise Architect file parameter $f and
· The current PackageID $p
Hence the arguments should simply contain: $f, $p
The available parameters for passing information to external applications are:

Parameter Description Notes

$d Diagram ID ID for accessing associated diagram.

$D Diagram GUID GUID for accessing the associated diagram.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1671

Parameter Description Notes

$e Comma separated list of element IDs All elements selected in the current diagram.

$E Comma separated list of element All elements selected in the current diagram.
GUIDs

$f Project Name For example: C:\projects\EAexample.eap.

$F Calling Application (Enterprise 'Enterprise Architect'.

Architect)

$p Current Package ID For example: 144.

$P Package GUID GUID for accessing this package.

Once this has been set up, the application can be called from the main menu in Enterprise Architect using the
Tools | YourApplication menu option.

11.2.1.2.2 Available Resources

Other available resources include:

Resource Download Link

VB 6 Add-In for generating MS Word www.sparxsystems.com/resources/developers/autint_vb.html

documentation.

VB 6 Add-In to display a custom ActiveX www.sparxsystems.com/resources/developers/autint_vb_custo

graph control within the Enterprise m_view.html
Architect window as a new view.

A basic Add-In framework written in C#. www.sparxsystems.com/bin/CS_AddinFramework.zip

Useful as a starting point for authoring your
own custom Enterprise Architect Add-In.

An extension on the CS_AddinFramework www.sparxsystems.com/bin/CS_AddinTaggedCSV.zip

example showing how to export Tagged
Values to a .csv file.

A basic Add-In skeleton written in Delphi. www.sparxsystems.com/bin/DelphiDemo.zip

A simple example Add-In written in C#. www.sparxsystems.com/bin/CS_Sample.zip

For further information, see www.sparxsystems.com/resources/developers/autint.html.

11.2.2 Reference
This section provides detailed information on all the objects available in the object model provided by the
Automation Interface, covering:
· Interface Overview 1672
· App 1674
· Enumerations 1675
· Repository 1679
· Element 1708
· Element Features 1726
· Connector 1738
· Diagram Package 1745
· Project Interface 1753
· Code Samples 1765

© 1998-2010 Sparx Systems Pty Ltd

 1672 Automation and Scripts | Enterprise Architect Object Model

11.2.2.1 Interface Overview

public Package
This package provides an overview of the main elements within the Automation Interface. These are:
· The Repository 1679 , which represents the model as a whole and provides entry to model packages and
collections
· Elements 1708 , which are the basic structural unit (such as Class, Use Case and Object)
· Element Features 1726 , which are attributes and operations defined on an element
· Diagram Package 1745 , the visible drawings contained in the model
· Connectors 1738 , relationships between elements.
The following diagram illustrates the main interface elements and their associated contents. Each element in
this document is creatable by Automation and can be accessed through the various collections that exist or, in
some cases, directly.

The following diagram provides a high level overview of the Automation Interface for accessing, manipulating,
modifying and creating elements. The top level object is the Repository, which contains collections for a
variety of system level objects, as well as the main Models collection that provides access to the UML
elements, diagrams and packages within the project. In general, the Role names applied at the Target end of
associations indicate the name of the Collection that is used to access instances of that object.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1673

Internal Links
· Logical diagram:: Automation Interface
Package:: Automation Interface
· Logical diagram:: Automation Interface
Package:: Automation Interface
· Logical diagram:: Automation Interface
Package:: Automation Interface
· Logical diagram:: Automation Interface

© 1998-2010 Sparx Systems Pty Ltd

 1674 Automation and Scripts | Enterprise Architect Object Model

Package:: Automation Interface

· Logical diagram:: Automation Interface
Package:: Automation Interface
· Logical diagram:: Automation Interface
Package:: Automation Interface
· Logical diagram:: Automation Interface
Package:: Automation Interface

Connectors
Connector Source Target

Nesting Connector Overview

source > target Contained Element Containing Element

Nesting Repository Overview

source > target Contained Element Containing Element

Nesting Diagram Overview

source > target Contained Element Containing Element

Nesting Element Overview

source > target Contained Element Containing Element

Nesting Project Interface Overview

source > target Contained Element Containing Element

Nesting ElementFeatures Overview

source > target Contained Element Containing Element

11.2.2.2 App
The App object represents a running instance of Enterprise Architect. Its object provides access to the
Automation Interface.

Attribute Type Notes

Project Project Read only. Provides a handle to the Project Interface.

Repository Repository Read only. Provides a handle to the Repository object.

Visible Boolean Read/Write. Whether or not the application is visible.

GetObject() Support
The App object is creatable and a handle can be obtained by creating one. In addition, clients can use the
equivalent of Visual Basic's GetObject() to obtain a reference to a currently running instance of Enterprise
Architect.
Use this method to more quickly test changes to Add-Ins and external clients, as the Enterprise Architect
application and data files do not have to be constantly re-loaded.
For example:
Dim App as EA.App
Set App = GetObject(,"EA.App")
MsgBox App.Repository.Models.Count

Another example, which uses the App object without saving it to a variable:
Dim Rep as EA.Repository
Set Rep = GetObject(, "EA.App").Repository
MsgBox Rep.ConnectionString

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1675

11.2.2.3 Enumerations
These enumerations are defined by the Automation Interface:
· ConstLayoutStyles 1675
· CreateBaselineFlag 1676
· CreateModelType 1676
· EAEditionTypes 1676
· EnumRelationSetType 1676
· ExportPackageXMIFlag 1677
· MDGMenus 1677
· ObjectType 1677
· PropType 1678
· ReloadType 1678
· ScenarioDiagramType 1678
· ScenarioStepType 1679
· ScenarioTestType 1679
· XMIType 1679

11.2.2.3.1 ConstLayoutStyles Enum

The enum values defined here are used exclusively for the Lay Out a Diagram method. They enable you to
define the layout options as depicted in the Layout Diagram menu option. For further information, see the
Lay Out a Diagram 471 topic.

Method Use to

lsCrossReduceAggressive Perform aggressive Cross-reduction in the layout process (time

consuming).

lsCycleRemoveDFS Use the Depth First Cycle Removal algorithm.

lsCycleRemoveGreedy Use the Greedy Cycle Removal algorithm.

lsDiagramDefault Use existing layout options specified for this diagram.

lsInitializeDFSIn Initialize the layout using the Depth First Search Inward algorithm.

lsInitializeNaive Initialize the layout using the Naïve Initialize Indices algorithm.

lsInitializeDFSOut Initialize the layout using the Depth First Search Outward algorithm.

lsLayeringLongestPathSink Layer the diagram using the Longest Path Sink algorithm.

lsLayeringLongestPathSource Layer the diagram using the Longest Path Source algorithm.

lsLayeringOptimalLinkLength Layer the diagram using the Optimal Link Length algorithm.

lsLayoutDirectionDown Direct connectors to point downwards.

lsLayoutDirectionLeft Direct connectors to point leftwards.

lsLayoutDirectionRight Direct connectors to point rightwards.

lsLayoutDirectionUp Direct connectors to point upwards.

lsProgramDefault Use factory default layout options as specified by Enterprise Architect.

© 1998-2010 Sparx Systems Pty Ltd

 1676 Automation and Scripts | Enterprise Architect Object Model

11.2.2.3.2 CreateBaselineFlag Enum

The CreateBaselineFlag enumeration is used in Baseline Management, when creating a Baseline.

Method Use to

cbSaveToStub Baseline this package with only immediate children. (Child

packages are included as stubs only.)

11.2.2.3.3 CreateModelType Enum

The CreateModelType enumeration is used in the CreateModel 1684 method on the Repository class.

Method Use to

cmEAPFromBase Create a copy of the EABase model file to the specified file path.

cmEAPFromSQLRepository Create a .eap file shortcut to an SQL-based repository. Requires

user interaction to provide sql connection details.

11.2.2.3.4 EAEditionTypes Enum

The EAEditionTypes enumeration identifies the level of licensed functionality available to the current
repository. For example:
EAEditionTypes theEdition = theRepository.GetEAEdition();
if ( theEdition == EAEditionTypes.piDesktop )
...
else if ( theEdition == EAEditionTypes.piProfessional )
...
The enumeration defines the following formal values:
· piLite
· piDesktop
· piProfessional
· piCorporate
· piBusiness
· piSystemEng
· piUltimate.
There is no separate value for the trial edition; the Repository.EAEdition attribute contains the appropriate
EAEditionTypes value for whichever edition the user has selected to trial.

11.2.2.3.5 EnumRelationSetType Enum

This enumeration represents values returned from the GetRelationSet method of the Element 1711 object.

Method Notes

rsDependEnd List of elements that depend on the current element.

rsDependStart List of elements that the current element depends on.

rsGeneralizeEnd List of elements that are generalized by the current element.

rsGeneralizeStart List of elements that the current element generalizes.

rsParents List of all parent elements of the current element.

rsRealizeEnd List of elements that are realized by the current element.

rsRealizeStart List of elements that the current element realizes.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1677

11.2.2.3.6 ExportPackageXMIFlag Enum

The ExportPackageXMIFlag enumeration is used in package control, when exporting to XMI.

Method Use to

epSaveToStub Export this package with only immediate children. (Child packages
are included as stubs only.)

11.2.2.3.7 MDGMenus Enum

Use this enumeration when providing the HiddenMenus property to MDG_GetProperty.
These options are exclusive of one another and can be read or added to hide more than one menu.
See the MDG_GetProperty 1824 topic for an example of use.

Method Use to

mgBuildProject Hide Build Project menu option.

mgMerge Hide Merge menu option.

mgRun Hide Run menu option.

11.2.2.3.8 ObjectType Enum

The ObjectType enumeration identifies Enterprise Architect object types even when referenced through a
Dispatch interface.
For example:
Object ob = Repository.GetElementByID(13);
if ( ob.ObjectType == otElement )
;
else if( ob.ObjectType == otAuthor )
...
All of the following are valid enumeration values:

otAttribute otPackage
otAttributeConstraint otParameter
otAttributeTag otPartition
otAuthor otProject
otClient otProjectIssues
otCollection otProjectResource
otConnector otProperties
otConnectorConstraint otProperty
otConnectorEnd otPropertyType
otConnectorTag otReference
otConstraint otRepository
otCustomProperty otRequirement
otDatatype otResource
otDiagram otRisk
otDiagramLink otRoleTag
otDiagramObject otScenario
otEffort otScenarioExtension
otElement otScenarioStep
otEventProperties otStereotype
otEventProperty otSwimlane
otFile otSwimlaneDef
otIssue otSwimlanes
otMethod otTaggedValue
otMethodConstraint otTask
otMethodTag otTerm
otMetric otTest
otModel otTransition

© 1998-2010 Sparx Systems Pty Ltd

 1678 Automation and Scripts | Enterprise Architect Object Model

otNone

11.2.2.3.9 PropType Enum

The PropType enumeration gives the automation programmer an indication of what sort of data is going to be
stored by this property.

Method Notes

ptArray An array containing values of any type.

ptBoolean True or False.

ptEnum A string being an entry in the semi-colon separated list specified in the
validation field of the Property.

ptFloatingPoint 4 or 8 byte floating point value.

ptInteger 16-bit or 32-bit signed integer.

ptString Unicode string.

11.2.2.3.10 ReloadType Enum

This enumeration represents values returned from the GetReloadItem and PeekReloadItem methods of the
ModelWatcher Class. It has four possible values, which define the type of change that was made to a model.

Method Notes

rtElement The Item parameter represents a particular element that must be reloaded.

rtEntireModel Entire model must be reloaded to ensure that all changes are reloaded.

rtNone No change in the model.

rtPackage The Item parameter represents a particular package that must be reloaded.

11.2.2.3.11 ScenarioDiagramType Enum

The ScenarioDiagramType enumeration provides the following enumeration values to the
Project.GenerateDiagramFromScenario() 1757 method. They specify the type of diagram to generate.

Method Use to

sdActivity Generate an Activity diagram 500

sdActivityWithAction Generate an Activity diagram with an Action 500 .

sdActivityWithActionPin Generate an Activity diagram with an ActionPin 500 .

sdActivityWithActivityParameter Generate an Activity diagram with an ActivityParameter. 500

sdRobustness Generate a Robustness diagram. 504

sdRuleFlow Generate a RuleFlow diagram. 501

sdSequence Generate a Sequence diagram. 503

sdState Generate a State Machine diagram. 501

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1679

11.2.2.3.12 ScenarioStepType Enum

The ScenarioStepType enumeration is used to identify the steps 1723 of a scenario, and the entity performing
the step.

Method Use to

stActor Identify that the step is an action performed by an actor.

stSystem Identify that the step is an action performed by the system.

11.2.2.3.13 ScenarioTestType Enum

The ScenarioTestType enumeration provides the following enumeration values to the
Project.GenerateTestFromScenario() 1758 method. They specify the type of test to generate 505 .

Method Use to

stExternal Generate an external Test Case element.

stInternal Generate an internal test.

11.2.2.3.14 XMIType Enum

The following enumeration values are used in the Project.ExportPackageXMI() method. They enable
specification of the XMI export type.
xmiEADefault
xmiRoseDefault
xmiEA10
xmiEA11
xmiEA12
xmiEA20
xmiEA21
xmiMOF13
xmiMOF14
xmiRose10
xmiRose11
xmiRose12

11.2.2.4 Repository

public Package
The Repository package contains the high level system objects and entry point into the model itself using the
Models collection and the other system level collections.
This diagram illustrates the Repository 1680 and its first level functions and collections.

© 1998-2010 Sparx Systems Pty Ltd

 1680 Automation and Scripts | Enterprise Architect Object Model

11.2.2.4.1 Repository

public Class
The Repository is the main container of all structures such as models, packages and elements. You can
iteratively begin accessing the model using the Models collection. It also has some convenient methods to
directly access the structures without having to locate them in the hierarchy first.
Associated table in .EAP file: <none>

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1681

Repository Attributes
Attribute Type Notes

Authors Collection 1695 Read only. The system Authors collection. Contains 0 or
more Author objects, each of which can be associated
with, for example, elements or diagrams as the item author
or owner. Use AddNew, Delete and GetAt to manage
Authors.

BatchAppend Boolean Read/Write. Set this property to true when your

automation client has to rapidly insert many elements,
operations, attributes and/or operation parameters. Set to
false when work is complete.
This can result in 10- to 20-fold improvement in adding
new elements in bulk.

Clients Collection 1695 Read only. A list of Clients associated with the project. You
can modify, delete and add new Client objects using this
collection.

ConnectionString String Read only. The filename/connection string of the current

Repository.

Datatypes Collection 1695 Read only. The Datatypes collection. Contains a list of
Datatype objects, each representing a data type definition
for either data modeling or code generation purposes.

EAEdition EAEditionTyp Read only. Returns the level of core licensed functionality
es 1676 available to the current repository.

Note:
This property returns Corporate when the edition is
Business and Software Engineering, Systems
Engineering or Ultimate. Use EAEditionEx to identify
which of these extended editions is available.

EAEditionEx EAEditionTyp Read only. Returns the level of extended licensed

es 1676 functionality available to the current repository.

EnableCache Boolean Read/Write. An optimization for pre-loading package

objects when dealing with large sets of automation objects.

EnableUIUpdates Boolean Read/Write. Set this property to false to improve the

performance of changes to the model; for example, bulk
addition of elements to a package. To reveal the changes
to the user, call Repository.RefreshModelView().

FlagUpdate Boolean Read/Write. Instructs Enterprise Architect to update the

Repository with the LastUpdate value.

InstanceGUID String Read only. The identifier string identifying the Enterprise
Architect runtime session.

IsSecurityEnabled Boolean Read only. Checks whether User Security is enabled for
the current repository.

Issues Collection 1695 Read only. The System Issues list. Contains ProjectIssues
objects, each detailing a particular issue as it relates to the
project as a whole.

LastUpdate String Read only. The identifier string identifying the Enterprise
Architect runtime session and the timestamp for when it
was set.

© 1998-2010 Sparx Systems Pty Ltd

 1682 Automation and Scripts | Enterprise Architect Object Model

Attribute Type Notes

LibraryVersion Long Read only. The build number of the Enterprise Architect
runtime.

Models Collection 1695 Read only. Models are of type package and belong to a
of type collection of packages. This is the top level entry point to
Package 1698 an Enterprise Architect project file. Each model is a root
node in the Project Browser and can contain items such as
Views and packages.
A model is a special form of a package; it has a ParentID
of 0. By iterating through all models, you can access all
the elements within the project hierarchy.
You can also use the AddNew function to create a new
model. A model can be deleted, but remember that
everything contained in the model is deleted as well.

ObjectType ObjectType Read only. Distinguishes objects referenced through the

1677 Dispatch interface.

ProjectGUID String Read only. Returns a unique ID for the project.

PropertyTypes Collection 1695 Read only. Collection of Property Types 1704 available to
the Repository.

Resources Collection 1695 Read only. Contains available ProjectResource objects to

assign to work items within the project. Use the add new,
modify and delete functions to manage resources.

Stereotypes Collection 1695 Read only. The Stereotype 1706 collection. A list of
Stereotype objects that contain information on a
stereotype and which elements it can be applied to.

SuppressEADialogs Boolean Read/Write. Set this property in the

EA_OnPostNewElement 1798 or EA_OnPostNewConnector
1799 broadcast events to control whether Enterprise

Architect should suppress showing the default Properties

dialogs to the user when an element or connector is
created.

Tasks Collection 1695 Read only. A list of system tasks (to do list). Each entry is
a Task 1707 Item; you can modify, delete and add new
tasks.

Terms Collection 1695 Read only. The project Glossary. Each Term 1708 object is
an entry in the Glossary. Add, modify and delete Terms to
maintain the Glossary.

Repository Methods
Method Type Notes

ActivateDiagram (long Activates an already open diagram (that is, makes it the
DiagramID) active tab) in the main Enterprise Architect user interface.
Parameters:
· DiagramID: Long - the ID of the diagram to make
active.
ActivatePerspective (string, Boolean Deprecated - no longer in use.
long)

ActivateTab (string Name) Activates an open Enterprise Architect tabbed view.

Parameters:

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1683

Method Type Notes

· Name: String - the name of the view to activate.

ActivateTechnology (string Activates an enabled MDG Technology.
Name)
Parameters:
· Name: String - the name of the Technology to activate.
ActivateToolbox (string Boolean Activates a Toolbox page in the GUI.
Toolbox, long Options)
Returns true if the specified Toolbox page is successfully
activated, otherwise returns false.
Parameters:
· Toolbox: String - the name of the Toolbox page to
activate.
· Options: Long - reserved for future use.
AddDefinedSearches (string Enables you to enter a set of defined searches that last in
sXML) Enterprise Architect for the life of the application. When
Enterprise Architect loads again they must be inserted again
by your Add-In.
Parameters:
· sXML: String - the XML of the defined searches; you
can get this XML by performing an export of the
searches from the Manage Searches 1235 dialog in
Enterprise Architect.
AddPerspective (string Boolean Deprecated - no longer in use.
Perspective, long Options)

AddTab (string TabName, activeX Adds an ActiveX custom control as a tabbed window.
string ControlID) custom Enterprise Architect creates a control and, if successful,
control returns its Unknown pointer, which can be used by the caller
to manipulate the control.
Parameters:
· TabName: String - used as the tab caption.
· ControlID: String - the ProgID of the control; for
example, Project1,UserControl1.
AddWindow (string activeX Adds an ActiveX custom control as a window to the Add-Ins
WindowName, string custom docked window. Enterprise Architect creates a control and,
ControlID) control if successful, returns its Unknown pointer, which can be
used by the caller to manipulate the control.
The window can be shown by selecting it from the list in the
Workspace Layouts 86 toolbar - click on the third icon from
the right and look at the end of the list.
Parameters:
· WindowName: String - used as the window title.
· ControlID: String - the ProgID of the control; for
example, Project1,UserControl1.
AdviseConnectorChange (long Provides an Add-In or automation client with the ability to
ConnectorID) advise the Enterprise Architect user interface that a
particular connector has changed and, if it is visible in any
open diagram, to reload and refresh that connector for the
user.
Parameters:
· ConnectorID: Long - the ID of the connector.
AdviseElementChange (long Provides an Add-In or automation client with the ability to
advise the Enterprise Architect user interface that a

© 1998-2010 Sparx Systems Pty Ltd

 1684 Automation and Scripts | Enterprise Architect Object Model

Method Type Notes

ObjectID) particular element has changed and, if it is visible in any

open diagram, to reload and refresh that element for the
user.
Parameters:
· ObjectID: Long - the ID of the element.
ChangeLoginUser (string Boolean Sets the currently logged on user to be that specified by a
Name, string Password) name and password. This logs the user into the repository
when security is enabled. If security is not enabled an
exception (Security not enabled) is thrown.
Parameters:
· Name: String - the name of the user.
· Password: String - the password of the user.
ClearAuditLogs (Object Boolean Clears all Audit Logs from the model.
StartDateTime, Object
If StartDateTime and EndDateTime are not null then only log
EndDateTime)
items that fall into this period are cleared.
Returns true for success, false for failure.

Notes:
· This method cannot be undone. It is strongly advised
that you call SaveAuditLogs first to backup the logs.
· This method might fail if the user logged into the model
does not have the correct access permission.

Parameters:
· StartDateTime: Variant [DateTime] - the earliest date
and time of log entries to clear.
· EndDateTime; Variant [DateTime] - the latest date and
time of log entries to clear.
ClearOutput (string Name) Removes all the text from a tab in the Output window. See
also CreateOutputTab 1685 , EnsureOutput Visible 1685 ,
WriteOutput 1693 .
Parameters:
· Name: String - the name of the tab to remove text from.
CloseAddins () Called by automation controllers to ensure that Add-Ins
created in
.NET do not linger after all controller references to
Enterprise Architect have been cleared.

CloseDiagram (long Closes a diagram in the current list of diagrams that

DiagramID) Enterprise Architect has open.
Parameters:
· DiagramID: Long - the ID of the diagram to close.
CloseFile () Closes any open file.

CreateModel Boolean Creates a new .eap model file based on the standard
(CreateModelType CreateType, Enterprise Architect Base model, or a shortcut .eap based
string FilePath, long on a provided SQL connection.
ParentWnd) Returns true when the new file is created, otherwise returns
false.
Parameters:
· CreateType: CreateModelType 1676 - Specify whether to

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1685

Method Type Notes

make a new copy of the EABase.eap model, or create

a .eap file shortcut to a DBMS repository. The latter
option requires a dialog to be opened for the user to
provide SQL connection details.
· FilePath: String - Destination for new .eap file.
· ParentWnd: Long - Window handle to act as the parent
for the SQL connection dialog. Only required when
using cmEAPFromSQLRepository.
CreateOutputTab (string Creates a tab in the Output window. See also ClearOutput
Name) 1684 , EnsureOutput Visible 1685 , WriteOutput 1693 .

Parameters:
· Name: String - the name of the tab to create.
DeletePerspective (string Boolean Deprecated - no longer in use.
Perspective, long Options)

DeleteTechnology (string ID) Boolean Removes a specified MDG Technology resource from the
repository.
Returns true, if the technology is successfully removed from
the model. Returns false otherwise.

Note:
This applies to technologies imported into pre-7.0 versions
of Enterprise Architect (imported technologies), not to
technologies referenced in version 7.0 and later
(referenced technologies). See Deploy an MDG
Technology 1147 (from Add-Ins).

Parameters:
· ID: String - the ID of the technology.
EnsureOutputVisible (string Ensures that a specified tab in the Output window is visible
Name) to the user. The Output window is made visible if it is
hidden. See also ClearOutput 1684 , CreateOutputTab 1685 ,
WriteOutput 1693 .
Parameters:
· Name: String - the name of the tab to make visible.
ExecutePackageBuildScript Enables you to run the active package build script based on
(long ScriptOptions, string your current selection in the Project Browser. You can also
PackageGuid) run a script by passing in the package GUID.
Parameters:
· ScriptOptions: Long - the script type; can be any one of
these numerical values:
1 = Build
2 = Test
3 = Run
4 = Create Workbench Instance
5 = Debug.
· PackageGuid: String - the ID of the package for which
to run the script.
Exit Shuts down Enterprise Architect immediately. Used by .NET
programmers where the garbage collector does not
immediately release all referenced COM objects.

GetActivePerspective () String Deprecated - no longer in use.

© 1998-2010 Sparx Systems Pty Ltd

 1686 Automation and Scripts | Enterprise Architect Object Model

Method Type Notes

GetAttributeByGuid (string Attribute Returns a pointer to an attribute in the repository, located by

Guid) 1727 its GUID.This is usually found using the AttributeGUID
property of an attribute.
Parameters:
· Guid: String - the GUID of the attribute to locate.
GetAttributeByID (string Id) Attribute Returns a pointer to an attribute in the repository, located by
1727 its ID. This is usually found using the AttributeID property of
an attribute.
Parameters:
· Id: String - the ID of the attribute to locate.
GetConnectorByGuid (string Connector Returns a pointer to a connector in the repository, located
Guid) 1739 by its GUID. This is usually found using the ConnectorGUID
property of a connector.
Parameters:
· Guid: String - the GUID of the connector to locate.
GetConnectorByID (long Connector Searches the repository for a connector with a specific ID.
ConnectorID) 1739
Parameters:
· ConnectorID: Long - the ID of the connector to locate.
GetContextItem (object Item) ObjectTyp Sets a pointer to an item in context within Enterprise
e 1677 Architect.
Also returns the corresponding ObjectType.
For additional information about ContextItems and the
supported ObjectTypes see the GetContextItemType
method (below).
Parameters:
· Item: Object - the item to point to.
GetContextItemType () ObjectTyp Returns the ObjectType of an item in context within
e 1677 Enterprise Architect. A ContextItem is defined as an item
selected anywhere within the Enterprise Architect GUI
including:
· An item selected in the Project Browser
· An item selected in an open diagram
· An item selected in certain dialogs, such as the
attribute Properties dialog.
The supported ObjectTypes can be any one of the following
values:
· otElement
· otPackage
· otDiagram
· otAttribute
· otMethod
· otConnector
GetContextObject () Object Returns the current context Object.

GetCounts () String Returns a set of counts from a number of tables within the
base Enterprise Architect repository. These can be used to
determine whether records have been added or deleted
from the tables for which information is retrieved.

GetCurrentDiagram () Diagram Returns a selected diagram.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1687

Method Type Notes

1746

GetCurrentLoginUser (boolean String If security is not enabled in the repository, an error is

GetGuid = false) generated.
If GetGuid is True, a GUID generated by Enterprise
Architect representing the user is returned; otherwise the
text as entered in System Users/User Details/Login is
returned.

GetDiagramByGuid (string Diagram Returns a pointer to a diagram using the global reference ID
Guid) 1746 (global ID). This is usually found using the diagram GUID
property of an element, and stored for later use to open an
diagram without using the collection GetAt() function.
Parameters:
· Guid: String - the GUID of the diagram to locate.
GetDiagramByID (long Diagram Gets a pointer to a diagram using an absolute reference
DiagramID) 1746 number (local ID). This is usually found using the DiagramID
property of an element, and stored for later use to open a
diagram without using the collection GetAt() function.
Parameters:
· DiagramID: Long - the ID of the diagram to locate.

GetElementByGuid (string Element Returns a pointer to an element in the repository, using the
Guid) 1711 element's GUID reference number (global ID). This is
usually found using the ElementGUID property of an
element, and stored for later use to open an element without
using the collection GetAt() function.
Parameters:
· Guid: String - the GUID of the element to locate.
GetElementByID (long Element Gets a pointer to an element using an absolute reference
ElementID) 1711 number (local ID). This is usually found using the ElementID
property of an element, and stored for later use to open an
element without using the collection GetAt() function.
Parameters:
· ElementID: Long - the ID of the element to locate.
GetElementsByQuery (string Enables the user to run a search in Enterprise Architect,
QueryName, string returning the result as a collection.
SearchTerm) For example GetElementsByQuery('Simple','Class1'), where
results contain elements with Class1 in the Name and
Notes fields.
Parameters:
· QueryName: String - the name of the search to run, for
example 'Simple'.
· SearchTerm: String - the term to search for.
GetElementSet (string IDList, Collection Returns a set of elements as a collection based on a
long Options) 1695 comma-separated list of ElementID values. By default, if no
values are provided in the IDList parameter, all objects for
the entire project are returned.
Parameters
· IDList: String - a comma-separated list of ElementID
values
· Options: Long - modifies default behaviour of this
method

© 1998-2010 Sparx Systems Pty Ltd

 1688 Automation and Scripts | Enterprise Architect Object Model

Method Type Notes

· 1 - Returns empty collection when empty IDList

parameter is given.
· 2 - Use IDList string as an SQL query to populate
this collection.
GetFieldFromFormat (string String Converts a field from your preferred format to Enterprise
Format, string Text) Architect's internal format. Returns the field in Enterprise
Architect's internal format.
Parameters:
· Format: String - The format to convert the field from.
Valid formats are:
· HTML - Full HTML
· RTF - Rich Text Format
· TXT - Plain text
· Text: String - The field to be converted.
GetFormatFromField (string String After accessing a field that contains formatting, use this
Format, string Text) method to convert it to your preferred format. Returns the
field in the format specified.
Parameters:
· Format: String - The format to convert the field to. Valid
formats are:
· HTML - Full HTML
· RTF - Rich Text Format
· TXT - Plain text
· Text: String - The field to be converted.
GetLastError () String Returns a string value describing the most recent error that
occurred in relation to this object.
This function is rarely used as an exception is thrown when
an error occurs.

GetMethodByGuid (string Method 1732 Returns a pointer to a method in the repository. This is
Guid) usually found using the MethodGUID property of a method.
Parameters:
· Guid: String - the GUID of the method to look for.
GetMethodById (string Id) Method 1732 Returns a pointer to a method in the repository. This is
usually found using the MethodID property of a method.
Parameters:
· Id: String - the ID of the method to look for.
GetPackageByGuid (string Package Returns a pointer to a package in the repository using the
Guid) 1698 package's GUID reference number (global ID). This is
usually found using the PackageGUID property of the
package.
Each package in the model also has an associated element
with the same GUID, so if you have an element with
Type="Package" then you can load the package by calling:
GetPackageByGuid(Element.ElementGUID).
Parameters:
· Guid: String - the GUID of the package to look for.
GetPackageByID (long Package Get a pointer to a package using an absolute reference
PackageID) 1698 number (local ID). This is usually found using the
PackageID property of an package, and stored for later use

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1689

Method Type Notes

to open a package without using the collection GetAt()

function.
Parameters:
· PackageID: Long - the ID of the package to locate.
GetProjectInterface () Project 1753 Return a pointer to the EA.Project interface 1753 (the XML-
based automation server for Enterprise Architect). Use this
interface to work with Enterprise Architect using XML, and
also to access utility functions for loading diagrams, running
reports and so on.

GetReferenceList (string Type) Reference Uses the list type to get a pointer to a Reference List object.
1705
Parameters:
· Type: String - specifies the list type to get; valid list
types are:

Diagram
Element
Constraint
Requirement
Connector
Status
Cardinality
Effort
Metric
Scenario
Status and
Test.
GetTechnologyVersion (string String Returns the version of a specified MDG Technology
ID) resource.
Parameters:
· ID: String - the specified technology ID.
GetTreeSelectedElements() Collection Returns the set of elements currently selected in the Project
1695 Browser as a collection.

GetTreeSelectedItem (object ObjectTyp Gets an object variable and type corresponding to the
SelectedItem) e 1677 currently selected item in the tree view.
To use this function, create a generic object variable and
pass this as the parameter. Depending on the return type,
cast it to a more specific type.
The object passed back through the parameter can be a
package, element, diagram, attribute or operation object.
Parameters:
· SelectedItem: Object - the object to get the variable
and type for.
GetTreeSelectedItemType () ObjectTyp Returns the type of the object currently selected in the tree.
e 1677 One of:
· otDiagram
· otElement
· otPackage
· otAttribute
· otMethod.
GetTreeSelectedObject () Object The related method GetTreeSelectedItem 1689 () has an
output parameter that is inaccessible by some scripting

© 1998-2010 Sparx Systems Pty Ltd

 1690 Automation and Scripts | Enterprise Architect Object Model

Method Type Notes

languages. As an alternative, this method provides the

selected item through the return value.

GetTreeSelectedPackage () Package Returns the package in which the currently selected tree
1698 view object is contained.

HasPerspective (string String Deprecated - no longer in use.

Perspective)

ImportPackageBuildScripts Imports build scripts into a package in Enterprise Architect.

(string PackageGuid, string
Parameters:
BuildScriptXML)
· PackageGuid: String - the GUID of the package into
which to import the build scripts.
· BuildScriptXML: String - the build script XML data,
which you can export from within Enterprise Architect.
ImportTechnology (string Boolean Installs a given MDG Technology resource into the
Technology) repository.
Returns True, if the technology is successfully loaded into
the model. Otherwise returns False.

Note:
This applies to technologies imported into pre-7.0 versions
of Enterprise Architect (imported technologies), not to
technologies referenced in version 7.0 and later
(referenced technologies). See Deploy an MDG
Technology 1147 (from Add-Ins).

Parameters:
· Technology: String - the contents of the technology
resource file.
IsTabOpen (string TabName) String Checks whether a named Enterprise Architect tabbed view
is open and active. This includes open diagram windows or
custom controls added using Repository.AddTab() 1683 .
Returns:
· 2 to indicate that a tab is open and active (top-most)
· 1 to indicate that it is open but not top-most, or
· 0 to indicate that it is not visible at all.

Note:
TabName is case-sensitive.

Parameters:
· TabName: String - the name of the tab to check for.
IsTechnologyEnabled (string Boolean Checks whether a specified technology is enabled in
ID) Enterprise Architect.
Returns True if the MDG Technology resource is enabled.
Otherwise returns False.
Parameters:
· ID: String - the technology ID to check for.
IsTechnologyLoaded (string Boolean Checks whether a specified technology is loaded into the
ID) repository.
Returns True if the MDG Technology resource is loaded into
the repository. Otherwise returns False.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1691

Method Type Notes

Parameters:
· ID: String - the technology ID to check for.
OpenDiagram (long Provides a method for an automation client or Add-In to
DiagramID) open a diagram. The diagram is added to the tabbed list of
open diagrams in the main Enterprise Architect view.
Parameters:
· DiagramID: Long - the ID of the diagram to open.
OpenFile (string Filename) Boolean This is the main point for opening an Enterprise Architect
project file from an automation client, and working with the
contained objects.
If the required project is a DBMS repository, and you have
created a shortcut .EAP file containing the database
connection string, you can call this shortcut file to access
the DBMS repository.
You can also connect to a SQL database by passing in the
connection string itself instead of a filename. A valid
connection string can be obtained from the Open Project 114
dialog by selecting a recently opened SQL repository.
Parameters:
· Filename: String - the filename of the Enterprise
Architect project to open.
OpenFile2 (string FilePath, Boolean As for OpenFile() except this enables the specification of a
string Username, string password.
Password)
Parameters:
· Filepath: String - the file path of the Enterprise Architect
project to open.
· Username: String - the user login ID
· Password: String - the user password.
RefreshModelView (long Reloads a package or the entire model, updating the user
PackageID) interface.
Parameters:
· PackageID: Long - the ID of the package to reload: if 0,
the entire model is reloaded; if a valid package ID, only
that package is reloaded.
RefreshOpenDiagrams Refreshes the diagram contents for all diagrams open in
(boolean FullReload) Enterprise Architect.
Parameters:
· FullReload: Boolean - if false the displayed contents of
elements and connectors are refreshed in each
diagram; if true each of the diagrams is completely
reloaded from the repository.
ReloadDiagram (long Reloads a specified diagram. This would commonly be used
DiagramID) to refresh a visible diagram after code import/export or other
batch process where the diagram requires complete
refreshing.
Parameters:
· DiagramID: Long - the ID of the diagram to be
reloaded.
RemoveOutputTab (string Removes a specified tab from the Output window.
Name)
Parameters:

© 1998-2010 Sparx Systems Pty Ltd

 1692 Automation and Scripts | Enterprise Architect Object Model

Method Type Notes

· Name: String - the name of the tab to be removed.

RunModelSearch (string Runs a search, displaying the results in Enterprise
sQueryName, string Architect's Model Search window.
sSearchTerm, string Parameters:
sSearchOptions, string
sSearchData) · sQueryName: String - the name of the search to run,
for example Simple.
· sSearchTerm: String - the term to search for.
· sSearchOptions: String - currently not being used.
· sSearchData: String - enables you to supply a list of
results in the form of XML, which is appended onto the
result list in Enterprise Architect. See XML Format 1782 ;
this parameter is not mandatory so pass in an empty
string to run the search as per normal.
SaveAllDiagrams () Saves all open diagrams.

SaveAuditLogs (string Boolean Saves the Audit Logs contained within a model to a
FilePath, object specified file.
StartDateTime, object If StartDateTime and EndDateTime are not null then only log
EndDateTime) items that fall into this period are saved.
Returns true for success, false for failure.

Note:
This might fail if the user logged into the model does not
have the correct access permission.

Parameters:
· FilePath: String - the file to save the Audit Logs to.
· StartDateTime: Variant [DateTime] - the earliest date
and time of log entries to save.
· EndDateTime; Variant [DateTime] - the latest date and
time of log entries to save.
SaveDiagram (long DiagramID) Saves an open diagram. Assumes the diagram is open in
the main user interface Tab list.
Parameters:
· DiagramID: Long - the ID of the diagram to save.
ShowDynamicHelp (string Shows a help topic as a view.
Topic)
Parameters:
· Topic: String - specifies the help topic.
ShowInProjectView (object Selects a specified object in the Project Browser.
Item)
Accepted object types are Package, Element, Diagram,
Attribute, and Method. An exception is thrown if the object is
of an invalid type.
Parameters:
· Item: Object - the object to highlight.
ShowProfileToolbox (string Shows/hides the contents of a specified technology or
Technology, string Profile, profile in the Toolbox.
boolean Show) To show/hide a profile in the Toolbox, specify the profile's ID
value in the Profile parameter and set the Technology
parameter to a null string.
To show/hide a technology in the Toolbox, specify the

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1693

Method Type Notes

technology's ID in the Technology parameter and set the

Profile parameter to a null string.
Parameters:
· Technology: String - the ID of the technology.
· Profile: String - the ID of the profile.
· Show: Boolean - if true, show the technology or profile;
if false, hide the technology or profile.
ShowWindow (long Show) Shows or hides Enterprise Architect.
Parameters:
· Show: Long.
SQLQuery (string SQL) String Enables execution of a SQL select statement against the
current repository. Returns an XML formatted string value of
the resulting recordset.
Parameters:
· SQL: String - contains the SQL Select statement.
VersionControlResynchPkgSt Synchronizes the version control status 267 of each version
atuses (boolean ClearSettings) controlled package within the current model with the status
reported by your version control provider.
Parameters:
· ClearSettings: Boolean - if true, clear the version
control settings from packages that are reported by the
version control provider as uncontrolled; if false, leave
the version control settings unchanged for packages
reported as uncontrolled.
WriteOutput (string Name, Writes text to a specified tab in the Output window, and
string String, long ID) associates the text with an ID. See also ClearOutput 1684 ,
CreateOutputTab 1685 , EnsureOutput Visible 1685 .
Parameters:
· Name: String - specifies the tab on which to display the
text.
· String: String - specifies the text to display.
· ID: Long - specifies the ID the text is associated with.

11.2.2.4.2 Author

public Class
An Author object represents a named model author. Accessed using the Repository Authors collection.
Associated table in .EAP file: t_authors

Author Attributes
Attribute Type Notes

Name String Read/Write. Author name.

Notes String Read/Write. Notes about the author.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

Roles String Read/Write. Roles the author might play in this project.

© 1998-2010 Sparx Systems Pty Ltd

 1694 Automation and Scripts | Enterprise Architect Object Model

Author Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Updates the current Author object after modification or appending a new
item. If false is returned, check the GetLastError function for more
information.

11.2.2.4.3 Client

public Class
A Client represents one or more people or organizations related to the project. Accessed using the Repository
Clients collection.
Associated table in .EAP file: t_clients

Client Attributes
Attribute Type Notes

EMail String Read/Write. EMail address.

Fax String Read/Write. Fax number.

Mobile String Read/Write. Mobile phone if available.

Name String Read/Write. Client name.

Notes String Read/Write. Notes about client.

ObjectType ObjectType Read only. Distinguishes objects referenced through the Dispatch
1677 interface.

Organization String Read/Write. Associated organization.

Phone1 String Read/Write. Main phone number.

Phone2 String Read/Write. Second phone number.

Roles String Read/Write. Roles this client might play in the project.

Client Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error occurs.

Update () Boolean Updates the current Client object after modification or appending a new
item. If false is returned, check the GetLastError function for more
information.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1695

11.2.2.4.4 Collection

public Class
This is the main collection Class used by all elements within the Automation Interface. It contains methods to
iterate through the collection, refresh the collection and delete an item from the collection. It is important to
realize that when AddNew is called, the item is not automatically added to the current collection. The typical
steps are:
1. Call AddNew to add a new item.
2. Modify the item as required.
3. Call Update on the item to save it to the database.
4. Call Refresh on the collection to include it in the current set.
Delete is much the same; until Refresh is called, the collection still contains a reference to the deleted item,
which should not be called.
Each can be used to iterate through the collection for languages that support this type of construct.

Collection Attributes
Attribute Type Notes

Count Short Read only. The number of objects referenced by this list.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch

1677 interface.

Collection Methods
Method Type Notes

AddNew (string Object Adds a new item to the current collection.

Name, string Type)
Note that the interface is the same for all collections; you must
provide a Name and Type argument. What these are used for
depends on the actual collection member. Also note that you must
call Update() on the returned object to complete the AddNew. If
Update() is not called the object is left in an indeterminate state.
Parameters:
· Name: String
· Type: String (up to 30 characters long)
Delete (short index) Void Deletes the item at the selected reference.
Parameters:
· index: Short
DeleteAt (short index, Void Deletes the item at the selected index. The second parameter is
boolean Refresh) currently unused.
Parameters:
· index: Short
· Refresh: Boolean
GetAt (short index) Object Retrieves the array object using a numerical index. If the index is
out of bounds, an error occurs.
Parameters:
· index: Short
GetByName (string Object Gets an item in the current collection by Name.
Name)
If the collection does not contain any items, the method returns a
null value. If the collection contains items, but it was unable to find

© 1998-2010 Sparx Systems Pty Ltd

 1696 Automation and Scripts | Enterprise Architect Object Model

Method Type Notes

an object with the specified name, the method raises an exception.

Only supported for the following collections: Model 1698 , Package 1698

, Element 1711 , Diagram 1746 , and element TaggedValue 1724 .

Parameters:
· Name: String
GetLastError () String Returns a string value describing the most recent error that
occurred in relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Refresh () Void Refreshes the collection by re-querying the model and reloading the
collection. Should be called after adding a new item or after deleting
an item.

11.2.2.4.5 Datatype

public Class
A Datatype is a named type that can be associated with attribute or method types. It typically is related to
either code engineering or database modeling. Datatypes also indicate which language or database system
they relate to. Accessed using the Repository Datatypes collection.
Associated table in .EAP file: t_datatypes

Datatype Attributes
Attribute Type Notes

DatatypeID Long Read/Write. Instance ID for this datatype within the current model.
System maintained.

DefaultLen Long Read/Write. Default length (DDL only).

DefaultPrec Long Read/Write. Default precision (DDL only).

DefaultScale Long Read/Write. Default scale (DDL only).

GenericType String Read/Write. The associated generic type for this data type.

HasLength String Read/Write. Indicates datatype has a length component.

MaxLen Long Read/Write. Maximum length (DDL only).

MaxPrec Long Read/Write. Maximum precision (DDL only).

MaxScale Long Read/Write. Maximum scale (DDL only).

Name String Read/Write. The datatype name (such as integer). This appears in the
related drop-down datatype lists where appropriate.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch

1677 interface.

Product String Read/Write. The datatype product, such as Java, C++, Oracle.

Size Long Read/Write. The datatype size.

Type String Read/Write. The type can be DDL for database datatype or Code for
language datatypes.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1697

Attribute Type Notes

UserDefined Long Read/Write. Indicates if datatype is a user defined type or system

generated.
Datatypes distributed with Enterprise Architect are all system generated.
Datatypes created in the Datatype dialog are marked 1 (true).

Datatype Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Updates the current Datatype object after modification or appending a
new item.
If false is returned, check the GetLastError function for more information.

11.2.2.4.6 EventProperties
An EventProperties object is passed to BroadcastFunctions to facilitate parameter passing.

EventProperties Attributes
Attribute Type Notes

Count Long Read only. Number of parameters being passed to this broadcast event.

ObjectType ObjectType 1677 Read only. Distinguishes objects referenced through a Dispatch
interface.

EventProperties Methods
Method Type Notes

Get (object EventProperty Read only. Returns an EventProperty in the list, raising an error if Index
Index) 1697 is out of range.
Parameters:
· Index: Variant - can either be a number representing a zero-based
index into the array, or a string representing the name of the
EventProperty. For example, Props.Get(3) or Props.Get("ObjectID").

11.2.2.4.7 EventProperty
EventProperty objects are always part of an EventProperties 1697 collection, and are passed to Add-In methods
responding to broadcast events 1787 .

EventProperty Attributes
Attribute Type Notes

Description String Explanation of what this property represents.

Name String A string distinguishing this property from others in the list.

ObjectType ObjectType Distinguishes objects referenced through a Dispatch interface.

© 1998-2010 Sparx Systems Pty Ltd

 1698 Automation and Scripts | Enterprise Architect Object Model

Attribute Type Notes

1677

Value Variant A string, number or object reference representing the property value.

11.2.2.4.8 ModelWatcher

public Class
The ModelWatcher object enables an automation client to track changes in a particular model.

Note:
After your model has been loaded, you only create the ModelWatcher once. If you reload 267 the model, or
load another model, the created ModelWatcher is still valid.

ModelWatcher Attributes
Attribute Type Notes

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch

1677 interface.

ModelWatcher Methods
Methods Type Notes

GetReloadItem ReloadType The object that must be reloaded in order to see all changes is returned
(object Item) 1678 through the Item parameter. If there are no changes or the entire model
must be reloaded, this value is returned as null (C#) or Nothing (VB).
Calling this method clears the records so that the next time it is called the
return values refer only to new changes.Returns a value from the
ReloadType enumeration that specifies which type of change, if any, has
occurred.
Parameters:
· Item: Object
PeekReloadItem ReloadType This method behaves identically to GetReloadItem() but does not clear
1678 the change record.

11.2.2.4.9 Package

public Class
A Package object corresponds to a Package element in the Enterprise Architect Project Browser. It is
accessed either through the Repository Models 1682 collection (a Model is a special form of Package) or
through the Package Packages 1700 collection. Note that a Package has an Element object as an attribute; this
corresponds to an Enterprise Architect Package element in the t_object table and is used to associate
additional information (such as scenarios and constraints) with the logical package. To set additional
information for a package, reference the Element object directly. Also note that if you add a Package to a
diagram, you should add an instance of the element (not the Package itself) to the DiagramObjects collection
for a diagram.
Associated table in .EAP file: t_package

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1699

Package Attributes
Attribute Type Notes

Alias String Read only. Alias.

BatchLoad Long Read/Write. Flag to indicate that the package is batch loaded
during batch import from controlled packages. Not currently
used.

BatchSave Long Read/Write. Boolean value to indicate whether the package is

included in the batch XMI export list or not.

CodePath String Read/Write. The path to where associated source code is

found. Not currently used.

Connectors Collection Read only. Collection of connectors.

1695

Created Date Read/Write. Date the package was created.

Diagrams Collection Read only. A collection of diagrams contained in this package.

1695

Element Element 1711 Read only. The associated element object. Use to get/set
common information such as Stereotype, Complexity, Alias,
Author, Constraints, Tagged Values and Scenarios.

Elements Collection Read only. A collection of elements that belong to this

1695 package.

Flags String Read/Write. Extended information about the package.

IsControlled Boolean Read/Write. Indicates if the package has been marked as

Controlled.

IsModel Boolean Read only. Indicates if the package is a model or a package.

IsNamespace Boolean Read/Write. True is 'package is a Namespace root'. Use 0 and

1 to set False and True.

IsProtected Boolean Read/Write. Indicates if the package has been marked as

Protected.

IsVersionControlled Boolean Read. Indicates whether or not this package is under version
control.

LastLoadDate Date Read/Write. The date XML was last loaded for the package.

LastSaveDate Date Read/Write. The date XML was last saved from the package.

LogXML Boolean Read/Write. Indicates if XMI export information is to be logged.

Modified Date Read/Write. Date the package was last modified.

Name String Read/Write. The name of the package.

Notes String Read/Write. Notes about this package.

ObjectType ObjectType Read only. Distinguishes objects referenced through a

1677 Dispatch interface.

Owner String Read/Write. The package owner when using controlled

packages.

PackageGUID Variant Read only. The global Package ID. Valid across models.

© 1998-2010 Sparx Systems Pty Ltd

 1700 Automation and Scripts | Enterprise Architect Object Model

Attribute Type Notes

PackageID Long Read only. The local Package ID number. Valid only in this
model file.

Packages Collection Read only. A collection of contained packages that can be

1695 walked through.

ParentID Long Read/Write. The ID of the package that is the parent of this
one. 0 indicates this package is a model (that is, it has no
parent).

TreePos Long Read/Write. The relative position in the tree compared to other
packages (use to sort packages).

UMLVersion String Read/Write. The UML version for XMI export purposes.

UseDTD Boolean Read/Write. Indicates if a DTD is to be used when exporting

XMI.

Version String Read/Write. The version of the package.

XMLPath String Read/Write. The path to where the XML is saved when using
controlled packages.

Package Methods
Method Type Notes

ApplyGroupLock (string Boolean Applies a group lock to the package object, for the specified
aGroupName) group, on behalf of the current user.
Throws an exception if the operation fails. Use GetLastError()
to retrieve error information.
Parameter:
· aGroupName: String - The name of the security group for
which to apply the lock.
ApplyUserLock () Boolean Applies a user lock to the package object for the current user.
Throws an exception if the operation fails. Use GetLastError()
to retrieve error information.

Clone LDISPATCH Inserts a copy of the package into the same parent as the
original package.
Returns the newly-created package.

Returns a package, element, attribute or operation matching

the parameter DottedID. If the DottedID is not found, an error
is returned: Can't find matching object.
FindObject (string LPDISPATC Parameter:
DottedID) H
· DottedID: String - Is in the form object.object.object where
object is replaced by the name of a package, element
attribute or operation. Examples include MyNamespace.
Class1, CStudent.m_Name, MathClass.DoubleIt(int).
GetLastError () String Returns a string value describing the most recent error that
occurred in relation to this object.
This function is rarely used as an exception is thrown when an
error occurs.

ReleaseUserLock () Boolean Removes an existing User or Group lock from the package
object.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1701

Method Type Notes

Throws an exception if the operation fails. Use GetLastError( )

to retrieve error information.

Update () Boolean Update the current package object after modification or

appending a new item.
If false is returned, check the GetLastError function for more
information.
Note that a package object also has an element component
that must be taken into account. The package object contains
information about the package attributes such as hierarchy or
contents. The element attribute contains information about, for
example, Stereotype, Constraints or Files - all the attributes of
a typical element.

VersionControlAdd (string Void Places the package under version control, using the specified
ConfigGuid, string Version Control Configuration and the specified XMI filename.
XMLFile, string Comment, Throws an exception if the operation fails. Use GetLastError( )
boolean to retrieve error information.
KeepCheckedOut)
It is recommended that the package be saved using Update()
before calling VersionControlAdd(), so that any outstanding
changes are not lost.
Parameters:
· ConfigGuid: String - Name corresponding to the Unique
ID of the version control configuration to use.
· XMLFile: String - Name of the XML file to use for this
package. This filename is relative to the Working Copy
folder specified for the Config.
· Comment: String - Log message that is added to the
version controlled file's history (where applicable).
· KeepCheckedOut: Boolean - Specify True to add to
version control and keep package checked-out.
VersionControlCheckin Void Perform checkin of the version controlled package.
(string Comment)
Throws an exception if the operation fails. Use GetLastError( )
to retrieve error information.
Parameters:
· Comment: String - Log message that is added to the
version controlled file's history (where applicable).
VersionControlCheckout Void Perform checkout of the version controlled package.
(string Comment)
Throws an exception if the operation fails. Use GetLastError( )
to retrieve error information.
Parameters:
· Comment: String - Log message that is added to the
version controlled file's history (where applicable).
VersionControlGetLatest Updates the local working copy of the package file associated
(boolean ForceImport) with the object package, before re-importing the package data
from the package file.
Parameters:
· ForceImport: Boolean - Used if the package data in the
model is found to be up-to-date with respect to the version
controlled package file. If:
· False, the package data that exists in the model is
accepted as being up-to-date and no attempt is made to
re-import data from the package file

© 1998-2010 Sparx Systems Pty Ltd

 1702 Automation and Scripts | Enterprise Architect Object Model

Method Type Notes

· True, Enterprise Architect re-imports the package from

the package file regardless.
See also the version control menu option Get Latest 258 .

VersionControlGetStatus Long Returns the version control status of the package. Throws an
() exception if the operation fails. Use GetLastError( ) to retrieve
error information.
Return value maps to the following enumerated type:
enum EnumCheckOutStatus
{
csUncontrolled = 0,
csCheckedIn,
csCheckedOutToThisUser,
csReadOnlyVersion,
csCheckedOutToAnotherUser,
csOfflineCheckedIn,
csCheckedOutOfflineByUser,
csCheckedOutOfflineByOther,
csDeleted,
};
csUncontrolled - Either unable to communicate with the
version control provider associated with the package or the
package file is unknown to the provider.
csReadOnlyVersion - Package is marked as read-only. An
earlier revision of the package has been retrieved from version
control.
csOfflineCheckedOutToThisUser - Indicates that the package
was 'checked out' by this user whilst disconnected from version
control.
csOfflineNotCheckedOutToThisUser - Indicates that Enterprise
Architect can not currently connect to the version control config
and the package was not previously checked out to this user.
csDeleted - The package file has been deleted from version
control.

VersionControlPutLatest Void Perform a checkin of the version controlled package, whilst

(string CheckInComment) keeping the package checked-out.
Throws an exception if the operation fails. Use GetLastError( )
to retrieve error information.
When a package that was previously marked as Checked Out
Offline, is successfully 'Put' (checkedin) to version control, that
package's flags are updated to clear the Checked Out Offline
indicator.
Parameters:
· Comment: String - Log message added to the version
controlled file's history (where applicable).

VersionControlRemove () Void Removes version control from the package.

Throws an exception if the operation fails. Use GetLastError( )
to retrieve error information.

VersionControlResynchPk Synchronizes 267 the version control status of the single object
gStatus (boolean package recorded in your current model with the package
ClearSettings) status reported by your version control provider.
Parameters:
· ClearSettings: Boolean - used if the package file associated

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1703

Method Type Notes

with the specified package is reported by the version control

provider as uncontrolled. If ClearSettings is:
· True, the version control settings are cleared from the
package
· False, the version control settings remain unchanged.

11.2.2.4.10 ProjectIssues

public Class
A system-level Issue. Indicates a problem or risk associated with the system as a whole. Accessed using the
Repository Issues collection.
Associated table in .EAP file: t_issues

ProjectIssues Attributes
Attribute Type Notes

Category String Read/Write. The category this issue belongs to.

Date Date Read/Write. Date created.

DateResolved Date Read/Write. Date issue resolved.

Name String Read/Write. Issue name (that is, the issue itself).

IssueID Long Read only. The ID of this issue.

Notes String Read/Write. Associated description of issue.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

Owner String Read/Write. Owner of issue.

Priority String Read/Write. Issue priority. Generally should use Low, Medium or High.

Resolution String Read/Write. Description of resolution.

Resolver String Read/Write. Person resolving issue.

Severity String Read/Write. Issue severity. Should be marked as Low, Medium or High.

Status String Read/Write. Current issue status.

ProjectIssues Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current Issue object after modification or appending a new
item. If false is returned, check the GetLastError function for more
information.

© 1998-2010 Sparx Systems Pty Ltd

 1704 Automation and Scripts | Enterprise Architect Object Model

11.2.2.4.11 ProjectResource

public Class
A Project Resource is a named person who is available to work on the current project in any capacity.
Accessed using the Repository Resources collection.
Associated table in .EAP file: t_resources

ProjectResource Attributes
Attribute Type Notes

Email String Email address.

Fax String Fax number.

Mobile Variant Mobile number if available.

Name String Name of resource.

Notes String A description if appropriate.

ObjectType ObjectType 1677 Read only. Distinguishes objects referenced through a Dispatch
interface.

Organization Package 1698 : Organization resource associated with.

String

Phone1 Variant Main phone.

Phone2 Variant Alternative phone.

Roles String The roles this resource can play in the current project.

ProjectResource Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current Resource object after modification or appending a
new item. If false is returned, check the GetLastError function for more
information.

11.2.2.4.12 PropertyType

public Class
A PropertyType object represents a defined property that can be applied to UML elements as a Tagged Value.
Accessed using the Repository PropertyTypes collection. Each PropertyType corresponds to one of the
predefined Tagged Values for the model.
Associated table in .EAP file: t_propertytypes

Author Attributes
Attribute Type Notes

Description String Read/Write. Short description for the property.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1705

Attribute Type Notes

Detail String Read/Write. Configuration information for the property.

ObjectType ObjectType 1677 Read only. Distinguishes objects referenced through a Dispatch
interface.

Tag String Read/Write. Name of the property (Tag Name).

Author Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current PropertyType object after modification or appending
a new item. If false is returned, check the GetLastError function for
more information.

11.2.2.4.13 Reference

public Class
This Interface provides access to the various lookup tables within Enterprise Architect. Use the Repository
GetReferenceList() method to get a handle to a list. Valid lists are:
· Diagram
· Element
· Constraint
· Requirement
· Connector
· Status
· Cardinality
· Effort
· Metric
· Scenario
· Status
· Test

Reference Attributes
Attribute Type Notes

Count Short Count of items in the list.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch

1677 interface.

Type String The list type (for example, Diagram Types).

Reference Methods
Method Type Notes

GetAt (short String Get the item at the specified index.

Index)

© 1998-2010 Sparx Systems Pty Ltd

 1706 Automation and Scripts | Enterprise Architect Object Model

Method Type Notes

Parameters:
· Index: Short - The index of the item to retrieve from the list.
GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Refresh () Short Refresh the current list and return the count of items.

11.2.2.4.14 Stereotype

public Class
The Stereotype element corresponds to a UML stereotype, which is an extension mechanism for varying the
behavior and type of a model element. Use the Repository Stereotypes collection to add new elements and
delete existing ones.
Associated table in .EAP file: t_stereotypes

Stereotype Attributes
Attribute Type Notes

AppliesTo String Read/Write. A reference to the stereotype Base Class, that is, which
element it applies to.

MetafileLoadPat String Read/Write. Path to an associated metafile. The automation interface

h does not yet support loading metafiles. To do this you must use the
Stereotype tab of the UML Types dialog in Enterprise Architect.

Notes String Read/Write. Notes about the stereotype.

Name String Read/Write. The stereotype name. Appears in the Stereotype drop list
for elements that match the AppliesTo attribute.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch

1677 interface.

StereotypeGUID String Read/Write. Unique identifier for stereotype, generally set and
maintained by Enterprise Architect.

Style String Read/Write. Additional style specifier for stereotype.

VisualType String Read/Write. Indicates an inbuilt visual style associated with a

stereotype. Not currently implemented.

Stereotype Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current stereotype object after modification or appending a
new item. If false is returned, check the GetLastError function for more
information.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1707

11.2.2.4.15 Task

public Class
A Task is an entry in the System ToDo list. Accessed using the Repository Tasks collection.
Associated table in .EAP file: t_tasks

Task Attributes
Attribute Type Notes

ActualTime Long Read/Write. Time already expended on task, in hours, days or other units.

AssignedTo String Read/Write. Person this task is assigned to; that is, the responsible
resource.

EndDate Date Read/Write. Date task scheduled to finish.

History String Read/Write. Memo field to hold, for example, task history or notes.

Name Variant Read/Write. Task name.

Notes Variant Read/Write. Description of the task.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

Owner String Read/Write. The task owner.

Percent Long Read/Write. Percent the task is complete.

Phase String Read/Write. The phase of the project the task relates to.

Priority String Read/Write. Priority associated with this task.

StartDate Date Read/Write. Date task is to start.

Status Variant Read/Write. Current task status.

TaskID Long Read only. Local ID of task.

TotalTime Long Read/Write. The total expected time the task might run - in hours, days or
some other unit.

Type String Read/Write. Sets or returns string representing the type.

Task Methods
Method Type Notes

GetLastError String Returns a string value describing the most recent error that occurred in
() relation to this object.
This function is rarely used as an exception is thrown when an error occurs.

Update () Boolean Update the current Task object after modification or appending a new item.
If false is returned, check the GetLastError function for more information.

© 1998-2010 Sparx Systems Pty Ltd

 1708 Automation and Scripts | Enterprise Architect Object Model

11.2.2.4.16 Term

public Class
A Term object represents one entry in the system glossary. Accessed using the Repository Terms collection.
Associated table in .EAP file: t_glossary

Term Attributes
Attribute Type Notes

Meaning String Read/Write. The description of the term; its meaning.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

Term String Read/Write. The glossary item name.

TermID Long Read only. A local ID number to identify the term in the model.

Type String Read/Write. The type this term applies to (for example, business or
technical).

Term Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current Term object after modification or appending a new
item. If false is returned, check the GetLastError function for more
information.

11.2.2.5 Element

public Package
The Element package contains information about an element and its associated extended properties such as
testing and project management information. An element is the basic item in an Enterprise Architect model.
Classes, Use Cases and Components are all different types of UML element.
The diagram below illustrates the relationships between an element and its associated extended information.
The related information is accessed through the collections owned by the element (for example, Scenarios
and Tests). It also includes a full description of the element object (the basic model structural unit).

Enterprise Architect User Guide

Automation and Scripts | Enterprise Architect Object Model 1709

© 1998-2010 Sparx Systems Pty Ltd

 1710 Automation and Scripts | Enterprise Architect Object Model

11.2.2.5.1 Constraint

public Class
A Constraint is a condition imposed on an element. Constraints are accessed through the Element Constraints
collection.
Associated table in .EAP file: t_objectconstraints

Constraint Attributes
Attribute Type Notes

Name String Read/Write. The name of the constraint (that is, the constraint).

Notes String Read/Write. Notes about the constraint.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

ParentID Long Read only. The ElementID of the element to which this constraint applies.

Status String Read/Write. Current status.

Type String Read/Write. Constraint type.

Weight Long Read/Write. A weighting factor.

Constraint Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current Constraint object after modification or appending a
new item. If false is returned, check the GetLastError function for more
information.

11.2.2.5.2 Effort

public Class
An Effort is a named item with a weighting that can be associated with an element for purposes of building
metrics about the model. Accessed through the Element Efforts collection.
Associated table in .EAP file: t_objecteffort

Effort Attributes
Attribute Type Notes

Name String Read/Write. The name of the effort.

Notes String Read/Write. Notes about the effort.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

Type String Read/Write. The effort type.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1711

Attribute Type Notes

Weight Long Read/Write. A weighting factor.

Weight2 Float Read/Write. A weighting factor.

Effort Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Saves the effort to the model.

11.2.2.5.3 Element

public Class
An Element is the main modeling unit. It corresponds to (for example) Class, Use Case, Node or Component.
You create new elements by adding to the Package Elements collection. Once you have created an element,
you can add it to the DiagramObjects collection of a diagram to include it in the diagram.
Elements also have a collection of connectors. Each entry in this collection indicates a relationship to another
element.
There are also some extended collections for managing addition information about the element, including
things such as Tagged Values, Issues, Constraints and Requirements.
Associated table in .EAP file: t_object

Element Attributes
Attribute Type Notes

Abstract String Read/Write. Indicates if the element is Abstract (1) or Concrete

(0).

ActionFlags String Read/Write. A structure to hold flags concerned with Action

semantics.

Alias String Read/Write. An optional alias for this element.

Attributes Collection 1695 Read only. Collection of Attribute objects for current element.
Use the AddNew and Delete functions to manage attributes.

AttributesEx Collection 1695 Read only. Collection of Attribute objects belonging to the
current element and its parent elements.

Author String Read/Write. The element author (see the Repository: Authors
1680 list for more details).

BaseClasses Collection 1695 Read only. List of Base Classes for this element presented as a
collection for convenience.

ClassfierID Long Deprecated. See ClassifierID.

ClassifierID Long Read/Write. ElementID of a Classifier associated with this

element; that is, the base type. Only valid for instance type
elements (such as Object, Sequence).

ClassifierName String Read/Write. Name of associated Classifier (if any).

© 1998-2010 Sparx Systems Pty Ltd

 1712 Automation and Scripts | Enterprise Architect Object Model

Attribute Type Notes

ClassifierType String Read only. Type of associated classifier.

Complexity String Read/Write. A complexity value indicating how difficult the

element is. Can be used for metric reporting and estimation.
Valid values are: 1 for Easy, 2 for Medium, 3 for Difficult.

CompositeDiagram Diagram 1746 Read only. If the element is Composite, returns its associated
diagram; otherwise returns null.

Connectors Collection 1695 Read only. Returns a collection containing the connectors to
other elements.

Constraints Collection 1695 Read only. Collection of Constraint 1710 objects.

ConstraintsEx Collection 1695 Read only. Collection of Constraint objects belonging to the
current element and its parent elements.

Created Date Read/Write. The date the element was created.

CustomProperties Collection 1695 Read only. List of advanced properties for an element. The
collection of advanced properties differs depending on element
type; for example, an Action and an Activity have different
advanced properties. Currently only editable from the user
interface.

Diagrams Collection 1695 Read only. Returns a collection of sub-diagrams (child

diagrams) attached to this element as seen in the tree view.

Difficulty String Read/Write. A difficulty level associated with this element for
estimation/metrics; only useable for Requirement, Change and
Issue element types, otherwise ignored.
Valid values are: Low, Medium, High.

Efforts Collection 1695 Read only. Collection of Effort 1710 objects.

ElementGUID String Read only. A globally unique ID for this element; that is, unique
across all model files. If you have to set this value manually,
you should only do so when the element is first created, and
make sure you format the GUID exactly as Enterprise Architect
expects.

ElementID Long Read only. The local ID of the Element. Valid for this file only.

Elements Collection 1695 Read only. Returns a collection of child elements (sub-
elements) attached to this element as seen in the tree view.

EmbeddedElements Collection 1695 Read only. List of elements that are embedded into this
element, such as Ports, Parts, Pins and Parameter Sets.

EventFlags String Read/Write. A structure to hold a variety of flags to do with

signals or events.

ExtensionPoints String Read/Write. Optional extension points for a Use Case as a

comma-separated list.

Files Collection 1695 Read only. Collection of File 1717 objects.

GenFile String Read/Write. The file associated with this element for code
generation and synchronization purposes. Can include macro
expansion tags for local conversion to full path.

Genlinks String Read/Write. Links to other Classes discovered at code

reversing time; Parents and Implements connectors only.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1713

Attribute Type Notes

GenType String Read/Write. The code generation type; for example, Java, C++,
C#, VBNet, Visual Basic, Delphi.

Header1 Variant Read/Write. A user defined string for inclusion as header in the
source files generated.

Header2 Variant Read/Write. Same as for Header1, but used in the CPP source
file.

IsActive Boolean Read/Write. Boolean value indicating whether the element is

active or not.
1 = True, 0 = False.

IsLeaf Boolean Read/Write. Boolean value indicating whether the element is in

leaf node or not.
1 = True, 0 = False.

IsNew Boolean Read/Write. Boolean value indicating whether the element is

new or not.
1 = True, 0 = False.

IsSpec Boolean Read/Write. Boolean value indicating whether the element is a

specification or not.
1 = True, 0 = False.

Issues Collection 1695 Read only. Collection of Issue objects.

Locked Boolean Read/Write. Indicates if the element has been locked against
further change.

MetaType String Read only. The element's domain-specific meta type, as

defined by an applied stereotype from an MDG Technology.

Methods Collection 1695 Read only. Collection of Method objects for current element.

MethodsEx Collection 1695 Read only. Collection of Method objects belonging to the
current element and its parent elements.

Metrics Collection 1695 Read only. Collection of Metric elements for current element.

MiscData String Read only. This low-level property provides information about
the contents of the PDatax fields. These database fields are not
documented and developers must gain understanding of these
fields through their own endeavors to use this property.
MiscData is zero based, therefore:
· MiscData(0) corresponds to PData1
· MiscData(1) to PData2
and so on.

Modified Date Read/Write. The date the element was last modified.

Multiplicity String Read/Write. Multiplicity value for this element.

Name String Read/Write. The element name; should be unique within the
current package.

Notes String Read/Write. Further descriptive text about the element.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch

1677 interface.

© 1998-2010 Sparx Systems Pty Ltd

 1714 Automation and Scripts | Enterprise Architect Object Model

Attribute Type Notes

PackageID Long Read/Write. A local ID for the package containing this element.

ParentID Long Read/Write. If this element is a child of another, used to set or

retrieve the ElementID of the other element. If not, returns 0.

Partitions Collection 1695 Read only. List of logical partitions into which an element can
be divided. Only valid for elements that support partitions, such
as Activities and States.

Persistence String Read/Write. The persistence associated with this element. Can
be Persistent or Transient.

Phase String Read/Write. Phase this element scheduled to be constructed in.

Any string value.

Priority String Read/Write. The priority of this element as compared to other

project elements. Only applies to Requirement, Change and
Issue types, otherwise ignored.
Valid values are: Low, Medium and High.

Properties Properties 1736 Returns a list of specialized properties that apply to the element
that might not be available using the automation model. The
properties are purposely undocumented because of their
obscure nature and because they are subject to change as
progressive enhancements are made to them.

PropertyType Long Read/Write. The ElementID of a Type associated with this

element. Only valid for Port and Part elements.

Realizes Collection 1695 Read only. List of Interfaces realized by this element for
convenience.

Requirements Collection 1695 Read only. Collection of Requirement 1719 objects.

RequirementsEx Collection 1695 Read only. Collection of Requirement 1719 objects belonging to
the current element and its parent elements.

Resources Collection 1695 Read only. Collection of Resource 1720 objects for current
element.

Risks Collection 1695 Read only. Collection of Risk 1721 objects.

RunState String Read/Write. The object's runstate list as a string.

Scenarios Collection 1695 Read only. Collection of Scenario 1722 objects for current
element.

StateTransitions Collection 1695 Read only. List of State Transitions that an element can
support. Applies in particular to Timing elements.

Status String Read/Write. Sets or gets the status, such as Proposed or

Approved.

Stereotype String Read/Write. The primary element stereotype. This is the first of
the list of stereotypes you can access using the StereotypeEx
attribute.

StereotypeEx String Read/Write. All the applied stereotypes of the element in a

comma-separated list.

StyleEx String Read/Write. Advanced style settings. Reserved for the use of
Sparx Systems.

Subtype Long Read/Write. A numeric subtype that qualifies the Type 1715 of

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1715

Attribute Type Notes

the main element. For example:

· For Event: 0 = Receiver, 1 = Sender
· For Class: 1 = Parameterised, 2 = Instantiated, 3 = Both, 0
= Neither,
17 = Association Class

Note:
If 17, because an Association Class has been created through
the user interface, MiscData(3) will contain the ID of the
related Association. As MiscData is read-only, you cannot
create an Association Class through the Automation Interface.

· For Note: 1 = Note linked to connector, 2 = Constraint

linked to connector
· For StateNode: 100 = ActivityIntitial, 101 = ActivityFinal
· For Activity: 0 = Activity, 8 = composite Activity (also set to
8 for other composite elements such as Use Cases)
· For Synchronization: 0 = Horizontal, 1 = Vertical.
Note that there are many more Types than indicated in the
above examples.

Tablespace String Read/Write. Associated tablespace for a Table element.

Tag String Read/Write. Corresponds to the Keywords field in the

Enterprise Architect user interface. See the General Settings
482 topic.

TaggedValues Collection 1695 Read only. Returns a collection of TaggedValue 1724 objects.
of type
TaggedValue
1724

TaggedValuesEx Collection 1695 Read only. Returns a collection of TaggedValue 1724 objects
of type belonging to the current element and the elements specialized
TaggedValue or realized by the current element.
1724

Tests Collection 1695 Read only. Collection of Test 1725 objects for current element.

TreePos Long Read/Write. Sets or gets the tree position.

Type String Read/Write. The element type (such as Class, Component).

Note that Type is case sensitive inside Enterprise Architect and
should be provided with an initial capital (proper case). Valid
types are:

Action InteractionOccurrence
Activity InteractionState
ActivityPartition Interface
ActivityRegion InterruptibleActivityRegion
Actor Issue
Artifact Node
Association Note
Boundary Object
Change Package
Class Parameter
Collaboration Part
Component Port
Constraint ProvidedInterface
Decision Report
DeploymentSpecification RequiredInterface

© 1998-2010 Sparx Systems Pty Ltd

 1716 Automation and Scripts | Enterprise Architect Object Model

Attribute Type Notes

DiagramFrame
Requirement
EmbeddedElement
Screen
Entity
Sequence
EntryPoint
State
Event
StateNode
ExceptionHandler
Synchronization
ExitPoint
Text
ExpansionNode
TimeLine
ExpansionRegion
UMLDiagram
GUIElement
UseCase
InteractionFragment

Version String Read/Write. The version of the element.

Visibility String Read/Write. The Scope of this element within the current
package.
Valid values are: Public, Private, Protected or Package.

Element Methods
Method Type Notes

ApplyGroupLock (string Boolean Applies a group lock to the element object, for the specified
aGroupName) group, on behalf of the current user.
Throws an exception if the operation fails. Use GetLastError() to
retrieve error information.
Parameter:
· aGroupName: String - the name of the user group for
which to set the group lock.
ApplyUserLock () Boolean Applies a user lock to the element object for the current user.
Throws an exception if the operation fails. Use GetLastError() to
retrieve error information.

GetLastError () String Returns a string value describing the most recent error that
occurred in relation to this object.
This function is rarely used as an exception is thrown when an
error occurs.

GetLinkedDocument () String Returns a string value containing the element's linked

document contents, in RTF format.
If the element contains no linked document, an empty string is
returned.

GetRelationSet String Returns a string containing a comma-separated list of

(EnumRelationSetType ElementIDs of directly- and indirectly-related elements based
Type) on the given type. See EnumRelationSetType 1676 .
Recurses using the same relation type on all elements it finds,
retrieving all dependencies and sub-dependencies of the
current element; for example, Object1 depends on Object2,
which depends on Object3. Therefore this method returns
Object2 and Object3.
To obtain only the direct relationships of the element, use the
Connector 1738 collection instead.

GetStereotypeList () String Returns a comma-separated list of stereotypes allied to this

element.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1717

Method Type Notes

LoadLinkedDocument Boolean Loads the RTF document from the specified file into the
(string Filename) element's linked document.
Parameter:
· FileName: String - the name of the file from which to load
the RTF document.
Refresh () Void Refreshes the element features in the Project Browser. Usually
called after adding or deleting attributes or methods, when the
user interface is required to be updated as well.

ReleaseUserLock () Boolean Releases a user lock or group lock on the element object.
Throws an exception if the operation fails. Use GetLastError() to
retrieve error information.

SaveLinkedDocument Boolean Saves the linked document for this element to the specified
(string Filename) RTF file.
Parameter:
· FileName: String - the name of the RTF file to which to
save the linked document.
SetAppearance (long Void Sets the visual appearance of the element.
Scope, long Item, long
Parameter:
Value)
· Scope: Long - Scope of appearance set to modify

0 – Local (Diagram-local appearance)

1 – Base (Default appearance across entire model)
· Item: Long - Appearance item to modify

0 – Background color
1 – Font Color
2 – Border Color
3 – Border Width
· Value: Long - Value to set appearance to.
Update () Boolean Update the current element object after modification or
appending a new item.
If false is returned, check the GetLastError function for more
information.

11.2.2.5.4 File

public Class
A File represents an associated file for an element. It is accessed through the Element Files collection.
Associated table in .EAP file: t_objectfiles

File Attributes
Attribute Type Notes

FileDate String Read/Write. The file date when entry is created.

Name String Read/Write. The file name can be a logical file or a reference to a web
address (using http://).

Notes String Read/Write. Notes about the file.

© 1998-2010 Sparx Systems Pty Ltd

 1718 Automation and Scripts | Enterprise Architect Object Model

Attribute Type Notes

ObjectType ObjectTyp Read only. Distinguishes objects referenced through a Dispatch interface.
e 1677

Size String Read/Write. The file size.

Type String Read/Write. File type.

File Methods
Method Type Notes

GetLastError String Returns a string value describing the most recent error that occurred in relation
() to this object.
This function is rarely used as an exception is thrown when an error occurs.

Update () Boolean Update the current File object after modification or appending a new item. If
false is returned, check the GetLastError function for more information.

11.2.2.5.5 Issue (Maintenance)

public Class
An Issue is either a Change or a Defect, is associated with the containing element, and is accessed through
the Issues collection of an element.
Associated table in .EAP file: t_objectproblems

Issue Attributes
Attribute Type Notes

DateReported Date Read/Write. Date issue reported.

DateResolved Date Read/Write. Date issue resolved.

ElementID Long Read/Write. ID of element associated with this issue.

Name String Read/Write. The Issue name; that is, the Issue itself.

Notes String Read/Write. Issue description.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

Priority String Read/Write. Issue priority. Generally should use Low, Medium and High.

Reporter String Read/Write. Person reporting issue.

Resolver String Read/Write. Person resolving issue.

ResolverNotes String Read/Write. Notes entered by resolver about resolution.

Severity String Read/Write. Issue severity. Should be marked as Low, Medium or High.

Status String Read/Write. The current status of the issue.

Type Variant Read/Write. Issue type - can be Defect or Change, Issue and ToDo.

Version String Read/Write. Version associated with issue. Note that this method is only
available through a Dispatch interface. For example:
Object ob = Issue;

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1719

Attribute Type Notes

Print ob.Version;

Issue Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error occurs.

Update () Boolean Update the current Issue object after modification or appending a new item.
If false is returned, check the GetLastError function for more information.

11.2.2.5.6 Metric

public Class
A Metric is a named item with a weighting that can be associated with an element for purposes of building
metrics about the model. Accessed through the Element Metrics collection.
Associated table in .EAP file: t_objectmetrics

Metric Attributes
Attribute Type Notes

Name String Read/Write. The name of the metric.

Notes String Read/Write. Notes about this metric.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch

1677 interface.

Type String Read/Write. The metric type.

Weight Long Read/Write. A user defined weighting for estimation or metric purposes.

Metric Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current Metric object after modification or appending a new
item. If false is returned, check the GetLastError function for more
information.

11.2.2.5.7 Requirement

public Class
An Element Requirement object holds information about the responsibilities of an element in the context of the
model. Accessed using the Element Requirements collection.
Associated table in .EAP file: t_objectrequires

© 1998-2010 Sparx Systems Pty Ltd

 1720 Automation and Scripts | Enterprise Architect Object Model

Requirement Attributes
Attribute Type Notes

Difficulty String Read/Write. Estimated difficulty to implement.

LastUpdate Date Read/Write. Date requirement last updated.

Name String Read/Write. The requirement itself.

Notes String Read/Write. Further notes about requirement.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

ParentID Long Read only. The ElementID of the element to which this requirement
applies.

Priority String Read/Write. Assigned priority of the requirement.

RequirementID Long Read only. A local ID for this requirement.

Stability String Read/Write. Estimated stability of the requirement.

This is an indication of the probability of the requirement - or
understanding of the requirement - changing. High stability indicates a
low probability of the requirement changing.

Status String Read/Write. Current status of the requirement.

Type String Read/Write. Requirement type.

Requirement Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current Requirement object after modification or appending a
new item. If false is returned, check the GetLastError function for more
information.

11.2.2.5.8 Resource

public Class
An Element Resource is a named person/task pair with timing constraints and percent complete indicators.
Use this to manage the work associated with delivering an Element.
Associated table in .EAP file: t_objectresources

Resource Attributes
Attribute Type Notes

ActualHours Long Read/Write. Time already expended on the task, in hours, days or other
units.

DateEnd Date Read/Write. Expected end date.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1721

Attribute Type Notes

DateStart Date Read/Write. Date to start work.

ExpectedHours Long Read/Write. The total expected time the task might run, in hours, days
or other units.

History String Read/Write. Gets or sets history text.

Name String Read/Write. Name of resource (for example, person's name).

Notes String Read/Write. Descriptive notes.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch

1677 interface.

PercentComplete Long Read/Write. Current percent complete figure.

Role String Read/Write. Role they play in implementing the element.

Time Long Read/Write. Time expected; numeric indicating number of days.

Resource Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current Resource object after modification or appending a
new item. If false is returned, check the GetLastError function for more
information.

11.2.2.5.9 Risk

public Class
A Risk object represents a named risk associated with an element and is used for project management
purposes. Accessed through the Element Risks collection.
Associated table in .EAP file: t_objectrisks

Risk Attributes
Attribute Type Notes

Name String Read/Write. The risk.

Notes String Read/Write. Further notes describing the risk.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

Type String Read/Write. The risk type associated with this element.

Weight Long Read/Write. A weighting for estimation or metric purposes.

© 1998-2010 Sparx Systems Pty Ltd

 1722 Automation and Scripts | Enterprise Architect Object Model

Risk Methods
Method Type Notes

GetLastError String Returns a string value describing the most recent error that occurred in
() relation to this object.
This function is rarely used as an exception is thrown when an error occurs.

Update () Boolean Update the current Risk object after modification or appending a new item. If
false is returned, check the GetLastError function for more information.

11.2.2.5.10 Scenario

public Class
A Scenario corresponds to a Collaboration or Use Case instance. Each Scenario is a path of execution
through the logic of a Use Case. Scenarios can be added to using the Element Scenarios collection.
Associated table in .EAP file: t_objectscenarios

Scenario Attributes
Attribute Type Notes

Name String Read/Write. The Scenario name.

Notes String Read/Write. Description of the Scenario. Usually contains the steps to
execute the scenario.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

ScenarioGUID String Read/Write. A unique ID for the Scenario. Used to identify the Scenario
unambiguously within a model.

Steps Collection of Read only. A collection of step objects for this Scenario. Use the AddNew
ScenarioStep 1695 and Delete functions to manage steps. AddNew passes the step

1723 name and "1" as the type for an actor step.

Type String Read/Write. The scenario type (for example, Basic Path).

Weight Long Read/Write. Currently used to position scenarios in the scenario list (that
is, List Position).

XMLContent String Read/Write. A structured field that can contain scenario details in XML
format. It is recommended that you use the Steps 1722 collection to read
or modify this field.

Scenario Methods
Method Type Notes

GetLastError String Returns a string value describing the most recent error that occurred in
() relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current Scenario object after modification or appending a new
item. If false is returned, check the GetLastError function for more
information.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1723

11.2.2.5.11 ScenarioExtension

ScenarioExtension Attributes
Attribute Type Notes

ExtensionGUI String Read/Write. A unique GUID for this Extension.

D

Join String Read/Write. The GUID of the step where this Extension rejoins the
Scenario.

JoiningStep ScenarioStep Read only. The actual step where this Extension rejoins the Scenario, if
1723 any.

Level String Read only. The number of this Extension as shown in the scenario editor.
This is derived from the value of Pos for this object and the owning step.

Name String Read/Write. The Extension name.

Note:
This should match the name of the linked scenario.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

Pos Long Read/Write. The position of the Extension in the Extensions list

Scenario Scenario 1722 Read only. The scenario that is executed as an alternative path for this
Extension.

ScenarioExtension Methods
Method Type Notes

GetLastError String Returns a string value describing the most recent error that occurred in
() relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current ScenarioExtension object after modification or

appending a new item. If false is returned, check the GetLastError
function for more information.

11.2.2.5.12 ScenarioStep

ScenarioStep Attributes
Attribute Type Notes

Extensions Collection of Read only. A collection of ScenarioExtension objects that specify how
ScenarioExtens the scenario is extended from this step. The arguments to AddNew 1695
ion 1723 should match the name and GUID of the alternative scenario being
linked to.

Level String Read only. The number of this Step as shown in the scenario editor. This
is derived from the value of Pos.

Link String Read/Write. The GUID of a Use Case that is relevant to this step.

LinkedElemen Element 1711 Read only. The actual element specified by Link, if any.

© 1998-2010 Sparx Systems Pty Ltd

 1724 Automation and Scripts | Enterprise Architect Object Model

Attribute Type Notes

Name String Read/Write. The Step name.

ObjectType ObjectType 1677 Read only. Distinguishes objects referenced through a Dispatch
interface.

Pos Long Read/Write. The position of the Step in the Scenario Step list.

Results String Read/Write. Any results that are given from this step.

State String Read/Write. A description of the state the system enters when this Step
is executed.

StepGUID String Read/Write. A unique GUID for this Step.

StepType ScenarioStepT Read/Write. Identifies whether this step is being performed by a user or
ype 1679 the system.

Uses String Read/Write. Input and requirements that are relevant to this step.

ScenarioStep Methods
Method Type Notes

GetLastError String Returns a string value describing the most recent error that occurred in
() relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current ScenarioStep object after modification or appending a
new item. If false is returned, check the GetLastError function for more
information.

11.2.2.5.13 TaggedValue

public Class
A TaggedValue is a named property and value associated with an element. It is accessed through the
TaggedValues collection.
Associated table in .EAP file: t_objectproperties

TaggedValue Attributes
Attribute Type Notes

ElementID Long Read/Write. The local ID of the associated element.

Name String Read/Write. Name of the tag.

Notes String Read/Write. Further descriptive notes about this tag.

If Value (below) is set to "<memo>", then Notes should contain the
actual Tagged Value content.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

PropertyGUID String Read/Write. The tag global ID.

PropertyID Long Read only. The tag local ID.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1725

Attribute Type Notes

Value String Read/Write. The value assigned to this tag.

This field has a 255 character limit. If the value is greater than 255
characters long, set the value to "<memo>" and insert the body of text in
the Notes attribute (above).
When reading existing Tagged Values, if Value = "<memo>" then the
developer should read the actual body of text from the Notes attribute.

TaggedValue Methods
Method Type Notes

GetLastError() String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update() Boolean Update the current TaggedValue object after modification or appending a
new item. If false is returned, check the GetLastError function for more
information.

11.2.2.5.14 Test

public Class
A Test is a single Test Case applied to an element. Tests are added and accessed through the Element Tests
collection.
Associated table in .EAP file: t_objecttests

Test Attributes
Attribute Type Notes

AcceptanceCriteria String Read/Write. The acceptance criteria for successful execution.

CheckedBy String Read/Write. Results confirmed by.

Class Long Read/Write. The test Class:

1 = Unit Test
2 = Integration Test
3 = System Test
4 = Acceptance Test
5 = Scenario Test.
DateRun Date Read/Write. Date last run.

Input String Read/Write. Input data.

Name String Read/Write. The test name.

Notes String Read/Write. Detailed notes about test to be carried out.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch

1677 interface.

RunBy String Read/Write. Person conducting test.

Status String Read/Write. Current status of test.

TestResults Variant Read/Write. Results of test.

© 1998-2010 Sparx Systems Pty Ltd

 1726 Automation and Scripts | Enterprise Architect Object Model

Attribute Type Notes

Type String Read/Write. The test type, such as Load or Regression.

Test Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current Test object after modification or appending a new
item. If false is returned, check the GetLastError function for more
information.

11.2.2.6 Element Features

public Package
The ElementFeatures package contains descriptions of the model interfaces that enable access to operations
and attributes, and their associated Tagged Values and constraints.
This diagram illustrates the components associated with element features. These include Attributes and
Methods, and the associated constraints and Tagged Values related to them. It also includes the Parameter
object that defines the arguments associated with an operation (method).

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1727

11.2.2.6.1 Attribute

public Class
An attribute corresponds to a UML Attribute. It contains further collections for constraints and Tagged Values.
Attributes are accessed from the Element Attributes collection.
Associated table in .EAP file: t_attribute

Attribute Attributes
Attribute Type Notes

AllowDuplicate Boolean Read/Write. Indicates if duplicates are allowed in the collection. If the
s attribute represents a database column, this when set represents the Not
Null option.

© 1998-2010 Sparx Systems Pty Ltd

 1728 Automation and Scripts | Enterprise Architect Object Model

Attribute Type Notes

AttributeGUID String Read/Write. A globally unique ID for the current attribute. System
generated.

AttributeID Long Read only. Local ID number of the attribute.

ClassifierID Long Read/Write. Classifier ID, if appropriate; indicates the base type
associated with attribute, if not a primitive type.

Container String Read/Write. The container type.

Containment String Read/Write. Type of containment. Can be Not Specified, By Reference or

By Value.

Constraints Collection Read only. A collection of AttributeConstraint objects. Used to access and
1695 manage constraints associated with this attribute.

Default String Read/Write. Initial value assigned to this attribute.

IsCollection Boolean Read/Write. Indicates if the current feature is a collection or not. If the
attribute represents a database column, this when set represents a
Foreign Key.

IsConst Boolean Read/Write. Flag indicating if the attribute is Const or not.

IsDerived Boolean Read/Write. Indicates if the attribute is derived (that is, a calculated value).

IsOrdered Boolean Read/Write. Indicates if a collection is ordered or not. If the attribute

represents a database column, this when set represents a Primary Key.

IsStatic Boolean Read/Write. Indicates if the current attribute is a static feature or not. If the
attribute represents a database column, this when set represents the
Unique option.

Length String Read/Write. The attribute length, where applicable.

LowerBound String Read/Write. A value for the collection lower bound.

Name String Read/Write. The attribute name.

Notes String Read/Write. Further notes about this attribute.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

ParentID Long Read only. Returns the ElementID of the element that this attribute is a
part of.

Pos Long Read/Write. Position of the attribute in the Class attribute list.

Precision String Read/Write. Precision value.

Scale String Read/Write. Scale value.

Stereotype String Read/Write. Sets or gets the stereotype for this attribute.

StereotypeEx String Read/Write. All the applied stereotypes of the attribute in a comma-
separated list.

Style String Read/Write. Contains the Alias property for this attribute.

StyleEx String Read/Write. Advanced style settings. Reserved for the use of Sparx
Systems.

TaggedValues Collection Read only. A collection of AttributeTag objects. Use to access and manage
1695 of type Tagged Values associated with this attribute.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1729

Attribute Type Notes

AttributeTag
1730

TaggedValuesE Collection Read only. Collection of TaggedValue objects belonging to the current
x 1695 of type attribute and the TaggedValuesEx property of its classifier.
TaggedValu
e 1724

Type String Read/Write. The attribute type (by name; also see ClassifierID).

UpperBound String Read/Write. A value for the collection upper bound.

Visibility String Read/Write. The scope of the attribute. Can be Private, Protected, Public
or Package.

Attribute Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Updates the current attribute object after modifying or appending a new
item. If false is returned, check the GetLastError function for more
information.

11.2.2.6.2 AttributeConstraint

public Class
An AttributeConstraint is a constraint associated with the current Attribute.
Associated table in .EAP file: t_attributeconstraints

AttributeConstraint Attributes
Attribute Type Notes

AttributeID Long Read/Write. ID of the attribute this constraint applies to.

Name String Read/Write. The constraint.

Notes String Read/Write. Descriptive notes about constraint.

ObjectType ObjectType 1677 Read only. Distinguishes objects referenced through a Dispatch
interface.

Type String Read/Write. Type of constraint.

AttributeConstraint Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred
in relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

© 1998-2010 Sparx Systems Pty Ltd

 1730 Automation and Scripts | Enterprise Architect Object Model

Method Type Notes

Update () Boolean Update the current AttributeConstraint object after modification or

appending a new item. If false is returned, check the GetLastError
function for more information.

11.2.2.6.3 AttributeTag

public Class
An AttributeTag represents a Tagged Value associated with an attribute.
Associated table in .EAP file: t_attributetag

AttributeTag Attributes
Attribute Type Notes

AttributeID Long Read/Write. Local ID of attribute associated with this Tagged Value.

Name String Read/Write. Name of tag.

Notes String Read/Write. Further descriptive notes about this tag.

If Value (below) is set to "<memo>", then Notes should contain the
actual Tagged Value content.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch

1677 interface.

TagGUID String Read/Write. A globally unique ID for this Tagged Value.

TagID Long Read only. Local ID to identify Tagged Value.

Value String Read/Write. The value assigned to this tag.

This field has a 255 character limit. If the value is greater than 255
characters long, set the value to "<memo>" and insert the body of text
in the Notes attribute (above).
When reading existing Tagged Values, if Value = "<memo>" then the
developer should read the actual body of text from the Notes attribute.

AttributeTag Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current AttributeTag object after modification or appending
a new item. If false is returned, check the GetLastError function for
more information.

11.2.2.6.4 CustomProperties

public Collection
The CustomProperties collection contains 0 or more Cust Properties associated with the current element.
These properties provide advanced UML configuration options, and must not be added to or deleted. The
value of each property can be set.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1731

Note:
The number and type of properties vary depending on the actual element.

CustomProperty
Attribute Type Notes

Name String Read only. The CustomProperty name.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

Value String Read/Write. The value associated with this custom property. Can be a string,
the boolean values true or false, or an enumeration value from a defined
list. The UML 2.3 specification in general provides information on
enumeration kinds relevant here.

11.2.2.6.5 EmbeddedElements

public Collection
In UML 2.3 an element can have one or more embedded elements such as Ports, Pins, Parameters or
ObjectNodes. These are attached to the boundary of the host element and cannot be moved off the element.
They are owned by their host element. This collection gives easy access to the set of elements embedded on
the surface of an element. Note that some embedded elements can have their own embedded element
collection (for example, Ports can have Interfaces embedded on them).
The EmbeddedElements collection contains Element objects.

© 1998-2010 Sparx Systems Pty Ltd

 1732 Automation and Scripts | Enterprise Architect Object Model

11.2.2.6.6 Method

public Class
A method represents a UML operation. It is accessed from the Element Methods collection and includes
collections for parameters, constraints and Tagged Values.
Associated table in .EAP file: t_operation

Method Attributes
Attribute Type Notes

Abstract Boolean Read/Write. Flag indicating if the method is abstract (1) or not (0).

Behavior String Read/Write. Some further explanatory behavior notes (for example,
pseudocode).

Note:
In earlier releases of Enterprise Architect this attribute had the UK/
Australian spelling 'Behaviour'; this is still present for backwards
compatibility, but please now use the 'Behavior' attribute for consistency.

ClassifierID String Read/Write. Classifier ID that applies to the ReturnType.

Code String Read/Write. Optional field to hold the method Code (used for the Initial
Code field).

Concurrency Variant Read/Write. Concurrency type of method.

IsConst Boolean Read/Write. Flag indicating the method is Const.

IsLeaf Boolean Read/Write. Flag to indicate if the method is Leaf (cannot be overridden).

IsPure Boolean Read/Write. Flag indicating the method is defined as Pure in C++.

IsQuery Boolean Read/Write. Flag to indicate if the method is a query (that is, does not
alter Class variables).

IsRoot Boolean Read/Write. Flag to indicate if the method is Root.

IsStatic Boolean Read/Write. Flag to indicate a static method.

IsSynchronized Boolean Read/Write. Flag indicating a Synchronized method call.

MethodGUID String Read/Write. A globally unique ID for the current method. System
generated.

MethodID Long Read only. A local ID for the current method, only valid within this .EAP
file.

Name String Read/Write. The method name.

Notes String Read/Write. Descriptive notes about the method.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch

1677 interface.

Parameters Collection 1695 Read only. The Parameters collection for the current method. Use to add
and access parameter objects for the current method.

ParentID Long Read only. Returns the ElementID of the element that this method
belongs to.

Pos Long Read/Write. Specifies the position of the method within the set of

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1733

Attribute Type Notes

operations defined for a Class.

PostConditions Collection 1695 Read only. PostConditions (constraints) as they apply to this method.
Returns a MethodConstraint object of type post.

PreConditions Collection 1695 Read only. PreConditions (constraints) as they apply to this method.
Returns a MethodConstraint object of type pre.

ReturnIsArray Boolean Read/Write. Flag to indicate the return value is an array.

ReturnType String Read/Write. Return type for the method; can be a primitive data type or a
Class or Interface type.

StateFlags String Read/Write. Some flags as applied to methods in State elements.

Stereotype String Read/Write. The method stereotype (optional).

StereotypeEx String Read/Write. All the applied stereotypes of the method in a comma-
separated list.

Style String Read/Write. Contains the Alias property for this method.

StyleEx String Read/Write. Advanced style settings. Reserved for the use of Sparx
Systems.

TaggedValues Collection 1695 Read only. TaggedValues collection for the current method. Accesses a
of type list of MethodTag objects.
MethodTag
1734

Throws String Read/Write. Exception information.

Visibility String Read/Write. The method scope: Public, Protected, Private or Package.

Method Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current method object after modification or appending a new
item. If false is returned, check the GetLastError function for more
information.

11.2.2.6.7 MethodConstraint

public Class
A MethodConstraint is a condition imposed on a method. It is accessed through either the Method
PreConditions or Method PostConditions collection.
Associated table in .EAP file: t_operationpres and t_operationposts

MethodConstraint Attributes
Attribute Type Notes

MethodID Long Read/Write. The local ID of the associated method.

© 1998-2010 Sparx Systems Pty Ltd

 1734 Automation and Scripts | Enterprise Architect Object Model

Attribute Type Notes

Name String Read/Write. The name of the constraint.

Notes String Read/Write. Descriptive notes about this constraint.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch

1677 interface.

Type String Read/Write. The constraint type.

MethodConstraint Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current MethodConstraint object after modification or

appending a new item. If false is returned, check the GetLastError
function for more information.

11.2.2.6.8 MethodTag

public Class
A MethodTag is a Tagged Value associated with a method.
Associated table in .EAP file: t_operationtag

MethodTag Attributes
Attribute Type Notes

MethodID Long Read/Write. The ID of the associated method.

Name String Read/Write. The tag or name of the property.

Notes String Read/Write. Further descriptive notes about this tag.

If Value (below) is set to "<memo>", then Notes should contain the
actual Tagged Value content.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

TagGUID String Read/Write. A unique GUID for this Tagged Value.

TagID Long Read only. A unique ID for this Tagged Value.

Value String Read/Write. The value assigned to this tag.

This field has a 255 character limit. If the value is greater than 255
characters long, set the value to "<memo>" and insert the body of text in
the Notes attribute (above).
When reading existing Tagged Values, if Value = "<memo>" then the
developer should read the actual body of text from the Notes attribute.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1735

MethodTag Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current MethodTag object after modification or appending a
new item. If false is returned, check the GetLastError function for more
information.

11.2.2.6.9 Parameter

public Class
A Parameter object represents a method argument and is accessed through the Method Parameters
collection.
Associated table in .EAP file: t_operationparams

Parameter Attributes
Attribute Type Notes

Alias String Read/Write. An optional alias for this parameter.

ClassifierID String Read/Write. A ClassifierID for the parameter, if known.

Default String Read/Write. A default value for this parameter.

IsConst Boolean Read/Write. Flag indicating the parameter is Const (cannot be altered).

Kind String Read/Write. The parameter kind - in, inout, out, return.

Name String Read/Write. The parameter name; must be unique for a single method.

Notes String Read/Write. Descriptive notes.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

OperationID Long Read only. ID of the method associated with this parameter.

ParameterGUI String Read/Write. A globally unique ID for the current Parameter. System
D generated.

Position Long Read/Write. The position in the argument list.

Stereotype String Read/Write. The first stereotype of the parameter.

StereotypeEx String Read/Write. All the applied stereotypes of the parameter in a comma-
separated list.

Style String Read/Write. Some style information.

StyleEx String Read/Write. Advanced style settings. Reserved for the use of Sparx
Systems.

Type Variant Read/Write. The parameter type; can be a primitive type or defined
classifier.

© 1998-2010 Sparx Systems Pty Ltd

 1736 Automation and Scripts | Enterprise Architect Object Model

Parameter Methods
Method Type Notes

GetLastError String Returns a string value describing the most recent error that occurred in
() relation to this object.
This function is rarely used as an exception is thrown when an error occurs.

Update () Boolean Update the current Parameter object after modifying or appending a new
item. If false is returned, check the GetLastError function for more
information.

11.2.2.6.10 Partitions

public Collection
A collection of internal element partitions (regions). This is commonly seen in Activity 753 , State 789 , Boundary
836 , Diagram Frame 766 and similar elements. Not all elements support partitions.

This collection contains a set of Partition elements. The set is read/write: information is not saved until the host
element is saved, so ensure that you call the Element.Save method after making changes to a Partition.

Partition Attributes
Attribute Type Notes

Name String Read/Write. The partition name; can represent a condition or constraint in
some cases.

Note String Read/Write. A free text note associated with this partition.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

Operator String Read/Write. An optional operator value that specifies the partition type.

Size String Read/Write. Vertical or horizontal width of partition in pixels.

11.2.2.6.11 Properties

Properties
Properties Attributes

Attribute Type Notes

Count Long The number of properties that are available for this object.

ObjectType ObjectType 1677 Read only. Distinguishes objects referenced through a Dispatch
interface.

Properties Methods

Method Type Notes

Item (object Index) Property Returns a property either by name or by zero-based integer offset
into the list of properties.
Parameter:
· Index: Variant - either a string representing the property name
or an integer representing the zero-based offset into the
property list.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1737

Property
Property Attributes

Attribute Type Notes

Name String Read only. Identifies the property. The object to which the
properties list applies can have an automation property with the
same name, in which case the data accessed through Value is
identical to that obtained through the automation property.

ObjectType ObjectType 1677 Read only. Distinguishes objects referenced through a Dispatch
interface.

Type PropType 1678 Read only. Provides an indication of what sort of data is going to
be stored by this property. This restriction can be further defined by
the Validation attribute.

Validation String Read only. Optional string that is used to validate any data that is
passed to the Value attribute. This string is used by the
programmer at run time to provide an indication of what's
expected, and by Enterprise Architect to ensure that the submitted
data is appropriate.

Value Variant Read/write. The value of the property as defined in the other fields.

11.2.2.6.12 Transitions

public Collection
Applies only to Timeline elements. A Timeline element displays 0 or more state transitions at set times on its
extent. This collection enables you to access the transition set. You can also access additional information by
referring to the connectors associated with the Timeline, and by referencing messages passed between
timelines. Note that any changes made to elements in this collection are only saved when the main element is
saved.

Transition Attributes
Attribute Type Notes

DurationConstra String Read/Write. A constraint on the time duration that the transition takes.
int

Event String Read/Write. Event (optional) that initiated transition.

Note String Read/Write. A free text note.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

TimeConstraint String Read/Write. A constraint on when the transition has to be complete by.

TxState String Read/Write. The state to transition to. Defined in the Timeline Properties
dialog.

TxTime String Read/Write. The time that the transition occurs. Value depends on range
set in diagram.

© 1998-2010 Sparx Systems Pty Ltd

 1738 Automation and Scripts | Enterprise Architect Object Model

11.2.2.7 Connector

public Package
The Connector package details how connectors between elements are accessed and managed.

11.2.2.7.1 ConnectorConstraint

public Class
A ConnectorConstraint holds information about special conditions that apply to a connector. It is accessed
through the Connector Constraints collection.
Associated table in .EAP file: t_connectorconstraints

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1739

ConnectorConstraint Attributes
Attribute Type Notes

ConnectorID Long Read/Write. A local ID value (long) - system generated.

Name String Read/Write. The constraint name.

Notes String Read/Write. Notes about this constraint.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

Type String Read/Write. The constraint type.

ConnectorConstraint Methods
Method Type Notes

GetLastError String Returns a string value describing the most recent error that occurred in relation
() to this object.
This function is rarely used as an exception is thrown when an error occurs.

Update () Boolean Update the current ConnectorConstraint object after modification or appending
a new item. If false is returned, check the GetLastError function for more
information.

11.2.2.7.2 Connector

public Class
A Connector object represents the various kinds of connectors between UML elements. It is accessed from
either the Client or Supplier element, using the Connectors collection of that element. When creating a new
connector you must assign it a valid type from the following list:
· Aggregation
· Assembly
· Association
· Collaboration
· CommunicationPath
· Connector
· ControlFlow
· Delegate
· Dependency
· Deployment
· ERLink
· Generalization
· InformationFlow
· Instantiation
· InterruptFlow
· Manifest
· Nesting
· NoteLink
· ObjectFlow
· Package
· Realization
· Sequence
· StateFlow

© 1998-2010 Sparx Systems Pty Ltd

 1740 Automation and Scripts | Enterprise Architect Object Model

· UseCase
Associated table in .EAP file: t_connector

Connector Attributes
Attribute Type Notes

Alias String Read/Write. An optional alias for this connector.

ClientEnd ConnectorEn Read only. A pointer to the ConnectorEnd object representing the source
d 1742 end of the relationship.

ClientID Long Read/Write. ElementID of the element at the source end of this
connector.

Color Long Read/Write. Sets the color of the connector.

ConnectorGUID Variant Read only. A globally unique ID for the current connector. System
generated.

ConnectorID Long Read only. Local identifier for the current connector. System generated.

Constraints Collection 1695 Read only. Collection of constraint 1710 objects.

CustomProperti Collection 1695 Read only. Returns a collection of advanced properties associated with
es an element in the form of CustomProperty 1730 objects.

DiagramID Long Read/Write. The DiagramID of the connector.

Direction String Read/Write. Connector direction. Can be set to one of the following:
· Unspecified
· Bi-Directional
· Source -> Destination
· Destination -> Source
EndPointX Long Read/Write. The x-coordinate of the connector's end point.

Note:
Connector end points are specified in Cartesian coordinates with the
origin to the top left of the screen.

EndPointY Long Read/Write. The y-coordinate of the connector's end point.

Note:
Connector end points are specified in Cartesian coordinates with the
origin to the top left of the screen.

EventFlags String Read/Write. Structure to hold a variety of flags concerned with event
signaling on messages.

IsLeaf Boolean Read/Write. Flag indicating connector is a leaf.

IsRoot Boolean Read/Write. Flag indicating connector is a root.

IsSpec Boolean Read/Write. Flag indicating connector is a specification.

MetaType String Read only. The connector's domain-specific meta type, as defined by an
applied stereotype from an MDG Technology.

MiscData String Read only. This low-level property provides information about the
contents of the PDatax fields. These database fields are not
documented and developers must gain understanding of these fields

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1741

Attribute Type Notes

through their own endeavors to use this property.

MiscData is zero based, therefore:
· MiscData(0) corresponds to PData1
· MiscData(1) to PData2
and so on.

Name String Read/Write. The connector name.

Notes String Read/Write. Descriptive notes about the connector.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch

1677 interface.

Properties Properties 1736 Returns a list of specialized properties that apply to the connector that
might not be available using the automation model. The properties are
purposely undocumented because of their obscure nature and because
they are subject to change as progressive enhancements are made to
them.

RouteStyle Long Read/Write. The route style.

SequenceNo Long Read/Write. The SequenceNo of the connector.

StartPointX Long Read/Write. The x-coordinate of the connector's start point.

Note:
Connector end points are specified in Cartesian coordinates with the
origin to the top left of the screen.

StartPointY Long Read/Write. The y-coordinate of the connector's start point.

Note:
Connector end points are specified in Cartesian coordinates with the
origin to the top left of the screen.

StateFlags String Read/Write. Structure to hold a variety of flags concerned with State
signaling on messages, the list delimited by semi-colons.

Stereotype String Read/Write. Sets or gets the stereotype for this connector end.

StereotypeEx String Read/Write. All the applied stereotypes of the connector in a comma-
separated list.

StyleEx String Read/Write. Advanced style settings. Reserved for the use of Sparx
Systems.

Subtype String Read/Write. A possible subtype to refine the meaning of the connector.

SupplierEnd ConnectorEn Read only. A pointer to the ConnectorEnd object representing the target
d 1742 end of the relationship.

SupplierID Long Read/Write. ElementID of the element at the target end of this
connector.

TaggedValues Collection Read only. Collection of ConnectorTag objects.

TransitionActio String Read/Write. See the Transition 892 topic for appropriate values.
n

TransitionEvent String Read/Write. See the Transition 892 topic for appropriate values.

© 1998-2010 Sparx Systems Pty Ltd

 1742 Automation and Scripts | Enterprise Architect Object Model

Attribute Type Notes

TransitionGuard String Read/Write. See the Transition 892 topic for appropriate values.

Type String Read/Write. Connector type. Valid types are held in the
t_connectortypes table in the .EAP file.

VirtualInheritanc String Read/Write. For Generalization, indicates if inheritance is virtual.

e

Width Long Read/Write. Specifies the width of the connector.

Connector Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

MiscData (long String Read only. This low-level property provides information about the contents
Index) of the PDatax fields. These database fields are not documented and
developers must gain understanding of these fields through their own
endeavors to use this property.
MiscData is zero based, therefore:
· MiscData(0) corresponds to PData1
· MiscData(1) to PData2
Parameters:
· Index: long - the zero based index of the PData field to access.
Update () Boolean Update the current ConnectorObject after modification or appending a new
item. If false is returned, check the GetLastError function for more
information.

11.2.2.7.3 ConnectorEnd

public Class
A ConnectorEnd contains information about a single end of a connector. A ConnectorEnd is accessed from
the connector as either the ClientEnd or SupplierEnd.
Associated table in .EAP file: derived from t_connector

ConnectorEnd Attributes
Attribute Type Notes

Aggregation Long Read/Write. Aggregation as it applies to this end. Valid values are:
0 = None
1 = Shared
2 = Composite.
Alias String Read/Write. An optional alias for this connector end.

AllowDuplicates Boolean Read/Write. For multiplicities greater than 1, indicates that duplicate
entries are possible.

Cardinality String Read/Write. Cardinality associated with this end.

Constraint String Read/Write. A constraint that can be applied to this connector end.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1743

Attribute Type Notes

Containment String Read/Write. Containment type applied to this connector end.

Derived Boolean Read/Write. Indicates that the value of this end is derived.

DerivedUnion Boolean Read/Write. Indicates the value of this role derived from the union of
all roles that subset this.

End String Read only. The end this ConnectorEnd object applies to: Client or
Supplier.

IsChangeable String Read/Write. Flag indicating whether this end is changeable or not.
Values: frozen, addOnly or none.

IsNavigable Boolean Read/Write. Flag indicating this end is navigable from the other end.

Navigable String Read/Write. Indicates whether this role of an association is navigable

from the opposite classifier. Three values are valid: Navigable, Non-
Navigable and Unspecified.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch

1677 interface.

Ordering Long Read/Write. Ordering for this connector end.

OwnedByClassifie Boolean Read/Write. Indicates this Association end corresponds to an

r attribute on the opposite end of the Association.

Qualifier String Read/Write. A qualifier that can apply to connector end.

Role String Read/Write. The connector end role.

RoleNote String Read/Write. Notes associated with the role of this connector end.

RoleType String Read/Write. The role type applied to this end of the connector.

Stereotype String Read/Write. Sets or gets the stereotype for this connector end.

StereotypeEx String Read/Write. All the applied stereotypes of the connector end in a
comma-separated list.

TaggedValues Private Read only. Collection of RoleTag 1744 objects.

Visibility String Read/Write. Scope associated with this connector end. Valid types
are: Public, Private, Protected and Package.

ConnectorEnd Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred
in relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current ConnectorEnd object after modification or

appending a new item. If false is returned, check the GetLastError
function for more information.

© 1998-2010 Sparx Systems Pty Ltd

 1744 Automation and Scripts | Enterprise Architect Object Model

11.2.2.7.4 ConnectorTag

public Class
A ConnectorTag is a Tagged Value for a connector and is accessed through the Connector TaggedValues
collection.
Associated table in .EAP file: t_connectortag

ConnectorTag Attributes
Attribute Type Notes

ConnectorID Long Read/Write. The local ID of the associated connector.

Name String Read/Write. The tag or name.

Notes String Read/Write. Further descriptive notes about this tag.

If Value (below) is set to "<memo>", then Notes should contain the
actual Tagged Value content.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch

1677 interface.

TagGUID String Read/Write. A globally unique ID for this Tagged Value.

TagID Long Read only. A local ID to identify the Tagged Value.

Value String Read/Write. The value assigned to this tag.

This field has a 255 character limit. If the value is greater than 255
characters long, set the value to "<memo>" and insert the body of text
in the Notes attribute (above).
When reading existing Tagged Values, if Value = "<memo>" then the
developer should read the actual body of text from the Notes attribute.

ConnectorTag Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current ConnectorTag object after modification or appending
a new item. If false is returned, check the GetLastError function for
more information.

11.2.2.7.5 RoleTag

public Class
This interface provides access to the association Role Tagged Values. Each connector end has a RoleTag
collection that can be accessed to add, delete and access the RoleTags.
In code you create something that resembles the following (where con is a Connector Object):
Code fragment for accessing a RoleTag in VB.NET:

client = con.ClientEnd
client.Role = "m_client"
client.Update()
tag = client.TaggedValues.AddNew("tag", "value")
tag.Update()

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1745

tag = client.TaggedValues.AddNew("tag2", "value2")

tag.Update()
client.TaggedValues.Refresh()
For idx = 0 To client.TaggedValues.Count - 1
tag = client.TaggedValues.GetAt(idx)
Console.WriteLine(tag.Tag)
client.TaggedValues.DeleteAt(idx, False)
Next
tag = Nothing

RoleTag Attributes
Attribute Type Notes

BaseClass String Read/Write. Indicates the role end; set to ASSOCIATION_SOURCE or

ASSOCIATION_TARGET.

ElementGUID String Read/Write. GUID of the connector with which this role tag is associated.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

PropertyGUID String Read/Write. A system generated GUID to identify the Tagged Value.

Tag String Read/Write. The actual tag name.

Value String Read/Write. The value associated with this tag.

RoleTag Methods
Method Type Notes

GetLastError String Returns a string value describing the most recent error that occurred in
() relation to this object.
This function is rarely used as an exception is thrown when an error occurs.

Update () Boolean Update the RoleTag after changes or on initial creation. If false is returned,
check the GetLastError function for more information.

11.2.2.8 Diagram

public Package
The Diagram package has information on a diagram and on DiagramObjects and DiagramLinks, which are the
instances of elements within a diagram.

© 1998-2010 Sparx Systems Pty Ltd

 1746 Automation and Scripts | Enterprise Architect Object Model

11.2.2.8.1 Diagram

public Class
A Diagram corresponds to a single Enterprise Architect diagram. It is accessed through the Package
Diagrams collection and in turn contains a collection of diagram objects and diagram connectors. Adding to
the DiagramObjects collection adds an element to the diagram (the element must already exist). When adding
a new diagram, you must set the diagram type to a valid type; these are:
· Activity
· Analysis
· Component
· Custom
· Deployment
· Logical

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1747

· Sequence
· Statechart
· Use Case

Note:
Use the Analysis type for a Collaboration Diagram.

Associated table in .EAP file: t_diagram

Diagram Attributes
Attribute Type Notes

Author String Read/Write. The author.

CreatedDate Date Read/Write. The date the diagram was created.

cx Long Read/Write. The X dimension of the diagram (default is 800).

cy Long Read/Write. The Y dimension of the diagram (default is 1100).

DiagramGUID Variant Read/Write. A globally unique ID for this diagram.

DiagramID Long Read only. A local ID for the diagram.

DiagramLinks Collection Read only. A list of DiagramLink objects, each containing information
1695 about the display characteristics of a connector in a diagram.

Note:
A DiagramLink is only created once a user modifies a connector in a
diagram in some way. Until this condition has been met default values
are used and the DiagramLink is not in use.

DiagramObjects Collection Read only. A collection of references to DiagramObjects 1750 . A

1695 DiagramObject is an instance of an element in a diagram, and includes
size and display characteristics.

ExtendedStyle String Read/Write. An extended style attribute.

HighlightImports Boolean Read/Write. Flag to indicate elements from other packages should be
highlighted.

IsLocked Boolean Read/Write. Flag indicating whether this diagram is locked or not.

MetaType String Read only. The diagram's domain-specific meta type, as defined by an
MDG Technology.

ModifiedDate Variant Read/Write. The date the diagram was last modified.

Name String Read/Write. The diagram name.

Notes String Read/Write. Set/retrieve notes for this diagram.

ObjectType ObjectTyp Read only. Distinguishes objects referenced through a Dispatch interface.
e 1677

Orientation String Read/Write. Page orientation: P for Portrait or L for Landscape.

PackageID Long Read/Write. An ID of the package that this diagram belongs to.

ParentID Long Read/Write. An optional ID of an element that 'owns' this diagram; for
example, a Sequence diagram owned by a Use Case.

Scale Long Read/Write. The zoom scale (default is 100).

© 1998-2010 Sparx Systems Pty Ltd

 1748 Automation and Scripts | Enterprise Architect Object Model

Attribute Type Notes

SelectedConnector Connector Read/Write. The currently selected connector on this diagram. Null if
1739 there is no currently selected diagram.

SelectedObjects Collection Read only. Gets a collection representing the currently selected elements
1695 on the diagram. Can remove objects from this collection to deselect them,
and add elements to the collection by passing the Object ID as a name to
select them.

ShowDetails Long Read/Write. Flag to indicate Diagram Details text should be shown. 1 =
Show, 0 = Hide.

ShowPackageCont Boolean Read/Write. Flag to indicate package contents should be shown in the
ents current diagram.

ShowPrivate Boolean Read/Write. Flag to show or hide Private features.

ShowProtected Boolean Read/Write. Flag to show or hide Protected features.

ShowPublic Boolean Read/Write. Flag to show or hide Public features.

Stereotype String Read/Write. Sets or gets the stereotype for this diagram.

StyleEx String Read/Write. Advanced style settings. Reserved for the use of Sparx
Systems.

Swimlanes String Read/Write. Information on swimlanes contained in the diagram. Please

note that this property is superseded by SwimlaneDef 1751 .

SwimlaneDef Swimlane Read/Write. Information on swimlanes contained in the diagram.

Def 1751

Type String Read only. The diagram type. See the t_diagramtypes table in the .EAP
file for more information.

Version String Read/Write. The version of the diagram.

Diagram Methods
Method Type Notes

ApplyGroupLock Boolean Applies a group lock to this diagram object, for the specified group, on
(string behalf of the current user.
aGroupName) Throws an exception if the operation fails. Use GetLastError() to retrieve
error information.
Parameter:
· aGroupName: String - the name of the user group for which to set the
group lock.
ApplyUserLock () Boolean Applies a user lock to this diagram object, for the current user.
Throws an exception if the operation fails. Use GetLastError() to retrieve
error information.

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

ReleaseUserLock Boolean Releases a group lock or user lock on this diagram object.
()
Throws an exception if the operation fails. Use GetLastError() to retrieve
error information.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1749

Method Type Notes

ReorderMessages Void Resets the display order of Sequence and Collaboration messages.
() Typically used after inserting or deleting messages in the diagram.

ShowAsElementLi Boolean Toggles the diagram display between diagram format and Element List
st (bool depending on the value of ShowAsList.
ShowAsList, bool
If Persist is set, the display format is written to the database so the
Persist) diagram always opens in that format (diagram or list). Otherwise, the
display format falls back to the default (diagram) once the display is
closed.
Parameters:
· ShowAsList: Boolean - indicates diagram or Element List
· Persist: Boolean - indicates set (maintain ShowAsList value) or not
(revert to default).
Update () Boolean Updates this diagram object after modification or appending a new item.
If false is returned, use GetLastError() to retrieve error information.

11.2.2.8.2 DiagramLinks

public Class
A DiagramLink is an object that holds display information about a connector between two elements in a
specific diagram. It includes, for example, the custom points and display appearance. Accessed from the
Diagram DiagramLinks 1747 collection.
Associated table in .EAP file: t_diagramlinks

DiagramLinks Attributes
Attribute Type Notes

ConnectorID Long Read/Write. The ID of the associated connector.

DiagramID Long Read/Write. The local ID for the associated diagram.

Geometry String Read/Write. The geometry associated with the current connector in this
diagram.

InstanceID Long Read only. Holds the connector identifier for the current model.

IsHidden Boolean Read/Write. Flag to indicate if this item is hidden or not.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

Path String Read/Write. The path of the connector in this diagram.

Style String Read/Write. Additional style information; for example, color, thickness.

DiagramLinks Methods
Method Type Notes

GetLastError String Returns a string value describing the most recent error that occurred in
() relation to this object.
This function is rarely used as an exception is thrown when an error occurs.

Update () Boolean Update the current DiagramLink object after modification or appending a
new item.

© 1998-2010 Sparx Systems Pty Ltd

 1750 Automation and Scripts | Enterprise Architect Object Model

Method Type Notes

If false is returned, check the GetLastError function for more information.

11.2.2.8.3 DiagramObjects

public Class
The DiagramObjects collection holds a list of element IDs and presentation information that indicates what is
displayed in a diagram and how it is shown.
Associated table in .EAP file: t_diagramobjects

DiagramObjects Attributes
Attribute Type Notes

Bottom Long Read/Write. The bottom position of the element.

DiagramID Long Read/Write. The ID of the associated diagram (long).

ElementID Long Read/Write. The ElementID of the object instance in this diagram.

InstanceID Long Read/Write. Read only attribute. Holds the connector identifier for the
current model.

Left Long Read/Write. The left position of the element.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

Right Long Read/Write. The right position of the element.

Sequence Long Read/Write. The sequence position when loading into diagram (affects Z
order). The Z-order is one-based and the lowest value is in the
foreground.

Style Variant Write only (reading this value gives undefined results). Style information
for this object.
See Setting the Style 1750 below for more information.

Top Long Read/Write. The top position of the element.

DiagramObjects Methods
Method Type Notes

GetLastError () String Returns a string value describing the most recent error that occurred in
relation to this object.
This function is rarely used as an exception is thrown when an error
occurs.

Update () Boolean Update the current DiagramObject object after modification or appending
a new item.
If false is returned, check the GetLastError function for more information.

Setting The Style

The Style attribute is used for setting the appearance of a DiagramObject. It is set with a string value in the
format:
BCol=n;BFol=n;LCol=n;LWth=n;

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1751

where:
· BCol = Background Color
· BFol = Font Color
· LCol = Line Color
· LWth = Line Width

The color value is a decimal representation of the hex RGB value, where Red=FF, Green=FF00 and
Blue=FF0000. For example:
DiagObj.Style = "BCol=35723;BFol=9342520;LCol=9342520;LWth=1;"

The following code snippet shows how you might change the style settings for all of the objects in the current
diagram, in this case changing everything to red.
For Each aDiagObj In aDiag.DiagramObjects
aDiagObj.Style = "BCol=255;BFol=9342520;LCol=9342520;LWth=1;"
aDiagObj.Update
aRepos.ReloadDiagram aDiagObj.DiagramID
Next

11.2.2.8.4 SwimlaneDef
A SwimlaneDef object makes available attributes relating to a single row or column in a list of swimlanes.

Attribute Type Notes

Bold Boolean Read/Write. Show the title text in bold.

FontColor Long Read/Write. RGB color used to draw the titles.

HideClassifier Boolean Read/Write. Removes any classifier from title display.

HideNames Boolean Read/Write. Set to true to hide the swimlane titles.

LineColor Long Read/Write. RGB color used to draw swimlane borders.

LineWidth Long Read/Write. Width of line, in pixels, used to draw swimlanes. Valid
values: 1, 2 or 3.

Locked Boolean Read/Write. If set to true, disables user modification of the swimlanes via
the diagram.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

Orientation String Read/Write. Indication of whether the swimlanes are vertical or horizontal.

ShowInTitleBar Boolean Read/Write. Enables vertical swimlane titles to be shown in title bar.

Swimlanes Swimlanes Read/Write. A list of individual swimlanes.

1751

11.2.2.8.5 Swimlanes
A Swimlanes object is attached to a diagram's SwimlaneDef 1751 object and provides a mechanism to access
individual swimlanes.

Swimlanes Attributes
Attribute Type Notes

Count Long Read/Write. Gives the number of swimlanes.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch

© 1998-2010 Sparx Systems Pty Ltd

 1752 Automation and Scripts | Enterprise Architect Object Model

Attribute Type Notes

1677 interface.

Swimlanes Methods
Method Type Notes

Add (string Title, Swimlane 1752 Adds a new swimlane to the end of the list. Returns a swimlane object
long Width) representing the newly added entry.
Parameters:
· Title: String - The title text that appears at the top of the swimlane.
Can be the same as an existing swimlane title.
· Width: Long - The width of the swimlane in pixels.
Delete (object Void Deletes a selected swimlane.
Index)
If the string matches more than one entry, only the first entry is deleted.
Parameter:
· Index: Object - Either a string representing the title text or an
integer representing the zero-based index of the swimlane to
delete.
DeleteAll () Void Removes all swimlanes.

Insert (long Swimlane 1752 Inserts a swimlane at a specific position.Returns a swimlane object
Index, string representing the newly added entry.
Title, long Width) Parameters:
· Index: Long - The zero-based index of the existing Swimlane before
which this new entry is inserted.
· Title: String - The title text which appears at the top of the
swimlane. Can be the same as an existing swimlane title.
· Width: Long - The width of the swimlane in pixels.
Items (object Swimlane 1752 Accesses an individual swimlane.
Index) collection
If the string matches more than one swimlane title, the first matching
swimlane is returned.
Parameter:
· Index: Object - Either a string representing the title text or an
integer representing the zero-based index of the swimlane to get.

11.2.2.8.6 Swimlane
A Swimlane object makes available attributes relating to a single row or column in a list of swimlanes 1751 .

Attribute Type Notes

BackColor Long Read/Write. The swimlane is filled with this RGB color.

ClassifiedGuid String Read/Write. The GUID of the classifier Class. This can be obtained from
the corresponding Element object via the ElementGUID property.

ObjectType ObjectType Read only. Distinguishes objects referenced through a Dispatch interface.
1677

Title String Read/Write. Text at the head of the swimlane.

Width Long Read/Write. The width of the swimlane in pixels.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1753

11.2.2.9 Project Interface

public Package
The Enterprise Architect.Project interface. This is the XML-based interface to Enterprise Architect elements; it
also includes some utility functions. You can get a pointer to this interface using the Repository.
GetProjectInterface method.

11.2.2.9.1 Project

public Class
The Project interface can be accessed from the Repository using GetProjectInterface(). The returned interface
provides access to the XML-based Enterprise Architect Automation Interface. Use this interface to get XML for
the various internal elements and to run some utility functions to perform tasks such as load diagrams or run
reports.

Note:
These methods all require input GUIDs in XML format; use GUIDtoXML 1760 to change the Enterprise
Architect GUID to an XML GUID.

Project Attributes
Attribute Type Notes

ObjectType ObjectType 1677 Read only. Distinguishes objects referenced through a

Dispatch interface.

Project Methods
Method Type Notes

CreateBaseline (string Boolean Creates a Baseline of a specified package.

PackageGUID, string Version,
Parameters:
string Notes)
· PackageGUID: String - the GUID (in XML format)
of the package to Baseline.
· Version: String - the version of the Baseline.
· Notes: String - any notes concerning the
Baseline.

© 1998-2010 Sparx Systems Pty Ltd

 1754 Automation and Scripts | Enterprise Architect Object Model

Method Type Notes

CreateBaselineEx(string Boolean Creates a Baseline of a specified package, with a flag

PackageGUID, string Version, to exclude package contents 282 below the first level.
string Notes, EA.
Parameters:
CreateBaselineFlag Flags)
· PackageGUID: String - the GUID (in XML format)
of the package to Baseline.
· Version: String - the version of the Baseline.
· Notes: String - any notes concerning the
Baseline.
· Flags: EA.CreateBaselineFlag 1676 - whether or
not to exclude package contents below the first
level
DefineRule (string CategoryID, String Defines the individual rules that can be performed
EA.EnumMVErrorType during model validation. It must be called once for
ErrorType, string each rule from the EA_OnInitializeUserRules 1812
ErrorMessage broadcast handler.
The return value is a RuleId, which can be used for
reference purposes when an individual rule is
executed by Enterprise Architect during model
validation.
See Model Validation Example 1816 for a detailed
example of use of this method.
Parameters:
· CategoryId: String - should be passed the return
value from the DefineRuleCategory 1754 method.
· ErrorType: EA.EnumMVErrorType - depending on
the severity of the error being validated, can be:
· mvErrorCritical
· mvError
· mvWarning, or
· mvInformation.
· ErrorMessage: String - can contain a default error
string, although this is probably overridden by the
PublishResult 1763 call.
DefineRuleCategory (string String Defines a category of rules that can be performed
CategoryName) during model validation (there is typically one category
per Add-In). It must be called once from the
EA_OnInitializeUserRules 1812 broadcast handler.
The return value is a CategoryId that must to be
passed to the DefineRule 1754 method.
See Model Validation Example 1816 for a detailed
example of use of this method.
Parameters:
· CategoryName: String - a text string that is visible
in the Model Validation Configuration dialog.
DeleteBaseline (string Boolean Deletes a Baseline, identified by the BaselineGUID,
BaselineGUID) from the repository.
Parameters:
· BaselineGUID: String - the GUID (in XML format) of
the Baseline to delete.

DoBaselineCompare String Performs a Baseline comparison using the supplied

(string PackageGUID, string package GUID and Baseline GUID (obtained in the

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1755

Method Type Notes

Baseline, string ConnectString result list from GetBaselines 1758 ).

)
Optionally you can include the connection string
required to find the Baseline if it exists in a different
model file.
This method returns a log file of the status of all
elements found and compared in the difference
procedure. You can use this log information as input
to DoBaselineMerge 1755 - automatically merging
information from the Baseline.
Parameters:
· PackageGUID: String - the GUID (in XML format)
of the package to run the comparison on.
· Baseline: String - the GUID (in XML format) of the
Baseline to run the comparison on.
· ConnectString: String - the location of the external
.EAP file or DBMS to extract the Baseline from.
DoBaselineMerge String Performs a batch merge based on instructions
(string PackageGUID, string contained in an XML file (MergeInstructions). You can
Baseline, string supply an optional connection string if the Baseline is
MergeInstructions, string located in another model.
ConnectString) In the MergeInstructions file, each MergeItem node
supplies the GUID of a differenced item from the XML
difference log. As the merge is uni-directional and
actioned in only one possible way, no additional
arguments are required. Enterprise Architect chooses
the correct procedure based on the Difference results.
<Merge>
<MergeItem guid="{XXXXXX}" />
<MergeItem guid="{XXXXXX}" />
</Merge>
Alternatively, you can supply a single Mergeitem with a
GUID of RestoreAll. In this case, Enterprise Architect
batch-processes ALL differences.
<Merge>
<MergeItem guid="RestoreAll" />
</Merge>
Parameters:
· PackageGUID: String - the GUID (in XML format)
of the package to merge the Baseline into.
· Baseline: String - the GUID of the Baseline (in
XML format) to merge into the package.
· MergeInstructions: String - the file containing the
GUID of each differenced item from the XML
difference log returned by DoBaselineCompare()
1754 .

· ConnectString: String - the location of the EAP

file or DBMS to get the Baseline from, if not in the
same model as the package.
EnumDiagramElements (string protected Gets an XML list of all elements in a diagram.
DiagramGUID) abstract: String
Parameters:
· DiagramGUID: String - the GUID (in XML format)
of the diagram to get elements for.

© 1998-2010 Sparx Systems Pty Ltd

 1756 Automation and Scripts | Enterprise Architect Object Model

Method Type Notes

EnumDiagrams (string protected Gets an XML list of all diagrams in a specified

PackageGUID) abstract: String package.
Parameters:
· PackageGUID: String - the GUID (in XML format)
of the package to list diagrams for.
EnumElements (string protected Gets an XML list of elements in a specified package.
PackageGUID) abstract: String
Parameters:
· PackageGUID: String - the GUID (in XML format)
of the package to get a list of elements for.
EnumLinks (string protected Gets an XML list of connectors for a specified element.
ElementGUID) abstract: String
Parameters:
· ElementGUID: String - the GUID (in XML format)
of the element to get all associated connectors
for.
EnumPackages (string protected Gets an XML list of child packages inside a parent
PackageGUID) abstract: String package.
Parameters:
· PackageGUID: String - the GUID (in XML format)
of the parent package.
EnumProjects () protected Gets a list of projects in the current file; corresponds
abstract: String to Models 1682 in Repository.

EnumViews () protected Enumerates the Views for a project. Returned as an

abstract: String XML document.

EnumViewEx (string protected Gets a list of Views in the current project.

ProjectGUID) abstract: String
Parameters:
· ProjectGUID: String - the GUID (in XML format) of
the project to get views for.
Exit () protected Exits the current instance of Enterprise Architect; this
abstract: String function is maintained for backward compatibility and
should never be called.
Enterprise Architect automatically exits when you are
no longer using any of the provided objects.

ExportPackageXMI (string protected Exports XMI for a specified package.

PackageGUID, enumXMIType abstract: String
Parameters:
XMIType, long DiagramXML,
long DiagramImage, long · PackageGUID: String - the GUID (in XML format)
FormatXML, long UseDTD, of the package to be exported.
string FileName) · XMIType: EnumXMIType - specifies the XMI type
and version information; see XMIType Enum 1679
for accepted values.
· DiagramXML: Long - true if XML for diagrams is
required; accepted values:
0 = Do not export diagrams
1 = Export diagrams
2 = Export diagrams along with alternate images.
· DiagramImage: Long - the format for diagram
images to be created at the same time; accepted
values:
-1=NONE
0=EMF
1=BMP

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1757

Method Type Notes

2=GIF
3=PNG
4=JPG.
· FormatXML: Long - true if XML output should be
formatted prior to saving.
· UseDTD: Long - true if a DTD should be used.
· FileName: String - the filename to output to.
ExportPackageXMIEx (string protected Exports XMI for a specified package, with a flag to
PackageGUID, enumXMIType abstract: String determine whether the export includes package
XMIType, long DiagramXML, content 295 below the first level.
long DiagramImage, long Parameters:
FormatXML, long UseDTD,
string FileName, ea. · PackageGUID: String - the GUID (in XML format)
ExportPackageXMIFlag Flags) of the package to be exported.
· XMIType: EnumXMIType - specifies the XMI type
and version information; see XMIType Enum 1679
for accepted values.
· DiagramXML: Long - true if XML for diagrams is
required; accepted values:
0 = Do not export diagrams
1 = Export diagrams
2 = Export diagrams along with alternate images.
· DiagramImage: Long - the format for diagram
images to be created at the same time; accepted
values:
-1=NONE
0=EMF
1=BMP
2=GIF
3=PNG
4=JPG.
· FormatXML: Long - true if XML output should be
formatted prior to saving.
· UseDTD: Long - true if a DTD should be used.
· FileName: String - the filename to output to.
· Flags: ea.ExportPackageXMIFlag 1677 - whether or
not to include package content below the first
level (currently only supported for xmiEADefault).
GenerateClass (string Boolean Generates the code for a single Class.
ElementGUID, string
Parameters:
ExtraOptions)
· ElementGUID: String - the GUID (in XML format)
of the element to generate.
· ExtraOptions: String - enables extra options to be
given to the command; currently unused.
GenerateDiagramFromScenari Boolean Generates various diagrams from the Structured
o (string ElementGUID, Specification of an element.
EnumScenarioDiagramType Parameters:
DiagramType, long
OverwriteExistingDiagram) · ElementGUID: String - the GUID (in XML format)
of the element containing the Structured
Specification.
· DiagramType: EnumScenarioDiagramType - the
type of diagram to generate; see
ScenarioDiagramType Enum 1678 for accepted
values
· OverwriteExistingDiagram: Long - determines

© 1998-2010 Sparx Systems Pty Ltd

 1758 Automation and Scripts | Enterprise Architect Object Model

Method Type Notes

whether to overwrite the existing diagram or

synchronize the existing elements with the
scenario steps
0 = Delete existing diagram and elements, and
create new diagram and elements
1 = Synchronize existing elements with scenario
steps and preserve diagram layout
2 = Synchronize existing elements with scenario
steps and re-cast diagram layout
3 = Do not generate diagram if one already exists.
GeneratePackage (string Boolean Generates the code for all Classes within a package.
Package GUID, string
For example: recurse=1;overwrite=1;dir=C:\
ExtraOptions)
Parameters:
· PackageGUID: String - the GUID (in XML format)
of the package to generate.
· ExtraOptions: String - enables extra options to be
given to the command; currently enables:
· Generation of all subpackages (recurse)
· Force overwrite of all files (overwrite) and
· Specification to auto generate all paths (dir).
GenerateTestFromScenario Boolean Generates either an Internal test or an External test
(string ElementGUID, 505 from the Structured Specification of an element.

EnumScenarioTestType
Parameters:
TestType)
· ElementGUID: String - the GUID (in XML format)
of the element containing the Structured
Specification.
· TestType: EnumScenarioTestType - the type of
test to generate; see ScenarioTestType Enum 1679
for accepted values.
GenerateXSD (string Boolean Creates an XML schema for this GenerateXSD.
PackageGUID, string Returns true on success.
FileName, string Encoding,
Parameters:
string Options)
· PackageGUID: String - the GUID (in XML format)
of the package.
· FileName: String - target filepath.
· Encoding: String - the XML encoding for the code
page instruction.
· Options: String - enables extra options to be given
to the command; currently enables:
· GenGlobalElement - turn the generation of
global elements for all global ComplexTypes
On or Off; for example: - GenGlobalElement=1.
GetBaselines (string String Returns a list (in XML format) of Baselines associated
PackageGUID, string with the supplied package GUID. Optionally, you can
ConnectString) provide a connection string to get Baselines from the
same package, but located in a different model file (or
DBMS).
Parameters:
· PackageGUID: String - the GUID (in XML format)
of the package to get Baselines for.
· ConnectString: String - the location of the EAP file
or DBMS to get the Baselines from, if not in the
same model as the package.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1759

Method Type Notes

GetDiagram (string protected Gets diagram details, in XML format.

DiagramGUID) abstract: String
Parameters:
· DiagramGUID: String - the GUID (in XML format)
of the diagram to get details for.
GetElement (string protected Gets XML for the specified element.
ElementGUID) abstract: String
Parameters:
· ElementGUID: String - the GUID (in XML format)
of the element to retrieve XML for.
GetElementConstraints (string protected Gets constraints for an element, in XML format.
ElementGUID) abstract: String
Parameters:
· ElementGUID: String - the GUID (in XML format)
of the element.
GetElementEffort (string protected Gets efforts for an element, in XML format.
ElementGUID) abstract: String
Parameters:
· ElementGUID: String - the GUID (in XML format)
of the element.
GetElementFiles (string protected Gets metrics for an element, in XML format.
ElementGUID) abstract: String
Parameters:
· ElementGUID: String - the GUID (in XML format)
of the element.
GetElementMetrics (string protected Gets files for an element, in XML format.
ElementGUID) abstract: String
Parameters:
· ElementGUID: String - the GUID (in XML format)
of the element.
GetElementProblems (string protected Gets a list of issues (problems) associated with an
ElementGUID) abstract: String element, in XML format.
Parameters:
· ElementGUID: String - the GUID (in XML format)
of the element.
GetElementProperties (string protected Gets Tagged values for an element, in XML format.
ElementGUID) abstract: String
Parameters:
· ElementGUID: String - the GUID (in XML format)
of the element.
GetElementRequirements (s protected Gets a list of requirements for an element, in XML
tring ElementGUID) abstract: String format.
Parameters:
· ElementGUID: String -the GUID (in XML format)
of the element.
GetElementResources (string protected Gets a list of resources for an element, in XML format.
ElementGUID) abstract: String
Parameters:
· ElementGUID: String - the GUID (in XML format)
of the element.
GetElementRisks (string protected Gets a list of risks associated with an element, in XML
ElementGUID) abstract: String format.
Parameters:

© 1998-2010 Sparx Systems Pty Ltd

 1760 Automation and Scripts | Enterprise Architect Object Model

Method Type Notes

· ElementGUID: String - the GUID (in XML format)

of the element.
GetElementScenarios (string protected Gets a list of scenarios for an element, in XML format.
ElementGUID) abstract: String
Parameters:
· ElementGUID: String - the GUID (in XML format)
of the element.
GetElementTests (string protected Gets a list of tests for an element, in XML format.
ElementGUID) abstract: String
Parameters:
· ElementGUID: String - the GUID (in XML format)
of the element.
GetLastError () protected Returns a string value describing the most recent error
abstract: String that occurred in relation to this object.
This function is rarely used as an exception is thrown
when an error occurs.

GetLink (string LinkGUID) protected Gets connector details, in XML format.

abstract: String
Parameters:
· LinkGUID: String - the GUID (in XML format) of
the connector to get details of.
GUIDtoXML (string GUID) String Changes an internal GUID to the form used in XML.
Parameters:
· GUID: String - the Enterprise Architect style GUID
to convert to XML format.
ImportDirectory (string Boolean Imports a source code directory into the model.
PackageGUID, string
Parameters:
Language, string
DirectoryPath, string · PackageGUID: String - the GUID (in XML format)
ExtraOptions) of the package to reverse engineer code into.
· Language: String - specifies the language of the
code to be imported.
· DirectoryPath: String - specifies the path where
the code is found on the computer.
· ExtraOptions: String - enables extra options to be
given to the command; currently enables import
of source from all child directories (recurse) - for
example: recurse=1.
ImportFile (string Boolean Imports an individual file or binary module into the
PackageGUID, string model, in a package per namespace style import.
Language, string FileName, Parameters:
string ExtraOptions)
· PackageGUID: String - the GUID (in XML format)
of the package to reverse engineer code into; this
is expected to be a namespace root package.
· Language: String - specifies the language of the
code to be imported.
Note:
Use the value "DNPE" to import a binary module. This
imports a .Net assembly or Java .class file, but not a .
jar file.

· Filename: String - specifies the path where the

code or module is found on the computer.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1761

Method Type Notes

· ExtraOptions: String - enables extra options to be

given to the command; currently unused.
ImportPackageXMI (string String Imports an XMI file at a point in the tree.
PackageGUID, string
Parameters:
Filename, long
ImportDiagrams, long · PackageGUID: String - the GUID (in XML format)
StripGUID) of the target package to import the XMI file into
(or overwrite with the XMI file).
· Filename or XMLText: String - the name of the
XMI file.
Note:
If the String is of type filename it is interpreted as a
source file, otherwise the String is imported as XML
text.

· ImportDiagrams: Long.
· StripGUID: Long - boolean value to indicate
whether to replace the element UniqueIDs on
import; if stripped, then a package could be
imported twice into Enterprise Architect, as two
different versions.
LayoutDiagram (string Boolean Deprecated. it is recommended that
DiagramGUID, long LayoutDiagramEx is used instead.
LayoutStyle)
Calls the function to automatically layout a diagram in
hierarchical fashion. It is only recommended for Class
and Object diagrams.
Parameters:
· DiagramGUID: String - the GUID (in XML format)
of the diagram to lay out.
· LayoutStyle: Long - always ignored.
LayoutDiagramEx (string Boolean Calls the function to automatically layout a diagram in
DiagramGUID, long hierarchical fashion. It is only recommended for Class
LayoutStyle, long Iterations, and Object diagrams.
long LayerSpacing, long LayoutStyle accepts the following options (also see
ColumnSpacing, boolean ConstLayoutStyles Enum 1675 ):
SaveToDiagram)
· Default Options:
lsDiagramDefault
lsProgramDefault.
· Cycle Removal Options:
lsCycleRemoveGreedy
lsCycleRemoveDFS.
· Layering Options:
lsLayeringLongestPathSink
lsLayeringLongestPathSource
lsLayeringOptimalLinkLength.
· Initialize Options:
IsInitializeNaive
IsInitializeDFSOut
IsInitializeDFSIn.
· Crossing Reduction Option:
lsCrossReduceAggressive.
· Layout Options - Direction
lsLayoutDirectionUp

© 1998-2010 Sparx Systems Pty Ltd

 1762 Automation and Scripts | Enterprise Architect Object Model

Method Type Notes

lsLayoutDirectionDown
lsLayoutDirectionLeft
lsLayoutDirectionRight.
Parameters:
· DiagramGUID: String - the GUID (in XML format)
of the diagram to lay out.
· LayoutStyle: Long - the layout style.
· Iterations: Long - the number of layout iterations
the Layout process should take to perform cross
reduction (Default value = 4).
· LayerSpacing: Long - the per-element layer
spacing the Layout process shall use (Default
value = 20).
· ColumnSpacing: Long - the per-element column
spacing the Layout process shall use (Default
value = 20).
· SaveToDiagram: Boolean - specifies whether or
not Enterprise Architect should save the supplied
layout options as default to the diagram in
question.
LoadControlledPackage ( String Loads a package that has been marked and
string PackageGUID) configured as controlled. The filename details are
stored in the package control data.
Parameters:
· PackageGUID: String - the GUID (in XML format)
of the package to load.
LoadDiagram (string protected Loads a diagram by its GUID.
DiagramGUID) abstract:
Boolean Parameter:
· DiagramGUID: String - the GUID (in XML format)
of the diagram to load; if you retrieve the GUID
using the Diagram interface, use the GUIDtoXML
1760 function to convert it to XML format.

LoadProject (string FileName) protected Loads an Enterprise Architect project file. Do not use
abstract: this method if you have accessed the Project interface
Boolean from the Repository, which has already loaded a file.
Parameters:
· FileName: String - the name of the project file to
load.
MigrateToBPMN11 (string Void Migrates every BPMN 1.0 construct in a package or an
GUID, string Type) element (including elements, attributes, diagrams and
connectors) to BPMN 1.1.
Parameters
· GUID: String - the GUID of the package or
element for which the contents are to be migrated
to BPMN 1.1
· Type: String - the type of upgrade, either just to
BPMN 1.1 or to BPMN 1.1 and BPEL. Accepted
values:

BPMN = migrate to BPMN 1.1

BPEL = migrate to BPMN 1.1 and update:
· any diagram with stereotype BPMN to
BPEL
· any element with stereotype

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1763

Method Type Notes

BusinessProcess to BPELProcess.
Note:
Migrating to BPEL is possible only in the Ultimate or
Business and Software Engineering editions of
Enterprise Architect.

PublishResult (string String Returns the results of each rule that can be performed
CategoryID, EA. during model validation. It must be called once for
EnumMVErrorType ErrorType, each rule from the EA_OnInitializeUserRules 1812
string ErrorMessage broadcast handler.
The return value is a RuleId, which can be used for
reference purposes when an individual rule is
executed by Enterprise Architect during model
validation.
See Model Validation Example 1816 for a detailed
example of use of this method.
Parameters:
· CategoryId: String - should be passed the return
value from the DefineRuleCategory 1754 method.
· ErrorType: EA.EnumMVErrorType - depending on
the severity of the error being validated, can be:
· mvErrorCritical
· mvError
· mvWarning, or
· mvInformation.
· ErrorMessage: String - contains an error string.
PutDiagramImageOnClipboard protected Copies an image of the specified diagram to the
(string DiagramGUID, long abstract: clipboard.
Type) Boolean
Parameters:
· DiagramGUID: String - the GUID (in XML format)
of the diagram to copy.
· Type: Long - the file type.
· If Type = 0 then it is a metafile
· If Type = 1 then it is a Device Independent
Bitmap.
PutDiagramImageToFile (s protected Saves an image of the specified diagram to file.
tring Diagram GUID, string abstract:
Boolean Parameters:
FileName, long Type)
· DiagramGUID: String - the GUID (in XML format)
of the diagram to save.
· FileName: String - the name of the file to save the
diagram into.
· Type: Long - the file type.
· If type = 0 then it is a metafile
· If type = 1 then it uses the file type from the
name extension (that is, .bmp, .jpg, .gif, .png, .
tga)
ReloadProject () protected Reloads the current project. This is a convenient
abstract: method to refresh the current loaded project (in case
Boolean of outside changes to the .EAP file).

RunReport (string protected Runs a named RTF report.

PackageGUID, string abstract: Void

© 1998-2010 Sparx Systems Pty Ltd

 1764 Automation and Scripts | Enterprise Architect Object Model

Method Type Notes

TemplateName, string Parameters:

Filename)
· PackageGUID: String - the GUID (in XML format)
of the package to run the report on.
· TemplateName: String - the RTF report template
to use. If the PackageGUID has a stereotype of
MasterDocument, the template is not required.
· FileName: String - the file name to store the
generated report in.
RunHTMLReport (string String Runs an HTML report (same as Documentation |
PackageGUID, string HTML Documentation when you right-click on a
ExportPath, string package in the Project Browser).
ImageFormat, string Style,
Parameters:
string Extension)
· PackageGUID: String - the GUID (in XML format)
of the package to run the report on.
· ExportPath: String - the file name to store the
generated report in.
· ImageFormat: String.
· Style: String.
· Extension: String.
SaveControlledPackage (s String Saves a package that has been configured as a
tring PackageGUID) controlled package, to XMI. Only the package GUID is
required, Enterprise Architect picks the rest up from
the package control information.
Parameter:
· PackageGUID: String - the GUID (in XML format)
of the package to save.
SaveDiagramImageToFile (s protected Saves a diagram image of the current diagram to file.
tring Filename) abstract: String
Parameters:
· FileName: String - the filename of the image to
save.
ShowWindow (long Show) protected Shows or hides the Enterprise Architect User
abstract: Void Interface.
Parameters:
· Show: Long.
SynchronizeClass (string Boolean Synchronizes a Class with the latest source code.
ElementGUID, string
Parameters:
ExtraOptions)
· ElementGUID: String - the GUID (in XML format)
of the element to update from code.
· ExtraOptions: String - enables extra options to be
given to the command; currently unused.
SynchronizePackage (string Boolean Synchronizes each Class in a package with the latest
PackageGUID, string source code.
ExtraOptions) Parameters:
· PackageGUID: String - the GUID (in XML format)
of the package containing the elements to update
from code.
· ExtraOptions: String - enables extra options to be
given to the command; currently enables
synchronization of all child packages (children) -
for example: children=1.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1765

Method Type Notes

TransformElement (string Boolean Transforms an element into a package.

TransformName, string
Parameters:
ElementGUID, string
TargetPackage, string · TransformName: String - specifies the
ExtraOptions) transformation that should be executed.
· ElementGUID: String - the GUID (in XML format)
of the element to transform.
· TargetPackageGUID: String - the GUID (in XML
format) of the package to transform into.
· ExtraOptions: String - enables extra options to be
given to the command; currently unused.
TransformPackage (string Boolean Runs a transformation on the contents of a package.
TransformName, string
Parameters:
SourcePackage, string
TargetPackage, string · TransformName: String - specifies the
ExtraOptions) transformation that should be executed.
· SourcePackageGUID: String - the GUID (in XML
format) of the package to transform.
· TargetPackageGUID: String - the GUID (in XML
format) of the package to transform into.
· ExtraOptions: String - enables extra options to be
given to the command; currently unused.
XMLtoGUID (string GUID) String Changes a GUID in XML format to the form used
inside Enterprise Architect.
Parameters:
· GUID: String - the XML style GUID to convert to
Enterprise Architect internal format.

11.2.2.10 Code Samples

This topic contains various code examples indicating how to use the Automation Interface, written in VB.Net:
· Open the Repository 1765
· Iterate Through a .EAP File 1766
· Add and Manage Packages 1766
· Add and Manage Elements 1767
· Add a Connector 1767
· Add and Manage Diagrams 1768
· Add and Delete Features 1769
· Element Extras 1769
· Repository Extras 1772
· Stereotypes 1773
· Work with Attributes 1773
· Work with Methods 1774

11.2.2.10.1 Open the Repository

public Object
''An example of how to open an Enterprise Architect repository
''in VB.Net.

Public Class AutomationExample

''class level variable for Repository

Public m_Repository As Object

© 1998-2010 Sparx Systems Pty Ltd

 1766 Automation and Scripts | Enterprise Architect Object Model

Public Sub Run()

try
''create the repository object
m_Repository = CreateObject("EA.Repository")

''open an EAP file

m_Repository.OpenFile("F:\Test\EAAuto.EAP")
''use the Repository in any way required
'DumpModel

''close the repository and tidy up

m_Repository.Exit()
m_Repository = Nothing

....catch e as exception
Console.WriteLine(e)
End try
End Sub
end Class

11.2.2.10.2 Iterate Through a .EAP File

public Object
''Assume repository has already been opened.

''Start at the model level

Sub DumpModel()
Dim idx as Integer
For idx=0 to m_Repository.Models.Count-1
DumpPackage("",m_Repository.Models.GetAt(idx))
Next
End Sub

'output package name, then element contents, then process child packages
Sub DumpPackage(Indent as String, Package as Object)
Dim idx as Integer
Console.WriteLine(Indent + Package.Name)
DumpElements(Indent + " ", Package)

For idx = 0 to Package.Packages.Count-1

DumpPackage(Indent + " ", Package.Packages.GetAt(idx))
Next
End Sub

''dump element name

Sub DumpElements(Indent as String, Package as Object)
Dim idx as Integer
For idx = 0 to Package.Elements.Count-1
Console.WriteLine(Indent + "::" + Package.Elements.GetAt(idx).Name)
Next
End Sub

11.2.2.10.3 Add and Manage Packages

public Object
Example illustrating how to add a Model or a Package.

Sub TestPackageLifecycle

Dim idx as integer

Dim idx2 as integer
Dim package as object
Dim model as object
Dim o as object

''first add a new Model

model = m_Repository.Models.AddNew("AdvancedModel","")
If not model.Update() Then
Console.WriteLine(model.GetLastError())
End If

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1767

''refresh the models collection

m_Repository.Models.Refresh

''now work through models collection and add a package

For idx = 0 to m_Repository.Models.Count -1

o = m_Repository.Models.GetAt(idx)
Console.WriteLine(o.Name)
If o.Name = "AdvancedModel" Then
package = o.Packages.Addnew("Subpackage","Nothing")
If not package.Update() Then
Console.WriteLine(package.GetLastError())
End If

package.Element.Stereotype = "system"
package.Update

''for testing purposes just delete the

''newly created Model and its contents
m_Repository.Models.Delete(idx)

End If
Next

End Sub

11.2.2.10.4 Add and Manage Elements

public Object
''Add and delete elements in a package.

Sub ElementLifecycle

Dim package as Object

Dim element as Object

package = m_Repository.GetPackageByID(2)
element = package.elements.AddNew("Login to Website","UseCase")
element.Stereotype = "testcase"
element.Update
package.elements.Refresh()

Dim idx as integer

''note the repeated calls to "package.elements.GetAt"

''in general you should make this call once and assign to a local
''variable - in the example below, Enterprise Architect loads the element required
''everytime a call is made - rather than loading once and keeping
''a local reference

For idx = 0 to package.elements.count-1

Console.WriteLine(package.elements.GetAt(idx).Name)
If (package.elements.GetAt(idx).Name = "Login to Website" and _
package.elements.GetAt(idx).Type = "UseCase") Then
package.elements.deleteat(idx, false)
End If
Next
End Sub

11.2.2.10.5 Add a Connector

public Object
"Add a connector and set values.

Sub ConnectorTest

Dim source as object

Dim target as object
Dim con as object
Dim o as object

© 1998-2010 Sparx Systems Pty Ltd

 1768 Automation and Scripts | Enterprise Architect Object Model

Dim client as object

Dim supplier as object

''use ElementID's to quickly load an element in this example

''... you must find suitable ID's in your model

source = m_Repository.GetElementByID(129)
target = m_Repository.GetElementByID(169)

con = source.Connectors.AddNew ("test link 2", "Association")

''again- replace ID with a suitable one from your model

con.SupplierID = 169

If not con.Update Then

Console.WriteLine(con.GetLastError)
End If
source.Connectors.Refresh

Console.WriteLine("Connector Created")

o = con.Constraints.AddNew ("constraint2","type")
If not o.Update Then
Console.WriteLine(o.GetLastError)
End If

o = con.TaggedValues.AddNew ("Tag","Value")
If not o.Update Then
Console.WriteLine(o.GetLastError)
End If

''use the client and supplier ends to set

''additional information

client = con.ClientEnd
client.Visibility = "Private"
client.Role = "m_client"
client.Update
supplier = con.SupplierEnd
supplier.Visibility = "Protected"
supplier.Role = "m_supplier"
supplier.Update

Console.WriteLine("Client and Supplier set")

Console.WriteLine(client.Role)
Console.WriteLine(supplier.Role)

End Sub

11.2.2.10.6 Add and Manage Diagrams

public Object
''An example of how to create a diagram and add an element to it.
''Note the optional use of element rectangle setting using
''left,right,top and bottom dimensions in AddNew call.

Sub DiagramLifeCycle

Dim diagram as object

Dim v as object
Dim o as object
Dim package as object

Dim idx as Integer

Dim idx2 as integer

package = m_Repository.GetPackageByID(5)

diagram = package.Diagrams.AddNew("Logical Diagram","Logical")

If not diagram.Update Then
Console.WriteLine(diagram.GetLastError)
End if

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1769

diagram.Notes = "Hello there this is a test"

diagram.update()

o = package.Elements.AddNew("ReferenceType","Class")
o.Update

'' add element to diagram - supply optional rectangle co-ordinates

v = diagram.DiagramObjects.AddNew("l=200;r=400;t=200;b=600;","")
v.ElementID = o.ElementID
v.Update

Console.WriteLine(diagram.DiagramID)

End Sub

11.2.2.10.7 Add and Delete Features

public Object
Dim element as object
Dim idx as integer
Dim attribute as object
Dim method as object

'just load an element by ID - you must

'substitute a valid ID from your model
element = m_Repository.GetElementByID(246)

''create a new method

method = element.Methods.AddNew("newMethod", "int")
method.Update
element.Methods.Refresh

'now loop through methods for Element - and delete our addition
For idx = 0 to element.Methods.Count-1
method =element.Methods.GetAt(idx)
Console.Writeline(method.Name)
If(method.Name = "newMethod") Then
element.Methods.Delete(idx)
End if
Next

'create an attribute
attribute = element.attributes.AddNew("NewAttribute", "int")
attribute.Update
element.attributes.Refresh

'loop through and delete our new attribute

For idx = 0 to element.attributes.Count-1
attribute =element.attributes.GetAt(idx)
Console.Writeline(attribute.Name)
If(attribute.Name = "NewAttribute") Then
element.attributes.Delete(idx)
End If
Next

11.2.2.10.8 Element Extras

public Object
''Examples of how to access and use element extras, such as
''scenarios, constraints and requirements.

Sub ElementExtras

Dim element as object

Dim o as object
Dim idx as Integer
Dim bDel as boolean
bDel = true

try

© 1998-2010 Sparx Systems Pty Ltd

 1770 Automation and Scripts | Enterprise Architect Object Model

element = m_Repository.GetElementByID(129)

'manage constraints for an element

'demonstrate addnew and delete
o = element.Constraints.AddNew("Appended","Type")
If not o.Update Then
Console.WriteLine("Constraint error:" + o.GetLastError())
End if
element.Constraints.Refresh
For idx = 0 to element.Constraints.Count -1
o = element.Constraints.GetAt(idx)
Console.WriteLine(o.Name)
If(o.Name="Appended") Then
If bDel Then element.Constraints.Delete (idx)
End if
Next

'efforts
o = element.Efforts.AddNew("Appended","Type")
If not o.Update Then
Console.WriteLine("Efforts error:" + o.GetLastError())
End if
element.Efforts.Refresh
For idx = 0 to element.Efforts.Count -1
o = element.Efforts.GetAt(idx)
Console.WriteLine(o.Name)
If(o.Name="Appended") Then
If bDel Then element.Efforts.Delete (idx)
End if
Next

'Risks
o = element.Risks.AddNew("Appended","Type")
If not o.Update Then
Console.WriteLine("Risks error:" + o.GetLastError())
End if
element.Risks.Refresh
For idx = 0 to element.Risks.Count -1
o = element.Risks.GetAt(idx)
Console.WriteLine(o.Name)
If(o.Name="Appended") Then
If bDel Then element.Risks.Delete (idx)
End if
Next

'Metrics
o = element.Metrics.AddNew("Appended","Change")
If not o.Update Then
Console.WriteLine("Metrics error:" + o.GetLastError())
End if
element.Metrics.Refresh
For idx = 0 to element.Metrics.Count -1
o = element.Metrics.GetAt(idx)
Console.WriteLine(o.Name)
If(o.Name="Appended") Then
If bDel Then element.Metrics.Delete (idx)
End if
Next

'TaggedValues
o = element.TaggedValues.AddNew("Appended","Change")
If not o.Update Then
Console.WriteLine("TaggedValues error:" + o.GetLastError())
End if
element.TaggedValues.Refresh
For idx = 0 to element.TaggedValues.Count -1
o = element.TaggedValues.GetAt(idx)
Console.WriteLine(o.Name)
If(o.Name="Appended") Then
If bDel Then element.TaggedValues.Delete (idx)
End if
Next

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1771

'Scenarios
o = element.Scenarios.AddNew("Appended","Change")
If not o.Update Then
Console.WriteLine("Scenarios error:" + o.GetLastError())
End if
element.Scenarios.Refresh
For idx = 0 to element.Scenarios.Count -1
o = element.Scenarios.GetAt(idx)
Console.WriteLine(o.Name)
If(o.Name="Appended") Then
If bDel Then element.Scenarios.Delete (idx)
End if
Next

'Files
o = element.Files.AddNew("MyFile","doc")
If not o.Update Then
Console.WriteLine("Files error:" + o.GetLastError())
End if
element.Files.Refresh
For idx = 0 to element.Files.Count -1
o = element.Files.GetAt(idx)
Console.WriteLine(o.Name)
If(o.Name="MyFile") Then
If bDel Then element.Files.Delete (idx)
End if
Next

'Tests
o = element.Tests.AddNew("TestPlan","Load")
If not o.Update Then
Console.WriteLine("Tests error:" + o.GetLastError())
End if
element.Tests.Refresh
For idx = 0 to element.Tests.Count -1
o = element.Tests.GetAt(idx)
Console.WriteLine(o.Name)
If(o.Name="TestPlan") Then
If bDel Then element.Tests.Delete (idx)
End if
Next

'Defect
o = element.Issues.AddNew("Broken","Defect")
If not o.Update Then
Console.WriteLine("Issues error:" + o.GetLastError())
End if
element.Issues.Refresh
For idx = 0 to element.Issues.Count -1
o = element.Issues.GetAt(idx)
Console.WriteLine(o.Name)
If(o.Name="Broken") Then
If bDel Then element.Issues.Delete (idx)
End if
Next

'Change
o = element.Issues.AddNew("Change","Change")
If not o.Update Then
Console.WriteLine("Issues error:" + o.GetLastError())
End if
element.Issues.Refresh
For idx = 0 to element.Issues.Count -1
o = element.Issues.GetAt(idx)
Console.WriteLine(o.Name)
If(o.Name="Change") Then
If bDel Then element.Issues.Delete (idx)
End if
Next

catch e as exception
Console.WriteLine(element.Methods.GetLastError())
Console.WriteLine(e)
End try

End Sub

© 1998-2010 Sparx Systems Pty Ltd

 1772 Automation and Scripts | Enterprise Architect Object Model

11.2.2.10.9 Repository Extras

public Object
'' Examples of how to access repository
'' collections for system level information.

Sub RepositoryExtras

Dim o as object
Dim idx as integer

'issues
o = m_Repository.Issues.AddNew("Problem","Type")
If(o.Update=false) Then
Console.WriteLine (o.GetLastError())
End if
o = nothing
m_Repository.Issues.Refresh
For idx = 0 to m_Repository.Issues.Count-1
Console.Writeline(m_Repository.Issues.GetAt(idx).Name)
If(m_Repository.Issues.GetAt(idx).Name = "Problem") then
m_Repository.Issues.DeleteAt(idx,false)
Console.WriteLine("Delete Issues")
End if
Next

''tasks
o = m_Repository.Tasks.AddNew("Task 1","Task type")
If(o.Update=false) Then
Console.WriteLine ("error - " + o.GetLastError())
End if
o = nothing
m_Repository.Tasks.Refresh
For idx = 0 to m_Repository.Tasks.Count-1
COnsole.Writeline(m_Repository.Tasks.GetAt(idx).Name)
If(m_Repository.Tasks.GetAt(idx).Name = "Task 1") then
m_Repository.Tasks.DeleteAt(idx,false)
Console.WriteLine("Delete Tasks")
End if
Next

''glossary
o = m_Repository.Terms.AddNew("Term 1","business")
If(o.Update=false) Then
Console.WriteLine ("error - " + o.GetLastError())
End if
o = nothing
m_Repository.Terms.Refresh
For idx = 0 to m_Repository.Terms.Count-1
COnsole.Writeline(m_Repository.Terms.GetAt(idx).Term)
If(m_Repository.Terms.GetAt(idx).Term = "Term 1") then
m_Repository.Terms.DeleteAt(idx,false)
Console.WriteLine("Delete Terms")
End if
Next

'authors
o = m_Repository.Authors.AddNew("Joe B","Writer")
If(o.Update=false) Then
Console.WriteLine (o.GetLastError())
End if
o = nothing
m_Repository.Authors.Refresh
For idx = 0 to m_Repository.authors.Count-1
COnsole.Writeline(m_Repository.Authors.GetAt(idx).Name)
If(m_Repository.authors.GetAt(idx).Name = "Joe B") then
m_Repository.authors.DeleteAt(idx,false)
Console.WriteLine("Delete Authors")
End if
Next

o = m_Repository.Clients.AddNew("Joe Sphere","Client")
If(o.Update=false) Then

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1773

Console.WriteLine (o.GetLastError())
End if
o = nothing
m_Repository.Clients.Refresh
For idx = 0 to m_Repository.Clients.Count-1
COnsole.Writeline(m_Repository.Clients.GetAt(idx).Name)
If(m_Repository.Clients.GetAt(idx).Name = "Joe Sphere") then
m_Repository.Clients.DeleteAt(idx,false)
Console.WriteLine("Delete Clients")
End if
Next

o = m_Repository.Resources.AddNew("Joe Worker","Resource")
If(o.Update=false) Then
Console.WriteLine (o.GetLastError())
End if
o = nothing
m_Repository.Resources.Refresh
For idx = 0 to m_Repository.Resources.Count-1
COnsole.Writeline(m_Repository.Resources.GetAt(idx).Name)
If(m_Repository.Resources.GetAt(idx).Name = "Joe Worker") then
m_Repository.Resources.DeleteAt(idx,false)
Console.WriteLine("Delete Resources")
End if
Next

End Sub

11.2.2.10.10 Stereotypes

public Object
Sub TestStereotypes

Dim o as object
Dim idx as integer

''add a new stereotype to the Stereotypes collection

o = m_Repository.Stereotypes.AddNew("funky","class")
If(o.Update=false) Then
Console.WriteLine (o.GetLastError())
End if
o = nothing

''make sure you refresh

m_Repository.Stereotypes.Refresh

''then iterate through - deleting our new entry in the process

For idx = 0 to m_Repository.Stereotypes.Count-1
COnsole.Writeline(m_Repository.Stereotypes.GetAt(idx).Name)
If(m_Repository.Stereotypes.GetAt(idx).Name = "funky") then
m_Repository.Stereotypes.DeleteAt(idx,false)
Console.WriteLine("Delete element")
End if
Next

End Sub

11.2.2.10.11 Work With Attributes

public Object
''An example of working with attributes.

Sub AttributeLifecycle

Dim element as object

Dim o as object
Dim t as object
Dim idx as Integer
Dim idx2 as integer
try
element = m_Repository.GetElementByID(129)

© 1998-2010 Sparx Systems Pty Ltd

 1774 Automation and Scripts | Enterprise Architect Object Model

For idx = 0 to element.Attributes.Count -1

Console.WriteLine("attribute=" + element.Attributes.GetAt(idx).Name)

o = element.Attributes.GetAt(idx)
t = o.Constraints.AddNew("> 123","Precision")
t.Update()
o.Constraints.Refresh
For idx2 = 0 to o.Constraints.Count-1
t = o.Constraints.GetAt(idx2)
Console.WriteLine("Constraint: " + t.Name)
If(t.Name="> 123") Then
o.Constraints.DeleteAt(idx2, false)
End if
Next

For idx2 = 0 to o.TaggedValues.Count-1

t = o.TaggedValues.GetAt(idx2)
If(t.Name = "Type2") Then
'Console.WriteLine("deleteing")
o.TaggedValues.DeleteAt(idx2, true)
End if
Next

t = o.TaggedValues.AddNew("Type2","Number")
t.Update
o.TaggedValues.Refresh
For idx2 = 0 to o.TaggedValues.Count-1
t = o.TaggedValues.GetAt(idx2)
Console.WriteLine("Tagged Value: " + t.Name)
Next

If(element.Attributes.GetAt(idx).Name = "m_Tootle") Then

Console.WriteLine("delete attribute")
element.Attributes.DeleteAt(idx, false)
End If

Next

catch e as exception
Console.WriteLine(element.Attributes.GetLastError())
Console.WriteLine(e)
End try
End Sub

11.2.2.10.12 Work With Methods

public Object
''An example of working with the Methods collection
''of an element - and with Method collections.

Sub MethodLifeCycle

Dim element as object

Dim method as object
Dim t as object
Dim idx as Integer
Dim idx2 as integer

try
element = m_Repository.GetElementByID(129)

For idx = 0 to element.Methods.Count -1

method = element.Methods.GetAt(idx)
Console.WriteLine(method.Name)

t = method.PreConditions.AddNew("TestConstraint","something")
If t.Update = false Then
Console.WriteLine("PreConditions: " + t.GetLastError)
End if

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Object Model 1775

method.PreConditions.Refresh
For idx2 = 0 to method.PreConditions.Count-1
t = method.PreConditions.GetAt(idx2)
Console.WriteLine("PreConditions: " + t.Name)
If t.Name = "TestConstraint" Then
method.PreConditions.DeleteAt(idx2,false)
End If
Next

t = method.PostConditions.AddNew("TestConstraint","something")
If t.Update = false Then
COnsole.WriteLine("PostConditions: " + t.GetLastError)
End if

method.PostConditions.Refresh
For idx2 = 0 to method.PostConditions.Count-1
t = method.PostConditions.GetAt(idx2)
Console.WriteLine("PostConditions: " + t.Name)
If t.Name = "TestConstraint" Then
method.PostConditions.DeleteAt(idx2, false)
End If
Next

t = method.TaggedValues.AddNew("TestTaggedValue","something")
If t.Update = false Then
COnsole.WriteLine("Tagged Values: " + t.GetLastError)
End if

For idx2 = 0 to method.TaggedValues.Count-1

t = method.TaggedValues.GetAt(idx2)
Console.WriteLine("Tagged Value: " + t.Name)
If(t.Name= "TestTaggedValue") Then
method.TaggedValues.DeleteAt(idx2,false)
End If
Next

t = method.Parameters.AddNew("TestParam","string")
If t.Update = false Then
Console.WriteLine("Parameters: " + t.GetLastError)
End if

method.Parameters.Refresh
For idx2 = 0 to method.Parameters.Count-1
t = method.Parameters.GetAt(idx2)
Console.WriteLine("Parameter: " + t.Name)
If(t.Name="TestParam") Then
method.Parameters.DeleteAt(idx2, false)
End If
Next

method = nothing
Next
catch e as exception
Console.WriteLine(element.Methods.GetLastError())
Console.WriteLine(e)
End try

End Sub

© 1998-2010 Sparx Systems Pty Ltd

 1776 Automation and Scripts | Enterprise Architect Add-In Model

11.3 Enterprise Architect Add-In Model

Introduction
Add-Ins enable you to add functionality to Enterprise Architect. The Enterprise Architect Add-In model builds
on the features provided by the Automation Interface 1666 to enable you to extend the Enterprise Architect user
interface.
Add-Ins are ActiveX COM objects that expose public Dispatch methods. They have several advantages over
stand-alone automation clients:
· Add-Ins can define Enterprise Architect menus and sub-menus
· Add-Ins receive notifications about various Enterprise Architect user-interface events including menu clicks
and file changes
· Add-Ins can (and should) be written as in-process (DLL) components. This provides lower call overhead
and better integration into the Enterprise Architect environment
· Because a current version of Enterprise Architect is already running there is no requirement to start a
second copy of Enterprise Architect via the automation interface
· Because the Add-In receives object handles associated with the currently running copy of Enterprise
Architect, more information is available about the current user's activity; for example, which diagram
objects are selected
· You are not required to do anything other than to install the Add-In to make it usable; that is, you do not
have to configure Add-Ins to run on your systems.
Because Enterprise Architect is constantly evolving in response to customer requests, the Add-In interface is
flexible:
· The Add-In interface does not have its own version, rather it is identified by the version of Enterprise
Architect it first appeared in; for example, the current version of the Enterprise Architect Add-In interface is
version 2.1.
· When creating your Add-In, you do not have to subscribe to a type-library.
Note:
From Enterprise Architect release 7.0 Add-Ins created before 2004 are no longer supported. If an Add-In
subscribes to the Addn_Tmpl.tlb interface (2003 style), it will fail on load. In this event, contact the vendor
or author of the Add-In and request an upgrade.

· Add-Ins do not have to implement methods that they never use.

· Add-Ins prompt users via context menus in the tree view and the diagram.
· Menu check and disable states can be controlled by the Add-In.
Add-Ins enhance the existing functionality of Enterprise Architect through a variety of mechanisms such as
Scripts 1660 , UML Profiles 1093 and the Automation Interface 1666 . Once an Add-In is registered 1876 , it can be
managed using the Add-In Manager 1781 .

Create and Use Add-Ins

This topic covers the following information on Add-Ins:
· Add-In Tasks 1777
· Add-In Events 1782
· Broadcast Events 1787
· Custom Views 1820
· MDG Add-Ins 1821

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1777

11.3.1 Add-In Tasks

This topic provides instructions on how to create, test, deploy and manage Add-Ins.
1. Create an Add-In 1777
· Define Menu Items 1777
· Respond to Menu Events 1785

· Handle Add-In Events 1782

2. Deploy your Add-In 1778

· Potential Pitfalls 1779

3. Manage Add-Ins
· Register an Add-In 1876 (developed in-house or brought-in)
· The Add-In Manager 1781

11.3.1.1 Create Add-Ins

Before you start you must have an application development tool that is capable of creating ActiveX COM
objects supporting the IDispatch interface, such as:
· Borland Delphi
· Microsoft Visual Basic
· Microsoft Visual Studio .Net.
You should consider how to define menu items 1777 . To help with this, you could review some examples of
Automation Interfaces (this web page provides examples of code used to create Add-Ins for Enterprise
Architect).

Create an Add-In
An Enterprise Architect Add-In can be created in four steps:
1. Use a development tool to create an ActiveX COM DLL project. Visual Basic users, for example,
choose File-Create New Project-ActiveX DLL.
2. Connect to the interface using the syntax appropriate to the language as detailed in the Connect to the
Interface 1666 topic.
3. Create a COM Class and implement each of the general Add-In Events 1782 applicable to your Add-In.
You only have to define methods for events to respond to.
4. Add a registry key that identifies your Add-In to Enterprise Architect, as described in the Deploy Add-Ins
1778 topic.

11.3.1.1.1 Define Menu Items

Menu items are defined by responding to the GetMenuItems event.
The first time this event is called, MenuName is an empty string, representing the top-level menu. For a simple
Add-In with just a single menu option you can return a string; for example:
Function EA_GetMenuItems(Repository as EA.Repository, MenuLocation As String, MenuName As String) As Variant
EA_GetMenuItems = "&Joe's Add-In"
End Function

To define sub-menus, prefix a parent menu with a dash. Parent and sub-items are defined as follows:
Function EA_GetMenuItems(Repository as EA.Repository, MenuLocation As String, MenuName As String) As Variant
Select Case MenuName
Case ""
'Parent Menu Item
EA_GetMenuItems = "-&Joe's Add-In"
Case "-&Joe's Add-In"
'Define Sub-Menu Items using the Array notation.
'In this example, "Diagram" and "Treeview" compose the "Joe's Add-In" sub-menu.
EA_GetMenuItems = Array("&Diagram", "&Treeview")
Case Else
MsgBox "Invalid Menu", vbCritical
End Select
End Function

© 1998-2010 Sparx Systems Pty Ltd

 1778 Automation and Scripts | Enterprise Architect Add-In Model

Similarly, you can define further sub-items:

Function EA_GetMenuItems(Repository as EA.Repository, MenuLocation As String, MenuName As String) As Variant
Select Case MenuName
Case ""
EA_GetMenuItems = "-Joe's Add-In"
Case "-Joe's Add-In"
EA_GetMenuItems = Array("-&Diagram", "&TreeView")
Case "-&Diagram"
EA_GetMenuItems = "&Properties"
Case Else
MsgBox "Invalid Menu", vbCritical
End Select
End Function

To enable or disable menu options by default, you can use this method to show particular items to the user:
Sub EA_GetMenuState(Repository As EA.Repository, Location As String, MenuName As String, ItemName As String,
IsEnabled As Boolean, IsChecked As Boolean)
Select Case Location
Case "TreeView"
'Always enable
Case "Diagram"
'Always enable
Case "MainMenu"
Select Case ItemName
Case "&Translate", "Save &Project"
If GetIsProjectSelected() Then
IsEnabled = False
End If
End Select
End Select
IsChecked = GetIsCurrentSelection()
End Sub

11.3.1.1.2 Deploy Add-Ins

To deploy Add-Ins to users' sites, follow the steps below:
1. Add the Add-In DLL file to an appropriate directory on the user's computer; that is, C:\Program Files\[new
dir].
2. Register the DLL as appropriate to your platform:
· If compiled as a native Win32 DDL, such as VB6 or C++, register the DDL using the regsvr32
command from the command prompt; for example:

regsvr32 "C:\Program Files\MyCompany\EAAddin\EAAddin.dll"

· If compiled as a .NET DLL, such as C# or VB.NET, register the DLL using the RegAsm command
from the command prompt; for example:

C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\RegAsm.exe "C:\Program
Files\MyCompany\EAAddin\EAAddin.dll" /codebase

3. Place a new entry into the registry using the registry editor (run regedit) so that Enterprise Architect
recognizes the presence of your Add-In.
4. Add a new key value EAAddIns under the location: HKEY_CURRENT_USER\Software\Sparx Systems

5. Add a new key under this key with the project name.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1779

Note:
[ProjectName] is not necessarily the name of your DLL, but the name of the Project. In Visual Basic,
this is the value for the property Name corresponding to the project file.

6. Specify the default value by modifying the default value of the key.

7. Enter the value of the key by typing in the [project name].[class name]; for example, EaRequirements.
Requirements, where EaRequirements is the project name, as shown in the example below.

11.3.1.1.3 Tricks and Traps

Visual Basic 5/6 Users Note

Visual Basic 5/6 users should note that the version number of the Enterprise Architect interface is stored in the
VBP project file in a form similar to the following:
Reference=*\G{64FB2BF4-9EFA-11D2-8307-C45586000000}#2.2#0#..\..\..\..\Program Files\Sparx Systems\EA\EA.
TLB#Enterprise Architect Object Model 2.02
If you experience problems moving from one version of Enterprise Architect to another, open the VBP file in a
text editor and remove this line. Then open the project in Visual Basic and use Project-References to create a
new reference to the Enterprise Architect Object model.

Add-In Fails to Load

From Enterprise Architect release 7.0, Add-Ins created before 2004 are no longer supported. If an Add-In
subscribes to the Addn_Tmpl.tlb interface (2003 style), it will fail on load. In this event, contact the vendor or
author of the Add-In and request an upgrade.

© 1998-2010 Sparx Systems Pty Ltd

 1780 Automation and Scripts | Enterprise Architect Add-In Model

Holding State Information

It is possible for an Add-In to hold state information, meaning that data can be stored in member variables in
response to one event and retrieved in another. There are some dangers in doing this:
· Enterprise Architect Automation Objects do not update themselves in response to user activity, to activity
on other workstations, or even to the actions of other objects in the same automation client. Retaining
handles to such objects between calls can result in the second event querying objects that have no
relationship with the current state of Enterprise Architect.
· When you close Enterprise Architect, all Add-Ins are asked to shut down. If there are any external
automation clients Enterprise Architect must stay active, in which case all the Add-Ins are reloaded, losing
all the data.
· Enterprise Architect acting as an automation client does not close if an Add-In still holds a reference to it
(releasing all references in the Disconnect() event avoids this problem).
It is recommended that unless there is a specific reason for doing so, the Add-In should use the repository
parameter and its method and properties to provide the necessary data.

Enterprise Architect Not Closing

.Net Specific Issues
Automation checks the use of objects and won't enable any of them to be destroyed until they are no longer
being used.
As noted in the Automation Interface 1669 topic, if your automation controller was written using the .NET
framework, Enterprise Architect does not close even after you release all your references to it. To force the
release of the COM pointers, call the memory management functions as shown below:
GC.Collect();
GC.WaitForPendingFinalizers();
Additionally, because automation clients hook into Enterprise Architect, which creates Add-Ins which in turn
hook back into Enterprise Architect, it is possible to get into a deadlock situation where Enterprise Architect
and the Add-Ins won't let go of one another and keep each other active. An Add-In might retain hooks into
Enterprise Architect because:
· It keeps a private reference to an Enterprise Architect object (see Holding State Information 1780 above), or
· It has been created by .NET and the GC mechanism hasn't got around to releasing it.
There are two actions required to avoid deadlock situations:
· Automation controllers must call Repository.CloseAddins() at some point (presumably at the end of
processing).
· Add-Ins must release all references to Enterprise Architect in the Disconnect() event. See the Add-In Events
1782 topic for details.

It is possible that your Automation client controls a running instance of Enterprise Architect where the Add-Ins
have not complied with the rule above. In this case you could call Repository.Exit() to terminate Enterprise
Architect.

Miscellaneous
In developing Add-Ins using the .Net framework you must select COM Interoperability in the project's
properties in order for it to be recognized as an Add-In.
Some development environments do not automatically register COM DLLs on creation. You might have to do
that manually before Enterprise Architect recognizes the Add-In.
You can use your private Add-In key (as required for Add-In deployment) to store configuration information
pertinent to your Add-In.

Concurrent Calls
In Enterprise Architect releases up to release 7.0, there is a possibility that Enterprise Architect could call two
Add-In methods concurrently if the Add-In calls:
· A message box
· A modal dialog
· VB DoEvents, .NET Application DoEvents or the equivalent in other languages.
In such cases, Enterprise Architect could initiate a second Add-In method before the first returns (re-entrancy).

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1781

In release 7.0. and subsequent releases, Enterprise Architect cannot make such concurrent calls.
If developing Add-Ins, ensure that the Add-In users are running Enterprise Architect release 7.0 or a later
release to avoid any risk of concurrent method calls.

11.3.2 The Add-In Manager

You can use the Add-In Manager to view what Add-Ins are available and to disable those not to be used.
Access the Manage Add-Ins dialog by selecting the Add-Ins | Manage Add-Ins menu option.

To enable an Add-In for use, select the Load on Startup check box. To disable an Add-In, deselect the
checkbox.

Note:
Enterprise Architect must be restarted for changes to take effect.

11.3.3 Add-In Search

Enterprise Architect enables Add-Ins to integrate with the Model Search 1231 . Searches can be defined that
execute a method within your Add-In and display your results in an integrated way.
The method that runs the search must be structured in the following way:
variant <method name> (Rep as Repository, SearchText as String, XMLResults as String)

Parameter Description

Rep The currently open repository.

SearchText An optional field that you can fill in through the Model Search.
XMLResults At completion of the method, this should contain the results for the search. The results
should be an XML String that conforms to the Search Data Format 1782 .

Return
The method must return a value for the results to be displayed.

Advanced Usage
In addition to the displayed results, two additional hidden fields can be passed into the XML that provide
special functionality.

CLASSTYPE
Returning a field of CLASSTYPE, containing the Object_Type value from the t_object table, displays the
appropriate icon in the column you place the field.

CLASSGUID
Returning a field of CLASSGUID, containing an ea_guid value, enables the Model Search to track the object in

© 1998-2010 Sparx Systems Pty Ltd

 1782 Automation and Scripts | Enterprise Architect Add-In Model

the Project Browser and open the Properties window for the element by double-clicking in the Model Search.

11.3.3.1 XML Format (Search Data)

The XML below provides the format for the sSearchData parameter of the RunModelSearch method. See the
Repository 1692 topic for more information.

<ReportViewData UID=\"MySearchID\" >

<!--
//The UID attribute enables XML type searches to persist column information. That is, if you run the search, group by
column or adjust column widths, then close the window and run the search again, the format/organization changes are
retained.To avoid persisting column arrangements, leave the attribute value blank or remove it altogether.
// Use this section to declare all possible fields - columns that appear in Enterprise Architect's search window - that
are used below in <Rows/>.
// The order of the columns of information to be appended here must match the order that the search run in
Enterprise Architect would normally display.
// Furthermore, if you append results onto a custom SQL Search, then the order used in your Custom SQL must
match the order used below.
-->

<Fields>
<Field name=""/>
<Field name=""/>
<Field name=""/>
<Field name=""/>
</Fields>

<Rows>
<Row>
<Field name="" value=""/>
<Field name="" value=""/>
<Field name="" value=""/>
<Field name="" value=""/>
</Row>
<Row>
<Field name="" value=""/>
<Field name="" value=""/>
<Field name="" value=""/>
<Field name="" value=""/>
</Row>
<Row>
<Field name="" value=""/>
<Field name="" value=""/>
<Field name="" value=""/>
<Field name="" value=""/>
</Row>
</Rows>
</ReportViewData>

11.3.4 Add-In Events

All Enterprise Architect Add-Ins can choose to respond to the following general Add-In events:
· EA_Connect 1782
· EA_Disconnect 1783
· EA_GetMenuItems 1783
· EA_MenuClick 1785
· EA_GetMenuState 1784
· EA_ShowHelp 1787
· EA_OnOutputItemClicked 1785
· EA_OnOutputItemDoubleClicked 1786

11.3.4.1 EA_Connect

Details
EA_Connect events enable Add-Ins to identify their type and to respond to Enterprise Architect start up.
This event occurs when Enterprise Architect first loads your Add-In. Enterprise Architect itself is loading at this
time so that while a Repository object is supplied, there is limited information that you can extract from it.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1783

The chief uses for EA_Connect are in initializing global Add-In data and for identifying the Add-In as an MDG
Add-In 1821 .
Also look at EA_Disconnect 1783 .

Syntax
Function EA_Connect(Repository As EA.Repository) As String
The EA_Connect function syntax has the following elements:

Parameter Type Direction Description

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve
model data and user interface status information.

Return Value
String identifying a specialized type of Add-In:

Type Details

"MDG" MDG Add-Ins receive MDG Events 1822 and extra menu options.

"" None-specialized Add-In.

11.3.4.2 EA_Disconnect

Details
The EA_Disconnect event enables the Add-In to respond to user requests to disconnect the model branch
from an external project.
This function is called when the Enterprise Architect closes. If you have stored references to Enterprise
Architect objects (not particularly recommended anyway), you must release them here.
In addition, .NET users must call memory management functions as shown below:
GC.Collect();
GC.WaitForPendingFinalizers();
Also look at EA_Connect 1782 .

Syntax
Sub EA_Disconnect()

Return Value
None.

11.3.4.3 EA_GetMenuItems

Details
The EA_GetMenuItems event enables the Add-In to provide the Enterprise Architect user interface with
additional Add-In menu options in various context and main menus. When a user selects an Add-In menu
option, an event is raised and passed back to the Add-In that originally defined that menu option.
This event is raised just before Enterprise Architect has to show particular menu options to the user, and its
use is described in the Define Menu Items 1777 topic.
Also look at:
· EA_MenuClick 1785
· EA_GetMenuState 1784 .

© 1998-2010 Sparx Systems Pty Ltd

 1784 Automation and Scripts | Enterprise Architect Add-In Model

Syntax
Function EA_GetMenuItems(Repository As EA.Repository, MenuLocation As String, MenuName As
String) As Variant
The EA_GetMenuItems function syntax has the following elements:

Parameter Type Direction Description

MenuLocatio String String representing the part of the user interface that brought up
n the menu. Can be TreeView, MainMenu or Diagram.

MenuName String The name of the parent menu for which sub-items are to be
defined. In the case of the top-level menu it is an empty string.

Repository EA. IN An EA.Repository object representing the currently open

Repository Enterprise Architect model. Poll its members to retrieve model
1680 data and user interface status information.

Return Value
One of the following types:
· A string indicating the label for a single menu option.
· An array of strings indicating a multiple menu options.
· Empty (Visual Basic/VB.NET) or null (C#) to indicate that no menu should be displayed.
In the case of the top-level menu it should be a single string or an array containing only one item, or Empty/
null.

11.3.4.4 EA_GetMenuState

Details
The EA_GetMenuState event enables the Add-In to set a particular menu option to either enabled or disabled.
This is useful when dealing with locked packages and other situations where it is convenient to show a menu
option, but not enable it for use.
This event is raised just before Enterprise Architect has to show particular menu options to the user. Its use is
described in the Define Menu Items 1777 topic.
Also look at EA_GetMenuItems 1783 .

Syntax
Sub EA_GetMenuState(Repository as EA.Repository, MenuLocation As String, MenuName as String,
ItemName as String, IsEnabled as Boolean, IsChecked as Boolean)
The EA_GetMenuState function syntax has the following elements:

Parameter Type Directio Description

n

IsChecked Boolean Boolean. Set to True to check this particular menu option.

IsEnabled Boolean Boolean. Set to False to disable this particular menu option.

ItemName String The name of the option actually clicked, for example, Create a
New Invoice.

MenuLocation String String representing the part of the user interface that brought
up the menu. Can be TreeView, MainMenu or Diagram.

MenuName String The name of the parent menu for which sub-items must be
defined. In the case of the top-level menu it is an empty string.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1785

Parameter Type Directio Description

n

Repository EA. IN An EA.Repository object representing the currently open

Repository Enterprise Architect model. Poll its members to retrieve model
1680 data and user interface status information.

Return Value
None.

11.3.4.5 EA_MenuClick

Details
EA_MenuClick events are received by an Add-In in response to user selection of a menu option.
The event is raised when the user clicks on a particular menu option. When a user clicks on one of your non-
parent menu options, your Add-In receives a MenuClick event, defined as follows:
Sub EA_MenuClick(Repository As EA.Repository, ByVal MenuName As String, ByVal ItemName As
String)
The code below illustrates an example of use:
If MenuName = "-&Diagram" And ItemName = "&Properties" then
MsgBox Repository.GetCurrentDiagram.Name, vbInformation
Else
MsgBox "Not Implemented", vbCritical
End If
Notice that your code can directly access Enterprise Architect data and UI elements using Repository 1680

methods.
Also look at EA_GetMenuItems 1783 .

Syntax
Sub EA_MenuClick(Repository As EA.Repository, MenuLocation As String, MenuName As String,
ItemName As String)
The EA_GetMenuClick function syntax has the following elements:

Parameter Type Direction Description

ItemName String The name of the option actually clicked, for example, Create a
New Invoice.

MenuName String The name of the parent menu for which sub-items are to be
defined. In the case of the top-level menu it is an empty string.

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
None.

11.3.4.6 EA_OnOutputItemClicked

Details
EA_OnOutputItemClicked events inform Add-Ins that the user has clicked on a list entry in the system tab or
one of the user defined output tabs.
Usually an Add-In responds to this event in order to capture activity on an output tab they had previously
created through a call to Repository.AddTab().

© 1998-2010 Sparx Systems Pty Ltd

 1786 Automation and Scripts | Enterprise Architect Add-In Model

Note that every loaded Add-In receives this event for every click on an output tab in Enterprise Architect -
irrespective of whether the Add-In created that tab. Add-Ins should therefore check the TabName parameter
supplied by this event to ensure that they are not responding to other Add-Ins' events.
Also look at EA_OnOutputItemDoubleClicked 1786 .

Syntax
EA_OnOutputItemClicked(Repository As EA.Repository, TabName As String, LineText As String, ID As
Long)
The EA_OnOutputItemClicked function syntax has the following elements:

Parameter Type Direction Description

ID Long IN The ID value specified in the original call to Repository.WriteOutput

().

LineText String IN The text that had been supplied as the String parameter in the
original call to Repository.WriteOutput().

Repository EA. IN An EA.Repository object representing the currently open Enterprise

Repository Architect model. Poll its members to retrieve model data and user
1680 interface status information.

TabName String IN The name of the tab that the click occurred in. Usually this would
have been created through Repository.AddTab().

Return Value
None.

11.3.4.7 EA_OnOutputItemDoubleClicked

Details
EA_OnOutputItemDoubleClicked events informs Add-Ins that the user has used the mouse to double-click on
a list entry in one of the user-defined output tabs.
Usually an Add-In responds to this event in order to capture activity on an output tab they had previously
created through a call to Repository.AddTab().
Note that every loaded Add-In receives this event for every double-click on an output tab in Enterprise
Architect - irrespective of whether the Add-In created that tab. Add-Ins should therefore check the TabName
parameter supplied by this event to ensure that they are not responding to other Add-Ins' events.
Also look at EA_OnOutputItemClicked 1785 .

Syntax
EA_OnOutputItemDoubleClicked(Repository As EA.Repository, TabName As String, LineText As
String, ID As Long)
The EA_OnOutputItemClicked function syntax contains the following elements:

Parameter Type Direction Description

ID Long IN The ID value specified in the original call to Repository.WriteOutput()

.

LineText String IN The text that had been supplied as the String parameter in the
original call to Repository.WriteOutput().

Repository EA. IN An EA.Repository object representing the currently open Enterprise

Repository Architect model. Poll its members to retrieve model data and user
1680 interface status information.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1787

Parameter Type Direction Description

TabName String IN The name of the tab that the click occurred in. Usually this would
have been created through Repository.AddTab().

Return Value
None.

11.3.4.8 EA_ShowHelp

Details
The EA_ShowHelp event enables the Add-In to show a help topic for a particular menu option. When the user
has an Add-In menu option selected, pressing [F1] can be delegated to the required Help topic by the Add-In
and a suitable help message shown.
This event is raised when the user presses [F1] on a menu option that is not a parent menu.
Also look at EA_GetMenuItems 1783 .

Syntax
Sub EA_ShowHelp(Repository as EA.Repository, MenuLocation As String, MenuName as String,
ItemName as String)
The EA_ShowHelp function syntax contains the following elements:

Parameter Type Direction Description

ItemName String The name of the option actually clicked, for example, Create a
New Invoice.

MenuLocatio String String representing the part of the user interface that brought up
n the menu. Can be Treeview, MainMenu or Diagram.

MenuName String The name of the parent menu for which sub-items are to be
defined. In the case of the top-level menu it is an empty string.

Repository EA. IN An EA.Repository object representing the currently open

Repository Enterprise Architect model. Poll its members to retrieve model
1680 data and user interface status information.

Return Value
None.

11.3.5 Broadcast Events

Overview
The following general Broadcast events are sent to all loaded Add-Ins. For an Add-In to receive the event, they
must first implement the required automation event interface. If Enterprise Architect detects that the Add-In
has the required interface, the event is dispatched to the Add-In.
· File Open Event 1788
· File Close Event 1788
· File New Event 1789
· Post Open Diagram Event 1789
· Post Close Diagram Event 1789
· Pre-Deletion Events 1790
· Pre-New Events 1793
· Post-New Events 1798

© 1998-2010 Sparx Systems Pty Ltd

 1788 Automation and Scripts | Enterprise Architect Add-In Model

· Technology Events 1803

· Context Item Events 1807
· Transformation Events 1803
· Compartment Events 1809
· Model Validation Broadcasts 1811
· Retrieve Model Template Event 1820
· Initialize Technology Event 1803
· PreExit Instance 1798 (not currently used).

MDG Events 1822 add quite a number of additional events, but the Add-In must first have registered as an
MDG-style Add-In, rather than as a generic Add-In.

11.3.5.1 EA_FileOpen

Details
The EA_FileOpen event enables the Add-In to respond to a File Open event. When Enterprise Architect opens
a new model file, this event is raised and passed to all Add-Ins implementing this method.
The event occurs when the model being viewed by the Enterprise Architect user changes, for whatever reason
(through user interaction or Add-In activity).
Also look at EA_FileClose 1788 and EA_FileNew 1789 .

Syntax
Sub EA_FileOpen(Repository As EA.Repository)
The EA_FileOpen function syntax contains the following elements:

Parameter Type Direction Description

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
None.

11.3.5.2 EA_FileClose

Details
The EA_FileClose event enables the Add-In to respond to a File Close event. When Enterprise Architect
closes an opened Model file, this event is raised and passed to all Add-Ins implementing this method.
This event occurs when the model currently opened within Enterprise Architect is about to be closed (when
another model is about to be opened or when Enterprise Architect is about to shutdown).
Also look at EA_FileOpen 1788 and EA_FileNew 1789 .

Syntax
Sub EA_FileClose(Repository As EA.Repository)
The EA_FileClose function syntax contains the following elements:

Parameter Type Direction Description

Repository EA. IN An EA.Repository object representing the Enterprise Architect

Repository model about to be closed. Poll its members to retrieve model data
1680 and user interface status information.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1789

Return Value
None.

11.3.5.3 EA_FileNew

Details
The EA_FileNew event enables the Add-In to respond to a File New event. When Enterprise Architect creates
a new model file, this event is raised and passed to all Add-Ins implementing this method.
The event occurs when the model being viewed by the Enterprise Architect user changes, for whatever reason
(through user interaction or Add-In activity).
Also look at EA_FileClose 1788 and EA_FileOpen 1788 .

Syntax
Sub EA_FileNew(Repository As EA.Repository)
The EA_FileNew function syntax contains the following elements:

Parameter Type Direction Description

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
None.

11.3.5.4 EA_OnPostCloseDiagram

Details
EA_OnPostCloseDiagram notifies Add-Ins that a diagram has been closed.
Also look at EA_OnPostOpenDiagram 1789 .

Syntax
Function EA_OnPostCloseDiagram(Repository As EA.Repository, DiagramID As Integer)
The EA_OnPostCloseDiagram function syntax contains the following elements:

Parameter Type Direction Description

DiagramID Integer IN Contains the Diagram ID of the diagram that was closed.

Repository EA. IN An EA.Repository object representing the Enterprise Architect

Repository model about to be closed. Poll its members to retrieve model data
1680 and user interface status information.

Return Value
None.

11.3.5.5 EA_OnPostOpenDiagram

Details
EA_OnPostOpenDiagram notifies Add-Ins that a diagram has been opened.
Also look at EA_OnPostCloseDiagram 1789 .

© 1998-2010 Sparx Systems Pty Ltd

 1790 Automation and Scripts | Enterprise Architect Add-In Model

Syntax
Function EA_OnPostOpenDiagram(Repository As EA.Repository, DiagramID As Integer)
The EA_OnPostOpenDiagram function syntax contains the following elements:

Parameter Type Direction Description

DiagramID Integer IN Contains the Diagram ID of the diagram that was opened.

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
None.

11.3.5.6 Pre-Deletion Events

Enterprise Architect Add-Ins can respond to requests to delete elements, attributes, methods, connectors,
diagrams, packages and technologies using the following broadcast events:
· EA_OnPreDeleteElement 1790
· EA_OnPreDeleteAttribute 1791
· EA_OnPreDeleteMethod 1791
· EA_OnPreDeleteConnector 1792
· EA_OnPreDeleteDiagram 1792
· EA_OnPreDeletePackage 1793
· EA_OnPreDeleteTechnology 1805 (Deprecated).

11.3.5.6.1 EA_OnPreDeleteElement

Details
EA_OnPreDeleteElement notifies Add-Ins that an element is to be deleted from the model. It enables Add-Ins
to permit or deny deletion of the element.
This event occurs when a user deletes an element from the Project Browser or on a diagram. The notification
is provided immediately before the element is deleted, so that the Add-In can disable deletion of the element.

Syntax
Function EA_OnPreDeleteElement(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPreDeleteElement function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty Objects for the element
EventProperties to be deleted:
1697
· ElementID: A long value corresponding to Element.
ElementID.
Repository EA.Repository 1680 IN An EA.Repository object representing the currently open
Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
Return True to enable deletion of the element from the model. Return False to disable deletion of the element.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1791

11.3.5.6.2 EA_OnPreDeleteAttribute

Details
EA_OnPreDeleteAttribute notifies Add-Ins that an attribute is to be deleted from the model. It enables Add-Ins
to permit or deny deletion of the attribute.
This event occurs when a user attempts to permanently delete an attribute from the Project Browser. The
notification is provided immediately before the attribute is deleted, so that the Add-In can disable deletion of
the attribute.

Syntax
Function EA_OnPreDeleteAttribute(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPreDeleteAttribute function syntax contains the following elements:

Parameter Type Directio Description

n

Info EA. IN Contains the following EventProperty Objects for the attribute to
EventProperties be deleted:
1697
· AttributeID: A long value corresponding to Attribute.
AttributeID.
Repositor EA.Repository 1680 IN An EA.Repository object representing the currently open
y Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
Return True to enable deletion of the attribute from the model. Return False to disable deletion of the
attribute.

11.3.5.6.3 EA_OnPreDeleteMethod

Details
EA_OnPreDeleteMethod notifies Add-Ins that a method (operation) is to be deleted from the model. It enables
Add-Ins to permit or deny deletion of the method.
This event occurs when a user attempts to permanently delete a method from the Project Browser. The
notification is provided immediately before the method is deleted, so that the Add-In can disable deletion of the
method.

Syntax
Function EA_OnPreDeleteMethod(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPreDeleteMethod function syntax contains the following elements:

Parameter Type Directio Description

n

Info EA. IN Contains the following EventProperty Objects for the method to
EventProperties be deleted:
1697
· MethodID: A long value corresponding to Method.
MethodID.
Repositor EA.Repository 1680 IN An EA.Repository object representing the currently open
y Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

© 1998-2010 Sparx Systems Pty Ltd

 1792 Automation and Scripts | Enterprise Architect Add-In Model

Return Value
Return True to enable deletion of the method from the model. Return False to disable deletion of the method.

11.3.5.6.4 EA_OnPreDeleteConnector

Details
EA_OnPreDeleteConnector notifies Add-Ins that a connector is to be deleted from the model. It enables Add-
Ins to permit or deny deletion of the connector.
This event occurs when a user attempts to permanently delete a connector on a diagram. The notification is
provided immediately before the connector is deleted, so that the Add-In can disable deletion of the connector.

Syntax
Function EA_OnPreDeleteConnector(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPreDeleteConnector function syntax contains the following elements:

Parameter Type Directio Description

n

Info EA. IN Contains the following EventProperty Objects for the connector
EventProperties to be deleted:
1697
· ConnectorID: A long value corresponding to Connector.
ConnectorID.
Repositor EA.Repository 1680 IN An EA.Repository object representing the currently open
y Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
Return True to enable deletion of the connector from the model. Return False to disable deletion of the
connector.

11.3.5.6.5 EA_OnPreDeleteDiagram

Details
EA_OnPreDeleteDiagram notifies Add-Ins that a diagram is to be deleted from the model. It enables Add-Ins
to permit or deny deletion of the diagram.
This event occurs when a user attempts to permanently delete a diagram from the Project Browser. The
notification is provided immediately before the diagram is deleted, so that the Add-In can disable deletion of
the diagram.

Syntax
Function EA_OnPreDeleteDiagram(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPreDeleteDiagram function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty Objects for the connector
EventProperties to be deleted:
1697
· DiagramID: A long value corresponding to Diagram.
DiagramID
Repositor EA.Repository IN An EA.Repository object representing the currently-open
1680 Enterprise Architect model. Poll its members to retrieve model

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1793

Parameter Type Direction Description

y data and user interface status information.

Return Value
Return True to enable deletion of the diagram from the model. Return False to disable deletion of the
diagram.

11.3.5.6.6 EA_OnPreDeletePackage

Details
EA_OnPreDeletePackage notifies Add-Ins that a package is to be deleted from the model. It enables Add-Ins
to permit or deny deletion of the package.
This event occurs when a user attempts to permanently delete a package from the Project Browser. The
notification is provided immediately before the package is deleted, so that the Add-In can disable deletion of
the package.

Syntax
Function EA_OnPreDeletePackage(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPreDeletePackage function syntax contains the following elements:

Parameter Type Directio Description

n

Info EA. IN Contains the following EventProperty Objects for the connector to
EventProperties be deleted:
1697
· PackageID: A long value corresponding to Package.
PackageID.
Repositor EA.Repository IN An EA.Repository object representing the currently open
y 1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
Return True to enable deletion of the package from the model. Return False to disable deletion of the
package.

11.3.5.7 Pre-New Events

Enterprise Architect Add-Ins can respond to requests to create new elements, connectors, objects, attributes,
methods and packages using the following broadcast events:
· EA_OnPreNewElement 1793
· EA_OnPreNewConnector 1794
· EA_OnPreNewDiagram 1795
· EA_OnPreNewDiagramObject 1795

· EA_OnPreNewAttribute 1796
· EA_OnPreNewMethod 1797
· EA_OnPreNewPackage 1797 .

11.3.5.7.1 EA_OnPreNewElement

Details
EA_OnPreNewElement notifies Add-Ins that a new element is about to be created on a diagram. It enables
Add-Ins to permit or deny creation of the new element.

© 1998-2010 Sparx Systems Pty Ltd

 1794 Automation and Scripts | Enterprise Architect Add-In Model

This event occurs when a user drags a new element from the Toolbox or Resources window onto a diagram.
The notification is provided immediately before the element is created, so that the Add-In can disable addition
of the element.
Also look at EA_OnPostNewElement 1798 .

Syntax
Function EA_OnPreNewElement(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPreNewElement function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty Objects for the element to
EventProperties be created:
1697
· Type: A string value corresponding to Element.Type
· Stereotype: A string value corresponding to Element.
Stereotype
· ParentID: A long value corresponding to Element.ParentID
· DiagramID: A long value corresponding to the ID of the
diagram to which the element is being added.
Repository EA.Repository 1680 IN An EA.Repository object representing the currently open
Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
Return True to enable addition of the new element to the model. Return False to disable addition of the new
element.

11.3.5.7.2 EA_OnPreNewConnector

Details
EA_OnPreNewConnector notifies Add-Ins that a new connector is about to be created on a diagram. It
enables Add-Ins to permit or deny creation of a new connector.
This event occurs when a user drags a new connector from the Toolbox or Resources window, onto a
diagram. The notification is provided immediately before the connector is created, so that the Add-In can
disable addition of the connector.
Also look at EA_OnPostNewConnector 1799 .

Syntax
Function EA_OnPreNewConnector(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPreNewConnector function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty Objects for the connector
EventProperties to be created:
1697
· Type: A string value corresponding to Connector.Type
· Subtype: A string value corresponding to Connector.
Subtype
· Stereotype: A string value corresponding to Connector.
Stereotype
· ClientID: A long value corresponding to Connector.
ClientID

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1795

Parameter Type Direction Description

· SupplierID: A long value corresponding to Connector.

SupplierID
· DiagramID: A long value corresponding to Connector.
DiagramID.
Repository EA.Repository IN An EA.Repository object representing the currently open
1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
Return True to enable addition of the new connector to the model. Return False to disable addition of the new
connector.

11.3.5.7.3 EA_OnPreNewDiagram

Details
EA_OnPreNewDiagram notifies Add-Ins that a new diagram is about to be created. It enables Add-Ins to
permit or deny creation of the new diagram.
The notification is provided immediately before the diagram is created, so that the Add-In can disable addition
of the diagram.
Also look at EA_OnPostNewDiagram 1800 .

Syntax
Function EA_OnPreNewDiagram(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPreNewDiagram function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty Objects for the diagram
EventProperties to be created:
1697
· Type: A string value corresponding to Diagram.Type
· ParentID: A long value corresponding to Diagram.ParentID
· PackageID: A long value corresponding to Diagram.
PackageID.
Repository EA.Repository 1680 IN An EA.Repository object representing the currently open
Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
Return True to enable addition of the new diagram to the model. Return False to disable addition of the new
diagram.

11.3.5.7.4 EA_OnPreNewDiagramObject

Details
EA_OnPreNewDiagramObject notifies Add-Ins that a new diagram object is about to be dropped on a
diagram. It enables Add-Ins to permit or deny creation of the new object.
This event occurs when a user drags an object from the Enterprise Architect Project Browser or Resources
window onto a diagram. The notification is provided immediately before the object is created, so that the Add-
In can disable addition of the object.
Also look at EA_OnPostNewDiagramObject 1800 .

© 1998-2010 Sparx Systems Pty Ltd

 1796 Automation and Scripts | Enterprise Architect Add-In Model

Syntax
Function EA_OnPreNewDiagramObject(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPreNewDiagramObject function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty Objects for the object to
EventProperties be created:
1697
· Type: A string value corresponding to Object.Type
· Stereotype: A string value corresponding to Object.
Stereotype
· ParentID: A long value corresponding to Object.ParentID
· DiagramID: A long value corresponding to the ID of the
diagram to which the object is being added.
Repository EA.Repository 1680 IN An EA.Repository object representing the currently open
Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
Return True to enable addition of the object to the model. Return False to disable addition of the object.

11.3.5.7.5 EA_OnPreNewAttribute

Details
EA_OnPreNewAttribute notifies Add-Ins that a new attribute is about to be created on an element. It enables
Add-Ins to permit or deny creation of the new attribute.
This event occurs when a user creates a new attribute on an element by either drag-dropping from the Project
Browser, using the Attributes Properties dialog, or using the in-place editor on the diagram. The notification is
provided immediately before the attribute is created, so that the Add-In can disable addition of the attribute.
Also look at EA_OnPostNewAttribute 1801 .

Syntax
Function EA_OnPreNewAttribute(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPreNewAttribute function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty Objects for the attribute
EventProperties to be created:
1697
· Type: A string value corresponding to Attribute.Type
· Stereotype: A string value corresponding to Attribute.
Stereotype
· ParentID: A long value corresponding to Attribute.
ParentID
· ClassifierID: A long value corresponding to Attribute.
ClassifierID.
Repository EA.Repository IN An EA.Repository object representing the currently open
1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1797

Return Value
Return True to enable addition of the new attribute to the model. Return False to disable addition of the new
attribute.

11.3.5.7.6 EA_OnPreNewMethod

Details
EA_OnPreNewMethod notifies Add-Ins that a new method is about to be created on an element. It enables
Add-Ins to permit or deny creation of the new method.
This event occurs when a user creates a new method on an element by either drag-dropping from the Project
Browser, using the method Properties dialog, or using the in-place editor on the diagram. The notification is
provided immediately before the method is created, so that the Add-In can disable addition of the method.
Also look at EA_OnPostNewMethod 1801 .

Syntax
Function EA_OnPreNewMethod(Repository As EA.Repository, Info As EA.EventProperties) As Boolean
The EA_OnPreNewMethod function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty Objects for the method to
EventProperties be created:
1697
· ReturnType: A string value corresponding to Method.
ReturnType
· Stereotype: A string value corresponding to Method.
Stereotype
· ParentID: A long value corresponding to Method.ParentID
· ClassifierID: A long value corresponding to Method.
ClassifierID.
Repository EA.Repository 1680 IN An EA.Repository object representing the currently open
Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
Return True to enable addition of the new method to the model. Return False to disable addition of the new
method.

11.3.5.7.7 EA_OnPreNewPackage

Details
EA_OnPreNewPackage notifies Add-Ins that a new package is about to be created in the model. It enables
Add-Ins to permit or deny creation of the new package.
This event occurs when a user drags a new package from the Toolbox or Resources window onto a diagram,
or by selecting the New Package icon from the Project Browser. The notification is provided immediately
before the package is created, so that the Add-In can disable addition of the package.
Also look at EA_OnPostNewPackage 1802 .

Syntax
Function EA_OnPreNewPackage(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPreNewPackage function syntax contains the following elements:

© 1998-2010 Sparx Systems Pty Ltd

 1798 Automation and Scripts | Enterprise Architect Add-In Model

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty Objects for the package
EventProperties to be created:
1697
· Stereotype: A string value corresponding to Package.
Stereotype
· ParentID: A long value corresponding to Package.
ParentID
· DiagramID: A long value corresponding to the ID of the
diagram to which the package is being added.
Repository EA.Repository IN An EA.Repository object representing the currently open
1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
Return True to enable addition of the new package to the model. Return False to disable addition of the new
package.

11.3.5.8 EA_OnPreExitInstance

Details
EA_OnPreExitInstance is not currently used.

Syntax
Sub EA_OnPreExitInstance(Repository As EA.Repository)
The EA_OnPreExitInstance function syntax contains the following element:

Parameter Type Direction Description

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
None.

11.3.5.9 Post-New Events

Enterprise Architect Add-Ins can respond to the creation of new elements, connectors, objects, attributes,
methods and packages using the following broadcast events:
· EA_OnPostNewElement 1798
· EA_OnPostNewConnector 1799
· EA_OnPostNewDiagram 1800
· EA_OnPostNewDiagramObject 1800

· EA_OnPostNewAttribute 1801
· EA_OnPostNewMethod 1801
· EA_OnPostNewPackage 1802 .

11.3.5.9.1 EA_OnPostNewElement

Details
EA_OnPostNewElement notifies Add-Ins that a new element has been created on a diagram. It enables Add-
Ins to modify the element upon creation.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1799

This event occurs after a user has dragged a new element from the Toolbox or Resources window onto a
diagram. The notification is provided immediately after the element is added to the model. Set Repository.
SuppressEADialogs to true to suppress Enterprise Architect from showing its default dialogs.
Also look at EA_OnPreNewElement 1793 .

Syntax
Function EA_OnPostNewElement(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPostNewElement function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty objects for the new
EventProperties element:
1697
· ElementID: A long value corresponding to Element.
ElementID.
Repository EA.Repository 1680 IN An EA.Repository object representing the currently open
Enterprise Architect model. Poll its members to retrieve
model data and user interface status information.

Return Value
Return True if the element has been updated during this notification. Return False otherwise.

11.3.5.9.2 EA_OnPostNewConnector

Details
EA_OnPostNewConnector notifies Add-Ins that a new connector has been created on a diagram. It enables
Add-Ins to modify the connector upon creation.
This event occurs after a user has dragged a new connector from the Toolbox or Resources window onto a
diagram. The notification is provided immediately after the connector is added to the model. Set Repository.
SuppressEADialogs to true to suppress Enterprise Architect from showing its default dialogs.
Also look at EA_OnPreNewConnector 1794 .

Syntax
Function EA_OnPostNewConnector(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPostNewConnector function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty objects for the new
EventProperties connector:
1697
· ConnectorID: A long value corresponding to Connector.
ConnectorID.
Repository EA.Repository 1680 IN An EA.Repository object representing the currently open
Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
Return True if the connector has been updated during this notification. Return False otherwise.

© 1998-2010 Sparx Systems Pty Ltd

 1800 Automation and Scripts | Enterprise Architect Add-In Model

11.3.5.9.3 EA_OnPostNewDiagram

Details
EA_OnPostNewDiagram notifies Add-Ins that a new diagram has been created. It enables Add-Ins to modify
the diagram upon creation.
Set Repository.SuppressEADialogs to true to suppress Enterprise Architect from showing its default dialogs.
Also look at EA_OnPreNewDiagram 1795 .

Syntax
Function EA_OnPostNewDiagram(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPostNewDiagram function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty objects for the new
EventProperties diagram:
1697
· DiagramID: A long value corresponding to Diagram.
PackageID.
Repository EA.Repository IN An EA.Repository object representing the currently open
1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
Return True if the diagram has been updated during this notification. Return False otherwise.

11.3.5.9.4 EA_OnPostNewDiagramObject

Details
EA_OnPostNewDiagramObject notifies Add-Ins that a new object has been created on a diagram. It enables
Add-Ins to modify the object upon creation.
This event occurs after a user has dragged a new object from the Project Browser or Resources window onto
a diagram. The notification is provided immediately after the object is added to the diagram. Set Repository.
SuppressEADialogs to true to suppress Enterprise Architect from showing its default dialogs.
Also look at EA_OnPreNewDiagramObject 1795 .

Syntax
Function EA_OnPostNewDiagramObject(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPostNewDiagramObject function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty objects for the new
EventProperties element:
1697
· ObjectID: A long value corresponding to Object.
ObjectID.
Repository EA.Repository 1680 IN An EA.Repository object representing the currently open
Enterprise Architect model. Poll its members to retrieve
model data and user interface status information.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1801

Return Value
Return True if the element has been updated during this notification. Return False otherwise.

11.3.5.9.5 EA_OnPostNewAttribute

Details
EA_OnPostNewAttribute notifies Add-Ins that a new attribute has been created on a diagram. It enables Add-
Ins to modify the attribute upon creation.
This event occurs when a user creates a new attribute on an element by either drag-dropping from the Project
Browser, using the Attributes Properties dialog, or using the in-place editor on the diagram. The notification is
provided immediately after the attribute is created. Set Repository.SuppressEADialogs to true to suppress
Enterprise Architect from showing its default dialogs.
Also look at EA_OnPreNewAttribute 1796 .

Syntax
Function EA_OnPostNewAttribute(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPostNewAttribute function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty objects for the new
EventProperties attribute:
1697
· AttributeID: A long value corresponding to Attribute.
AttributeID.
Repository EA.Repository IN An EA.Repository object representing the currently open
1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
Return True if the attribute has been updated during this notification. Return False otherwise.

11.3.5.9.6 EA_OnPostNewMethod

Details
EA_OnPostNewMethod notifies Add-Ins that a new method has been created on a diagram. It enables Add-
Ins to modify the method upon creation.
This event occurs when a user creates a new method on an element by either drag-dropping from the Project
Browser, using the method's Properties dialog, or using the in-place editor on the diagram. The notification is
provided immediately after the method is created. Set Repository.SuppressEADialogs to true to suppress
Enterprise Architect from showing its default dialogs.
Also look at EA_OnPreNewMethod 1797 .

Syntax
Function EA_OnPostNewMethod(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPostNewMethod function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty objects for the new
EventProperties method:

© 1998-2010 Sparx Systems Pty Ltd

 1802 Automation and Scripts | Enterprise Architect Add-In Model

Parameter Type Direction Description

1697 · MethodID: A long value corresponding to Method.

MethodID.
Repository EA.Repository 1680 IN An EA.Repository object representing the currently open
Enterprise Architect model. Poll its members to retrieve
model data and user interface status information.

Return Value
Return True if the method has been updated during this notification. Return False otherwise.

11.3.5.9.7 EA_OnPostNewPackage

Details
EA_OnPostNewPackage notifies Add-Ins that a new package has been created on a diagram. It enables Add-
Ins to modify the package upon creation.
This event occurs when a user drags a new package from the Toolbox or Resources window onto a diagram,
or by selecting the New Package icon from the Project Browser. Set Repository.SuppressEADialogs to true to
suppress Enterprise Architect from showing its default dialogs.
Also look at EA_OnPreNewPackage 1797 .

Syntax
Function EA_OnPostNewPackage(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPostNewPackage function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty objects for the new
EventProperties package:
1697
· PackageID: A long value corresponding to Package.
PackageID.
Repository EA.Repository IN An EA.Repository object representing the currently open
1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
Return True if the package has been updated during this notification. Return False otherwise.

11.3.5.10 EA_OnPostInitialized

Details
EA_OnPostInitialized notifies Add-Ins that the Repository object has finished loading and any necessary
initialization steps can now be performed on the object.
For example, the Add-In can create an Output tab using Repository.CreateOutputTab 1685 .

Syntax
Sub EA_OnPostInitialized(Repository As EA.Repository)
The EA_OnPostInitialized function syntax contains the following elements.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1803

Parameter Type Direction Description

Repository EA.Repository 1680 IN An EA.Repository object representing the currently open

Enterprise Architect model. Poll its members to retrieve
model data and user interface status information.

Return Value
None.

11.3.5.11 EA_OnPostTransform

Details
EA_OnPostTransform notifies Add-Ins that an MDG transformation has taken place with the output in the
specified target package.
This event occurs when a user runs an MDG transform on one or more target packages. The notification is
provided for each transform/target package immediately after all transform processes have completed.

Syntax
Function EA_OnPostTransform(Repository As EA.Repository, Info As EA.EventProperties) As Boolean
The EA_OnPostTransform function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty Objects for the

EventProperties transform performed:
1697
· Transform: A string value corresponding to the name of
the transform used
· PackageID: A long value corresponding to Package.
PackageID of the destination package.
Repository EA.Repository 1680 IN An EA.Repository object representing the currently open
Enterprise Architect model. Poll its members to retrieve
model data and user interface status information.

Return Value
Reserved for future use.

11.3.5.12 Technology Events

Enterprise Architect Add-Ins can respond to the following events associated with the use of MDG
Technologies:
· EA_OnInitializeTechnologies 1803
· EA_OnPreActivateTechnology 1804
· EA_OnPostActivateTechnology 1805
· EA_OnPreDeleteTechnology 1805 (Deprecated)
· EA_OnDeleteTechnology 1806 (Deprecated)
· EA_OnImportTechnology 1806 (Deprecated)

11.3.5.12.1 EA_OnInitializeTechnologies

Details
EA_OnInitializeTechnologies requests that an Add-In pass an MDG Technology to Enterprise Architect for
loading.
This event occurs on Enterprise Architect startup. Return your technology XML to this function and Enterprise

© 1998-2010 Sparx Systems Pty Ltd

 1804 Automation and Scripts | Enterprise Architect Add-In Model

Architect loads and enables it.

Syntax
Function EA_OnInitializeTechnologies(Repository As EA.Repository) As Object
The EA_OnInitializeTechnologies function syntax contains the following element:

Parameter Type Direction Description

Repository EA. IN An EA.Repository object representing the currently open Enterprise

Repository Architect model. Poll its members to retrieve model data and user
1680 interface status information.

Return Value
Return the MDG Technology as a single XML string.

Example
Public Function EA_OnInitializeTechnologies(ByVal Repository As EA.Repository) As Object
EA_OnInitializeTechnologies = My.Resources.MyTechnology
End Function

11.3.5.12.2 EA_OnPreActivateTechnology

Details
EA_OnPreActivateTechnology notifies Add-Ins that an MDG Technology resource is about to be activated in
the model. This event occurs when a user selects to activate an MDG Technology resource in the model (by
clicking on the Set Active button on the MDG Technologies 1069 dialog or by selecting the technology in the list
box in the Default Tools 80 toolbar).
The notification is provided immediately after the user attempts to activate the MDG Technology, so that the
Add-In can permit or disable activation of the Technology.
Also look at EA_OnPostActivateTechnology 1805 .

Syntax
Function EA_OnPreActivateTechnology(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPreActivateTechnology function syntax contains the following elements:

Parameter Type Direction Description

Info EA.EventProperties IN Contains the following EventProperty objects for the MDG
1697 Technology to be activated:
· TechnologyID: A string value corresponding to the
MDG Technology ID.
Repository EA.Repository 1680 IN An EA.Repository object representing the currently open
Enterprise Architect model. Poll its members to retrieve
model data and user interface status information.

Return Value
Return True to enable activation of the MDG Technology resource in the model. Return False to disable
activation of the MDG Technology resource.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1805

11.3.5.12.3 EA_OnPostActivateTechnology

Details
EA_OnPostActivateTechnology notifies Add-Ins that an MDG Technology resource has been activated in the
model. This event occurs when a user activates an MDG Technology resource in the model (by clicking on
the Set Active button on the MDG Technologies 1069 dialog or by selecting the technology in the list box in the
Default Tools 80 toolbar). The notification is provided immediately after the user succeeds in activating the
MDG Technology, so that the Add-In can update the Technology if necessary.
Also look at EA_OnPreActivateTechnology 1804 .

Syntax
Function EA_OnPostActivateTechnology(Repository As EA.Repository, Info As EA.EventProperties)
The EA_OnPostActivateTechnology function syntax contains the following elements:

Parameter Type Direction Description

Info EA.EventProperties IN Contains the following EventProperty objects for the MDG
1697 Technology to be activated:
· TechnologyID: A string value corresponding to the
MDG Technology ID.
Repository EA.Repository 1680 IN An EA.Repository object representing the currently open
Enterprise Architect model. Poll its members to retrieve
model data and user interface status information.

Return Value
Return True if the MDG Technology resource is updated during this notification. Return False otherwise.

11.3.5.12.4 EA_OnPreDeleteTechnology
Deprecated - refers to deleting a technology through the Resources window; this process is no longer
recommended. See:
· EA_OnPreActivateTechnology 1804
· EA_OnPostActivateTechnology 1805
· EA_OnInitializeTechnologies 1803 .

Details
EA_OnPreDeleteTechnology notifies Add-Ins that an MDG Technology resource is about to be deleted from
the model. This event occurs when a user deletes an MDG Technology resource from the model. The
notification is provided immediately after the user confirms their request to delete the MDG Technology, so
that the Add-In can disable deletion of the MDG Technology.
Also look at EA_OnDeleteTechnology 1806 .

Syntax
Function EA_OnPreDeleteTechnology(Repository As EA.Repository, Info As EA.EventProperties) As
Boolean
The EA_OnPreDeleteTechnology function syntax contains the following elements:

Parameter Type Direction Description

Info EA.EventProperties IN Contains the following EventProperty objects for the MDG
1697 Technology to be deleted:
· TechnologyID: A string value corresponding to the
MDG Technology ID.

© 1998-2010 Sparx Systems Pty Ltd

 1806 Automation and Scripts | Enterprise Architect Add-In Model

Parameter Type Direction Description

Repository EA.Repository 1680 IN An EA.Repository object representing the currently open

Enterprise Architect model. Poll its members to retrieve
model data and user interface status information.

Return Value
Return True to enable deletion of the MDG Technology resource from the model. Return False to disable
deletion of the MDG Technology resource.

11.3.5.12.5 EA_OnDeleteTechnology
Deprecated - refers to deleting a technology through the Resources window; this process is no longer
recommended. See:
· EA_OnPreActivateTechnology 1804
· EA_OnPostActivateTechnology 1805
· EA_OnInitializeTechnologies 1803 .

Details
EA_OnDeleteTechnology notifies Add-Ins that an MDG Technology resource has been deleted from the
model.
This event occurs after a user has deleted an MDG Technology resource from the model. Add-Ins that require
an MDG Technology resource to be loaded can catch this event to disable certain functionality.
Also look at EA_OnPreDeleteTechnology 1805 .

Syntax
Sub EA_OnDeleteTechnology(Repository As EA.Repository, Info As EA.EventProperties)
The EA_OnDeleteTechnology function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty objects:

EventProperties
1697
· TechnologyID: A string value corresponding to the MDG
Technology ID.
Repositor EA.Repository IN An EA.Repository object representing the currently open
y 1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
None.

11.3.5.12.6 EA_OnImportTechnology
Deprecated - refers to deleting a technology through the Resources window; this process is no longer
recommended. See:
· EA_OnPreActivateTechnology 1804
· EA_OnPostActivateTechnology 1805
· EA_OnInitializeTechnologies 1803 .

Details
EA_OnImportTechnology notifies Add-Ins that you have imported an MDG Technology resource into the
model.
This event occurs after you have imported an MDG Technology resource into the model. Add-Ins that require
an MDG Technology resource to be loaded can catch this Add-In to enable certain functionality.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1807

Syntax
Sub EA_OnImportTechnology(Repository As EA.Repository, Info As EA.EventProperties)
The EA_OnImportTechnology function syntax contains the following elements:

Parameter Type Direction Description

Info EA. IN Contains the following EventProperty objects:

EventProperties
1697
· TechnologyID: A string value corresponding to the MDG
Technology ID.
Repository EA.Repository 1680 IN An EA.Repository object representing the currently open
Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
None.

11.3.5.13 Context Item Events

Enterprise Architect Add-Ins can respond to the following events associated with changing context:
· EA_OnContextItemChanged 1807
· EA_OnContextItemDoubleClicked 1808
· EA_OnNotifyContextItemModified 1809

11.3.5.13.1 EA_OnContextItemChanged

Details
EA_OnContextItemChanged notifies Add-Ins that a different item is now in context.
This event occurs after a user has selected an item anywhere in the Enterprise Architect GUI. Add-Ins that
require knowledge of the current item in context can subscribe to this broadcast function. If ot = otRepository,
then this function behaves the same as EA_FileOpen 1788 .
Also look at EA_OnContextItemDoubleClicked 1808 and EA_OnNotifyContextItemModified 1809 .

Syntax
Sub EA_OnContextItemChanged(Repository As EA.Repository, GUID As String, ot as EA.ObjectType)
The EA_OnContextItemChanged function syntax contains the following elements:

Parameter Type Direction Description

GUID String IN Contains the GUID of the new context item. This value corresponds
to the following properties, depending on the value of the ot
parameter:

ot (ObjectType) - GUID value

otElement - Element.ElementGUID
otPackage - Package.PackageGUID
otDiagram - Diagram.DiagramGUID
otAttribute - Attribute.AttributeGUID
otMethod - Method.MethodGUID
otConnector - Connector.ConnectorGUID
otRepository - NOT APPLICABLE, GUID is an empty string

© 1998-2010 Sparx Systems Pty Ltd

 1808 Automation and Scripts | Enterprise Architect Add-In Model

Parameter Type Direction Description

ot EA. IN Specifies the type of the new context item.

ObjectType

Repository EA.Repository IN An EA.Repository object representing the currently open Enterprise

1680 Architect model. Poll its members to retrieve model data and user
interface status information.

Return Value
None.

11.3.5.13.2 EA_OnContextItemDoubleClicked

Details
EA_OnContextItemDoubleClicked notifies Add-Ins that the user has double-clicked the item currently in
context.
This event occurs when a user has double-clicked (or pressed [Enter]) on the item in context, either in a
diagram or in the Project Browser. Add-Ins to handle events can subscribe to this broadcast function.
Also look at EA_OnContextItemChanged 1807 and EA_OnNotifyContextItemModified 1809 .

Syntax
Function EA_OnContextItemDoubleClicked(Repository As EA.Repository, GUID As String, ot as EA.
ObjectType)
The EA_OnContextItemDoubleClicked function syntax contains the following elements:

Parameter Type Direction Description

GUID String IN Contains the GUID of the new context item. This value corresponds
to the following properties, depending on the value of the ot
parameter:

ot (ObjectType) - GUID value

otElement - Element.ElementGUID
otPackage - Package.PackageGUID
otDiagram - Diagram.DiagramGUID
otAttribute - Attribute.AttributeGUID
otMethod - Method.MethodGUID
otConnector - Connector.ConnectorGUID

ot EA. IN Specifies the type of the new context item.

ObjectType

Repository EA. IN An EA.Repository object representing the currently open Enterprise

Repository Architect model. Poll its members to retrieve model data and user
1680 interface status information.

Return Value
Return True to notify Enterprise Architect that the double-click event has been handled by an Add-In. Return
False to enable Enterprise Architect to continue processing the event.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1809

11.3.5.13.3 EA_OnNotifyContextItemModified

Details
EA_OnNotifyContextItemModified notifies Add-Ins that the current context item has been modified.
This event occurs when a user has modified the context item. Add-Ins that require knowledge of when an item
has been modified can subscribe to this broadcast function.
Also look at EA_OnContextItemChanged 1807 and EA_OnContextItemDoubleClicked 1808 .

Syntax
Sub EA_OnNotifyContextItemModified(Repository As EA.Repository, GUID As String, ot as EA.
ObjectType)
The EA_OnNotifyContextItemModified function syntax contains the following elements:

Parameter Type Direction Description

GUID String IN Contains the GUID of the new context item. This value
corresponds to the following properties, depending on the
value of the ot parameter:

· ot (ObjectType) - GUID value

· otElement - Element.ElementGUID

· otPackage - Package.PackageGUID

· otDiagram - Diagram.DiagramGUID

· otAttribute - Attribute.AttributeGUID

· otMethod - Method.MethodGUID

· otConnector - Connector.ConnectorGUID

ot EA.ObjectType IN Specifies the type of the new context item.

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
None.

11.3.5.14 Compartment Events

Enterprise Architect Add-Ins can respond to the following events associated with user-generated element
compartments:
· EA_QueryAvailableCompartments 1809

· EA_GetCompartmentData 1810

11.3.5.14.1 EA_QueryAvailableCompartments

Details
This event occurs when Enterprise Architect's diagrams are refreshed. It is a request for the Add-In to provide
a list of user-defined compartments. The EA_GetCompartmentData 1810 event then queries each object for the
data to display in each user-defined compartment.

Syntax
Function EA_QueryAvailableCompartments(Repository As EA.Repository) As Variant

© 1998-2010 Sparx Systems Pty Ltd

 1810 Automation and Scripts | Enterprise Architect Add-In Model

The EA_QueryAvailableCompartments function syntax contains the following elements:

Parameter Type Direction Description

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
A String containing a comma-separated list of user-defined compartments.

Example
Function EA_QueryAvailableCompartments(Repository As EA.Repository) As Variant
Dim sReturn As String
sReturn = ""
If m_FirstCompartmentVisible = True Then
sReturn = sReturn + "first,"
End If
If m_SecondCompartmentVisible = True Then
sReturn = sReturn + "second,"
End If
If m_ThirdCompartmentVisible = True Then
sReturn = sReturn + "third,"
End If

If Len(sReturn) > 0 Then

sReturn = Left(sReturn, Len(sReturn)-1)
End If

EA_QueryAvailableCompartments = sReturn
End Function

11.3.5.14.2 EA_GetCompartmentData

Details
This event occurs when Enterprise Architect is instructed to redraw an element. It requests that the Add-In
provide the data to populate the element's compartment.

Syntax
Function EA_GetCompartmentData(Repository As EA.Repository, sCompartment As String, sGUID As
String, oType As EA.ObjectType) As Variant
The EA_QueryAvailableCompartments function syntax contains the following elements:

Parameter Type Direction Description

oType ObjectType IN The type of the element for which data is being requested.

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve
model data and user interface status information.

sCompartment String IN The name of the compartment for which data is being
requested.

sGUID String IN The GUID of the element for which data is being requested.

Return Value
Variant containing a formatted string. See the example below to understand the format.

Example

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1811

Function EA_GetCompartmentData(Repository As EA.Repository, sCompartment As String, sGUID As String, oType As

EA.ObjectType) As Variant

If Repository Is Nothing Then

Exit Function
End If

Dim sCompartmentData As String

Dim oXML As MSXML2.DOMDocument
Dim Nodes As MSXML2.IXMLDOMNodeList
Dim Node1 As MSXML2.IXMLDOMNode
Dim Node As MSXML2.IXMLDOMNode
Dim sData As String

sCompartmentData = ""
Set oXML = New MSXML2.DOMDocument
sData = ""

On Error GoTo ERR_GetCompartmentData

oXML.loadXML (Repository.GetTreeXMLByGUID(sGUID))
Set Node1 = oXML.selectSingleNode("//ModelItem")

If Node1 Is Nothing Then

Exit Function
End If

sCompartmentData = sCompartmentData + "Name=" + sCompartment + ";"

sCompartmentData = sCompartmentData + "OwnerGUID=" + sGUID + ";"
sCompartmentData = sCompartmentData + "Options=SkipIfOnDiagram&_eq_^1&_sc_^"

Select Case sCompartment

Case "parts"
Set Nodes = Node1.selectNodes("ModelItem[@Metatype=""Part""]")
For Each Node In Nodes
sData = sData + "Data&_eq_^" + Node.Attributes.getNamedItem("Name").nodeValue + "&_sc_^"
sData = sData + "GUID&_eq_^" + Node.Attributes.getNamedItem("GUID").nodeValue + "&_sc_^,"
Next

Case "ports"
Set Nodes = Node1.selectNodes("ModelItem[@Metatype=""Port""]")
For Each Node In Nodes
sData = sData + "Data&_eq_^" + Node.Attributes.getNamedItem("Name").nodeValue + "&_sc_^"
sData = sData + "GUID&_eq_^" + Node.Attributes.getNamedItem("GUID").nodeValue + "&_sc_^,"
Next

End Select

' If there's no data to display, then don't return any compartment data
If sData <> "" Then
sCompartmentData = sCompartmentData + "CompartmentData=" + sData + ";"
Else
sCompartmentData = ""
End If

EA_GetCompartmentData = sCompartmentData
Exit Function

ERR_GetCompartmentData:
EA_GetCompartmentData = ""

End Function

11.3.5.15 Model Validation Broadcasts

Perform Model Validation from an Add-In

Using Enterprise Architect broadcasts, it is possible to define a set of rules that are evaluated when the user
instructs Enterprise Architect to perform model validation. An Add-In that performs model validation would
involve the following broadcast events:
· EA_OnInitializeUserRules 1812 is intercepted in order to define rule categories and rules.
· EA_OnStartValidation 1812 can be intercepted to perform any required processing prior to validation.
· The following functions intercept each request to validate an individual element, package, diagram,
connector, attribute and method:
© 1998-2010 Sparx Systems Pty Ltd
 1812 Automation and Scripts | Enterprise Architect Add-In Model

· EA_OnRunElementRule 1813
· EA_OnRunPackageRule 1813
· EA_OnRunDiagramRule 1814
· EA_OnRunConnectorRule 1814
· EA_OnRunAttributeRule 1815
· EA_OnRunMethodRule 1815
· EA_OnEndValidation 1813 can be intercepted to perform any required clean-up after validation has
completed.

Also consider the Model Validation Example 1816 .

11.3.5.15.1 EA_OnInitializeUserRules

Details
EA_OnInitializeUserRules is called on Enterprise Architect start-up and requests that the Add-In provide
Enterprise Architect with a rule category and list of rule IDs for model validation.
This function must be implemented by any Add-In that is to perform its own model validation. It must call
Project.DefineRuleCategory once and Project.DefineRule for each rule; these functions are described in the
Project Interface 1753 section.

Syntax
Sub EA_OnInitializeUserRules(Repository As EA.Repository)
The EA_OnInitializeUserRules function syntax contains the following elements:

Parameter Type Direction Description

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

11.3.5.15.2 EA_OnStartValidation

Details
EA_OnStartValidation notifies Add-Ins that a user has invoked the model validation command from Enterprise
Architect.

Syntax
Sub EA_OnStartValidation(Repository As EA.Repository, ParamArray Args() as Variant)
The EA_OnStartValidation function syntax contains the following elements:

Parameter Type Direction Description

Args ParamArray of Variant IN Contains a list of Rule Categories that are active for the
current invocation of model validation.

Repository EA.Repository 1680 IN An EA.Repository object representing the currently

open Enterprise Architect model. Poll its members to
retrieve model data and user interface status
information.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1813

11.3.5.15.3 EA_OnEndValidation

Details
EA_OnEndValidation notifies Add-Ins that model validation has completed. Use this event to arrange any
clean-up operations arising from the validation.

Syntax
Sub EA_OnEndValidation(Repository As EA.Repository, ParamArray Args() as Variant)
The EA_OnEndValidation function syntax contains the following elements:

Parameter Type Direction Description

Args ParamArray of IN Contains a list of Rule Categories that were active for
Variant the invocation of model validation that has just
completed.

Repository EA.Repository 1680 IN An EA.Repository object representing the currently open

Enterprise Architect model. Poll its members to retrieve
model data and user interface status information.

11.3.5.15.4 EA_OnRunElementRule

Details
This event is triggered once for each rule defined in EA_OnInitializeUserRules to be performed on each
element in the selection being validated. If you don't want to perform the rule defined by RuleID on the given
element, then simply return without performing any action. On performing any validation, if a validation error is
found, use the Repository.ProjectInterface.PublishResult method to notify Enterprise Architect.
Also look at EA_OnInitializeUserRules 1812 .

Syntax
Sub EA_OnRunElementRule(Repository As EA.Repository, RuleID As String, Element As EA.Element)
The EA_OnRunElementRule function syntax contains the following elements:

Parameter Type Direction Description

Element EA.Element IN The element to potentially perform validation on.

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

RuleID String IN The ID that was passed into the Project.DefineRule command.

11.3.5.15.5 EA_OnRunPackageRule

Details
This event is triggered once for each rule defined in EA_OnInitializeUserRules 1812 to be performed on each
package in the selection being validated. If you don't want to perform the rule defined by RuleID on the given
package, then simply return without performing any action. On performing any validation, if a validation error is
found, use the Repository.ProjectInterface.PublishResult method to notify Enterprise Architect.

Syntax
Sub EA_OnRunPackageRule(Repository As EA.Repository, RuleID As String, PackageID As Long)
The EA_OnRunElementRule function syntax contains the following elements:

© 1998-2010 Sparx Systems Pty Ltd

 1814 Automation and Scripts | Enterprise Architect Add-In Model

Parameter Type Direction Description

PackageID Long IN The ID of the package to potentially perform validation on. Use
the Repository.GetPackageByID method to retrieve the package
object.

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

RuleID String IN The ID that was passed into the Project.DefineRule method.

11.3.5.15.6 EA_OnRunDiagramRule

Details
This event is triggered once for each rule defined in EA_OnInitializeUserRules 1812 to be performed on each
diagram in the selection being validated. If you don't want to perform the rule defined by RuleID on the given
diagram, then simply return without performing any action. On performing any validation, if a validation error is
found, use the Repository.ProjectInterface.PublishResult method to notify Enterprise Architect.

Syntax
Sub EA_OnRunDiagramRule(Repository As EA.Repository, RuleID As String, DiagramID As Long)
The EA_OnRunDiagramRule function syntax contains the following elements:

Parameter Type Direction Description

DiagramID Long IN The ID of the diagram to potentially perform validation on. Use
the Repository.GetDiagramByID method to retrieve the
diagram object.

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

RuleID String IN The ID that was passed into the Project.DefineRule command.

11.3.5.15.7 EA_OnRunConnectorRule

Details
This event is triggered once for each rule defined in EA_OnInitializeUserRules 1812 to be performed on each
connector in the selection being validated. If you don't want to perform the rule defined by RuleID on the given
connector, then simply return without performing any action. On performing any validation, if a validation error
is found, use the Repository.ProjectInterface.PublishResult method to notify Enterprise Architect.

Syntax
Sub EA_OnRunConnectorRule(Repository As EA.Repository, RuleID As String, ConnectorID As Long)
The EA_OnRunConnectorRule function syntax contains the following elements:

Parameter Type Direction Description

ConnectorI Long IN The ID of the connector to potentially perform validation on. Use
D the Repository.GetConnectorByID method to retrieve the
connector object.

Repository EA. IN An EA.Repository object representing the currently open

Repository Enterprise Architect model. Poll its members to retrieve model
1680 data and user interface status information.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1815

Parameter Type Direction Description

RuleID String IN The ID that was passed into the Project.DefineRule command.

11.3.5.15.8 EA_OnRunAttributeRule

Details
This event is triggered once for each rule defined in EA_OnInitializeUserRules 1812 to be performed on each
attribute in the selection being validated. If you don't want to perform the rule defined by RuleID on the given
attribute, then simply return without performing any action. On performing any validation, if a validation error is
found, use the Repository.ProjectInterface.PublishResult method to notify Enterprise Architect.

Syntax
Sub EA_OnRunAttributeRule(Repository As EA.Repository, RuleID As String, AttributeGUID As String,
ObjectID As Long)
The EA_OnRunAttributeRule function syntax contains the following elements:

Parameter Type Direction Description

AttributeGUID String IN The GUID of the attribute to potentially perform validation on.
Use the Repository.GetAttributeByGuid method to retrieve
the attribute object.

ObjectID Long IN The ID of the object that owns the given attribute. Use the
Repository.GetObjectByID method to retrieve the object.

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve
model data and user interface status information.

RuleID String IN The ID that was passed into the Project.DefineRule

command.

11.3.5.15.9 EA_OnRunMethodRule

Details
This event is triggered once for each rule defined in EA_OnInitializeUserRules 1812 to be performed on each
method in the selection being validated. If you don't want to perform the rule defined by RuleID on the given
method, then simply return without performing any action. On performing any validation, if a validation error is
found, use the Repository.ProjectInterface.PublishResult method to notify Enterprise Architect.

Syntax
Sub EA_OnRunMethodRule(Repository As EA.Repository, RuleID As String, MethodGUID As String,
ObjectID As Long)
The EA_OnRunMethodRule function syntax contains the following elements:

Parameter Type Direction Description

MethodGUI String IN The GUID of the method to potentially perform validation on.
D Use the Repository.GetMethodByGuid method to retrieve the
method object.

ObjectID Long IN The ID of the object that owns the given method. Use the
Repository.GetObjectByID method to retrieve the object.

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

© 1998-2010 Sparx Systems Pty Ltd

 1816 Automation and Scripts | Enterprise Architect Add-In Model

Parameter Type Direction Description

RuleID String IN The ID that was passed into the Project.DefineRule command.

11.3.5.15.10 EA_OnRunParameterRule

Details
This event is triggered once for each rule defined in EA_OnInitializeUserRules 1812 to be performed on each
parameter in the selection being validated. If you don't want to perform the rule defined by RuleID on the given
parameter, then simply return without performing any action. On performing any validation, if a validation error
is found, use the Repository.ProjectInterface.PublishResult method to notify Enterprise Architect.

Syntax
Sub EA_OnRunParameterRule(Repository As EA.Repository, RuleID As String, ParameterGUID As
String, MethodGUID As String, ObjectID As Long)
The EA_OnRunMethodRule function syntax contains the following elements:

Parameter Type Direction Description

MethodGUID String IN The GUID of the method that owns the given parameter. Use
the Repository.GetMethodByGuid method to retrieve the
method object.

ObjectID Long IN The ID of the object that owns the given parameter. Use the
Repository.GetObjectByID method to retrieve the object.

ParameterGUI String IN The GUID of the parameter to potentially perform validation

D on. Use it to retrieve the parameter by iterating through the
Method.Parameters collection.

Repository EA. IN An EA.Repository object representing the currently open

Repository Enterprise Architect model. Poll its members to retrieve model
1680 data and user interface status information.

RuleID String IN The ID that was passed into the Project.DefineRule

command.

11.3.5.15.11 Model Validation Example

The following example code is written in C# and provides a skeleton model validation implementation that you
might like to use as a starting point in writing your own model validation rules.

Main.cs
using System;

namespace myAddin
{
public class Main
{
public Rules theRules;

public Main()
{
theRules = new Rules();
}

public string EA_Connect(EA.Repository Repository)

{
return "";
}

public void EA_Disconnect()

{

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1817

GC.Collect();
GC.WaitForPendingFinalizers();
}

private bool IsProjectOpen(EA.Repository Repository)

{
try
{
EA.Collection c = Repository.Models;
return true;
}
catch
{
return false;
}
}

public object EA_GetMenuItems(EA.Repository Repository, string MenuLocation, string MenuName)

{
switch (MenuName)
{
case "":
return "-&myAddin";
case "-&myAddin":
string[] ar = { "&Test" };
return ar;
}
return "";
}

public void EA_GetMenuState(EA.Repository Repository, string MenuLocation, string MenuName, string

ItemName, ref bool IsEnabled, ref bool IsChecked)
{
// if no open project, disable all menu options
if (IsProjectOpen(Repository))
IsEnabled = true;
else
IsEnabled = false;
}

public void EA_MenuClick(EA.Repository Repository, string MenuLocation, string MenuName, string

ItemName)
{
switch (ItemName)
{
case "&Test";
DoTest(Repository);
break;
}
}

public void EA_OnInitializeUserRules(EA.Repository Repository)

{
if (Repository != null)
{
theRules.ConfigureCategories(Repository);
theRules.ConfigureRules(Repository);
}
}

public void EA_OnRunElementRule(EA.Repository Repository, string RuleID, EA.Element element)

{
theRules.RunElementRule(Repository, RuleID, element);
}

public void EA_OnRunDiagramRule(EA.Repository Repository, string RuleID, long lDiagramID)

{
theRules.RunDiagramRule(Repository, RuleID, lDiagramID);
}

public void EA_OnRunConnectorRule(EA.Repository Repository, string RuleID, long lConnectorID)

{
theRules.RunConnectorRule(Repository, RuleID, lConnectorID);
}

public void EA_OnRunAttributeRule(EA.Repository Repository, string RuleID, string AttGUID, long

© 1998-2010 Sparx Systems Pty Ltd

 1818 Automation and Scripts | Enterprise Architect Add-In Model

lObjectID)
{
return;
}

public void EA_OnDeleteTechnology(EA.Repository Repository, EA.EventProperties Info)

{
return;
}

public void EA_OnImportTechnology(EA.Repository Repository, EA.EventProperties Info)

{
return;
}

private void DoTest(EA.Repository Rep)

{
// TODO: insert test code here
}
}
}

Rules.cs
using System;
using System.Collections;

namespace myAddin
{
public class Rules
{
private string m_sCategoryID;
private System.Collections.ArrayList m_RuleIDs;
private System.Collections.ArrayList m_RuleIDEx;

private const string cRule01 = "Rule01";

private const string cRule02 = "Rule02";
private const string cRule03 = "Rule03";
// TODO: expand this list as much as necessary

public Rules()
{
m_RuleIDs = new System.Collections.ArrayList();
m_RuleIDEx = new System.Collections.ArrayList();
}

private string LookupMap(string sKey)

{
return DoLookupMap(sKey, m_RuleIDs, m_RuleIDEx);
}

private string LookupMapEx(string sRule)

{
return DoLookupMap(sRule, m_RuleIDEx, m_RuleIDs);
}

private string DoLookupMap(string sKey, ArrayList arrValues, ArrayList arrKeys)

{
if (arrKeys.Contains(sKey))
return arrValues[arrKeys.IndexOf(sKey)].ToString();
else
return "";
}

private void AddToMap(string sRuleID, string sKey)

{
m_RuleIDs.Add(sRuleID);
m_RuleIDEx.Add(sKey);
}

private string GetRuleStr(string sRuleID)

{
switch (sRuleID)
{
case cRule01:
return "Error Message 01";

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1819

case cRule02:
return "Error Message 02";
case cRule03:
return "Error Message 03";
// TODO: add extra cases as much as necessary
}
return "";
}

public void ConfigureCategories(EA.Repository Repository)

{
EA.Project Project = Repository.GetProjectInterface();
m_sCategoryID = Project.DefineRuleCategory("Enterprise Collaboration Architecture (ECA)
Rules");
}

public void ConfigureRules(EA.Repository Repository)

{
EA.Project Project = Repository.GetProjectInterface();
AddToMap(Project.DefineRule(m_sCategoryID, EA.EnumMVErrorType.mvError,
GetRuleStr(cRule01)), cRule01);
AddToMap(Project.DefineRule(m_sCategoryID, EA.EnumMVErrorType.mvError,
GetRuleStr(cRule02)), cRule02);
AddToMap(Project.DefineRule(m_sCategoryID, EA.EnumMVErrorType.mvError,
GetRuleStr(cRule03)), cRule03);
// TODO: expand this list
}

public void RunConnectorRule(EA.Repository Repository, string sRuleID, long lConnectorID)

{
EA.Connector Connector = Repository.GetConnectorByID((int)lConnectorID);
if (Connector != null)
{
switch (LookupMapEx(sRuleID))
{
case cRule02:
// TODO: perform rule 2 check
break;
// TODO: add more cases
}
}
}

public void RunDiagramRule(EA.Repository Repository, string sRuleID, long lDiagramID)

{
EA.Diagram Diagram = Repository.GetDiagramByID((int)lDiagramID);
if (Diagram != null)
{
switch (LookupMapEx(sRuleID))
{
case cRule03:
// TODO: perform rule 3 check
break;
// TODO: add more cases
}
}
}

public void RunElementRule(EA.Repository Repository, string sRuleID, EA.Element Element)

{
if (Element != null)
{
switch (LookupMapEx(sRuleID))
{
case cRule01:
DoRule01(Repository, Element);
break;
// TODO: add more cases
}
}
}

private void DoRule01(EA.Repository Repository, EA.Element Element)

{
if (Element.Stereotype != "myStereotype")
return;

© 1998-2010 Sparx Systems Pty Ltd

 1820 Automation and Scripts | Enterprise Architect Add-In Model

// TODO: validation logic here

// report validation errors

EA.Project Project = Repository.GetProjectInterface();
Project.PublishResult(LookupMap(cRule01), EA.EnumMVErrorType.mvError,
GetRuleStr(cRule01));
}
}
}

11.3.5.16 EA_OnRetrieveModelTemplate

Details
EA_OnRetrieveModelTemplate requests that an Add-In pass a model template to Enterprise Architect.
This event occurs when a user executes the Add a New Model Using Wizard command to add a model that
has been defined by an MDG Technology. See the Incorporate Model Templates 1146 topic for details of how to
define such model templates.

Syntax
Function EA_OnRetrieveModelTemplate(Repository As EA.Repository,sLocation As String) As String
The EA_OnRetrieveModelTemplate function syntax contains the following elements:

Parameter Type Direction Description

Repository EA. IN An EA.Repository object representing the currently open Enterprise

Repository Architect model. Poll its members to retrieve model data and user
1680 interface status information.

sLocation String IN The name of the template requested. This should match the
location attribute in the <ModelTemplates> section of an MDG
Technology File. For more information, see the Incorporate Model
Templates in a Technology topic.

Return Value
Return a string containing the XMI export of the model that is being used as a template.

Example
Public Function EA_OnRetrieveModelTemplate(ByRef Rep As EA.Repository, ByRef sLocation As String) As String
Dim sTemplate As String
Select Case sLocation
Case "Templates\Template1.xml"
sTemplate = My.Resources.Template1
Case "Templates\Template2.xml"
sTemplate = My.Resources.Template2
Case "Templates\Template3.xml"
sTemplate = My.Resources.Template3
Case Else
MsgBox("Path for " & sLocation & " not found")
sTemplate = ""
End Select
EA_OnRetrieveModelTemplate = sTemplate
End Function

11.3.6 Custom Views

Enterprise Architect enables custom windows to be inserted as tabs in the Diagram View that appears at the
center of the Enterprise Architect frame.
Creating a custom view 1821 enables you to easily and quickly tab between a custom interface and diagrams
and other views normally provided by Enterprise Architect.
Uses for this facility include:
· Reports and graphs showing summary data of the model

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1821

· Alternative views of a diagram

· Alternative views of the model
· Views of external data related to model data
· Documentation tools.

11.3.6.1 Create a Custom View

A custom view must be designed as an ActiveX custom control and inserted through the automation interface.
ActiveX custom controls can be created using most well-known programming tools including Microsoft Visual
Studio.NET. See the documentation provided by the relevant vendor on how to create a custom control to
produce an OCX file.
Once the custom control has been created and registered on the target system, it can be added through the
AddTab() method of the Repository 1680 object.

While it is possible to call AddTab() from any automation client, it is likely that you would call it from an Add-In,
and that Add-In is defined in the same OCX that provides the custom view.
Example C# code is shown below:

public class Addin

{
UserControl1 m_MyControl;

public void EA_Connect(EA.Repository Rep)

{
}

public object EA_GetMenuItems(EA.Repository Repository, string Location, string MenuName)

{
if( MenuName == "" )
return "-&C# Control Demo";
else
{
String[] ret = {"&Create", "&Show Button"};
return ret;
}
}

public void EA_MenuClick(EA.Repository Rep, string Location, string MenuName, string ItemName)
{
if( ItemName == "&Create" )
m_MyControl = (UserControl1) Rep.AddTab("C# Demo","ContDemo.UserControl1");
else
m_MyControl.ShowButton();
}

11.3.7 MDG Add-Ins

MDG Add-Ins are specialized types of Add-Ins that have additional features and extra requirements for Add-In
authors who want to contribute to Enterprise Architect's goal of Model Driven Generation. Unlike general Add-
In events, MDG Add-In events are only sent to the Add-In that has taken ownership of an Enterprise Architect
model branch on a particular PC.
One of the additional responsibilities of an MDG Add-In is to take ownership of a branch of an Enterprise
Architect model, which is done through the MDG_Connect 1822 event.
MDG Add-Ins identify themselves as such during EA_Connect 1782 by returning the string MDG.
Unlike ordinary Add-Ins, responding to MDG Add-In events is not optional, and methods must be published for
each of the MDG Events 1822 .
Two examples of MDG Add-Ins are the commercially available MDG Link for Eclipse and MDG Link for Visual
Studio, published by Sparx Systems.

© 1998-2010 Sparx Systems Pty Ltd

 1822 Automation and Scripts | Enterprise Architect Add-In Model

11.3.7.1 MDG Events

An MDG Add-In must respond to all MDG Events. These events usually identify processes such as Build, Run,
Synchronize, PreMerge and PostMerge, amongst others.
An MDG Link Add-In is expected to implement some form of forward and reverse engineering capability within
Enterprise Architect, and as such requires access to a specific set of events, all to do with generation,
synchronization and general processes concerned with converting models to code and code to models.
· MDG_BuildProject 1822
· MDG_Connect 1822
· MDG_Disconnect 1823
· MDG_GetConnectedPackages 1824

· MDG_GetProperty 1824
· MDG_Merge 1825
· MDG_NewClass 1826
· MDG_PostGenerate 1827
· MDG_PostMerge 1827
· MDG_PreGenerate 1828
· MDG_PreMerge 1828
· MDG_PreReverse 1829
· MDG_RunExe 1830
· MDG_View 1830

11.3.7.1.1 MDGBuild Project

Details
MDG_BuildProject enables the Add-In to handle file changes caused by generation. This function is called in
response to a user selecting the Add-Ins | Build Project menu option.
Respond to this event by compiling the project source files into a running application.
Also look at MDG_RunExe 1830 .

Syntax
Sub MDG_BuildProject(Repository As EA.Repository, PackageGuid As String)

The MDG_BuildProject function syntax contains the following elements:

Parameter Type Direction Description

PackageGuid String IN The GUID identifying the Enterprise Architect package sub-
tree that is controlled by the Add-In.

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve
model data and user interface status information.

Return Value
None.

11.3.7.1.2 MDGConnect

Details
MDG_Connect enables the Add-In to handle user driven request to connect a model branch to an external
application. This function is called when the user attempts to connect a particular Enterprise Architect package
to an as yet unspecified external project. This event enables the Add-In to interact with the user to specify
such a project.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1823

The Add-In is responsible for retaining the connection details, which should be stored on a per-user or per-
workstation basis. That is, users who share a common Enterprise Architect model over a network should be
able to connect and disconnect to external projects independently of one another.
The Add-In should therefore not store connection details in an Enterprise Architect repository. A suitable place
to store such details would be:
SHGetFolderPath(..CSIDL_APPDATA..)\AddinName.
The PackageGuid parameter is the same identifier as required for most events relating to the MDG Add-In.
Therefore it is recommended that the connection details be indexed using the PackageGuid value.
The PackageID parameter is provided to aid fast retrieval of package details from Enterprise Architect, should
this be required.
Also look at MDG_Disconnect 1823 .

Syntax
Function MDG_Connect(Repository As EA.Repository, PackageID as Long, PackageGuid As String) As
Long
The MDG_Connect function syntax contains the following elements:

Parameter Type Direction Description

PackageGui String IN The unique ID identifying the project provided by the Add-In
d when a connection to a project branch of an Enterprise
Architect model was first established.

PackageID Long IN The PackageID of the Enterprise Architect package the user
has requested to have connected to an external project.

Repository EA. IN An EA.Repository object representing the currently open

Repository Enterprise Architect model. Poll its members to retrieve model
1680 data and user interface status information.

Return Value
Returns a non-zero to indicate that a connection has been made; a zero indicates that the user has not
nominated a project and connection should not proceed.

11.3.7.1.3 MDGDisconnect

Details
MDG_Disconnect enables the Add-In to respond to user requests to disconnect the model branch from an
external project. This function is called when the user attempts to disconnect an associated external project.
The Add-In is required to delete the details of the connection.
Also look at MDG_Connect 1822 .

Syntax
Function MDG_Disconnect(Repository As EA.Repository, PackageGuid As String) As Long
The MDG_Disconnect function syntax contains the following elements:

Parameter Type Direction Description

PackageGui String IN The GUID identifying the Enterprise Architect package sub-tree
d that is controlled by the Add-In.

Repository EA. IN An EA.Repository object representing the currently open

Repository Enterprise Architect model. Poll its members to retrieve model
1680 data and user interface status information.

© 1998-2010 Sparx Systems Pty Ltd

 1824 Automation and Scripts | Enterprise Architect Add-In Model

Return Value
Returns a non-zero to indicate that a disconnection has occurred enabling Enterprise Architect to update the
user interface. A zero indicates that the user has not disconnected from an external project.

11.3.7.1.4 MDGGetConnectedPackages

Details
MDG_GetConnectedPackages enables the Add-In to return a list of current connection between Enterprise
Architect and an external application. This function is called when the Add-In is first loaded, and is expected to
return a list of the available connections to external projects for this Add-In.
Also look at MDG_Connect 1822 .

Syntax
Function MDG_GetConnectedPackages(Repository As EA.Repository) As Variant
The MDG_GetConnectedPackages function syntax contains the following elements:

Parameter Type Direction Description

Repository EA. IN An EA.Repository object representing the currently open Enterprise

Repository Architect model. Poll its members to retrieve model data and user
1680 interface status information.

Return Value
Returns an array of GUID strings representing individual Enterprise Architect packages.

11.3.7.1.5 MDGGetProperty

Details
MDG_GetProperty provides miscellaneous Add-In details to Enterprise Architect. This function is called by
Enterprise Architect to poll the Add-In for information relating to the PropertyName. This event should occur in
as short a duration as possible as Enterprise Architect does not cache the information provided by the
function.
Values corresponding to the following PropertyNames must be provided:
· IconID - Return the name of a DLL and a resource identifier in the format #ResID, where the resource ID
indicates an Icon; for example, c:\program files\myapp\myapp.dlll#101
· Language - Return the default language that Classes should be assigned when they are created in
Enterprise Architect
· HiddenMenus - Return one or more values from the MDGMenus enumeration to hide menus that do not
apply to your Add-In. For example:

if( PropertyName == "HiddenMenus" )

return mgBuildProject + mgRun;

Syntax
Function MDG_GetProperty(Repository As EA.Repository, PackageGuid As String, PropertyName As
String) As Variant
The MDG_GetProperty function syntax contains the following elements:

Parameter Type Direction Description

PackageGuid String IN The GUID identifying the Enterprise Architect package sub-tree
that is controlled by the Add-In.

PropertyNam String IN The name of the property that is used by Enterprise Architect.
See Details for the possible values.

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1825

Parameter Type Direction Description

Repository EA. IN An EA.Repository object representing the currently-open

Repository Enterprise Architect model. Poll its members to retrieve model
1680 data and user interface status information.

Return Value
See Details, above.

11.3.7.1.6 MDGMerge

Details
MDG_Merge enables the Add-In to jointly handle changes to both the model branch and the code project that
the model branch is connected to. This event should be called whenever the user has asked to merge their
model branch with its connected code project, or whenever the user has established a new connection to a
code project. The purpose of this event is to enable the Add-In to interact with the user to perform a merge
between the model branch and the connected project.
Also look at MDG_Connect 1822 , MDG_PreMerge 1828 and MDG_PostMerge 1827 .

Syntax
Function MDG_Merge(Repository As EA.Repository, PackageGuid As String, SynchObjects As Variant,
SynchType As String, ExportObjects As Variant, ExportFiles As Variant, ImportFiles As Variant,
IgnoreLocked As String, Language As String) As Long
The MDG_Merge function syntax contains the following elements:

Parameter Type Direction Description

ExportFiles Variant OUT A string array containing the list of files for each model object
chosen for export by the Add-In. Each entry in this array must
have a corresponding entry in the ExportObjects parameter at
the same array index, so ExportFiles(2) must contain the
filename of the object by ExportObjects(2).

ExportObject Variant OUT The string array containing the list of new model objects (in
s Object ID format) to be exported by Enterprise Architect to the
code project.

IgnoreLocked String OUT A value indicating whether to ignore any files locked by the code
project (that is, "TRUE" or "FALSE".

ImportFiles Variant OUT A string array containing the list of code files made available to
the code project to be newly imported to the model. Enterprise
Architect imports each file listed in this array for import into the
connected model branch.

Language String OUT The string value containing the name of the code language
supported by the code project connected to the model branch.

PackageGuid String IN The GUID identifying the Enterprise Architect package sub-tree
that is controlled by the Add-In.

Repository EA. IN An EA.Repository object representing the currently open

Repository Enterprise Architect model. Poll its members to retrieve model
1680 data and user interface status information.

SynchObjects Variant OUT A string array containing a list of objects (Object ID format) to be
jointly synchronized between the model branch and the project.
See below 1826 for the format of the Object IDs.

© 1998-2010 Sparx Systems Pty Ltd

 1826 Automation and Scripts | Enterprise Architect Add-In Model

Parameter Type Direction Description

SynchType String OUT The value determining the user-selected type of synchronization
to take place. See below 1826 for a list of valid values.

Return Value
Return a non-zero if the merge operation completed successfully and a zero value when the operation has
been unsuccessful.

Merge
A merge consists of three major operations:
· Export: Where newly created model objects are exported into code and made available to the code
project.
· Import: Where newly created code objects, Classes and such things are imported into the model.
· Synchronize: Where objects available both to the model and in code are jointly updated to reflect changes
made in either the model, code project or both.

Synchronize Type
The Synchronize operation can take place in one of four different ways. Each of these ways corresponds to a
value returned by SynchType:
· None: (SynchType = 0) No synchronization is to be performed
· Forward: (SynchType = 1) Forward synchronization, between the model branch and the code project is to
occur
· Reverse: (SynchType = 2) Reverse synchronization, between the code project and the model branch is to
occur
· Both: (SynchType = 3) Reverse, then Forward synchronization's are to occur.

Object ID Format
Each of the Object IDs listed in the string arrays described above should be composed in the following format:
(@namespace)*(#class)*($attribute|%operation|:property)*

11.3.7.1.7 MDGNewClass

Details
MDG_NewClass enables the Add-In to alter details of a Class before it is created.
This method is called when Enterprise Architect generates a new Class, and requires information relating to
assigning the language and file path. The file path should be passed back as a return value and the language
should be passed back via the language parameter.
Also look at MDG_PreGenerate 1828 .

Syntax
Function MDG_NewClass(Repository As EA.Repository, PackageGuid As String, CodeID As String,
Language As String) As String
The MDG_NewClass function syntax contains the following elements:

Parameter Type Direction Description

CodeID String IN A string used to identify the code element before it is created, for
more information see MDG_View 1830 .

Language String OUT A string used to identify the programming language for the new
Class. The language must be supported by Enterprise Architect.

PackageGui String IN The GUID identifying the Enterprise Architect package sub-tree

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1827

Parameter Type Direction Description

d that is controlled by the Add-In.

Repository EA. IN An EA.Repository object representing the currently open

Repository Enterprise Architect model. Poll its members to retrieve model
1680 data and user interface status information.

Return Value
Returns a string containing the file path that should be assigned to the Class.

11.3.7.1.8 MDGPostGenerate

Details
MDG_PostGenerate enables the Add-In to handle file changes caused by generation.
This event is called after Enterprise Architect has prepared text to replace the existing contents of a file.
Responding to this event enables the Add-In to write to the linked application's user interface rather than
modify the file directly.
When the contents of a file are changed, Enterprise Architect passes FileContents as a non-empty string. New
files created as a result of code generation are also sent through this mechanism, enabling Add-Ins to add
new files to the linked project's file list.
When new files are created Enterprise Architect passes FileContents as an empty string. When a non-zero is
returned by this function, the Add-In has successfully written the contents of the file. A zero value for the return
indicates to Enterprise Architect that the file must be saved.
Also look at MDG_PreGenerate 1828 .

Syntax
Function MDG_PostGenerate(Repository As EA.Repository, PackageGuid As String, FilePath As
String, FileContents As String) As Long
The MDG_PostGenerate function syntax contains the following elements:

Parameter Type Directio Description

n

FileContents String IN A string containing the proposed contents of the file.

FilePath String IN The path of the file Enterprise Architect intends to overwrite.

PackageGui String IN The GUID identifying the Enterprise Architect package sub-tree
d that is controlled by the Add-In.

Repository EA.Repository IN An EA.Repository object representing the currently open

1680 Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

Return Value
Return value depends on the type of event that this function is responding to (see Details, above). This
function is required to handle two separate and distinct cases.

11.3.7.1.9 MDGPostMerge

Details
MDG_PostMerge is called after a merge process has been completed.
This function is called by Enterprise Architect after the merge process has been completed.

© 1998-2010 Sparx Systems Pty Ltd

 1828 Automation and Scripts | Enterprise Architect Add-In Model

Note:
File save checking should not be performed with this function, but should be handled by MDG_PreGenerate
1828 , MDG_PostGenerate 1827 and MDG_PreReverse 1829 .

Also look at MDG_PreMerge 1828 and MDG_Merge 1825 .

Syntax
Function MDG_PostMerge(Repository As EA.Repository, PackageGuid As String) As Long
The MDG_PostMerge function syntax contains the following elements:

Parameter Type Direction Description

Repository EA. IN An EA.Repository object representing the currently open

Repository Enterprise Architect model. Poll its members to retrieve model
1680 data and user interface status information.

PackageGui String IN The GUID identifying the Enterprise Architect package sub-tree
d that is controlled by the Add-In.

Return Value
Return a zero value if the post-merge process has failed, a non-zero return indicates that the post-merge has
been successful. Enterprise Architect assumes a non-zero return if this method is not implemented

11.3.7.1.10 MDGPreGenerate

Details
MDG_PreGenerate enables the Add-In to deal with unsaved changes. This function is called immediately
before Enterprise Architect attempts to generate files from the model. A possible use of this function would be
to prompt the user to save unsaved source files.
Also look at MDG_PostGenerate 1827 .

Syntax
Function MDG_PreGenerate(Repository As EA.Repository, PackageGuid As String) As Long
The MDG_PreGenerate function syntax contains the following elements:

Parameter Type Direction Description

Repository EA. IN An EA.Repository object representing the currently open

Repository Enterprise Architect model. Poll its members to retrieve model
1680 data and user interface status information.

PackageGuid String IN The GUID identifying the Enterprise Architect package sub-tree
that is controlled by the Add-In.

Return Value
Return a zero value to abort generation. Any other value enables the generation to continue.

11.3.7.1.11 MDGPreMerge

Details
MDG_PreMerge is called after a merge process has been initiated by the user and before Enterprise Architect
performs the merge process.
This event is called after a user has performed their interactions with the merge screen and has confirmed the
merge with the OK button, but before Enterprise Architect performs the merge process using the data

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1829

provided by the MDG_Merge call, before any changes have been made to the model or the connected project.
This event is made available to provide the Add-In with the opportunity to generally set internal Add-In flags to
augment the MDG_PreGenerate, MDG_PostGenerate and MDG_PreReverse events.

Note:
File save checking should not be performed with this function, but should be handled by MDG_PreGenerate
1828 , MDG_PostGenerate 1827 and MDG_PreReverse 1829 .

Also look at MDG_Merge 1825 and MDG_PostMerge 1827 .

Syntax
Function MDG_PreMerge(Repository As EA.Repository, PackageGuid As String) As Long
The MDG_PreMerge function syntax contains the following elements:

Parameter Type Direction Description

Repository EA. IN An EA.Repository object representing the currently open

Repository Enterprise Architect model. Poll its members to retrieve model
1680 data and user interface status information.

PackageGui String IN The GUID identifying the Enterprise Architect package sub-tree
d that is controlled by the Add-In.

Return Value
A return value of zero indicates that the merge process will not occur. If the value is not zero the merge
process will proceed. If this method is not implemented then it is assumed that a merge process is used.

11.3.7.1.12 MDGPreReverse

Details
MDG_PreReverse enables the Add-In to save file changes before being imported into Enterprise Architect.
This function operates on a list of files that are about to be reverse-engineered into Enterprise Architect. If the
user is working on unsaved versions of these files in an editor, you could either prompt the user or save
automatically.
Also look at MDG_PostGenerate 1827 and MDG_PreGenerate 1828 .

Syntax
Sub MDG_PreReverse(Repository As EA.Repository, PackageGuid As String, FilePaths As Variant)
The MDG_PreReverse function syntax contains the following elements:

Parameter Type Direction Description

Repository EA. IN An EA.Repository object representing the currently open

Repository Enterprise Architect model. Poll its members to retrieve model
1680 data and user interface status information.

PackageGui String IN The GUID identifying the Enterprise Architect package sub-tree
d that is controlled by the Add-In.

FilePaths String array IN An array of filepaths pointed to the files that are to be reverse
engineered.

Return Value
None.

© 1998-2010 Sparx Systems Pty Ltd

 1830 Automation and Scripts | Enterprise Architect Add-In Model

11.3.7.1.13 MDGRunExe

Details
MDG_RunExe enables the Add-In to run the target application. This function is called when the user selects
the Add-Ins | Run Exe menu option. Respond to this event by launching the compiled application.
Also look at MDG_BuildProject 1822 .

Syntax
Sub MDG_RunExe(Repository As EA.Repository, PackageGuid As String)
The MDG_RunExe function syntax contains the following elements:

Parameter Type Direction Description

Repository EA. IN An EA.Repository object representing the currently open

Repository Enterprise Architect model. Poll its members to retrieve model
1680 data and user interface status information.

PackageGui String IN The GUID identifying the Enterprise Architect package sub-tree
d that is controlled by the Add-In.

Return Value
None.

11.3.7.1.14 MDGView

Details
MDG_View enables the Add-In to display user specified code elements. This function is called by Enterprise
Architect when the user asks to view a particular code element. This enables the Add-In to present that
element in its own way, usually in a code editor.

Syntax
Function MDG_View(Repository As EA.Repository, PackageGuid As String, CodeID as String) As Long
The MDG_View function syntax contains the following elements:

Parameter Type Direction Description

Repository EA. IN An EA.Repository object representing the currently open

Repository Enterprise Architect model. Poll its members to retrieve model
data and user interface status information.

PackageGuid String IN The GUID identifying the Enterprise Architect package sub-tree
that is controlled by the Add-In.

CodeID String IN Identifies the code element in the following format:

<type>ElementPart<type>ElementPart...
where each element is proceeded with a token identifying its type:
@ -namespace
# - Class
$ - attribute
% - operation
For example if a user has selected the m_Name attribute of
Class1 located in namespace Name1, the class ID would be
passed through in the following format:

Enterprise Architect User Guide

 Automation and Scripts | Enterprise Architect Add-In Model 1831

Parameter Type Direction Description

@Name1#Class1%m_Name

Return Value
Return a non-zero value to indicate that the Add-In has processed the request. Returning a zero value results
in Enterprise Architect employing the standard viewing process which is to launch the associated source file.

© 1998-2010 Sparx Systems Pty Ltd

Part

XII
 Glossary of Terms | 1833

12 Glossary of Terms

This topic provides a detailed glossary for Enterprise Architect.

A B C D E F G H I J L
1834 1836 1837 1840 1842 1843 1844 1845 1846 1848 1849

M N O P Q R S T U V
1850 1852 1853 1854 1857 1858 1860 1863 1864 1865

© 1998-2010 Sparx Systems Pty Ltd

 1834 Glossary of Terms | A

12.1 A
abstract class
A Class that cannot be directly instantiated.
Contrast: concrete class

abstraction
The essential characteristics of an entity that distinguish it from all other kinds of entities. An abstraction
defines a boundary relative to the perspective of the viewer.

action
The specification of an executable statement that forms an abstraction of a computation procedure. An
action typically results in a change in the state of the system, and can be realized by sending a
message to an object or modifying a connector or a value of an attribute.

action sequence
An expression that resolves to a sequence of actions.

action state
A state that represents the execution of an atomic action, typically the invocation of an operation.

activation
The execution of an action.

active class
A Class whose instances are active objects. When instantiated, an active Class controls its execution.
Rather than being invoked or activated by other objects, it can operate standalone, and define its own
thread of behavior.
See also: active object

active object
An object that owns a thread and can initiate control activity. An instance of active Class.
See also: active class, thread

activity
Defines the bounds for the structural organization that contains a set of basic or fundamental behaviors.
It can used to model procedural type application development for system design through to modeling
business processes in organizational structures and work flow.

activity diagram
A diagram used to model procedural type application development for system design through to
modeling business processes in organizational structures and work flow.

activity graph
A special case of a State Machine that is used to model processes involving one or more classifiers.
Contrast: state chart diagram

actor [class]
A coherent set of roles that users of Use Cases play when interacting with these Use Cases. An Actor
has one role for each Use Case with which it communicates.

actual parameter
A binding for a parameter that resolves to a run-time instance.
Synonym: argument
Contrast: (formal) parameter

aggregate [class]
A Class that represents the 'whole' in an Aggregation (whole-part) relationship.
See also: aggregation

aggregation
A special form of Association that specifies a whole-part relationship between the Aggregate (whole)
and a component part.
See also: composition

analysis
The part of the software development process whose primary purpose is to formulate a model of the

Enterprise Architect User Guide

 Glossary of Terms | A 1835

problem domain. Analysis focuses on what to do, design focuses on how to do it.
Contrast: design

analysis diagram
A diagram used to capture high level business processes and early models of system behavior and
elements. It is less formal than some other diagrams, but provides a good means of capturing the
essential business characteristics and requirements.

analysis time
Refers to something that occurs during an analysis phase of the software development process.
See also: modeling time, run time, compile time
Contrast: design time

architecture
The organizational structure and associated behavior of a system. An architecture can be recursively
decomposed into parts that interact through interfaces, relationships that connect parts, and constraints
for assembling parts. Parts that interact through interfaces include Classes, Components and
subsystems.

argument
A binding for a parameter that resolves to a run-time instance.
Synonym: actual parameter
Contrast: (formal) parameter

artifact
A physical piece of information that is used or produced by a business or development process.
Examples of Artifacts include models, source files, scripts, and binary executable files. An Artifact can
constitute the implementation of a deployable component.
Synonym: product
Contrast: component

assembly
A connector that bridges the required interface of a component with the provided interface of a second
component.

association
The semantic relationship between two or more classifiers that specifies connections among their
instances.
See also: link

association class
A model element that has both Association and Class properties. An Association Class can be seen as
an Association that also has Class properties, or as a Class that also has Association properties.
See also: class

association end
The endpoint of an Association, which connects the Association to a classifier.
See also: classifier, link end

attribute
A feature within a classifier that describes a range of values that instances of the classifier can hold.

auxiliary class
A stereotyped Class that supports another more central or fundamental Class, typically by implementing
secondary logic or control flow. Auxiliary Classes are typically used together with focus Classes, and
are particularly useful for specifying the secondary business logic or control flow of components during
design.
See also: focus class

© 1998-2010 Sparx Systems Pty Ltd

 1836 Glossary of Terms | B

12.2 B
behavior
The observable effects of an operation or event, including its results.

behavioral diagram
A diagram that depicts the behavioral features of a system or business process. Behavioral diagrams
include Activity diagrams, State Machine diagrams, Communication diagrams, Interaction Overview
diagrams, Sequence diagrams, Timing diagrams and Use Case diagrams.

behavioral feature
A dynamic feature of a model element, such as an operation or method.

behavioral model aspect

A model aspect that emphasizes the behavior of the instances in a system, including their methods,
collaborations, and state histories.

binary association
An Association between two Classes. A special case of an N-ary Association.
Contrast: n-ary association

binding
The creation of a model element from a template by supplying arguments for the parameters of the
template.

bookmark
A marker in a Rich Text Format document that enables you to link inner sections of a document into a
master document (using the Word 'Insert File' function).

boolean
An enumeration whose values are true and false.

boolean expression
An expression that evaluates to a boolean value.

boundary
1. A stereotyped Class that models some system boundary – typically a user interface screen. It is used
in the conceptual phase to capture user interaction with the system at a screen level (or some other
boundary interface type). It is often used in Sequence and Robustness (Analysis) diagrams. It is the
View in the Model-View-Controller pattern.
2. A System Boundary element is used to delineate a particular part of the system.

Enterprise Architect User Guide

 Glossary of Terms | C 1837

12.3 C
C++
An object-oriented programming language based on the earlier 'C' language.

call
An action state that invokes an operation on a classifier.

cardinality
The number of elements in a set.
Contrast: multiplicity

CASE
Computer Aided Software Engineering. A tool designed for the purpose of modeling and building
software systems.

child
In a Generalization relationship, the specialization of another element, the parent.
See also: subclass, subtype
Contrast: parent

choice
A pseudo-state used to compose complex transitional paths, where the outgoing transition path is
decided by dynamic, run-time conditions determined by the actions performed by the State Machine on
the path leading to the choice.

class
A description of a set of objects that share the same attributes, operations, methods, relationships and
semantics. A Class can use a set of interfaces to specify collections of operations it provides to its
environment.
See also: interface, object

class diagram
A diagram that shows a collection of declarative (static) model elements, such as Classes, types, and
their contents and relationships.
See also: object diagram

classification
The assignment of an object to a classifier.
See also: dynamic classification, multiple classification and static classification.

classifier
A mechanism that describes behavioral and structural features. Classifiers include Interfaces, Classes,
datatypes, and components.

client
A classifier that requests a service from another classifier.
Contrast: supplier

collaboration
The specification of how an operation or classifier, such as a Use Case, is realized by a set of
classifiers and Associations playing specific roles used in a specific way. The Collaboration defines an
interaction.
See also: interaction

collaboration diagram
Used pre-UML 2.0. Now called a Communication diagram.

collaboration occurrence
Uses an Occurrence to apply a pattern defined by a Collaboration to a specific situation.

combined fragment
A combined fragment reflects a piece or pieces of interaction (called interaction operands) controlled by
an interaction operator, whose corresponding boolean conditions are known as interaction constraints.
It appears graphically as a transparent window, divided by horizontal dashed lines for each operand.

comment

© 1998-2010 Sparx Systems Pty Ltd

 1838 Glossary of Terms | C

An annotation attached to an element or a collection of elements. A comment, or note, has no

semantics.
Contrast: constraint

communication diagram
A diagram that shows the interactions between elements at run-time in much the same manner as a
Sequence diagram. However, Communication diagrams are used to visualize inter-object relationships,
while Sequence diagrams are more effective at visualizing processing over time.
See also: collaboration diagram, object diagram

compile time
Refers to something that occurs during the compilation of a software module.
See also: modeling time, run time, analysis time, design time

component
A modular, deployable, and replaceable part of a system that encapsulates implementation and
exposes a set of interfaces. A Component is typically specified by one or more classifiers (such as
implementation Classes) that reside on it, and can be implemented by one or more artifacts (such as
binary, executable, or script files).
See also: module
Contrast: artifact, product

component diagram
A diagram that shows the organizations and dependencies among Components.

composite [class]
A Class that is related to one or more Classes by a Composition relationship.
See also: composition

composite state
A State that consists of either concurrent (orthogonal) substates or sequential (disjoint) substates.
See also: substate, concurrent substate, disjoint substate

composite structure diagram

A diagram that reflects the internal collaboration of Classes, Interfaces, or Components to describe a
functionality. Composite Structure diagrams are similar to Class diagrams, except that they model a
specific usage of the structure.

composition
A form of Aggregation that requires that a part instance be included in at most one Composite at a time,
and that the Composite object is responsible for the creation and destruction of the parts. Composition
can be recursive.
Synonym: composite aggregation
See also: composite, aggregation

concrete class
A Class that can be directly instantiated.
Contrast: abstract class

concurrency
The occurrence of two or more activities during the same time interval. Concurrency can be achieved by
interleaving or simultaneously executing two or more threads.
See also: thread

concurrent substate
A substate that can be held simultaneously with other substates contained in the same composite
State.
See also: composite state
Contrast: disjoint substate

connector
A logical link between model elements. Can be structural, dynamic or possessive.

constraint
1. A semantic condition or restriction. Certain constraints are predefined in the UML, others can be user
defined. Constraints are one of three extensibility mechanisms in UML.

Enterprise Architect User Guide

 Glossary of Terms | C 1839

See also: tagged value, stereotype

Contrast: comment
2. A rule or condition that applies to some element. It is often modeled as a pre- or post- condition.

container
1. An instance that exists to contain other instances, and that provides operations to access or iterate
over its contents.(for example, arrays, lists, sets).
2. A component that exists to contain other components.

containment hierarchy
A namespace hierarchy consisting of model elements, and the containment relationships that exist
between them. A containment hierarchy forms a graph.

context
A view of a set of related modeling elements for a particular purpose, such as specifying an operation.

continuation
A Continuation is used in seq and alt combined fragments, to indicate the branches of continuation an
operand follows.

control
A stereotyped Class that represents a controlling entity or manager. A Control organizes and schedules
other activities and elements. It is the controller of the Model-View-Controller pattern.

control flow
A connector linking two nodes in an activity diagram. Control Flow connectors start a node's activity
when the preceding node's action is finished.

© 1998-2010 Sparx Systems Pty Ltd

 1840 Glossary of Terms | D

12.4 D
database schema
The description of a database structure. It defines tables and fields and the relationship between them.

datastore
An element used to define permanently stored data. A token of data that is stored in the Datastore is
stored permanently. A token of data that comes out of the Datastore is a copy of the original data. The
tokens imported are kept for the life of the Activity in which it exists.

datatype
A descriptor of a set of values that lack identity and whose operations do not have side effects.
Datatypes include primitive pre-defined types and user-definable types. Pre-defined types include
numbers, string and time. User-definable types include enumerations.

decision
An element of an Activity diagram that indicates a point of conditional progression: if a condition is true,
then processing continues one way, if not, then another.

defining model [MOF]

The model on which a repository is based. Any number of repositories can have the same defining
model.

delegate
A connector that defines the internal assembly of a component's external ports and interfaces. Using a
Delegate connector wires the internal workings of the system to the outside world, by a delegation of
the external interfaces' connections.

delegation
The ability of an object to issue a message to another object in response to a message. Delegation can
be used as an alternative to inheritance.
Contrast: inheritance

dependency
A relationship between two modeling elements, in which a change to one modeling element (the
independent element) affects the other modeling element (the dependent element).

deployment
A type of Dependency relationship that indicates the deployment of an artifact onto a node or
executable target.

deployment diagram
A diagram that shows the configuration of run-time processing nodes and the components, processes,
and objects that live on them. Components represent run-time manifestations of code units.
See also: component diagrams

deployment specification
Specifies parameters guiding deployment of an artifact, as is common with most hardware and software
technologies.

derived element
A model element that can be computed from another element, but that is shown for clarity or that is
included for design purposes even though it adds no semantic information.

design
The part of the software development process whose primary purpose is to decide how the system is to
be implemented. During design, strategic and tactical decisions are made to meet the required
functional and quality requirements of a system.
Contrast: analysis

design time
Refers to something that occurs during a design phase of the software development process.
See also: modeling time, run time, compile time
Contrast: analysis time

development process
A set of partially ordered steps performed for a given purpose during software development, such as
constructing models or implementing models.

Enterprise Architect User Guide

 Glossary of Terms | D 1841

diagram
A graphical presentation of a collection of model elements, most often rendered as a connected graph
of arcs (relationships) and vertices (other model elements). UML supports 14 diagram types, and
Enterprise Architect extends these with seven more. Add-Ins, technologies and profiles can provide
further diagram types.

diagram gate
A simple graphical way to indicate the point at which messages can be transmitted into and out of
Interaction Fragments.

diagram view
The Enterprise Architect workspace area where the UML diagrams are displayed.

disjoint substate
A substate that cannot be held simultaneously with other substates contained in the same composite
State.
See also: composite state, substate
Contrast: concurrent substate

distribution unit
A set of objects or components that are allocated to a process or a processor as a group. A distribution
unit can be represented by a run-time composite or an Aggregate.

domain
An area of knowledge or activity characterized by a set of concepts and terminology understood by
practitioners in that area.

dynamic classification
A semantic variation of Generalization in which an object can change its classifier.
See also: multiple classification
Contrast: static classification

© 1998-2010 Sparx Systems Pty Ltd

 1842 Glossary of Terms | E

12.5 E
element
1. An atomic constituent of a model.
2. A model object of any type, such as Class, Component, Node or Object.

endpoint
Used in Interaction diagrams to reflect a lost message in sequence.

entity
A store or persistence mechanism that captures the information or knowledge in a system. It is the
Model in the Model-View-Controller pattern.

entry action
An action executed upon entering a state in a State Machine regardless of the transition taken to reach
that state.

entry point
Used to define where external states can enter a Sub Machine.

enumeration
A list of named values used as the range of a particular attribute type. For example, RGBColor = {red,
green, blue}. Boolean is a predefined enumeration with values from the set {false, true}.

event
The specification of a significant occurrence that has a location in time and space. In the context of
State diagrams, an event is an occurrence that can trigger a transition.

exception handler
An element that defines the group of operations to carry out when an exception occurs.

exit action
An action executed upon exiting a State in a State Machine regardless of the transition taken to exit that
State.

exit point
Used in Sub Machine states and State Machines to denote the point where the machine is exited and
the transition sourcing this exit point, for Sub Machines, is triggered. Exit points are a type of pseudo-
state used in the State Machine diagram.

export
In the context of packages, to make an element visible outside its enclosing namespace.
See also: visibility
Contrast: import

expose interface
A toolbox icon that is a graphical way to depict the required and supplied interfaces of a Component,
Class or Part.

expression
A string that evaluates to a value of a particular type. For example, the expression (7 + 5 * 3) evaluates
to a value of type number. A relationship from an extension Use Case to a base Use Case, specifying
how the behavior defined for the extension Use Case augments (subject to conditions specified in the
extension) the behavior defined for the base Use Case. The behavior is inserted at the location defined
by the extension point in the base Use Case. The base Use Case does not depend on performing the
behavior of the extension Use Case.
See also: extend, include

extend
A connector used to indicate that an element extends the behavior of another. Extensions are used in
Use Case models to indicate one Use Case (optionally) extends the behavior of another.
See also: expression, include

Enterprise Architect User Guide

 Glossary of Terms | F 1843

12.6 F
facade
A stereotyped package containing only references to model elements owned by another package. It is
used to provide a 'public view' of some of the contents of a package.

feature
A property, like operation or attribute, that is encapsulated within a classifier, such as an Interface, a
Class, or a Datatype.

final
A pseudo-state that indicates an end.

final state
A special kind of State signifying that the enclosing composite State or the entire State Machine is
completed.

fire
To execute a State transition.
See also: transition

flow final
An element that depicts an exit from the system, as opposed to the Activity Final, which represents the
completion of the activity.

focus class
A stereotyped Class that defines the core logic or control flow for one or more auxiliary Classes that
support it. Focus Classes are typically used together with one or more auxiliary Classes, and are
particularly useful for specifying the core business logic or control flow of components during design.
See also: auxiliary class

focus of control
A symbol on a Sequence diagram that shows the period of time during which an object is performing an
action, either directly or through a subordinate procedure.

forward engineering
The process of generating source code from the UML model.

fork
Used in State Machine diagrams as pseudo-states. With respect to State Machine diagrams, a Fork
pseudo-state signifies that its incoming transition comes from a single State, and it has multiple
outgoing transitions.
Contrast: join

framework
A stereotyped package containing model elements that specify a reusable architecture for all or part of
a system. Frameworks typically include Classes, Patterns or templates. When frameworks are
specialized for an application domain, they are sometimes referred to as Application frameworks.
See also: pattern

© 1998-2010 Sparx Systems Pty Ltd

 1844 Glossary of Terms | G

12.7 G
generalizable element
A model element that can participate in a Generalization relationship.
See also: generalization

generalization
A taxonomic relationship between a more general element and a more specific element. The more
specific element is fully consistent with the more general element and contains additional information.
An instance of the more specific element can be used where the more general element is allowed.
See also: generalizable element, inheritance

guard condition
A condition that must be satisfied in order to enable an associated transition to fire.

Enterprise Architect User Guide

 Glossary of Terms | H 1845

12.8 H
history state
There are two types of History pseudo-states defined in UML: shallow History and deep History. A
shallow History sub-state is used to represent the most recently active sub-state of a composite State. A
deep History sub-state, in contrast, reflects the most recent active configuration of the composite State.

© 1998-2010 Sparx Systems Pty Ltd

 1846 Glossary of Terms | I

12.9 I
implementation
A definition of how something is constructed or computed. For example, a Class is an implementation of
a type, a method is an implementation of an operation.

implementation class
A stereotyped Class that specifies the implementation of a Class in some programming language (for
example, C++, Smalltalk, Java) in which an instance can not have more than one Class. An
Implementation Class is said to realize a type if it provides all of the operations defined for the type with
the same behavior as specified for the type's operations.
See also: type

implementation inheritance
The inheritance of the implementation of a more general element. Includes inheritance of the interface.
Contrast: interface inheritance

import
In the context of packages, a dependency that shows the packages whose Classes can be referenced
within a given package (including packages recursively embedded within it).
See also: visibility
Contrast: export

include
A relationship from a base Use Case to an inclusion Use Case, specifying how the behavior for the
base Use Case contains the behavior of the inclusion Use Case. The behavior is included at the
location that is defined in the base Use Case. The base Use Case depends on performing the behavior
of the inclusion Use Case, but not on its structure (that is, attributes or operations).
See also: extend, expression

inheritance
The mechanism by which more specific elements incorporate the structure and behavior of more
general elements related by behavior.
See also: generalization
Contrast: delegation

initial state
A pseudo-state used to denote the default state of a composite State; there can be one initial vertex in
each region of the composite State.

instance
An entity that has a unique identity, a set of operations that can be applied to it, and a state that stores
the effects of the operations.
See also: object

interaction
A specification of how stimuli are sent between instances to perform a specific task. The interaction is
defined in the context of a collaboration.
See also: collaboration

interaction diagram
A generic term that applies to several types of diagrams that emphasize object interactions. These
include Timing diagrams, Sequence diagrams, Interaction Overview diagrams and Communication
diagrams.

interaction occurrence
A reference to an existing interaction element. Interaction occurrences are visually represented by a
frame, with ref in the frame's title space. The diagram name is indicated in the frame contents.

interaction overview diagram

A diagram that visualizes the cooperation between other Interaction diagrams to illustrate a control flow
serving an encompassing purpose. As Interaction Overview diagrams are a variant of Activity diagrams,
most of the diagram notation is similar, as is the process in constructing the diagram.

interface
A named set of operations that characterize the behavior of an element.

Enterprise Architect User Guide

 Glossary of Terms | I 1847

See also: class

Contrast: type

interface inheritance
The inheritance of the interface of a more general element. Does not include inheritance of the
implementation.
Contrast: implementation inheritance

internal transition
A transition signifying a response to an event without changing the state of an object.

interrupt flow
An Enterprise Architect-defined toolbox icon used to define the exception handler and interruptible
activity region concepts.

© 1998-2010 Sparx Systems Pty Ltd

 1848 Glossary of Terms | J

12.10 J
Java
A fully object-oriented, cross platform language based on elements from Smalltalk, C++ and other OO
languages.

join
Used in State Machine diagrams and in Activity diagrams to synchronize multiple flows.
Contrast: fork

junction
Junction pseudo-states are used to design complex transitional paths. A Junction can be used to
combine, or merge, multiple paths into a shared transition path or to split an incoming path into multiple
paths.

Enterprise Architect User Guide

 Glossary of Terms | L 1849

12.11 L
layer
The organization of classifiers or packages at the same level of abstraction. A layer represents a
horizontal slice through an architecture, whereas a partition represents a vertical slice.
Contrast: partition

lifeline
An individual participant in an interaction (that is, Lifelines cannot have multiplicity). A Lifeline
represents a distinct connectable element.

link
A semantic connector among a tuple of objects. An instance of an Association.
See also: association

link end
An instance of an Association end.
See also: association end, classifier

local path
A relative path on a local machine, enabling developers to store shared source code in machine specific
directories, but still generate and synchronize code.

© 1998-2010 Sparx Systems Pty Ltd

 1850 Glossary of Terms | M

12.12 M
maintenance
The support of a software system after it is deployed.

manifest
A relationship that indicates that the artifact source embodies the target model element. Stereotypes
can be added to Enterprise Architect to classify the type of manifestation of the model element.

message
Messages indicate a flow of information, or transition of control, between elements. Messages are used
by Communication diagrams, Sequence diagrams, Interaction Overview diagrams and Timing
diagrams.

message endpoint
An element that defines an endpoint of a Lifeline, such as a State or Value Lifeline in a Timing diagram.

message label
Used for messages sent between Lifelines to make the diagram appear less cluttered. Labels with the
same name indicate that a message can be interrupted.

metaclass
A Class whose instances are Classes. Metaclasses are typically used to construct metamodels.

metafile
A vector-based image format native to Windows. Supports high detail and excellent scaling. Typically
used for saving diagram images for placement in documents. Comes in Placeable (an older format) and
Enhanced (current standard format).

meta-metamodel
A model that defines the language for expressing a metamodel. The relationship between a meta-
metamodel and a metamodel is analogous to the relationship between a metamodel and a model.

metamodel
A model that defines the language for expressing a model.

meta-object
A generic term for all meta-entities in a meta-modeling language. For example, meta-types, meta-
classes, meta-attributes, and meta-associations.

Meta-Object Facility (MOF)

An Object Management Group (OMG) standard. MOF originated in the UML, when the OMG required a
Meta-Modeling architecture to define the UML. MOF is designed as a four-layered architecture.

method
The implementation of an operation. It specifies the algorithm or procedure associated with an
operation.

model [MOF]
An abstraction of a physical system with a certain purpose.
See also: physical system
Usage note: In the context of the MOF specification, which describes a meta-metamodel, the meta-
metamodel is for brevity frequently referred to simply as the model.

model aspect
A dimension of modeling that emphasizes particular qualities of the metamodel. For example, the
structural model aspect emphasizes the structural qualities of the metamodel.

model elaboration
The process of generating a repository type from a published model. Includes the generation of
interfaces and implementations which enables repositories to be instantiated and populated based on,
and in compliance with, the model elaborated.

model element [MOF]

An element that is an abstraction drawn from the system being modeled.
Contrast: view element; in the MOF specification model elements are considered to be meta-objects.

model library
A stereotyped package containing model elements that are intended to be reused by other packages. A

Enterprise Architect User Guide

 Glossary of Terms | M 1851

model library differs from a profile in that a model library does not extend the metamodel using
stereotypes and tagged definitions. A model library is analogous to a Class library in some
programming languages.

modeling time
Refers to something that occurs during the modeling phase of the software development process. It
includes analysis time and design time.
Usage note: When discussing object systems, it is often important to distinguish between modeling-time
and run-time concerns.
See also: analysis time, design time, compile time
Contrast: run time

module
A software unit of storage and manipulation. Modules include source code modules, binary code
modules and executable code modules.
See also: component
MOF
Meta-Object Facility, an Object Management Group (OMG) standard. MOF originated in the UML, when
the OMG required a Meta-Modeling architecture to define the UML. MOF is designed as a four-layered
architecture.

multiple classification
A semantic variation of Generalization in which an object can belong directly to more than one
classifier.
See also: static classification, dynamic classification

multiple inheritance
A semantic variation of Generalization in which a type can have more than one supertype.
Contrast: single inheritance

multiplicity
A specification of the range of enableable cardinalities that a set can assume. Multiplicity specifications
can be given for roles within Associations, Parts within Composites, repetitions and other purposes.
Essentially a multiplicity is a (possibly infinite) subset of the non-negative integers.
Contrast: cardinality

multi-valued [MOF]
A model element with multiplicity defined whose Multiplicity Type:: upper attribute is set to a number
greater than one. The term multi-valued does not pertain to the number of values held by, for example,
an attribute or parameter, at any point in time.
Contrast: single-valued

© 1998-2010 Sparx Systems Pty Ltd

 1852 Glossary of Terms | N

12.13 N
name
A string used to identify a model element.

namespace
A part of the model in which the names can be defined and used. Within a namespace, each name has
a unique meaning.
See also: name

n-ary association
An Association among three or more Classes. Each instance of the Association is an n-tuple of values
from the respective Classes.
Contrast: binary association

nesting
A connector used as an alternative membership notation to indicate nested members within an element;
for example, a package that has nested members. The nested members of a package could also be
shown inside the package rather than linked by the Nesting connector.

node
A classifier that represents a run-time computation resource, which generally has at least a memory
and often processing capability. Run-time objects and components can reside on nodes.

Enterprise Architect User Guide

 Glossary of Terms | O 1853

12.14 O
object
An entity with a well-defined boundary and identity that encapsulates state and behavior. State is
represented by attributes and relationships, behavior is represented by operations, methods and State
Machines. An Object is an instance of a Class.
See also: class, instance

object diagram
A diagram that encompasses objects and their relationships at a point in time. An Object diagram can
be considered as a special case of a Class diagram or Communication diagram.
See also: class diagram, communication diagram

object flow
A sub type of the State flow or transition. It implies the passing of an object instance between elements
at run-time.

object flow state

A state in an Activity graph that represents the passing of an object from the output of actions in one
State to the input of actions in another State.

object lifeline
A line in a Sequence diagram that represents the existence of an object over a period of time.
See also: sequence diagram

Object Management Group (OMG)

The standards body responsible for the UML specification and management. Their website is www.omg.
org - follow the links to the UML pages.

occurrence
A relationship that indicates that a Collaboration represents a classifier. An Occurrence connector is
drawn from the collaboration to the classifier.

operation
A service that can be requested from an object to effect behavior. An operation has a signature, which
could restrict the actual parameters that are possible.

© 1998-2010 Sparx Systems Pty Ltd

 1854 Glossary of Terms | P

12.15 P
package
1. A namespace, as well as an element that can be contained in other packages' namespaces.
Packages can own or merge with other packages, and their elements can be imported into a
package's namespace.
2. A logical container of model elements. It groups elements and can also contain other packages.
The OMG UML specification (UML Superstructure Specification, v2.1.1, p. 109) states:
A package is used to group elements, and provides a namespace for the grouped elements.
A package is a namespace for its members, and may contain other packages. Only packageable
elements can be owned members of a package. By virtue of being a namespace, a package can
import either individual members of other packages, or all the members of other packages.
In addition a package can be merged with other packages.
Note that packages own model elements and are the basis for configuration control, storage and
access control. Each element can be directly owned by a single package, so the package hierarchy is a
strict tree. However, packages can reference other packages, modeled by using one of the stereotypes
«import» and «access» of Permission dependency, so the usage network is a graph. Other kinds of
dependencies between packages usually imply that one or more dependencies among the elements
exist.
A package is represented by the common folder icon - a large rectangle with a small rectangle (a 'tab')
attached to the left side on top.

package diagram
Used to reflect the organization of packages and their elements, and provide a visualization of their
corresponding namespaces.

package import
A package import relationship is drawn from a source package to a package whose contents are
imported. Private members of a target package cannot be imported.

package merge
Indicates a relationship between two packages whereby the contents of the target package are merged
with those of the source package. Private contents of a target package are not merged.

parameter
The specification of a variable that can be changed, passed, or returned. A parameter can include a
name, type, and direction. Parameters are used for operations, messages and events.
Synonym: formal parameter
Contrast: argument, actual parameter

parameterized element
The descriptor for a Class with one or more unbound parameters.
Synonym: template, parameterized class

parent
In a generalization relationship, the generalization of another element, the child.
See also: subclass, subtype
Contrast: child

part
A run-time instance of a Class or Interface.

participate
The connection of a model element to a relationship or to a reified relationship. For example, a Class
participates in an Association, an Actor participates in a Use Case.

partition
1. activity graphs: A portion of an activity graph that organizes the responsibilities for actions.
See also: swim lane
2. architecture: A set of related classifiers or packages at the same level of abstraction or across layers
in a layered architecture. A partition represents a vertical slice through an architecture, whereas a
layer represents a horizontal slice.

Enterprise Architect User Guide

 Glossary of Terms | P 1855

Contrast: layer

pattern
A template collaboration.
See also: framework

persistent object
An object that exists after the process or thread that created it has ceased to exist.

physical system
1. The subject of a model.
2. A collection of connected physical units, which can include software, hardware and people, that are
organized to accomplish a specific purpose. A physical system can be described by one or more
models, possibly from different viewpoints.
See also: model (MOF)
Contrast: system

port
Defines the interaction between a classifier and its environment. Interfaces controlling this interaction
can be depicted using the 'Expose Interface' toolbox icon.

postcondition
A constraint that must be true at the completion of an operation.

precondition
A constraint that must be true when an operation is invoked.

primitive type
A pre-defined basic datatype without any substructure, such as an integer or a string.

process
1. A heavyweight unit of concurrency and execution in an operating system.
Contrast: thread, which includes heavyweight and lightweight processes. If necessary, an
implementation distinction can be made using stereotypes.
2. A software development process - the steps and guidelines by which to develop a system.
3. To execute an algorithm or otherwise handle something dynamically.

product
A physical piece of information that is produced by a business or development process. Examples of
products include models, source files, scripts, and binary executable files. An product can constitute the
implementation of a deployable component.
Synonym: artifact
Contrast: component

profile
A stereotyped package that contains model elements that have been customized for a specific domain
or purpose using extension mechanisms, such as stereotypes, tagged definitions and constraints. A
profile can also specify model libraries on which it depends and the metamodel subset that it extends.

Project Browser
The workspace window where the model contents are displayed in 'tree' format. Displays structures
such as packages, diagrams and model elements.

projection
A mapping from a set to its subset.

property
A named value denoting a characteristic of an element. A property has semantic impact. Certain
properties are predefined in the UML; others can be user defined.
See also: tagged value

pseudo-state
A vertex in a State Machine that has the form of a State, but doesn't behave as a State. Pseudo-states
include initial and history vertices.

published model [MOF]

A model that has been frozen, and that becomes available for instantiating repositories and for support

© 1998-2010 Sparx Systems Pty Ltd

 1856 Glossary of Terms | P

in defining other models. A frozen model's model elements cannot be changed.

Enterprise Architect User Guide

 Glossary of Terms | Q 1857

12.16 Q
qualifier
An Association attribute or tuple of attributes whose values partition the set of objects related to an
object across an Association.

© 1998-2010 Sparx Systems Pty Ltd

 1858 Glossary of Terms | R

12.17 R
realize
A source object realizes the destination object. Realize is used to express traceability and
completeness in the model – a business process or requirement is realized by one or more Use Cases
which are in turn realized by some Classes which in turn are realized by a Component, and so on.

receive [a message]
The handling of a stimulus passed from a sender instance.
See also: sender, receiver

receive
An element used to define the acceptance or receipt of a request. Movement on to the next action
occurs until it has received what is defined.

receiver [object]
The object handling a stimulus passed from a sender object.
Contrast: sender

reception
A declaration that a classifier is prepared to react to the receipt of a signal.

recursion
A type of message used in Sequence diagrams to indicate a recursive function.

reference
1. A denotation of a model element.
2. A named slot within a classifier that facilitates navigation to other classifiers.
Synonym: pointer

region
UML 2.x supports both Expansion Regions and Interruptible Activity Regions. An Expansion Region
defines the bounds of a region consisting of one or more sets of input collections, where an input
collection is a set of elements of the same type. An Interruptible Activity Region contains Activity nodes
- when a token leaves an interruptible region, this terminates all of the region's tokens and behaviors.

refinement
A relationship that represents a fuller specification of something that has already been specified at a
certain level of detail. For example, a design Class is a refinement of an analysis Class.

relationship
A semantic connection among model elements. Examples of relationships include Associations and
Generalizations.

repository
A facility for storing object models, interfaces and implementations.

represents
A connector that indicates a Collaboration is used in a classifier. The connector is drawn from the
Collaboration to its owning classifier.

requirement
A required feature, property or behavior of a system (external requirement).

responsibility
A contract or obligation of a classifier (internal requirement).

reuse
The use of a pre-existing artifact.

reverse engineering
The process of importing source code into the model as standard UML model objects (such as Classes,
attributes and operations).

rich text format

A standard mark-up language for creating word processor documents, frequently associated with
Microsoft Word.

robustness diagram

Enterprise Architect User Guide

 Glossary of Terms | R 1859

Enterprise Architect supports business process modeling extensions from the UML business process
model profile. Robustness diagrams are used in ICONIX - you can read more about this at www.
sparxsystems.com/iconix/iconixsw.htm.

role
1. The named detail and rules associated with one end of an association. Can indicate name,
constraints, multiplicity and collection details.
2. The named specific behavior of an entity participating in a particular context. A role can be static
(such as an Association end) or dynamic (such as a Collaboration role).

role binding
The mapping between a Collaboration Occurrence's internal roles and the respective parts required to
implement a specific situation. The associated parts can have properties defined to enable the binding
to occur, and the collaboration to take place.

run time
The period of time during which a computer program executes.
See also: analysis time, compile time, design time
Contrast: modeling time

© 1998-2010 Sparx Systems Pty Ltd

 1860 Glossary of Terms | S

12.18 S
scenario
1. A specific sequence of actions that illustrates behaviors. A scenario can be used to illustrate an
interaction or the execution of a Use Case instance.

See also: interaction.

2. A sequence of operations carried out in some order to produce a known result. Can apply to Use
Cases where it is the equivalent of a Sequence diagram, or to other objects to describe how they are
used at run-time.

schema [MOF]
In the context of the MOF, analogous to a package that is a container of model elements. Schema
corresponds to a MOF package.
Contrast: metamodel, package

self-message
Reflects a new process or method invoked within the calling Lifeline's operation. It is a specification of a
message.

semantic variation point

A point of variation in the semantics of a metamodel. It provides an intentional degree of freedom for the
interpretation of the metamodel semantics.

send [a message]
The passing of a stimulus from a sender instance to a receiver instance.
See also: sender, receiver

sender [object]
The object passing a stimulus to a receiver object.
Contrast: receiver

sequence diagram
A diagram that shows object interactions arranged in time sequence. In particular, it shows the objects
participating in the interaction and the sequence of messages exchanged. Unlike a Communication
(Collaboration) diagram, a Sequence diagram includes time sequences but does not include object
relationships. A Sequence diagram can exist in a generic form (describes all possible scenarios) and in
an instance form (describes one actual scenario). Sequence diagrams and Communication diagrams
express similar information, but show it in different ways.
See also: communication diagram, object lifeline

signal
The specification of an asynchronous stimulus communicated between instances. Signals can have
parameters.

signature
The name and parameters of a behavioral feature. A signature can include an optional returned
parameter.

single inheritance
A semantic variation of Generalization in which a type can have only one supertype.
Contrast: multiple inheritance

single valued [MOF]

A model element with multiplicity defined is single valued when its Multiplicity Type: upper attribute is
set to 1. The term single-valued does not pertain to the number of values held by, for example, an
attribute or parameter at any point in time, since a single-valued attribute (for instance, with a multiplicity
lower bound of zero) could have no value.
Contrast: multi-valued

specification
A declarative description of what something is or does.
Contrast: implementation

state
A condition or situation during the life of an object during which it satisfies some condition, performs

Enterprise Architect User Guide

 Glossary of Terms | S 1861

some activity, or waits for some event.

Contrast: state [OMA]

state invariant
A condition applied to a Lifeline that must be fulfilled for the Lifeline to exist.

state machine
A behavior that specifies the sequences of States that an object or an interaction goes through during
its life in response to events, together with its responses and actions.

state machine diagram

A diagram that illustrates how an element, often a Class, can move between States classifying its
behavior, according to transition triggers, constraining guards and other aspects of State Machine
diagrams that depict and explain movement and behavior.

state chart
A diagram that shows a State Machine.
See also: state machine
Contrast: activity graph

state continuation
A symbol that serves two different purposes for Interaction diagrams - as State Invariants and as
Continuations. A State Invariant is a condition applied to a Lifeline that must be fulfilled for the Lifeline to
exist. A Continuation is used in seq and alt combined fragments to indicate the branches of continuation
that an operand follows.

state lifeline
A State Lifeline follows discrete transitions between States, which are defined along the y-axis of the
timeline. Any transition has optional attributes of timing constraints, duration constraints and
observations.

static classification
A semantic variation of Generalization in which an object can not change classifier.
See also: multiple classification
Contrast: dynamic classification

stereotype
A new type of modeling element that extends the semantics of the metamodel. Stereotypes must be
based on certain existing types or Classes in the metamodel. Stereotypes can extend the semantics,
but not the structure of pre-existing types and Classes. Certain stereotypes are predefined in the UML,
others can be user defined. Stereotypes are one of three extensibility mechanisms in UML.
See also: constraint, tagged value

stimulus
The passing of information from one instance to another, such as raising a signal or invoking an
operation. The receipt of a signal is normally considered an event.
See also: message

string
A sequence of text characters. The details of string representation depend on implementation, and can
include character sets that support international characters and graphics.

structural diagram
A diagram that depicts the structural elements composing a system or function. These diagrams can
reflect the static relationships of a structure, as do Class or Package diagrams, or run-time
architectures, such as Object or Composite Structure diagrams. Structural diagrams include Class
diagrams, Composite Structure diagrams, Component diagrams, Deployment diagrams, Object
diagrams and Package diagrams.

structural feature
A static feature of a model element, such as an attribute.

structural model aspect

A model aspect that emphasizes the structure of the objects in a system, including their types, Classes,
relationships, attributes and operations.

subactivity state
A State in an activity graph that represents the execution of a non-atomic sequence of steps that has

© 1998-2010 Sparx Systems Pty Ltd

 1862 Glossary of Terms | S

some duration.

subclass
In a Generalization relationship, the specialization of another Class; the superclass.
See also: generalization, child, parent
Contrast: superclass

submachine state
A State in a State Machine that is equivalent to a composite State but its contents are described by
another State Machine.

subpackage
A package that is contained in another package.

substate
A State that is part of a composite State.
See also: composite state, concurrent substate, disjoint substate

subsystem
A grouping of model elements that represents a behavioral unit in a physical system. A subsystem
offers interfaces and has operations. In addition, the model elements of a subsystem can be partitioned
into specification and realization elements.
See also: package, physical system

subtype
In a Generalization relationship, the specialization of another type; the supertype.
See also: generalization, child, parent
Contrast: supertype

superclass
In a Generalization relationship, the generalization of another Class; the subclass.
See also: generalization
Contrast: subclass

supertype
In a Generalization relationship, the generalization of another type; the subtype.
See also: generalization
Contrast: subtype

supplier
A classifier that provides services that can be invoked by others.
Contrast: client

swimlane
A partition on an Activity diagram for organizing the responsibilities for actions. Swimlanes typically
correspond to organizational units in a business model.
See also: partition

synch
A State used for indicating that concurrent paths of a State Machine are synchronized. After bringing
the paths to a synch state, the emerging transition indicates unison.

synchronize code
The process of importing and exporting code changes to ensure the model and source code match.

system
A top-level subsystem in a model.
Contrast: physical system

system boundary
An element used to delineate a particular part of the system.

Enterprise Architect User Guide

 Glossary of Terms | T 1863

12.19 T
table
A relational table (composed of columns).

tagged value
The explicit definition of a property as a name-value pair. In a Tagged Value, the name is referred to as
the tag. Certain tags are predefined in the UML; others can be user defined. Tagged Values are one of
three extensibility mechanisms in UML.
See also: constraint, property, stereotype

template
The descriptor for a Class with one or more unbound parameters.
Synonym: parameterized element, parameterized class

terminate
A pseudostate indicating that upon entry of its pseudostate, the State Machine's execution ends.

thread [of control]

A single path of execution through a program, a dynamic model, or some other representation of control
flow. Also, a stereotype for the implementation of an active object as a lightweight process.
See also: active object, process, concurrency

time event
An event that denotes the time elapsed since the current state was entered.
See also: event

time expression
An expression that resolves to an absolute or relative value of time.

timing diagram
A diagram that defines the behavior of different objects within a time-scale, with visual depictions of
those objects changing state and interacting over time.

toolbox
The main toolbar running down the center of Enterprise Architect, from which you can select model
elements to insert into diagrams. This is also known as the Toolbox and the Object toolbar.

top level
A stereotype of package denoting the top-most package in a containment hierarchy. The topLevel
stereotype defines the outer limit for looking up names, as namespaces 'see' outwards. For example,
opTopLevelsubsystem represents the top of the subsystem containment hierarchy.

trace
A dependency that indicates a historical or process relationship between two elements that represent
the same concept without specific rules for deriving one from the other.

transient object
An object that exists only during the execution of the process or thread that created it.

transition
A relationship between two States indicating that an object in the first State performs certain specified
actions and enters the second State when a specified event occurs and specified conditions are
satisfied. On such a change of State, the transition is said to fire.
See also: fire, object flow

type
A stereotyped Class that specifies a domain of objects together with the operations applicable to the
objects, without defining the physical implementation of those objects. A type can not contain any
methods, maintain its own thread of control, or be nested. However, it can have attributes and
associations. Although an object can have at most one implementation Class, it can conform to multiple
different types.
See also: implementation class
Contrast: interface

type expression
An expression that evaluates to a reference to one or more types.

© 1998-2010 Sparx Systems Pty Ltd

 1864 Glossary of Terms | U

12.20 U
UML
The Unified Modeling Language, a notation and specification for modeling software systems in an
Object-Oriented manner. You can read more about UML at the OMG home page or at our UML Tutorial.

UML diagrams
Diagrams used to model different aspects of the system under development. They include various
elements and connectors, all of which have their own meanings and purposes. UML 2.3 includes 14
diagrams: Use Case diagram, Activity diagram, State Machine diagram, Timing diagram, Sequence
diagram, Interaction Overview diagram, Communication diagram, Package diagram, Class diagram,
Object diagram, Composite Structure diagram, Component diagram and Deployment diagram.

UML toolbox
The main toolbar running down the center of Enterprise Architect from which you can select model
elements to insert into diagrams. This is also known as the Toolbox and the Object toolbar.

uninterpreted
A placeholder for a type or types whose implementation is not specified by the UML. Every
uninterpreted value has a corresponding string representation.
See also: any [CORBA]

usage
A dependency in which one element (the client) requires the presence of another element (the supplier)
for its correct functioning or implementation.

use
A connector that indicates that one element requires another to perform some interaction. The Usage
relationship does not specify how the target supplier is used, other than that the source client uses it in
definition or implementation.

use case [class]

A UML model element that describes how a user of the proposed system interacts with the system to
perform a discrete unit of work. It describes and signifies a single interaction over time that has meaning
for the end user (person, machine or other system), and is required to leave the system in a complete
state: either the interaction completed or was rolled back to the initial state.
See also: use case instance

use case diagram

A diagram that captures Use Cases and Actor interactions. It describes the functional requirements of
the system, the manner in which outside things (Actors) interact at the system boundary, and the
response of the system.

use case estimation

The technique of estimating project size and complexity based on the number of Use Cases and their
difficulty.

use case instance

The performance of a sequence of actions being specified in a Use Case. An instance of a Use Case.
See also: Use Case class

use case model

A model that describes a system's functional requirements in terms of Use Cases.

utility
A stereotype that groups global variables and procedures in the form of a Class declaration. The utility
attributes and operations become global variables and global procedures, respectively. A utility is not a
fundamental modeling construct, but a programming convenience.

Enterprise Architect User Guide

 Glossary of Terms | V 1865

12.21 V
value
An element of a type domain.

value lifeline
A Lifeline that shows the Lifeline's state across the diagram, within parallel lines indicating a steady
state. A cross between the lines indicates a transition or change in state.

vertex
A source or a target for a transition in a State Machine. A vertex can be either a State or a pseudo-
state.
See also: state, pseudo-state

view
A projection of a model, which is seen from a given perspective or vantage point and omits entities that
are not relevant to this perspective.

view element
An element that is a textual and/or graphical projection of a collection of model elements.
Contrast: model element (MOF)

view projection
A projection of model elements onto view elements. A view projection provides a location and a style for
each view element.

visibility
An enumeration whose value (public, protected, package or private) denotes how the model element to
which it refers can be seen outside its enclosing namespace.
See also: export, import

Visual Basic
A rapid application development programming language. Windows' only scripting language based on
COM.

© 1998-2010 Sparx Systems Pty Ltd

Part

XIII
 License Management | 1867

13 License Management

The License Management dialog in Enterprise Architect enables you to upgrade Enterprise Architect and to
register Add-Ins.
To access License Management from within Enterprise Architect, select the Help | Register and Manage
License Key(s) menu option. The License Management dialog displays, listing the currently-registered keys,
when the key expires (or, for shared keys 1870 , when they are to be reactivated in the keystore for issue to
another user) and the product each key applies to.

Use the buttons on the dialog as required:

Option Use to

Add Key Display the Add Registration Key dialog, which enables you to:
· Add a new key to update to a higher version of Enterprise Architect or to register an Add-
In.
· Obtain a key from the Sparx Systems Key Store (available for version 4.51 and above).
For more information on adding keys see the Add License Key 1870 topic.

Remove Key (Private Key) Make the Add-In or current version of Enterprise Architect inoperable.
Release Key (Shared Key) Release the key to the keystore; however, the Keystore Manager is normally
configured to release keys automatically when the user logs off.

Copy Place the highlighted key into the clipboard.

Close Close the dialog.

Help Display the help for this topic.

You can also run the following tasks from the License Management dialog:
· Register a Full License 22
· Upgrade an Existing License 1873

© 1998-2010 Sparx Systems Pty Ltd

 1868 License Management |

· Register an Add-In 1876

Enterprise Architect User Guide

 License Management | Finding Your License Information 1869

13.1 Finding Your License Information

You can find information on your Enterprise Architect license in the About Enterprise Architect dialog; select
the Help | About EA menu option.

© 1998-2010 Sparx Systems Pty Ltd

 1870 License Management | Add License Key

13.2 Add License Key

Two types of key can be used in conjunction with Enterprise Architect:
· Private keys allow you to register, indefinitely, an Enterprise Architect license (Desktop, Professional,
Corporate, Business and Software Engineering, Systems Engineering or Ultimate) or an Add-In product
(such as MDG Link for Eclipse or MDG Link for Visual Studio.NET) on the machine and user account that
you are currently using.
· Shared keys - obtained from a central shared key store - give you temporary access to the installed 'suite'
edition of Enterprise Architect. Shared Keys are available with the purchase of a floating license, and
require Enterprise Architect version 4.51 or higher. For more information, see Enterprise Architect Floating
License.

Notes:
· Some license keys can override and remove others. For example, the key for a more advanced edition of
Enterprise Architect replaces the key for a simpler edition, and the key for MDG Integration for Visual
Studio replaces the key for MDG Link for Visual Studio.
· Shared keys and Private keys have different formats and cannot be used interchangeably in the two
procedures below.

Add a Private Key

To add a private key, follow the steps below:
1. Select the Help | Register and Manage License Key(s) menu option. The License Management 1867

dialog displays.
2. Click on the Add Key button. The Add Registration Key dialog displays.

3. Click on the Enter Private Key tab.

4. In the Name and Company fields, type your user name and company name. Into the registration key
field, copy the registration key (including any parentheses around the key).
5. Click on the OK button to confirm the key selection.

Add a Shared Key

Shared Keys require a shared license keystore to be configured by your license administrator. The key store
can be either file-based or network based (preferred). Only the Key Administrator is required to install the
Sparx Enterprise Key Store application. End users simply connect to the configured key file - advised by the
administrator - using Enterprise Architect as described below. No additional software is required to be
installed.

Note:
If any error messages are displayed while attempting to obtain a shared key, see Keystore Troubleshooting
1872 .

Enterprise Architect User Guide

 License Management | Add License Key 1871

To add a shared key, follow the steps below:

1. Select the Help | Register and Manage License Key(s) menu option. The License Management 1867

dialog displays.
2. Click on the Add Key button. The Add Registration Key dialog displays.
3. Click on the Get Shared Key tab.

4. In the Name and Company fields, type your user name and company name.
5. In the Shared key store field, click on the [ ... ] (Browse) button. The Shared Keystore Selection dialog
displays.

6. If your keystore is file-based, select the File Based Keystore radio button, click on the Browse button,
and locate and select the keystore file. Go to step 9.
7. If the keystore is network-based, click on the Sparx Keystore Server radio button and, in the Server
Address field, type the server address of the keystore.
8. If necessary, type in the password (advised by your administrator) and/or click on the Test button to
ensure that you have a connection to the keystore.
9. Click on the OK button to return to the Get Shared Key tab, which now shows the name of the keystore
in the Shared Keystore field.
10. In the Select a Product field, click on the appropriate product name.
11. Click on the OK button. The License Management dialog redisplays, indicating that the shared key is
registered for the selected product, until the key expiry date.
12. Click on the Close button.

© 1998-2010 Sparx Systems Pty Ltd

 1872 License Management | Keystore Troubleshooting

13.3 Keystore Troubleshooting

Message Displayed: Explanation

Error reading Key Store file: All users who are to use the shared key facility require Read, Write and
(Access is denied) Modify access to the sskeys.dat file containing the shared keys. Please verify
that all required users have sufficient permissions to the file and try again.
If the problem continues, contact Sparx Support.

Tip:
Review the effective permissions calculated at the location of the key file for
the user account reporting the problem. You should closely examine the
permissions for both the Network Share and the File System. It is possible
that these permissions have been overwritten at some point.

Error reading Key Store file: As a security measure in the key store, the hard drive serial number is
(Key File has been moved) recorded when the file is created. The file then cannot be moved from the
original location in which it was created. If the key store has to be re-located
for any reason, the administrator should re-create the key store in the new
location using the original license keys.
This issue is commonly seen after a file server has undergone a hardware
upgrade in which the physical hard drives have been replaced. Problems
could also occur if the drive used is part of a RAID configuration.
This message could also appear where the key store exists on a Novell-
based file system. When creating the key store, the administrator is prompted
to confirm that the key store is to be located on a Novell Netware file server. If
the administrator clicks on the Yes button, the key store instead records the
logical path used to create it, and all users must connect to the key store
using this same path. The recorded path is case-sensitive and must be an
exact match.

Enterprise Architect User Guide

 License Management | Upgrade an Existing License 1873

13.4 Upgrade an Existing License

Enterprise Architect comes in six editions: Desktop, Professional, Corporate, Business and Software
Engineering, Systems Engineering and Ultimate. If you are using a less powerful edition, such as Professional
or Desktop, you can upgrade your license at a future date. You can do this by purchasing an upgrade key from
Sparx Systems (see the Sparx Systems website for purchase details).
An upgrade key is a special key that upgrades an existing license to a higher edition. Once you have
purchased and received the appropriate key, use the following procedures to unlock additional features. The
procedure for Enterprise Architect version 7.0 and later 1874 releases differs from the procedure for earlier
releases 1873 .

Notes:
· The Lite 15 version and the Trial version cannot be registered or upgraded. If you have purchased
Enterprise Architect, you must download the registered version from www.sparxsystems.com/
securedownloads/easetupfull.exe before you can enter your registration key.
· This topic is mainly relevant to users with private keys. If you are an end-user with a shared key, you would
simply be allocated the relevant key next time you requested one. If, however, you need to upgrade while
using a shared key on a long lease, you would simply click on the Release Key 1874 button and then the
Add Key 1871 button.

Tip:
Once you have successfully completed an upgrade with a Private key, select the Help | About EA menu
option. Copy the registration key shown and store it somewhere safe; this is a key to the full license of the
edition you have upgraded to. If you ever have to reinstall Enterprise Architect, you can register it with this
key, so you won't have to go through the upgrade process again.

Upgrade Enterprise Architect Version 6.5 and Earlier

To upgrade from one license edition to another, follow the steps below:
1. Make sure you have a valid upgrade key purchased from Sparx Systems; you typically receive this in an
email or PDF format.
2. Open Enterprise Architect.
3. Select the Help | Register and Manage License Key(s) menu option. The License Management dialog
displays

4. Click on the Add Key button or the Upgrade button to enter a new license key.
5. If you selected the Add key option, the Add Registration Key dialog displays. Enter the key you
received for the upgraded edition of Enterprise Architect, including the { and } bracket characters (use
copy and paste from an email to avoid typing mistakes).
6. If you selected the Upgrade option, the Upgrade Key dialog displays. Enter the key you received for the

© 1998-2010 Sparx Systems Pty Ltd

 1874 License Management | Upgrade an Existing License

upgraded edition of Enterprise Architect, including the { and } bracket characters (use copy and paste
from an email to avoid typing mistakes).

7. Click on the OK button. If the key is valid, Enterprise Architect modifies the Current Version field to
reflect the upgrade.
8. Close Enterprise Architect and restart to enable the unlocked features.

Upgrade Enterprise Architect Version 7.0 and Later

To upgrade from one license edition to another, follow the steps below:
1. Make sure you have a valid upgrade key purchased from Sparx Systems; you typically receive this in an
email or PDF format.
2. Open Enterprise Architect.
3. Select the Help | Register and Manage License Key(s) menu option. The License Management dialog
displays.

4. Click on the Add Key button; the Add Registration Key dialog displays

Enterprise Architect User Guide

 License Management | Upgrade an Existing License 1875

5. In the Name and Company fields, type your name and company name.
6. To avoid typing mistakes, copy the key you received for the upgraded edition of Enterprise Architect -
including the { and } bracket characters - from the email and paste the key into the Copy registration
key field.
7. Click on the OK button. Enterprise Architect displays a Registration succeeded – Thank you for
purchasing Enterprise Architect xxxx Edition message.
8. Click on the OK button, and then on the Close button to continue working in Enterprise Architect.

© 1998-2010 Sparx Systems Pty Ltd

 1876 License Management | Register Add-In

13.5 Register Add-In

To register Add-Ins for Enterprise Architect, follow the steps below:

Register an Add-In for Enterprise Architect

1. Purchase one or more licenses for the Add-In from your Add-In provider. Once you have paid for a
licensed version of the Add-In, you receive (via email or other suitable means) a license key for the
product.
2. Save the license key and the latest full version of the Add-In.
3. Run the Add-In's setup program to install the Add-In.
4. In Enterprise Architect, select the Help | Register and Manage License Key(s) menu option, or the
Add-Ins | Enter License Key for <Add-In name> menu option.

The License Management 1867 dialog displays.

5. Click on the Add Key button. The Add Registration Key dialog displays.

6. Type in the key you received with the Add-In, including the { and } characters.

Note:
If you have purchased a floating licence (shared key) follow these steps 1871 .

7. Click on the OK button.

8. When the Add-In has been added successfully, close down Enterprise Architect and restart it to apply

Enterprise Architect User Guide

 License Management | Register Add-In 1877

the changes.

© 1998-2010 Sparx Systems Pty Ltd

 1878 Index

Operations 743

Index SendSignal, Signal Tab 745

StructuralFeature 745
Trigger, AcceptEvent 745
Type, Set 745
-.- Update Operation 743
Action Pin
.EMX
Add To Action 749
Import 290
As Action Property 751
.NET
As Argument For Call Action 749
ASP, Debug 1463
Assign To Action 751
Debug 1460
Properties 749
Debug Another Process 1472
ActionScript
Debug Assembly 1461
Code Generation Language Options 1348
Debug CLR Versions 1462
Import, Reverse Engineering 1331
Debug With COM Interop Process 1463
Modeling Conventions 1283
Debug, System Requirements 1447
Options 1348
Garbage Collect (Exit Method) 1680
Versions Supported 1348
Set Up Debug Session 1461
Activate
.UML2
MDG Technologies 1069
Import 290
Activate Recording Markers 1503
Activation
-A- End 711
Extend Down 711
Abstract Extend Up 711
Complex Models 821 Lower 711
XSD Models 1047 Raise 711
Acceptance Testing 1542 Sequence Element 711
AcceptEvent Action Suppress 711
Triggers Tab 745 Activation Layer
Access Sequence Diagram Lifelines 712
Email 103 Activation Levels
Internet Search Engine 103 Sequence Diagram Lifeline Self Messages 712
MDG Technologies Remote From Enterprise Active
Architect 1070 Classes 812
Web Site 103 State Configuration 790
Access 2007 Active Directory
Repository, Create 123 Import User ID From 192
Upsize To 169 Active State Logic
Acknowledgement Model State Machine For HDL 1319
CXImage Library 20 Activity
Of Contributions 20 Behavioral Aspects 581
Of Trademarks 19 Edit Parameters 581
Print Listview 20 Element 753
Action Elements And Connectors 412
AcceptEvent, Triggers Tab 745 Group, Toolbox 412
As Hyperlink 842 Instance 892
BroadcastSignal, Signal Tab 745 IsException 755
Element 743 IsStream 755
Expansion Node 749 Notation 754
Local Pre/Post Conditions 752 Parameter Nodes 755
Notation 745 Parameters, Define 583
Enterprise Architect User Guide
 Index 1879

Activity Code Modules In MDG Technology Wizard

Partition 756, 786 1128
Paste As Action 432 Connectors Between Locked Elements 204
Paste As Link 432 Connectors To UML Model, Quick Start 32
Paste From Project Browser 432 Diagram Properties Note 440
Process Element 846 Diagram To Package 30
Region Element 788 Diagram to Project 422
Structured 798 Diagram To UML Model, Quick Start 30
Structured, Conditional Node 796, 798 Diagram Type In MDG Technology Wizard
Structured, Loop Node 796, 798 1124
Structured, Sequential 796 Element Changes 1559
Element Defects 1559
Activity (BPEL)
Create 974 Element Directly To Package 524
Loop 974 Element Issues 1559
Model 974 Element Tasks 1559
Sub-Process 974 Element To Diagram 31
Task 974 Element To Diagram From Project Browser
430
Types 974
Element To UML Model, Quick Start 31
Activity Diagram
Enumeration Tags To Stereotypes 1103
Create Object From Attribute 568
Expansion Region 771
Description 674
Filters To Search 1242
Elements And Connectors 674
Images In MDG Technology Wizard 1130
Example 674
Instance Variable 824
Generate Code From 1314, 1323
Interruptible Activity Region 782
Generate From Scenario 499, 500
Key 1870
Generate Scenario From 513
License Key 1870
Object Flows 886
Line Points 615
Operations 743
Linked Document Template In MDG Technology
Activity Edge Wizard 1133
Connector 867 MDA Transforms In MDG Technology Wizard
Relationship 867 1130
Activity Final Model To Project 112
Element 772 MS Word Table Of Contents 1641
Activity Partition MS Word Table Of Figures 1642
Docking 786 New Code Sections To Existing Features 1308
Element 786 Note To Connector 612
Horizontal 786 Note To Link 612
Vertical 786 Package In Project Browser 387
Actor Package To UML Model, Quick Start 30
Element 757 Packages To Model Document 1620
Ada 2005 Pattern In MDG Technology Wizard 1123
Code Generation Language Options 1348 Pattern To Diagram 904
Modeling Conventions 1284 Port To Element 827
Options 1348 Post To Team Review 213
Adaptive Server Anywhere Profile Attribute To Diagram 909
Data Repository, Connect To 162 Profile Connector To Diagram 909
ODBC Driver, Set Up 141 Profile Element To Diagram 909
Repository, Create 132 Profile In MDG Technology Wizard 1122
Upsize To 170 Profile Operation To Diagram 909
Add Project Items Via Toolbar 81
Category To Team Review 211 Project Task 330
Property Value to Part 826
© 1998-2010 Sparx Systems Pty Ltd
 1880 Index

Add Model Driven Generation 1073

RTF Report Template In MDG Technology Pre-2004 1779
Wizard 1132 Re-entrancy 1779
Scripts In MDG Technology Wizard 1131 Register 1876
Shape Script To Stereotype In Profile 1104 Run Functions From Tasks Pane 1143
Tagged Value Types In MDG Technology Wizard Search 1239, 1781
1127 Search Data 1782
Tagged Values 634 Submenu 72
Task Panel In MDG Technology Wizard 1126 Tasks 1777
Test Details 1538 Visual Basic Issues 1779
Toolbox In MDG Technology Wizard 1125 Window 58
Topic To Team Review 212
Add-In Event
UML Diagram 422 EA_Connect 1782
UML Pattern To Diagram 904 EA_Disconnect 1783
Views 383 EA_GetMenuItems 1783
Add And Delete Attributes EA_GetmenuState 1784
Automation Interface Code Example 1769 EA_MenuClick 1785
Add And Delete Methods EA_OnOutputItemClicked 1785
Automation Interface Code Example 1769 EA_OnOutputItemDoubleClicked 1786
Add And Manage Diagrams EA_ShowHelp 1787
Automation Interface Code Example 1768
Add-In Model
Add And Manage Elements Add-In Event, EA_Connect 1782
Automation Interface Code Example 1767 Add-In Event, EA_Disconnect 1783
Add And Manage Packages Add-In Event, EA_GetMenuItems 1783
Automation Interface Code Example 1766 Add-In Event, EA_GetMenuState 1784
Add Connector Add-In Event, EA_MenuClick 1785
Automation Interface Code Example 1767 Add-In Event, EA_OnOutputItemClicked 1785
Add Stereotypes Add-In Event, EA_OnOutputItemDoubleClicked
Automation Interface Code Example 1773 1786
Add Submenu Add-In Event, EA_ShowHelp 1787
Element Context Menu, Project Browser 1219 Add-In Event, Overview 1782
Package Context Menu, Project Browser 1216 Add-In Tasks 1777
Add to Project Clipboard Benefits 1776
Menu Option (Edit Menu) 57 Broadcast Event, EA_FileClose 1788
Add-In Broadcast Event, EA_FileNew 1789
And Enterprise ArchitectDeadlocks (.NET) Broadcast Event, EA_FileOpen 1788
1779 Broadcast Event, EA_OnPostCloseDiagram
COM Interoperability 1779 1789
Concurrent Method Calls 1779 Broadcast Event, EA_OnPostInitialized 1802
Connect To 72 Broadcast Event, EA_OnPostOpenDiagram
Create 1777 1789
Create, Define Menu Items 1777 Broadcast Event, EA_OnPostTransform 1803
Deploy 1778 Broadcast Event, EA_OnPreExitInstance 1798
Disable 1781 Broadcast Event, EA_OnRetrieveModelTemplate
Display Help On 72 1820
Enable 1781 Broadcast Events 1787
Events 1782 Compartment Events 1809
Holding State Information 1779 Compartment Events, EA_GetCompartmentData
Manage 1781 1810
Manager 1781 Compartment Events,
EA_QueryAvailableCompartments 1809
MDG 1073
Context Item Events 1807
Menu 72

Enterprise Architect User Guide

 Index 1881

Add-In Model EA_OnPreNewElement 1793

Context Item Events, EA_OnPreNewMethod 1797
EA_OnContextItemChanged 1807, 1809 EA_OnPreNewPackage 1797
Context Item Events, EA_OnRetrieveModelTemplate 1820
EA_OnContextItemDoubleClicked 1808 EA_OnRunAttributeRule 1815
Create Add-In 1777 EA_OnRunConnectorRule 1814
Create Add-In, Tricks and Traps 1779 EA_OnRunDiagramRule 1814
Create Custom View 1821 EA_OnRunElementRule 1813
Custom View 1820 EA_OnRunMethodRule 1815
EA_Connect 1782 EA_OnRunPackageRule 1813
EA_Disconnect 1783 EA_OnRunParameterRule 1816
EA_FileClose 1788 EA_OnStartValidation 1812
EA_FileNew 1789 EA_QueryAvailableCompartments 1809
EA_FileOpen 1788 EA_ShowHelp 1787
EA_GetCompartmentData 1810 Interface 1776
EA_GetMenuItems 1783 Introduction 1776
EA_GetMenuState 1784 MDG Add-Ins 1821
EA_MenuClick 1785 MDG Add-Ins, MDG Events 1822
EA_OnContextItemChanged 1807, 1809 MDG Events, MDG_BuildProject 1822
EA_OnContextItemDoubleClicked 1808 MDG Events, MDG_Connect 1822
EA_OnDeleteTechnology 1806 MDG Events, MDG_Disconnect 1823
EA_OnEndValidation 1813 MDG Events, MDG_GetConnectedPackages
EA_OnImportTechnology 1806 1824
EA_OnInitializeTechnologies 1803 MDG Events, MDG_GetProperty 1824
EA_OnInitializeUserRules 1812 MDG Events, MDG_Merge 1825
EA_OnOutputItemClicked 1785 MDG Events, MDG_NewClass 1826
EA_OnOutputItemDoubleClicked 1786 MDG Events, MDG_PostGenerate 1827
EA_OnPostActivateTechnology 1805 MDG Events, MDG_PostMerge 1827
EA_OnPostCloseDiagram 1789 MDG Events, MDG_PreGenerate 1828
EA_OnPostInitialized 1802 MDG Events, MDG_PreMerge 1828
EA_OnPostNewAttribute 1801 MDG Events, MDG_PreReverse 1829
EA_OnPostNewConnector 1799 MDG Events, MDG_RunExe 1830
EA_OnPostNewDiagram 1800 MDG Events, MDG_View 1830
EA_OnPostNewDiagramObject 1800 Model Validation Broadcasts 1811
EA_OnPostNewElement 1798 Model Validation Broadcasts,
EA_OnPostNewMethod 1801 EA_OnEndValidation 1813
EA_OnPostNewPackage 1802 Model Validation Broadcasts,
EA_OnPostOpenDiagram 1789 EA_OnInitializeUserRules 1812
EA_OnPostTransform 1803 Model Validation Broadcasts,
EA_OnPreActivateTechnology 1804 EA_OnRunAttributeRule 1815
EA_OnPreDeleteAttribute 1791 Model Validation Broadcasts,
EA_OnRunConnectorRule 1814
EA_OnPreDeleteConnector 1792
Model Validation Broadcasts,
EA_OnPreDeleteDiagram 1792 EA_OnRunDiagramRule 1814
EA_OnPreDeleteElement 1790 Model Validation Broadcasts,
EA_OnPreDeleteMethod 1791 EA_OnRunElementRule 1813
EA_OnPreDeletePackage 1793 Model Validation Broadcasts,
EA_OnPreDeleteTechnology 1805 EA_OnRunMethodRule 1815
EA_OnPreExitInstance 1798 Model Validation Broadcasts,
EA_OnPreNewAttribute 1796 EA_OnRunPackageRule 1813
EA_OnPreNewConnector 1794 Model Validation Broadcasts,
EA_OnRunParameterRule 1816
EA_OnPreNewDiagram 1795
Model Validation Broadcasts,
EA_OnPreNewDiagramObject 1795 EA_OnStartValidation 1812
© 1998-2010 Sparx Systems Pty Ltd
 1882 Index

Add-In Model Security Perrmissions 189

Model Validation Example 1816 Advanced
Post-New Events 1798 Settings, Generalizable Elements 483
Post-New Events, EA_OnPostNewAttribute Tag Management 638
1801 Advanced (Element)
Post-New Events, EA_OnPostNewConnector Submenu 68
1799
Advanced Options
Post-New Events, EA_OnPostNewDiagram RTF Report 1607
1800
Advanced Search Options 1238
Post-New Events,
EA_OnPostNewDiagramObject 1800 Aggregate
Post-New Events, EA_OnPostNewElement Connector 854
1798 Relationship 854
Post-New Events, EA_OnPostNewMethod Aggregation Connector
1801 Change Form 855
Post-New Events, EA_OnPostNewPackage Align
1802 Elements From Toolbar 83
Pre-Deletion Events 1790 Multiple Elements 532
Pre-Deletion Events, EA_OnPreDeleteAttribute Alignment
1791
Submenu 70
Pre-Deletion Events, EA_OnPreDeleteConnector
1792 All User Permissions
Pre-Deletion Events, EA_OnPreDeleteDiagram Dialog, User Security 196
1792 View, User Security 196
Pre-Deletion Events, EA_OnPreDeleteElement Alternate Path
1790 RTF Report Template Section 1585
Pre-Deletion Events, EA_OnPreDeleteMethod Alternate Path, Scenario 490
1791 Alternative Image
Pre-Deletion Events, EA_OnPreDeletePackage For Element 447
1793
In Diagram 447
Pre-New Events 1793 Select 447
Pre-New Events, EA_OnPreNewAttribute 1796
Stereotype 900
Pre-New Events, EA_OnPreNewConnector
Analysis
1794
Elements and Connectors 416
Pre-New Events, EA_OnPreNewDiagram 1795
Group, Toolbox 416
Pre-New Events, EA_OnPreNewDiagramObject
1795 Models, Business Processes 931
Pre-New Events, EA_OnPreNewElement 1793 Stereotypes 835
Pre-New Events, EA_OnPreNewMethod 1797 Analysis Diagram
Pre-New Events, EA_OnPreNewPackage Description 733
1797 Diagram 733
Search Data, XML Format 1782 Elements And Connectors 733
Technology Event, EA_OnInitializeTechnologies Example 733
1803 Analyzer Windows
Technology Events 1803 From the Debug Window 1467
Technology Events, EA_OnDeleteTechnology ANSI C 1349
1806 Modeling Conventions 1285
Technology Events, EA_OnImportTechnology Anti-Aliased Rendering
1806
Of Diagrams 356
Technology Events,
EA_OnPostActivateTechnology 1805 Anti-Aliased Text
Technology Events, In Diagrams 356
EA_OnPreActivateTechnology 1804 Apache Tomcat
Technology Events, EA_OnPreDeleteTechnology Server Configuration 1459
1805 Server, Debugging 1456
Administrator Service Configuration 1460
Enterprise Architect User Guide
 Index 1883

App Object Assembly

Automation Interface 1674 Connector 855
Appearance Debug 1461
Apply From Clipboard 555 Relationship 855
Connectors Context Menu Section 609 Assign
Copy For Element 555 Information to Tagged Values 636
Default, Of Element 538 People To Changes 1566
Element Context Menu 555 People To Defects 1566
Appearance (Element) Tagged Values To Item 635
Autosize 69 Assignments
Submenu 69 BPEL, Create 981
Applets Associate
Java, In Internet Browsers, Debug 1454 Calls With Behaviors 582
Application Connector 855
Connector 414 Invocations With Behaviors 582
Application Look Dialog 101 Relationship 855
Application Workspace 48 Associated Files
Apply Elements 507
Rigorous Security Mode Lock 205 Association
RTF Report Filter (Legacy) 1630 Class 844
Stereotype To Dependency Relationship 862 Connector 855
Stereotype To Element 896 Connector, Set Collection Class 1345
Stereotype To UML Construct 896 Details 626
User Lock 205 Dot On Connector 629
Archimate N-Ary 844
Concept 1073 Properties 626
Diagram 1073 Relationship 855
Disable 1073 Set Derived Property 608
Elements 1073 Specialisation, Set Up 623
Enable 1073 Association Class
MDG Technology 1073 Connector 856
Relationships 1073 Link New Class To Association 857
Toolbox Pages 1073 Relationship 856
Argument Association End
Call, Synchronize With Behavior Parameter Qualifiers 830, 832
582 Asynchronous Signal Message
For Behavioral Parameter 582 Associate With Signal 877
Invocation, Synchronize With Behavior Connector 877
Parameter 582 Relationship 877
Arrange Attach
Connectors 613 Note To Link 612
Arrow Attach To Process Dialog 1472
Quick Linker 474
Attribute
Artifact Add And Delete, Automation Interface Code
Element 810 Example 1769
ASA Add To Element, In-place Editor 592
Data Repository, Connect To 162 Automation Interface, ElementFeatures Package
ODBC Driver, Set Up 141 1727
Repository, Create 132 Collections 562
Upsize To 170 Connect To 611
ASP .NET Constraints 563
Debug 1463 Context Menu, Project Browser 1221

© 1998-2010 Sparx Systems Pty Ltd

 1884 Index

Attribute Automation Interface, ElementFeatures Package

Copy Between Elements 544 1730
Create 558 Audit
Create Fast, Option 1341 Requirements 928
Create Object From 568 Scope 272
Definition 558 Audit History Tab
Delete 560 Description 278
Delete If Not In Code In Reverse Synchronization How To Display 278
1341 On Output Window 102, 1258
Derived 560 Audit Options
Dialog 558 All 273
Dialog, Constraints Tab 563 Connectors Audited 273
Dialog, Detail Tab 562 Core Structural 273
Dialog, General Tab 560 Custom 273
Disconnect From 611 Elements Audited 273
Edit Keyword 590 Maintenance 273
Edit Name, In-Place Editor 588 Audit View
Edit Scope 589 Advanced Mode 276
Edit Stereotype, In-place Editor 588 Audit Changes 276
Fast Create 558 Controls 276
Imported, Default Name Generated From 1341 Custom Time Periods 276
Inherited, Display 567 Deleted Mode 276
Inherited, Show 438 Display Database Changes 276
Introduction 558 Filter By Time 276
Link To Element Via Object 568 Performance Problems 279
Message Part, WSDL 1060 Raw Mode 276
Modify 558 Refresh 276
Move Between Elements 545 Search 276
Multiplicity 562 Slow Loading 279
Of Toolbox Page 1135 Slow Navigation 279
PData & StyleEx, Diagram Profiles 1140 Sort 276
Private, Icon 1213 Standard Mode 276
Properties, Create 565 Auditing
Protected, Icon 1213 Alternative To Differencing 279
Qualifiers 562, 832 And Performance Of Enterprise Architect 270
Redefine Property 562 And RTF Reporting 270
Show On Diagram 438 Audit Tree 274
Stereotyped, For Columns 1019 Display Audit Results 274
Supported, By XML Element Node 914 Enable 272
Supported, Create Composite Elements 1111 How To Invoke 271
Supported, Define Child Diagram Types 1111 Include Reverse Engineering 272
Supported, In UML Profile 914 Include XMI Export 272
Supported, Metatype In Profiles 1108 Include XMI Import 272
Supported, Stereotype In Profiles 1108 Introduction 270
Tagged Values 564 Large Deletion Issue 279
UML Property, isUnique 562 Level, Core 273
Work With, Automation Interface Code Example Level, Extended 273
1773 Level, Standard 273
AttributeConstraint Performance Issues 279
Automation Interface, ElementFeatures Package Quick Start 271
1729 Record Display 274
AttributeTag Reverse Engineering Issue 279

Enterprise Architect User Guide

 Index 1885

Auditing App Object 1674

Settings 271, 272 Attribute, ElementFeatures Package 1727
Use Database Timestamp 272 AttributeConstraint, ElementFeatures Package
View 274 1729
XMI Import Issue 279 AttributeTag, ElementFeatures Package 1730
Auditing Settings Available Resources 1671
Clear Logs 272 Call Executables From Enterprise Architect
Load Logs 272 1666
Save Logs 272 Call From Enterprise Architect 1670
Code Example, Add And Delete Attributes
Authentication
1769
Accept Windows Authentication 191
Code Example, Add And Delete Methods 1769
Automatic Delete On Relocation Of Project
191 Code Example, Add And Manage Diagrams
1768
Author
Code Example, Add And Manage Elements
Attributes 1693 1767
Define 645 Code Example, Add And Manage Packages
From Windows Active Directory 645 1766
Methods 1693 Code Example, Add Connector 1767
Author Collection Code Example, Add Stereotypes 1773
Automation Interface Repository 1693 Code Example, Iterate Through EAP File 1766
Auto Counter Code Example, Open The Repository 1765
Of Elements 525 Code Example, Use Element Extras 1769
Auto Naming Code Example, Use Repository Extras 1772
Of Element 525 Code Example, Work With Attributes 1773
Auto Numbering Code Example, Work With Methods 1774
Of Elements 525 Code Examples, Introduction 1765
Auto Route Diagram Layout 470 Connect From Borland Delphi 7.0 1666
Auto Save Connect From Java 1666
Diagram Changes 359 Connect From MS C# 1666
Autocompletion List Connect From MS Visual Basic 6.0 1666
Code Editor, Common 1432 Connect To 1666
Autohide Connector Package Diagram 1738
Reveal Autohidden Window 78 Connector, Connector Package 1739
Turn Off 78 ConnectorConstraint, Connector Package
Turn On 78 1738
Windows 78 ConnectorEnd, Connector Package 1742
Autolayout ConnectorTag, Connector Package 1744
Diagram 471 ConstLayoutStyles Enum 1675
Options 471 Constraint, Element Package 1710
Automatic CreateBaselineFlag Enum 1676
Save Of Diagram Changes 359 CreateModelType Enum 1676
Automatic Exclusive Edit Lock 189 CustomProperties Collection, ElementFeatures
Automatic Indentation Package 1730
Code Editor, Common 1431 Diagram Package 1745
Automatic Recording Diagram, Diagram Package 1746
Execution Analysis, Recording Sequence DiagramLinks, Diagram Package 1749
Diagrams 1504 DiagramObjects, Diagram Package 1750
Automatically Hidden Windows Effort, Element Package 1710
Animate 59 Element Package Diagram 1708
Automation Element Package, File 1717
Of Enterprise Architect 1659 Element, Element Package 1711
Automation Interface ElementFeatures Package Diagram 1726

© 1998-2010 Sparx Systems Pty Ltd

 1886 Index

Automation Interface ScenarioStep, Element Package 1723

EmbeddedElements Collection, ElementFeatures ScenarioStepType Enum 1679
Package 1731 ScenarioTestType Enum 1679
Enumerations 1675 Set Up Visual Basic 1668
EnumRelationSetType Enum 1676 Swimlane, Diagram Package 1752
Examples 1666 SwimlaneDef, Diagram Package 1751
Examples and Tips 1669 Swimlanes, Diagram Package 1751
ExportPackageXMIFlag Enum 1677 TaggedValue, Element Package 1724
Introduction 1666 Test, Element Package 1725
Issue, Element Package 1718 Transitions Collection, ElementFeatures Package
MDGMenus Enum 1677 1737
Method, ElementFeatures Package 1732 Using 1666
MethodConstraint, ElementFeatures Package VB GetObject Support 1674
1733 XMIType Enum 1679
MethodTag, ElementFeatures Package 1734 Autonumbering
Metric, Element Package 1719 And Requirements 918
Model 1672 Autosize
ObjectType Enum 1677 Element, Single 444
Package 1672 Elements, As Group 444
Parameter, ElementFeatures Package 1735 Available Resources
Partitions Collection, ElementFeatures Package Automation Interface 1671
1736
Project Interface 1753
Project, Project Interface 1753
Properties, ElementFeatures Package 1736
-B-
Property ElementFeatures Package 1736 Base Project
PropType Enum 1678 Copy 121
Reference 1671 New 121
ReloadType Enum 1678 Baseline
Repository 1680 And Differences, Overview 279
Repository Package 1679, 1698 Considerations 280
Repository, Author Collection 1693 Create 282
Repository, Client Collection 1694 Delete 281
Repository, Collection Class 1695 Export 281
Repository, Datatype 1696 Import 281
Repository, EventProperties 1697 Include XMI Stubs 282
Repository, EventProperty 1697 Load From Alternative Model 281
Repository, ModelWatcher 1698 Manage 281
Repository, ProjectIssues 1703 Merge With Current Model, Overview 279
Repository, ProjectResource 1704 Model 280
Repository, PropertyType 1704 Overview 280
Repository, Reference 1705 Requirements 928
Repository, Stereotype 1706 Scenarios 280
Repository, Task 1707 Versions 282
Repository, Term 1708 BaseModel Script
Requirement, Element Package 1719 InnoDB 178
Resource, Element Package 1720 MyISAM 178
Risk, Element Package 1721 Basic Path, Scenario 490
RoleTag, Connector Package 1744 Batch Generate
Scenario, Element Package 1722 Elements With Code 69
ScenarioDiagramType Enum 1678 RTF Resource Documents, Automatically
1606
ScenarioExtension, Element Package 1723
RTF Resource Documents, Manually 1606
Enterprise Architect User Guide
 Index 1887

Batch XMI Insert In RTF Template 1597

Export 298 Multiple Elements 341
Import 298 Package As 1639
Behavior RTF, In Master Document Element 1616
Associate With Calls 582 Selected Element 57
Associate With Invocations 582 Triangle 341
Instance 892 Bookmark Selected
Of Operation, Display In Diagram 573 Menu Option (Edit Menu) 57
Operation, Associate With 573 Border
Parameter, Tagged Values 585 Red 206
Parameters, Define 583 Boundary
Synchronize Call Arguments With Parameters Element 836
582 Element Settings 803
Synchronize Invocation Arguments With Element, Create 836
Parameters 582 Object Settings 803
Behavior Call Properties 803
Actions For RuleTask Operations 943
Box Diagram Layout 463
Interaction Occurrence 581
BPEL
Modeling 581 Assignments, Create 981
Parameter Arguments 582 BPMN Elements Not Mapable 961
Behavioral Diagram Concepts 958
Elements 742 Create Assignments 981
Overview 673 Create Model 959
Behavioral Model Templates 1193 Diagram 958
Behavioral Modeling 569 Disable 958
Behavioral Models End Event, Model 965
Generate Code From 1314 Generate 983
Behavioral Parameter In Enterprise Architect 958
Edit 583 Intermediate Event, Model 968
Extend 583 Looping Constructs 974
Reassign 583 MDG Technology 958
Set 583 Model A Process 961
Behaviors Model Activity 974
Of Activities 581 Model Gateway 972
Of Interactions 581 Model Pool 979
Bend Model Sequence Flow Connector 980
Connector At Cursor 615 Model Validation 984
Bend Connector 32 Model, Create 959
Bezier Lines 615 Modeling Restrictions 958
Binary Module Package Structure 959
Import, Reverse Engineering 1334 Process, Properties 961
Binding Start Event, Model 962
WSDL Diagram 1057 Sub Process Types 974
WSDL Element 1057 Task Types 974
Bitmap Image Validation Violations 984
In Diagrams 447 Web Service, Create 983
Blue Exclamation Mark 206 BPMN
Bookmark 1.0 952
Clear 57 1.1 952
Clear All 57 Change Element Appearance 956
Code Editor, Common 1430 Concepts 952
For RTF Report 1639 Connectors 952
© 1998-2010 Sparx Systems Pty Ltd
 1888 Index

BPMN Browser
Core Toolbox Page 952 Element 510
Diagram 952 Build And Run Submenu
Disable 952 Package Context Menu, Project Browser 1217
Element Appearance, Change 956 Build Script
Elements 952 Create 1444
MDG Technology 952 Deploy Script, Create 1484
Migrate 1.0 Model To 1.1 957 Enable Diagnostic Messages, Sequence
Relationships 952 Diagram Recording Tab 1496
Types Toolbox Page 952 Enable Filter, Sequence Diagram Recording Tab
Update Version Via Toolbox Element 956 1493
Version Differences In Appearance 956 Filters 1493
Limit Auto Recording, Sequence Diagram
BPMN 1.1
Recording Tab 1496
Activity Types 974
Options, Sequence Diagram Recording Tab
BPEL Sequence Flow 980 1492
Elements Not Mappable to BPEL 961 Record Arguments To Function Calls, Sequence
End Event, Types 965 Diagram Recording Tab 1494
Gateway Types 972 Record Calls To Dynamic Modules, Sequence
Intermediate Event, Types 968 Diagram Recording Tab 1495
Pool 979 Record Calls To External Modules, Sequence
Start Event, Types 962 Diagram Recording Tab 1494
Sub-Process Types 974 Recursive 1446
Task Types 974 Run Script, Create 1482
Brace Matching Test Script, Create 1483
Code Editor, Common 1430 Wildcard in Filter 1493
Branching Macros Build Scripts
Code Template Syntax 1190 Introduction 1443
Breakpoint Build Systems Using UML
Delete 1468 Enterprise Architect 5
Difference From Recording Marker 1503 Built-In
Disable 1468 Diagram Types 1140
Enable 1468 Transformations 1388
Failure Message 1468 Business
Management 1468 Scenarios & Requirements 514
Set For Modifiable Data 1470 Business Analyst
Set In Code 1469 And Enterprise Architect 38
States 1468 Project Role 38
Storage 1469 Business and Software Engineering Edition
Breakpoints And Markers Window 1503 Of Enterprise Architect 12
Broadcast Event Business Domain Model
Add-In Model 1787 Create 938
EA_FileClose 1788 Business Interaction Diagram
EA_FileNew 1789 Description 739
EA_FileOpen 1788 Elements And Connectors 739
EA_OnPostCloseDiagram 1789 Example 739
EA_OnPostInitialized 1802 Business Model
EA_OnPostOpenDiagram 1789 Analysis 931
EA_OnPostTransform 1803 Business Modeling
EA_OnPreExitInstance 1798 Business Process Outline 933
EA_OnRetrieveModelTemplate 1820 Events 932
BroadcastSignal Action Example 930
Signal Tab 745 Goals 933

Enterprise Architect User Guide

 Index 1889

Business Modeling Modeling Conventions 1285, 1286

Information 931 Object Oriented Programmiing 1286
Inputs 931 Options 1349
Outputs 932 C#
Process Element 931 Code Generation Language Options 1350
Process Modeling Notation 931 Import, Reverse Engineering 1331
Processes 930 Modeling Conventions 1287
Resources 931 Options 1350
Traceability 1245 Transformation 1389
Business Modeling Diagram C++
Description 739 Code Generation 1351
Elements And Connectors 739 Debug Symbols 1452
Example 739 Implementation Files 1351
Business Process Import, Reverse Engineering 1331
Analysis 374 Language Options 1351
Model, Template 374 Modeling Conventions 1289
Outline 933 Modeling Conventions, CLI Extensions 1291
Business Process Execution Language (BPEL) Modeling Conventions, Managed 1290
958 Set Up Debug Session 1451
Business Process Modeling 733 Calibration
Business Process Modeling Notation (BPMN) 952 Of Project Factors 335
Business Rule Call
Add To Rule Task 945 Associate With Behaviors 582
Create 945 Automation Interface From Enterprise Architect
Element 937 1670
Export To CSV File 945 Re-associate With Behavior 582
Generate Code 951 Self Message 872
Modeling 937 Synchronize Arguments With Behavior
Parameters As Variables 942 Parameters 582
Remove From Rule Task 945 Call Action
Validate 950 Pin As Argument 749
Business Rule Modeling Call Stack
Business Domain Model, Create 938 Copy To Recording History 1482
Business Rules 937 Create Sequence Diagram 1480
Compose Rules 945 Save 1482
Computation Rule Table 945 View 1473
Decision Table 945 Window 1473
Export Rules To CSV File 945 Calltips
Generate Code 951 Code Editor, Common 1432
In Class Operations 943 Camel Case
In RuleTask Actions 937 Naming Format 1422
Overview 934 Cancel
Rule Composer 945 Default Diagram, Model 437
Rule Flow Diagram 939 Validation 64
Rule Model 937 Capture State Changes
Vocabulary 938 Setup To, Visual Execution Analyzer 1508
Cardinality (Multiplicity)
Define 665
-C- CASE Tool
Enterprise Architect 3
C
Category
Code Generation Language Options 1349
Add To Team Review 211
Import, Reverse Engineering 1331
© 1998-2010 Sparx Systems Pty Ltd
 1890 Index

Category Checked In Package

Create 211 Icon 1213
Delete 209 Checked Out Package
Central Buffer Node Icon 1213
Element 758 Child
Chaining Transformations 1388 Confirm Element As Parent 529
Change Child Element
BPMN Element Appearance 956 Paste Object As 430
Connector Source Or Target 614 Choice
Connector Type 614 Element 758
Diagram Type 434 Circle Diagram Layout 459
Element 1563 Class
Element Type 532 Active Classes 812
Elements And Requirements 928 Collection, Set 1345
Form Of Aggregation Connector 855 Created In Transformation, Connect To 1419
Tracking 269, 270 Element 811
Change Conflicts Elements And Connectors 407
Resolve 187 Elements, Imported 1367
Change Element Group, Toolbox 407
Hide Stereotype Letter 1564 Make Into Association Class 857
Show Stereotype Letter 1564 Members, Show/Hide On Diagram 429
Change Management Model Template 376
And Requirements 928 Parameterized Classes (Templates) 813
Auditing 228 Partial 1287
Baselines And Differences 228 Partial, Generate 1311
In Enterprise Architect 228 Reset Options 1361
Introduction 228 Show Realised Interfaces On Diagram 452
Model Transfer 287 Source Code Generation 1308
Project Data Transfer 228 View 383
Tracking Changes 269 Class Diagram
Version Control 228 Description 721
Character Set Edit Elements 68
Set Up For RTF Report 1615 Elements And Connectors 721
Set Up For RTF Report (Legacy) 1637 Example 721
Check CLASSGUID
Data Integrity 344 Add-In Hidden Field 1781
Model Integrity 344 Classifier
Project Integrity 344 Behavior 779
Check Constraint Drop As Link 430
Create 1033 Drop As New Instance 430
What Is A? 1033 Item Conveyed 865
Check In Of Objects 519
Branch 261 Properties 726
Explanation 257 Set 520
Offline Packages 268 Use 520
Packages Online 261 CLASSTYPE
Project Browser Icon 261 Add-In Hidden Field 1781
Check Out Clean
Branch 261 Project 344
Explanation 257 Clear All Bookmarks
Packages Offline 261, 268 Menu Option (Edit Menu) 57
Project Browser Icon 261 Clear Project Clipboard
Enterprise Architect User Guide
 Index 1891

Clear Project Clipboard Key Bindings 1433

Menu Option (Edit Menu) 57 Line Selection 1432
Clear Selection Mouseovers 1432
Menu Option (Edit Menu) 57 Overview 1428
CLI Extensions Scope Guides 1431
C++ Modeling Conventions 1291 Search Facility 1437
Client Syntax Highlighting 1429
Define 651 Tooltips, Debug 1479
Client Collection Zooming 1432
Automation Interface Repository 1694 Code Engineering
Clipboard And MDG Integration 1334
Copy Team Review Path To 218 Broad View Of, In Enterprise Architect 1279
Clipboard File Format Code, Reverse Engineer 1328
Define 351 Eclipse 1334
Close Element Context Menu 554
Full Screen 74 Generate Code For Single Class 1309
Close Project Generate Group of Classes 1311
Menu Option (File Menu) 56 Generate Package 1311
CLR Versions Generate Package Source Code 1311
Debug .NET 1462 Generate Source Code 1308
Code Introduction 1281
Breakpoint, Set 1469 Namespaces 1313
Debug, Step Into Function Calls 1473 Object Lifetimes 1340
Debug, Step Out Of Functions 1473 Package Contents, Update 1313
Debug, Step Over Lines 1472 Referenced XML Schema 1373
Debug, Step Through Function Calls 1480 Reverse Engineer Source Code 1328
Delete From Features In Model In Fwd Settings 1335
Synchronization 1341 Settings, Attribute/Operation Options 1341
Generate For Business Rule 951 Settings, Code Generation
Generated From State Machine 1317 Constructor/Destructor Options 1340
Generation, Toolbar 81 Settings, Code Page for Source Editing 1342
Import, Select Language 81 Settings, General Code Options 1336
Language, Set Default 81 Settings, Import Component Types 1337
Synchronize 1307 Settings, Source Code Options 1336
Code Breakpoint Synchronization 1328
Set 1469 Synchronize Model And Code 1327
Code Editor, Common Synchronize Package Tree 1313
Autocompletion List 1432 UML Profile For XSD 1041
Automatic Indentation 1431 Unicode Character Set 1342
Bookmarks 1430 Update Package Contents 1313
Brace Matching 1430 Visual Studio 1334
Calltips 1432 With Enterprise Architect 1279
Commenting Selections 1431 XML Schema 1039
Configure Search Options 1437 XML Schema (XSD), Default UML To XSD
Context Menu 1437 Mappings 1049
Cursor History 1430 XML Schema, Abstract XSD Models 1047
Customize 1428 XML Schema, Generate XSD 1376
Debug Tooltips 1479 XML Schema, Import XSD 1373
Functions 1428 XML Schema, Model XSD 1040
IME 1437 XSD 1039
Input Method Editor 1437 XSD Datatype Packages 1047
Intellisense 1432 Code Engineering Submenu

© 1998-2010 Sparx Systems Pty Ltd

 1892 Index

Code Engineering Submenu Variables 1200

Package Context Menu, Project Browser 1217 Codepage
Code Generation Set Up For RTF Report 1615
ActionScript Language Options 1348 Set Up For RTF Report (Legacy) 1637
Ada 2005 Language Options 1348 Collaboration
C Language Options 1349 Element 814
C# Language Options 1350 Elements and Connectors, Now Communication
C++ Language Options 1351 409
Delphi Language Options 1352 Message 880
From Activity Diagrams 1314, 1323 Collaboration Diagram
From Behavioral Models 1314 Description 715
From Interaction Diagrams 1314, 1322 Elements And Connectors 715
From Sequence Diagrams 1314, 1322 Example 715
From State Machine Diagrams 1314, 1316 Message Colors 716
Java Language Options 1355 Collaboration Occurrence
Language Options 1347 Element 815
MDG Technology Language Options 1360 Collaborative Development 1343
PHP Language Options 1356 Collection Class
Python Language Options 1356 Automation Interface Repository 1695
SystemC Language Options 1357 Collection Classes
VB.NET Language Options 1358 Set 1345
Verilog Language Options 1358 Collections, EASL
VHDL Language Options 1359 Action 1194
Visual Basic Language Options 1360 Behaviors 1194
Code Language Classifier 1194
Create Properties As Attributes 565 Construct 1194
Code Language Options 1338 Node 1194
Code Module State 1194
Add To MDG Technology 1128 State Machine 1194
Code Sections Transition 1194
Synchronize 1308 Trigger 1194
Code Template Vertex 1194
Base Templates 1302 Color
Custom Templates, Create 1202 Of Communication Messages 366
Default Templates 1204 Color Code External Requirements 920
Editor 1202, 1305 Color Query
Editor, Add New Stereotyped Templates 1205 Shape Scripts 1158
Editor, Create Templates For Custom Languages Column
1206 Create In Data Modeling 1019
Editor, In SDK 1202 Definition 1019
Export 1202 In UML Data Modeling Profile 1019
Framework, In SDK 1172 Order, Change 1019
Framework, Overview 1301 Properties 1019
Import 1202 Sequence Entries 1019
Overview 1302 Stereotyped Attribute 1019
Syntax, Introduction 1172 Unique 1019
Syntax, Literal Text 1172 COM Interop
Syntax, Macros 1173 Debug .NET 1463
Syntax, Template Substitution Macros 1173 COM Object
Code Template Syntax .NET Garbage Collect (Exit Method) 1680
Variable Definitions 1200 Combine
Variable References 1200 Windows In One Frame 76

Enterprise Architect User Guide

 Index 1893

Combined Fragment Data 308

Create 761 DDL With Database 1369
Element 759 Models 308
Interaction Operator 762 Projects, Instructions 308
Comma Separated Value Projects, Why? 308
Export 300, 303 Utility 279, 283
Import 300, 305 Compare Utility
Command Context Menu 285
Deploy, Create 1484 Keyboard Options 285
Deploy, Introduction 1484 Merge Options 285
Run, Create 1482 Options 284
Run, Introduction 1482 Output 284
Unit Test, Create 1483 Tab 284
Unit Test, Introduction 1483 Toolbar 285
Commands Compartment
Add To Toolbar 91 Constraint 521
Change Icon Appearance 91 Element 521
Customize 91 Maintenance 521
Remove From Toolbar 91 Responsibility 521
Commenting Selections Tag 521
Code Editor, Common 1431 Testing 521
Common Compartment Events
Connectors 405 Add-In Model 1809
Elements 405 EA_GetCompartmentData 1810
Group, Toolbox 405 EA_QueryAvailableCompartments 1809
Relationships 405 Compiled August 10 2010 3
Communication Complex Modeling
Connector 859 Enterprise Architect 5
Elements and Connectors 409 Component
Group, Toolbox 409 Description 730
Message 879 Diagram 730
Message, Create 880 Element 816
Message, Level 880 Elements And Connectors 412, 730
Message, Properties 880 Example 730
Message, Sequence 880 Group, Toolbox 412
Relationship 859 Model Template 378
Communication Diagram View 383
Description 715 Compose
Elements And Connectors 715 Connector 858
Example 715 Relationship 858
Labelled Associations 715 Composite
Message Colors 716 Elements 837
Numbering In 715 Elements And Connectors 409
Communication Message Foreign Key 1025
Colors 366 Group, Toolbox 409
Communication Path State 789, 790
Connector 858 State Regions 681
Relationship 858 Composite Aggregation
Community Site 23, 50 Connector 858
Compact Relationship 858
Project .EAP File 348 Composite Element
Compare Paste From Project Browser 431
© 1998-2010 Sparx Systems Pty Ltd
 1894 Index

Composite Elements Objects 610

Metaclass, Create With Supported Attributes To ASA Data Repository 162
1111 To Automation Interface 1666
Composite Structure Diagram To Data Repository 147
Description 724 To Element Feature 611
Elements And Connectors 724 To MSDE Server Data Repository 165
Example 724 To MySQL Data Repository 148
Compress To Oracle 10g Data Repository 153
Timeline 703 To Oracle 11g Data Repository 153
Transition 703 To Oracle 9i Data Repository 153
Computation Rule Table To PostgreSQL Data Repository 160
Business Rule Modeling 945 To Progress OpenEdge Data Repository 165
Concept To SQL Server Data Repository 150
Archimate 1073 Connections
BPEL 958 In Relationships Window 1269
BPMN 952 In Team Review 218
Eriksson-Penker MDG Technology 1080 To Other Team Reviews 218
Mind Mapping 1087 Window 1269
SoaML 1089 Connector
SPEM 1061 Activity Edge 867
SysML 989 Add Between Locked Elements 204
Concurrent Method Calls Add Note 612
In Add-Ins 1779 Add To Diagram 32
Concurrent Substate Add To UML Model, Quick Start 32
Regions 681 Add, Automation Interface Code Example
Conditional Node 1767
Structured Activity 796, 798 Advanced, Menu Section 608
Conditional Substitution Aggregate 854
Field Substitution Macros, Code Template Syntax Appearance 609
1174 Application 414
Configuration Arrange 613
Apache Tomcat Server 1459 Assembly 855
JBOSS Server 1458 Associate 855
Tomcat Server 1459 Association 855
Tomcat Service 1460 Association Class 856
Configure Asynchronous Signal Message 877
Controlled Packages With XMI 295 At Page Boundaries 615
Export To XMI Stubs 295 Automation Interface, Connector Package
Local Options 350 1739
Model Validation 1530 Bend At Cursor 615
Options 350 Bend Connector 32
Package For Version Control 259 BPMN 952
Packages 295 Break Connection To Feature 611
User Registry Settings 350 Change Source Or Target 614
Version Control, Subversion 250 Change Type 614
Configure Timeline Dialog Characteristics, Edit 608
States Tab 697 Communication 859
Transitions Tab 699 Communication Path 858
Confirm Compose 858
Parent Element 529 Composite Aggregation 858
Connect Connect To Element Feature 611
Elements 610 Connector 859

Enterprise Architect User Guide

 Index 1895

Connector Nesting 885

Constraints 628 Notelink 886
Context Menu 606 Notes 641
Control Flow 860 Object Flow 886
Copy Between Instances Of Elements From Occurrence 888
Project Browser 618 Off Page 615
Create Between Elements 618 Off-Page 606
Create From Project Browser 618 Overview 852
Create From Toolbox 399 Package Import 888
Create In MDA-Style Transformation 1419 Package Merge 888
Create With Element Using Quick Linker 475 Page Boundary 615
Create With Quick Linker 476 Pkg Import 888
Create, Same Type As Previous 65 Pkg Merge 888
Custom Properties 550 Precede 406
Custom Properties, Set Value 608 Properties 626
Data Flow 1076 Properties Menu 607
Delegate 861 Realization, Common Diagram 921
Delete 619 Realization, Quick Generation Of 921
Dependency 861 Realize 889
Dependency, Apply Stereotype 862 Recursion 890
Deployment 862 Redefinition 414
Destination Role 631 Relationship 859
Details 626 Representation 891
Direction Indicator 452 Represents 891
Display Options 364 Reverse Direction 623
Duplication In Transformation 1419 Role Binding 890
Edge 615 Role, Context Menu 606
Entity Relationship Diagram 1077 Self-Message 871
Extend 862 Shape Script Properties 1158
Extension (Profile Toolbox) 414 Source Role Properties 629
Generalization 863 Styles 608, 615
Generalize 863 SysML Activity 996
Generalize (Profile Toolbox) 414 SysML Block Definition 992
Hide 619 SysML Interaction 998
Hide/Show 609 SysML Internal Block 994
Implements 889 SysML Model 991
Include 864 SysML Parametric 995
Information Flow 864 SysML Requirement 1001
Inheritance 863 SysML State Machine 999
In-place Editor Options 623 SysML Use Case 1000
Interrupt Flow 867 Tagged Value (Profile Toolbox) 414
Invoke 406 Tagged Value, Use 1101
Labels 452 Tagged Values 631
Labels, Edit 623 Target Role Properties 631
Line Color 353 Tasks 609
List For Requirements 921 To Class Created In Transformation 1419
List, On Context References Tab 506 Trace 892
Locked 204 Transform 1419
Manifest 867 Transition 892
Message 867 Type Specific Menu Section 607
Move 34, 613 Type, Change 614
Multiplicity 629 Usage 894
© 1998-2010 Sparx Systems Pty Ltd
 1896 Index

Connector Pre-Condition, RTF Reporting 1585

Use 894 Profile 1101
Visibility 609, 619, 621 RTF Report Template Sections 1585
What Is A? 852 Status Type, Define 656
Working With 606 Stereotype 1101
Connector Package Supported In UML Profiles 912
Connector, Automation Interface 1739 Synchronize, And Tagged Values 910
ConnectorConstraint, Automation Interface Synchronize, From MDG Toolbox Pages 910
1738 Synchronize, From Resources Window 910
ConnectorEnd, Automation Interface 1742 Tab, Scenario 507
ConnectorTag, Automation Interface 1744 Type, Define 655
RoleTag, Automation Interface 1744 Contents
Connector Package Diagram Table, MS Word, Add 1641
Automation Interface 1738 Contents Submenu
Connector Styles Package Context Menu, Project Browser 1218
Auto Routing 615 Context Diagram 1076
Bezier 615 Context Element
Custom 615 Highlight 543
Direct 615 In Multiple Selection 543
Lateral 615 Context Item Events
Line Style 615 Add-In Model 1807
Set 615 EA_OnContextItemChanged 1807, 1809
Tree Style 615 EA_OnContextItemDoubleClicked 1808
ConnectorConstraint Context Menu
Automation Interface, Connector Package Apply «Stereotype» Option 399, 910
1738 Attribute, Project Browser 1221
ConnectorEnd Code Editor, Common 1437
Automation Interface, Connector Package Configure Code Editor Search Options 1437
1742
Connector 606
ConnectorTag
Connector Label 452
Automation Interface, Connector Package
1744 Connector Role 606
Console Diagram 394
Commands, Scripter Window 1663 Diagram, Project Browser 1220
Tab, Scripter Window 1663 Element 547
Constant Element Label 452
Custom, For RTF Reports 1614 Element, Add Supporting Diagrams and
Elements 550
ConstLayoutStyles Enum
Element, Multiple Selection 557
Automation Interface 1675
Element, Project Browser 1218
Constraint
Item, Structural Specification 496
Automation Interface, Element Package 1710
Linked Document Editor 600
Compartment, Element 521
Main 54
Delete 563
Method, Project Browser 1221
Element 488
Model Views 1224
In Connector 628
Model, Project Browser 1213
In Scenarios & Requirements Window 514
New Element Or Connector 395
Inherited, Show 438
Operation, Project Browser 1221
Internal, Import As Test 1547
Package, Project Browser 1214
Note, Element 785
Project Browser 1213
Of Attributes, Create 563
Scripter Window 1661
Post Condition On Actions 752
Selected Text, Structural Specification 497
Post-Condition, RTF Reporting 1585
Structural Specification Entry Points 498
Precondition On Actions 752
Enterprise Architect User Guide
 Index 1897

Context Menu Maintenance Item Between Categories 1561

Team Review Options 209 Model 115, 116, 117
Context Reference Operations Between Elements 544
Add Comments, On Context References Tab Package 388
506 Packages Between Projects 309
Add, On Context References Tab 506 RTF Bookmark To Clipboard 1216, 1220
Delete, On Context References Tab 506 Test Between Categories 1544
List, On Context References Tab 506 UML Diagram, Deep 436
Tab 506 UML Diagram, Shallow 436
Continuation Copyright Notice 16
Element 792 CORBA
Control MDG Technology For, Enterprise Architect
Create 838 1073
Element 838 Co-Region Notation 868
Control Flow Corporate Edition
Connector 860 Of Enterprise Architect 12
Guard 860 Correct Spell Checked Words 1553
Relationship 860 Corrupt EAP file 348
Weight 860 Create
Control Macros A Project In Enterprise Architect 28
Code Template Syntax 1190 Access 2007 Repository 123
Control Recording Activity, BPEL 974
Execution Analysis, Recording Sequence Adaptive Server Anywhere Repository 132
Diagrams 1504 Add-In 1777
Controlled Package 259 Attribute Properties 565
Batch Export To XMI 298 Baselines 282
Batch Import From XMI 298 Boundary Element 836
Disconnect 296 BPEL Assignments 981
Load 297 BPEL Model 959
Menu, XMI 294 BPEL Web Service 983
Recovery 299 Build Script 1444
Version Control 299 Check Constraint 1033
With XMI 293 Columns In Data Modeling 1019
Converge Diagram Layout 467 Combined Fragment 761
Convert Communication Messages 880
Linked Element To Local Copy 544 Connector With Quick Linker 476
Names In MDA Transformations 1422 Control Element 838
CONVERT_DB_TYPE 1421 Custom Diagram Background, Image Manager
CONVERT_NAMES 1422 448
CONVERT_TYPE 1421 Custom Tagged Values 1171
Convey Custom View, Add-In Model 1821
Information Item 865 Data Repository 123
Copy Design Master, Replication 185
Attributes Between Elements 544 Diagram 422
Base Project 121 Diagram From Linked Document 602
Diagram Image To Clipboard 436 Diagram, Automatically 387
Diagram Image To Disk File 435 Document Artifact 599
Diagram, Deep 436 Documents 1568
Diagram, Shallow 436 Element And Connector With Quick Linker 475
Element Between Packages 531 Element From Linked Document 602
Element On Diagram 433 Element From Maintenance Item 1561
Elements Between Diagrams 34 Element In Diagram 523

© 1998-2010 Sparx Systems Pty Ltd

 1898 Index

Create Sorted Lookup Table 1033

Element On Diagram From Project Browser SQL Server Repository 126
430 Start Event, BPEL 962
Element Template 542 Structured Tagged Values 1168
Elements 523 Table in Data Modeling 1013
End Event, BPEL 965 Tasks Pane Profiles 1141
Entity 839 Team Review Category 211
Favorites Folder, Model View 1223 Team Review Topic 212
Favorites Folder, Model View (Context Menu) Text 536
1224 Timing Diagram 692
Foreign Key 1025 Timing Message 883
Gateway, BPEL 972 Toolbox Profile For MDG Technology 1134
Hidden Submenu In Toolbox Profile 1135 Trigger Operation 1033
HTML Report 1647 UML Diagram 422
Index (Data Modeling) 1033 UML Pattern 902
Intermediate Event, BPEL 968 Unique Constraint 1033
Link Between Elements 618 View, Data Modeling 1032
Linked Document Template 603 Views Folder, Model View 1223
Masked Tagged Values 1171 Views Folder, Model View (Context Menu)
MDG Technologies, Overview 1118 1224
Model 120 Views, Model View 1223
MSDE Server Repository 134 Views, Model View (Context Menu) 1224
MySQL Repository 123 Create Property Implementation Dialog 565
Notes 536 CreateBaselineFlag Enum
Oracle 10g Server Repository 129 Automation Interface 1676
Oracle 11g Server Repository 129 CreateModelType Enum
Oracle 9i Server Repository 129 Automation Interface 1676
Pattern 902 Cross Reference
Pool, BPEL 979 Between EMX Files 291
Post In Team Review 213 Delete 527
PostgreSQL Repository 129 Set For Element 527
Primary Key 1022 Trace With Traceability Window 1253
Primary Key Name Template 1022 Use In Element 527
Profiles 1095 CSV
Progress OpenEdge Repository 134 Export 300, 303
Project 120 Export From Relationship Matrix 1267
Project File 112 Export From Rule Composer 945
Reference Data Tagged Values 1170 Export State Machine Table To 690
Relationship Using Matrix 1266 Import 300, 305
Replicas 185 Import Requirement Hierarchies 922
Requirements 918 Import Requirements 922
Rich Text Format Report (Enhanced Generator) Preserve Hierarchy 300
1570 Specifications 300
Root Node, Model View 1223
CTF
Root Node, Model View (Context Menu) 1224 In SDK 1172
RTF Report (Enhanced Generator) 1570 Overview 1301
RTF Style Template 1576
Current Connector
RTF Style Template (Legacy) 1634 Toolbar 84
Search Definition 1239
Current Element
Sequence Flow, BPEL 980 Toolbar 84
Slideshow, Model View 1223
Cursor History
Slideshow, Model Views 1228 Code Editor, Common 1430

Enterprise Architect User Guide

 Index 1899

Custom Automation Interface, ElementFeatures Package

Diagram 736, 737, 738 1730
Diagram Types 1139 Cut And Paste
Elements and Connectors 417 Elements Between Diagrams 34
Group, Toolbox 417 CVS
Stereotypes 1093 Remote Repository 240
Custom Background Version Control Options 240, 244
Create For Diagram, Image Manager 448 Version Control With Local Repositories 244
Custom Diagram
Description 734
Elements And Connectors 734
-D-
Example 734 Dashed Border
Model 734 On Element 529
Custom Language Data
Create Templates For In Code Template Editor Breakpoint, Set 1470
1206
Compare 308
Settings, RTF Report Generation 1615
Export 223
Custom Properties Import 225
Dialog 550
Integrity 344
For Connectors 550
Integrity Check 344
For Elements 550
Integrity, Run SQL Patches 346
Custom Reference Model Template 377
Delete 527
Data Breakpoint
Set For Element 527
Set 1470
Trace With Traceability Window 1253
Data Distribution Service
Use In Element 527
MDG Technology For, Enterprise Architect
Custom Tagged Values 1073
Create 1171 Data Flow
Custom Template Concepts 1076
Create From Project 120 Connector 1076
Custom Tools Context Diagram 1076
External Applications 96 Diagram 1076
Custom View MDG Technology 1076
Add-In Model 1820 Relationship 1076
Customize Toolbox Page 1076
Commands 90, 91 Data Management
Diagram Appearance 423 Project Compare 71
Dialog 90 Project Integrity 71
External Tools, Pass Parameters To 97 Project Transfer 71
Keyboard 90 Submenu (Tools Menu) 71
Keyboard Shortcuts 98 Data Model
Menu Appearance 100 To ERD Transformation, MDA-Style Transform
Menus 90 1390
Options 90 Transformation From Entity Relationship
RTF Language 1615 Diagram 1399
RTF Language (Legacy) 1637 Transformation To Entity Relationship Diagram
Toolbar Option Appearance 101 1390
Toolbars 90, 92 Data Modeling
Tools 90, 94 Advanced Processes 1031
Visibility Of Elements 535 Check Constraint 1033
Window 90 Compare DDL With Database 1369
Create Columns 1019
CustomProperties Collection
© 1998-2010 Sparx Systems Pty Ltd
 1900 Index

Data Modeling Data Type

Create Table 1013 Add 666
Data Model Diagram 1013 Code 666
Data Type Conversion Procedures 1035 Conversion Procedures 1035
DBMS Conversion Procedure Package 1036 DBMS 1037
DBMS Data Types 1037 Definition 293
DDL, Generate 1367 Delete 666
Elements And Connectors 421 Element 817
Foreign Keys 1024 Extend 666
Generate DDL 1367 Instance 817
Generate DDL For A Package 1369 Modify 666
Group, Toolbox 421 Programming Language 666
Index 1033 Referenced 817
Introduction 1011 Database
Primary Key Extended Properties 1024 Compare Package DDL With 1369
Primary Key, Create 1022 Default 1337
Profile (UML) 1011 Design 1011
Set MySQL Table Type 1016 Keys 1011
Set Oracle Table Properties 1017 Model Template 377
Set Schema Owner 1016 Modeling 1011
Set Table Owner 1016 Schema, Import Of 1011
Set Table Properties 1014 Set Default 81
Sorted Lookup Table 1033 Supported Types 1011
Stored Procedure 1030 View, Report On 1032
Trigger Operation 1033 Database Administrator
Typical Tasks 1011 And Enterprise Architect 47
Unique Constraint 1033 Project Role 47
Data Repository Database Engineering
Adaptive Server Anywhere, Connect To 162 Introduction 1363
Connect To 112, 147 Submenu (Project Menu) 63
Create 123 Database Modeling
MSDE Server, Connect To 165 Enterprise Architect 5
MySQL, Connect To 148 Database Operation Properties
Oracle 10g, Connect To 153 Dialog 1024
Oracle 11g, Connect To 153 Database Repository
Oracle 9i, Connect To 153 Access Permissions For 122
Oracle, Connect Via ODBC 153 Connect To 122
Oracle, Connect Via OLE DB 153 Create 122
PostgreSQL, Connect To 160 Set Up 122
Progress OpenEdge, Connect To 165 Database Schema
SQL Server, Connect To 150 Description 739
Data Source Diagram 739
Select 1365 Elements And Connectors 739
Data Store Example 739
Element (Data Flow Diagram) 1076 Database Table
Data Transfer Select From ODBC Data Source 1366
Between Repositories 306 Datastore
Compare Projects, Instructions 308 Element, Activity Diagram 764
Compare Projects, Why? 308 Datatype
Copy Packages Between Projects 309 Automation Interface Repository 1696
Transfer Project Data 307 DBMS
Upsize to MySQL 178 Conversion Procedures 1035
Enterprise Architect User Guide
 Index 1901

DBMS Step Out Of Functions 1473

Data Type Conversion Procedures 1035 Step Over Lines Of Code 1472
DBMS Conversion Step Through Function Calls 1480
Mapper 1036 Tooltips In Code Editor 1479
Procedure 1036 Under Windows Vista 1447
Table Conversion Between DBMS Types 1036 Unit Test Script, Create 1483
DDL Unit Test Script, Introduction 1483
Compare With Database 1369 View Call Stack 1473
Data Modeling 1367 View Local Variables 1474
Default Script Editor 1337 View Local Variables, Long Values 1474
Display In Source Code Viewer 1441 View Variables In Other Scopes 1475
Generate 1367 WINE Applications 1450
Generate For Package 1369 Debug Session
Generate For Table 1367 Debug C++ 1451
Import Schema From ODBC 1363 Java, Attach To VM 1454
Schema, Import From ODBC 1363 Microsoft Native Setup 1451
Scripts And Generated Tables 1011 Set Up 1447
Transformation 1393 Set Up For .NET 1461
DDS Set Up For Microsoft Native 1451
MDG Technology For, Enterprise Architect Start 1471
1073 Stop 1471
Debug Debug Symbols
.NET 1447, 1460 Debug C++ 1452
.NET Assembly 1461 Microsoft Native 1452
.NET CLR Versions 1462 Debugger
.NET With COM Interop Process 1463 Actions 1446
Another .NET Process 1472 Debug Another Process 1472
ASP .NET 1463 Detatch From Process 1472
Break On Variable Changing Value 1477 Execution Analysis 1490
Create Sequence Diagram, Call Stack 1480 Frameworks 1446
Deploy Script, Create New 1484 How It Works 1446
Deploy Script, Introduction 1484 Introduction 1446
Enterprise Architect 5 On Windows 7 And Windows Vista 1448
File Search, Introduction 1485 Overview 1446
File Search, Use 1485 Process 1446
Inspect Process Memory 1476 Start 1471
Java 1447, 1452 Stop 1471
Java Applets In Internet Browsers 1454 System Requirements 1447
Java Web Servers 1456, 1460 Debugger Windows
Java, Advanced Techniques 1454 From the Debug Window 1467
Java, General Setup 1453 Debugging Actions 1470
On Windows 7 And Windows Vista 1448 Decision
Platforms 1447 Element 765
Recording Actions 1480 Decision Table
Run Script, Create New 1482 Business Rule Modeling 945
Run Script, Introduction 1482 Rule Action Section 945
Save Call Stack 1482 Rule Binding Section 945
Script Search 1485 Rule Condition Section 945
Search Window 1485 Deep Copy
Show Loaded Modules 1478 Of Diagram 436
Show Output 1478 Deep History 777
Step Into Function Calls 1473 Convert From Shallow History 549
© 1998-2010 Sparx Systems Pty Ltd
 1902 Index

Default Author 645

Code Language, Set 81 Browser Behavior 351
Database 1337 Clients 651
Database, Set 81 Clipboard Image File Format 351
DDL Script Editor 1337 Email Exchange Server 351
Hours 340 File Directory 351
Model Diagram, Cancel 65 Foreign Key Name Template 1028
Model Diagram, Set 65 Home Web Site 351
Project Browser Behavior 1210 Internet Search Engine 351
Templates 1204 Resources 650
UML To XSD Mappings 1049 Roles 648
User Diagram, Cancel 65 Run-Time Variable 824
User Diagram, Set 65 Stereotype As Metatype 1109
Default Appearance Stereotype Constraints 1101
Background Color 538 Tasks Pane Contexts 1144
Border Color 538 Tasks Pane Toolbox 1141
Border Thickness 538 Validation Configuration For MDG Technology
Font Color 538 1145
Of An Element 555 Define Menu Items
Of Element 538 Create Add-In 1777
Set For Profile Stereotype Objects 1106 Defined Environment Types 337
Default Diagram Delegate
Model, Cancel 65 Connector 861
Model, Cancel For 437 Relationship 861
Model, Set 65 Delete
Model, Set For 437 Category In Team Review 215
User, Cancel 65 Connectors 619
User, Set 65 Connectors, Quick Start 35
Default Fonts Diagram (Single) From Project Browser 1220
Model 357 Diagrams (Multiple) From Project Browser
Set 357 1220
User 357 Diagrams From Project browser 434
Diagrams, Quick Start 35
Default Hours
Estimation 340 Element Changes 1559
Per Adjusted Use Case Point 340 Element Defects 1559
Project Management 340 Element From Diagram 534
Rate 340 Element from Model 534
Settings 340 Element From Project Browser 534
Element Issues 1559
Default Settings
Options Dialog 90 Element Tasks 1559
Elements, Impact of Auditing 279
Default Templates
Override in Code Template Editor 1204 Elements, Quick Start 35
Instance Variable 824
Default Toolbox
Override In Profile 1136 Item In Team Review 215
Line Points 615
Default Tools Toolbar 80
Linked Document 602
Defect
Add 1563 Linked Document Template 603
Create From Test Item 1548 Locks 200
Element 1563 Menu Options 100
Hide Stereotype Letter 1563 Package Attributes From Model Document
1621
Show Stereotype Letter 1563
Package In Project Browser 390
Define
Enterprise Architect User Guide
 Index 1903

Delete View 383

Packages From Model Document 1621 Deployment and Rollout
Packages, Quick Start 35 And Enterprise Architect 45
Post In Team Review 215 Project Role 45
Project Task 330 Deployment Diagram
Relationship 489 Description 727
Relationship Using Matrix 1266 Elements And Connectors 727
Reply In Team Review 215 Example 727
RTF Style Template 1576 Deployment Spec
Team Review Category 209 Element 818
Team Review Post 209 Derived
Team Review Resource 209 Attribute 560
Team Review Topic 209 Symbol 560
Topic In Team Review 215 Design
Views 385 Patterns 901
Delete Selected Element(s) Design Master 184, 347
Menu Option (Edit Menu) 57 Create, Replication 185
Deletion Design Systems Using UML
And Auditing 279 Enterprise Architect 5
Delphi Designate Driving Triggers
Code Generation 1352 Model State Machine For HDL 1319
Import, Reverse Engineering 1331 Desktop Edition
Language Options 1352 Of Enterprise Architect 12
Limitations 1353 Upsize From 122
Modeling Conventions 1292 Desktop Tools
Properties 1353 Add 94
Demonstration Configure 94
Of Enterprise Architect 48 Customize 94
Dependency Destination Role 631
Connector 861 Developer
Relationship 861 And Enterprise Architect 42
Relationship, Apply Stereotype 862 Forward Engineering 42
Report 1624 Project Role 42
Dependency Report Reverse Engineering 42
In Traceability 1251 Round-Trip Engineering 42
Deploy Visualise Package Arrangement 42
Add-In 1778 Device
MDG Technology From Add-In 1146 Element 818
MDG Technology From File 1146 Diagram
Deploy Command Activity, Description 674
Create 1484 Activity, Generate From Scenarios 500
Introduction 1484 Add And Manage, Automation Interface Code
Deploy Script Example 1768
Create 1484 Add Elements Via Context Menu 395
Introduction 1484 Add Link To Team Review Post 216
Deployment Add Profile Feature 909
Connector 862 Add Profile Object 909
Diagram 727 Add To Project 422
Elements and Connectors 413 Add To UML Model, Quick Start 30
Group, Toolbox 413 Alias 425
Model Template 378 Alternative Image For Element 447
Relationship 862 Analysis 733
© 1998-2010 Sparx Systems Pty Ltd
 1904 Index

Diagram Create Custom Background, Image Manager

Anti-Aliased Rendering 356 448
Anti-Aliased Text 356 Create From Linked Document 602
Appearance Options 356 Create Using Image Library 449
Appearance Options, Connectors 428 Creator 424
Appearance Options, Diagram Tab 425 Custom 734, 736, 737, 738
Appearance Options, Element 426 Customize Appearance 423
Appearance Options, Features 427 Data Flow 1076
Appearance Options, General 424 Data Model, Example 1013
Appearance Options, Set 423 Database Schema 377, 739
Appearance Options, Visible Class Members Define Child Type, Supported Attributes 1111
429 Delete (Multiple) From Project Browser 434
Archimate 1073 Delete (Single) From Project Browser 434
Attribute Details, Show 427 Delete Element From 534
Auto Route Layout 470 Delete From Project Browser 1220
Automatic Layout 471 Delete Multiple Elements From 534
Automatic Save 359 Deployment 727
Automation Interface, Diagram Package 1746 Details Note 425, 440
Background Color 353 Diagram 835, 838, 839
Background Color Gradient 356 Diagram To Package 30
Behavior Options 359 Digraph Layout 465
Behavioral, Overview 673 Display Options 355
Box Layout 463 Diverge Layout 467
BPEL 958 Divide Between Pages In RTF Reprt 425
BPMN 952 Drag & Drop Elements From Project Browser
Build 396 430
Business Interaction 739 Drag Existing Package Onto 389
Business Modeling 739 Duplicate 436
Business Process 374 Element Appearance Options 426
Cancel Model Default 437 Element Compartments, Show/Hide 426
Center-Focussed Layout 459 Element Icons 521
Change Type 434 Element Stereotypes, Show 426
Circular Layout 459 Element, Copy 433
Class 376, 721 Element, Paste 433
Class Features, Visibility 355 Elliptical Layout 459
Close 396 Entity Relationship 1077
Collaboration 715 Eriksson-Penker 1080
Communication 715 Exclusive Edit Lock 189
Component 378, 730 Extended 673
Composite Structure 724 Extended UML 733
Connector Appearance Options 428 Fan Relations Layout 469
Connector Notation, Show 428 Feature Return Types, Show 427
Context 1076 Feature Stereotypes, Show 427
Context Menu 394 Features Appearance Options 427
Context Menu, Project Browser 1220 Filter Display Of Elements 1271, 1272
Converge Layout 467 Find In Project Browser 65, 67
Copy Image 65 Find Related Elements 433
Copy, Deep 436 Frame 355, 766
Copy, Shallow 436 Frame (Border) 766
Create 422 Generate From Scenarios 499
Create Automatically 387 Hyperlink 766
Hyperlink To 842

Enterprise Architect User Guide

 Index 1905

Diagram Properties Dialog - General Tab 424

Increase Display Size 356, 391 Properties Dialog, Visible Class Members, 429
Interaction 690, 706, 715, 717 Properties Note, Add 440
Interaction Overview 717 Properties, Set 423
Layout Options 471 Property Strings, Show 428
Layout Tool 458 Qualifiers, Show 427
Layout, Move Sections 454 Redo Last Action 458
Legend 441 Reference 766
Lock, General 65 Relationship Traceability For 1253
Lock, Require User Lock 205 Relationships, Show 428
Lock, Security Off 457 Rename 434
Lock, User/Group Lock 204 Requirements 374, 736
Logical 721 Robustness 706, 715, 733, 835, 836, 838, 839
Maintenance 737 Robustness, Generate From Scenarios 504
Make All Elements Selectable 394 Rotate Image In RTF Report 425
Make Model Default 437 RTF Document Options 425, 1571
Manage Display 396 RTF Report On Elements Linked From Other
Managing 421 Packages 1571
MDG Technology 673 Rule Model 937
Menu 65 RuleFlow, Generate From Scenarios 501
Mind Mapping 1087 Save 65, 394
Modeling With 391 Save As Pattern 902
Move Elements 529 Save Automatically 359
Move Sections 454 Save Image Of 65
Move, Impact On Element 34, 765, 772, 778 Save Profile 1107
Navigation And Selection Hotkeys 435 Scale View 356
Neaten Layout 467 Schema Diagram 739
Note 440 Scroll Through From Diagram Toolbar 83
Notes 424 Sequence 706
Notes, Show/Hide 355 Sequence, Generate From Scenarios 503
Object 723 Set Page Size 455
Open From Shortcut 115, 117 Show As Element List 394
Open From Shortcut (Direct Definition) 116 Show Element List As 1258
Open Package In 438 Show Realised Interfaces For Class 452
Overview 673 Show/Hide Package Contents 389
Package 720 Slideshow, Model View 1222, 1228
Page Setup 355 SoaML 1089
Pan And Zoom 1275 SPEM 1062
Parametric, SysML 1002 Spring Layout 466
Paste 436 Stae Machine, Generate From Scenarios 501
Per Page Layout 464 State 678
Place Related Elements On Current 433 State Machine 678
Print From Project Browser 1220 Stereotype 424
Print Page Footer 425 Structural, Overview 719
Print Page Header 425 Swimlanes 450
Profile Attributes, PData and StyleEx 1140 Swimlanes Matrix 444
Profiles 1139 Switch 396
Properties (Diagram Menu) 65 Synchronize With Scenario Steps 499
Properties Dialog - Connectors Tab 428 SysML 989
Properties Dialog - Diagram Tab 425 SysML, Parametric 1002
Properties Dialog - Elements Tab 426 Tab Context Menu 397
Properties Dialog - Features Tab 427 Table Owner, Show 426
© 1998-2010 Sparx Systems Pty Ltd
 1906 Index

Diagram Diagram Note

Tabs 397 Insert New From Toolbar 83
Tasks, General 421 Diagram Only Report 1625
Timing 690 Diagram Package
Toolbar 83 Automation Interface 1745
Traceability 1250 Diagram, Automation Interface 1746
Types 673 DiagramLinks, Automation Interface 1749
Types, Built In 1140 DiagramObjects, Automation Interface 1750
Types, Custom 1139 Swimlane, Automation Interface 1752
UML 673 SwimlaneDef, Automation Interface 1751
Undo Last Action 458 Diagram Type
Use Case 375, 676 Add To MDG Technology 1124
User Interface 738 DiagramLinks
User Interface Design 734 Automation Interface, Diagram Package 1749
Version 424 DiagramObjects
View 396 Automation Interface, Diagram Package 1750
View Next 455 Dialog
View Previous 455 All User Permissions 196
Visibility Indicators 427 Application Look 101
Water Mark 356 Attach To Process 1472
What Is A? 673 Audit Settings 271
Working With 391 Create Property Implementation 565
WSDL Binding 1057 Database Operation Properties 1024
WSDL Message 1056 Difference 274
WSDL Overview 1051 General Types 653
WSDL Port Type 1056 Group Properties (Script) 1663
WSDL Service 1054 Maintenance 660
WSDL Types 1051 New Action 745
Z Order Elements 437 Options 350
Zoom From Diagram Toolbar 83 Package Control Options 295
Diagram Caption Bar Paste Element 430
Hide 59 People 645
Show 59 Project Issues 331
Diagram Filters Qualifiers 832
Access 1272 Recent Post Options 1224
Application 1271 Select <Item> 515
Clear Effect Of 1272 Select Attribute Type 560
Create 1272 Select Property 517
Delete 1272 Set Attribute 748
Disable 1272 Set Feature 748
Enable 1272 Set Operation 748
Introduction 1271 Slideshow Properties 1228
Set Effect Of 1272 String Viewer 1474
Suggested Use 1271 UML Types 662
Window 1272 Version Control Settings 234
Diagram Frame 766 DIB Data Access Violation 1450
Diagram Gate Dictionary
Element 767 User (Spell Checker) 1553
Diagram Image Diff Utility 279, 283
Copy To Clipboard 436 Differencing
Copy To Disk File 435 Facility 283
Save To Disk File 435 Output 284
Enterprise Architect User Guide
 Index 1907

Differencing Replication 183

With Baselines 279, 283 XMI Import/Export 183
Digraph Diagram Layout 465 Diverge Diagram Layout 467
Direct Substitution Dock
Field Substitution Macros, Code Template Syntax Two Elements 555
1174 Dock Windows
Direction Indicator Navigation Compass 76
Connector Label 452 Dockable
Directory Structure Element Option 555
Import, Reverse Engineering 1332 Windows 75
Disable Docked Windows
Add-Ins 1781 For Requirements 927
Archimate 1073 Document
BPEL 958 Enterprise Architect Content 1568
BPMN 952 Exclude Packages 1568
Data Flow Diagrams 1076 HTML 1568
Entity Relationship Diagram 1077 Linking 597
Eriksson-Penker MDG Technology 1080 Projects 1568
Gang Of Four Pattern Technology 1083 Resource, RTF Generator (Enhanced) 1606
GoF Pattern Technology 1083 Rich Text Format 1568
ICONIX 1084 RTF 1568
MDG Technologies 1069 Single Element, RTF (Legacy) 1629
Mind Mapping 1087 WSDL Element 1053
Security 189 Document Artifact
SoaML 1089 Element 597, 819
SPEM 1061 Link Into RTF Report 597, 1579
SysML 989 Document Generation
Disable Recording Markers 1503 Enterprise Architect 5
Disconnect Document Options
Controlled Package 296 RTF Generator, From Diagram (Enhanced)
Discussion Forum 1571
Now Team Review 208 RTF Generator, From Diagram (Legacy) 1571
Display RTF Report 1607
Attributes, Inherited 438 Documentation
Connector Properties, Shape Scripts 1158 Elements 1616
Constraints, Inherited 438 Generate, Project Browser Option 1212
Element Properties, Shape Scripts 1158 Group, Toolbox 1616
Full Screen 74 HTML 1647
Inherited Attributes 567 Rich Text Format 1569
Inherited Operation 579 RTF 1569
Operations, Inherited 438 Documentation (Reports)
Requirements, Inherited 438 Submenu (Project Menu) 61
Tagged Values, Inherited 438 Documentation Submenu
Display Options Package Context Menu, Project Browser 1216
Connector 364 Reports 1216
Diagram 355 DoDAF-MODAF
Element 362 MDG Technology For, Enterprise Architect
Link 364 1073
Relationship 364 Domain
Display Size Model Template 376
Diagram, Increase 356 Organizational Relationships 376
Distributed Development Physical Units 376

© 1998-2010 Sparx Systems Pty Ltd

 1908 Index

Domain Compartment Events, Add-In Model 1810

Structure 376 EA_GetMenuItems
DOORS, Telelogic Add-In Event 1783
MDG Link For, Enterprise Architect 1073 EA_GetMenuState
Dot Add-In Event 1784
On Association 629 EA_MenuClick
Download Add-In Event 1785
Gang Of Four Patterns 904 EA_OnContextItemChanged
GoF Patterns 904 Context Item Events, Add-In Model 1807
Drag EA_OnContextItemDoubleClicked
Element From Project Browser Onto Diagram Context Item Events, Add-In Model 1808
430 EA_OnDeleteTechnology
Objects From Project Browser Onto Diagram Technology Events, Add-In Model 1806
430
EA_OnEndValidation
Drawing Methods Model Validation Broadcasts, Add-In Model
Shape Scripts 1154 1813
Drop EA_OnImportTechnology
Classifiers As Links 430 Technology Events, Add-In Model 1806
Classifiers As New Instances 430 EA_OnInitializeTechnologies
Elements From Project Browser Onto Diagram Technology Events, Add-In Model 1803
430
EA_OnInitializeUserRules
Objects From Project Browser Onto Diagram Model Validation Broadcasts, Add-In Model
430 1812
DTD EA_OnNotifyContextItemModified
Validate XMI Import/Export 293 Context Item Events, Add-In Model 1809
Duplicate EA_OnOutputItemClicked
Diagram 436 Add-In Event 1785
Element 531
EA_OnOutputItemDoubleClicked
Package 388 Add-In Event 1786
UML Diagram 436
EA_OnPostActivateTechnology
Duration Technology Events, Add-In Model 1805
Constraint 874
EA_OnPostCloseDiagram
Constraint Between Messages 874 Broadcast Events, Add-In Model 1789
Observation 874
EA_OnPostInitialized
Dynamic View 383 Broadcast Events, Add-In Model 1802
Dynamic Visual Filters 1271 EA_OnPostNewAttribute
Post-New Events, Add-In Model 1801
-E- EA_OnPostNewConnector
Post-New Events, Add-In Model 1799
EA EA_OnPostNewDiagram
Execution Analyzer, Introduction 1489 Post-New Events, Add-In Model 1800
EA_Connect EA_OnPostNewDiagramObject
Add-In Event 1782 Post-New Events, Add-In Model 1800
EA_Disconnect EA_OnPostNewElement
Add-In Event 1783 Post-New Events, Add-In Model 1798
EA_FileClose EA_OnPostNewMethod
Broadcast Events, Add-In Model 1788 Post-New Events, Add-In Model 1801
EA_FileNew EA_OnPostNewPackage
Broadcast Events, Add-In Model 1789 Post-New Events, Add-In Model 1802
EA_FileOpen EA_OnPostOpenDiagram
Broadcast Events, Add-In Model 1788 Broadcast Events, Add-In Model 1789
EA_GetCompartmentData EA_OnPostTransform

Enterprise Architect User Guide

 Index 1909

EA_OnPostTransform Model Validation Broadcasts, Add-In Model

Broadcast Events, Add-In Model 1803 1813
EA_OnPreActivateTechnology EA_OnRunParameterRule
Technology Events, Add-In Model 1804 Model Validation Broadcasts, Add-In Model
1816
EA_OnPreDeleteAttribute
Pre-Deletion Events, Add-In Model 1791 EA_OnStartValidation
Model Validation Broadcasts, Add-In Model
EA_OnPreDeleteConnector
1812
Pre-Deletion Events, Add-In Model 1792
EA_QueryAvailableCompartments
EA_OnPreDeleteDiagram
Compartment Events, Add-In Model 1809
Pre-Deletion Events, Add-In Model 1792
EA_ShowHelp
EA_OnPreDeleteElement
Add-In Event 1787
Pre-Deletion Events, Add-In Model 1790
EAB File
EA_OnPreDeleteMethod
Export 264
Pre-Deletion Events, Add-In Model 1791
Import 265
EA_OnPreDeletePackage
Model Branch File 264
Pre-Deletion Events, Add-In Model 1793
EABase
EA_OnPreDeleteTechnology
As Source 121
Technology Events, Add-In Model 1805
Project 27
EA_OnPreExitInstance
Project File 120
Broadcast Events, Add-In Model 1798
EAExample File 114
EA_OnPreNewAttribute
EAP File
Pre-New Events, Add-In Model 1796
As Project Database 112
EA_OnPreNewConnector
Corrupt 348
Pre-New Events, Add-In Model 1794
Iterate Through, Automation Interface Code
EA_OnPreNewDiagram Example 1766
Pre-New Events, Add-In Model 1795 EASL
EA_OnPreNewDiagramObject Behavioral Model Templates 1193
Pre-New Events, Add-In Model 1795 Code Generation Macros, Behavioral Model
EA_OnPreNewElement 1193
Pre-New Events, Add-In Model 1793 Enterprise Architect Simulation Library 1193
EA_OnPreNewMethod EASL Collections
Pre-New Events, Add-In Model 1797 Action 1194
EA_OnPreNewPackage Behavior 1194
Pre-New Events, Add-In Model 1797 Classifier 1194
EA_OnRetrieveModelTemplate Construct 1194
Broadcast Events, Add-In Model 1820 Node 1194
EA_OnRunAttributeRule State 1194
Model Validation Broadcasts, Add-In Model State Machine 1194
1815 Transition 1194
EA_OnRunConnectorRule Trigger 1194
Model Validation Broadcasts, Add-In Model Vertex 1194
1814
EASL Properties
EA_OnRunDiagramRule
Action 1196
Model Validation Broadcasts, Add-In Model
1814 Argument 1196
Behavior 1196
EA_OnRunElementRule
Model Validation Broadcasts, Add-In Model Call Event 1196
1813 ChangeEvent 1196
EA_OnRunMethodRule Classifier 1196
Model Validation Broadcasts, Add-In Model Condition 1196
1815 Construct 1196
EA_OnRunPackageRule Edge 1196
EventObject 1196
© 1998-2010 Sparx Systems Pty Ltd
 1910 Index

EASL Properties Global Options 1338

Instance 1196 Language-Specific Options 1338
Parameter 1196 Macro Key Assignment 1338
Primitive 1196 Effort
PropertyObject 1196 Attributes 1710
SignalEvent 1196 Automation Interface, Element Package 1710
State 1196 Methods 1710
StateMachine 1196 Effort Management 315
TimeEvent 1196 Effort Types
Transition 1196 Define 319
Trigger 1196 Global 319
Vertex 1196 Non-Global 315
EASL_GET EJB
Code Generation Macro, Behavioral Model Entity Bean Transformations 1397
1193 Session Bean Transformations 1397
EASLList Element
Code Generation Macro, Behavioral Model Abort Edit Changes 68
1193 Accept Edit Changes 68
ECF Action 743
Value 337 Active 483
Weighting 337 Activity 753
Eclipse Activity Final 772
MDG Integration For, Enterprise Architect Activity Partition 786
1073
Activity Region 788
MDG Link For, Enterprise Architect 1073
Actor 757
Edit
Add And Manage, Automation Interface Code
Attribute Name, In-Place Editor 588 Example 1767
Element Name, In-Place Editor 588 Add Attribute, In-place Editor 592
Item In Team Review 215 Add Directly To Package 524
Linked Document Template 604 Add Link To Team Review Post 216
Linked Documents 600 Add New Item (Inline Features Menu Option)
Menu 57 68
Operation Name, In-Place Editor 588 Add Operation, In-place Editor 592
Pattern Default 904 Add Supporting Diagrams and Elements 550
RTF Style Template 1576 Add To Diagram 31
Test Details 1538 Add To Diagram From Project Browser 430
Editions Add To Diagram Via Context Menu 395
Business and Software Engineering 12 Add To Favorites 552
Corporate 12 Add To Profile 1096
Desktop 12 Add To UML Model, Quick Start 31
Floating Licence 12 Align 557
Lite 15 Align From Diagram Toolbar 83
Of Enterprise Architect 12 Align Multiple 532
Of Enterprise Architect, Introduction 10 Alternative Image 447
Professional 12 Appearance, Context Menu Option 555
Standalone 12 Appearance, Format From Toolbar 85
System Engineering 12 Apply Image From Clipboard 69
Ultimate 12 Archimate 1073
Editor Artifact 810
Team Review 215 Associated Files 507
Editor Language Properties Attributes Option 554
Code Editor Properties 1338 Author 482

Enterprise Architect User Guide

 Index 1911

Element Copy Between Packages 531

Auto Counters 525 Create Child Diagram 422
Auto Naming 525 Create From Linked Document 602
Auto Numbering 525 Create From Maintenance Item 1561
Automation Interface, Element Package 1711 Create From Toolbox 399
Autosize Group 444 Create In Diagram 523
Autosize Single 444 Create Link From Project Browser 618
Background Color 353 Create With Quick Linker 475
Behavioral Diagram 742 Create, Same Type As Previous 65
Boundary 836 Custom Properties 550
Boundary, Settings 803 Customize Visibility 535
BPMN 952 Cut And Paste Between Diagrams 34
BPMN, Change Appearance 956 Dashed Border On 529
Browser Window 510 Data Store, Data Flow Diagram 1076
Bulk Update 340 Data Type 817
Business Rule 937 Datastore, Activity Diagram 764
Cardinality (Multiplicity), Non-Displayable 484 Decision 765
Central Buffer Node 758 Default Appearance 69
Change 1563, 1564 Default Element Template 542
Change Appearance, BPMN 956 Defect 1563
Change Type 532 Defects 1558
Changes And Issues 1558 Defects, Add/Modify/Delete 1559
Changes, Add/Modify/Delete 1559 Delete 534
Child Validation 1531 Delete Item From 68
Choice 758 Deployment Spec 818
Class 811 Details 484
Code Engineering Menu 554 Device 818
Collaboration 814 Diagram Frame 766
Collaboration Occurrence 815 Diagram Gate 767
Combined Fragment 759 Display Depth 437
Compartments 521 Display Options 362
Complexity 482 Dockable 555
Component 816 Document Artifact 819
Composite 837 Documentation 1616
Concurrency 484 Drag From Project Browser 430
Confirm As Parent 529 Duplicate 531
Connect 610 Edit Attribute Keyword 590
Connectors In Relationships Window 1269 Edit Attribute Scope 589
Constraint Note 785 Edit Attribute Stereotype, In-place Editor 588
Constraint, Attach 68 Edit Item, Tasks 586
Constraints 488 Edit Name, In-Place Editor 588
Context Menu 547 Edit Operation Parameter Keyword 591
Context Menu, Add Submenu 550 Edit Operation Parameter Kind 592
Context Menu, Advanced 549 Edit Operation Scope 589
Context Menu, Features 554 Edit Operation Stereotype, In-place Editor 588
Context Menu, Find Submenu 552 Embedded Submenu 552
Context Menu, Project Browser 1218 Embedded, Add 553
Continuation 792 Endpoint 768
Continutaion 792 Entity 839
Control 838 Entity, Entity Relationship Diagram 1077
Coordinates On Status Bar 89 Entry Point 769
Copy And Paste Between Diagrams 34 Enumeration 819
© 1998-2010 Sparx Systems Pty Ltd
 1912 Index

Element Instance 823

Eriksson-Penker 1080 Interaction 779
Event 839 Interaction Occurrence 780
Exception 769 InteractionUse 780
Execution Environment 820 Interface 821
Exit Point 771 Internal Requirements 485
Expansion Region 769 Interruptible Activity Region 781
Export Data In CSV Format 303 Issue 1563
Expose Interface 820 Issues And Changes 1558
Extended By Stereotype 835 Issues, Add/Modify/Delete 1559
External Requirements 487 Join 773, 776
External, Data Flow Diagram 1076 Junction 782
Feature 840 Keywords 482
Feature, Connect To 611 Labels 452
Feature, Disconnect From 611 Layout 557
Fill Color 353 Legend 441
Fill Color Gradient 356 Lifeline 783
Filter Display On Diagram 1271, 1272 Link To Attribute Via Object 568
Final (Leaf) 483 Linked, Convert To Local Copy 544
Find In Diagram Menu Options 1218 Lock Indicators 206
Find in Diagrams 552 Lock, Require User Lock 205
Find In Diagrams, Element List 1258 Lock, Security Off 555
Find In Project Browser 67, 552 Lock, User/Group Lock 204
Find Related 433 Locked, Add Connector To 204
Fine Movement 454 Maintenance 1558
Flow Final 772 Make All Selectable/Unselectable 394
Font, Set 69 Make Non-Selectable, Multiple Elements 557
Fork 773, 775 Make Non-Selectable, Single Element 555
Fragment 759 Make Selectable, Multiple Elements 557
Gang Of Four Pattern 1083 Make Selectable, Single Element 555
General Settings 482 Managing 522
Generalizable, Advanced Settings 483 Master Document 1616
Get Project Custom Colors 540 Match Size 557
GoF Pattern 1083 Menu 67
Hide Type On Diagram 1271, 1272 Merge 765
Highlight Context 543 Merge Node 784
History 777 Mind Mapping 1087
Hyperlink 840, 842 Model Document 1616
Icon, Project Browser, User-Defined 1108 Modeling With 478
Icons On Diagram 521 Move Between Packages 530
Import Data In CSV Format 305 Move By Increments 454
Include Linked In RTF Report 1571 Move In Diagrams 529
Information Item 821 Move, Impact Of Diagram 34
Initial 778 Multiple Selection 557
In-place Editor Options 586 Multiple Update 340
In-Place Formatting 521 Multiplicity, Displayable 483
Insert Maintenance Feature 594 N-Ary Association 844
Insert New Feature (Inline Features Menu N-Ary, Entity Relationship Diagram 1077
Option) 68 New 523
Insert Operation Parameter 593 Node 822
Insert Related Elements 551 Non-Selectable, Multiple Elements 557
Insert Testing Features 595 Non-Selectable, Single Element 555
Enterprise Architect User Guide
 Index 1913

Element Scenario 490

Note (Constraint, Comment) 785 Scenarios & Requirements 514
Note, Attach 68 Screen 847
Notes 536, 641 Select By Property 1271
Nudge 70, 454 Selectable, Multiple Elements 557
Object 823 Selectable, Single Element 555
Occurrence 780 Send 789
Operations Option 554 Send Event 839
Package 825 Sequence Diagram 710
Packaging Component 845 Sequence, Lifecycle 708
Part 825 Set Alternative Image 69
Partition 786 Set Cross References 527
Paste As Link 58 Set Custom References 527
Paste As New 58 Set Default Appearance 538
Paste Copy 531 Set Element Template Package 542
Paste From Clipboard As Metafile 58 Set Feature Visibility 554
Paste From Project Browser 430 Set Font 556
Phase 482 Set Parent 526
Phase, Update For Package 340 Set Project Custom Colors 540
Place Related On Current Diagram 433 Shadow Color 353
Port 826 Shape Script Properties 1158
Postconditions 488 Show Usage 526
Preconditions 488 Signal 834
Primitive 829 Size 533
Process 846, 931 SoaML 1089
Process, Data Flow Diagram 1076 Specification 483
Properties Dialog 481 SPEM 1062
Properties Dialog, Changes and Defects 1565 State 789
Properties Dialog, General Settings 482 State Invariant 792, 793
Properties Menu 548 State Lifeline 794
Properties Window 508 State Machine 796
Properties, As Attributes 565 State/Continuation 792
Properties, Edit From Package 720 Status 482
Properties, Links 489 Status, Update For Package 340
Properties, Tagged Values Tab 508 Stereotype 482
Pseudo-State 682 Stored Procedure 1030
Receive 787 Structural Diagram 809
Receive Event 839 Structured Activity, Conditional Node 796, 798
Region 788 Structured Activity, Loop Node 796, 798
Region, Expansion 769 Structured Activity, Sequential Node 796, 798
Region, Interruptible Activity 781 Structured Activity, Structured Node 796, 798
Relationship Traceability For 1253 Sub-Activity 753
Relationship, Delete 489 Sub-Activity, Conditional Node 796, 798
Relationship, Entity Relationship Diagram 1077 Sub-Activity, Loop Node 796, 798
Relationship, Hide 489 Sub-Activity, Sequential Node 796, 798
Relationship, Show 489 Sub-Activity, Structured Node 796, 798
Requirement 846, 922 Submachine State 789, 796
Requirements 485 Superimposition 437
Resize 533 Synch 802
Responsibilities 485 Synchronize Stereotyped Tagged Values From
Root 483 Toolbox 399
Rule Task 939 Synchronize Stereotypes With Profile 910
© 1998-2010 Sparx Systems Pty Ltd
 1914 Index

Element WSDL, Document 1053

SysML Activity 996 WSDL, Port Type 1056
SysML Block Definition 992 Z Order 437
SysML Interaction 998 Element Context Menu
SysML Internal Block 994 Add Submenu, Project Browser 1219
SysML Model 991 Element Feature
SysML Parametric 995 Attribute 558
SysML Requirement 1001 Connect To 611
SysML State Machine 999 Disconnect From 611
SysML Use Case 1000 Operation 569
System Boundary 802 Element List
Table 849 Context Menu Options 1258
Tasks 522, 1558 Description 1255
Tasks, Add/Modify/Delete 1559 Generate RTF Report 1570
Template Package 542 Options 1258
Template Parameters 484 Show As Diagram 1258
Template, Default Element 542 Show Diagram As 394
Templates And Profiles 542, 906 Toolbar 1258
Terminate 804 Was Report View 1255
Test Case 848 Work On Elements 1258
Test Scripts Compartment 1549 Element Package, Automation Interface
Text 536 Constraint 1710
Text Color 353 Diagram 1708
Toolbar 83 Effort 1710
Transformation 1387 Element 1711
Trigger 804 File 1717
Type 549 Issue 1718
UI Control 849 Metric 1719
UML 741 Requirement 1719
Usage 526 Resource 1720
Use Case 806 Risk 1721
Use Cross References 527 Scenario 1722
Use Custom References 527 ScenarioExtension 1723
Use Extras, Automation Interface Code Example ScenarioStep 1723
1769 TaggedValue 1724
User Interface 849 Test 1725
Value Lifeline 808 Element Templates
Version 482 And Profiles 1093
Version, Update For Package 340 ElementFeatures Package, Automation Interface
View Properties (Inline Features Menu Option) Attribute 1727
68 AttributeConstraint 1729
View, Data Modeling 1032 AttributeTag 1730
Visibility 484 CustomProperties Collection 1730
Visibility Options 363 Diagram 1726
Visual Representation, Introduction 520 EmbeddedElements Collection 1731
Work On From Element List 1255 Method 1732
Work On From Toolbar 84 MethodConstraint 1733
Working With 478 MethodTag 1734
WSDL Binding 1057 Parameter 1735
WSDL Message 1056 Partitions Collection 1736
WSDL Namespace 1051 Properties 1736
WSDL Service 1054 Property 1736
Enterprise Architect User Guide
 Index 1915

ElementFeatures Package, Automation Interface Enterprise Architect

Transitions Collection 1737 Add-In Model 1776
Ellipse Diagram Layout 459 Alignment With UML 672
Email And Deployment 45
Access Within Enterprise Architect 103 And IDEs 5
Exchange Server, Define Default 351 Autohide Windows 78
Embedded Elements Automation 1659
Dialog 553 Build Systems 5
Element Context Submenu 552 CASE Tool 3
Include When Pasting Composite 431 Change Control, Project 1557
Incorporate Inherited Properties 553 Change Management 228
Maintain Layout In Pasting Composite 431 Code Engineering With 1279
Window 553 Community Site 23, 50
EmbeddedElements Collection Connectors 852
Automation Interface, ElementFeatures Package Create Project, Tutorial 28
1731 Database Modeling 5
EMX Debug 5
File Cross References 291 Demonstration 48
File Import 291 Design Systems 5
Enable Dock Windows 76
Add-Ins 1781 Dockable Windows 75
Archimate 1073 Editions, Differences Between 12
Data Flow Diagrams 1076 Editions, Introduction 10
Entity Relationship Diagram 1077 Editor 1337
Eriksson-Penker MDG Technology 1080 End User License Agreement 16
Exclusive Diagram Edit Lock 189 Example Project File 114
Gang Of Four Pattern Technology 1083 Export Data In CSV Format 303
GoF Pattern Technology 1083 Extend Trial Period 10
ICONIX 1084 Feedback Pages 3
MDG Technologies 1069 For Business Analysts 38
Mind Mapping 1087 For Database Administrators 47
Security 189 For Developers 42
SoaML 1089 For Implementation Managers 45
SPEM 1061 For Project Managers 43
Enable Diagnostic Messages For Software Architects 40
Build Script, Sequence Diagram Recording Tab For Software Engineers 41
1496 For Technology Developers 46
Enable Filter For Testers 43
Build Script, Sequence Diagram Recording Tab Formal Statements 16
1493
Fundamental Processes 4
Encrypt Password
Generate Documentation 5
Prior To Release 7.1 Of Enterprise Architect
200 Generate Source Code 5
Encrypt Password (Repository) Getting Started 26
At Release 7.1 Of Enterprise Architect 115, Glossary 1833
119 Help 23
End Event, BPEL How To Use 3
Create 965 Import Data In CSV Format 305
Model 965 In Action 48
Types 965 Install 21
End User License Agreement 16 Interfaces For Modeling 48
Endpoint Introduction 3
Element 768 Key Features 8
© 1998-2010 Sparx Systems Pty Ltd
 1916 Index

Enterprise Architect What Can I Do With It? 5

Keyboard Shortcuts 104 What is Enterprise Architect? 4
Keyboard/Mouse Shortcuts 109 Working With 4
License Agreement 16 Workspace Status Bar 89
Lite Edition 15 Enterprise Architect Lite
Main Context Menu 54 Availability 15
Main Menu 54 Description 15
Manage Model Structure 5 Edition 15
Manage Requirements 5 Enterprise Architect Simulation Library
MDA Transformation 5 Behavioral Model Templates 1193
Model Complexity 5 EASL Code Generation 1193
Model Requirements 5 EASL_GET Macro 1193
Modeling Tool 3 EASLList Macro 1193
Navigation Compass 76 Enterprise Architect Toolbox 399
Object Model, Introduction 1666 Activity Group 412
Online Resources 50 Analysis Group 416
Online User Guide 3 Class Group 407
Performance, DBMS Connections 148, 150, Common Group 405
153, 160, 162, 165 Communication Group 409
Performance, In Auditing 270 Component Group 412
Performance, WAN Optimizer 180 Composite Group 409
Predefined Search Definitions 1241 Custom Group 417
Professional Roles 37 Data Modeling Group 421
Project Change Control 1557 Deployment Group 413
Project Files, Open A Project 114 Documentation Group 1616
Project Maintenance 1557 Interaction Group 410
Project Roles 37 Maintenance Group 418
Project Team Review 208 MDG Technology Groups 1067
Project, What Is A? 113 Metamodel Group 415
Quality Control 1527 Object Group 408
Read-Only Edition 15 Profile Group 414
Register Full License 22 Requirement Group 418
Replication Merge Rules 184 Shortcut Menu 403
Reverse Engineer 5 State (Machine) Group 411
Scripting 1659 SystemC Group 1295
SDK, Introduction 1092 Timing Group 410
Select Edition To Trial 10 Use Case Group 406
Share Model Development 5 User Interface Group 419
Software Product License Agreement 16 Verilog Group 1298
Spell Checking 1552 VHDL Group 1299
Start 27 WSDL Group 420
Start Page 50 XML Schema Group 420
Support 23, 24 Enterprise Java Beans 1397
Testing 1527 MDG Technology For, Enterprise Architect
Tools And Features For Modeling 48 1073
Trial Version 10 Entity
UML 2.3 Support 5 Create 839
UML Modeling With 370 Element 839
User Interface 48 Element (Entity Relationship Diagram) 1077
Uses Of 5 Entity Relationship Diagram
Visualize Systems 5 Concepts 1077
Web Services Access 103 Connector 1077

Enterprise Architect User Guide

 Index 1917

Entity Relationship Diagram Toolbox Page 1080

Elements 1077 Eriksson-Penker Business Extensions 733
Example Diagram 1077 Establish Port-Trigger Mappng
MDG Technology 1077 Model State Machine For HDL 1319
Relationship 1077 Estimation 659
Tagged Values 1077 Default Hours 340
Toolbox Page 1077 Environment Complexity Factors 337
Transformation From Data Model 1390 Of Project Factors 335
Transformation To Data Model 1399 Of Project Size 338
Entry Point Of Project Timescale 335
Element 769 Technical Complexity Factors 336
Entry Points Use Case 335
Tab Of Structural Specification 493, 498 Event
Enumeration Business Modeling 932
Automation Interface 1675 Element 839
ConstLayoutStyles 1675 Receive 839
CreateBaselineFlag 1676 Send 839
CreateModelType 1676 EventProperties
Element 819 Automation Interface Repository 1697
EnumRelationSetType 1676 EventProperty
ExportPackageXMIFlag 1677 Automation Interface Repository 1697
Literal 819 Example Diagram
MDGMenus 1677 Entity Relationship Diagram 1077
ObjectType 1677 Examples And Tips
PropType 1678 Automation Interface 1669
ReloadType 1678 Exception
ScenarioDiagramType 1678 Element 769
ScenarioStepType 1679 Exception Path, Scenario 490
ScenarioTestType 1679 Exclamation Mark
XMIType 1679 Blue 206
Enumeration Elements Red 206
Add To Profiles 1103 Exclude
EnumRelationSetType Enum Package In RTF Report 1573
Automation Interface 1676 Exclusive Edit Lock
Environment Complexity Factor Automatic 189
Definition 337 Disable 189
Estimate Project Size 338 Enable 189
Estimation 337 Toggle 189
Value 337 Exclusive Gateway
Weighting 337 Data-Based 972
ERD To Data Model Event-Based 972
Transformation, MDA-Style Transform 1399 Execution Analysis
ERDs 1077 Add State Transitions 1507
Eriksson-Penker Automatic Recording, Record Sequence
Concept 1080 Diagrams 1504
Diagram 1080 Breakpoints And Markers Window, Record
Disable 1080 Sequence Diagrams 1503
Elements 1080 Control Recording, Record Sequence Diagrams
1504
Enable 1080
Diagram Features, Generate Sequence
Extensions 1080 Diagrams 1507
MDG Technology 1080 Difference Between Recording Marker And
Relationships 1080 Breakpoint 1503
© 1998-2010 Sparx Systems Pty Ltd
 1918 Index

Execution Analysis Resume Recording, Record Sequence Diagrams

Generate Sequence Diagram 1505, 1507 1505
Introduction 1490 Run Unit Test 1513
Manual Recording, Record Sequence Diagrams Save Recording History 1507
1504 Sequence Diagrams, Enable Diagnostic
Marker Types, Record Sequence Diagrams Messages 1496
1499 Sequence Diagrams, Limit Auto Recording
Object Workbench, Create Variables 1521 1496
Object Workbench, Introduction 1519 Sequence Diagrams, Record Arguments To
Object Workbench, Invoke Methods 1522 Function Calls 1494
Object Workbench, Overview 1520 Sequence Diagrams, Record Calls To Dynamic
Modules 1495
Object Workbench, Variables 1521
Sequence Diagrams, Record Calls To External
Pause Recording, Record Sequence Diagrams Modules 1494
1505
Set Recording Markers, Record Sequence
Place Markers, Recording Sequence Diagrams Diagrams 1502
1499
Set Up To Capture State Changes 1508
Platforms 1490
State Machine Diagram 1509
Profiler Operation 1517
State Transition Diagram 1509
Profiler Report, Load 1518
Stop Recording, Record Sequence Diagrams
Profiler Report, Save 1518 1505
Profiler Report, Save As Resource In Team Submenu (Project Menu) 62
Review 1519
Team Review, Save Profiler Report As Resource
Profiler Toolbar 1516 1519
Profiler, Attach To Process 1517 Unit Test Script, Create 1512
Profiler, Getting Started 1516 Unit Test, Record Results 1514
Profiler, Launch 1517 Unit Testing, Introduction 1512
Profiler, Overview 1514 With Enterprise Architect 1490
Profiler, Prerequisites 1516 Work With Marker Sets, Record Sequence
Profiler, Set Options 1518 Diagrams 1503
Profiler, Set Sample Intervals 1518 Execution Analyzer
Profiler, Start 1517 Introduction 1489
Profiler, Stop 1517 Submenu (View Menu) 59
Profiler, Supported Platforms 1516 Execution Environment
Profiler, System Requirements 1516 Element 820
Record Activity For Class 1497 Execution Profiler
Record Activity For Method 1498 Attach To Process 1517
Record Sequence Diagrams, Advanced Getting Started 1516
Techniques 1497 Launch 1517
Record Sequence Diagrams, Enable Filter Operation 1517
1493
Overview 1514
Record Sequence Diagrams, Introduction
1490 Prerequisites 1516
Record Sequence Diagrams, Overview 1491 Report, Example 1514
Record Sequence Diagrams, Prerequisites Report, Load 1518
1492 Report, Save 1518
Record Sequence Diagrams, Recording Options Report, Save As Resource In Team Review
1492 1519
Record Sequence Diagrams, Set Up 1492 Set Options 1518
Record Unit Test Results 1514 Set Sample Intervals 1518
Recording History 1506 Start 1517
Recording Markers, Activate, Record Sequence Stop 1517
Diagrams 1503 Supported Platforms 1516
Recording Markers, Disable, Record Sequence System Requirements 1516
Diagrams 1503 Team Review, Save Report As Resource 1519
Enterprise Architect User Guide
 Index 1919

Execution Profiler Extension Stereotypes 835

Toolbar 1516 External
Exit Element (Data Flow Diagram) 1076
Menu Option (File Menu) 56 Requirements 487, 922
Exit Point External File
Element 771 Add Link To Team Review Post 216
Expansion Node External Requirements
Action 749 Color Coded 920
Expansion Region External Tools
Add 771 Open 96
Element 769 Pass Parameters To 97
Explorer
Open 70
Export -F-
.EAB File 264
Fan Relations Diagram Layout 469
Code Templates 1202
Favorites
Data 223
Add To Resources Window 669
MOF To XMI 1383
Delete From Resources Window 669
Profile, To Disk 1106
Drag Objects Into 1222, 1226
Reference Data 223
Elements, Resources Window 669
Reference Data, Introduction 223
Folder, Resources Window 669
RTF Style Template 1576
Model Views Folder 1222
State Machine Table To CSV 690
View Properties In Resources Window 669
To Rational Rose 288, 289, 293
FDD Methodology 840
To XMI 289
Feature
Version Controlled Model Branch 264
As Attribute 558
XMI, Batch 298
As Operation 569
Export Diagrams Element 840
To RTF Document 1625
Feature Driven Design Methodology 840
ExportPackageXMIFlag Enum
Feature Visibility
Automation Interface 1677
Attributes 438
Expose Interface Customize 438
Element 820
Inherited 438
Extend Operations 438
Connector 862
Set 438
Relationship 862
Supress 438
Toolbox Connectors 1138
Features
Toolbox Elements 1137
Connect To 611
Extended Elements 835 Disconnect From 611
Extended UML Diagrams 733 Of Enterprise Architect 8
Extending Modeling Languages
Feedback Pages 3
And MDG Technologies 1092
Field Substitution Macros
With Enterprise Architect 1092
Access Data from Attributes 1174
With UML Patterns In Enterprise Architect
Access Data from Classes 1174
1092
Access Data from Operations 1174
With UML Profiles In Enterprise Architect 1092
Access Data from Packages 1174
With UML Stereotypes In Enterprise Architect
1092 Access Data from Parameters 1174
Extension Conditional Substitution 1174
SysML Requirement 1001 Direct Substitution 1174
Extension Points Fields and Conditions
Use Case 807 In Search 1243

© 1998-2010 Sparx Systems Pty Ltd

 1920 Index

File Composite 1025

.EAB 264 Constraint 1025
Element Package, Automation Interface 1717 Create 1025
Hyperlink To 842 Description 1024
Menu 56 Name Template, Define 1028
File Search Representation In Diagram 1025
Introduction 1485 Foreign Language Translation
List View 1485 RTF Report Generation 1615
Search Window, Debugging 1485 Fork
Toolbar 1485 Element 773, 775
Tree View 1485 Pseudo-State 773, 775
Use 1485 Fork/Join
Filter Element 773
Diagram, Display Of Elements 1272 Formal Statements 16
Filters Format
Add To Search 1242 Element Appearance From Toolbar 85
AND 1235 Toolbar 85
Diagram, Display Of Elements 1271 Forum
Dynamic Visual 1271 Discussion, Now Team Review 208
Element, RTF Report 1611 Forward Engineering
OR 1235 Initial Code In Operations 576
Other, RTF Report 1612 Introduction 1281
Search 1235 Forward Slash
Find Derived Symbol 560
Diagram In Project Browser 65, 67 Forward Synchronization
Element In All Diagrams 552 Delete Code From Features In Model 1341
Element In Diagrams, Element List 1258 Fragment
Element In Project Browser 67, 552 Element 759
Submenu 552 Frame
Find In Diagram Combine Windows In 76
Element Context Menu, Project Browser 1218 Remove Windows From 76
Find in Project Tabbed 76
Menu Option (Edit Menu) 57 Free Sorting
Find In Project Browser On Project Browser 1210
Search Option 1214 Full Screen
Floating Licence Close 74
Version of Corporate Edition 12 Display 74
Floating Toolbar Buttons Fully Qualified Tagged Value
Display 362 Show In Element Compartment 438
Floating Windows 76 Function
Flow Final Macros, Code Template Syntax 1187
Element 772 Step Out Of 1473
Font Function Call
Set For Element Text 556 Step Into 1473
Fonts Step Through 1480
Set Model Default 357
Set User Default 357
Footer -G-
Insert In RTF Template 1596
Gang Of Four Pattern
Footers Concepts 1083
Add To RTF Document 1643
Download 901, 904
Foreign Key
Enterprise Architect User Guide
 Index 1921

Gang Of Four Pattern From State Machine Diagrams 1314, 1316

MDG Technology 1083 Generate HTML Report Dialog 1648
Toolbox Page 1083 Generate RTF Document
Garden Of Eden Style 1378 Element Filters Tab 1611
Gateway From Model Search 1234
Create 972 Other Filters Tab 1612
Exclusive (XOR) 972 Project Constants, User Defined 1614
Inclusive (OR) 972 Update Links In Word 1646
Model In BPEL 972 Generate RTF Documentation Dialog
Parallel (AND) 972 General Tab 1573
Types 972 Optimize For Sun Open Office 1573
General Options 1573
Types, Dialog 653 Template Editor 1587
General Options Templates Tab 1576
Set For Project 351 Word Substitution Tab 1615
General Ordering Generate Sequence Diagram
Sequence Diagram Messages 876 Diagram Features 1507
Generalizable Elements 483 Execution Analysis 1505, 1507
Generalization Generate Source Code
Sets 620 Enterprise Architect 5
Generalization Link Overview 1308
Implement Parent Operations 578 Get Function
Override Parent Operations 578 Create As Attribute Property 565
Generalize Get Project Custom Colors
Connector 863 For Element 540
Relationship 863 Getting Started
Generate Add License Key 1870
BPEL 983 In Enterprise Architect 26
DDL 1367 Installing Enterprise Architect 21
Global Element For Global ComplexTypes License Information 1869
1376 License Management 1867
Global Element In XSD 1378 Register Enterprise Architect 22
Report On Elements 1255 Registration Key 1869
Report On Project 1255 Start Enterprise Architect 27
Rich Text Format Report (Legacy) 1634 Upgrade Existing License 1873
RTF Document from Resources (Enhanced) With MOF 1381
1606
Global Element
RTF Document From Resources (Legacy) Generate For Global ComplexTypes 1376
1636
Generate In XSD 1378
RTF Report (Legacy) 1634
Import XSD 1375
RTF Report From Element List 1255
Global Elements
RTF Report From Virtual Document 1623
Import 1373
WSDL 1379
Global Risks 322
XML Schema For Referenced Packages 1376
Glossary
XML Schema, For Child Packages 1376
A 1834
XSD 1376
Add Item, Glossary Dialog 324
Generate Code
B 1836
For Business Rule 951
C 1837
From Activity Diagrams 1314, 1323
Create Item From Notes Text 641
From Behavioral Models 1314
D 1840
From Interaction Diagrams 1314, 1322
Delete Item, Glossary Dialog 324
From Sequence Diagrams 1314, 1322
Dialog 324
© 1998-2010 Sparx Systems Pty Ltd
 1922 Index

Glossary Insert In RTF Template 1596

E 1842 Headers
F 1843 Add To RTF Document 1643
Filter List, Glossary Dialog 324 Help
G 1844 Add-In 72
H 1845 Display On Add-Ins 72
Hyperlink Term From Notes 641 File Formats 24
I 1846 For Tagged Values 636
Insert Item In Text 641 Index Tab 23
J 1848 Menu 74
L 1849 Release Date 24
M 1850 Search Tab 23
Model 323 Systems 23
Modify Item, Glossary Dialog 324 Tasks Pane Topics 51
N 1852 Topic, Hyperlink To 840
O 1853 Version Details 24
Of Terms 1833 Hidden Submenu
P 1854 Create In Toolbox Profile 1135
Project 323 Hide
Q 1857 Code Execution (Project Menu) 62
R 1858 Connectors 619
Report 328 Connectors, All Diagrams 621
Report Output Sample 328 Connectors, Requirements Element 621
S 1860 Connectors, Single Diagram 621
T 1863 Diagram Caption Bar 59
U 1864 Labels 622
V 1865 Package Contents On Diagram 389
Glossary Detail Dialog Project Browser 1209
Add Item 325 Relationship 489
Modify Item 325 Toolbox 399
Goal Hide/Show
Business Modeling 933 Connector Labels 609
GoF Pattern Connectors 609
Concepts 1083 Hierarchy
Download 901, 904 Of Requirements 922
MDG Technology 1083 Requirement, Import Via CSV 922
Toolbox Page 1083 Highlight
Group Lock Context Element 543
Identify Owner 207 History
Group Login 197 Deep 777
Group Properties Dialog Element 777
Script 1663 Shallow 777
Guillemets 899 Hotkeys
Diagram Navigation And Selection 435

-H- Hourly Rate 340

HTML
And CSS Style Editor 1649
Hardware Description Languages
Documentation 1568, 1647
Model State Machine For 1319
Generate HTML Report Dialog 1648
HDL
Locate Page By GUID 1647
Model State Machine For 1319
Quick Start, Generate Report 1647
Header
Report 1568, 1647
Enterprise Architect User Guide
 Index 1923

HTML Add To MDG Technology 1130

Report Templates 1649 Change Linked To Embedded 1638
Report, Create 1647 Handling, RTF 1638
Style Template Fragments 1651 Print Scaled 456
Style Templates, Reporting 1649 Refresh 447
Template Fragments 1651 Scale To Page Size 456
View Report 1647 Select Alternative 447
Hyperlink Store In Enterprise Architect 447
Action Element 842 Use From Image Library 449
As Sub Activities 842 Image Library
Diagrams 842 Import 449
Element 840 Use 449
In Linked Document 601 Image Manager
Insert In RTF Template 1597 Create Custom Diagram Background 448
Insert New From Toolbar 83 Select Alternative Image For Element 447
To Element From Linked Document 601 Use 447
To External Files 842 IME
To Help Topics 840 Code Editor 1437
To Internet Facilities 840 Implementation Manager
To Matrix Profiles 840 And Enterprise Architect 45
To Model Search 840 Project Role 45
To Script 842 Implementation Report 1626
To Team Review 840 In Traceability 1251
Target Types 1627

-I- Implemented Interfaces

Generate/Disable Methods For 1341
Implements
Icon
Connector 889
Attribute Private 1213
Relationship 889
Attribute Protected 1213
Checked In Package 1213 Import
.EAB File 265
Checked Out Package 1213
ActionScript, Reverse Engineering 1331
Namespace Root Package 1213
Binary Module, Reverse Engineering 1334
Operation Private 1213
C#, Reverse Engineering 1331
Operation Protected 1213
C, Reverse Engineering 1331
Project Browser, User Defined 1108
C++, Reverse Engineering 1331
Version Controlled Package 1213
Code Templates 1202
ICONIX
Code, Select Language 81
Disable 1084
Component Types 1337
Elements 1084
Data 225
Enable 1084
Database Schema from ODBC 1363
Layout 1084
DDL Schema from ODBC 1363
MDG Technology 1084
Delphi, Reverse Engineering 1331
Relationships 1084
Directory Structure, Reverse Engineering 1332
Roadmap 1084
EMX files 291
UML Toolbox Pages 1084
From XMI 290
Icons
Global Elements 1373
For Element On Diagram 521
Handle Classes Not Found 1335
For Toolbox Items, Assign 1136
Image Library 449
IDE
Java, Reverse Engineering 1331
And Enterprise Architect 5
MDA-Style Transformations 1414
Image
MDG Technologies 1071
© 1998-2010 Sparx Systems Pty Ltd
 1924 Index

Import Relationship 864

MOF From XMI 1383 Information Item
Pattern 904 Conveyed 865
PHP, Reverse Engineering 1331 Element 821
Python, Reverse Engineering 1331 Inheritance
Reference Data, Automatically 225 Connector 863
Reference Data, Introduction 223 Relationship 863
Reference Data, Manually 225 Inherited Attributes
Referenced XML Schema 1373 Display 567
Requirements Via CSV 922 Inherited Feature
RTF Style Template 1576 Show 438
RTF Template 1606 Inherited Operation
Scenario as Test 1544 Display 579
Scenarios From Package 1544 Inherited Port
Source Code, Reverse Engineering 1329, Manage 827
1335 Initial
Split WSDL Files 1376 Element 778
Technology Files 70 Initial Code
Test From Other Element 1546 Operations Properties 576
UML Pattern 904 Inline Features
UML Profiles 908 Submenu (Element Menu) 68
UML2 files 291 Inline IME
User ID From Active Directory 192 Option In RTF Editor 1600
Version Controlled Model Branch 265 Inline Sequence Elements
Visual Basic, Reverse Engineering 1331 Part And Port 714
Visual Basic.Net, Reverse Engineering 1331 InnoDB
WSDL Files 1376 BaseModel Script 178
XMI 298 In-place Editor
XSD 1373 Automatic Scroll Into View 586
Import/Export Connector Options 623
Submenu (Project Menu) 65 Edit Attribute Keyword 590
Import/Export Submenu Edit Attribute Name 588
Package Context Menu, Project Browser 1218 Edit Attribute Scope 589
Imported Class Elements 1367 Edit Attribute Stereotype 588
Inbuilt Stereotypes 835 Edit Connector Labels 623
Include Edit Element Name 588
Connector 864 Edit Operation Name 588
Package In RTF Report 1573 Edit Operation Parameter Keyword 591
Relationship 864 Edit Operation Parameter Kind 592
Increase Text Display Size 75 Edit Operation Scope 589
Index Edit Operation Stereotype 588
Create in Data Modeling 1033 Element Item, Tasks 586
Unique 1033 Element Options 586
What Is An? 1033 Insert Attribute To Element 592
Indicator Insert Maintenance Feature 594
Locked Element 206 Insert Operation Parameter 593
Visibility 427 Insert Operation To Element 592
Information Flow Insert Testing Feature 595
And Patterns 864 In-Place Formatting
Connector 864 Elements 521
In Combination 864 Input Method Editor
Realized 866 Code Editor 1437
Enterprise Architect User Guide
 Index 1925

Insert InteractionUse
Attribute To Element, In-place Editor 592 Element 780
Bookmarked RTF Into Word 1639 Interface
Boundary Element 803 Element 821
Diagram Properties Note 440 Expose Element 820
Linked Elements 551 Provided 820
Maintenance Feature In Element 594 Required 820
Operation To Element, In-place Editor 592 Set For Element 526
Related Elements 551 Source Code Generation 1308
Testing Features In Element 595 Intermediary Language
Install MDA-Style Transforms 1415
Enterprise Architect 21 Intermediate Event, BPEL
Instance Create 968
Define Behavior On Creation, Supported Model 968
Attributes 1110 Types 968
Paste Object As 430 Internal Binding
Instantiated Template 813 PIM to PSM 1385
Integrated Development Environment 1424 Internal Editor
Integration Testing Language Properties 1337
Display Details 1540 Internal Requirement
Integrity Define 925
Of Model Data 344 Properties 925
Of Project Data 344 Internet Browser Applets
Integrity Check 344 Java, Debug 1454
Intellisense Internet Facilities
Code Editor, Common 1432 Hyperlink To 840
In Script Editor 1439 Internet Search Engine
Keystrokes, Script Editor 1439 Access Within Enterprise Architect 103
Interaction Define Default 351
Behavioral Aspects 581 Interrupt Flow
Diagram 690, 715, 717 Connector 867
Edit Parameters 581 Relationship 867
Element 779 Interruptible Activity Region
Elements and Connectors 410 Add 782
Group, Toolbox 410 Element 781
Parameter 581 Interval Bar
Parameters, Define 583 Context Menu 700
Interaction Diagram Timing Diagram Time Interval 700
Description 706 Introduction
Diagram 706 Copyright Notice 16
Elements And Connectors 706 Enterprise Architect Key Features 8
Example 706 Help File Formats 24
Generate Code From 1314, 1322 License Agreement 16
Interaction Occurrence Support 24
Behavior Call 581 To Code Engineering 1281
Element 780 To Enterprise Architect 3, 4
Interaction Operator To Enterprise Architect SDK 1092
Combined Fragment 762 To Forward Engineering 1281
Interaction Overview Diagram To Quick Linker 474, 1113
Description 717 To Reverse Engineering 1281
Elements And Connectors 717 To Round-trip Engineering 1281
Example 717 To Shape Scripts 1147
© 1998-2010 Sparx Systems Pty Ltd
 1926 Index

Introduction Language Options 1355

To Synchronization 1281 Modeling Conventions 1293
To Tagged Value Types 1166 Modeling Conventions, AspectJ Extensions
To UML Objects 741 1294
Trademarks 19 Transformation, MDA-Style Transform 1403
Invocation Web Servers, Debugging 1456
Associate With Behaviors 582 JavaScript 1660, 1661
Re-associate With Behaviors 582 JBOSS
Synchronize Arguments With Behavior Server Configuration 1458
Parameters 582 Server, Debugging 1456
Invocations Join
Modeling 581 Element 773, 776
Invoke Pseudo-State 773, 776
Connector 406 JScript 1660, 1661
Method, Object Workbench 1522 Junction
Issue Element 782
Create From Test Item 1548 JUnit Transformation
Elements And Requirements 928 MDA-Style Transform 1405
Issue (Defect)
Add 1563
Automation Interface, Element Package 1718 -K-
Element 1563
Key
Hide Stereotype Letter 1563
Combinations 104
Show Stereotype Letter 1563
Missing Combination 90
Issue (Project)
Key Bindings
Add 334
Code Editor, Common 1433
Delete 334
Key Features
Model 331
Of Enterprise Architect 8
Modify 334
Key Store
Report, Generate 331
File Based 1870
Issues Report Network Based 1870
Sample Output 335
Keyboard
Via Project Issues Tab 334
Accelerator Map 104
isUnique And Mouse Shortcuts 109
UML Property 629
Missing Combination 90
Iterate Through EAP File Shortcuts 104
Automation Interface Code Example 1766
Shortcuts, Customize 98
Shortcuts, Reset 98
-J- Key-Mouse
Combinations 109
Java Keys
Advanced Debug Techniques 1454 Foreign, Definition 1011
Applets In Internet Browsers, Debug 1454 Primary, Definition 1011
AspectJ Extensions 1331 Keystore
Code Generated From State Machine Diagram Troubleshooting 1872
1317 Keywords
Code Generation 1355 For RTF Report (Legacy) 1637
Debug 1452
Debug Session, Attach To VM 1454
Debug, System Requirements 1447 -L-
General Debug Setup 1453
Label
Import, Reverse Engineering 1331
Enterprise Architect User Guide
 Index 1927

Label Center Focussed Layout 459

Alignment 452 Circular Layout 459
Bold 452 Converge Layout 467
Connector 452 Digraph Layout 465
Connector, Hide/Show 609 Diverge Layout 467
Direction Indicator 452 Elliptical Layout 459
Display Under Toolbar Icons 92 Fan Relations Layout 469
Element 452 Main Procedure 458
Hide 452, 622 Neaten Layout 467
Menu 452 Options 458
Set Color 452 Per Page Layout 464
Show 622 Spring Layout 466
Show And Hide In Toolbox 401 Tool 458
Visibility 622 Top-To-Bottom Circle 459
Label Visibility Layout Tools Window 458
On Sequence Messages 714 Lazy Loading
Language Enterprise Architect Performance 148, 150,
Adjust in RTF (Legacy) 1637 153, 160, 162, 165
Adjust in RTF Report 1615 For ASA Data Repository 162
Create Properties As Attributes 565 For MSDE Server Data Repository 165
Custom, Create Templates For In Code For MySQL Data Repository 148
Template Editor 1206 For Oracle Data Repository 153
For Spell Check, Download 1554 For PostgreSQL Data Repository 160
Macros 1344 For Progress OpenEdge Data Repository 165
Language Options For SQL Server Data Repository 150
ActionScript 1348 Legend
Ada 2005 1348 Add To Diagram 441
C 1349 Add To State Machine Table 689
C# 1350 Edit 441
C++ 1351 Element 441
Code Editor 1338 Insert New From Toolbar 83
Code Generation 1347 Remove From State Machine Table 689
Delphi 1352 Style 441
Java 1355 Letter A
MDG Technology 1360 Red 597, 599
PHP 1356 Level Numbering
Python 1356 For Requirements 922
SystemC 1357 Show In Project Browser 1214
VB.NET 1358 License
Verilog 1358 Agreement 16
VHDL 1359 Information 1869
Visual Basic 1360 Management 1867
Languages Lifecycle
For Modeling, Introduction 671 Of A Sequence Element 708
Layout Lifeline
Diagram, Automatically 471 Element 783
Diagram, Move Sections 454 Objects In Sequence Diagrams 710
ICONIX 1084 Sequence Element, Termination 708
Sequence Diagram 709 Limit Auto Recording to Stack Frame Threshold
Layout Diagram Build Script, Sequence Diagram Recording Tab
Auto Route Layout 470 1496
Box Layout 463 Limitations

© 1998-2010 Sparx Systems Pty Ltd

 1928 Index

Limitations Change To Embedded 1638

Of XMI 293 List Macro
Line Code Template Syntax 1190
Angles, Tidy 615 List Overrides
Bend At Cursor 615 RTF Reports 1601
Bezier 615 Load
Straighten At Cursor 615 Controlled Package 297
Style 615 Report Templates (Legacy) 1634
Supress Segments 615 Loaded Modules
Line Points Show In Debugger 1478
Add 615 Local
Delete 615 Directories 1343
Toggle 615 Path Dialog 1343
Line Selection Paths 1343
Code Editor, Common 1432 Pre/Post Conditions 752
Link Local Variables
Add Note 612 View 1474
Copy Between Instances Of Elements From View Long Values 1474
Project Browser 618 Locals Window 1474
Create Between Elements 618 View Long Values 1474
Create From Project Browser 618 Lock
Display Options 364 Apply User Lock 205
Paste Object As 430 Connector 200
Window 1269 Delete 200
Link Notes Delete, User level 207
To Element Feature 537 Diagram, Rigorous Security Mode 205
To Internal Documentation 537 Diagram, Security Off 457
Linked Document Diagram, User/Group Lock 204
Create 597 Element 200
Create Diagram From 602 Element, Security Off 555
Create Document Artifact 599 Identify Owner 207
Create Element From 602 Manage 200
Create For UML Element 599 Manage, User-Level 207
Create Glossary Definition In 600 Model Elements, Rigorous Security Mode 205
Delete 602 Model Elements, User/Group Lock 204
Edit 600 Package, Rigorous Security Mode 205
Editor Context Menu 600 Package, User/Group Lock 204
Hyperlink 601 Packages 205
Introduction 597 Release User Lock 205
Link Into RTF Report 597, 1579 Standard Security Policy 204
Replace 602 View 200
To UML Element 599 View, User Level 207
Linked Document Template Locked Element
Add To MDG Technology 1133 Add Connectors 204
Assign To Group 603 Indicators 206
Create 603 Log
Delete 603 Audit, Clear 272
Edit 604 Audit, Load 272
Modify 603 Audit, Save 272
Linked Element Logical Diagram
Convert To Local Copy 544 Class Diagram 721
Linked Image Logical Model 376
Enterprise Architect User Guide
 Index 1929

Login Problem Types 660

As Different User (Security) 64 Script, Show In Compartments 1561
Group 197 Support 1559
Multiple Under One ID 197 Testing Types 661
Loop Node Window 1558
Structured Activity 796, 798 Workspace 1558
Maintenance Diagram
Description 737
-M- Elements And Connectors 737
Example 737
Macro
Behavioral Model 1193 Maintenance Item
Copy Between Categories 1561
Branching 1190
Create Element From 1561
Code Template Syntax 1173, 1190
Move Between Categories 1561
Control 1190
CONVERT_DB_TYPE 1421 Make Same
Submenu 70
CONVERT_NAMES 1422
CONVERT_TYPE 1421 Manage
Add-Ins 1781
EASL Code Generation 1193
Baselines 281
EASL_GET 1193
Bookmarks 341
EASLList 1193
Changes 228
Field Substitution, Code Template Syntax
1174 Diagrams 421
Function, Code Template Syntax 1187 Elements 522
Language 1344 Inherited Ports 827
List 1190 Locks 200
PI 1190 MDG Technologies 1069
Preprocessor 1344 Redefined Ports 827
REMOVE_PREFIX 1422 Requirements 927
SQL Search 1239 User-Level Locks 207
Synchronization 1190 Views 383
Tagged Value, Code Template Syntax 1186 Views, Add Views 383
Template Substitution, Code Template Syntax Views, Delete 385
1173 Views, Rename 384
TRANSFORM_CLASSIFIER 1423 Manage .EAP File
TRANSFORM_CURRENT 1421 Submenu (Tools Menu) 71
TRANSFORM_REFERENCE 1419, 1423 Managed C++
Main Context Menu 54 Modeling Conventions 1290
Main Menu 54 Manifest
Maintain Connector 867
Groups 197 Relationship 867
Security Users 191 Manual Recording
Maintenance Execution Analysis, Recording Sequence
Asterisk On Maintenance Window Tabs 1558 Diagrams 1504
Compartment, Element 521 Manual Version Control
Create Defect Item From Test 1548 With XMI 299
Dialog 660 Map State Changes
Elements And Connectors 418 Visual Execution Analyzer 1511
Feature, Insert In Element 594 Mapper
Group, Toolbox 418 Data Type Conversion Procedures 1035
Items 1558 Marker
Model Template 381 Storage 1469
Of Element Properties 1559 Marker Management
© 1998-2010 Sparx Systems Pty Ltd
 1930 Index

Marker Management Advanced Debug Techniques, Java 1454

Debugger 1468 Available Tools 1424
Marker Sets Basic Setup 1425
Work With 1503 Breakpoint Management 1468
Masked Tagged Values Build Script, Create 1444
Create 1171 Build Script, Introduction 1443
Master Document Code Editors 1425
Element 1616 Debug .NET 1460
Element, Create 1618 Debug .NET Assembly 1461
Generate Documentation 1623 Debug .NET CLR Versions 1462
Overview, Virtual Document 1616 Debug .NET With COM Interop Process 1463
RTF Bookmarks In 1616 Debug Apache Tomcat Server Configuration
Tagged Values 1618 1459
Matrix Debug Apache Tomcat Windows Service 1460
Swimlanes 444 Debug ASP .NET 1463
Matrix Profile Debug Java 1452
Hyperlink To 840 Debug Java Applets In Internet Browsers 1454
MDA Transform Debug Java Web Servers 1456
Add To MDG Technology 1130 Debug JBOSS Server Configuration 1458
MDA Transformation Debug Symbols, C++ And Native Applications
Built-In 1385 1452
Enterprise Architect 5 Debugger Frameworks 1446
Overview 1385 Debugger System Requirements 1447
Project Menu Option 63 Debugger, Overview 1446
Default Script, Set 1428
MDA-Style Transformation
Built In Transformation 1388 External Tools 1425
C# Transformation 1389 For C++ Applications 1451
Chaining Transformations 1388 For Microsoft Native Applications 1451
Convert Datatypes 1421 For WINE Applications 1450
Convert Names 1422 General Debug Setup, Java 1453
Convert Types 1421 General Workflow 1425
Copy Information 1421 Generate Code 1425
Create Connectors 1419 Getting Started 1424
Cross References 1423 Introduction 1424
Data Model To ERD Transformation 1390 Java Debug Session, Attach To VM 1454
DDL Transformation 1393 Limitations 1277
Duplication Of Connectors 1419 Marker Management 1468
EJB Transformations 1397 Model Driven Development Environment 1489
ERD To Data Model Transformation 1399 Overview 1277
Import Transformations 1414 Package Build Scripts, Manage 1426
Intermediary Language 1415 Pin/Unpin A Package 1428
Java Transformation 1403 Prerequisites 1424
JUnit Transformation 1405 Recursive Builds 1446
NUnit Transformation 1407 Script Actions, Define 1427
Specify Classifiers 1423 Set Up Debug Session 1447
Transform Connectors 1419 Set Up Debug Session For .NET 1461
Transform Elements 1387 Supported Environments 1277
Transformation Templates 1412 Synchronize Code 1425
Write Transformations 1414 UAC-Enabled Operating Systems 1448
WSDL Transformation 1408 Workspace Layout 1424
XSD Transformation 1409 MDG Add-In For
CORBA 1073
MDDE
Enterprise Architect User Guide
 Index 1931

MDG Add-In For MDG_PreGenerate 1828

Data Distribution Service 1073 MDG_PreMerge 1828
DDS 1073 MDG_PreReverse 1829
Department Of Defense Architecture Framework MDG_Run_Exe 1830
- Ministry Of Defence Architecture Framework MDG_View 1830
1073
MDG Integration For
DoDAF-MODAF 1073 Eclipse 1073
DOORS 1073 TcSE 1073
Eclipse 1073 Teamcenter Systems Engineering, Siemens PLM
Enterprise Java Beans 1073 1073
Python 1073 Visual Studio 2005/2008 1073
Strategic Modeling 1073 MDG Link For
SysML 1073 DOORS, Telelogic 1073
Systems Modeling Lanuages 1073 Eclipse 1073
TcSE 1073 Visio 1073
Teamcenter Systems Engineering, Siemens PLM Visual Studio.NET 1073
1073
MDG Technology
Testing 1073 Access, Remote From Enterprise Architect
The Open Group Architecture Framework 1070
1073 Activate 1069
TOGAF 1073 Active, Automatically Pinned Pages 401
Visio 1073 And Resources Window 1067
Visual Studio 2005/2008 1073 Code Generation 1360
Visual Studio.NET 1073 Create 1118
Zachman Framework 1073 Create Toolbox Profile For 1134
MDG Add-Ins Define Tasks Pane Profile 1141
Add-In Model 1821 Define Validation Configuration 1145
MDG Events 1822 Deploy From Add-In 1146
MDG_BuildProject 1822 Deploy From File 1146
MDG_Connect 1822 Disable 1069
MDG_Disconnect 1823 Enable 1069
MDG_GetConnectedPackages 1824 Example Of Development 1118
MDG_GetProperty 1824 Import 1071
MDG_Merge 1825 Include Custom Diagram Types 1139
MDG_NewClass 1826 Incorporate Model Template 1146
MDG_PostGenerate 1827 Introduction 1066, 1118
MDG_PostMerge 1827 Language Options 1360
MDG_PreGenerate 1828 Link for Downloads 1066
MDG_PreMerge 1828 Manage 1069
MDG_PreReverse 1829 Toolbox Groups 1067
MDG_Run_Exe 1830
MDG Technology (Integrated)
MDG_View 1830 Archimate 1073
MDG Events BPEL 958
Add-In Model 1822 BPMN 952
MDG_BuildProject 1822 Data Flow Diagram 1076
MDG_Connect 1822 Entity Relationship Diagram 1077
MDG_Disconnect 1823 Eriksson-Penker 1080
MDG_GetConnectedPackages 1824 Gang Of Four Pattern 1083
MDG_GetProperty 1824 GoF Pattern 1083
MDG_Merge 1825 ICONIX 1084
MDG_NewClass 1826 Mind Mapping 1087
MDG_PostGenerate 1827 SoaML 1089
MDG_PostMerge 1827
© 1998-2010 Sparx Systems Pty Ltd
 1932 Index

MDG Technology (Integrated) Add-In Model 1827

SPEM 1061 MDG_PostMerge
SysML 989 Add-In Model 1827
MDG Technology For MDG_PreGenerate
CORBA 1073 Add-In Model 1828
Data Distribution Service 1073 MDG_PreMerge
DDS 1073 Add-In Model 1828
Department Of Defense Architecture Framework MDG_PreReverse
- Ministry Of Defence Architecture Framework Add-In Model 1829
1073
MDG_Run_Exe
DoDAF-MODAF 1073 Add-In Model 1830
Enterprise Java Beans 1073
MDG_View
Python 1073 Add-In Model 1830
Strategic Modeling 1073
MDGMenus Enum
SysML 1073 Automation Interface 1677
Systems Modeling Languages 1073
Memory Viewer
Testing 1073 Window 1476
The Open Group Architecture Framework
Menu
1073
Add-Ins 72
TOGAF 1073
Context 48
Zachman Framework 1073
Context, Project Browser 1213
MDG Technology Selection (MTS) File 1133
Customize Appearance 100
MDG Technology Wizard
Delete Options 100
Add Code Modules 1128
Diagram 65
Add Diagram Type To Technology 1124
Diagram Context 394
Add Images 1130
Edit 57
Add Linked Document Template To Technology
1133 Element 67
Add MDA Transforms 1130 Element Context 547
Add Pattern To Technology 1123 File 56
Add Profile To Technology 1122 Help 74
Add RTF Report Template To Technology Items, Define In Add-In 1777
1132 Label 452
Add Scripts 1131 Main 54
Add Tagged Value Types 1127 Main Context 54
Add Task Panel To Technology 1126 Missing Option 90
Add Toolbox To Technology 1125 New Element Or Connector Context 395
Create Technologies 1118 Other Element Tools 58
MDG_BuildProject Other Project Tools 58
Add-In Model 1822 Package Control 294
MDG_Connect Project 60
Add-In Model 1822 Properties, Element Context 548
MDG_Disconnect Set Animation 100
Add-In Model 1823 Set Shadowing 100
MDG_GetConnectedPackages Settings (Project) 73
Add-In Model 1824 Toolbars (View Menu Option) 58
MDG_GetProperty Tools 70
Add-In Model 1824 Version Control (Package) 257
MDG_Merge Version Control (Project) 256
Add-In Model 1825 View 58
MDG_NewClass Visual Styles (View Menu Option) 58
Add-In Model 1826 Window 74
MDG_PostGenerate Menu Option (File Menu)
Enterprise Architect User Guide
 Index 1933

Menu Option (File Menu) Message Part

Close Project 56 WSDL Attribute 1060
Exit 56 Meta Object Facility
New Project 56 Introduction 1380
Open Project 56 Metaclass
Open Source File 56 Add To Profile 1096
Page Setup 56 Metafile
Print 56 Supported In UML Profiles 912
Print Preview 56 META-INF Package 1397
Print Setup 56 Metamodel
Reload Current Project 56 Elements and Connectors 415
Save Project As 56 Group, Toolbox 415
Merge Method
Baseline With Current Model, Overview 279 Add And Delete, Automation Interface Code
Element 765, 784 Example 1769
Node 784 Automation Interface, ElementFeatures Package
Options, Compare Utility 285 1732
Context Menu, Project Browser 1221
Merge Packages
Relationship 888 Delete If Not In Code In Reverse Synchronization
1341
Message
From Rule Flow Activity 942
Asynchronous Signal 877
Implemented Interfaces 1341
Collaboration 880
Include Bodies In Model When Reverse
Colors In Communication Diagrams 716 Engineering 1341
Communication 879 Invoke, Object Workbench 1522
Communication, Coloring 366 Show Parameters On Diagram 429
Communication, Create 880 Work With, Automation Interface Code Example
Connector 867 1774
Create On Timing Diagram 883 MethodConstraint
Endpoint 784 Automation Interface, ElementFeatures Package
Group, Start New 880 1733
Label 785 Methodology
Level 880 FDD 840
Move 867 Feature-Driven Design 840
Recursion 890 MethodTag
Relationship 867 Automation Interface, ElementFeatures Package
Scope 624 1734
Self Message 871 Metric
Self Message Call 872 Automation Interface, Element Package 1719
Sequence Communication 880 Metric Types
Sequence Diagram, Asyncronous Signal 877 Define 320
Sequence Diagram, Examples 873 Global 320
Sequence Diagram, General Ordering 876 Non-Global 317
Sequence Diagram, Self Message 871 Metrics 659
Sequence, Create 868 Project Management Window 312
Sequence, Label Visibility 714 Metrics And Estimation
Sequencing 880 Default Hour Rate 340
Source and Target 624 ECF 337
Timing Diagram 882 Effort Types 319
WSDL Diagram 1056 Environment Complexity Factors 337
WSDL Element 1056 For An Element 317
Message Angle Metric Types 320
Adjust With Duration Constraint 874 Risk Types 322

© 1998-2010 Sparx Systems Pty Ltd

 1934 Index

Metrics And Estimation Package, Create Using Model Wizard 372

TCF 336 Pattern 372
Technical Complexity Factors 336 Pool, BPEL 979
Microsoft Native Remove Recent 56
Debug Symbols 1452 Requirements 917, 922
Set Up Debug Sessions 1451 Requirements, SysML, Create 1007
Microsoft Word Root Node 1213
Special Considerations 1641 Search Tools 1208
Use In RTF Documentation 1638 Sequence Flow, BPEL 980
Migrate Sharing, Introduction 182
BPMN 1.0 Model To 1.1 957 Shortcut 115
MigrateToBPMN11() Shortcut (Capture Current Environment) 117
Function 957, 1753 Shortcut (Direct Definition) 116
Migration Structure 370
From UML 1.3 344 SysML Operational Domain, Create 1007
To UML 2.0 344 SysML Parametric, Create 1002
Mind Mapping SysML System Design 1009
Concept 1087 SysML, Simulate 1005
Diagram 1087 Systems Engineering, Create 986
Disable 1087 Templates, Incorporate In Technology 1146
Elements 1087 Trace Tools 1208
Enable 1087 Transformation 1387
MDG Technology 1087 UML, Specialized 917
Relationship 1087 Upgrade 346
Toolbox Page 1087 What Is A? 372
MiscData 1711 WSDL 1050
Model WSDL, Binding 1057
Activity, BPEL 974 WSDL, Document 1053
Add To Project 112 WSDL, Message 1056
Analysis, Business Processes 931 WSDL, Message Part 1060
Automation Interface 1672 WSDL, Namepace 1051
BPEL Process 961 WSDL, Port Type 1056
BPEL, Create 959 WSDL, Port Type Operation 1059
Business Domain, Create 938 WSDL, Service 1054
Business Processes, Analysis 931 XSD 1040
Business Rules 934 Model Branch
Connect To Version Control Using TFS 253 .EAB File 264
Contents 372 Apply Version Control 264
Context Menu, Project Browser 1213 Check In 261
Data Integrity 344 Check Out 261
Databases 1011 Export 264
Default Diagram, Cancel 437 File 264
Default Diagram, Set 437 Import 265
Default Fonts 357 Model Changes
Delete Element From 534 Auditing 270
Delete Multiple Elements From 534 Record 270
Gateway, BPEL 972 Model Document
Glossary 323 Add Packages As Attributes 1620
Integrity Check 344 Change Package Sequence 1622
Integrity, Run SQL Patches 346 Delete Package Attributes 1621
Issues 331 Delete Packages 1621
Navigation Tools 1208 Document Order 1622
Enterprise Architect User Guide
 Index 1935

Model Document Marker Management 1468

Element 1616 Overview 1277
Element, Create 1619 Package Build Scripts, Manage 1426
Generate Documentation 1623 Pin/Unpin A Package 1428
Identify Search For 1619 Prerequisites 1424
Model Search Sequence 1622 Recursive Builds 1446
Move Package Attributes Between Elements Script Actions, Define 1427
1622 Set Up Debug Session 1447
Overview, Virtual Document 1616 Set Up Debug Session For .NET 1461
Select Template For 1619 Supported Environments 1277
Sequence of Model Document Elements 1622 Synchronize Code 1425
Sequence of Package Attributes 1622 UAC-Enabled Operating Systems 1448
Tagged Values 1619 Workspace Layout 1424
Model Driven Achitecture Model Driven Generation
Overview 1385 Add-Ins 1073
Model Driven Development Environment 1424 Model File
Advanced Debug Techniques, Java 1454 Connect To ASA Data Repository 162
Available Tools 1424 Connect To Data Repository 147
Basic Setup 1425 Connect To MSDE Server Data Repository
Breakpoint Management 1468 165
Build Script, Create 1444 Connect To MySQL Data Repository 148
Build Script, Introduction 1443 Connect To Oracle 10g Data Repository 153
Code Editors 1425 Connect To Oracle 11g Data Repository 153
Debug .NET 1460 Connect To Oracle 9i Data Repository 153
Debug .NET Assembly 1461 Connect To PostgreSQL Data Repository 160
Debug .NET CLR Versions 1462 Connect To Progress OpenEdge Data Repository
Debug .NET With COM Interop Process 1463 165
Debug Apache Tomcat Server Configuration Connect To SQL Server Data Repository 150
1459 Create Access 2007 Repository 123
Debug Apache Tomcat Windows Service 1460 Create Adaptive Server Anywhere Repository
Debug ASP .NET 1463 132
Debug Java 1452 Create Data Repository 123
Debug Java Applets In Internet Browsers 1454 Create Model 120
Debug Java Web Servers 1456 Create MSDE Server Repository 134
Debug JBOSS Server Configuration 1458 Create MySQL Repository 123
Debug Symbols, C++ And Native Applications Create Oracle 10g Server Repository 129
1452 Create Oracle 11g Server Repository 129
Debugger Frameworks 1446 Create Oracle 9i Server Repository 129
Debugger System Requirements 1447 Create PostgreSQL Repository 129
Debugger, Overview 1446 Create Progress OpenEdge Repository 134
Default Script, Set 1428 Create SQL Server Repository 126
External Tools 1425 Enterprise Architect Project Files 112
For C++ Applications 1451 Set Up Adaptive Server Anywhere ODBC Driver
For Microsoft Native Applications 1451 141
For WINE Applications 1450 Set Up Database Model Files 122
General Debug Setup, Java 1453 Set Up MySQL ODBC Driver 135
General Workflow 1425 Set Up ODBC Driver 135
Generate Code 1425 Set Up PostgreSQL ODBC Driver 138
Getting Started 1424 Set Up Progress OpenEdge ODBC Driver 145
Introduction 1489 Model Glossary
Java Debug Session, Attach To VM 1454 Add Item, Glossary Detail Dialog 325
Limitations 1277 Add Item, Glossary Dialog 324
Delete Item, Glossary Dialog 324
© 1998-2010 Sparx Systems Pty Ltd
 1936 Index

Model Glossary To Populate Model Views 1226

Delete Item, Project Glossary Tab 325 Toolbar Options 1231
Filter List, Glossary Dialog 324 Use 1233
Filter List, Project Glossary Tab 325 View 1231
Glossary Dialog 324 Model State Machine
Glossary Report 328 Active State Logic 1319
Modify Item, Glossary Detail Dialog 325 Designate Driving Triggers 1319
Modify Item, Glossary Dialog 324 Establish Port-Trigger Mapping 1319
Project Glossary Tab 325 For Hardware Description Languages 1319
Redefine Entry Type, Project Glossary Tab Model Template
325 Business Process 374
Model Maintenance (.EAP) Class 376
Compact Project 348 Component 378
Introduction 344 Database 377
Rename Project 348 Deployment 378
Repair Project 348 Domain 376
Model Pattern Introduction 373
Introduction 373 Logical 376
Select In Enterprise Architect 28 Maintenance 381
Model Profile Physical 378
Apply 444 Project 381
Save 444 Relational Database 377
Swimlanes Matrix 444 Requirements 374
Zachman 444 Testing 380
Model Search Use Case 375
Access From Add-In 1233, 1781 Model Transfer
Access From MTS File 1233 Introduction 287
Access From Shortcut 115, 117, 1233 Model Transformations
Access From Shortcut (Direct Definition) 116 Submenu (Project Menu) 63
Add Data Columns 1231 Model Validation
Add Filters 1242 BPEL Violations 984
Advanced Search Options 1238 Configure 1530
Conditions 1243 Define Configuration For MDG Technology
Create Search Definition 1239 1145
Define In MTS File 1133 Element Composition Rule 1531
Export Search Definitions 1235 Object Constraint Language 1528
External Access 1233 OCL 1528
Fields 1243 OCL Conformance Rule 1532
Find Object In Diagrams 1234 Of BPEL 984
Find Object In Project Browser 1234 Property Validity Rule 1532
Generate RTF Documentation 1234 Rule, Element Composition 1531
Generate RTF Report 1570 Rule, OCL Conformance 1532
Group Results 1231 Rule, Property Validity 1532
Hyperlink To 840, 1233 Rule, Well Formedness 1531
Import Search Definitions 1235 Rules 1530
Introduction 1231 Submenu (Project Menu) 64
Manage 1235 Well Formedness Rule 1531
Notes Options 1231 Model Validation Broadcasts
Operate On Objects In Results 1234 Add-In Model 1811
Options 1231 EA_OnEndValidation 1813
Process Results Of Search 1231, 1234 EA_OnInitializeUserRules 1812
Remove Data Columns 1231 EA_OnRunAttributeRule 1815

Enterprise Architect User Guide

 Index 1937

Model Validation Broadcasts Model Wizard

EA_OnRunConnectorRule 1814 Add Model Package 372
EA_OnRunDiagramRule 1814 Quick Start 28
EA_OnRunElementRule 1813 Use To Create Model 120
EA_OnRunMethodRule 1815 Modeling
EA_OnRunPackageRule 1813 Behavior Calls 581
EA_OnRunParameterRule 1816 Behaviors (General) 569
EA_OnStartValidation 1812 Enterprise Architect Processes 4
Model Validation Example 1816 Enterprise Architect Tools and Features 48
Model Views Enterprise Architect, Getting Started 26
Automatic Notification 342 Getting Started - Enterprise Architect 26
Context Menu Options 1224 Invocations 581
Define In MTS File 1133 Languages, Introduction 671
Define Search 1226 Systems Engineering 986
Delete (Context Menu) 1224 Tasks With Enterprise Architect 4
Delete (Toolbar) 1223 The Business Process 930
Display Recent Postings 1226 With Diagrams 391
Enable Technology-Defined View 1226 With Elements 478
Export As XML 1226 With Enterprise Architect, Overview 371
Favorites 1222 Modeling Conventions 1282
Favorites Folder, Create (Context Menu) 1224 ActionScript 2 and 3 1283
Favorites Folder, Create (Toolbar) 1223 Ada 2005 1284
For Requirement Change Management 928 ANSI C 1285
Import As XML 1226 C 1285
Monitor Work Flow 342 C# 1287
Move Objects Between Views 1226 C, Object Oriented Programming 1286
Move Objects Into Favorites 1226 C++ 1289
My Views 1222 C++, Managed 1290
Operations 1226 C++/CLI Extensions 1291
Postings From Team Review 1222 Delphi 1292
Properties 1226 Java 1293
Recent Discussions 1222 Java AspectJ Extensions 1294
Recent Post Options 1224 Object Oriented Programming in C 1286
Refresh (Toolbar) 1223 PHP 1294
Refresh Search 1226 Python 1295
Root Node, Create (Context Menu) 1224 SystemC 1295
Root Node, Create (Toolbar) 1223 VB.NET 1296
Slide Show, Run (Manual) 1228 Verilog 1298
Slideshow 1222 VHDL 1299
Slideshow Folder, Create (Toolbar) 1223, 1228 Visual Basic 1301
Slideshow, Automate 1228 Modeling Language
Technology-Defined 1222 Extending 1092
Toolbar Options 1223 Modeling Tool
Use Objects In Views And Favorites 1226 Enterprise Architect 3
View, Create (Context Menu) 1224 Models Collection 1680
View, Create (Toolbar) 1223 Model-View-Controller Pattern 838
Views 1222 ModelWatcher
Views Folder, Create (Context Menu) 1224 Automation Interface Repository 1698
Views Folder, Create (Toolbar) 1223 Modify
Window 1222 Element Changes 1559
Model Violations Element Defects 1559
Examples 1528 Element Issues 1559
© 1998-2010 Sparx Systems Pty Ltd
 1938 Index

Modify Server Data Repository, Connect To 165

Element Tasks 1559 Server Repository, Create New 134
Linked Document Template 603 Upsize To 173
Project Task 330 MTS File
Relationship Using Matrix 1266 Advanced Options 1133
RTF Style Template (Legacy) 1634 Create 1133
Tagged Values 635 Incorporate Model Search 1133
Modules Incorporate Model View 1133
Window 1478 Working With 1133
MOF Multi-page Diagram
Export To XMI 1383 Print 456
Getting Started 1381 Multiple Login
Import From XMI 1383 Under One User ID 197
Introduction 1380 Multiple Select
Monitor Items From Project Browser 431
Events 342 Multiple Stereotype
Progress 342 Restrict Application Of 1110
Work Flow 342 Multiplicity 376
Mouse/Keyboard Connector, Source Role 629
Shortcuts 109 Connector, Target Role 631
Mouseovers Of Connector 665
Code Editor, Common 1432 Of Element 665
Move Of Element, Displayable 483, 549
Attributes Between Elements 545 Of Element, Non-Displayable 484
Connectors 613 MVC Pattern 838
Connectors, Quick Start 34 MyISAM
Diagram Sections 454 BaseModel Script 178
Diagrams, Quick Start 34 MySQL
Elements Between Packages 530 Create Repository 123
Elements By Increments 70, 454 Data Repository, Connect To 148
Elements In Diagrams 529 ODBC Driver, Set Up 135
Elements, Quick Start 34 Table Type, Set 1016
Internal Responsibility To External Requirement Upsize To 178
926
Maintenance Item Between Categories 1561
Nudge Elements 70 -N-
Objects Between Packages 530
Name Template
Operations Between Elements 545
Foreign Key 1028
Package Contents Up Or Down 1210
Primary Key 1022
Packages, Quick Start 34
Namespace
Submenu 70
Clear 1313
Test Between Categories 1544
Dialog 1313
MS Jet
Explanation 1313
Database As Model Repository 122
List 1313
MS Word
Locate In Project Browser 1313
Update RTF Report Links 1646
Root 1313
Use In RTF Documentation 1638
Root Package Icon 1213
MS Word Tables
Set 1313
Apply Styles 1644
WSDL Element 1051
Manipulate 1644
Naming Format
Resize 1644
Camel Case 1422
MSDE
Enterprise Architect User Guide
 Index 1939

Naming Format Window 641

Pascal Case 1422 Notelink
Spaced 1422 Connector 886
Underscored 1422 Insert New From Toolbar 83
N-Ary Relationship 886
Association Element 844 Nudge
Element (Entity Relationship Diagram) 1077 Elements 70, 454
Navigate Numbered Sections
Diagram 1275 In RTF Reports 1601
Navigation And Selection Numbering Levels
Hotkeys, For Diagram 435 Apply 1601
Navigation Compass 76 In Virtual Documents 1623
Neaten Diagram Layout 467 RTF Reports 1601
Nested Version Control Packages 231, 236 Use 1601
Nesting Numbering List
Connector 885 RTF Reports 1601
Relationship 885 Numeric Range Generator
New Action Dialog 745 Timeline Element States 697
New Code Sections NUnit Transformation
Add To Existing Features 1308 MDA-Style Transform 1407
New Project
Menu Option (File Menu) 56
New Search Query 1239 -O-
New Structured Activity Dialog 796
Object
Node Appearance, Options 362
Element 822
Attributes 1415
Non-Selectable Classes 1415
Element 555
Classifiers 519
Normal.rtf Template File 1576 Columns 1415
Notation Connect 610
Co-Region 868
Connector 489
Process Modeling 931
Create From Attribute 568
Note Definition 1415
Add To Link/Connector 612
Element 823
Create Project Glossary Item 641
Elements And Connectors 408
Element 785
Group, Toolbox 408
Element, Create 536
Instance 823
For Attribute 641
Links 489
For Connector 641
Move Between Packages 530
For Diagram 641
Multiplicity 629
For Element 641
Operations 1415
For Operation 641
Packages 1415
Formatting 642
Parameters 1415
Hyperlink Glossary Term 641
Properties 481, 1415
Insert Glossary Item 641
Relationships 489
Insert New From Toolbar 83
Scenario 490
Keyboard Shortcuts 642
State, Set 824
Link To Element Feature 537
Tables 1415
Link To Internal Documentation 537
Transformation 1415
Spell Check 641
Type 1415
Tab 641
Type, Change For Element 532
Toolbar Options 642
© 1998-2010 Sparx Systems Pty Ltd
 1940 Index

Object Constraint Language Select Tables From 1366

Model Validation 1528 Offline
Model Validation Rules For Conformance 1532 Checkout 268
Object Diagram Version Control 268
Description 723 OLE DB Provider
Elements And Connectors 723 Microsoft For Oracle 153
Example 723 Oracle Provider 153
Object Flow Online Resources
Connector 886 Access From Tasks Pane 51
In Activity Diagram 886 Submenu 74
In State Machine Diagram 886 Open
Multiple 886 External Tools 96
Relationship 886 Package From Project Browser 387
Selection Behavior 886 Package Within Diagram 438
Simple 886 Report in Microsoft Word 1638
Transformation Behavior 886 Open Office
With Action Pins 886 Optimize For, In RTF Report Generation 1573
Object Oriented Programming Open Project
C Code Generation For UML Model 1286 Menu Option (File Menu) 56
Limitations 1286 Open Repository
Object Workbench Automation Interface Code Example 1765
Constraints 1521 Open Source Directory
Introduction, Visual Execution Analyzer 1519 Element Code 69
Invoke Method 1522 Open Source File
Modes 1520 Menu Option (File Menu) 56
Overview, Visual Execution Analyzer 1520 Operation
Platforms Upported 1520 Add To Element, In-place Editor 592
Requirements 1521 Appearance 569
Workbench Variables, Constructors 1521 As Action 743
Workbench Variables, Create 1521 Associate With Behavior 573
Workbench Variables, Delete 1521 Behavior Description, Show In Diagram 573
ObjectType Enum Behavior, Initial Code 576
Automation Interface 1677 Business Rule 943
Occurrence Connect To 611
Connector 888 Constraints 577
Element 780 Context Menu, Project Browser 1221
Relationship 888 Copy Between Elements 544
OCL Definition 569
Model Validation 1528 Dialog, Behavior Tab 573
OCL Constraints Dialog, General Tab 570
Attribute 1532 Dialog, Post Tab 577
Element 1532 Dialog, Pre Tab 577
Feature 1532 Disconnect From 611
Model Validation Rules for Conformance 1532 Display Inherited Operation 579
Relationship 1532 Edit Name, In-Place Editor 588
ODBC Edit Parameter Kind 592
Data Modeling 1367 Edit Scope 589
Driver, Set Up 135 Edit Stereotype, In-place Editor 588
ODBC Data Source Element Feature 569
Select 1365 Fast Create 570
ODBC Source Implement Interface Operations 578
Select Stored Procedures From 1366 Implement Parent Operations 578
Enterprise Architect User Guide
 Index 1941

Operation Object Appearance, Element Visibility 363

In Project Browser 569 PHP 1356
Inherited, Show 438 Python 1356
Introduction 569 Sequence Diagram Options 360
Move Between Elements 545 Standard Colors 353
Of State Element, Behavior 573 SystemC 1357
Overide Interface Operations 578 VB.NET 1358
Override Parent Operations 578 Verilog 1358
Parameter Keyword, Edit 591 VHDL 1359
Parameter, By Reference 586 Visual Basic 1360
Parameter, Insert In Element 593 XML Specifications 367
Parameters, Define 583 Oracle
Private, Icon 1213 Package, Create 1022
Properties, Behavior 573 Sequence 1019
Properties, General 570 Sequence Options, DDL For Packages 1369
Properties, Initial Code 576 Sequence Options, DDL For Table 1367
Properties, Postconditions 577 Tables, Set Properties 1017
Properties, Preconditions 577 Tables, Tagged Values 1017
Protected, Icon 1213 Temporary Table 1017
RuleTask, Behavior Call Action 943 Upsize To 175
Show On Diagram 438 Oracle 10g
Tagged Values, Add 577 Data Repository, Connect To 153
WSDL Port Type Operation 1059 Server Repository, Create 129
Operational Domain Model Oracle 11g
SysML, Create 1007 Data Repository, Connect To 153
Options Server Repository, Create 129
Audit 273 Oracle 9i
Compare Utility 284 Data Repository, Connect To 153
Element Visibility 363 Server Repository, Create 129
Read-Only, For Enterprise Architect 15 Order
Reset For A Class 1361 Package Contents 1210
Visual Styles/Themes 101 Other Element Tools
Options Dialog Submenu 59
ActionScript 1348 Other Project Tools
Ada 2005 1348 Submenu 59
Appearance Options 356 Outline
Attribute/Operation Specifications 1341 Red 206
C 1349 Output
C# 1350 Business Modeling 932
C++ 1351 Debugger, View 1478
Communication Message Coloring 366 Debugger, Window 1478
Connector Settings 364 Output Window
Delphi 1352 Audit History Tab 278
Diagram Behavior 359 Context Menu 102
Diagram Settings 355 Override
General Settings 351 Attribute Initializer 567
Introduction 350 Default Toolbox In Toolbox Profile 1136
Java 1355 Implement Parent Operations 578
Links Settings 364 Parent Operations 578
MDG Technology 1360 Overview
Object Appearance 362 Visual Execution Analyzer 1488
Object Appearance, Default Fonts 357
© 1998-2010 Sparx Systems Pty Ltd
 1942 Index

Nested in Version Control 236

Open From Diagram 438
-P- Open From Project Browser 387
Paste Copy 388
Package
Phase, Update 340
Add And Manage, Automation Interface Code
Example 1766 Pin/Unpin, Visual Execution Analyzer 1428
Add Element Directly 524 Profile 1095
Add To Diagram From Toolbox 387 Rename 388
Add To Project Browser 387 Resynchronize Package Version Control Status
267
Add To UML Model, Quick Start 30
Review Version Control History 266
Apply Version Control To Model Branch 264
Save 297
As RTF Bookmark 1639
Save Profile 1107
Automation Interface 1672
Show Contents On Diagram 389
Automation Interface Repository 1698
Specification, For Oracle 1022
Baselines 279
Status, Update 340
Batch Export To XMI 298
Synchronize Contents 1313
Batch Import From XMI 298
Tasks 387
Body, For Oracle 1022
Update Contents 1313
Check In 261
Validate Version Control Configuration 260
Check Out 261
Version Control 228
Comparison, Example 284
Version, Update 340
Configuration 295
Working With 387
Configure For Version Control 259
XML 293
Context Menu, Project Browser 1214
Control, Menu 294 Package Build Scripts
Manage, Visual Execution Analyzer 1426
Control, Remove 296
Controlled 259 Package Context Menu
Add Submenu, Project Browser 1216
Copy 388
Build And Run Submenu, Project Browser
Copy Between Projects 309
1217
Create Diagram 422
Code Engineering Submenu, Project Browser
Create Oracle Packages 1022 1217
CSV Import/Export Specification 300 Contents Submenu, Project Browser 1218
Delete In Project Browser 390 Documentation Submenu, Project Browser
Duplicate 388 1216
Element 825 Import/Export Submenu, Project Browser 1218
Existing, Drag Onto Diagram 389 Package Control
Export 293 Options, Dialog 295
Export To XMI Stubs 295 Package Diagram
Export Version Controlled Model Branch 264 Description 720
Hide Contents On Diagram 389 Elements And Connectors 720
Icon Overlays 1213 Example 720
Import 293 Package Import
Import Version Controlled Model Branch 265 Connector 888
Load 297 Relationship 888
Lock 205 Package Merge
Lock, Require User Lock 205 Connector 888
Lock, User/Group Lock 204 Relationship 888
META-INF 1397 Package Scenarios
Modeling With 387 Import As Test Scenarios 1544
Move 34 Package Structure
Move Element Between 530 BPEL 959
Move Objects Between 530 Packaging Component
Enterprise Architect User Guide
 Index 1943

Packaging Component Part

Element 845 Add Property Value 826
Page Element 825
Footer, Print On Diagram 425 Property Tab 829
Header, Print On Diagram 425 Qualifiers 832
Setup, Menu Option (File Menu) 56 Represent On Sequence Diagram 714
Size, Set For Diagram 455 Partial Class
Pan Generate 1311
Diagram View 453 Partition
Pan And Zoom Activity 786
Diagram 1275 Docking 786
Window 1275 Element 786
Paragraph Numbering Horizontal 786
In RTF Style Template Editor 1593 Vertical 786
Parameter Partitions Collection
Activity 583 Automation Interface, ElementFeatures Package
Automation Interface, ElementFeatures Package 1736
1735 Pascal Case
Behavior 583 Naming Format 1422
Behavior Call Arguments 582 Password
Behavior, Tagged Values 585 Administrator Change 202
Behavioral, Edit 583 Administrator Set 202
Behavioral, Extend 583 Security, Change 191
Behavioral, Reassign 583 User Change 202
Behavioral, Set 583 Password Encryption
Behavioral, Synchronize Call Argument With Prior To Release 7.1 Of Enterprise Architect
582 200
Behavioral, Synchronize Invocation Argument Password Encryption (Repository)
With 582 At Release 7.1 Of Enterprise Architect 115,
Dialog 583 119
For Rule Flow Activity 942 Paste
Interaction 583 Activity As Action 432
Kind Inout, By Reference 586 Activity As Link 432
Operation 583 Composite Element 431
Operation, By Reference 586 Connectors Between Pasted Activities 432
Reference 586 Connectors Between Pasted Instances 430
Show Details On Diagram 429 Copy Of Element 531
Variables In Business Rules 942 Copy Of Package 388
Parameter Information Diagram Into Package 436
Display In Source Code 1442 Element From Project Browser 430
Parameter Kind Element On Diagram 433
Edit for Element Operation 592 Multiple Items As Children 431
Parameterized Classes (Templates) 813 Multiple Items As Instances 431
Parametric Multiple Items As Links 431
Diagram 1002 Multiple Items From Project Browser 431
Diagram, Simulate SysML Model 1005 Object As Child 430
Model, SysML, Create 1002 Object As Link 430
Parent Object As New Instance 430
Confirm Element As Parent 529 Paste Element Dialog 430
Set For Element 526 Paste Elements
Parse As Link 58
Source Code Files In Viewer 1441 As New 58

© 1998-2010 Sparx Systems Pty Ltd

 1944 Index

Paste Elements Action 749

From Clipboard As Metafile 58 Add To Action 749
Menu Option (Edit Menu) 57 As Action Property 751
Submenu (Edit Menu) 58 As Argument For Call Action 749
Patches Assign To Action 749, 751
SQL, Run 346 Connector End Point 84
Pattern Connector Start Point 84
Action, Modify 904 Properties 749
Actions 902 Toolbox Pages 401
Add To MDG Technology 1123 Pkg Import
Create From Diagram 902 Connection 888
Default, Change 904 Relationship 888
Design 901 Pkg Merge
Gang of Four 901 Connector 888
GoF 901 Relationship 888
GoF, Download 904 Place Recording Markers
Import Into Model 904 Execution Analysis, Recording Sequence
In Resources View 902 Diagrams 1499
Model-View-Controller 838 Platform Naming Conventions 1422
MVC 838 Platform Specific Model 1385
Save 902 Platform-Independent Model 1385
Save From Diagram 902 Pool (BPEL)
Pause Recording Create 979
Execution Analysis, Recording Sequence Model 979
Diagrams 1505 Port
PDATA Add To Element 827
Diagram Profile Attribute Values 1140 Element 826
Element Attribute In MiscData, Object Model For Trigger Element 804
1711 Inherited 827
People Property Tab 829
As Project Resources 650 Qualifiers 832
Assign To Changes 1566 Redefined 827
Assign To Defects 1566 Represent On Sequence Diagram 714
Dialog 645 Port Type
Settings 645 WSDL Diagram 1056
Per Page Diagram Layout 464 WSDL Element 1056
Performance Port Type Operation
Of Enterprise Architect 148, 150, 153, 160, WSDL 1059
162, 165, 180, 270
Position Elements 70
Permission List Post
User Security 198 Add To Team Review 213
PHP Create In Team Review 213
Code Generation 1356 Create Reply 214
Import, Reverse Engineering 1331 Delete 209
Language Options 1356 Delete In Team Review 215
Modeling Conventions 1294 Edit In Team Review 215
Physical Model 378 Reply To In Team Review 214
PI Macro Post-Constraint
Code Template Syntax 1190 RTF Report Template Section 1585
PIM PostgreSQL
Internal Bindings 1385 Data Repository, Connect To 160
Pin ODBC Driver, Set Up 138

Enterprise Architect User Guide

 Index 1945

PostgreSQL Description 1022

Repository, Create 129 Extended Properties 1024
Upsize To 173 Name Template, Define 1022
Post-New Events Simple 1022
Add-In Model 1798 SQL Server, Non-Clustered 1024
EA_OnPostNewAttribute 1801 Primitive
EA_OnPostNewConnector 1799 Element 829
EA_OnPostNewDiagram 1800 Print
EA_OnPostNewDiagramObject 1800 Diagram (Single) From Project Browser 1220
EA_OnPostNewElement 1798 Diagrams (Multiple) From Project Browser
EA_OnPostNewMethod 1801 1220
EA_OnPostNewPackage 1802 Menu Option (File Menu) 56
Pre/Post Conditions Multi-page Diagrams 456
Constraints 752 Page Footer On Diagram 425
Local 752 Page Header On Diagram 425
Notes 752 Preview, Menu Option (File Menu) 56
On Actions 752 Project Issues 332
Precede Scaled Image 456
Connector 406 Setup, Menu Option (File Menu) 56
Pre-Constraint Task List 329
RTF Report Template Section 1585 Print Preview
Predefined Tag Type Display 395
Assign To Stereotype 1099 Multiple Pages 395
Define 1099 Private Key
Predefined Tagged Value Type Add 1870
Filters 1166 Private Model
Reference Data 1169 And Version Control Using TFS 253
Structured 1166 Problem Type
Syntax 1166, 1169 Define 660
Pre-Deletion Events Process
Add-In Model 1790 BPEL, Properties 961
EA_OnPreDeleteAttribute 1791 Element 846, 931
EA_OnPreDeleteConnector 1792 Element (Data Flow Diagram) 1076
EA_OnPreDeleteDiagram 1792 Model Template 374
EA_OnPreDeleteElement 1790 Modeling 374
EA_OnPreDeleteMethod 1791 Process Memory
EA_OnPreDeletePackage 1793 Inspect 1476
Pre-New Events Process Modeling Notation 931
Add-In Model 1793 Professional Edition
EA_OnPreNewAttribute 1796 Of Enterprise Architect 12
EA_OnPreNewConnector 1794 Upsize From 122
EA_OnPreNewDiagram 1795 Profile
EA_OnPreNewDiagramObject 1795 Add Attribute To Diagram 909
EA_OnPreNewElement 1793 Add Connector To Diagram 909
EA_OnPreNewMethod 1797 Add Element To Diagram 909
EA_OnPreNewPackage 1797 Add Elements 1096
Preprocessor Macros 1344 Add Enumeration Elements 1103
Preserve Hierarchy Add Metaclasses 1096
CSV Specification 300 Add Operation To Diagram 909
Primary Key Add Shape Script 1104
Complex 1022 Add Stereotypes 1096
Create 1022 Add To MDG Technology 1122
© 1998-2010 Sparx Systems Pty Ltd
 1946 Index

Profile Stop 1517

And Element Templates 542, 906, 1093 Supported Platforms 1516
Constraints 1101 System Requirements 1516
Create 1095 Team Review, Save Report As Resource 1519
Diagram, Create 1139 Toolbar 1516
Elements And Connectors 414 Progress OpenEdge
Export To Disk 1106 Data Repository, Connect To 165
Group, Toolbox 414 ODBC Driver, Set Up 145
Import 908 Server Repository, Create 134
Import From XML 906, 1093 Upsize To 171
Package 1095 Project
References 912 Administration, Security Permissions 189
Save 1106 Author 645
Save From Diagram 1107 Browser 1209
Save From Package 1107 Change Control 1557
Set Default Appearance Of Stereotype Objects Clean 344
1106 Clients 651
Stereotype 1095, 1113 Compact .EAP File 348
Stereotypes 906, 1093 Compare With Other Project 308
Swimlanes Matrix 444 Comparison, Why? 308
Tagged Values 910 Configure 120
Tags 1098 Constants 1614
Tasks Pane, Create 1141 Create In Enterprise Architect, Tutorial 28
Toolbox 1134 Data Integrity 344
UML, Constraints Supported 912 Data, Transfer 307
UML, Example File 915 Develop In Team Environment, Introduction
UML, Metafiles Supported 912 182
UML, Structure 913 Development, Introduction 111
UML, Supported Attributes 914 EABase 27
UML, Tags Supported 912 Estimation 335
Use 907 Explorer 1209
Work With 1095 File, EABase 120
Zachman 444 Glossary 323
Profile Connector Integrity Check 344
Add To Diagram 909 Integrity, Run SQL Patches 346
Profile Element Issues 323, 331
Add To Diagram 909 Items, Add Via Toolbar 81
Profiler Maintenance 1557
Attach To Process 1517 Menu 60
Getting Started 1516 Metrics 335
Launch 1517 Model Template 381
Operation 1517 Open Existing 112
Overview 1514 Recover 344
Prerequisites 1516 Remove Recent 56
Report, Example 1514 Rename .EAP File 348
Report, Load 1518 Repair Project .EAP File 348
Report, Save 1518 Resources 650
Report, Save As Resource In Team Review Roles 648
1519 Share, DBMS Repository 183
Set Options 1518 Share, Network Drive 183
Set Sample Intervals 1518 Share, Replication 183
Start 1517 Sharing, Introduction 182

Enterprise Architect User Guide

 Index 1947

Project Toolbar 1212

Spell Checking 1552 Version Control Indicators 233
Statistics, View 60 Views 1209
Structure 370 Project Constant
Tasks 37, 323 RTF Reports 1614
Timescale Estimation 335 Project Custom Colors
Toolbar 81 Get For Element 540
Transfer 178 Set For Element 540
Upgrade 346 Project Discussion Forum
Use The Model Search 1233 Now Team Review 208
View 1209 Project Factor Calibration 335
What Is A? 113 Project File
Project Branch Create 112
Check In 261 Example 114
Check Out 261 Open 114
Project Browser Project Glossary
Attribute Context Menu 1221 Add Item, Glossary Detail Dialog 325
Collapse Contents 1218 Add Item, Glossary Dialog 324
Context Menus 1213 Create Item From Notes Text 641
Default Behaviour 1210 Delete Item, Glossary Dialog 324
Diagram Context Menu 1220 Delete Item, Project Glossary Tab 325
Element Context Menu 1218 Filter List, Glossary Dialog 324
Element Context Menu, Add Submenu 1219 Filter List, Project Glossary Tab 325
Exclamation Marks 206 Glossary Dialog 324
Expand Contents 1218 Glossary Report 328
Free Sorting 1210 Hyperlink Term From Notes 641
Hide And Show 1209 Insert Item In Text 641
Icon Overlays 1213 Modify Item, Glossary Detail Dialog 325
Icon, User-Defined 1108 Modify Item, Glossary Dialog 324
Introduction 1209 Redefine Entry Type, Project Glossary Tab
Method Context Menu 1221 325
Model Context Menu 1213 Tab 325
Move Items Within 1209 Project Indicators
Open Package 387 Risk Types 322
Operation Context Menu 1221 Project Interface
Order Package Contents 1209 Automation Interface 1753
Package Context Menu 1214 Project 1753
Package Context Menu, Add Submenu 1216 Project Issue
Package Context, Build And Run Submenu Add 334
1217 Delete 334
Package Context, Code Engineeiing Submenu Dialog 331
1217 Modify 334
Package Context, Contents Submenu 1218 Print List 332
Package Context, Documentation Submenu Record 331
1216 Report, Via Project Issues Dialog 334
Package Context, Import/Export Submenu Report, Via Project Issues Tab 334
1218
Tab 332
Reload Current Package 1218
Project Management
Reset Sort Order 1218
Asterisk On Window Tabs 313
Scripts 1663
Default Hours 340
Selective Collapse of Packages 1209
Effort Management 315
Show Level Numbering 1214
Effort Types 319
Show Stereotypes 1210
© 1998-2010 Sparx Systems Pty Ltd
 1948 Index

Project Management Create Post 213

Environment Complexity Factors 337 Create Reply 214
Introduction 312 Delete Item 215
Maintenance 1558 Edit Item 215
Metric Types 320 Editor 215
Metrics 312, 317 Icons 208
Resource Allocation 314 Introduction 208
Resource Report 318 Load Data When Required 218
Resources 312 Loading Behavior 218
Risk Management 316 Mark All Posts Unread 218
Risk Types 322 Options 218
Risks 312 Preload 218
Technical Complexity Factors 336 Reply To Post 214
Toolbar 312 Search 217
Window 312, 313 Was Discussion Forum 208
With Enterprise Architect 312 Project Version Control Menu 256
Project Manager ProjectIssues
And Enterprise Architect 43 Automation Interface Repository 1703
Project Estimation 43 ProjectResource
Project Role 43 Automation Interface Repository 1704
Resource Management 43 Properties
Risk Management 43 Automation Interface, ElementFeatures Package
Project Role 1736
And Enterprise Architect 37 Behavior Tab 581
Business Analyst 38 Call Tab 581
Database Administrator 47 Connector, Menu Section 607
Deployment and Rollout 45 Constraints, Scenario 507
Developer 42 Dialog, Element 481
Implementation Manager 45 Editor Language 1338
Project Manager 43 Effect Tab 743
Software Architect 40 Element 481
Software Engineer 41 Element Context Menu 548
Technology Developer 46 Element, Associated Files 507
Tester 43 Element, Connectors 489
Project Settings Element, Constraints 488
Configure (Settings Menu) 73 Element, Details 484
Project Task Element, External Requirements 487
Add 330 Element, General 482
Delete 330 Element, Generalizable 483
List 329 Element, Internal Requirements 485
Modify 330 Element, Links 489
Tab, Print List 329 Element, Relationships 489
Project Team Review Element, Requirements 485
Access 208 Element, Tagged Values Tab 508
Add External File Link To Post 216 Element, Trigger Tab 804
Add New Category 211 Extend For Requirements 920
Add New Post 213 Object 481
Add Object Link To Post 216 Of Classifiers, Composite Structure Diagram
Add Team Review Link To Post 216 726
Connections To Other Team Reviews 218 Of Requirements, Extended 920
Copy Path To Clipboad 218 Of Requirements, Standard 919
Create Category 211 Requirement, Display On Diagram 920, 921

Enterprise Architect User Guide

 Index 1949

Properties Join 773, 776

Window (Element) 508 PSM 1385
Properties Note Python
Diagram 440 Code Generation 1356
Properties, Import, Reverse Engineering 1331
Part, Property Tab 829 Language Options 1356
Port, Property Tab 829 MDG Technology For, Enterprise Architect
Properties, EASL 1073
Action 1196 Modeling Conventions 1295
Argument 1196
Behavior 1196
Call Event 1196
-Q-
ChangeEvent 1196 Qualified Association 830
Classifier 1196 Qualifier
Condition 1196 Association End 832
Construct 1196 Association Property 830
Edge 1196 Attribute 832
EventObject 1196 Attribute Property 830
Instance 1196 Dialog 832
Parameter 1196 Part 832
Primitive 1196 Part Property 830
PropertyObject 1196 Port 832
SignalEvent 1196 Port Property 830
State 1196 Set Properties 832
StateMachine 1196 Quality Control 1527
TimeEvent 1196 Model Validation 1528
Transition 1196 Spell Checking 1552
Trigger 1196 Testing 1536
Vertex 1196 Query Builder
Property Search Definition 1239
Automation Interface, ElementFeatures Package Query Methods
1736
In Shape Scripts 1158
Redefined 517
Quick Add
Select, Dialog 517
Tagged Values 634
Subsetted 517
Quick Linker 610
Property Validation Arrow 474
Attribute 1532
Connector Names, In Definitions 1117
Element 1532
Create Connector 476
Feature 1532
Create Element And Connector 475
Relationship 1532
Default Settings, Hide 1117
Property Value Definition Format 1113
Part, Add To 826
Element Names, In Definitions 1117
PropertyType Example 1115
Automation Interface Repository 1704
Introduction 474, 1113
PropType Enum Options 475
Automation Interface 1678
Quick Start
Proxy Add Connectors To UML Model 32
(Shortcut) File 115
Add Diagram To Package 30
Pseudo-State Add Diagram To UML Model 30
Elements 682
Add Element To Diagram 31
Fork 773, 775
Add Element To UML Model 31
In State Machine Diagram 682
Add Package to UML Model 30
© 1998-2010 Sparx Systems Pty Ltd
 1950 Index

Quick Start Execution Analysis, Record Sequence Diagram

Auditing 271 1498
Create A Project In Enterprise Architect 28 Record Arguments To Function Calls
Define Connector Properties 33 Build Script, Sequence Diagram Recording Tab
Define Element Properties 33 1494
Delete UML Model Components 35 Record Calls To Dynamic Modules
Generate HTML Report 1647 Build Script, Sequence Diagram Recording Tab
1495
Generate RTF Report 1570
Record Calls To External Modules
Move Project Components 34
Build Script, Sequence Diagram Recording Tab
Project Tasks 37 1494
Save Project Changes 36 Record Macro
View HTML Report 1647 In Source Code Editor 1442
Record Sequence Diagrams
-R- Automatic Recording 1504
Control Recording 1504
Rational Rose Execution Analysis, Advanced Techniques
And XMI 288 1497
Export To 293 manual Recording 1504
Rational Software Architect Pause Recording 1505
Models 291 Resume Recording 1505
Rational Software Modeler Stop Recording 1505
Import *.emx Files 290 Record State Changes
Import *.uml2 Files 290 Visual Execution Analyzer 1511
Read-Only Options Recording Actions
For Enterprise Architect 15 Create Sequence Diagram, Call Stack 1480
Realization Debugger, Overview 1480
Connector, Quick Generation Of 921 Debugger, Step Through Function Calls 1480
Realization Link Save Call Stack 1482
Implement Parent Operations 578 Recording History
Override Parent Operations 578 Save, Execution Analysis 1507
Realize Recording Markers
An Information Flow 866 Activate, Execution Analysis 1503
Connector 889 Breakpoints And Markers Window, Execution
Analysis 1503
Relationship 889
Difference From Breakpoint 1503
Realized Interfaces
Disable, Execution Analysis 1503
For Class, Show On Diagram 452
Marker Types, Execution Analysis 1499
Receive
Place, Execution Analysis 1499
Element 787
Set, Execution Analysis 1502
Event 839
Work With Marker Sets, Execution Analysis
Recent Discussions 1503
Concerning Model View Items 1222
Recover
Recent Post Options Dialog 1224 Controlled Package 299
Recent Postings Project 344
Display 1226
Rectangle Notation
Reception Element Menu Option 549
Definition 834 For Use Cases 808
Of Signal 834
Recursion
Record & Analyze Window 1506 Connector 890
Record Activity For Class Message 890
Execution Analysis, Record Sequence Diagram Relationship 890
1497
Recursive Builds
Record Activity For Method
Enterprise Architect User Guide
 Index 1951

Recursive Builds Refresh

Visual Execution Analyzer 1446 Diagram 267
Red Image 447
Border 206 Project 267
Exclamation Mark 206 View Of Shared Model 267
Letter A 597, 599 Region
Object Outline 206, 457, 555 Composite State 681
Triangle 341 Concurrent Substate 681
Redefined Port Element 788
Manage 827 Expansion, Element 769
Redefinition Interruptible Activity, Element 781
Connector 414 On Composite State 790
Redo State Machine 681
Last Action, Diagram Edits 458 Register
Re-entrancy Add-Ins 1876
In Add-Ins 1779 Enterprise Architect 22
Reference Registration Key
Automation Interface 1671 In License Information 1869
Automation Interface Repository 1705 Registry Settings 90
Reference Data 644 User 350
And Version Control 231 Related Elements
Cardinality (Multiplicity) 665 Find 433
Clients 651 Insert With Context Menu 551
Constraint Status Types 656 Place On Current Diagram 433
Constraint Types 655 Relational Database
Estimation 659 Model Template 377
Export 223 Relationship
Export, Introduction 223 Activity Edge 867
General Types 653 Aggregate 854
Import Automatically 225 Application 414
Import Manually 225 Archimate 1073
Import, Introduction 223 Assembly 855
Maintenance 660 Associate 855
Metrics 659 Association 855
People 645 Association Class 856
Problem Types 660 Asynchronous Signal 877
Project Author 645 BPMN 952
Requirement Types 657 Communication 859
Resources 650 Communication Path 858
Roles 648 Compose 858
Scenario Types 658 Composite Aggregation 858
Share 223 Connector 859
Status Types 653 Control Flow 860
Stereotypes 662 Create Using Relationship Matrix 1266
Tagged Value Types 664 Data Flow 1076
Testing Types 661 Delegate 861
UML Types 662 Delete 489
Reference Data Tagged Value Type 1169 Delete Using Relationship Matrix 1266
Reference Data Tagged Values Dependency 861
Create 1170 Dependency, Apply Stereotype 862
Referenced XML Schema Deployment 862
Import 1373 Display Options 364
© 1998-2010 Sparx Systems Pty Ltd
 1952 Index

Relationship Window, Context Menu 1269

Element (Entity Relationship Diagram) 1077 Relationship Matrix
Entity Relationship Diagram 1077 Access 1262
Eriksson-Penker 1080 Access From Shortcut 115, 117
Extend 862 Access From Shortcut (Direct Definition) 116
Extension (Profile Toolbox) 414 Create Relationship 1266
Generalization 863 Delete Relationship 1266
Generalize 863 Export To CSV 1267
Generalize (Profile Toolbox) 414 Incorporate In HTML Report 1265
Hide 489 Incorporate In RTF Report 1265
Implements 889 Introduction 1261
Include 864 Link Direction 1263
Information Flow 864 Link Type 1263
Inheritance 863 Locate Elements 1268
Interrupt Flow 867 Manage Display Content 1265
List, On Context References Tab 506 Modify Relationship 1266
Manifest 867 Open 1262
Matrix, In Traceability 1251 Options 1265
Message 867 Print Matrix 1265
Mind Mapping 1087 Print Preview 1265
Modify Using Relationship Matrix 1266 Profile, Delete 1267
Nesting 885 Profile, Save 1267
Notelink 886 Profile, Update 1267
Object Flow 886 Review Elements 1268
Occurrence 888 Save As .EMF File 1265
Package Import 888 Save As .PNG File 1265
Package Merge 888 Scale Printout Width 1265
Pkg Import 888 Set Element Type 1262
Pkg Merge 888 Set Link Direction 1263
Realize 889 Set Link Type 1263
Recursion 890 Set Source Package 1264
Redefinition 414 Set Target Package 1264
Representation 891 Relationships Window
Represents 891 Context Menu 433
Role Binding 890 Reload
Self Message 871 Diagram 267
Show 489 Model (Shared) 267
SysML Activity 996 Project 267
SysML Block Definition 992 View 267
SysML Interaction 998 Reload Current Project
SysML Internal Block 994 Menu Option (File Menu) 56
SysML Model 991 ReloadType Enumeration
SysML Parametric 995 Automation Interface 1678
SysML Requirement 1001 Remove
SysML State Machine 999 Package Control 296
SysML Use Case 1000 Recent Project 56
Tagged Value (Profile Toolbox) 414 Replication 186
Trace 892 REMOVE_PREFIX 1422
Transition 892 Rename
Usage 894 Diagram 434
Use 894 Package 388
Visibility 619 Project .EAP File 348
Enterprise Architect User Guide
 Index 1953

Rename Create 122

Views 384 Datatype 1696
Re-Order Encrypt Password 115, 119
Messages 880 EventProperties 1697
Repair EventProperty 1697
Project .EAP File 348 Methods 1680
Replace ModelWatcher 1698
Linked Document 602 MSDE Server, Create 134
Replica Open, Automation Interface Code Example
Create 185 1765
Synchronize 186 Package 1698
Upgrade 186, 347 Package, Automation Interface 1679
Replication Progress OpenEdge, Create 134
And Version Control 256 ProjectIssues 1703
Change Collisions 184 ProjectResource 1704
Create Design Masters 185 PropertyType 1704
Create Replicas 185 Reference 1705
Disable 184 Set Up Database 122
Introduction 184 Stereotype 1706
Merge Rules 184 Task 1707
Remove 186 Term 1708
Resolve Conflicts 187 Transfer Data Between 306
Synchronize Replicas 186 Use Extras, Automation Interface Code Example
Upgrade Replicas 186 1772
Using 184 Representation
Connector 891
Reply
To Post In Team Review 214 Relationship 891
Report Represents
Dependency 1624 Connector 891
HTML 1568, 1647 Relationship 891
Implementation 1626 Require User Lock
Open In Microsoft Word 1638 Apply User Lock 205
Project Issues, Via Project Issues Dialog 334 Release User Lock 205
Project Issues, Via Project Issues Tab 334 Require User Lock Policy 190
Rich Text Format 1568, 1569 Requirement
RTF 1568, 1569 Aggregation 921
Testing Details 1549 Analysis 374
And Level Numbering 922
Report View
Now Element List 1255 And Use Cases 922
Auditing 928
Reporting
Dependency 929 Automation Interface, Element Package 1719
Implementation 929 Autonumbering 918
Requirements 929 Baselines 928
Change Management 928
Repository
Access Permissions For 122 Changes 928
Adaptive Server Anywhere, Create 132 Color Code Status 920
Attributes 1680 Connect On Diagram 921
Author Collection 1693 Connect Through Relationship Matrix 921
Automation Interface 1680 Connectors 921
Client Collection 1694 Convert From Responsibility 926
Collection Class 1695 Create In Diagram 918
Connect To 122 Create In Project Browser 918

© 1998-2010 Sparx Systems Pty Ltd

 1954 Index

Requirement Requirement Type

Create SysML Model 1007 Define 657
Dependency Report 929 Requirements Diagram
Docked Windows 927 Description 736
Element 846, 922 Elements And Connectors 736
Element Template 920 Example 736
Element, Hide/Show Connectors 621 Requirements Management
Elements And Connectors 418 And Enterprise Architect 917
Extend Properties, Default Format 920 Enterprise Architect 5
External 487, 922 In Example Model 917
Fast Generate Realization Connector 921 Overview 917
Functional 485 Requirements Model
Gather 917 SysML, Create 1007
Group, Toolbox 418 Requirements Modeling
Hide Stereotype Letter 846, 918 Enterprise Architect 5
Hierarchies 922 Reserved Names
Implementation Report 929 In Shape Scripts, Connectors 1161
Import Via CSV 922 In Shape Scripts, Elements 1161
Inherited, Show 438 Reset Options
Internal 485, 925 For A Class 1361
Internal, Import As Test 1547 For All Classes 1361
Internal, In Scenarios & Requirements Window Source Code Language 1212, 1361
514 Reset Sort Order
Issues 928 In Project Browser 34
Manage 927 Resize
Model 917, 922 Element 533
Model Template 374 Element By Increments 533
Model Views 928 Multiple Elements 533
Modeling 374 Resolve Change Conflicts
Non-Functional 485 Between Replicas 187
Profile 920 Resource
Properties, Display On Diagram 921 Add To Team Review Item 209
Properties, Extended 920 Allocation 314
Properties, Standard 919 And Tasking Details Dialog 318
Realization 921 Automation Interface, Element Package 1720
Report Template 929 Delete From Team Review Item 209
Reporting 929 Report 318
Requirements Management 374 Resource Document
Review 927 RTF Generator (Enhanced) 1606
Show Stereotype Letter 846, 918 RTF, Batch Generate Reports 1606
Stability 485 Resource Management 313
Status, Color Coded 920 Effort Types 319
Tagged Values 920 Metric Types 320
Tagged Values, Display 921 Risk Types 322
Template 374 Resources
Trace Through Connectors 921 Define 650
Trace Use Of 928 Documents 667
User-Defined Attributes 920 Favorites Folder 667, 669
View 928 Matrix Profiles 667
What Is A? 917 MDG Technologies 667
Windows For Tracing Use 928 Project Management Window 312
Windows For Viewing 928 Scripts 667
Enterprise Architect User Guide
 Index 1955

Resources Visual Studio 1334

Templates 667 Reverse Synchronization
UML Patterns 667 Delete Attribute If Not In Code 1341
UML Profiles 667 Delete Method If Not In Code 1341
Window 667 Delete Model Aggregations For Attributes Not In
Window, And MDG Technologies 1067 Code 1341
XSL Stylesheets 667 Delete Model Associations For Attributes Not In
Code 1341
Resources View
Of Patterns 902 Include Method Bodies In Model 1341
Responsibility Review
Compartment, Element 521 Package Version Control History 266
Define 925 Requirements 927
Import As Test 1547 Rich Text Format
Internal 485 Copy Bookmark To Clipboard 1216
Move To External Requirement 926 Document 1569
Report 1569
Result
End Event, BPEL 965 Rich Text Format Generator
Enhanced 1573
Resume Recording
Execution Analysis, Recording Sequence Rich Text Format Report
Diagrams 1505 Apply Filter (Legacy) 1630
Resynchronize Diagram Format (Legacy) 1631
Package Version Control Status 267 Diagram Only 1625
Reusable Subsystems Dialog (Legacy) 1628
Systems Engineering Modeling 1011 Element-Level 1570
Reverse Connector 623 Exclude Elements (Legacy) 1630
Reverse Engineer Exclude Objects (Legacy) 1630
Enterprise Architect 5 Exclude Package 1573
Source Code 1328 Generate (Enhanced) 1570
Reverse Engineering Generate (Legacy) 1634
And Auditing 279 Generate From Element List 1255
And MDG Integration 1334 Generate, Quick Start 1570
Directory Structure 1332 Generator (Legacy) 1628
Eclipse 1334 Include Glossary (Legacy) 1631
Handling Classes Not Found During Import Include Issues (Legacy) 1631
1335 Include Package 1573
Import ActionScript 1331 Include Tasks (Legacy) 1631
Import Binary Module 1334 Object Selections (Legacy) 1633
Import C 1331 Options (Legacy) 1632
Import C# 1331 Save As RTF Document (Enhanced) 1606
Import C++ 1331 Save As RTF Document (Legacy) 1636
Import Delphi 1331 Set Main Properties (Legacy) 1629
Import Java 1331 Single Element (Legacy) 1629
Import PHP 1331 Templates, Load (Legacy) 1634
Import Python 1331 Through Element List 1570
Import Source Code 1329, 1335 Through Model Search 1570
Import Visual Basic 1331 Wizard (Legacy) 1628
Import Visual Basic.Net 1331 Rich Text Notes
Initial Code In Operations 576 In Legacy RTF Generator Reports 1628
Introduction 1281 Rigorous Security Mode
ODBC Data Sources 1363 Apply User Lock 205
Source Code, Import Directory Structure 1332 Release User Lock 205
Synchronize Model And Code 1327 Risk

© 1998-2010 Sparx Systems Pty Ltd

 1956 Index

Risk Document Options, From Diagram (Legacy)

Automation Interface, Element Package 1721 1571
Management 316 Enhanced 1573
Risk Types RTF Report
Define 322 Advanced Options 1607
Global 322 Apply Filter (Legacy) 1630
Non-Global 316 Bookmarks 1639
Risks Bookmarks, In Master Document Elements
Project Management Window 312 1616
Custom Language Settings 1615
Roadmap
ICONIX 1084 Custom Language Settings (Legacy) 1637
Diagram Format (Legacy) 1631
Robustness Diagram 836
Generate From Scenario 499, 504 Diagram Only 1625
Dialog (Legacy) 1628
Role
Context Menu 606 Document Options (Enhanced Generator)
1607
Define 648
Element Filters 1611
Tagged Values 631
Element-Level 1570
Role Binding
Exclude Elements (Legacy) 1630
Connector 890
Exclude Objects (Legacy) 1630
Relationship 890
Exclude Package 1573
RoleTag
Footers, Add 1643
Automation Interface, Connector Package
1744 Generate (Enhanced) 1570
Generate (Legacy) 1628, 1634
Rollback Change
Options 285 Generate From Element List 1255
Generate, Quick Start 1570
Round-Trip Engineering
Introduction 1281 Headers, Add 1643
In MS Open Office 1607
RSA
Models 291 In Sun Open Office 1573
XMI 290 Include Glossary (Legacy) 1631
Include Issues (Legacy) 1631
RSM
Import *.emx Files 290 Include Package 1573
Import *.uml2 Files 290 Include Tasks (Legacy) 1631
Keywords (Legacy) 1637
RTF
Copy Bookmark To Clipboard 1216, 1220 Object Selections (Legacy) 1633
Documentation 1568, 1569 Open Office Display 1607
Documentation, Other 1624 Options (Legacy) 1632
List Overrides 1601 Other Filters 1612
Numbered Sections 1601 Project Constants, User Defined 1614
Numbering Levels 1601 Quick Start 1570
Numbering List 1601 Save As RTF Document (Enhanced) 1606
Report 1568, 1569 Save As RTF Document (Legacy) 1636
Section Numbering 1601 Set Main Properties (Legacy) 1629
Single Element (Legacy) 1629
RTF Document Options
RTF Generator (Enhanced) 425 Switch Generator 1607
RTF Generator (Legacy) 425 Templates, Load (Legacy) 1634
Through Element List 1570
RTF Generator
Document Options (Enhanced) 425 Through Model Search 1570
Document Options (Legacy) 425 Update Links In MS Word 1646
Document Options, From Diagram (Enhanced) Wizard (Legacy) 1628
1571 Word Substitution 1615
RTF Report Template

Enterprise Architect User Guide

 Index 1957

RTF Report Template Redo Edit 1587

Add To MDG Technology 1132 Repagination 1595
RTF Style Editor (Legacy) 1634 Revert To Previous Copy 1588
RTF Style Template Save File 1588
Create 1576 Scenario Sections 1585
Delete 1576 Search and Replace Options 1605
Edit 1576 Sections 1599
Export To Reference File 1576 Select Model Elements 1579
Import From Reference File 1576 Select Text 1589
Normal.rtf 1576 Show Headers & Footers 1590
RTF Style Template Editor Special Text 1600
Add Content 1586 Split Rows 1581
Bookmarks 1597 Style Sheets 1600
Character Formatting 1592 Tab Support (Enhanced) 1595
Character Styles 1592 Table Commands 1597
Child Sections 1584 Table of Contents 1600
Columns 1599 Tabular Sections 1581
Commands 1587 Text Frame 1604
Constraint Sections 1585 Text Scrolling 1588
Continuous Table 1581 Undo Edit 1587
Copy Text 1589 Update Styles 1588
Cut And Paste 1589 ValueOf Field 1586
Delete Text 1589 View Options 1590
Description (Enhanced) 1578 Zoom 1590
Drawing Objects 1604 RTF Template
Edit Picture 1591 Import 1606
Export As RTF Document 1588 RTF Templates Tab (Enhanced) 1576
File Options 1588 Rule Composer
Fonts 1592 Business Rule Modeling 945
Footers 1596 Computation Rule Table 945
Frames 1604 Decision Table 945
Headers 1596 Rule Table 945
Highlight Text 1589 Rule Flow
Hyperlinks 1597 Activity 939
IME Option 1600 Activity Parameter 942
Import RTF Document 1588 Behavior 939
Insert RTF File 1591 Diagram 939
Level Numbering 1600 Generate Code From Behavior 951
Lists And Overrides 1600 Model 939
Move Text 1589 Rule Model
Numbered Lists 1593 Diagram 937
Page Breaks 1595 Rule Task
Page Columns 1599 Element 939
Page Mode 1590 RuleFlow Diagram
Paragraph Formatting 1593 Generate From Scenario 499, 501
Paragraph Numbering 1593 Run
Paragraph Styles 1593 SQL Patches 346
Paste External Objects 1589 Run Command
Picture Embed 1591 Create 1482
Picture Frame 1604 Introduction 1482
Picture Link 1591 Run Script
Print Options 1588 Create 1482
© 1998-2010 Sparx Systems Pty Ltd
 1958 Index

Run Script Alternate Path, RTF Reporting 1585

Introduction 1482 Automation Interface, Element Package 1722
Run State 823 Basic Path 490
Add Instance Variable 824 Context Menu, Item 496
Define, Element Context Menu 549 Create 494, 495, 496
Run-Time Create Element 497
Variable, Define 824 Delete Path 498
Runtime Object Delete Step 495, 496
In Script Editor 1439 Delete Text 497
Run-Time State Description Tab 490
Add Instance Variable 824 Edit Text 497
Delete Instance Variable 824 Element 490
Introduction 823 Entry Points Tab, Context Menu 498
Exception Path 490
Exception Path, Add 495, 496
-S- External Test Cases 505
Floating Toolbar 499
Save
Generate Activity Diagram From 500
Changes 36
Generate Diagram From 499
Controlled Package 297
Generate From Activity Diagram 513
Diagram As UML Pattern 902
Generate From Clipboard Text 496
Diagram Changes Automatically 359
Generate Robustness Diagram From 504
Diagram Image To Disk File 435
Generate RuleFlow Diagram From 501
Diagram, Context Menu Option 394
Generate Sequence Diagram From 503
Diagram, Quick Start 36
Generate State Machine Diagram From 501
Package with XMI 297
Generate Structure From Notes 490
Profile From Diagram Context 1107
Glossary Reference, Add 497
Profile From Package Context 1107
In Scenarios & Requirements Window 514
RTF Report As RTF Document (Enhanced)
1606 Insert Context Reference 497
RTF Report As RTF Document (Legacy) 1636 Internal Test Cases 505
Tasks Pane Profile 1145 Item Context Menu 496
UML Pattern 902 Join Scenarios 498
Save As Link Step To Use Case 496, 497
Copy 115 Link To Element 497
Shortcut 115 Merge Steps 496
Save Project As Move Step 495
Menu Option (File Menu) 56 Move Steps 496
Save Project As (File Menu Option) Object 490
Copy 116, 117 Organization 498
Shortcut (Capture Current Environment) 117 RTF Report Template Sections 1585
Shortcut (Direct Definition) 116 Set Responsible Entity 496
Scale Split Step 497
Image To Page Size 456 Structured Specification Tab 490
Scale Diagram View 356 Structured Specification, Create 494
SCC Structured, RTF Reporting 1585
Providers Dialog 236 Test Cases 505
Version Control Options 236 Testing 1543
Version Control, Upgrade For Enterprise Text Context Menu 497
Architect 4.5 239 Toolbar 495
Scenario Type, Define 658
Alternate Path 490 Undo Changes 497
Alternate Path, Add 495, 496 Use Case 710
Enterprise Architect User Guide
 Index 1959

ScenarioDiagramType Enum VBScript 1660, 1661

Automation Interface 1678 Workflow 1663
ScenarioExtension Workflow Functions 220
Automation Interface, Element Package 1723 Workflow, Introduction 220
Scenarios & Requirements Worklow 1661
Toggle Window/View 514 Script Actions
Window 514 Define, Visual Execution Analyzer 1427
ScenarioStep Script Editor
Automation Interface, Element Package 1723 Context Menu 1437
ScenarioStepType Enum Script Objects 1439
Automation Interface 1679 Scripter Window 1660
ScenarioTestType Enum Console Tab 1663
Automation Interface 1679 Console Toolbar 1663
Schema Context Menu 1661
Database 739 Editor 1439
Database, Import From ODBC 1363 Group Properties Dialog 1663
DDL, Import From ODBC 1363 Intellisense 1439
Owner Tagged Value 1016 Runtime Objects 1439
Set Owner 1016 Script Editor 1439
Scope Script Objects 1439
Values 1282 Scripts Tab 1661
Scope Guides Toolbar 1661
Code Editor, Common 1431 Type Libraries 1439
Screen Scripting
Element 847 In Enterprise Architect 1659
Script Scripts
Add To MDG Technology 1131 Build 1443
Commands 1663 SDK
Console 1663 Enterprise Architect 1092
Copy 1661 Search
Create 1661 A Package 1233
Default, Set In Visual Execution Analyzer 1428 Add-In 1781
Delete 1661 Advanced Options 1238
Deploy, Create 1484 Code Editor Facility 1437
Deploy, Introduction 1484 Conditions 1243
Engines 1660 Configure Code Editor Context Menu Options
Execute 1661 1437
Group 1660, 1661 Debugger File Search 1485
Group Type 1663 Definitions 1235
Hyperlink To 842 Definitions, New 1239
JavaScript 1660, 1661 Definitions, Predefined 1241
JScript 1660, 1661 Element Features 1235
Local 1660, 1661 Element Features, RTF Reports 1612
Move 1661 Element Filters, RTF Reports 1611
Normal 1663 Fields 1243
Project Browser 1663 File, Introduction 1485
Run, Introduction 1482 Filters 1235
Search 1485, 1663 List, Predefined Searches 1241
Template 1660, 1661 Macros, SQL 1239
Unit Test, Create 1483 Manage 1235
Unit Test, Introduction 1483 Model 1235
User 1660, 1661 Model, Create Search Definition 1239
© 1998-2010 Sparx Systems Pty Ltd
 1960 Index

Search Select Property Dialog 517

Other Filters, RTF Reports 1612 SELECT Statement
Project 1233, 1235 SQL Search 1239
Query, New 1239 Selectable
Results, Manipulate 1231 Element 555
Scripts 1485, 1663 Self Message
Simple 1235 Calls 872
Team Review 217 Self-Message
The Model Search 1233 Connector 871
User Defined, Storage 1239 Hierarchy, Sequence Diagram 712
Within Project Browser 1212 Relationship 871
Search Data Parameter Return 871
Add-In Search 1782 Send
Search Filters Element 789
Add To Search 1242 Event 839
Search Project SendSignal Action
Add Filters 1242 Signal Tab 745
Section Numbering Sequence
In RTF Reports 1601 Communication Messages 880
In Virtual Documents 1623 Elements and Connectors 410
Security Message, Change Timing Details 874
Basics 188 Message, Create 868
Change Password 191, 202 Message, Timing Details 874
Disable 189 Oracle, DDL Options 1367
Enable 189 Oracle, DDL Options For Packages 1369
Maintain Groups 197 Sequence Diagram
Maintain Users 191 Activation Levels 712
Policy 190 And Version Control 710
Re-enable 189 Damage To 710
Require User Lock Mode 190 Description 706
Reset Password 202 Diagram Features, Generate Sequence
Rigorous Security 190 Diagrams 1507
Set Password 202 Display Options 360
Standard Security 190 Element Activation 711
Submenu (Project Menu) 64 Elements 710
Tasks 188 Elements And Connectors 706
User Permission List 198 Example 706
User/Group Lock Mode 190 Generate Code From 1314, 1322
What Is User Security? 188 Generate From Debugger Call Stack 1480
Security Group Permissions 197 Generate From Recording, Execution Analysis
1505
Select
Alternative Image 447 Generate From Scenario 499, 503
ODBC Data Source 1365 Generate In Execution Analysis 1491
Stereotypes 897 Generate, Execution Analysis 1507
Layout 709
Select <Item> Dialog 515
Lifeline Activation Level 712
Select All
Menu Option (Edit Menu) 57 Messages, Asynchronous Signal 877
Messages, Self Message 871
Select Attribute Type
Data Type 560 Recording History, Execution Analysis 1506
Dialog 560 Save Recording History, Execution Analysis
1507
Select By Type
Self-Message Hierarchy 712
Menu Option (Edit Menu) 57
Enterprise Architect User Guide
 Index 1961

Sequence Diagram Classifiers For REFGUID Tagged Values 515

Top Margin, Change 714 Collection Classes 1345
Sequence Diagram Message Connector Visibility 619
Examples 873 Default Diagram, Model 437
External To Sequence 873 Default Tree Behavior 1210
General Ordering 876 Diagram Appearance Options 423
Sequence Diagram Recording Tab Diagram Page Size 455
Build Script, Options 1492 Diagram Properties 423
Sequence Element Element Classifier 904
Inline, Part And Port 714 Element Cross References 527
Sequence Flow Element Custom References 527
Create 980 Element Parent 526
Model In BPEL 980 Feature Visibility 438
Sequence Message Font For Element Text 556
Label Visibility 714 Group Permissions 197
Modify Height 709 Instance Classifier 515
Sequence Recording Option 1492 Interface For Element 526
Advanced Techniques 1497 Main RTF Report Properties (Legacy) 1629
Enable Diagnostic Messages 1496 Message Source and Target 624
Enable Filter 1493 Object State 824
Limit Auto Recording 1496 Operation Parameter Return Type 515
Record Activity For Class 1497 Operation Parameter Type 515
Record Activity For Method 1498 Operation Return Type 515
Record Arguments To Function Calls 1494 Parent For Element 526
Record Calls To Dynamic Modules 1495 Pattern Element Defaults 515
Record Calls To External Modules 1494 Relationship Visibility 619
Sequential Node Set Attribute Dialog 748
Structured Activity 796, 798 Set Feature Dialog 748
Server Set Feature Visibility
Apache Tomcat, Debugging 1456 Element Context Menu Option 554
JBOSS, Debugging 1456 Set Function
Tomcat, Debugging 1456 Create As Attribute Property 565
Server Configuration Set Operation Dialog 748
JBOSS 1458 Set Project Custom Colors
Tomcat 1459 For Element 540
Server Repository Set Up
Create for Oracle 10g 129 Adaptive Server Anywhere ODBC Driver 141
Create for Oracle 9i 129 Database Model Files 122
Service Debug Session 1447
WSDL Diagram 1054 For .NET 1461
WSDL Element 1054 MySQL ODBC Driver 135
Service Configuration ODBC Driver 135
Tomcat 1460 PostgreSQL ODBC Driver 138
Service Oriented Architecture 1039 Progress OpenEdge ODBC Driver 145
Development 1279 Single Permissions 195
Implementing XML-Based, In Enterprise Architect User Groups 194
1279 Settings
Service Oriented Architecture Modeling Language Author 645
1089 Cardinality (Multiplicity) 665
Set Clients 651
Activities For Transitions 515 Constraint Status Types 656
Association Specialization 623 Constraint Types 655
© 1998-2010 Sparx Systems Pty Ltd
 1962 Index

Settings Connector 1163

Default Hours 340 Create 1148
Effort Types 319 Custom Shapes 1147
Environment Complexity Factors 337 Display Element Properties 1158
Estimation 659 Double Line 1163
General Types 653 Drawing Methods 1154
Maintenance 660 Editable Field 1163
Menu 644 Example Shape Scripts 1163
Menu, Configure 73 Filled Arrow 1163
Metric Types 320 Fonts 1162
Metrics 659 Getting Started 1148
People 645, 650 Introduction 1147
Problem Types 660 Looping 1162
Project Author 645 Miscellaneous 1162
Project Resources 650 Multiple Condition 1163
Requirement Types 657 Override Element Appearance 1148
Risk Types 322 Properties, Connector 1158
Roles 648 Properties, Element 1158
Scenario Types 658 Query Methods 1158
Status Types 653 Reserved Names, Connectors 1161
Stereotypes 662 Reserved Names, Elements 1161
Tagged Value Types 664 Return Statement 1163
Technical Complexity Factors 336 Shape Attributes 1152
Template Package 542 Shape Editor 664, 1150
Testing Types 661 Single Condition 1163
UML Types 662 Stereotypes 1147
Shallow Copy String Manipulation 1162
Of Diagram 436 Subshape 1163
Shallow History 777 Subshape Layout 1160
Convert To Deep History 549 Syntax Grammar 1151
Shape Terminate Execution 1162
<LabelID> 1161 Variable Declarations 1162
Attributes 1152 Without Stereotypes 1162
Decoration 1161 Writing Scripts 1151
Editor 1150 Share
Label 1161 An Enterprise Architect Project 183
Main 1161 Project On Network Drive 183
Source 1161 Shared Key
Target 1161 Add 1870
Shape Attributes Issues 1872
Shape Scripts 1152 Shared Model Development
Shape Editor 664, 1150 Enterprise Architect 5
Shape Scripts Shortcut
Add To Profile 1104 Clear 117
Arithmetical Operations 1162 Diagram (Capture Current Environment) 117
Assign To Stereotype 1148 Keyboard 104
Basic Shapes 1163 Keyboard/Mouse 109
Change Font Of Text 1162 Menu, Toolbox 403
Cloud Path 1163 Model (Capture Current Environment) 117
Color Queries 1158 Model Search (Capture Current Environment)
Comments 1162 117
Conditional Branching 1158
Enterprise Architect User Guide
 Index 1963

Shortcut Diagram Presentations 1222, 1228

Relationship Matrix (Capture Current Model View 1222, 1228
Environment) 117 Of Diagrams, Automate 1228
Team Review (Capture Current Environment) Properties Dialog, Model View 1228
117 Remove From Model View 1228
Shortcut To Run, Diagram View 1228
Diagram 115 Run, Full Screen View 1228
Diagram (Direct Definition) 116 Stop 1228
Model 115
Snap to Grid
Model (Direct Definition) 116 Diagram Menu Option 65
Model Search 115
SOA 1039
Model Search (Direct Definition) 116 Development 1279
Relationship Matrix 115 Implementing XML-Based, In Enterprise Architect
Relationship Matrix (Direct Definition) 116 1279
Team Review 115 Modeling Language 1089
Team Review (Direct Definition) 116 SOA WSDL
Show Elements And Connectors, Enterprise Architect
Code Execution (Project Menu) 62 420
Connectors, All Diagrams 621 SOA XSD
Connectors, Requirements Element 621 Elements and Connectors, Enterprise Architect
Connectors, Single Diagram 621 420
Diagram Caption Bar 59 SoaML
Duplicate Tagged Values 637 Concept 1089
Element Stereotype 898 Diagrams 1089
Feature Stereotype 898 Disable 1089
Labels 622 Elements 1089
Package Contents On Diagram 389 Enable 1089
Project Browser 1209 MDG Technology 1089
Relationship 489 Toolbox Pages 1089
Toolbox 399 SOAP Binding 1057
Usage Of Element 526 Software and Systems Process Engineering
Use Case Arrowhead 625 Meta-model
SPEM 1061
Show Grid
Diagram Menu Option 65 Software Architect
And Enterprise Architect 40
Show Status Colors on Diagrams
Menu Option 920 Project Role 40
Show/Hide Software Development
Connectors 609 Database Engineering 1363
Labels 609 MDA Transformations 1385
Model Transformations 1385
Signal
Element 834 Software Engineering 1281
Reception 834 XML Engineering 1373
Simple View 383 Software Development Kit
Enterprise Architect 1092
Simulate
SysML Parametric Model 1005 Software Engineer
And Enterprise Architect 41
Single Permissions
Set Up 195 Project Role 41
Single User 1343 Software Product License Agreement 16
Size Sort Order
Elements By Increments 70 Project Browser, Reset 34
Submenu 70 Sorted Lookup Table
Create In Data Modeling 1033
Slideshow
Source
© 1998-2010 Sparx Systems Pty Ltd
 1964 Index

Source Languages, Download 1554

Set for Message 624 Model 1552
Source Code Perform 1552
Add New Features And Elements 1308 Project 1552
Control 228 Single Package 1552
Display In Source Code Viewer 1441 Spell Checking
Display Parameter Information 1442 Automatic, Disable 1552
Editor 1441 Automatic, Enable 1552
Editor Functions 1442 Introduction 1552
Engineering, Project Browser Options 1212 Spelling
File Parsing In Source Code Viewer 1441 Language (Tools Menu) 70
Generate For Method In Project Browser 1221 SPEM
Generate For Operation In Project Browser Base Plug-In 1061
1221 Concept 1061
Import, Reverse Engineering 1329 Diagram 1062
Internal Editor Options 1337 Disable 1061
Open Directory, Project Browser Menu Option Elements 1062
1218 Enable 1061
Record Macro 1442 MDG Technology 1061
Reset Language 1212, 1361 Method Content 1061
Reverse Engineer 1328 Package 1061
Synchronize 1328 Process 1061
Synchronize With Method In Project Browser Software and Systems Process Engineering
1221 Meta-model 1061
Synchronize With Operation In Project Browser Stereotype Presentation 1062
1221
Toolbox Page 1062
View For Method In Project Browser 1221
Spring Diagram Layout 466
View For Operation In Project Browser 1221
SQL
View, Project Browser Menu Option 1218
Custom Searches 1239
Viewer 1441
Editor 1239
Viewer Toolbar 1442
Patches, Run 346
XML Structure Tree 1441
Search Macros 1239
Source Code Engineering
Search, SELECT Statements 1239
Submenu (Element Menu) 69
Server Data Repository, Connect To 150
Submenu (Project Menu) 62
Server Repository, Create 126
Source Code Generation
SQL Server
Class 1308
Desktop Engine, Upsize To 173
Interface 1308
Non-Clustered Primary Key 1024
Overview 1308
Upsize To 176
Source Object
Standard Colors
Multiplicity 629
Attribute 353
Source Role
Connector Line 353
Details 629
Diagram Backgound 353
Space Evenly
Element Fill 353
Submenu 70
Element Line 353
Sparx Systems
Method 353
Enterprise Architect Community Site 23, 50
Note Text 353
Website 23
Operation 353
Specialize Association 623
Options 353
Specialized UML Models 917
Screen 353
Spell Check
Shadow 353
Correct Words 1553
Standard Element Stereotypes 899
Dictionary 1553
Enterprise Architect User Guide
 Index 1965

Start Synchronize Transition 694

Application 27 State Machine
Enterprise Architect 27 Element 796
Start Event, BPEL Entry And Exit Actions 570
Create 962 Model For Hardware Description Languages
Model 962 1319
Types 962 Regions 681
Start Page State Machine Diagram
Full Description 50 Code Generated From 1317
Quick Start 28 Description 678
State Display Format 678
Add To State Lifeline Element 693 Elements And Connectors 678
Chart 678 Example 678
Composite 789, 790 Execution Analysis 1509
Delete On State Lifeline Element 693 Generate Code From 1314, 1316
Diagram 678 Generate From Scenario 499, 501
Edit On State Lifeline Element 693 In Visual Execution Analyzer 1509
Element 789 Locate State In State Machine Table 689
Entry And Exit Actions 570, 789 Locate Transition In State Machine Table 689
In Timeline Element 697 Locate Trigger In State Machine Table 689
Locate In State Machine Diagram 689 State Machine Table
Locate In State Machine Table 689 Add States 687
Operation Behavior 573 Add Substates 687
Reposition In State Machine Table 689 Add Triggers 688
Simple 789 Cell Color 684
State Machine Table Conventions 689 Cell Enumeration 684
State (Machine) Cell Highlights 684
Elements and Connectors 411 Cell Size 684
Group, Toolbox 411 Change Position In Diagram View 687
State Changes Change Size 687
Capture, Execution Analysis 1508 ChangeTransitions 688
Map, Visual Execution Analyzer 1511 Conventions 689
Record, Visual Execution Analyzer 1511 Description 682
Set Up To Capture, Execution Analysis 1508 Export To CSV 690
State Invariant Format 682
Element 792, 793 Insert Transitions 688
State Lifeline Legend, Add 689
Element 794 Legend, Remove 689
State Lifeline Element Locate State In State Machine Diagram 689
Add State 693 Locate Transition In State Machine Diagram
Add To Timing Diagram 693 689
Add Transition 694 Locate Trigger In State Machine Diagram 689
Change Transition Time 694 Operations, Overview 686
Define Name 693 Options 684
Delete State 693 Remove Substate Parent Relation 687
Delete Transition 694 Reposition States 689
Edit State 693 Reposition Substates 689
Edit Transition 694 Reposition Triggers 689
Merge Transitions 694 State-Next State 682
Move Transition 694 State-Trigger 682
Set Timeline Start Position 693 Table Format 684
Sizing and Scale 693 Trigger-State 682

© 1998-2010 Sparx Systems Pty Ltd

 1966 Index

State Region Tags, Define 1098

Composite 681 UML Description 895
State Transitions Visibility 898
Add, Visual Execution Analyzer 1507 With Alternative Images 900
State/Continuation XSD In UML Profile 1041
Element 792 Stereotyped Element
Status Bar Table 849
Element Coordinates 89 Stop Recording
Enterprise Architect Workspace 89 Execution Analysis, Recording Sequence
Hide 89 Diagrams 1505
Show 89 Store
Zoom Control 89 Image In Enterprise Architect 447
Status Type Stored Procedure
Color 653 As Individual Class 1030
Define 653 Definition 1030
For Different Elements 653 Element 1030
Step Into Select From ODBC Data Source 1366
Function Calls 1473 Supported Databases 1030
Step Out Of Straighten
Functions 1473 Line At Cursor 615
Step Over Strategic Modeling
Lines Of Code 1472 MDG Technology For, Enterprise Architect
1073
Step Through
Function Calls 1480 String Viewer Dialog 1474
Stereotype Structural Diagram
Add Shape Script In Profile 1104 Elements 809
Add To Profile 1096 Structural Diagrams
Add, Automation Interface Code Example Overview 719
1773 Structural Specification
Analysis 835 Generate From Description 490
And Metafiles 895 StructuralFeature Action
Apply To Dependency Relationship 862 Set Structural Feature 745
Automation Interface Repository 1706 Structured Activity
Custom 1093 Conditional Node 796, 798
Define As Metatype 1109 Element 796, 798
Definition 895 Loop Node 796, 798
Dialog 1093 Nested 796
Extension 835 Node 796, 798
Inbuilt 835 Sequential Node 796, 798
Multiple, Restrict Application Of 1110 Structured Activity Node 798
Predefined Tag Types 1099 Structured Scenario
Profile 1113 Alternate Path 493
Selector 897 Constraints Tab 507
Set Default Appearance Of Objects In Profile Editor 493
1106 Entry Points Tab 493
Settings 662 Exception Path, 493
Show On Project Browser 1210 RTF Report Template Section 1585
SPEM Presentation 1062 Structured Specification Tab 493
Standard Element 899 Structured Specification
Synchronize Element With Profile 910 Alternate Path 493
Tagged Values In Profile 1098 Alternate Path, Add 495, 496
Tags For Supported Attributes 1100 Context Menu, Item 496

Enterprise Architect User Guide

 Index 1967

Structured Specification Alignment 70

Create 494, 495, 496 Appearance (Element) 69
Create Element 497 Data Management (Tools Menu) 71
Delete Path 498 Database Engineering (Project Menu) 63
Delete Step 495, 496 Documentation (Project Menu) 61
Delete Text 497 Execution Analyzer (Project Menu) 62
Edit Text 497 Execution Analyzer (View Menu) 59
Entry Points Tab 493 Hidden, Create In Toolbox Profile 1135
Entry Points Tab, Context Menu 498 Import/Export (Project Menu) 65
Exception Path 493 Inline Features (Element Menu) 68
Exception Path, Add 495, 496 Make Same 70
External Test Cases 505 Manage .EAP File (Tools Menu) 71
Floating Toolbar 499 Model Transformations (Project Menu) 63
Generate From Activity Diagram 513 Model Validation (Project Menu) 64
Generate From Clipboard Text 496 Move 70
Glossary Reference, Add 497 Online Resources 74
Insert Context Reference 497 Other Element Tools 59
Internal Test Cases 505 Other Project Tools 59
Item Context Menu 496 Paste Elements (Edit Menu) 58
Join Scenarios 498 Security (Project Menu) 64
Link Step To Use Case 496, 497 Size 70
Link To Element 497 Source Code Engineering (Element Menu) 69
Merge Steps 496 Source Code Engineering (Project Menu) 62
Move Steps 496 Space Evenly 70
Of Scenario Steps 493, 494 Toolbars 59
Organization 498 Version Control (Project Menu) 65
Set Responsible Entity 496 Visual Styles 59
Split Step 497 Web Services (Project Menu) 64
Test Cases 505 XML Schema (Project Menu) 64
Text Context Menu 497 Zoom 453
Toolbar 495 Z-Order 70
Undo Changes 497 Subshape
Structured Tagged Value Type 1166 Example 1160
Structured Tagged Values In Shape Scripts 1160
Create 1168 Substate
Style Reposition In State Machine Table 689
For Connectors 608 Sub-State 790
Style Template Substitute Words
Fragments, HTML 1651 In Extended RTF Generator 1615
StyleEx In RTF Report (Legacy) 1637
Diagram Profile Attribute Values 1140 Substitution
Sub Activity Conditional 1174
As Hyperlink 842 Direct 1174
Sub-Activity Macro 1158
Conditional Node 796, 798 Subtype
Element 753, 796, 798 Relationship 620
Loop Node 796, 798 Subversion
Submachine State Caching Client Credentials 247
Element 789, 796 Configure Version Control 250
Submenu Documentation 247
Add-In 72 Executables 247
Advanced (Element) 68 Repository URLs 247
© 1998-2010 Sparx Systems Pty Ltd
 1968 Index

Subversion Synch
Setting Up 247 Element 802
TortoiseSVN 252 Synchronization 184
UNIX-Based Client 249 Intial Code In Operations 576
Using With Enterprise Architect Under WINE Introduction 1281
Crossover 249 Macros, Code Template Syntax 1190
Version Control Options 247 Of Source Code And Model 1328
Version Control, Create Local Working Copy Synchronize
249 Batch With Code 69
Version Control, Create Repository Subtree By Dragging Element From Toolbox 910
248
Call Argument With Behavior Parameter 582
Windows-Based Client 249
Class With Code 69
Support
Code 1307
For Registered Users 24
Elements With Profile 910
For Trial Users 24
Existing Code Sections 1308
Supported Attribute
Invocation Argument With Behavior Parameter
By XML Element Node 914 582
Create Composite Elements 1111 Package With Source, (Project Menu Option)
Define Behavior On Creating Instance 1110 62
Define Child Diagram Types 1111 Replicas 186
In UML Profiles 914 Stereotypes From Profile 910
Metatype, In Profiles 1108 Tagged Values And Constraints 910
Of Stereotype Tags 1100 Tagged Values From MDG Toolbox Pages
Stereotype, In Profiles 1108 910
Supported Stereotype Attribute Tags 1100 Tagged Values From Resources Window 910
Supported Tags UML Profile Tagged Values And Constraints
In UML Profiles 912 910
Supress Syntax Check
Line Segments 615 For UML, Option 355
SwimlaneDef Syntax Grammar
Automation Interface, Diagram Package 1751 Shape Scripts 1151
Swimlanes Syntax Highlighting
Automation Interface, Diagram Package 1751, Code Editor Options 1338
1752 Code Editor, Common 1429
Manage 450 SysML
On Diagram 450 Activity Elements, Toolbox Page 996
Orientation 450 Activity Relationships, Toolbox Page 996
Swimlanes Matrix Block Definition Elements, Toolbox Page 992
Activate 444 Block Relationships, Toolbox Page 992
And Matrix Dialog, Matrix Tab 444 Concepts 989
Create Columns And Rows 444 Create Operational Domain Model 1007
Define Heading 444 Design Model 1009
Delete Items 444 Diagrams 989
Edit Items 444 Disable 989
Lock 444 Interaction Elements, Toolbox Page 998
Model Profile 444 Interaction Relationships, Toolbox Page 998
Size 444 Internal Block Diagram 1009
Switch Internal Block Elements, Toolbox Page 994
Diagram 396 Internal Block Relationships, Toolbox Page
RTF Generator 1607 994
Sybase Adaptive Server Anywhere MDG Technology 989
ODBC Driver, Set Up 141 MDG Technology For, Enterprise Architect
Upsize To 170 1073
Enterprise Architect User Guide
 Index 1969

SysML Overview 986

Model Elements, Toolbox Page 991 Process 986
Model Relationships, Toolbox Page 991 Simulate SysML Parametric Model 1005
Parametric Elements, Toolbox Page 995 SysLM Operational Domain Model, Create
Parametric Model, Simulate 1005 1007
Parametric Models 1002 Systems Modeling Languages
Parametric Relationships, Toolbox Page 995 MDG Technology For, Enterprise Architect
Requirement Elements, Toolbox Page 1001 1073
Requirement Extensions, Toolbox Page 1001 Systems Modelling Language (SysML) 989
Requirement Relationships, Toolbox Page
1001
Requirements Model, Create 1007
-T-
Reusable Subsystems 1011 Tab
State Machine Elements, Toolbox Page 999 Asterisks 397
State Machine Relationships, Toolbox Page Audit History In Output Window 102
999
Context Menu 397
Toolbox Pages 989
Context References 506
Use Case Elements, Toolbox Page 1000
Diagram 397
Use Case Relationships, Toolbox Page 1000
View 397
System
Tab Support
Project Glossary 323
RTF Style Template Editor (Enhanced) 1595
Project Issues 323
Tabbed Frame
Project Tasks 323
Combine Windows In 76
Tabs 323
Remove Window From 76
Testing 1541
Table
Users 191
DDL Script For 1011
Window 323
Detail 849
System Boundary Element 849
Element 802
Owner Tagged Value 1016
Insert New From Toolbar 83
Properties 849
System Design, Set Owner 1016
Compose, Systems Engineering Modeling
Set Properties 1014
1009
State Machine 682
System Engineering Modeling
Table Of Contents
Create Reusable Subsystems 1011
MS Word, Add 1641
System Window
Table Of Figures
Project Glossary Tab 325
MS Word, Add 1642
Project Issues Tab 332
Tables in RTF Reports
Project Tasks Tab 329
Sections 1581
SystemC
Split Rows 1581
Code Generation 1357
Tag
Enterprise Architect Toolbox Pages 1295
Compartment, Element 521
Language Options 1357
Management, Advanced 638
Modeling Conventions 1295
Profile 1098
Systems Engineering Edition
Tag Type
Of Enterprise Architect 12
Predefined, Assign To Stereotype 1099
Systems Engineering Model
Tagged Value
Create 986
Add 634
Systems Engineering Modeling
Add To Operations 577
Compose System Design 1009
Assign Information To 636
Create SysML Parametric Model 1002
Assign To Item 635
Create SysML Requirements Model 1007
Behavior Parameters 585
© 1998-2010 Sparx Systems Pty Ltd
 1970 Index

Tagged Value Add To MDG Technology 1126

By Dragging Element From Toolbox 910 Tasks Pane
Connector, Use 1101 Allocate Toolbox To Contexts 1144
Custom, Create 1171 Commands, Built In 1142
Duplicate Values 632 Contexts, Define 1144
Element Package, Automation Interface 1724 Getting Started 51
Entity Relationship Diagram 1077 Introduction 23
For Oracle Table Properties 1017 Named Contexts 1144
For Schema Owner 1016 Profiles, Create 1141
For Table Owner 1016 Run Add-In Functions From 1143
Fully Qualified, Show 438 Save Profile 1145
Fully-Qualified Value 632 Toolboxes, Define 1141
In UML Profiles 910 Tools 51
Inherited, Show 438 Window 51
Macros, Code Template Syntax 1186 TCF
Masked, Create 1171 Value 336
Model Components And 632 Weighting 336
Modify 632 TcSE
Modify Value 635 MDG Integration For, Enterprise Architect
Of Attributes 564 1073
Quick Add 634 Team
Reference Data, Create 1170 Develop Projects In, Introduction 182
Show Duplicates 637 Development, Introduction 111
Structured, Create 1168 Development, Project Sharing 182
Supported For UML Profile Stereotypes 912 Team Deployment
Synchronize, And Constraints 910 And Version Control 232
Synchronize, From MDG Toolbox Pages 910 Version Control Branching 232
Synchronize, From Resources Window 910 Team Foundation Server
Tab, Element Properties Dialog 508 Connect Enterprise Architect Model For Version
Toolbar 632 Control 253
Types 664 Version Control Option 253
Types Of Value Field 635 Team Review
View 632 Access 208
What Is A? 632 Access From Shortcut 115, 117
Window 632 Access From Shortcut (Direct Definition) 116
Add External File Link To Post 216
Tagged Value Type
Add To MDG Technology 1127 Add New Category 211
Filters 1166 Add New Post 213
Introduction 1166 Add New Topic 212
Predefined Reference Data 1169 Add Object Link To Post 216
Predefined Structured 1166 Add Team Review Link To Post 216
Capture Diagram Image As Resource 217
TaggedValue
Automation Interface, Element Package 1724 Connections To Other Team Reviews 218
Context Menu Options 209
Target
Role 631 Copy Path To Clipboad 218
Set For Message 624 Create Category 211
Types 1627 Create Post 213
Create Reply 214
Task
Automation Interface Repository 1707 Create Topic 212
Completion 314 Delete Category 209
Details 330 Delete Item 215
Delete Post 209
Task Panel
Enterprise Architect User Guide
 Index 1971

Team Review Instantiated 813

Delete Resource 209 Model, Incorporate In Technology 1146
Delete Resources 217 Package, Settings 542
Delete Topic 209 Parameterized Classes 813
Edit Item 215 RTF, Import 1606
Editor 215 Script 1660, 1661
Export Package As Resource 217 Transformation, Default 1415
Hyperlink To 840 Term
Icons 208 Automation Interface Repository 1708
Import Resource Package 217 Terminate
Introduction 208 Element 804
Load Data When Required 218 Test
Loading Behavior 218 Automation Interface, Element Package 1725
Mark All Posts Unread 218 Copy Between Categories 1544
Options 218 Create Defect From 1548
Postings in Model Views 1222 Documentation 1550
Preload 218 Generate From Scenario 505
Reply To Post 214 Import From Other Element 1546
Resources 217 Model Template 380
Save Profiler Report As Resource 1519 Move Between Categories 1544
Search 217 Report 1550
Tab 208 Result Output 1550
View Diagram Image Resource 217 Script Output 1550
Was Discussion Forum 208 Unit, In Execution Analysis 1512
Window 208 Unit, Record Results In Execution Analysis
Teamcenter Systems Engineering, Siemens PLM 1514
MDG Integration For, Enterprise Architect Unit, Run In Execution Analysis 1513
1073 Unit, Set Up In Execution Analysis 1512
Technical Complexity Factor Test Case
Estimate Project Size 338 Element 848
Value 336 Test Cases
Weighting 336 Generate From Scenario 505
Technology Developer Test Details Dialog 1538
And Enterprise Architect 46 Test Script
Project Role 46 Introduction 1483
Technology Event JUnit 1512
EA_OnInitializeTechnologies 1803 NUnit 1512
Technology Events Test Scripts
Add-In Model 1803 Compartment 1549
EA_OnDeleteTechnology 1806 Tester
EA_OnImportTechnology 1806 And Enterprise Architect 43
EA_OnPostActivateTechnology 1805 Project Role 43
EA_OnPreActivateTechnology 1804 Testing
EA_OnPreDeleteTechnology 1805 Acceptance 1542
Technology-Defined Model View Asterisk On Testing Window Tabs 1537
Set Up 1226 Autonaming 1537
Template Compartment, Element 521
Behavioral Model 1193 Import Element Scenarios 1544
Editor In SDK 1202 Import Internal Constraint 1547
Editor, Code Templates 1305 Import Internal Requirement 1547
Element 906 Import Package Scenarios 1544
Fragments, HTML 1651 Import Responsibility 1547
© 1998-2010 Sparx Systems Pty Ltd
 1972 Index

Testing Resize 700

Integration 1540 Select 700
MDG Technology For, Enterprise Architect Shift Left Or Right 703
1073 Transitions 703
Model Template 380 Time Range
Overview 1536 Set For Timing Diagram 692
Report, Create 1627 Timeline Element States
Scenario 1543 Add Via Configure Timeline Dialog 697
Support 1536 Delete via Configure Timeline Dialog 697
System 1541 Edit Via Configure Timeline Dialog 697
Type, Define 661 Maintain 697
Unit 1539 Numeric Range Generator 697
Window 1537 Timeline Range
Window, Acceptance Test Tab 1542 Set For Timing Diagram 692
Window, Integration Test Tab 1540 Timeline Start Position
Window, Scenario Test Tab 1543 Set For State Lifeline Element 693
Window, System Test Tab 1541 Timing
Window, Unit Test Tab 1539 Constraint 874
Workspace 1537 Details, Change 874
Testing Details Report 1549 Elements and Connectors 410
Testing Feature Group, Toolbox 410
Insert In Element 595 Message 882
Text Element Message, Create 883
Create 536 Observation 874
Insert New From Toolbar 83 Timing Diagram
TFS Add Value Lifeline Element 696
Connect Enterprise Architect Model For Version Create 692
Control 253 Description 690
Version Control Option 253 Edit Options 692
Working Folder For Enterprise Architect Version Edit Value Lifeline Element 696
Control 253
Elements And Connectors 690
Workspace For Enterprise Architect Version
Control 253 Example 690
The Debug Window 1467 Set Time Range 692
The Open Group Architecture Framework TOGAF
MDG Technology For, Enterprise Architect MDG Technology For, Enterprise Architect
1073 1073
Theme Tomcat
Microsoft Office Styles 101 Server, Configuration 1459
Microsoft Visual Basic Styles 101 Server, Debugging 1456
Options 101 Service Configuration 1460
Visual Style 59 Toolbar
Tidy Line Angles 615 (File) Search, Debugging 1485
Time Event 787 Add Commands 91
Time Interval Change Command Icon Appearance 91
Compress 700, 703 Code Generation 81
Context Menu 700 Console Tab, Scripter Window 1663
Copy and Paste 703 Create 92
Create 700 Current Connector 84
Delete 700 Current Element 84
Description 700 Customize 92
Move 700 Default Tools 80
Operations 703 Diagram 83

Enterprise Architect User Guide

 Index 1973

Toolbar Documentation Group 1616

Display Labels 92 Elements For Extending 1137
Docked 79 Entity Relationship Diagram 1077
Element 83 Eriksson-Penker Group 1080
Element List 1258 Expand Page 399
Floating Buttons, Display 362 Gang Of Four Pattern Group 1083
Floating, Structural Specification 499 GoF Pattern Group 1083
Format (Element Appearance) 85 Hide 399
Hide 92 Hide Labels 401
Large Icons 101 ICONIX Group 1084
Manage Searches 1235 Interaction Group 410
Missing Icon 90 Maintenance Group 418
Model Search 1231, 1234 MDG Technology Groups 1067
Notes 642 Metamodel Group 415
Options, Customize Appearance 101 Mind Mapping Group 1087
Project 81 Object Group 408
Project Browser 1212 Override Default In Toolbox Profile 1136
Remove 92 Page Attributes 1135
Remove Commands 91 Pin Pages 401
Rename 92 Profile Group 414
Screen Tips 101 Profile, Create For MDG Technology 1134
Scripter Window 1661 Profiles 1134
Show 92 Requirement Group 418
Submenu 59 Set Toolbox Visibility 401
UML Elements 83 Shortcut Menu 403
Workspace 79 Show 399
Workspace Layouts 86 Show Labels 401
Toolbar Customize Button SoaML Pages 1089
Show/Hide 59 SPEM 1062
Toolbox State (Machine) Group 411
Activity Group 412 Synchronize Stereotyped Tagged Values 399
Add Stereotype To Diagram Element 399 SysML Groups 989
Add To MDG Technology 1125 SystemC Group 1295
Analysis Group 416 Tasks Pane, Define 1141
Appearance Options 401 Timing Group 410
Archimate Group 1073 Unpin Pages 401
BPMN Group 952 Use Case Group 406
Business Modeling Group 739 User Interface Group 419
Class Group 407 Verilog Group 1298
Collapse Page 399 VHDL Group 1299
Common Group 405 WSDL Group 420
Communication Group 409 XML Schema Group 420
Component Group 412 Toolbox Profile
Composite Group 409 Connectors For Extending 1138
Connectors For Extending In Profile 1138 Create Hidden Submenu In 1135
Create Elements And Connectors 399 Items, Assign Icons For 1136
Custom Group 417 Pages That Can be Overridden 1137
Customize 1134 Tools
Data Flow Diagram Group 1076 Custom 96
Data Modeling Group 421 External Applications 96
Default, Override In Profile 1136 Pass Parameters To External Tools 97
Deployment Group 413 Tools Menu 70
© 1998-2010 Sparx Systems Pty Ltd
 1974 Index

Top Margin C# 1389

Sequence Diagram, Change 714 Data Model To ERD 1390
Topic DDL 1393
Add To Team Review 212 Dependencies 1385
Create 212 EJB 1397
Delete 209 Entity Bean 1397
TortoiseSVN ERD To Data Model 1399
In Version Control 252 Java 1403
Trace JUnit 1405
Connector 892 NUnit 1407
Relationship 892 Session Bean 1397
Traceability Write 1414
Diagrams 1250 WSDL 1408
Element Grouping 1246 XSD 1409
For Diagram 1253 Transformation Dependency
For Elements 1253 Trace With Traceability Window 1253
In Requirements Models 736 Transformation Template
Introduction 1245 Default 1415
Model Structure 1246 Modify 1412
Package Organization 1246 Transfer Between Models 1414
Themes 1245 Transition
Tools 1251 Add To State Lifeline Elements 694
Window 1253 Add Via Configure Timeline Dialog 699
Window, In Traceability 1251 Change In State Machine Table 688
With Dependency Report 1251 Change Time, State Lifeline Element 694
With Implementation Report 1251 Connector 892
With Relationship Matrix 1251 Delete On State Lifeline Element 694
With Traceability Window 1251 Delete Via Configure Timeline Dialog 699
Track Changes Edit In Time Intervals 703
Auditing 269 Edit On State Lifeline Elements 694
Baselines 269 Edit Via Configure Timeline Dialog 699
Introduction 269 Effect 892
Trademarks 19 Guard 892
Transfer Highlight Associated Trigger or State 688
Project Data Between Repositories 307 Insert In State Machine Table 688
Transform Locate In State Machine Diagram 689
Connector End 1421 Locate In State Machine Table 689
Connectors 1419 Merge On State Lifeline Element 694
Copy Information 1421 Move On State Lifeline Elements 694
Duplication Of Connectors 1419 Properties 892
Elements, MDA-Style Transformations 1387 Relationship 892
Model, MDA-Style Transformations 1387 State Machine Table Conventions 689
Names 1422 Trigger 892
Objects 1415 Transitions Collection
TRANSFORM_CLASSIFIER Automation Interface, ElementFeatures Package
Macro 1423 1737
TRANSFORM_CURRENT Translation
Macro 1421 RTF Report Generation 1615
TRANSFORM_REFERENCE Tree Style Hierarchy
Macro 1419, 1423 Create 625
Transformation Set Default Link Style 625
Built In, MDA-Style Transformation 1388 Trial Version
Enterprise Architect User Guide
 Index 1975

Trial Version 2.0, Import From XMI 290

Extend Trial Period 10 2.3 - Definition 5
Of Enterprise Architect 10 Analysis Tool - Enterprise Architect 4
Select Edition To Trial 10 Build Systems 5
Select Workspace Layout 10 Connectors 852
Triangle Data Modeling Profile 1011
Red 341 Definition 672
Tricks and Traps Design Systems 5
Create Add-In 1779 Design Tool - Enterprise Architect 4
Trigger Dictionary 672
Create 804 DTD 293
Create In State Machine Table 688 Elements 741
Create In Transition Properties 892 Enterprise Architect Modeling Platform 370
Element 804 Extend 672
For Transition 892 Manage Complexity 5
Intermediate Event, BPEL 968 Mappings To XSD 1049
Locate In State Machine Diagram 689 Model Complexity 5
Locate In State Machine Table 689 Model Structure, Manage - Enterprise Architect
Operation, What Is A? 1033 5
Ports 804 Models Under Single Root 291
Properties Tab 804 Pattern 901
Reposition In State Machine Table 689 Recommended Reading 672
Start Event, BPEL 962 Shared Model Development - Enterprise
State Machine Table Conventions 689 Architect 5
Type 892 Support - Enterprise Architect 5
Syntax Checking Option 355
Trigger Operation
Create 1033 Visualize Systems - Enterprise Architect 5
What Is A? 1033 UML Behavioral Diagram
Overview 673
Type
Element Context Menu 549 UML Business Process Model
In Enterprise Architect 374
Type Hierarchy Dialog 526
Type Libraries UML Class Model
For Script Editor 1439 In Enterprise Architect 376
Type Specific Menu Section UML Component Model
Connector 607 In Enterprise Architect 378
UML Database Model
In Enterprise Architect 377
-U- UML Deployment Model
In Enterprise Architect 378
UAC UML Diagram
And Debugging 1448 Add To Project 422
UI Control Copy, Deep 436
Element 849 Copy, Shallow 436
Ultimate Edition Create 422
Of Enterprise Architect 12 Duplicate 436
UML Extended 673, 733
1.3 288, 289, 344 In Enterprise Architect 391
1.3, Import From XMI 290 MDG Technology 673
1.4 289 Overview 673
1.4, Import From XMI 290 Paste 436
1.5 362 Types 673
2.0 Migration 344 What Is A? 673

© 1998-2010 Sparx Systems Pty Ltd

 1976 Index

UML Domain Model Save From Diagram 902

In Enterprise Architect 376 UML Profile
UML Element And Element Templates 906, 1093
Behavioral Diagram Elements 742 Example File 915
Structural Diagram Elements 809 Import 908
Toolbar 83 Import From XML 906, 1093
UML Maintenance Model Stereotypes 906, 1093
In Enterprise Architect 381 Structure 913
UML Model Supported Attributes 914
Add Connectors In Enterprise Architect, Tutorial Synchronize Elements 910
32 Synchronize Stereotypes 910
Add Diagram In Enterprise Architect, Tutorial Synchronize Tagged Values And Constraints
30 910
Add Element In Enterprise Architect, Tutorial XSD, Stereotypes 1041
31
UML Project Model
Add Element To Diagram, Tutorial 31 In Enterprise Architect 381
Add Package In Enterprise Architect, Tutorial
UML Requirements Model
30
In Enterprise Architect 374
Add View, Tutorial 29
UML Resources
CSV Import And Export In Enterprise Architect
300 Patterns 901, 904
Define Connector Properties In Enterprise UML Structural Diagram
Architect 33 Overview 719
Define Element Properties In Enterprise Architect UML Syntax Compliance
33 Turn Off 1530
Project Roles And Tasks In Enterprise Architect UML Testing Model
37 In Enterprise Architect 380
Specialized 917 UML Types
UML Model Pattern Cardinality (Multiplicity) 665
Introduction 373 Dialog 662
UML Model Template Stereotypes 662
In Enterprise Architect 373 Tagged Values 664
Introduction 373 UML Use Case Model
UML Modeling In Enterprise Architect 375
And MDG Technologies 370 UML_EA.DTD 293
And Requirements Management In Enterprise File 290
Architect 370
UML2
Build Models 370
File Import 291
Business Modeling In Enterprise Architect 370
Unadjusted Use Case Points 338
What Is? 370
Undo
With Enterprise Architect 370
Last Action, Diagram Edits 458
With Packages 387
Option (Edit Menu) 57
With UML Patterns In Enterprise Architect 370
Unified Modeling Language 672
With UML Profiles In Enterprise Architect 370
Unique
With UML Stereotypes In Enterprise Architect
370 Constraint 1033
Index 1033
UML Modeling Tool
Enterprise Architect - Key Features 8 Unit Test Command
Introduction 1483
UML Pattern
Actions 902 Unit Test Script
Add To Diagram 904 Create 1483
Create From Diagram 902 Unit Testing 1539
In Resources View 902 Create Test Scripts, Execution Analysis 1512
Save 902 Define Tests, Execution Analysis 1512

Enterprise Architect User Guide

 Index 1977

Unit Testing 1539 Element 806

Introduction, Execution Analysis 1512 Elements and Connectors 406
JUnit 1512 Extension Points 807
NUnit 1512 Group, Toolbox 406
Record Test Results, Execution Analysis 1514 Keyword 338
Run, Execution Analysis 1513 Metrics 335
Set Up, Execution Analysis 1512 Metrics Dialog 338
Unlock Model Template 375
Connector 200 Phase 338
Element 200 Points, Unadjusted 338
Unpin Rectangle Notation 808
Toolbox Pages 401 Scenarios 710
Update View 383
Element Phase, For Package 340 Use Case Diagram
Element Status, For Package 340 Description 676
Element Version, For Package 340 Elements And Connectors 676
Package Phase 340 Example 676
Package Status 340 Use Element Extras
Package Version 340 Automation Interface Code Example 1769
Upgrade Use Repository Extras
Existing License (v. 6.5 And Earlier) 1873 Automation Interface Code Example 1772
Existing License (v. 7.0+) 1873 User
Model 346, 347 Default Fonts 357
Models, Upgrade Wizard 347 Defined Searches, Storage 1239
Project 346 Dictionary, For Spell Checker 1553
Replicas 186, 347 Directory 645
Wizard 347 Forum 24
Upsize Groups 191
From Desktop and Professional Editions 122 ID, Import From Active Directory 192
To Access 2007 169 Settings 1343
To MySQL 178 User Interface
To Oracle 175 Components 48
To PostgreSQL 173 Control Element 849
To Progress OpenEdge 171 Design 734
To SQL Server 176 Element 849
To SQL Server Desktop Engine (MSDE) 173 Elements and Connectors 419
To Sybase Adaptive Server Anywhere (ASA) Group, Toolbox 419
170 Screen Prototype 847
Usage User Interface Diagram
Connector 894 Description 738
Of Element 526 Elements And Connectors 738
Relationship 894 Example 738
Use User Lock
Classifiers 520 Identify Owner 207
Connector 894 Indicators 206
Pattern 904 User Security
Profiles 907 Add Connector To Locked Element 204
Relationship 894 Apply User Lock 205
Spell Checker 1552 Assign User To Group 194
Use Case Basics 188
And Requirements 922 Change Password 202
Arrowhead, Show 625 Disable 189
© 1998-2010 Sparx Systems Pty Ltd
 1978 Index

User Security Of Element 1528

Enable 189 Of Model, Configure 1530
Identify Lock Owner 207 Of Model, Configure For MDG Technology
Import User ID From Active Directory 192 1145
List Of Permissions 198 Of Package 1528
Lock Elements & Diagrams 204 Rules, Model 1530
Lock Packages 205 Validation, Properties
Locked Element Indicators 206 Attribute 1532
Maintain Groups 197 Element 1532
Maintain Users 191 Feature 1532
Manage User-level Locks. 207 Relationship 1532
Password Encryption 200 Validation, Well Formedness
Policy 190 Attribute 1531
Re-enable 189 Diagram 1531
Release Elements & Diagrams 204 Element 1531
Reset Password 202 Feature 1531
Set Group Permissions 197 Relationship 1531
Set Password 202 Value Lifeline Element 808
Set Up Single Permissions 195 Add States 696
Tasks 188 Add To Timing Diagram 696
View All Permissions 196 Add Transitions 696
View And Manage Locks 200 Change Transition Time 696
What Is User Security? 188 Delete Transitions 696
User Security Groups Edit Transitions 696
Assign User To 194 Sizing and Scale 696
Set Up 194 States 696
User Settings Transitions 696
Options Dialog 90 ValueOf Field
User/Group Lock RTF Style Template Editor 1586
Release 204 Variable
Set 204 Debug, Break On Change In Value 1477
User/Group Lock Policy 190 Definitions, Code Template Syntax 1200
Using Enterprise Architect Definitions, Examples 1200
Application Workspace 48 References, Code Template Syntax 1200
Remove Recent Project 56 References, Examples 1200
Start Page 50 VB
Utility Set Up In Automation Interface 1668
Compare 279 VB.NET
Diff 279 Code Generation 1358
UUCP Language Options 1358
Estimate Project Size 338 Modeling Conventions 1296
VBScript 1660, 1661
Verilog
-V- Code Generation 1358
Enterprise Architect Toolbox Pages 1298
Validate
Language Options 1358
Business Rules 950
Modeling Conventions 1298
Package Configuration For Version Control
260 Version Control
And Reference Data 231
Rule Composer 950
And Replication 256
Validation
And Sequence Diagram 710
Cancel 64
Apply To Enterprise Architect Model 231
Of Diagram 1528
Enterprise Architect User Guide
 Index 1979

Version Control Subversion, Create Local Working Copy 249

Apply To Model Branch 264 Subversion, Create New Repository Subtree
Basics 230 248
Branching 232 Subversion, Setting Up 247
Check In and Check Out Packages 261 Subversion, TortoiseSVN 252
Configuration 229, 233, 234, 265 Subversion, Using With Enterprise Architect
Configuration, Team Deployment 232 Under WINE Crossover 249
Configuration, Use Previously-Defined 260 System Requirements 229
Configure Current Package 256 Tasks 256
Configure In Subversion 250 TFS Option 253
Configure Package 259 Usage Scenarios 230
Connect Model Using TFS 253 Use Nested Version Control Packages 236
Considerations 229 Using 256
Controlled Packages 293 Validate Package Configurations 256
Copy-Modify-Merge Policy 230 Who Has Checked Out A Package? 257
CVS Options 240, 244 Work Offline 256
CVS Remote Repository 240 Version Controlled Package
Discussion Of File Control 231 Icon 1213
Export Model Branch 264 VHDL
Features 228 Code Generation 1359
File History 257 Enterprise Architect Toolbox Pages 1299
File Properties 257 Language Options 1359
Import Model Branch 265 Modeling Conventions 1299
In Team Deployment 232 View
Include Other Users' Packages 263 Add To UML Model, Quick Start 29
Introduction 229 Audit 274
Locking - Necessary? 230 Create, Data Modeling 1032
Lock-Modify-Unlock Policy 230 Database 1032
Manual, With XMI 299 Element List 1255
Menu (Package) 257 Element, Data Modeling 1032
Menu (Project) 256 Locks 200
Nested Packages 231 Menu 58
Offline 268 Next Diagram 455
Package Configuration, Validate 260 Of Model 1222
Policies 230 Previous Diagram 455
Project Browser Indicators 233 Project Statistics 60
Recommendations 256 Report On, Data Modeling 1032
Refresh View Of Shared Model 267 Requirements 928
Resynchronize Package Version Control Status Submenus 59
267 Tabs 397
Resynchronize Status Of All Packages 256 View Options
Review Version Control History 266 Diagram View 396
SCC Options 236 Element List 1255
SCC, Providers DialogSCC, Providers Dialog Views
236 Add 383
SCC, Upgrade For Enterprise Architect 4.5 Class 383
239 Component 383
Set Up 233 Delete 385
Settings 234, 256 Deployment 383
Setup Menu 256 Dynamic 383
Submenu (Project Menu) 65 Manage 383
Subversion Options 247 Rename 384

© 1998-2010 Sparx Systems Pty Ltd

 1980 Index

Views Breakpoint Storage 1469

Simple 383 Breakpoints And Markers Window, Record
Use Case 383 Sequence Diagrams 1503
Virtual Document Build Script, Create 1444
Add Packages As Attributes 1620 Control Recording, Record Sequence Diagrams
Change Package Sequence 1622 1504
Consecutive Numbering Through 1623 Create Sequence Diagram, Call Stack 1480
Create Master Document For 1618 Debug .NET 1460
Create Model Document For 1619 Debug .NET Assembly 1461
Delete Package Attributes 1621 Debug .NET CLR Versions 1462
Delete Packages 1621 Debug .NET With COM Interop Process 1463
Document Order 1622 Debug Another Process 1472
Generate RTF Report From 1623 Debug Apache Tomcat Server Configuration
1459
Introduction 1616
Debug Apache Tomcat Windows Service 1460
Master Document Element 1616
Debug ASP .NET 1463
Model Document Element 1616
Debug Java 1452
Model Search Sequence 1622
Debug Java Applets In Internet Browsers 1454
Move Package Attributes Between Elements
1622 Debug Java Web Servers 1456
Numbering Through 1623 Debug JBOSS Server Configuration 1458
RTF Bookmarking In 1616 Debug Symbols, C++ And Native Applications
1452
Sequence of Model Document Elements 1622
Debugger Frameworks 1446
Sequence of Package Attributes 1622
Debugger System Requirements 1447
Tagged Values For Master Document 1618
Debugger Windows, Display 1471
Visibility Indicators 427
Debugger, Overview 1446
Values 1282
Debugging Actions 1470
Visibility Of Elements
Deploy Script, Create New 1484
Customize 535
Deploy Script, Introduction 1484
Visible Class Members
Diagram Features, Generate Sequence
Set Diagram Appearance Options 429 Diagrams 1507
Visio Difference Between Recording Marker And
MDG Link For, Enterprise Architect 1073 Breakpoint 1503
Vista Execution Analysis, Introduction 1490
Permissions For Enterprise Architect 21 File Search, Introduction 1485
Visual Basic File Search, Use 1485
Code Generation 1360 For C++ Applications 1451
Connect To Automation Interface 1666 For Microsoft Native Applications 1451
Import, Reverse Engineering 1331 For WINE Applications 1450
Language Options 1360 General Debug Setup, Java 1453
Modeling Conventions 1301 Generate Sequence Diagram 1505, 1507
Set Up In Automation Interface 1668 Inspect Process Memory 1476
Visual Basic.Net Java Debug Session, Attach To VM 1454
Import, Reverse Engineering 1331 Manual Recording, Record Sequence Diagrams
Visual Execution Analyzer 1504
Access 1488 Map State Changes 1511
Add State Transitions 1507 Marker Management 1468
Advanced Debug Techniques, Java 1454 Marker Storage 1469
Automatic Recording, Record Sequence Marker Types, Record Sequence Diagrams
Diagrams 1504 1499
Availability 1488 MDDE Basic Setup 1425
Break On Variable Changing Value 1477 MDDE External Tools 1425
Breakpoint Management 1468 MDDE, Build Scripts 1443

Enterprise Architect User Guide

 Index 1981

Visual Execution Analyzer Sequence Diagrams, Limit Auto Recording

MDDE, Code Editors 1425 1496
MDDE, Default Script, Set 1428 Sequence Diagrams, Record Arguments To
MDDE, Generate Code 1425 Function Calls 1494
MDDE, Package Build Scripts, Manage 1426 Sequence Diagrams, Record Calls To Dynamic
Modules 1495
MDDE, Script Actions, Define 1427
Sequence Diagrams, Record Calls To External
MDDE, Synchronize Code 1425 Modules 1494
Object Workbench, Create Variables 1521 Set Code Breakpoint 1469
Object Workbench, Introduction 1519 Set Data Breakpoint 1470
Object Workbench, Invoke Methods 1522 Set Recording Markers, Record Sequence
Object Workbench, Overview 1520 Diagrams 1502
Object Workbench, Variables 1521 Set Up Debug Session 1447
Outputs 1488 Set Up Debug Session For .NET 1461
Overview 1488 Set Up To Capture State Changes 1508
Pause Recording, Record Sequence Diagrams Show Loaded Modules 1478
1505 Show Output 1478
Pin/Unpin A Package 1428 Start Debugger 1471
Place Markers, Recording Sequence Diagrams State Machine Diagram 1509
1499
State Transition Diagram 1509
Profiler Overview 1514
Step Into Function Calls 1473
Record Activity For Class 1497
Step Out Of Functions 1473
Record Activity For Method 1498
Step Over Lines Of Code 1472
Record Sequence Diagrams, Advanced
Techniques 1497 Step Though Function Calls 1480
Record Sequence Diagrams, Enable Filter Stop Debugger 1471
1493 Stop Recording, Record Sequence Diagrams
Record Sequence Diagrams, Introduction 1505
1490 Structure 1489
Record Sequence Diagrams, Overview 1491 Tooltips In Code Editor 1479
Record Sequence Diagrams, Prerequisites UAC-Enabled Operating Systems 1448
1492 Unit Test Script, Create 1483, 1512
Record Sequence Diagrams, Recording Options Unit Test Script, Introduction 1483
1492 Unit Test, Record Results 1514
Record Sequence Diagrams, Set Up 1492 Unit Testing, Introduction 1512
Record State Changes 1511 Uses Of 1488
Record Unit Test Results 1514 View Call Stack 1473
Recording Actions 1480 View Local Variables 1474
Recording History 1506 View Local Variables, Long Values 1474
Recording Markers, Activate, Record Sequence View Variables In Other Scopes 1475
Diagrams 1503 Work With Marker Sets, Record Sequence
Recording Markers, Disable, Record Sequence Diagrams 1503
Diagrams 1503 Workspace Layouts 1424
Recursive Builds 1446
Visual Execution Profiler
Resume Recording, Record Sequence Diagrams Attach To Process 1517
1505
Getting Started 1516
Run Script, Create New 1482
Launch 1517
Run Script, Introduction 1482
Operation 1517
Run Unit Test 1513
Overview 1514
Save Call Stack 1482
Prerequisites 1516
Save Recording History 1507
Report, Example 1514
Script Search 1485
Report, Load 1518
Search Window 1485
Report, Save 1518
Sequence Diagrams, Enable Diagnostic
Messages 1496
© 1998-2010 Sparx Systems Pty Ltd
 1982 Index

Visual Execution Profiler

Report, Save As Resource In Team Review
1519 -W-
Set Options 1518
W3C XML
Set Sample Intervals 1518
Technologies, Introduction 1039
Start 1517
W3C XSD
Stop 1517
Elements and Connectors, Enterprise Architect
Supported Platforms 1516
420
System Requirements 1516
W3CWSDL
Team Review, Save Report As Resource 1519
Elements And Connectors, Enterprise Architect
Toolbar 1516 420
Visual Execution Sampler WAN Optimization
Attach To Process 1517 Enterprise Architect Performance 148, 150,
Getting Started 1516 153, 160, 162, 165
Launch 1517 For ASA Data Repository 162
Operation 1517 For MSDE Server Data Repository 165
Overview 1514 For MySQL Data Repository 148
Prerequisites 1516 For Oracle Data Repository 153
Report, Example 1514 For PostgreSQL Data Repository 160
Report, Load 1518 For Progress OpenEdge Data Repository 165
Report, Save 1518 For SQL Server Data Repository 150
Report, Save As Resource In Team Review WAN Optimizer
1519 Introduction 180
Set Options 1518 Performance Of Enterprise Architect 180
Set Sample Intervals 1518 Transmission Diagram 180
Start 1517 Watched Items
Stop 1517 Debugger 1475
Supported Platforms 1516 Watches Window 1475
System Requirements 1516 Break On Variable Changing Value 1477
Team Review, Save Report As Resource 1519 Watermark
Toolbar 1516 Diagrams 356
Visual Representation Web
Of Elements, Introduction 520 Page Modeling 851
Visual Studio 2005/2008 Report Style Templates 1649
MDG Integration For, Enterprise Architect Stereotypes 851
1073
Templates, Reporting 1649
Visual Studio.NET
Web Browser
MDG Link For, Enterprise Architect 1073
Home Website, Access 103
Visual Styles Internet Email, Access 103
Microsoft Office Styles 101
Web Search Engine, Access 103
Microsoft Visual Basic Styles 101
Web Page
Options 101
Prototype 847
Select 101
Web Server
Submenu 59
Java, Debug 1456
Themes 59
Web Service
View Menu Option 58
Create In BPEL 983
Visualize Systems Submenu (Project Menu) 64
Enterprise Architect 5
Web Service Definition Language 1049
VM
Web Services (WSDL) 1049
Attach To In Java Debug Session 1454
Generate WSDL 1379
Import WSDL Files 1376
Model WSDL 1050
Enterprise Architect User Guide
 Index 1983

Web Services (WSDL) 1049 Connections 1269

Model WSDL, Binding 1057 Constraints 514
Model WSDL, Document 1053 Debug 1467
Model WSDL, Message 1056 Diagram Filter 1272
Model WSDL, Message Part 1060 Dock 76
Model WSDL, Namepaces 1051 Element Browser 510
Model WSDL, Port Type 1056 Floating 76
Model WSDL, Port Type Operation 1059 Generalized Functions 102
Model WSDL, Service 1054 Hide 74
Web Services Business Process Execution Layout Tools 458
Language (WS-BPEL) 958 Links 1269
Web Site Locals 1474
Access Any 103 Locals, View Long Values 1474
Access Home 103 Maintenance 1558
Home, Define Default 351 Make Active 74
Sparx Systems 23 Memory Viewer 1476
Well Formedness Validation Menu 74
Attribute 1531 Model Views 1222
Diagram 1531 Modules 1478
Element 1531 Notes 641
Feature 1531 Output 102
Relationship 1531 Output, Debugger 1478
What Is Pan And Zoom 1275
A Check Constraint? 1033 Project Management 312
A Connector? 852 Properties (Element) 508
A Foreign Key? 1024 Record & Analyze 1506
A Model? 372 Relationships 1269
A Pattern? 901 Reload 74
A Primary Key? 1022 Remove From Frame 76
A Project? 113 Requirements 514
A Requirement? 917 Resources 667
A Stored Procedure? 1030 Reveal Autohidden 78
A Tagged Value 632 Scenarios 514
A Trigger Operation? 1033 Scenarios & Requirements 514
An Index? 1033 Scripter 1660
Enterprise Architect? 4 Search, Debugging 1485
User Security? 188 System 323
XMI? 288 Tagged Value 632
Wide Area Network (WAN) Optimizer Tasks Pane 51
Introduction 180 Team Review 208
Performance Of Enterprise Architect 180 Traceability 1253
Transmission Diagram 180 Watches 1475
Window Watches, Break On Variable Changing Value
Add-Ins 58 1477
Autohide 78 Workbench 1521
Breakpoints And Markers 1503 Windows
Bring To Top 74 Authentication 191
Call Stack 1473, 1479 Service, Apache Tomcat 1460
Close All 74 Windows 7
Close All Except Current 74 Use Debugger 1448
Close Current 74 Windows Active Directory
Combine In Frame 76 Import User Login ID From 192
© 1998-2010 Sparx Systems Pty Ltd
 1984 Index

Windows Authentication Manage 86

Accept 192 Select 86
Windows Vista Show/Hide From Toolbar 86
Permissions For Enterprise Architect 21 System Provided 86
Use Debugger 1448 Toolbar 86
WINE Upgrade Customized 86
Debugging 1450 User Defined 86
DIB Data Access Violation 1450 View Menu Option 58
WINE-Crossover WS-BPEL 958
Using Subversion With Enterprise Architect WSDL
Under 249 Binding Diagram 1057
Word Binding Element 1057
Special Considerations 1641 Document Element 1053
Word Substitution Elements And Connectors 420
RTF Report Generation 1615 Group, Toolbox 420
Wordpad Import 1376, 1379
Open 70 Message Diagram 1056
Work Flow Message Element 1056
Monitor With Model Views 342 Model 1050
Work With Namespace Element 1051
Attributes, Automation Interface Code Example Overview Diagram 1051
1773 Port Type Diagram 1056
Enterprise Architect 4 Port Type Element 1056
Methods, Automation Interface Code Example Port Type Operation 1059
1774
Service Diagram 1054
Workbench Variables
Service Element 1054
Constraints 1521
Split Files 1376
Constructors 1521
Toolbox Pages 1050
Create 1521
Transformation 1408
Delete 1521
Web Services 1050
Requirements 1521
WSDL Support
Workbench Window 1521
Introduction 1049
Workflow
Data Structures 220
Objects 220
Script Functions 220
-X-
Script, Import 1661 XMI
Scripts 1663 Export 288, 289
Scripts, Introduction 220 Export MOF To 1383
Working Import 288, 290
With MDG Technologies 1067 Import And Auditing 279
With UML Connectors 606 Import MOF From 1383
Workspace Limitations 293
Toolbars, Docked 79 Manual Version Control 299
Toolbars, Introduction 79 Specifications 288
Workspace Layout UML DTD 293
For Execution Analysis 1424 XMIType Enum
Workspace Layouts Automation Interface 1679
Apply 86 XML
Capture 86 Code Page 367
Customize 86 Default XMI Version 367
Delete 86 Documents, Default Editor 367

Enterprise Architect User Guide

 Index 1985

XML Control On Status Bar 89

Import Referenced Schema 1373 Diagram From Toolbar 83
Package 293 Diagram View 453
Pattern File 901, 902 Submenu 453
Set Default XML Directory 367 Zooming
Set Default XML Editor 367 Code Editor, Common 1432
Specifications, Options Dialog 367 Z-Order
Structure Tree In Source Code Viewer 1441 Submenu 70
Technologies, Introduction 1039
XMI 1.0 Prefix 367
XML Engineering 1373
XML Schema
Elements and Connectors 420
Generate In Garden Of Eden Style 1378
Group, Toolbox 420
Submenu (Project Menu) 64
UML Profile For XSD 1041
XSD 1039
XSD
Abstract Models 1047
Datatype Packages 1047
Generate 1376
Import 1373
Import, Global Element Behaviour 1375
Model 1040
Transformation 1409
XML Schema 1039
XSDany 1041
XSDattribute 1041
XSDattributeGroup 1041
XSDchoice 1041
XSDcomplexType 1041
XSDelement 1041
XSDgroup 1041
XSDrestriction 1041
XSDschema 1041
XSDsequence 1041
XSDsimpleType 1041
XSDtopLevelAttribute 1041
XSDtopLevelElement 1041
XSDunion 1041

-Z-
Z Order
Elements 437
Zachman
Profile 444
Zachman Framework
MDG Technology For, Enterprise Architect
1073
Zoom
© 1998-2010 Sparx Systems Pty Ltd
 1986

Enterprise Architect User Guide

Enterprise Architect User Guide
www.sparxsystems.com