ER/Studio® Software Architect: Evaluation Guide
ER/Studio® Software Architect: Evaluation Guide
Version 1.0
Published October 7, 2009
Copyright © 1994-2009 Embarcadero Technologies, Inc.
All brands and product names are trademarks or registered trademarks of their respective owners.
This software/documentation contains proprietary information of Embarcadero Technologies, Inc.; 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.
If this software/documentation is delivered to a U.S. Government Agency of the Department of Defense, then it is delivered with
Restricted Rights and the following legend is applicable:
Restricted Rights Legend Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph
(c)(1)(ii) of DFARS 252.227-7013, Rights in Technical Data and Computer Software (October 1988).
If this software/documentation is delivered to a U.S. Government Agency not within the Department of Defense, then it is delivered
with Restricted Rights, as defined in FAR 552.227-14, Rights in Data-General, including Alternate III (June 1987).
Information in this document is subject to change without notice. Revisions may be issued to advise of such changes and additions.
Embarcadero Technologies, Inc. does not warrant that this documentation is error-free.
Contents
Introduction to Embarcadero’s ER/Studio Software Architect ...................................................................... 1
Product Benefits by Audience ................................................................................................................ 1
About This Evaluation Guide ................................................................................................................. 2
Session 1: Getting Started with ER/Studio SA.............................................................................................. 2
Session 2: Understanding the ER/Studio SA Infrastructure ......................................................................... 3
Session 3: Creating a Use Case Diagram .................................................................................................... 6
Placing the Diagram Elements .............................................................................................................. 6
Aligning in the Diagram View ................................................................................................................. 7
Create Generalization Link .................................................................................................................... 9
Creating Association Links .................................................................................................................... 9
Changing the Properties of an Element ............................................................................................... 10
Session 4: Create a Pattern from Existing Elements .................................................................................. 12
Session 5: Define the UML Profile ............................................................................................................. 14
Session 6: Deploy the UML Profile ............................................................................................................ 17
Session 7: Apply the UML Profile .............................................................................................................. 18
Session 8: Generating HTML Documentation ........................................................................................... 19
Setting Preferences for the Documentation Generation ...................................................................... 21
Session 9: Using ER/Studio SA Tools ....................................................................................................... 21
Search .................................................................................................................................................. 21
Diagram Commands ............................................................................................................................ 22
Zooming ............................................................................................................................................... 23
Toolbars ............................................................................................................................................... 23
Layout and Alignment .................................................................................................... 23
Formatting Toolbar ......................................................................................................... 23
Overview Window ................................................................................................................................ 23
Summary ..................................................................................................................................................... 24
Additional Evaluation Resources ................................................................................................................ 24
Introduction to Embarcadero’s ER/Studio Software Architect
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 an Eclipse-based RCP application, and the primary components are a Model
Navigator, Diagram Editor, Palette, and Properties View.
• Improve requirements elaboration definition processes through the use of visualization and
supported modeling notations such as Unified Modeling Language™ (UML).
• Ensure applications and/or integrations are designed and developed clearly with maximum
adaptability and reusability.
• Ensure application requirements, architectures, and designs can be well understood and
communicated effectively to enterprise teams without ambiguity.
Architects and Toolsmiths: Assist with the definition, implementation, customization, and deployment
of Domain Specific Modeling Languages, consisting of MetaModels, Graphical Editors, Transformations,
Reports and additional functions to support the need to express models with tailored tooling.
Development Team: Assists with communication through common language and visual representation
of the requirements, architecture, and code.
Architects and Developers: Assists with improving and monitoring application quality through audits
and metrics for models.
You can use this basic guide as a roadmap of product highlights, but it also is provided to help you find
your own path in exploring ER/Studio SA.
Once you’ve started, you can select Help from the menu to find many additional resources that
complement and build on many of the activities shown in this brief guide.
• Pattern Definition project is a profiled UML 2.0 modeling project that allows creation of new patterns.
• Profile Definition project is a profiled modeling project that allows you to create new profiles.
• UML 2.0 project is a design project with no source code support.
Physically, a package is a folder containing the files that store diagrams and model elements. Contents of a package
can be displayed on a special type of the Class Diagram that is synchronized with the package contents, i.e. all the
classifiers directly owned by this package automatically appear on the package diagram. Each package contains the
single package diagram that is created automatically and cannot be added explicitly.
The root package of a project (Model) is usually referenced as the default package. The package diagram of this
package is called the default diagram. This diagram is created and opened just after the modeling project creation.
Diagram: Each modeling project contains a set of diagrams that are graphical representations of parts of the model.
Diagrams contain graphical elements (nodes connected by paths) that represent model elements.
Each diagram belongs to a certain diagram type (for example, UML 2.0 Class Diagram). The diagram type defines
the typical contents of the diagram (the kind of elements that are usually placed on this diagram) and the notation
used to represent the model elements. For example, a Class in a UML 2.0 project can be added to the Class Diagram
and to the Composite Structure Diagram and will have different representations there. Each diagram has a specific
Palette and context menu that allows creation of the model elements specific to this diagram type.
Diagrams exist within the context of a project. You will have to create or open a project before creating a new
diagram. The set of available diagram types depends on the type of project. In UML 2.0 project you have a set of
standard UML diagrams defined in the UML2.0 specification. Along with the design diagrams that are explicitly
created by the user, ER/Studio SA models have so-called "Package" diagrams. These diagrams have the Class
Diagram type, but they will be generated automatically for each package and show its contents.
Model Elements: Each model in a modeling project is a set of entities that are instances of metaclasses of the
metamodel chosen for the project. These instances are the Model Elements.
Each model element has a set of properties and notations defined for its metaclass. For example, when you create a
UML 2.0 project, every element created in this project instantiates a metaclass from the UML 2.0 metamodel. That is,
each actor on a use case diagram in a UML 2.0 project is an instance of use cases/Actor, and each component is an
instance of components/Component.
The model elements have graphical notation and can be explicitly placed on diagrams, are nodes and links.
2. When you first open the application the Workspace Launcher dialog appears. The workspace
(named “workspace) is placed in the default directory. You can browse to a new location if you want
to change this.
4. To create a new project click File > New > UML 2.0 Project and the New Project dialog appears.
Note: You can also click Alt + Shift + N.
5. Enter the project name “Project One” under Project name. Leave the “use default location” selected
and leave the “Add project to working sets” unselected.
6. Click Next and the Modeling Settings dialog appears. Deselect the “use default” and select Use
Case from the drop-down list. The default diagram name “UseCaseDiagram201” appears. Leave
this diagram name as is.
7. When you click Finish, a new project and diagram are created and appear in the Model Navigator.
The items are displayed in the hierarchal mode in the tree.
5. The Use Cases are placed within the subject to show tasks or activities. Click Use Case ( ) and
place five elements inside the ATM subject.
6. Select an element and then click once again to label each element as follows:
UseCase1 = Withdraw
UseCase2 = Transfer Funds
UseCase3 = Deposit Money
UseCase4 = Register ATM at Bank
UseCase5 = Read Log
1. While holding down the Ctrl key, click the Association Link ( ) in the Use Case Palette.
2. While still holding down the Ctrl key, create association links between the following:
Customer to Withdraw
Customer to Transfer Funds
Customer to Deposit Money
Administrator to Register ATM at Bank
Administrator to Read Log
Bank to Deposit Money
Bank to Register ATM at Bank
ER/Studio Software Architect 1.0 Evaluation Guide 9
Changing the Properties of an Element
When you double-click on an element, the Property View for that element opens. You can use the
Property View to:
• Change the name or properties of an element.
• Enter a description and notes for the element, if applicable.
• View any links or usages that have been created to the element.
• Change the appearance of the object.
For purposes of this diagram, we are going to rename the Administrator actor and add a description.
1. Right-click the Administrator actor in the Diagram View and select Properties to open the Property
View.
Patterns are pluggable extensions for ER/Studio Software Architect enabling you to:
Each pattern describes a set of model elements, relations between them, and constraints applied to those elements.
Patterns are represented by special modeling projects covering all the aspects of patterns. Patterns are independent
of any programming or markup language. You can use them to create or modify any type of element. Concrete
patterns are designed to work with elements of a specific type. The Pattern Registry is used to manage patterns.
Pattern instances appear as a result of recognition of the existing model or creating new instances (along with model
elements playing pattern roles) in the model. Pattern instances contain information about the pattern name and the
role of each participant. They are shown in the Pattern Explorer view and under the Patterns node in the Model
Navigator.
When applied to a diagram, such patterns create their entities and are presented on the diagram itself, with the links
to the created entities. Such patterns enable further modification by means of adding new participants (new pattern
parts). All patterns that appear in the Pattern Explorer are represented in the project model in the form of entities with
metaclass "pattern". Visually, pattern instances will be displayed as ovals (like collaboration occurrences). Pattern
entities will have children links to pattern participants and this allows map links on diagrams from pattern instances to
pattern participants. Actions on pattern instances in the model will be the same as in the pattern explorer.
This portion of the Evaluation Guide walks you through the steps to create a pattern from existing elements using
ER/Studio SA. We are going to create a pattern from the project we created in the last step (Project One).
2. If the diagram is not open in the Diagram View, double-click “UseCaseDiagram201” in the Model Navigator
tree.
ER/Studio Software Architect 1.0 Evaluation Guide 12
3. Next , select the Subject element labeled “ATM” which will be transformed to a pattern definition.
5. In the Export dialog select Modeling > Pattern Definition and then click Next.
6. In the Create Pattern from Elements dialog that opens, enter the pattern name “ProjectOnePattern”
and then click Finish. The new "ProjectOnePattern” appears in the "Workspace" folder of the Pattern
Registry. This Pattern Registry can appear either on the right side of the Diagram View or below the
Diagram view. Now you can run recognition using this pattern or generate new pattern instances.
2. In the New Project dialog, enter the project name “WSDL profile” and click Finish. The WSDL profile
project containing an empty WSDL profile diagram is created. Also note that the Palette now has a
Profile Definition section as well.
3. Click the “stereotype” icon ( ). This icon is located in the Profile Definition portion of the palette.
4. Click in the diagram’s background and a stereotype rectangle is created. Name the stereotype “Web
Service” and press Enter.
ER/Studio Software Architect 1.0 Evaluation Guide 14
5. Create another stereotype icon and name it SOAP Port.
Next we are going to add the metamodel elements “Component” and “Port” to the diagram.
1. Right-click in the diagram’s background and select New > Shortcut on the context menu.
2. In the Shortcuts dialog expand metamodel > UML20 > components, select “Component” and click
Add.
3. In the same dialog, expand metamodels > UML20 > compositestructures, select “Port” and click
Add.
4. Click OK and the “component” and “Port” classes are added to the diagram.
We will continue the process by creating extension links, a namespace, and enumerations.
1. To create extension links click the Extension icon ( ) in the Profile Definition portion of the
palette and draw a link from “Web Service” to “component”. Also draw a link from “SOAP Port” to
“Port”. Notice that the links are labeled “<extension>”.
2. To create the Web Service “namespace” property right-click the “Web Service” stereotype and
select New > Attribute on the context menu.
3. Enter “namespace:String” and press Enter. The “namespace” property of type “String” is
created. Notice that if you enter incorrect syntax in the label the text turns red and remains so
until the error is corrected.
4. Once again, right-click “Web Service” and select Properties from the context menu.
5. Click Profile Definition in the Properties tab and click “viewmap”.
6. Click browse ( ) to open the Specify Node Viewmap. Uncheck the “use default viewmap”
option.
7. Select “color” and click “choose color”. Select Yellow from the color dialog and click OK. Click OK
once again to close the Specify Node Viewmap dialog.
8. Click “Enumeration” ( ) in the Class Diagram Elements palette and click the diagram’s
background.
9. Label the enumeration “Style” and press Enter.
10. Right-click the Enumeration element and select New > Insert > Enumeration Literal. Label it
“rpc”.
1. Click “Palette Contribution” ( ) in the Profile Definition portion of the Palette and click in the
diagram view. Label it “WSDL Profile”
2. Open the properties of the “WSDL Profile” and select “diagrams’ in the Profile Definition view.
Click Edit ( ). In the Select Diagrams dialog, select “Component” and click OK.
3. Click the contribution link ( ) and draw a link from the “WSDL Profile” to both the “Web Service”
and SOAP Port” stereotype elements.
3. Under the HTML Output category, choose the option of processing line breaks.
Search
The Search function searches the entire workspace and then provides a list of the objects that were
found. It searches the data itself, not the element in the diagram.
To perform a search, select Search > Model on the main menu and the Search dialog appears:
You can search a name or any property in the model. The scope of your search can include the entire
workspace, or selected resources or working sets. The search can be limited to specific types of objects
and you can match case and whole words. In the example below we are going to search any element
with the search string of “bank”.
ER/Studio Software Architect 1.0 Evaluation Guide 21
After you click Search, a Search tab view appears with all the elements that matched the search. From
this view, there are several toolbar buttons available which will assist in locating the element in active
diagram, all diagrams, or the model view. There are also toolbar buttons to modify the search and filter
out the results.
Diagram Commands
There are four commands available under Diagram on the main menu that you can use to customize
your diagrams:
Grid When working in the Diagram View you have the option to display grid lines in the view.
You also can ‘snap objects to grid’ so that when you place an object in the Diagram
View, it automatically snaps to the nearest grid line. When an element is moved, it also
snaps to the nearest grid.
1. With a diagram open in the Diagram View, select Diagram > Grid from the main
menu.
Zooming
From the main menu select Diagram to gain access to the commands to adjust the zoom level of any
diagram. These commands are also available on the Diagram View toolbar. You have several different
options available:
Fit to window: Zoom level is reduced in the Diagram View so that the entire diagram fits in the visible
screen area.
Actual Size: Returns the diagram to the original size when created.
Zoom with preset percentages: You can enlarge or reduce a diagram using a preset percentage.
Zoom In and Zoom Out: Each time your click the command the view increases or decreases by a
set percentage.
Toolbars
Layout and Alignment
Use this toolbar to align, evenly distribute, evenly size, stack, or group the elements in a diagram.
Formatting Toolbar
Use this toolbar to: create new projects, diagrams, etc.; save projects or diagrams; print diagrams; create
a new diagram; open the parent diagram; or select elements in an opened diagram.
Overview Window
Click Show Overview ( ) on the Layout and Alignment toolbar. This is a ‘thumbnail’ view of your model
and is useful when working with large diagrams that appear on more than one screen. You have the
ability to pan the entire model. As you move the blue shaded box in the Overview window, the portion in
the highlighted area appears in the Diagram View. Also, if you click an object in the Overview pane, that
object appears in the Diagram View.
Summary
This completes the ER/Studio SA Evaluation Guide. For more information please refer to the online help
in the application.
Web site
Visit our Web site for current product and company information, educational materials and
supporting information. Visit www.embarcadero.com.
Electronic Documentation
Detailed reference documentation is available on the ER/Studio SA Evaluation CD or online at
docs.embarcadero.com.
Email Support
You can contact ER/Studio SA support engineers, consultants and engineers directly by sending
inquiries to [email protected] or log a case through embarcadero.com at:
http://www.embarcadero.com/support/open_case.jsp
Telephone Support
We encourage you to call us anytime you would like help or have questions during your
evaluation.