Getting Started with ER/Studio Software

Architect

This section contains an introduction to modeling with ER/Studio Software Architect. The sample projects and Cheat

Sheets are designed to help you explore the features while working with projects. Some of the special features include: patterns, generating project documentation, reverse engineering and so forth.

•

Overview

•

Documentation Set

•

Sample Projects and Cheat Sheets

•

Help on Help

•

Tour of ER/Studio Software Architect

Overview

Welcome to ER/Studio Software Architect, the design-driven environment for modeling applications. ER/Studio

Software Architect includes features such as support for UML 2.0, OCL, patterns, Quality Assurance audits and metrics, XMI format import and export, and automated documentation generation.

ER/Studio Software Architect is shipped with two versions: one version using the regular installer and one using the

Instant On build.

• The Installation Guide for a regular installation is available for download from IDERA’s Product

Documentation web site www.idera.com/support/productdocuments .

•

The Instant On build (ION), is a Xenocode virtualized application. Click here for more information on

using the Instant On Application Launcher.

The ER/Studio Software Architect features are tightly integrated with the Eclipse environment. When ER/Studio

Software Architect support is activated, the following items are added or modified:

• Diagram Editor

• Model Navigator

• Properties View

• Palette

NOTE: If your Internet access is limited by network security, or if your computer is protected by a personal firewall, the Web-based links in this Help system might not function properly.

Related Concepts

•

Documentation Set

•

Help on Help

E M B A R C A D E R O TE C H N O L O G I E S > E R / S T U D I O S O F T W A R E A R C H I T E C T U S E R G U I D E 180

G E T TI N G S T A R TE D W I T H E R / S T U D I O S O F T W A R E A R C H I TE C T > TO U R O F E R / S TU D I O S O F T W A R E A R C H I T E C T

Documentation Set

The documentation set consists of the following items:

Item Description

Release Notes (ReadMe)

Setting Up Licensing for

ER/Studio Software

Architect.

Online help

Location

Late-breaking information including:

Last minute notes

System requirements

Installing and starting ER/Studio Software Architect

Known issues and limitations readme.html

ER/Studio Software Architect licensing setup. ER/Studio Software Architect main menu:

Help/ER/Studio Software Architect

Licensing

General, context, and dynamic help for ER/Studio

Software Architect including the following comprehensive information most relevant to the user:

— Conceptual topics — Getting Started and

Concepts

— Procedural topics — Working with Projects,

Creating and using profiles, Working with diagrams, Working with different types of modeling,

Refactoring procedures, Using OCL, Working with patterns, Quality assurance, and Documentation generation procedures.

— Reference topics — dialogs, wizards and GUI elements

ER/Studio Software Architect main menu:

Help/Help Contents

Cheat Sheets Interactive tutorial that help you start using basic product features. Each cheat sheet helps you complete a single task.

A list of cheat sheets is available in the Sample projects and cheat sheets topic.

ER/Studio Software Architect main menu:

Help/ Cheat Sheets

Related Concepts

•

Help on Help

Sample Projects and Cheat Sheets

ER/Studio Software Architect ships with sample projects and cheat sheets that help you get acquainted with the application and its features.

The sample projects are available under File > New > Other > Examples.

The following is a list of sample projects:

• Profile Definition

• UML 2.0 Notation

Cheat sheets provided with ER/Studio Software Architect are basically interactive tutorials that help you to start using some of the new features. Each cheat sheet helps you complete some task. The cheat sheets are available under:

Help > Cheat Sheets .

E M B A R C A D E R O TE C H N O L O G I E S > E R / S T U D I O S O F T W A R E A R C H I T E C T U S E R G U I D E 181

G E T TI N G S T A R TE D W I T H E R / S T U D I O S O F T W A R E A R C H I TE C T > TO U R O F E R / S TU D I O S O F T W A R E A R C H I T E C T

The following is a list of available cheat sheets

Open this cheat sheet...

to learn how to perform the following

OCL Features

Define and Run Model Audits

OCL Constraint Creation

Create custom model audits using OCL

Create OCL constraint in your project

Search in Model Using OCL Expressions Perform model search using OCL.

Patterns

Create a pattern from Existing Elements

Create a Pattern from Scratch

Export Pattern Definitions

UML Profiles

Apply UML Profile

Define UML Profile

Deploy UML Profile

Apply created UML profile for Web Services modeling

Create custom UML profile for Web Services modeling

Deploy created UML Profile

Help on Help

ER/Studio Software Architect allows you to view various help topics that will assist you while you are completing your tasks.

Online Help

The Online Help includes conceptual overviews, procedural how-to's, and reference information, which allow you to navigate from general to more specific information as needed.

NOTE: When you use a link to navigate from one topic to another topic, the context of the Help topic you are viewing might not be obvious. To find the context of a topic within the

Contents pane, click Show in Table of Contents on the toolbar of the Eclipse Help viewer.

Concepts

Concepts introduce the main features and methods that will help you learn and understand ER/Studio Software

Architect techniques. At the end of most conceptual topics, you will find links to related, more detailed information.

How-To Procedures

The how-to procedures provide step-by-step instructions.

All procedures are listed under Procedures in the Contents pane of the Help window.

Reference Topics

The reference topics provide detailed information on subjects such as configuration options, GUI elements, dialogs, and wizards references.

All of the reference topics are listed under the Reference section in the Contents pane of the Help window.

E M B A R C A D E R O TE C H N O L O G I E S > E R / S T U D I O S O F T W A R E A R C H I T E C T U S E R G U I D E 182

G E T TI N G S T A R TE D W I T H E R / S T U D I O S O F T W A R E A R C H I TE C T > TO U R O F E R / S TU D I O S O F T W A R E A R C H I T E C T

Typographic Conventions Used in the Help

The following typographic conventions are used throughout ER/Studio Software Architect online Help.

Typographic conventions

Convention Used to indicate

Monospace type

Boldface

Italics

KEYCAPS

Related Concepts

•

Documentation Set

Source code, file and folder names, and text that you must type.

GUI elements and dialogs.

Book titles and to emphasize new terms.

Keyboard keys, for example, the CTRL or ENTER key.

Tour of ER/Studio Software Architect

Modeling User Interface

The Modeling perspective is the default perspective. The Modeling perspective provides the following views:

View Description

Add linked results

Model Audits

Model Bookmarks

Model Metrics

Model Navigator

Diagram Editor

Shows results of applying the Add Linked command.

Displays the results of the model audits that are run.

Lists bookmarked model elements.

Displays the results of the model metrics that are run.

Provides the logical representation of the model of a project: namespaces

(packages) and diagram nodes.

Displays created and opened diagrams. When multiple diagrams are used, the diagram editor provides a tab for each diagram.

Properties

Profile Constraints

Profile Validation

OCL Expression

Last Validation Results

Displays the properties for a selected element. The properties for each element are usually divided into different categories.

Lists available profile constraints.

Displays results of the profile validation process.

Enables quick evaluation of OCL expressions in the explicitly specified context (an EM/Studio or EMF model element), or in the context of the current selection.

Displays results of the latest validation of a pattern definition.

Pattern Explorer

Pattern Registry

Enables logical organization of patterns (using virtual trees, folders and shortcuts), and management of recognized instances of patterns.

Defines the virtual hierarchy of patterns.

E M B A R C A D E R O TE C H N O L O G I E S > E R / S T U D I O S O F T W A R E A R C H I T E C T U S E R G U I D E 183

C O N C E P T S > I N T E R O P E R A B I L I TY

Model Menu

View

Generate Class Diagram

Run Model Metrics

Run Model Audits

Compare with

Profile

Documentation

Description

Displays the results of the model metrics you run.

Displays the results of the model audits you run

Each Other (as model elements): Compares two or three selected model elements against each other and shows differences in a separate view

Local Version: Compares a shared resource with a version stored on your disk.

Uninstall Profiles: Uninstalls the selected profile

Open Profile Definition: Opens the profile definition project.

Deploy Profile: Starts the creating profile plug-in process.

Run Profile Constraints: Runs profile-specific audits.

Convert Properties: Converts profile-specific properties of the projects created in the previous version of

ER/Studio Software Architect for Eclipse to the new format. For more information see Converting Profile-

Specific Properties topic in the Procedures section.

Preferences: Opens the Profile preferences in the

Modeling node.

Generate HTML: Opens the Generate HTML

Documentation dialog.

Generate Documentation Using Template: Opens the

Generate Documentation Using Template dialog.

Diagram Menu

The Diagram menu includes commands relevant to working with the diagram currently opened in the Diagram editor.

The commands include, but are not limited to, layout and align, different levels of zoom, switching grid and rulers,

hiding and showing elements, and so forth. For more information, refer to Diagram View .

Related Procedures

•

Choosing a Perspective

E M B A R C A D E R O TE C H N O L O G I E S > E R / S T U D I O S O F T W A R E A R C H I T E C T U S E R G U I D E 184