Sei sulla pagina 1di 2023
Enterprise Architect User Guide Enterprise Architect is an intuitive, flexible and powerful UML analysis and

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.

UML modeling tool, driving the long-term success of your software project. Copyright © 1998-2010 Sparx Systems

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: September 2010

Publisher Sparx Systems Managing Editor Geoffrey Sparks Technical Editors Geoffrey Sparks Dermot O'Bryan Simon
Publisher
Sparx Systems
Managing Editor
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

Special thanks to:

All the people who have contributed suggestions, examples, bug reports and assistance in the development of Enterprise Architect. The task of developing and maintaining this tool has been greatly enhanced by their contribution.

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

Contents

II

File

55

 

Remove Recent

Projects

 

56

Edit

57

 

Paste Elements

Submenu

 

57

View

58

 

View Submenus

59

Project

60

 

Documentation

Submenu

 

61

Source Code

Engineering

Submenu

61

Execution Analyzer

Submenu

62

Database Engineering

Submenu

63

Transformations

Submenu

63

Model Validation

Submenu

63

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

69

   

70

Tools Data Management

Submenu

 

71

 

Manage .EAP

File

Submenu

71

Addins

72

Settings

 

72

Window

73

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

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

User

IDs From Active Directory

192

Assign

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

V

Contents

 

CVS with

Remote

Repositories

240

CVS with

Local

Repositories

244

Version Control

with

Subversion

247

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

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

Users'

Control

Packages

To Branches

261

Include Other

263

Apply Version

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

Auditing Level

273

Audit Options

273

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

Report

Report

From

From

Output

Project Issues Dialog

334

Project Issues Tab

334

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

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

Image

Page Size

455

Scale

to Page Size

456

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

<Item>

& Requirements Window

514

Select

Dialog

515

Select Property

Dialog

 

517

Object Classifiers

519

Using Classifiers

520

Visual Representation

520

Element Icons

521

Compartments

521

Element

Tasks

522

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

Attributes

Attributes

Attribute

Dialog

Dialog

Dialog

Tagged

- General Tab

560

- Detail

562

- Constraints

563

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

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

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

Standard

UML

Models

671

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