0% found this document useful (0 votes)

218 views1,274 pages

VP-UML Users Guide

user guide

Uploaded by

Sukant Makhija

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

218 views1,274 pages

VP-UML Users Guide

user guide

Uploaded by

Sukant Makhija

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 1274

About Visual Paradigm for UML

Visual Paradigm for UML (VP-UML) is a powerful, cross-platform and yet the most easy-to-use visual UML modeling and CASE tool. VP-UML provides
software developers the cutting edge development platform to build quality applications faster, better and cheaper! It facilitates excellent interoperability
with other CASE tools and most of the leading IDEs which excels your entire Model-Code-Deploy development process in this one-stop-shopping
solution.
UML modeling
You can draw all kinds of UML 2.x diagrams in VP-UML, which include:
• Class diagram
• Use case diagram
• Sequence diagram
• Communication diagram
• State machine diagram
• Activity diagram
• Component diagram
• Deployment diagram
• Package diagram
• Object diagram
• Composite structure diagram
• Timing diagram
• Interaction overview diagram
Requirement modeling
Capture requirements with SysML Requirement Diagram, Use Case Modeling, Textual Analysis, CRC Cards, and create screen mock-up with User
Interface designer.
Database modeling
You can draw the following kinds of diagrams to aid in database modeling:
• Entity Relationship Diagram
• ORM Diagram (visualize the mapping between object model and data model)
You can model not only database table, but also stored procedure, triggers, sequence and database view in an ERD.
Besides drawing a diagram from scratch, you can reverse engineer a diagram from an existing database.
Apart from diagramming, you can also synchronize between class diagram and entity relationship diagram to maintain the consistency between them.
SQL generation ane execution feature is available for producing and executing SQL statement from model instantly.
Business process modeling
You can draw the following kinds of diagrams to aid in business process modeling:
• Business process diagram
• Data flow diagram
• Event-drive process chain diagram
• Process map diagram
• Organization Chart
You can also export Business process diagram to BPEL.
Object-Relational mapping
Object-Relational Mapping enables you to access relational database in an object relational approach when coding. VP-UML generates object-
relational mapping layer which incorporates features such as transaction support, pluggable cache layer, connection pool and customizable SQL
statement.
Team collaboration
For users that work as a team, team collaboration support lets you perform modeling collaboratively and concurrently with any one of the following tools
or technologies:
• VP Teamwork Server (Need to buy Visual Paradigm Teamwork Server additionally)
• CVS
• Subversion
• Perforce
Interoperability

About Visual Paradigm for UML P. 1

The interoperability support allows you to exchange model data with other tools. The following tools are supported:

Import Export

Telelogic Modeler

Rational Rose

ERwin Data Modeler project

Rational Software Architect

Rational DNX

NetBeans 6.x UML diagrams

Visio drawing

BPEL for Oracle workflow engine

BPEL for JBoss workflow engine

Diagram (JPG, PNG, SVG, EMF, PDF)

Microsoft Excel

EMF based UML2 model

XMI (1.0, 1.2, 2.1)

XML (native)

VP project

Microsoft Word document (for use case model)

List of standard or tools that are covered by interoperability support

Code engineering

About Visual Paradigm for UML P. 2

Instant Reverse and Instant Generator are provided for reversing engineering and forward engineering. In addition, the Java Round-Trip engineering
support lets you keep code and model in-sync. Below are the type of source code that can be reversed or generated through Instant Reverse and
Instant Generator.

Instant Reverse Instant Generator

Java

C++

XML Schema

PHP

Python Source

Objective-C

CORBA IDL Source

.NET dll or .exe files (binary)

CORBA IDL Source

XML (structure)

JDBC

Hibernate

VB.NET

ODL

ActionScript

Delphi

Perl

Ada95

Ruby

List of souce code supported by Instant Reverse and/or Generator

IDE integration
Support full software development life-cycle, from analysis to design, and from design to implementation with your most favorite IDE. Below are the
supported IDEs:
• Eclipse
• NetBeans/Sun ONE
• IntelliJ IDEA
Documentation generation
Share your design with your customers in popular document formats, including:
• HTML (report generation)
• HTML (project publisher)
• PDF
• Word

About Visual Paradigm for UML P. 3

Editions
Belows are the kinds of features that can be found in each edition of VP-UML. For details, please visit: http://www.visual-paradigm.com/product/vpuml/
editions

Enterprise Professional Standard Modeler Personal Community

UML Modeling

Use Case Diagram

Flow of Events Editor

Requirement Diagram

Glossary Grid

User Interface Mock-up

Entity Relationship Diagram

Generate Hibernate Mapping

Business Process Modeling

Mind Mapping

UML Profile

Design Pattern

Visual Diff

Animacian

Simulacian

Team Collaboration (Teamwork Server)

Team Collaboration (Subversion, Perforce, CVS)

Instant Forward and Reverse Engineering

Java and C++ Round Trip Engineering

Impact Analysis

PDF, HTML Report Generation

Word Report Generation

Report Template Designer

The filled circle indicates the support of certain feature in certain edition

Editions P. 4
A summary of features supported by VP-UML

Editions P. 5
Features
UML support
Improve modeling efficiency with this easy-to-use, feature-rich and reliable UML 2.1 modeling tool.

Enterprise Professional Standard Modeler Personal Community Viewer

Class diagram

Use case diagram

Sequence diagram

Communication diagram

State machine diagram

Activity diagram

Component diagram

Deployment diagram

Package diagram

Object diagram

Composite structure diagram

Timing diagram

Interaction overview diagram

Use case detail editor

Use case flow-of-events listing

Generate sequence diagrams from flow of events lists

Select attribute's getter or setter as call message's action

Business model use case support

The feature is available but unable to make changes.

UML Supports in different editions of VP-UML

Features P. 6
Requirements management
Capture requirements with SysML Requirement Diagram, Use Case Modeling, Textual Analysis, CRC and more!

Enterprise Professional Standard Modeler Personal Community Viewer

Requirement diagram

Textual analysis

CRC Cards

User interface designer

Identify candidate activity and action by textual analysis

Define and customize requirement types

Display full set of requirements in tabular view

Support generating ID for Requirements

The feature is available but unable to make changes.

Requirements management support in different editions of VP-UML

Business process modeling

Visualize, understand and improve your business process with the most comprehensive BPMN tool.

Enterprise Professional Standard Modeler Personal Community Viewer

Business process diagram

Data flow diagram

Event-driven process chain diagram

Process map diagram

Export business process diagrams to BPEL

Identify candidate business process elements using textual analysis

Automatically stretch pools and lanes to fit diagram

Smart routing for connecting objects

Extend business process model with stereotype and tagged value

Set state for data object

Organization chart

Relocate a branch of unit through drag and drop

Nested lanes support

The feature is available but unable to make changes.

Business Process modeling support in different editions of VP-UML

Features P. 7
Animacian
A set of tools to help animating paths in a diagram, or to export animation to flash for further analysis.

Enterprise Professional Standard Modeler Personal Community Viewer

Animate business process using Animacian

Animate sequence diagram using Animacian

Animate activity diagram using Animacian

Travel along execution path with slider

Step forward and backward in an animation

Auto validate execution path

Auto calculate all possible execution paths

Eliminate paths using filter

Dim non-execution path

Support Full and Compact Mode

Protect diagram when animating

Export selected path to flash format

Animate and navigate animation in exported flash

The feature is available but unable to make changes.

Animacian support in different editions of VP-UML

Mind mapping

Enterprise Professional Standard Modeler Personal Community Viewer

Mind map diagram

Create link relationships between nodes

Smart layout for mind mapping nodes and diagram

Mind Mapping support in different editions of VP-UML

Database modeling
Enhance database documentation quality with sophisticated ERD and Object-Relational Mapping diagrams.

Enterprise Professional Standard Modeler Personal Community Viewer

Entity relationship diagram

ORM diagrams

Reverse engineer existing databases to entity relationship diagrams

(ERDs)

Generate and execute database schema (DDLs)

Conceptual, logical and physical ERD support

Reverse engineer stored procedures to ERDs

Features P. 8
Foreign key auto-naming

Define PK naming pattern

Define FK relationship naming pattern

Model primary key in object model by using the <<PK>> stereotype

Download database drivers automatically

Display database architecture in object-relational mapping (ORM) pane

Customizable SQL generation

Generate class diagrams from ERDs

Generate ERDs from class diagrams

Select target diagram when first synchronized between class diagram

and ERD

Jump between ORM class and entity

Generate and reverse engineer database support for Oracle schema

Generate or reverse engineer user-defined database types

Database trigger and stored procedure modeling

Reverse engineer DDL models to ERD models

Database trigger and stored procedure generation and reversal

Unique and Index support for entities

Convert a normal association to ORM association

Support AbstractPersistable class for generating non ORM super class

attributes

Configurable generated SQL statements in upper or lower case

Model and generate DB Sequence (Oracle and DB2 only)

The feature is available but unable to make changes.

Database modeling support in different editions of VP-UML

Features P. 9
Object-Relational mapping
Know how to manipulate objects in Java, .NET and PHP? Then you now know how to access relational databases. No more tedious database
programming! Just leave it to us.

Enterprise Professional Standard Modeler Personal Community Viewer

Java ORM code generation

.NET ORM code generation

PHP ORM code generation

Lazy collection fetching

Database view support

Custom ID generator support

Map single classes to multiple tables

Custom query support

Automatic array table generation

Criteria class generation

DAO code generation

Factory code generation

POJO code generation

Optional library selection

Hibernate annotation support in ORM persistence

Generate Hibernate version tags for optimistic concurrency control

Formula support for ORM attribute

User defined exception support in error handling

Define default type mapping between database column and class

attribute

Configurable naming pattern for synchronization between Class

Diagram and ERD

Object Relational Mapping support in different editions of VP-UML

Visual modeling
Improve the user-friendlyness of drawing diagrams, thus speed up the time need to spend on diagramming.

Enterprise Professional Standard Modeler Personal Community Viewer

Reference other projects' model elements

Freehand shape support

Justify shape name

Support enable or disable minimum shape size

Features P. 10
Layer support to show/hide set of shape with single click

Support showing line jump in Arc, Square, Skip or normal

Align Connector Caption Base on Connector Orientation

Annotation with callout shapes

Annotation with freehand shapes

Organize model elements and diagrams using Model Explorer

Bookmark support

Handi-Selection tool

Customizable data types for use with multiple programming languages

Overview diagrams

Resource-centric interface

Model sharing

Cut, copy and paste

Copy diagrams as images for use in other applications

Undo and redo options

Mouse gestures

Reverse connector direction

Group creation support

Jump to feature for selecting a particular shape or model

Quick connect feature

Easy navigation to connected elements

Model commenting

Duplicate shapes and models

Selectable/non-selectable toggling for shapes

Diagram locking

Reference to any type of artifact

Advanced file and directory selector

Advanced tree support

Duplicate, move and reconnect connectors

Package headers for all types of diagrams

Features P. 11
Tagged value display toggling for diagram elements

Sub-diagrams and reference indicators

Rectilinear, round rectilinear, oblique, round oblique and curve

connector styles

Space reclamation using Sweeper

Space elimination using Magnet

Create shapes with user-defined initial sizes

Drag-and-drop creation of shapes using trees in diagrams

Auto-fit shape sizes

In-line editing

Spell checking

Visual alignment guides

Numerous grid options

Diagram information display in diagrams

Jump to diagram feature

Drag-and-drop copying, moving and reordering of classes and entity

members

Open view from model element

Diagram renaming boxes

Add folders as favorites

Display Undo/Redo action names

Inverse shape selection

Create new attribute with Enter key

Automatic reroute connector when overlapped with other shapes

Hide shapes or type of shapes on a diagram

Visualize related model element

Enforcing master view between model element and shape

Auto extend activation

Model name completion for class

Pinnable connector end

The feature is available but unable to make changes.

Visual Modeling support in different editions of VP-UML

Features P. 12
Visual diff
A set of tools that help to compare diagrams, and identify their differences.

Enterprise Professional Standard Modeler Personal Community Viewer

Compare and show difference between diagrams visually

Support compare by name, id and transitor options

Compare view, model element or both kinds of properties

Filter result by displaying all, addition, modification or deletion of items

Support of Visual Diff in different editions of VP-UML

Design pattern support

Define a pattern and save it for future use, or share with team members for making the design consistent.

Enterprise Professional Standard Modeler Personal Community Viewer

Design pattern support for class diagrams

Full Gang of Four (GOF) design patterns support

Define pattern with a configurable number of subclasses

Define pattern with a configurable number of attributes and operations

Define pattern with implementation hierarchy

Define pattern with automatically named association end

Automatically rename elements in pattern

Design pattern support for sequence diagrams

Design pattern support for all UML diagram types

Design pattern support for entity relationship diagrams

Design pattern support for business process diagrams

Sharing Design Patterns through team collaboration support

Design Pattern support in different editions of VP-UML

Model element nicknaming

Define nickname for a set of models.

Enterprise Professional Standard Modeler Personal Community Viewer

Assign nicknames to model elements

Model element nicknaming in different editions of VP-UML

Features P. 13
Model transitor
Setup and maintain transition between models through the Model Transitor

Enterprise Professional Standard Modeler Personal Community Viewer

Generate and link model elements

Trace the origin of model elements (model traceability)

Navigate between operation and sequence diagram

Transit Entity relationship diagram from Conceptual to Logical to

Physical

Model Transitor support in different editions of VP-UML

Style and formatting

Define and apply style and formatting to shapes.

Enterprise Professional Standard Modeler Personal Community Viewer

Manage and apply styles within project

Customizable shape style and formatting

Image incorporation in diagrams

Stereotyped element appearance

Rich text documentation

Add rich text elements to diagrams

Shape format copier

Enrich model documentation with images

Save/load template for model documentation

Display stereotyped model element as image icon

The feature is available but unable to make changes.

Style and Formatting support in different editions of VP-UML

Features P. 14
Team collaboration with VP teamwork server
Perform modeling collaboratively and concurrently with the VP Teamwork Server.

Enterprise Professional Standard Modeler Personal Community Viewer

Concurrent and collaborative modeling with VP Teamwork Server

Import projects to VP Teamwork Server

View projects from VP Teamwork Server

Commit project changes to VP Teamwork Server

Update local project copy using VP Teamwork Server

Review past revisions using VP Teamwork Server

Compare past revisions using VP Teamwork Server

Undo committed changes by reverting revisions

Detect and resolve conflicts using VP Teamwork Server

Branch and tag projects using VP Teamwork Server

Merge branch changes using VP Teamwork Server

Export multiple revisions from VP Teamwork Server

Run VP Teamwork Server on common Java web servers

Element based revision history

Preview local and server changes before commit or update

The feature is available but unable to make changes.

Support of Teamwork Collaboration with Teamwork Server in different editions of VP-UML

Features P. 15
Team collaboration with CVS repository
Perform modeling collaboratively and concurrently with CVS.

Enterprise Professional Standard Modeler Personal Community Viewer

Concurrent and collaborative modeling with CVS Repository

Import projects to CVS Repository

View projects from CVS Repository

Commit project changes to CVS Repository

Update local project copy using CVS Repository

Review past revisions using CVS Repository

Compare past revisions using CVS Repository

Undo committed changes by reverting revisions

Detect and resolve conflicts using CVS Repository

Branch and tag projects using CVS Repository

Merge branch changes using CVS Repository

Export multiple revisions from CVS Repository

Element based revision history

Preview local and server changes before commit or update

The feature is available but unable to make changes.

Support of Teamwork Collaboration with CVS Repository in different editions of VP-UML

Features P. 16
Team collaboration with Subversion repository
Perform modeling collaboratively and concurrently with Subversion.

Enterprise Professional Standard Modeler Personal Community Viewer

Concurrent and collaborative modeling with Subversion Repository

Import projects to Subversion Repository

View projects from Subversion Repository

Commit project changes to Subversion Repository

Update local project copy using Subversion Repository

Review past revisions using Subversion Repository

Compare past revisions using Subversion Repository

Undo committed changes by reverting revisions

Detect and resolve conflicts using Subversion Repository

Branch and tag projects using Subversion Repository

Merge branch changes using Subversion Repository

Export multiple revisions from Subversion Repository

Element based revision history

Preview local and server changes before commit or update

The feature is available but unable to make changes.

Support of Teamwork Collaboration with Subversion Repository in different editions of VP-UML

Features P. 17
Team collaboration with Perforce
Perform modeling collaboratively and concurrently with the Perforce.

Enterprise Professional Standard Modeler Personal Community Viewer

Concurrent and collaborative modeling with Perforce Repository

Import projects to Perforce Repository

View projects from Perforce Repository

Commit project changes to Perforce Repository

Update local project copy using Perforce Repository

Review past revisions using Perforce Repository

Compare past revisions using Perforce Repository

Undo committed changes by reverting revisions

Detect and resolve conflicts using Perforce Repository

Branch and tag projects using Perforce Repository

Merge branch changes using Perforce Repository

Export multiple revisions from Perforce Repository

Element based revision history

Preview local and server changes before commit or update

The feature is available but unable to make changes.

Support of Teamwork Collaboration with Perforce in different editions of VP-UML

Documentation generation
Share your design with your customers in popular document formats (PDF, HTML and MS Word).

Enterprise Professional Standard Modeler Personal Community Viewer

PDF report generation

MS Word report generation [1]

HTML report generation

Project publisher

Ad Hoc report creation [1]

Intelligent element sorting during report generation

[1] This feature is only available for the Windows platform.

Documentation generation support in different editions of VP-UML

Features P. 18
Printing
Print out diagrams using the Print features.

Enterprise Professional Standard Modeler Personal Community Viewer

Print multiple diagrams

Preview printable pages

Print clip marks

Page margin, size and orientation alteration support

Fit-to-pages option

Fit-to-ratio option

Customizable page header and footer

Project name and diagram name display in header or footer

Print with frame or border support

Toggle gradient color printing

Quick print support

This feature is available but the single watermark will be shown.

The feature is available but the single watermark will be shown when the project has one diagram per diagram type. And the pattern watermark will
be shown when the project has more than one diagram per diagram type.

Printing support in different editions of VP-UML

IDE integrations
Support full software development life-cycle, from analysis to design, and from design to implementation with your most favorite IDE.

Enterprise Professional Standard Modeler Personal Community Viewer

Activate full UML environment from your favorite IDE

Automatic code and model synchronization

Simple integration of any IDE

Import existing VP-UML project to IDE

Integration with Eclipse

Integration with NetBeans

Integration with IntelliJ IDEA

Multilingual support in IDE integration

IDE integration support in different editions of VP-UML

Features P. 19
Reverse engineering
Reverse engineer UML models from source code.

Enterprise Professional Standard Modeler Personal Community Viewer

Reverse engineer source code or executables to class diagrams using

Instant Reverse feature

Reverse engineer Java source code, classes and .jar files

Reverse engineer C++ source code

Reverse engineer .NET .dll and .exe files

Reverse engineer CORBA IDL source code

Reverse engineer Ada 9x source code

Reverse engineer XML

Reverse engineer XML Schema

Reverse engineer databases with JDBC

Reverse engineer Hibernate mapping files

Reverse engineer PHP 5.0 source code

Reverse engineer Python

On-demand Java reverse engineering

Template parameter support

Reverse Engineering support in different editions of VP-UML

Features P. 20
Code generation
Generate various kind of source code from class models.

Enterprise Professional Standard Modeler Personal Community Viewer

Instantly generate source code from class diagrams

Generate Java source code

Generate C# source code

Generate VB.NET source code

Generate PHP 5.0 source code

Generate Object Definition Language source code

Generate Flash ActionScript 3.0 source code

Generate IDL source code

Generate C++ source code

Generate Delphi source code

Generate Perl source code

Generate XML Schema source code

Generate Python source code

Generate Objective-C source code

Generate Ada source code

Generate Ruby source code

Template parameter support

Template support for generating source code with generic constructs

Customizable source code generation

Code generation support in different editions of VP-UML

State machine diagram code generation

Generate code from a state machine diagram for state machine.

Enterprise Professional Standard Modeler Personal Community Viewer

Generate Java source code from state diagram

Generate C++ source code from state diagram

Generate C# source code from state diagram

Generate VB.NET source code from state diagram

State Machine Diagram code generation support in different editions of VP-UML

Features P. 21
Java round-trip engineering
Update between UML class models and Java source code with the round-trip engineering functionalities.

Enterprise Professional Standard Modeler Personal Community Viewer

Reverse engineer Java source code to class diagram

Update Java source code based on class diagram

Java Round-Trip support in different editions of VP-UML

Shape editor
Create domain specific shapes with Shape Editor to use in diagrams.

Enterprise Professional Standard Modeler Personal Community Viewer

Design arbitrary shapes

Import SVG shapes

Incorporate different shapes into UML diagram

Organize shapes by gallery, category and stencil

Advanced shape design capabilities

Shape Editor support in different editions of VP-UML

Layout facilities
Tidy up diagram content by performing layout with several mouse actions.

Enterprise Professional Standard Modeler Personal Community Viewer

Automatic diagram layouts

Shape alignment and centering

Uniform shape width and height maintenance

Automatic shape distribution

Layout support in different editions of VP-UML

Interoperability
Exchange UML diagrams and models with other tools with industrial standard representation.

Enterprise Professional Standard Modeler Personal Community Viewer

Import Telelogic Modeler project files

Import and export EMF based UML2 model

Command-line operations

Import and export XMI 1.0, 1.2 and 2.1

Import and export XML

Import and export VP project file format

Import and export use case model to MS Word

Import Rational Rose project files

Features P. 22
Import ERwin data modeler project files [2]

Generate BPEL code for Oracle workflow engine

Generate BPEL code for JBoss workflow engine

Export diagrams as JPG, PNG, SVG and EMF image files

Export diagrams as PDFs

Slice exported diagrams into smaller segments

Import Rational Software Architect files

Import Rational DNX

Import NetBeans 6.x UML diagrams

Copy diagram elements as XML

Import Visio drawings into Visual Paradigm

Import and export Microsoft Excel file for use case diagram

Import and export Microsoft Excel file for class diagram

Import and export Microsoft Excel file for sequence diagram

Import and export Microsoft Excel file for communication diagram

Import and export Microsoft Excel file for state machine diagram

Import and export Microsoft Excel file for activity diagram

Import and export Microsoft Excel file for component diagram

Import and export Microsoft Excel file for deployment diagram

Import and export Microsoft Excel file for package diagram

Import and export Microsoft Excel file for object diagram

Import and export Microsoft Excel file for composite structure diagram

Import and export Microsoft Excel file for interaction overview diagram

Import and export Microsoft Excel file for requirement diagram

Import and export Microsoft Excel file for basic diagram

Import and export Microsoft Excel file for crc card diagram

Import and export Microsoft Excel file for entity relationship diagram

Import and export Microsoft Excel file for orm diagram

Import and export Microsoft Excel file for business process diagram

Import and export Microsoft Excel file for data flow diagram

Features P. 23
Import and export Microsoft Excel file for epc diagram

Import and export Microsoft Excel file for process map diagram

Import and export Microsoft Excel file for organization chart

Import and export Microsoft Excel file for mind mapping diagram

[2] This feature requires ERwin project on version 7.0 or above.

This feature is available but the single watermark will be shown.

Interoperability support in different editions of VP-UML

Intuitive user interface

User friendly user interface to let you achieve tasks effortlessly.

Enterprise Professional Standard Modeler Personal Community Viewer

Group diagrams by category

Advanced property pane

Dockable user interface windows

New project generation using predefined templates

Easy-to-use "New Diagram" dialog

Flexible zooming

Palette-style toolbar

Collapsible toolbar

Display tool names for toolbar buttons

Expand grouped toolbar buttons

Display various diagram categories in toolbar

Display stereotyped model types in toolbar

Numerous looks-and-feels

Import user preferences from existing workspaces

Multilingual support

Searchable options

Customizable program shortcuts

The feature is available but unable to make changes.

Support of 'intuitive user interface' in different editions of VP-UML

Features P. 24
Automatic updates
Keep VP-UML up-to-date with the automatic updates features.

Enterprise Professional Standard Modeler Personal Community Viewer

Automatic online updating

Maintain local update server with update synchronizer

Support of 'automatic updates' in different editions of VP-UML

Open architecture
Extend VP-UML's functionalities using plug-in

Enterprise Professional Standard Modeler Personal Community Viewer

Plug-in support (Java)

VP model and XML interaction

Support of 'open architect' in different editions of VP-UML

Features P. 25
Licensing
VP-UML need to run with a valid license key. A license key of a higher edition can be used on a lower edition. For example, you can run Standard
Edition of VP-UML with Professional Edition of VP-UML key.
VP-UML also provides a 30-days evaluation key for trial. After the evaluation key expires, you can purchase the full license from our website or
resellers, or un-install the program.
The license key for Community Edition will not expire. However, Community Edition cannot be used for commercial purposes.

Importing single-seat license key (For purchased customers)

A Visual Paradigm's Single Seat (developer based) license allows a licensee to install the software on more than one machine, such as desktop and
notebook, which belong to the licensee only. As the license is developer based, the software must be used by the licensee only, without running more
for than one instance concurrently. When you run VP-UML the first time, the License Key Manager pops up to let you import the license key.

License Key Manager

NOTE: To start License Key Manager in VP-UML, select Tools > Key Manager... from the main menu.

To import a single-seat key, select License Keys > Import... from the menu. In the Import License Key dialog box, specify the filepath of the key and
press OK to confirm.

Entering the filepath of license key

Licensing P. 26
If the imported key is valid, information of key will appear in the License Key Manager.

License key is imported

Importing evaluation key (For evaluation users)

You can evaluate VP-UML for 10 days without importing any keys. To do this, click Close to close the key manager and continue running VP-UML.
After 10 days gone, the key manager will popup again when you start VP-UML, requesting for a key. At that moment, you must supply a valid key in
order to continue.
If you want to evaluate for a longer period of time, click Request key to request for an evaluation key that enables you to run VP-UML for 30-days.
Click Import key to import the evaluation key into the key manager and continue.

Working with floating license server

Before you use VP-UML with a floating license key, your machine need to access to the license server via LAN to acquire a license key first. For more
details, you can refer to the Floating License Server Installation Guide about floating license server installation for more details.

Configuring floating license server

Floating license need to be acquired from server, through the License Key Manager. When you start VP-UML the first time, the License Key
Manager will show up automatically. From the License Key Manager, select License Keys > Floating License > Configure... in the menu.

To confirm floating license

NOTE: To start License Key Manager in VP-UML, select Tools > Key Manager... from the main menu.

Licensing P. 27
In the configuration page, specify the host IP and adjust the port (if necessary). You may need to specify the access code if it has been defined in
floating license server. You should contact your administrator about this matter.

Specifying host of license server

In order to verify the connection, press Test Connection. Alternatively, you may click on the View Keys button to see how many keys are available in
server.

Viewing license in license server

Once the configuration is done correctly, license key will be acquired from license server. By closing the License Key Manager, VP-UML will start.

Exporting floating license key from server

In order to acquire a floating license key, you must have access to the floating license server machine through network. If you need to use VP-UML
offline, which means, at a location that cannot reach the server machine (e.g. when having a meeting outside the office), you can export a floating
license keys to your laptop for running VP-UML with a local license key. Once a key has been exported from server, the number of keys in the server
will decrease by one. The volume will reset once you have imported the licence key back to the server.

Licensing P. 28
To export floating license key, start the License Key Manager by selecting Tools > Key Manager... in the main menu of VP-UML, and select License
Keys > Floating License > Export Floating License... in the menu of License Key Manager.

To export floating license key

A message appears informing you about the export of license key.

From the moment the key is exported from server, you do not need to connect to the license server anymore until the moment you import the key back
to the server.

Importing floating license key to server

To import an exported floating license key back to license server, start the License Key Manager by selecting Tools > Key Manager... in the main
menu of VP-UML, and select License Keys > Floating License > Import Floating License... in the menu of License Key Manager.

To import floating license key

In the Import Floating License Key dialog box, select the key you need to import and click OK to confirm.

Select the license key to import

This finished importing the key back to server.

Switching from evaluation license key to purchased license key

An evaluation key is required for evaluating VP-UML. But once you have purchased, you will receive a purchased license key from Visual Paradigm.
In order to make the purchased key take effect, you need to remove the evaluation keys, then import the purchased license key. To switching from an
evaluation license key to a purchased license key:
1. Start VP-UML.

Licensing P. 29
2. Start the License Key Manager by selecting Tools > Key Manager... from the main menu.

NOTE: If your evaluation has expired, you can skip this step as the License Key Manager was shown when starting VP-UML (step 1) due to no
valid license key was found.

3. Remove all license keys by selecting License Keys > Remove All Keys from the menu of License Key Manager.

To remove all keys in License Key Manager

This cause all the keys to be removed from the License Key Manager. Therefore, you should not see any entry in the manager.
4. You can import the purchased license key now. For single-seat key user, select License Keys > Import..., then specify the filepath of the
purchased license key. For floating license user, configure the license server connection by selecting License Keys > Floating License >
Configure... from the menu. For details, refer to the previous section.

Various licensing options

Single seat license
Visual Paradigm's single-seat (team-member-based) license allows a licensee to install the software on a computer that belongs, and provides sole
access, to the named user only. Since the license is team-member-based, the software must be used by the licensee only, without running more than
one instance concurrently. The single-seat license only allows installation on a maximum of three computers.

Floating license
The floating license supports sharing of the pool of licenses among your team. Instead of purchasing a single-seat license for each team member,
optimize your budget by purchasing floating licenses for the maximum number of simultaneous software users or access points. This approach allows
greater flexibility in using our software. Users can then export the license files to a laptop to use the software offsite (to deliver a presentation, for
example), and then import the license back to the server at a later time.
In order to work with the floating license, installation of a floating license server that stores the license key file(s) and also automatically manages
access requests from clients is required. The client must enable the connection to the license server when requesting access to the software.
For more information about floating licenses, please visit
http://www.visual-paradigm.com/shop/floatinglicense.jsp .

Academic license
Academic licenses are available for higher education, with the aim of providing free site licenses for the teaching of software engineering. Educational
institutions that join the Academic Partners Program are entitled to free licenses for the Standard Edition of Visual Paradigm's software, which can
then be used solely for educational purposes. The academic license is not limited to use on campus, but can also be used at home by students and
teachers.
For more information about academic licenses, please visit
http://www.visual-paradigm.com/partner/academic/ .

Licensing P. 30
Software maintenance
The Visual Paradigm Software Maintenance package includes both version upgrades and technical support services for our customers. The following
benefits are all included in the Visual Paradigm Software Maintenance package.

Version upgrades
From time to time, Visual Paradigm releases new versions of its software. Normally there are two or three versions released every year, with each
new version having around five to ten distinct new features as well as a number of improvements. The easiest way to get the latest version from Visual
Paradigm is to purchase the software maintenance package. Both minor upgrade (e.g., 6.1 to 6.1 SP1) and major upgrade (e.g., 7.0 to 7.1 or 8.0) of
Visual Paradigm products are included in the software maintenance package, thus entitling you to get all of the version upgrades issued within the
software maintenance period.

Technical support
You and your team members can submit technical support tickets to our Technical Support Team at http://www.visual-paradigm.com/support/
technicalsupport.jsp
Our Technical Support Team will respond to your message within one working day. Normally, you will receive our response by email within a few
hours.
Visual Paradigm is committed to delivering extraordinary technical support to our customers. Our Technical Support Team employs the following
technologies to back up our products.
Email with text and screen shot attachments
In most cases we can provide assistance by guiding you with the aid of screen shots.
LIVE help
Our Technical Support Team uses a real-time, web-based chat program to discuss the problem with you directly.
Flash demo
Sometimes, a short movie is more descriptive than a thousand words. If the answer to your question is complex, we can prepare a short Flash
demonstration to guide you in resolving your difficulty.
Secure online sessions
We can schedule an online meeting with you to take an interactive look at your issue. Online meetings are held using a secure Internet connection.
During the meeting, our team can remotely access and operate your PC while speaking with you by telephone or while chatting with you using the built-
in chat program.
Telephone
You can leave a callback request at the following URL. Our Technical Support Team will return your call as soon as possible. To make a call, visit:
http://www.visual-paradigm.com/support/callme.jsp

Price
Software maintenance is purchased in year-long terms (e.g., June 20, 2007 to June 19, 2008).
If you decide to purchase the software maintenance package with your product, or if you decide to extend a current maintenance contract, the yearly
cost is 20% of the product list price. To take advantage of this 20% offer, you must extend your maintenance contract at least one week prior to its
expiration date.
If you decide to purchase a software maintenance package separately, the yearly cost is 30% of the product list price.
You can purchase software maintenance to cover up to three years from the date of purchase.
Detailed software maintenance package pricing is listed below.
Single seat license
Prices are provided in US dollar

Edition 1 Year Maintenance 1 Year Maintenance

(extend current maintenance) (buy maintenance separately)

Enterprise $279.5 $419.5

Professional $139.5 $209.5

Standard $59.5 $89.5

Modeler $19.5 $29.5

Personal $11.5 $17.5

Community not applicable not applicable

Viewer not applicable not applicable

The above software maintenance contract prices are for 1 year only.

Price for single-seat license

Floating license

Software Maintenance P. 31
Prices are provided in US dollar

Edition 1 Year Maintenance 1 Year Maintenance

(extend current maintenance) (buy maintenance separately)

Enterprise $363.5 $545.5

Professional $181.5 $272.5

Standard $77.5 $116.5

Modeler $25.5 $38.5

Personal not applicable not applicable

Community not applicable not applicable

Viewer not applicable not applicable

The above software maintenance contract prices are for 1 year only.

Price for floating license

Software Maintenance P. 32
System requirements
Hardware requirements
• Intel Pentium III Compatible Processor at 1.0 GHz or higher.
• Minimum 512MB RAM, but 1.0 GB is recommended.
• Minimum 800MB disk space.
• Microsoft Windows (98/2000/XP/2003/Vista/7), Linux, Mac OS X, Solaris or all other Java-enabled platforms.

IDE requirements (for IDE integration)

• Eclipse 3.1 or above
• IntelliJ IDEA 4 or above (8.1 ready)
• NetBeans 4.0 or above (6.8 ready)

System Requirements P. 33
Installing Visual Paradigm for UML on Windows 2000/NT/2003/XP/Vista
Having downloaded the installer of Visual Paradigm Suite (VP Suite), you can execute it, run through the installation to install the suite as well as VP-
UML. If you are using the no-install zip version, you just need to unzip it, launch the suite and install VP-UML. In this chapter, we will go through the
installation of VP-UML both with installer (.exe) and no-install (.zip).

Using installer (.exe)

1. Execute the downloaded VP Suite installer file. The setup wizard appear as below.

VP Suite Welcome screen

2. Click Next to proceed to the License agreement page.

3. Read through the License Agreement carefully. Make sure you accept the terms before continuing with the installation. If you accept the
agreement, select I accept the agreement and click Next > to proceed to the Select Destination Directory page.

The License Agreement

Installing Visual Paradigm for UML on Windows 2000/NT/2003/XP/Vista P. 34

4. Specify the directory for installing VP Suite. Click Next > to proceed to the next page.
5. Specify the name of the Start Menu folder that will be used to store the shortcuts. Keep Create shortcuts for all users checked if you want the
shortcut to be available in all the user accounts in the machine. Click Next > to proceed.
6. In the File Association page, keep Visual Paradigm Project (*.vpp) and Visual Paradigm License File (*.zvpl) checked if you want your
system able to open the project file and the license key file. Click Next > to proceed to the product selection page.
7. Select Visual Paradigm for UML. Click Next > to proceed to the product configuration page.

The product selection page

8. VP-UML features vary by product edition. For more details on the features supported by different editions, click the hyperlink Edition
Comparison which brings you to the web page of VP-UML feature comparison for different editions.

Select product edition

Installing Visual Paradigm for UML on Windows 2000/NT/2003/XP/Vista P. 35

9. For users who are going to run VP-UML with floating license, the Pre-Configuration File section enables you to configure the connection(s) to
floating license server by providing a configuration file. The pre configuration is optional. If you do not define the connection here, you will need
to do so when starting VP-UML the first time. Below is the pre-configuration file file content:
?xml version="1.0" encoding="UTF-8"?>
<LicenseServer>
<Server accessCode="" host="" port=""/>
<Server accessCode="" host="" port=""/>
<Server accessCode="" host="" port=""/>
<Server accessCode="" host="" port=""/>
</LicenseServer>
Selecting Enable Product Selector for Product Selection will result in creating a shortcut under the Start Menu for starting the Product Selector,
a utility that lets you realize the installed products with available keys in the floating license server.

Pre-configure floating license server connection and enable product selector for floating license user

10. Select Download Online Help if you want to be able to access the Help contents from within the tool. Select Download PDF/HTML Version if
you wish to read the documentation in this two types of formats. Press Next > to proceed to the license import page.

Download documentation

Installing Visual Paradigm for UML on Windows 2000/NT/2003/XP/Vista P. 36

11. A combined license key is a key file which allows unlocking multiple products. To import a combined license key, select Combined License Key
and specify the file path of the key.
A single license key is a key file which allows unlocking only one product. To import a single license key, select Single License Key and specify
the file path of the key.
The import of license key is optional at this point, because you can import it when you run VP-UML. Click Next > to proceed with copying files.

The license key selection page

NOTE: For evaluation, the key should be sent to your email box (unless you have chosen not to receive it before download). If you have not
received the email with key yet, and if you have selected to receive the key as attachment, the email might be treated as spam by
mistake. Click on Request Evaluation Key to ask for another one. This time, try not to select sending the key as attachment.

Installing Visual Paradigm for UML on Windows 2000/NT/2003/XP/Vista P. 37

12. Upon finishing, you can select whether to start VP-UML or not. Keep Visual Paradigm for UML selected and click Finish will run VP-UML right
away.

Installation completed screen

Using no install version (.zip)

1. Decompress the downloaded zip file into a directory. This should create a subdirectory named “VP Suite 4.0” where 4.0 is the
version number.

Extracting No-Install zip file

Installing Visual Paradigm for UML on Windows 2000/NT/2003/XP/Vista P. 38

2. Change directory to “VP Suite 4.0\bin” and execute VP Suite in it.

Launching VP Suite

3. Select Visual Paradigm for UML. Click Next > to proceed to the product configuration page.

The product selection page

Installing Visual Paradigm for UML on Windows 2000/NT/2003/XP/Vista P. 39

4. VP-UML features vary by product edition. For more details on the features supported by different editions, click the hyperlink Edition
Comparison which brings you to the web page of VP-UML feature comparison for different editions.

Select product edition

5. Select Download Online Help if you want to be able to access the Help contents from within the tool. Select Download PDF/HTML Version if
you wish to read the documentation in this two types of formats. Press Next > to proceed to the license import page.

Download documentation

Installing Visual Paradigm for UML on Windows 2000/NT/2003/XP/Vista P. 40

6. A combined license key is a key file which allows unlocking multiple products. To import a combined license key, select Combined License Key
and specify the file path of the key.
A single license key is a key file which allows unlocking only one product. To import a single license key, select Single License Key and specify
the file path of the key.
The import of license key is optional at this point, because you can import it when you run VP-UML. Click Next > to proceed with copying files.

The license key selection page

7. Upon finishing, you can select whether to start VP-UML or not. Keep Visual Paradigm for UML selected and click Finish will run VP-UML right
away.

Installation completed screen

Installing Visual Paradigm for UML on Windows 2000/NT/2003/XP/Vista P. 41

Installation FAQ
Question: What is the difference between Installer and "No Install Version"?
Answer: Installer version creates shortcut and registers the menus that make the system more easy to use. We suggest user to use installer version for
a long term usage. The No Install version is good for evaluation and testing the release candidate.
Question: I cannot complete the installation due to a file is missing when copying files. What can I do?
Answer: This can be caused by a corrupted installer file. Please download the installer file again with a different mirror site and run it again to solve the
problem.
Question: I cannot start the application after installing the software. What can I do?
Answer: There are several possible causes of the problem. If you are sure that your installation was performed correctly, contact Visual Paradigm's
support team ( [email protected] ) for assistance. It is recommended to include the vp.log file, which can be found at the bin folder
of VP Suite installation directory, for our team to diagnose in further.
Question: I don't have administrator right, can I install the software?
Answer: Yes, you can.
Question: Can I change the Edition without re-install the software?
Answer: Yes, you can. Product edition can be changed by running VP Suite Product Edition Manager under the bin folder of VP Suite installation
directory. Change of edition takes effect after the restart of affected products. For more details, please read the section Switching Edition a few pages
later.
Question: The installer file is detected to contain a virus. What can I do?
Answer: Our installer files are all packed by ourselves in a secure environment, and are scanned for virus before releasing to public. If a virus is
detected, please update to the latest virus profile first. After that, we recommend you perform a full system scan, download the installer file from our
official site, and run the installation again. If the problem remain, please contact us ( [email protected] ) or the virus scanner vendor
for assistance.

Installing Visual Paradigm for UML on Windows 2000/NT/2003/XP/Vista P. 42

Installing Visual Paradigm for UML on Mac OSX
Having downloaded the installer of Visual Paradigm Suite (VP Suite), you can execute it, run through the installation to install the suite as well as VP-
UML. If you are using the no-install zip version, you just need to unzip it, launch the suite and install VP-UML. In this chapter, we will go through the
installation of VP-UML both with installer (.dmg) and no-install (.zip).

Using installer (.dmg)

1. Execute the downloaded VP Suite installer file:
bash ./%VP-SUITE-INSTALLER-FILENAME% (e.g. bash ./VP_Suite_Linux_7_0.sh)
The setup wizard appear as below.

VP Suite Welcome screen

2. Click Next to proceed to the License agreement page.

Installing Visual Paradigm for UML on Mac OSX P. 43

The License Agreement

4. Specify the directory for installing VP Suite. Click Next > to proceed to the next page.

The Select Destination Directory page

Installing Visual Paradigm for UML on Mac OSX P. 44

5. In the File Association page, keep Visual Paradigm Project (*.vpp) and Visual Paradigm License File (*.zvpl) checked if you want your
system able to open the project file and the license key file. Click Next > to proceed to the product selection page.

The Select File Associations page

6. Select Visual Paradigm for UML. Click Next > to proceed to the product configuration page.

The product selection page

Installing Visual Paradigm for UML on Mac OSX P. 45

7. VP-UML features vary by product edition. For more details on the features supported by different editions, click the hyperlink Edition
Comparison which brings you to the web page of VP-UML feature comparison for different editions.

Select product edition

8. For users who are going to run VP-UML with floating license, the Pre-Configuration File section enables you to configure the connection(s) to
floating license server by providing a configuration file. The pre configuration is optional. If you do not define the connection here, you will need
to do so when starting VP-UML the first time. Below is the pre-configuration file file content:
?xml version="1.0" encoding="UTF-8"?>
<LicenseServer>
<Server accessCode="" host="" port=""/>
<Server accessCode="" host="" port=""/>
<Server accessCode="" host="" port=""/>
<Server accessCode="" host="" port=""/>
</LicenseServer>
Selecting Enable Product Selector for Product Selection will result in creating a shortcut under the Start Menu for starting the Product Selector,
a utility that lets you realize the installed products with available keys in the floating license server.

Pre-configure floating license server connection for floating license user

9. Select Download Online Help if you want to be able to access the Help contents from within the tool. Select Download PDF/HTML Version if
you wish to read the documentation in this two types of formats. Press Next > to proceed to the license import page.

Download documentation

Installing Visual Paradigm for UML on Mac OSX P. 46

10. A combined license key is a key file which allows unlocking multiple products. To import a combined license key, select Combined License Key
and specify the file path of the key.
A single license key is a key file which allows unlocking only one product. To import a single license key, select Single License Key and specify
the file path of the key.
The import of license key is optional at this point, because you can import it when you run VP-UML. Click Next > to proceed with copying files.

The license key selection page

Installing Visual Paradigm for UML on Mac OSX P. 47

11. Upon finishing, you can select whether to start VP-UML or not. Keep Visual Paradigm for UML selected and click Finish will run VP-UML right
away.

Installation completed screen

Using no install version (.tgz)

Installing Visual Paradigm for UML on Mac OSX P. 48

1. Decompress the downloaded zip file into a directory.
tar -zxf %NO-INSTALL-FILE.tar.gz% -C %DESTINATION-FOLDER%
This should create a subdirectory named “VP Suite 4.0” where 4.0 is the version number.

Extracting No-Install zip file

2. Change directory to “VP Suite 4.0/bin” and execute VP Suite in it.

Launching VP Suite

Installing Visual Paradigm for UML on Mac OSX P. 49

3. Select Visual Paradigm for UML. Click Next > to proceed to the product configuration page.

The product selection page

Select product edition

Download documentation

Installing Visual Paradigm for UML on Mac OSX P. 50

The license key selection page

7. Upon finishing, you can select whether to start VP-UML or not. Keep Visual Paradigm for UML selected and click Finish will run VP-UML right
away.

Installation completed screen

Installing Visual Paradigm for UML on Mac OSX P. 51

Installation FAQ
Question: What is the difference between Installer and "No Install Version"?
Answer: Installer version creates shortcut and registers the menus that make the system more easy to use. We suggest user to use installer version for
a long term usage. The No Install version is good for evaluation and testing the release candidate.
Question: I cannot complete the installation due to a file is missing when copying files. What can I do?
Answer: This can be caused by a corrupted installer file. Please download the installer file again with a different mirror site and run it again to solve the
problem.
Question: I cannot start the application after installing the software. What can I do?
Answer: There are several possible causes of the problem. If you are sure that your installation was performed correctly, contact Visual Paradigm's
support team ( [email protected] ) for assistance. It is recommended to include the vp.log file, which can be found at the bin folder
of VP Suite installation directory, for our team to diagnose in further.
Question: Can I change the Edition without re-install the software?
Answer: Yes, you can. Product edition can be changed by running VP Suite Product Edition Manager under the bin folder of VP Suite installation
directory. Change of edition takes effect after the restart of affected products. For more details, please read the section Switching Edition a few pages
later.
Question: The installer file is detected to contain a virus. What can I do?
Answer: Our installer files are all packed by ourselves in a secure environment, and are scanned for virus before releasing to public. If a virus is
detected, please update to the latest virus profile first. After that, we recommend you perform a full system scan, download the installer file from our
official site, and run the installation again. If the problem remain, please contact us ( [email protected] ) or the virus scanner vendor
for assistance.

Installing Visual Paradigm for UML on Mac OSX P. 52

Installing Visual Paradigm for UML on Linux and Unix
Having downloaded the installer of Visual Paradigm Suite (VP Suite), you can execute it, run through the installation to install the suite as well as VP-
UML. If you are using the no-install zip version, you just need to unzip it, launch the suite and install VP-UML. In this chapter, we will go through the
installation of VP-UML both with installer (.sh) and no-install (.zip).

Using installer (.sh)

1. Execute the downloaded VP Suite installer file:
bash ./%VP-SUITE-INSTALLER-FILENAME% (e.g. bash ./VP_Suite_Linux_7_0.sh)
The setup wizard appear as below.

VP Suite Welcome screen

2. Click Next to proceed to the License agreement page.

Installing Visual Paradigm for UML on Linux P. 53

The License Agreement

4. Specify the directory for installing VP Suite. Click Next > to proceed to the next page.

The Select Destination Directory page

Installing Visual Paradigm for UML on Linux P. 54

5. select a folder for creating symlinks. You may select Don't create symlinks if you do not want to. Click Next to proceed.

The Select Symlinks Directory page

6. Select Visual Paradigm for UML. Click Next > to proceed to the product configuration page.

The product selection page

Installing Visual Paradigm for UML on Linux P. 55

Select product edition

Pre-configure floating license server connection for floating license user

Download documentation

Installing Visual Paradigm for UML on Linux P. 56

The license key selection page

Installing Visual Paradigm for UML on Linux P. 57

11. Upon finishing, you can select whether to start VP-UML or not. Keep Visual Paradigm for UML selected and click Finish will run VP-UML right
away.

Installation completed screen

Using no install version (.tar.gz)

Installing Visual Paradigm for UML on Linux P. 58

Extracting No-Install zip file

2. Change directory to “VP Suite 4.0/bin” and execute VP Suite in it.

Launching VP Suite

Installing Visual Paradigm for UML on Linux P. 59

3. Select Visual Paradigm for UML. Click Next > to proceed to the product configuration page.

The product selection page

Select product edition

Download documentation

Installing Visual Paradigm for UML on Linux P. 60

The license key selection page

Installing Visual Paradigm for UML on Linux P. 61

7. Upon finishing, you can select whether to start VP-UML or not. Keep Visual Paradigm for UML selected and click Finish will run VP-UML right
away.

Installation completed screen

Installation FAQ
Question: What is the difference between Installer and "No Install Version"?
Answer: Installer version creates shortcut and registers the menus that make the system more easy to use. We suggest user to use installer version for
a long term usage. The No Install version is good for evaluation and testing the release candidate.
Question: I cannot complete the installation due to a file is missing when copying files. What can I do?
Answer: This can be caused by a corrupted installer file. Please download the installer file again with a different mirror site and run it again to solve the
problem.
Question: I cannot start the application after installing the software. What can I do?
Answer: There are several possible causes of the problem. If you are sure that your installation was performed correctly, contact Visual Paradigm's
support team ( [email protected] ) for assistance. It is recommended to include the vp.log file, which can be found at the bin folder
of VP Suite installation directory, for our team to diagnose in further.
Question: Can I change the Edition without re-install the software?
Answer: Yes, you can. Product edition can be changed by running VP Suite Product Edition Manager under the bin folder of VP Suite installation
directory. Change of edition takes effect after the restart of affected products. For more details, please read the section Switching Edition a few pages
later.
Question: The installer file is detected to contain a virus. What can I do?
Answer: Our installer files are all packed by ourselves in a secure environment, and are scanned for virus before releasing to public. If a virus is
detected, please update to the latest virus profile first. After that, we recommend you perform a full system scan, download the installer file from our
official site, and run the installation again. If the problem remain, please contact us ( [email protected] ) or the virus scanner vendor
for assistance.

Installing Visual Paradigm for UML on Linux P. 62

Switching edition
Product edition can be changed through the Product Edition Manager without the need of re-installation. When you attempt to switch to another edition,
make sure you have the required key in order to run the product in new edition.
1. Launch the Product Edition Manager under the bin folder of VP Suite installation folder.

Launching Product Edition Manager

2. Select the edition to switch to in the edition manager.

Select product edition

3. Click Next to confirm.

Switching edition P. 63
Uninstalling Visual Paradigm for UML
Uninstalling VP-UML will cause VP-UML to be removed from VP-Suite.
1. Close VP-UML if it is running.
2. Execute uninstall_vpuml under the uninstaller folder of VP Suite installation folder.

Uninstalling VP-UML

Uninstalling Visual Paradigm for UML P. 64

Starting Visual Paradigm for UML
Ways of starting Visual Paradigm for UML
VP-UML can be launched through accessing the Start Menu.

Starting Visual Paradigm for UML via Start Menu

Alternatively, you can start VP-UML by executing the launcher run_vpuml in the launcher folder of VP Suite installation directory. Users in all operating
system can start VP-UML in this way.

Starting Visual Paradigm for UML with launcher

Starting Visual Paradigm for UML P. 65

For Linux users, VP-UML can be started through the shortcuts in desktop, created by the installer.

Starting Visual Paradigm for UML in Linux using the icon in desktop

Starting Visual Paradigm for UML (for floating license client whose host is IP-4-enabled)
If you are a floating license client, and if your host is IP-4 enabled, you need to start VP-UML with a startup script in order to connect to the server.
Here are the steps:
1. Copy VP-UML.bat under the scripts folder of VP Suite installation directory to become Startup.bat
2. Edit Startup.bat
3. Add -Djava.net.preferIPv4Stack=true to the script

Editing the start up script

4. Save
5. From now on, execute Startup.bat to run VP-UML

Select workspace
A workspace is a directory used to store all settings, user interface perspectives and other preferences defined for the working environment (settings
can be configured via Tools > Options... in VP-UML). A workspace also stores all the teamwork login information and local copies of teamwork
projects. In the case of switching computers, you simply need to copy the whole workspace directory to the new computer and specify the new
workspace when starting VP-UML. All your teamwork information and settings will then be transferred to the new computer.
The Workspace Launcher appear when running VP-UML.

Workspace Launcher

Specify the workspace folder.

If you do not want this dialog box to appear again, check Use this as the default and do not ask again. This will cause VP-UML to open the specified
workspace folder automatically the next time.
If you already have an existing workspace, you can import the settings from there by clicking Import Workspace....

Starting Visual Paradigm for UML P. 66

Click OK to continue.

Starting Visual Paradigm for UML P. 67

Interface overview
VP-UML's user interface comprises a menu bar, a toolbar several panes for model navigation, a message pane and a diagram pane that occupy most
spaces.

User Interface of Visual Paradigm for UML

No. Name Description

1 Menu bar The menu bar at the top of the window allows you to select and perform various operations in Visual Paradigm for UML.

2 Toolbar Toolbar, which is below the menu bar, is the extension of menu. All buttons are presented as groups of icons that handily
placed for users.

3 Diagram A place where diagrams are listed, and where you can create and access diagrams base on their types.
navigator

4 Property pane The properties of chosen model/ shapes will be shown on properties pane upon selection.

5 Diagram pane The diagram will be displayed in diagram pane.

6 Message pane Information, notification or warnings will be shown here.

Description of user interface

Interface Overview P. 68
Main menu
The main menu, which is on the top of the window, allows you to select and perform various operations in Visual Paradigm for UML.

File menu

The File menu

The File menu enables you to:

• Create a project
• Create a diagram
• Open project
• Save project
• Save and manage project template.
• Import project data from the following media: VP-UML Project, Rose Project, XMI, XML, Erwin Project, Telelogic Rhapsody Project, Telelogic
System Architect, Rational Model, Rational DNX, MS Word (Use Case Model documentation exported from VP), Excel (Exported from VP),
Visio, NetBeans
• Export project into the following formats: VP-UML Project, XMI, XML, MS Word (for Use Case Model), Excel
• Export images (JPG, PNG, SVG, EMF, PDF)
• Printing
• Set project properties
• Exit

Edit menu

Menu bar P. 69
The Edit menu

The Edit menu enables you to:

• Undo and Redo
• Cut
• Copy
• Duplicate
• Delete
• Change the end model element of connector
• Repeat an action
• Select everything in diagram
• Find a model element/diagram
• Jump to a diagram or an element
• Add or manage bookmarks
• Grouping
• Shapes alignment and distribution

View menu

Menu bar P. 70
The View menu

The View menu enables you to:

• Show/Hide a pane
• Show and manage grid
• Manage Layers
• Change Resource Centric behavior
• Save, open and manage perspective
• Change VP-UML to show in full screen
• Zoom diagram in and out
• Manage nickname
• Manage style
• Show spell check

Tools menu

Menu bar P. 71
The Tools menu

The Tools menu enables you to:

• Generate report
• Publish project
• Perform use case scheduling
• Open various kind of element grid
• Configure stereotypes
• Configure requirements
• Configure programming language
• Customize use case ranks
• Reverse and Forward engineering with Instant Reverse and Instant Generator
• Perform round-trip engineering
• Reverse DDL
• Perform Object Relational Mapping (ORM)
• Perform State Machine Code Generation
• Launch Animacian
• Launch Simulacian
• Perform IDE integration
• Perform Visio integration
• Launch Shape Editor
• Perform Teamwork operations
• Launch DB-VA SQL
• Compare diagrams with Visual Diff

Menu bar P. 72
• Launch License Key Manager
• Configure application options through the Options dialog box

Window menu

The Window menu

The Window menu enables you to:

• Navigate between diagram
• Rearrange diagram windows
• Switch to another diagram
• Show the Start Page
• Close Diagrams

Help menu

The Help menu

The Help menu enables you to:

• Browse the help contents
• Check the instruction of Mouse Gesture
• Visit Visual Paradigm online support
• Repair project
• Customize the user interface
• Check the environment using the About dialog box

Menu bar P. 73
Toolbar
Showing/Hiding toolbar(s)
A toolbar can be shown or hidden. To show a toolbar, right-click on any toolbar, and select the toolbar to show. Similarly, you can uncheck a toolbar to
hide it.

Show or hide Standard toolbar

Repositioning toolbars
A toolbar can be repositioned by pressing on the handle of toolbar, which appears on the left hand side of a toolbar, and dragging to your target
position.

Drag toolbar with the handle of toolbar

Locking toolbar
To freeze toolbars' position and make the toolbars not movable, right click on any toolbar and uncheck Rearrangable from the pop-up menu.

Uncheck the Rearrangable option

Standard toolbar

The Standard toolbar

Icon Name Description

New Project Create a project.

Open Project Open a project.

Save Project Save the changes made in the opening project.

Print... Select and print diagram(s) after configure the advanced printing set up.

Print Active Diagram... Select and print diagram(s) after configure the advanced printing set up.

Quick Print... Print the active diagram after configure the advanced printing set up.

Cut Cut selected diagram elements.

Copy within VP-UML Copy selected diagram elements ready to be used within VP-UML.

Copy to Clipboard as Image (JPG) Copy selected diagram elements as JPG image.

Copy to Clipboard as Image (EMF) Copy selected diagram elements as EMF image.

Toolbar P. 74
Copy to Clipboard as XML Copy selected diagram elements as XML data.

Paste View Paste copied diagram elements as view of original model element.

Paste Model Element Paste copied diagram elements as a new model element.

Undo Roll back undesired changes.

Redo Rerun an undone task.

UML Modeling Select and create a diagram type under UML Modeling, including: Use Case Diagram, Use
Case Grid, Actor Grid, Class Diagram, Composite Structure Diagram, Object Diagram,
Sequence Diagram, Communication Diagram, Activity Diagram, State Machine Diagram,
Timing Diagram, Interaction Overview Diagram, Component Diagram, Deployment Diagram
and Package Diagram.

Business Process Modeling Select and create a diagram type under Business Process Modeling, including: Business
Process Diagram, Conversation Diagram, Data Flow Diagram, Event-driven Process Chain
Diagram, Process Map Diagram, Organization Diagram and ArchiMate Diagram.

Database Modeling Select and create a diagram type under Database Modeling, including: Entity Relationship
Diagram and ORM Diagram.

Requirement Modeling Select and create a diagram type under Requirement Modeling, including: Textual Analysis,
Requirement Diagram, Basic Diagram, Open Requirements Grid, Open Glossary Grid and CRC
Card Diagram.

Impact Analysis Select and create Matrix Diagram.

Diagrams Select and create other diagrams, including: EJB Diagram, Overview Diagram, User Interface
and Mind Mapping Diagram.

Format Click it to open Formats dialog box. You can format font name, font style, font size, font color,
line style, shape's foreground and background color and style, etc.

Copier Copy the selected diagram element's format and apply on another shape.

Modeling Click it to perform the following: Visual Diff, Animacian, Simulacian, Nicknames, Apply Design
Pattern and Transit to New Diagram.
Visual Diff: Launch Visual Diff for comparing diagrams.
Animacian: Launch Animacian for animating the active diagram.
Simulacian: Launch Simulacian for simulating the execution of business process.
Nicknames: Manage and select the nickname to be applied on the working project.
Apply Design Pattern: Apply the defined design pattern to the target diagram.
Transit to New Diagram: Transit the current diagram to a new diagram.

Generate HTML Report Open the Generate HTML dialog box to generate HTML report.

Generate PDF Report Open the Generate PDF dialog box to generate PDF report.

Generate Word Report Open the Generate Word dialog box to generate Word report.

Report Writer Open Report Writer where you can create and edit your report(s).

Project Publisher Publish project to Web pages through Project Publisher.

Open Teamwork Client Open the Teamwork Client dialog box.

Commit Commit changes to server.

Update Update changes from server.

Tag Create a tag.

Toolbar P. 75
Branch Create a branch.

Merge Merge changes between trunk and branches.

Switch Switch between trunk, branches and tags.

Revert Click it to undo all non-committed changes in working project.

Instant Reverse Reverse Engineering Class Diagram from many kinds of source code, including: Instant
Reverse, Java, C++ Source, .Net dll or exe files, CORBA IDL Source, Ada 9x Source, XML,
XML Schema, JDBC, Hibernate, PHP 5.0 Source, Python Source, Objective-C and Java to
Sequence Diagram.

Instant Generator Generate source code from the opening project, including: Instant Generator, Java, C#,
VB.NET, PHP, ODL, ActionScript, IDL, C++, Delphi, Perl, XML Schema, Python, Objective-C,
Objective-C 2.0, Ada95 and Ruby.

Reverse DDL... Reverse data definition language file and form ERD.

Generate Code... Select Code > Java Round-trip > Generate Code....
Generate Java from class diagram for the whole project.

Reverse Code... Select Code > Java Round-trip > Reverse Code....
Reverse Java back into the opening project.

Generate Code... Select Code > C++ Round-trip > Generate Code....
Generate C++ from class diagram for the whole project.

Reverse Code... Select Code > C++ Round-trip > Reverse Code....
Reverse C++ back into the opening project.

Generate Code... Select Code > State Machine Code > Generate Code...
Generate state machine code from class diagram and state machine diagram.

Reverse Code... Select Code > State Machine Code > Reverse Code....
Reverse state machine code back into the opening project.

Interoperability Import: VP-UML Project...: Import a VP-UML project into the opening project.
Rose Project...: Import diagrams and model elements from a Rose model.
XMI...: Import diagrams and model elements from XMI.
XML...: Import diagrams and model elements from XML.
ERwin Project (XML)...: Import diagrams and model elements from ERwin Project.
Telelogic Rhapsody Project...: Import diagram and model elements from Telelogic Rhapsody
Project.
Telelogic System Architect...: Import diagram and model elements from Telelogic System
Architect.
Rational Model...: Import diagram and model elements from Rational Model.
Rational DNX...: Import diagram and model elements from Rational DNX.
MS Word to Use Case Model...: Import Use Case Report (MS Word) back into the opening
project.
PowerDesigner DataArchitect...: Import diagram and model elements from Power Designer
Data Model.
Visual UML...: Import diagram and model elements from Visual UML XML file.
Excel...: Import Excel file back into the working project.
Visio...: Import Visio diagrams into VP-UML.
NetBeans UML Project...: Import NetBeans UML diagrams into VP-UML.
Linked Project...: Import dependent projects into the opening project.
Export: VP-UML Project: Export the open project into a VP-UML project file.
XMI: Export XMI from the opening project.
XML: Export XML from the opening project.
Active Diagram as Image: Export active diagram as image file.
Diagrams as Image: Export any diagram(s) as image file(s).
Selection as Image: Export selection on active diagram as image file.
Use Case Model to MS Word: Export Use Case Report (MS Word) from Use Case diagrams
and use case models.
Active Diagram to Excel: Export active diagram into Excel report.
Excel: Export any diagram(s) into Excel report(s).

Wizards... Open the ORM Wizards.

Toolbar P. 76
Database Configuration... Open the Database Configuration dialog box to configure database connections.

Reverse Database... Reverse engineering from database.

Reverse Java Classes... Reverse engineering from Java Class.

Reverse Hibernate... Reverse engineering from Hibernate mapping file.

Reverse Enterprise Object Framework... Reverse engineering from Enterprise Object Framework.

Synchronize to Class Diagram Synchronize from Entity Relationship Diagram to Class Diagram.

Synchronize to Entity Relationship Diagram Synchronize from Class Diagram to Entity Relationship Diagram.

Ignore Entities when Synchronizing... Open Ignore Entities when Synchronizing dialog box to select entities to ignore during
synchronizing.

Ignore Classes when Synchronizing... Open Ignore Class when Synchronizing dialog box to select classes to ignore during
synchronizing.

Generate Database... Open the Database Code Generation dialog box to generate database.

Generate Code... Open the Database Code Generation dialog box to generate code.

Toolbar P. 77
Dockable user interface
VP-UML adapts a Dockable User Interface which allows you to drag UI components around to customize your favorite working environment. You can
save the environment as a perspective which you can reopen later. It allows you to use different perspectives for different purposes.

Using the dockable user interface

The Dockable User Interface is composed of a number of windows called dockable frames. A dockable frame may be standalone (floating) or docked
into another container (split pane/tab pane).
You can press on the title bar of a dockable frame or press on a tab to drag it to anywhere you like.

A frame can be dragged out and dock to elsewhere

You will notice a gray outline appears while you are dragging a frame/tab. This outline tells you where the dockable frame/tab will be docked to.

Docking a dockable frame to elsewhere

By dragging out a dockable frame/tab, and move the cursor to certain position, the frame/tab will be repositioned accordingly.
If you drag the dockable frame/tab and release it over another container, the gray outline will change its shape to fit the dockable area of the container.
If you release the frame/tab, it will be docked into the underlying container and also removed from its original container.

A frame docked to the right of application screen

Dockable User Interface P. 78

You also can drag a frame/tab out to make it a floating window.

A frame is floating on the application screen

You can also drag a frame/tab and dock it into another tabbed pane. You will see the outline changed to a tab shape if you drag over a tab pane.

A frame docked to another frame

Dockable User Interface P. 79

Auto-hiding a dockable frame
A dockable frame can be set to "auto hide", meaning it will automatically disappear when not active. To set a dockable frame to "auto hide", click on the
Toggle auto-hide button on the upper right corner of the frame (the button with a pin as the icon, see figure below)

Diagram Navigator is hidden

Dockable User Interface P. 80

Diagram navigator
Diagram navigator is the location where diagrams are listed. You can create your own diagrams easily as they are listed by categories, such as UML
Diagrams, Requirements Capturing, Database Modeling, Business Process Modeling and Others. With diagram navigator, you can create, open and
delete diagrams.

The diagram navigator

The toolbar
Name Icon Description

New diagram Create a new diagram through the New Diagram dialog box.

Collapse Collapse the selected diagram.

Expand Expand the selected diagram.

Show Diagram View Overview the diagram elements in the selected diagram.

Sort Diagram Element By Sort diagram elements by their name in alphabetical order.
Name

Sort Diagram Element By Sort diagram elements by their type, disregard their name.
Type

Move Selected Diagram Move the selected diagram down or up.

This option only works within the same diagram type when there are multiple diagrams.

Refresh Update the content of diagram tree.

The description of icons on diagram navigator

Pop-up menu
Pop-up menu of diagram navigator

Diagram navigator P. 81
The pop-up menu of diagram navigator

Menu Title Description

Filter Model Element... Open the Model Element Filter dialog box to filter the diagram elements to appear in the diagram navigator.

Show Carriage Return Display line breaks of multi-lined diagram name as carriage return character.
Character

Sorting Select the way to sort diagram elements in diagram navigator.

Group by Category Categorize diagrams base on their types.

Teamwork Perform teamwork activities.

Manage Dependent Project... Add or remove dependent project.

Refresh Refresh diagram navigator content.

Collapse All Collapse all tree nodes.

Expand All Expand all tree nodes.

Show Diagram View Make the Diagram Navigator to expand all diagram types' nodes to show the diagrams nodes, but do not display
any diagram element nodes.

The description of pop-up menu of diagram navigator

Pop-up menu of project node

The pop-up menu of project node in diagram navigator

Menu Title Description

No View Model Elements... It lists the model element(s) that either has not been visualized (no view) or has no master view.

Diagram navigator P. 82
Rename... Rename the project.

Nicknames Configure or switch to another nickname.

New Diagram... Create a diagram.

Configure Programming Change to another programming language or configure the type mapping for a language.
Language...

Group by Category Categorize diagrams base on their types.

Sorting Select the way to sort diagram elements in diagram explorer.

Teamwork Perform teamwork activities.

Refresh Refresh diagram navigator.

Collapse All Collapse the project node.

Expand All Expand the project node.

The description of pop-up menu of project node

Pop-up menu of diagram category

The pop-up menu of diagram category in diagram navigator

Menu Title Description

New Diagram... Create a diagram.

Collapse Collapse the selected diagram category node.

Expand Expand the selected diagram category node.

Show Diagram Make the Diagram Navigator to expand all diagram types' nodes to show the diagrams nodes, but do not display any diagram
View element nodes.

The description of pop-up menu of diagram category

Pop-up menu of diagram type

The pop-up menu of diagram type in diagram navigator

Diagram navigator P. 83
Menu Title Description

New [diagram type] Create a new diagram in the selected type.

New Diagram... Create a new diagram with popup dialog box.

Sort [diagram type] by Sort the diagram nodes of the selected type node in specific way.
name

Collapse Collapse the selected diagram type node.

Expand Expand the selected diagram type node.

The description of pop-up menu of diagram type

Pop-up menu of diagram

The pop-up menu of diagram in diagram navigator

Menu Title Description

Open [diagram name] Specification... Open the specification of the selected diagram.

Open [diagram name] Open the selected diagram if closed or inactive.

Close [diagram name] Close the selected diagram if opened.

Use Case Scheduling... Open Use Case Scheduling dialog box.

Rename... Rename the selected diagram.

Lock Set a password to lock the diagram. On the other hand, you can type the password to unlock the diagram.

Delete Delete the selected diagram.

Edit Nickname... A pop-up a dialog box for defining the nickname of model elements will appear in the diagram. This option is
available only after you have configured a nickname.

Diagram navigator P. 84
Create Matrix Diagram... Create a Matrix Diagram from [diagram name].

Analysis An analysis diagram will be formed to analyze the selected diagram with others and the result will be seen.
Relationship like diagram transition can also be found.

Export VP-UML Project... Export the selected diagram as VP-UML project.

Export XML... Export the selected diagram as XML.

Export Selected as Image... Export the selected diagram as image Excel.

Export as Image... Export diagram(s) as image via the Diagram Exporter.

Export to Excel... Export the selected diagram as image Excel.

Print... Print the selected diagram.

Move Up Move the selected diagram node upwards.

Move Down Move the selected diagram node downwards.

Collapse Collapse the selected diagram node.

Expand Expand the selected diagram node.

Sorting Change the way of sorting diagram elements.

The description of pop-up menu of diagram

Closing and opening the diagram navigator

Diagram navigator is opened by default. To close it, press the X button at the top right corner. On the other hand, it can be opened by selecting View >
Panes > Diagram Navigator from the main menu.

Creating a diagram
Approach 1 – Direct creation
If you want to create a diagram in a quick way and don't need to supply the documentation of diagram (for time-saving), use this approach. To create a
diagram:
1. Right click on the diagram type that you want to create.
2. Select New diagram type from the pop-up menu. Here, diagram type means the type of diagram you want to create.

NOTE: You can immediately enter the diagram name at the top left corner of diagram

Approach 2 – Through the New Diagram dialog box

This approach let you create a diagram and enter the name and documentation simultaneously. To create a diagram:
1. Right click on the diagram type that you want to create.
2. Select New Diagram from the pop-up menu.

Diagram navigator P. 85
In the New Diagram dialog box, you can enter the name and documentation of diagram, and click OK button to proceed.

New Diagram dialog box

Opening a diagram
Double click in the diagram you want to view in the diagram tab.

Sorting diagram elements

In diagram navigator, diagram elements are listed under diagram nodes. You can sort diagram elements by their names, or by their types (e.g. use
case, package, etc.)
To sort by name, click Sort Diagram Element by Name button. The elements will be listed by name, in alphabetical order.

Click Sort Diagram Element by Name

To sort by type, click Sort Diagram Element by Type button. As a result, the elements will be listed by type.

NOTE: The sort function applies to the entire diagram tree instead of the selected node.

Reordering diagrams
Select the diagram(s) you want to reorder. If there are multiple diagrams you want to select, just click one while pressing Ctrl button and make the
other selection.
Click Move Selected Diagram Up button to move the selection upwards, or Move Selected Diagram Down button to move the selection downwards.

Filtering model elements

You can choose which model elements you want to be displayed or not on the diagram tree.
1. Right click on the diagram navigator's background and select Filter Model Element. Model Element Filtering Dialog will then be pop-up.

Diagram navigator P. 86
2. Select the types of model element(s) you want to be displayed by checking to the type. Otherwise, uncheck the one you don't want to be
displayed.

Model Element Filtering dialog box

NOTE: You can check Display model element types in-use to list only types of model elements used in project. The text box Filter enables you
to filter model element type base on the type name (e.g. enter class to list only class)

Showing/hiding carriage return character

If it is the case that the name of the diagram and diagram elements is in multi-line, the character ¶ will be revealed.
When Show Carriage Return Character is selected, line break will be shown.

To show carriage return character

When deselected, the character ¶ is hidden.

If you want to hide it, uncheck Show Carriage Return Character and the character will automatically be unshown.

Grouping or ungrouping by category

As it is said before, default groups are automatically arranged by category.
If you want to ungroup diagram:
1. Right click on the diagram navigator's background.

Diagram navigator P. 87
2. Uncheck Show Group Category if there is a tick in the box, and then all diagram types will be ungrouped.

Ungrouped diagrams

Connecting to server for team collaboration

VP-UML's team collaboration support enables your team members work together on projects. To connect to server and perform related activities:
1. Right click on the diagram background.
2. Select Teamwork and the action you want to perform (e.g. commit and update, etc) from the pop-up menu.

Perform teamwork

Displaying only diagram nodes but not diagram elements

If you only want the diagram nodes to be shown but not the diagram elements under them, just click on Show Diagram View button.

NOTE: This option applies to all diagram nodes, but not just the selected one.

Diagram navigator P. 88
Model Explorer
It would be much more efficient to make use of Model Explorer for your middle to large scale project which has considerable numbers of diagrams and
model elements, rather than using Diagram Navigator.

The Model Explorer

The toolbar
Name Icon Description

New Model Element Create a new model element.

Collapse Collapse the selected model element.

Expand Expand the selected model element.

No Sorting Arrange model elements without grouping.

Sort By Name Sort model elements by their names in alphabetical order.

Sort By Type Sort model elements by their types.

Move Selected Model Move the selected model elements down or up.
Element This option only works within the same model element type when there are multiple model elements.

Refresh Update the content of model explorer.

The description of icons on Model Explorer

Popup menu

Model explorer P. 89
Popup menu of model explorer
The Model Explorer lists all the model elements in the project.

The popup menu of Model Explorer

Menu Title Description

Model Create a Model.

Model Element... Create a new Model Element or select a default model in Model Explorer.

Filter Model Element... Open the Model Element Filter dialog box to filter the diagram elements to appear in the Diagram Navigator.

Show Relationships Show also Relationship model elements in Model Explorer (default hidden).

Show Sub Diagrams Show Sub Diagrams in Model Explorer so that user can browse and open Sub Diagrams in Model Explorer.

Show Data Types Show Data Types in Model Explorer (default hidden).

Show Carriage Return Display line breaks of multi-lined diagram name as carriage return character.
Character

Sorting Select the way to sort model elements in Model Explorer.

Teamwork Perform teamwork activities.

Manage Dependent Project... Add or remove dependent project.

Refresh Refresh Model Explorer content.

Collapse All Collapse all tree nodes.

Expand All Expand all tree nodes.

Popup menu of project

Model explorer P. 90
The popup menu of project node in Model Explorer

Menu Title Description

No View Model Elements... It lists the model element(s) that either has not been visualized (no view) or has no master view.

Rename... Rename the project.

Nicknames Configure or switch to another nickname.

Create Profile Create a profile.

Model Create a Model.

Model Element Create a new Model Element in Model Explorer without the need of creating through diagramming.

Configure Programming Change to another programming language or configure the type mapping for a language.
Language...

Sorting Select the way to sort model elements in Model Explorer.

Show Relationships Show also Relationship model elements in Model Explorer (default hidden).

Show Sub Diagrams Show Sub Diagrams in Model Explorer so that user can browse and open Sub Diagrams in Model Explorer.

Show Data Types Show Data Types in Model Explorer (default hidden).

Teamwork Perform teamwork activities.

Manage Dependent Project... Add or remove dependent project.

Refresh Refresh Model Explorer.

Collapse All Collapse the project node.

Expand All Expand the project node.

Closing and opening the model explorer

Model Explorer is opened by default. To close it, press the X button at the top right corner. On the other hand, it can be opened by selecting View >
Panes > Model Explorer from the main menu.

Creating a model
A model is a package like UML element that can store model elements and diagrams. Users are recommended to structure project by using model in
order to maintain a clear structure for accessing project data and improve the application performance.

Model explorer P. 91
Right click on the root node in Model Explorer and select Model from the popup menu. You can either create a custom model by selecting New
Model..., or create a pre-defined model by selecting it in the list.

Select New Model in pop-up menu

Creating a model element

A model element is created when you create a shape on a diagram. If you want to create a model element without visualizing it, you can create it
through the Model Explorer. To create a model element:
1. Right click on the root node.
2. Select Model Element> New Model Element..., or select a pre-defined model element from the pop-up menu.

Select New Model Element from the pop-up menu

Sorting model elements

In model explorer, model elements are listed under root nodes. You can sort model elements by their names, by their types (e.g. use case, package,
etc.) or with no sorting.

Model explorer P. 92
To sort by name, click Sort by Name button. The elements will be listed by name, in alphabetical order.

Sort model elements by name

To sort by type, click Sort by Type button. As a result, the elements will be listed by type. To arrange model elements without sorting, click No sorting.

Reordering model elements

Select the model element(s) you want to reorder. If there are multiple model elements you want to select, just click one while pressing Ctrl button and
make the other selections.
Click Move Selected Model Element Up button to move the selection upwards, or Move Selected Model Element Down button to move the
selection downwards.

NOTE: This option only works within the same model element type when there are multiple model elements.

Filtering model elements

You can choose which model elements you want to be displayed or not on the model explorer.
Right click on the model explorer's background and select Filter Model Element. In Model Element Filtering Dialog, select the types of model
element(s) you want to be displayed by checking the type. Otherwise, uncheck the one you don't want to be displayed.

Model Element Filtering Dialog

Model explorer P. 93
NOTE: Instead of displaying all types of model elements, checking Display model element types in-use to display the types of model elements
used in the project.

Showing/hiding carriage return character

If it is the case that the name of model elements is in multi-line, the character ¶ will be revealed.
When Show Carriage Return Character is selected, line break will be shown.

Show Carriage Return Character is selected

When off, the character ¶ is hidden.

If you want to hide it, uncheck Show Carriage Return Character and the character will automatically be unshown.

Connecting to server for team collaboration

VP-UML's team collaboration support enables your team members work together on projects. To connect to server and perform related activities:
1. Right click on the model explorer's background.
2. Select Teamwork> Open Teamwork Client... from the pop-up menu.

Perform teamwork

Model explorer P. 94
Class Repository
Class repository is a pane where classes and container that contain classes, such as packages or subsystems, are listed. Further to accessing
classes, you can also form class diagram by dragging classes from class repository to class diagram.

The Class Repository

The toolbar
Name Icon Description

New Model To create a new model element.

Element

Collapse To collapse the selected model element.

Expand To expand the selected model element.

Reverse Code... To reverse a code as class model for the whole project.

Instant Reverse... To reverse different types of source into UML class models.

Refresh To update the content of Class Repository

The description of icons on Class Repository

Pop-up menu
Pop-up menu of class repository

The pop-up menu of Class Repository

Menu Title Description

Model Create a Model.

Model Element... Create a new Model Element in Class Repository without the need of creating through diagramming.

Show Carriage Return Display line breaks of multi-lined diagram name as carriage return character.
Character

Class repository P. 95
Teamwork Perform teamwork activities.

Manage Dependent Project... Add or remove dependent project.

Refresh Refresh Class Repository content.

Collapse All Collapse all tree nodes.

Expand All Expand all tree nodes.

Popup menu of project

The pop-up menu of project node in Class Repository

Menu Title Description

No View Model Elements... It lists the model element(s) that either has not been visualized (no view) or has no master view.

Rename... Rename the project.

Nicknames Configure or switch to another nickname.

Model Create a Model.

Model Element Create a new Model Element in Class Repository without the need of creating through diagramming.

Configure Programming Change to another programming language or configure the type mapping for a language.
Language...

Teamwork Perform teamwork activities.

Manage Dependent Project... Add or remove dependent project.

Refresh Refresh Class Repository.

Collapse All Collapse the project node.

Expand All Expand the project node.

Closing and opening the Class Repository

Class Repository is opened by default. To close it, press the X button at the top right corner. On the other hand, it can be opened by selecting View >
Panes > Class Repository from the main menu.

Class repository P. 96
Right click on the project root node in Class Repository and select Model > New Model... from the pop-up menu.

Select New Model from the pop-up menu

Creating a model element

A model element is created when you create a shape on a diagram. If you want to create a model element without visualizing it, you can create it
through the Class Repository. To create a model element:
1. Right click on the project root node.
2. Select Model Element> New Model Element..., or select a pre-defined model element from the pop-up menu to create a new model.

Select New Model Element from the pop-up menu

Showing/hiding carriage return character

If it is the case that the name of model elements is in multi-line, the character ¶ will be revealed.
When Show Carriage Return Character is selected, line break will be shown.

Show Carriage Return Character is revealed

When off, the character ¶ is hidden.

If you want to hide it, uncheck Show Carriage Return Character and the character will automatically be unshown.

Connecting to server for team collaboration

VP-UML's team collaboration support enables your team members work together on projects. To connect to server and perform related activities:

Class repository P. 97
1. Right click on the Class Repository's background.
2. Select Teamwork> Open Teamwork Client... from the pop-up menu.

Perform teamwork

Class repository P. 98
Logical view
The logical view provides a hierarchical view of a project's structure. With the logical view, users can create and customize the diagrams in their project
with meaningful categorization by adding domain specific view(s).
In addition, users can customize a default logical view for their preference, rather than re-creating a new logical view for every new project. The logical
view can be exported to xml files which can be used in other projects or distributed among the development team. Different views, thereby, can be
merged automatically through the teamwork server.

The Logical View

The toolbar
Name Icon Description

Collapse To collapse the selected diagram.

Expand To expand the selected diagram.

Refresh To update the content of logical view.

Set Logical View Structure as Default To set default structure for logical view in all projects.

The description of icons on Logical view

Pop-up menu
Pop-up menu of logical view

The pop-up menu of Logical View

Menu Title Description

Show Carriage Return Display line breaks of multi-lined diagram name as carriage return character.
Character

Teamwork Perform teamwork activities.

Manage Dependent Project... Add or remove dependent project.

Refresh Refresh Logical View content.

Logical view P. 99
Collapse All Collapse all tree nodes.

Expand All Expand all tree nodes.

Pop-up menu of project

The pop-up menu of project node in Logical View

Menu Title Description

Rename... Rename the project.

Add View Add a view under project.

New Diagram Create a diagram under root view.

Add Existing Diagram... Add an existing diagram under root view.

Import View from XML Import logical view configuration file.

Export View to XML Export logical view as configuration file.

Set Logical View Structure as Default Set the current view structure as default so that another project that will be created under the same
workspace will share the same structure.

Sort Child by Name Sort the views by name.

Teamwork Perform teamwork activities.

Collapse All Collapse the project node.

Expand All Expand the project node.

Pop-up menu of view

The pop-up menu of view in Logical View

Menu Title Description

Logical view P. 100

Add View Add a child view under the selected view.

New Diagram Create a diagram under the selected view.

Add Existing Diagram... Add an existing diagram under the selected view.

Sort Child by Name Sort the views/diagrams by name.

Collapse Collapse the selected view node.

Expand Expand the selected view node.

Rename... Rename the selected view.

Delete Delete the selected view.

Closing and opening the Logical view

Logical view is opened by default. To close it, press the X button at the top right corner. On the other hand, it can be opened by selecting View >
Panes > Logical View from the main menu.

Creating a new view node

Right-click a root node on Logical View and select Add View from the pop-up menu.

Click Add View from the pop-up menu

You can enter the name for the new view node in the Input dialog box and then click OK button to confirm editing and close the dialog box.
A new view node is, therefore, created under the chosen node.

Created new view node

Logical view P. 101

Adding diagram to view
After you create a few diagrams, right-click on a view node and select Add Existing Diagram... from the pop-up menu.

Select Add Existing Diagram... from the pop-up menu

In Select Diagrams Dialog, check the diagrams you would like to insert in the view node.

Check diagrams in Select Diagrams Dialog

Click OK button to confirm the selection.

Creating a new diagram

Right click the newly created view node, select New Diagram from the pop-up menu and then select New Diagram... or a pre-defined diagram.

Select New Diagram... from the pop-up menu

A new diagram is, therefore, created under the view node.

Logical view P. 102

Opening a diagram
Double click on the diagram you want to view in the logical view.

Setting Default View Structure

VP-UML provides a feature where you can set the current logical view structure as default, therefore, you may save your time and do not have to re-
create the structure every time you create a new project.
Either click Set Logical View Structure as Default button on the top of logical view or right click a root node to select Set Logical View Structure as
Default.

Click Set Logical View

Structure as Default button

In the pop-up Message dialog box, click OK button. The logical view structure in the new project will then follow the default style you have just
customized.

Sorting diagram by name

In logical view, diagram are listed under diagram nodes by default. You can sort child diagrams by their names as well.
To sort by name, right click on view node and select Sort Child by Name from the pop-up menu. The child diagrams will be listed by name, in
alphabetical order.

Click Sort Child by Name

NOTE: The sort function applies to the entire logical view instead of the selected node.

Showing/hiding carriage return character

If it is the case that the name of the diagram is in multi-line, the character ¶ will be revealed.

Logical view P. 103

When Show Carriage Return Character is selected, line break will be shown.

To show carriage return character

When off, the character ¶ is hidden.

If you want to hide it, uncheck Show Carriage Return Character and the character will automatically be unshown.

Exporting View Structure to XML

VP-UML allows you to export the current Logical View Structure as an XML file and to re-use it again on other projects.
Right click the root node and select Export View to XML from the pop-up menu.

Click Export View to XML from the pop-up menu

Logical view P. 104

Find a location for exporting the project and enter its file name in Save dialog box. At last, click the Save.

Enter the file name in Save dialog box

Importing View Structure from XML

VP-UML also allows you to import the existing xml file in your new project.
Right click on the root node and select Import View to XML from the pop-up menu.
In Open dialog box, browse and select the xml file to be imported. You can choose one out of two following choices provided for importing a logical
view structure:
1. Append to existing structure: the imported structure will be added to the current structure without deleting the old one.
2. Replace existing structure: the new imported structure will replace the current structure. Therefore, the current structure will be removed.

Select export.xml in Open dialog box

Connecting to server for team collaboration

VP-UML's team collaboration support enables your team members work together on projects. To connect to server and perform related activities:
1. Right click on the logical view's background.

Logical view P. 105

2. Select Teamwork and the action you want to perform from the pop-up menu.

Performce teamwork

Logical view P. 106

ORM pane
ORM pane consists of two views, class view and database view. They two serve two distinct purposes. The class view act as a media to convert
domain source code into UML persistable class model, while the database view act as a media to convert database schema into entity models.

An ORM pane (Database view)

An ORM pane (Class view)

The toolbar
Name Icon Description

Database View / Class Switch between views.

View
Class view - act as a media to convert domain source code into UML persistable class model.
Database view - act as a media to convert database schema into entity models.

Classpath Configuration Only available in class view, classpath configuration enables you to add or remove directories where
Java class files are stored. Classes in class paths will be listed in the pane.

Refresh By updating the class paths or database configuration, you can refresh the pane to show the updated
class or entity listing.

Database Configuration Only available in entity view, database configuration enables you to set the connection to database, so
that ORM pane can connect to that database to read the schema to form the entity list.

The description of icons on ORM pane

Database view
Database view lists tables from a chosen database. The tables are listed in a tree form. You can browse for its columns, and drag entities from tree to
diagram, to form an entity relationship diagram.

ORM pane P. 107

In order to list tables, you need to configure the database connection first. Click to open the Database Configuration dialog box. Then, specify the
database connection for the database you want to have its tables list in ORM pane.

Configuring database connection

By confirming the configuration, tables, if any, will be listed in the ORM pane. You may form an entity relationship diagrams by dragging entities from
the pane and releasing in diagram.

Entity relationship diagram is formed from entities in ORM pane

Class view
Class view lists classes from chosen classpaths. The main function is to let you convert source code of domain classes into class models that can be
used to synchronize an ERD, to generate database in further. In other words, with the class view you can convert domain class (code) into database
tables.

ORM pane P. 108

In order to list classes, you need to configure add classpaths first. Click to open the Classpath Configuration dialog box. Then, add the classpaths
of classes you want to list in ORM pane.

Adding classpaths

By confirming the classpath selection, classes, if any, will be listed in the ORM pane. You may form a class diagram by dragging classes from the
pane and releasing in diagram. You can see the classes created will be extending the ORM Persistable stereotype. This means that they can be
synchronized to an entity relationship diagram.

Class diagram is formed from classes in ORM pane

ORM pane P. 109

Property pane
Property pane is the location where the properties of a diagram, model element or shape are listed. With Property pane, you can view and edit
properties directly.

The Property pane

The toolbar
Name Icon Description

Categorized To sort all properties by their category.

View

Alphabetical To sort all properties in ascending order base on their names.

View

Collapse To collapse all properties of each subitem.

Expand To expand all properties of each subitem.

The description of icons on Property pane

Closing and opening the Property pane

Property pane is opened by default. To close it, press the X button at the top right corner. On the other hand, it can be opened by selecting View >
Panes > Property from the main menu.

Viewing the properties

Click a shape that you would like to view its properties directly when the shape is shown on diagram pane. There are not only the properties of shapes,
but also the properties of diagrams in Diagram Navigator and the properties of model elements in Model Explorer that can be viewed in property
pane.
Select a diagram on Diagram Navigator to view the properties of diagram or select a model element in Model Explorer to view the properties of
model element.

Property pane P. 110

Viewing the properties in shortcut
When a diagram, model element or shape is selected, its properties are shown on property pane. Meanwhile, you are allowed to view other properties,
which are in the same diagram, in shortcut by selecting the diagram, model element and shape from dropdown menu at the top of the property pane.

Select Customer -
Pool in dropdown menu

Sorting the properties

In Property pane, the properties of a diagram, model element and shape are listed. You can sort the properties by their category, or in ascending order.
To sort by the name of properties, click Alphabetical View button. All properties will be listed in ascending order base on their names.

Click Alphabetical Vie w

To sort by category, click Categorized View button. As a result, all properties will be listed by category.

Property pane P. 111

Diagram overview
Diagram overview is a pane where users can view and zoom in an active diagram directly and shortly.

The Diagram overvi ew

Closing and opening the diagram overview

Diagram overview is opened by default. To close it, press the X button at the top right corner. On the other hand, it can be opened by selecting View >
Panes > Diagram Overview from the main menu.

Viewing an active diagram

An active diagram can be viewed in diagram overview automatically. As the diagram is shown on the diagram pane, it can be viewed in diagram
overview.

An active diagram is shown on Diagram Overview

Having a quick view on a particular part of diagram

There is much truth in saying that viewing a large diagram is such an annoying task, especially a particular part of this large diagram is needed to
focus on. In fact, a particular part of diagram can be navigated by moving the purple rectangle which represents the visible area of diagram in diagram
overview.

Diagram overview P. 112

1. Press on the purple rectangle and drag it to the preferred part of diagram you would like to view.

Drag to the preferred part of diagram

2. As a result, the part of diagram will be subsequently shown on the diagram pane.

The particular part of diagram is viewed on diagram pane

Diagram overview P. 113

Zooming in a particular part of diagram
Drag the diagonal of purple rectangle to zoom in a particular part of diagram. The smaller you drag the purple rectangle, the more the part of diagram
will be magnified.

Drag the diagonal of purple rectangle

On the contrary, the larger you drag the purple rectangle, the more the part of diagram will be dwindled.

Diagram overview P. 114

Documentation pane
Documentation pane enables you to document project data such as model elements, shapes or diagrams either in written or verbal form. For written
content, it can be a plain text or HTML text with formattings like bold, italic, table, etc.

The Documentation pane

The toolbar
Name Icon Description

HTML It enables you to read and edit 3 different types of content. The 3 types of content include HTML, HTML Source
and Plain Text.
HTML: Read and edit the original content.
HTML Source: Read and edit the HTML source of content.
Plain Text: Read and edit content without formats.

Bold Set the highlighted text to bold.

Italic Set the highlighted text to italic.

Underline Underline the highlighted text.

Left Justify Set the alignment of highlighted text to left.

Center Justify Set the alignment of highlighted text to center.

Right Justify Set the alignment of highlighted text to right.

Ordered list Add a numbered list.

Un-ordered list Add a list with bullet points.

Font Select the font family of highlighted text.

Font size Select the size of highlighted text.

Font color Select the color of highlighted text.

Table Add a table. A few formats of insertion for rows and columns can be selected, including: Insert Row Above,
Insert Row Below, Insert Column on Left and Insert Column on Right.
Insert Row Above: Insert a row above the row you selected.
Insert Row Below: Insert a row below the row you selected.
Insert Column on Left: Insert a column on the left of the column you selected.
Insert Column on Right: Insert a column on the right of the column you selected.

Background color Select the background color of highlighted text.

Clear formats Clear formats of whole editor to convert the content to plain text.

Link Add a hyperlink.

Documentation pane P. 115

Image Add an image.

Save as Save the documentation as template.

template...

Manage Preview a saved template.

Template...

Print Print the custom content.

The description of icons on Documentation pane

Closing and opening the Documentation pane

Documentation pane is opened by default. To close it, press the X button at the top right corner. On the other hand, it can be opened by selecting View
> Panes > Documentation from the main menu.

Documenting project data in text

Documentation pane enables users to type in the textual description for project data, for instance, model elements, shapes and diagrams.

Defining a glossary item

A word or a lexis can be defined as a glossary item for explication.
1. Highlight the word or the lexis you would like to be defined and then right click on it. Select Add "..." to Glossary from the pop-up menu to
switch to Glossary Grid.

Select Add "premium plan" to

Glossary from the pop-up menu

2. In Glossary Grid, click Open Specification... button in order to fill more details about the new item.

Click Open Specification... button

Documentation pane P. 116

3. In Term Specification dialog box, click Add button to type the alias(es) for the new item.

Type an alias for the new item

4. Further information about the new item can be given by typing in the space under Documentation.

Type in text

5. Finally, click OK to confirm editing. The window will then return to Glossary Grid.
6. Moreover, you can insert as many new terms as you prefer. In Glossary Grid, click Create Term (Insert) to create another new term.

Click Create Term (Insert) button

Checking spelling
When you type an incorrect word carelessly, documentation pane can offer you a help.

Documentation pane P. 117

For correction, right click on the incorrect word with a red curved line and select one out of the suggested words from the pop-up menu.

Select a correct word from the pop-up menu

Moreover, you can add a new word to the dictionary if the word you typed is a rare word or a new created word. Right click the new word and select
Add to dictionary from the pop-up menu. When you type the word next time, it won't be marked as an incorrect word again.

Documenting a shape by voice

In addition to textual description, documentation pane also enables users to document for project data in verbal form.
Click Record... button for recording voice.

Click Record... button

In Record Voice dialog box, enter the name for the audio clip. Click Record to start recording while click Stop to terminate. Click OK if you want to
save the voice recording; click Cancel, and vice verse.

Click Record in Record Voice dialog box

Name Icon Description

Record Press it to start recording.

Play Press it to play the voice you recorded.

Documentation pane P. 118

Stop Press it to stop recording.

Clear Press it to clear the voice you recorded.

The description of icons on Record Voice dialog box

Documentation pane P. 119

Stencil pane
Stencil pane is a library of custom shapes or images that can be used on diagrams. With Stencil Pane, users can create custom shapes and display
stencils by selecting stencils and drag them on diagram. Furthermore, stencils can be created in Shape Editor.

The Stencil pane

The toolbar
Name Icon Description

Add Stencil Select a stencil to create a new shape. Different sorts of stencil are categorized into two folders: Computers and Shapes
and a large amount of subfolders are subdivided into these two folders.

Import Stencil... Import a stencil that created externally in Microsoft Visio to VP-UML.

The description of icons on Stencil pane

Closing and opening the Stencil pane

Stencil pane is opened by default. To close it, press the X button at the top right corner. On the other hand, it can be opened by selecting View >
Panes > Stencil from the main menu.

Creating a stencil
Instead of keeping the existing shapes, users can create a stencil to replace an existing one.
Click Add Stencil button on the top of stencil pane and select a subfolder from the pop-up menu.

Select Hardwares from the pop-up menu

Stencil pane P. 120

When the subfolder is unfolded, press the preferred stencil and drag it on the diagram pane.

Drag a stencil on the diagram pane

Editing a stencil
A stencil can be customized according to users' preference in Shape Editor.
Right click on the stencil pane's background and select Open Shape Editor from the pop-up menu.

Select Open Shape Editor

from the pop-up menu

In Shape Editor dialog box, click New Shape button.

Click New Shape button

Stencil pane P. 121

Press on the stencil you want to be edited and drag it on the diagram pane.
Insert any shape(s) from the diagram toolbar with your preference and edit the format for the shape(s) in Format tab.

Turn the shadow of stencil into pink

Importing a stencil
The function of importing stencil enables you to import a stencil which is created in Microsoft Visio externally and send it to VP-UML by making using of
the plug-in "VisioSendToVP".
Note that you are able to execute this function only after you have installed Microsoft Visio and have sent a stencil from Visio.

Stencil pane P. 122

Creating project
Visual Paradigm for UML stores information like model elements and diagrams in a project. Therefore, you need to create a project before performing
modeling. To create a project, select menu File > New Project. The New Project dialog box appears. Click on Create Blank Project to create the
project.

Create a new project

Overview of New Project dialog box

An overview of New Project dialog box

No. Name Description

1 UML version Select the version of UML notation for the project. Normally you would select UML 2.1 so you can create UML
diagrams of the latest standard. However if you want to create diagrams with older notation you should select UML
1.x.

2 Language The Language combo box lets you select the programming/scripting language for the project. The language you
selected mainly affects the class modeling. For example, the selectable visibilities and primitive types vary among
languages.

3 Properties A page for specifying basic information of project like the project name, author, company and description.

Creating Project P. 123

4 Template A page for you to create a project by selecting a template.

5 Other CASE Tools A page for you to specify either a Rose or XMI file path for creating a new project.
Project

Description of New Project dialog box

Properties
To create a blank project, ensure the Properties page is being selected, and then click the Create Blank Project button.

An overview of Properties page

No. Name Description

1 UML version Select the version of UML notation for the project. Normally you would select UML 2.1 so you can create UML diagrams of
the latest standard. However if you want to create diagrams with older notation you should select UML 1.x.

2 Project name The name of project.

3 Author The author of project.

4 Company The company of project.

5 Project description The project description. You can make use of the toolbar on top of the description pane to add formatted content.

Description of Properties page

Template
If you often create projects of similar structure, you can save the project as a template and use it for creating project later. For example, you can save
a project with a use case diagram and a class diagram as template called "Static Modeling Template". When we create project from this template, the
project will have the same structure as the template automatically.

Creating Project P. 124

To create project from template, select the Template page and select a template to use, then click the Create From Template button.

An overview of Template page

No. Name Description

1 Template list A list of template that you have defined before.

2 Template preview By selecting a template from the template list, you can read the structure in the Template preview pane.

3 Template A description of the template.

description

Description of Template page

Other CASE Tools Project

If you have legacy projects created with other CASE tools, you can import them to VP-UML. Select either to import from Rose or from XMI, specify the
file path of source to import and click Create From Other CASE Tools at the bottom of dialog box.

An overview of Other CASE Tools Project page

No. Name Description

Creating Project P. 125

1 Import from Select this option if you want to create a new project by importing a Rational Rose project.
Rose

2 File path The file path of Rational Rose (*.mdl) project.

3 Rose import The selection controls what to import. There are two modes:
mode
Model element and diagram -Import both model elements (e.g. use case, class...) and diagrams (e.g. use case diagram, class
diagram...)
Model element only - Import only model element but not diagram. In the new project you can find the imported model
elements in Model Explorer.

4 Import from Select this option if you want to create a new project by importing a XMI file.
XMI

5 File path The file path of XMI (*.xmi) project.

6 Description Description of chosen option.

Description of Other CASE Tools Project page

Creating Project P. 126

Saving project
VP-UML saves all project content to a single file, with file extension .vpp.
To save project, select File > Save Project from the main menu. If you are saving the first time, the Save Project dialog box will appear. You can save
a project to workspace, or any location in the machine. For details, read the sections below.

Saving project to workspace

To save project to workspace, select Save to workspace. Enter the file name and click OK to save.

Save project to workspace

Saving project to specified directory

To save project to a specified directory, select Save to directory, and then specify in the Directory field the directory for saving project. Enter the file
name and click OK to save.

Save project to a specified directory

Saving Project P. 127

Organizing diagrams by model explorer
For small scale project, it would be easy to use Diagram Navigator to manage it. However, for middle to large scale project which has considerable
numbers of diagrams and model elements, it would be better to use Model Explorer to organize the project.
VP-UML loads diagrams and model elements only when they are used. For example, opening a diagram will load all its diagram elements, and opening
the specification dialog box of a model element will cause it (and the model elements it referenced) to be loaded. Besides, selecting a tree node in the
Model Explorer will cause the corresponding element to be loaded as well.
For this reason, we recommend you to group diagrams using Model instead of laying them flat in the project. This can avoid accidentally loading
diagrams and model elements that you never use, and thus can speed up project loading and saving.

Creating model
To create a Model, right-click on the project node in Model Explorer and select Model from the pop-up menu. You can either create a custom Model
by selecting New Model..., or create a pre-defined Model (e.g. Analysis Model) by selecting it in the list.

Create a model in Model Explorer

Creating diagram in model

To create diagram in model, right-click on the target model, select Diagram from the pop-up menu and then select either create a new diagram or add
existing diagram.

Create a diagram under Model

NOTE: When you create a shape, its model element will be put under the same model as diagram.

Organizing diagrams by model explorer P. 128

Moving diagrams between models
If you are not organizing project structure with model, you may want to do it now. You can move a diagram from root into a model, or transfer a diagram
from one model to another.
To move diagram from one model to another, right-click on the target model in Model Explorer and select Diagram > Add Existing Diagram... from
the popup menu.

Add existing diagram to Model

Select the diagrams you want to move in the Add Sub Diagrams dialog box and click OK button.

Select diagrams to move

The selected diagrams will be moved to the target model.

NOTE: If you move a diagram which has the master view of model element(s), the model element(s) will be moved together with the diagram to
the new model.

Organizing diagrams by model explorer P. 129

Project dependency
Project dependency enables you to reference to an another project, and use its model elements in developing our own project. You can organize
our model elements in a more disciplined approach by having one Visual Paradigm project per library project. This also helps to "slim up" projects by
breaking down a project into smaller pieces. Other than this, you can reference to other projects, and create an overview project for them.

Adding dependent projects

To reference to another project:
1. Right-click on the background of any of the following panes and select Manage Dependent Project... from the pop-up menu.
• Diagram Navigator
• Model Explorer
• Class Repository
• Logical View
• ORM

Manage dependent project

2. In the Manage Dependent Projects dialog box, click Add.

3. In the Open dialog box, choose the Visual Paradigm project file (*.vpp) to reference to and click Open.

NOTE: You can only reference to a project that was saved under the same version of VP-UML you are opening. For example, if you are running
VP-UML 7.1, you can only reference to a project saved by version 7.1 of VP-UML.

4. Click Close.

Using model elements in dependent projects

Once a project dependency has been established, you can develop your model using model elements in dependent project. To do this:
1. In Model Explorer, click on the drop down menu at the top of the pane and select the project that contains the model elements you want to use.

Select a dependent project

NOTE: By selecting the first selection (Current), model elements in the current project will be listed.

Project dependency P. 130

2. In the model element list, select the model element you want to use. Press and drop to diagram. This create views from them.

Form class diagram from model elements in dependent project

NOTE: Alternatively, you can right-click on the model elements and select Create View in Active Diagram from the popup menu.

3. Continue modeling with the referenced elements.

Model with model elements in dependent project

NOTE: Views for dependent project are read-only (i.e. non edit-able).

Mirroring model element

Due to views of dependent model elements are read-only, you cannot add shapes in it. This may be a problem when you want to use dependent
packages in your project, and to add model elements such as classes in it. To overcome this problem, you can create a mirror of container-typed
dependent model element. By mirroring, a dependent element is localized partially by keeping a mirrored copy in your project which echos the element
in dependent project. The mirrored copy can be accessed in Model Explorer that lists model elements in current project, but not editable.
To create a mirror from a container-typed dependent model element (e.g. package, business pools/lanes...), right click on the element in Model
Explorer and select Create Mirror Model Element from popup menu. By doing so, you can use it in your project, and add shapes in it. If you have
already created a view for a non-mirrored element and you want to create a mirror, you can also right click on the shape and select Convert to Mirror
from popup menu.

Mirror a dependent package

Project dependency P. 131

Indicating dependent elements on diagram
In order to know which shape(s) on a diagram comes from a dependent project, you can enable to model element indicators. Click on the Show Model
Element Indicators button at the top of diagram toolbar.

To show model element indicators

After that, you can see the indicator, which is a small arrow, appear at the shapes that are referencing a dependent project.

Model element indicator appears

Project dependency P. 132

Maintaining backups
Backup is a copy of project file. The major advantage of backup is to allow you to recover your work, in case you have made some undesired
modification on your project. The backup file is usually put along with the project.
Backup is a default setting. After you save your project, it will be produced subsequently. The name of backup file is basically similar to the name of
project file, but an extra ~ and a number are appended to it.

Backup copy is produced

Setting the backup level

You can set the amount of backup copy for your own reference. Select Tools > Options... from the main menu.

Select Options... from the main menu

Maintaining Backups P. 133

In Options dialog box, click General and select a number from the drop-down menu of Backup level under Project tab. The number of backup level
represents the amount of backup copy that is produced after a project is saved.

Select the amount of backup level in Options dialog box

Maintaining Backups P. 134

Model element and view
A model element is an elementary component of a model. It will be created when you create a shape on a diagram, or when we create one directly
through the Model Explorer. An example of model element is class.

Creat a model element through Model Explorer

You can visualize an existing model element by dragging and dropping a model element from Model Explorer to diagram. We call the visualized form
of model element a view, or a shape, depending on whether we want to emphasis the differences against model element, or we want to focus on
diagramming operations.

Creating a view from an existing model element through drag and drop

When developing context-based diagrams, you will reuse a model element in different diagrams, resulted in creating multiple views. Each model
element can associate with zero to multiple views. When you make specification-level change, such as changing of name, on any view, the change will
be applied to all views.

Showing a view of a model element

If you want to open a diagram from a model element, right click on the model element in Model Explorer and select Show View... from the popup
menu. Then, select the view to open in the Show View dialog box and click Go to View to open the diagram.

Model element and view P. 135

Master view and auxiliary view
When you create a shape, it creates a model element as well as a view. We call the first view to be created from a model element a master view. For
subsequent views created from the same model element, they are called auxiliary views. A model element can have unlimited number of auxiliary
views. Yet, it can have at most one master view.
A master view differs from auxiliary view in that master view affects the parent assignment of the owned model element, while auxiliary view does not
has such power. For example, if there is a package with a use case in it, and you try to drag the use case out of the package, the use case's parent
will be changed from package to root. However, if the use case is an auxiliary view, moving it to another parent will have the package as its parent,
remaining unchanged.

Converting an auxiliary view to master view

A model element can have multiple views. Yet, it can only have one master view. You can, however, convert an auxiliary view to become a master
view. By doing so, the original master view will become auxiliary, and the assignment of parent element will be updated immediately base on the new
master view when the conversion take place.
To convert an auxiliary view to master view, right click on the auxiliary view and select Selection > Set as Master View from the popup menu.

Converting an auxiliary view to master

Master view and auxiliary view P. 136

Drawing use case diagrams
Use case diagrams can be created in Visual Paradigm for UML. It is recommended to group related diagrams and model elements in a model, this
could improve the performance while saving and loading the project.

Creating a use case diagram

Right click Use Case Diagram on Diagram Navigator and select New Use Case Diagram from the pop-up menu.

Create a use case diagram

Enter name for the newly created use case diagram in the text field of pop-up box on the top left corner.

Enter name for the newly created use case diagram

Drawing a system
To create a system, select System on the diagram toolbar and then click it on the diagram pane. Finally, name the newly created system when it is
created.

Create a system

Drawing use case diagrams P. 137

Drawing an actor
To draw an actor, select Actor on the diagram toolbar and then click it on the diagram pane. Finally, name the newly created actor when it is created.

Create an actor

Drawing a use case

Besides creating a use case through diagram toolbar, you can also create it through resource icon.
Move the mouse over a shape and press a resource icon that can create use case. Drag it and then release the mouse button until it reaches to your
preferred place. The source shape and the newly created use case are connected. Finally, name the newly created use case.

Create a use case through resource icon

Line wrapping use case name

If a use case is too wide, for a better outlook, you may resize it by dragging the filled selectors. As a result, the name of use case will be line-wrapped
automatically.

Resize a use case

NOTE: Alternatively, you can press Alt + Enter to force a new line.

Drawing <<Extend>> relationship

To create an extend relationship, move the mouse over a use case and press its resource icon Extend -> Use Case. Drag it to your preferred place
and then release the mouse button. The use case with extension points and a newly created use case are connected. After you name the newly
created use case, a pop-up dialog box will ask whether you want the extension point to follow the name of use case. Click Yes if you want it to do so;
click NO if you want to enter another name for extension point.

Create an extend relationship

Drawing use case diagrams P. 138

Drawing <<Include>> relationship
To create an include relationship, mouse over a use case and press its resource icon Include -> Use Case. Drag it to your preferred place and then
release the mouse button. A new use case together with an include relationship is created. Finally, name the newly created use case.

Include relationship is created

Structuring use cases with package

You can organize use cases with package when there are many of them on the diagram.
Select Package on the diagram toolbar (under Common category).

Create a package

Drag the mouse to create a package surrounding those use cases.

Surround use cases with package

Finally, name the package.

Name the package

Assigning IDs to actors/Use cases

You may assign IDs to actors and use cases. By default, IDs are assigned with the order of object creation, starting from one onwards. However, you
can define the format or even enter an ID manually.

Drawing use case diagrams P. 139

Defining the format of ID
To define the format of ID, select Tools > Options from the main menu to unfold the Options dialog box. Select Diagramming from the list on the left
hand side and select the Use Case Diagram tab on the right hand side. You can adjust the format of IDs under Use Case Diagram tab. The format of
ID consists of prefix, number of digits and suffix.

Use Case Diagram tab

The description of options for ID generator format is shown below.

Option Description

Prefix The prefix you enter in Prefix text field will be inserted before the number.

Num of The number of digits for the number. For example, when digit is 3, ID "1" will become "001".
digits

Suffix The suffix you enter in Suffix text field will be inserted behind the number.

Options for formatting ID

Showing ID on diagram
By default, ID is just a text property. It usually doesn't appear on diagram. However, you can make it shown within a use case.
Right click on the diagram background, select Presentation Options and the specific model element display option from the pop-up menu.

Show ID on diagram

Drawing use case diagrams P. 140

As a result, the use case is displayed with ID.

A use case with ID displayed

NOTE: The feature of showing ID does only support for use case, but not for actor.

ID assignment
There are several ways that you can assign an ID to a model element, including:
• Through the specification dialog box (Right click on the selected model element and select Open Specification... from the pop-up menu)
• Through the Property Pane

Drawing business use case

1. Right click on a use case and select Model Element Properties > Business Model from the pop-up menu.

Click Business Model

2. After selected, an extra slash will be shown on the left edge of the use case.

Business model

Drawing use case diagrams P. 141

Documenting use case details
The feature of use case details refers to the basic information, flow of events, requirements and test plan of a use case. Documenting use case details
is essential in recording meaningful and important information for a use case.

Opening use case details

To start editing and viewing use case details, right click on the target use case in use case diagram and select Use Case Details... from the pop-up
menu.

Select Open Use Case Details...

Entering basic information

Basic information refers to all general information of a use case. Rank and justification determine the importance of use case. Select a rank from the
drop-down menu and enter the text in Justification text field.
Primary actors list the actors being involved in a use case. Actors that are connected to a use case are automatically defined as primary actors.
Supporting actor are actors who are beneficial from the system, but without direct interaction. Both primary and supporting actors can be added
manually by pressing the Plus button and select the actors in the pop-up dialog box.

Basic information of use case

Documenting use case details P. 142

Entering flow of events
Flow of events refers to the steps required to go through and fulfill a use case. You may define multiple flows of events under a use case and add
extension to an event as well. For more information about documenting flow of events, read the next chapter Documenting Flow of Events.

Flow of events of use case

Entering details
Details are predefined and detailed fields of a use case, which includes level, complexity, status, implementation status, preconditions and post-
conditions, author and assumptions. Select an option for Level, Complexity, Use Case Status and Implementation Status from the drop-down
menu.

Details of use case

Inserting requirement links

Documenting use case details P. 143

1. Click in the text field where you want to insert a requirement link. Click the Insert Requirement... button when it pops out. Note that only fields
where support multiple line are allowed to add requirement links.

Click Insert Requirement... button

2. When the Select Requirement dialog box pops out, select the requirement you want to link to and click OK to confirm. The searching scope
of selecting requirement may be narrow down if you find too many requirements in your project. Select a specific diagram from the drop-down
menu at the top left corner of dialog box, or enter its name at the Filter field directly at the top right corner.

Select a requirement

3. Once the link is inserted in the text field, you can right click to navigate it through its pop-up menu.

Adding requirements
Requirements of a use case can be added in the Requirements page.

Requirements of use case

To add requirement(s) to a use case:

1. Click the Add... button at the bottom right of dialog box.

Documenting use case details P. 144

2. In the Requirements dialog box, look for and select the requirements to add, and click OK to confirm the selection.

Select a requirement

NOTE: The Requirements page is for adding existing requirements as requirements. If you want to define a new requirement, read the next
section Adding a sub-diagram. Information about how to add a requirement diagram as sub-diagram and define the requirements in the
diagram is provided. Requirements are made in Diagrams page will be automatically added to the use case's requirements.

Managing sub-Diagrams
You can make use of another diagram for elaborating a use case. The Diagrams page enables you to add and open sub-diagrams of a use case.
When you select a diagram on the list on the left, you may preview it on the right if Show preview is checked.

Diagrams of use case

Adding a sub-diagram

Documenting use case details P. 145

1. Click the Add button at the bottom of Diagrams page, select a type of diagram from the pop-up menu if you want to add a new diagram as sub-
diagram. On the other hand, select Add Existing Diagrams... if you want to add an existing diagram in your current project.

Add a sub-diagram

Opening a sub-diagram
Select a sub-diagram on the list to open and click the Open button at the bottom of Diagrams page.

Writing test plan

While the detailed testing procedure can be documented in flow of events, the testing setup and configurations can be documented in the Test Plan
tab.

Test Plan of use case

Documenting use case details P. 146

Adding references
You may add references to both internal and external artifacts, such as shapes, diagrams, files, folders and URLs for describing the use case in
various views.

References of use case

Opening obsolete use case description

Use Case Description was an obsolete feature removed in Visual Paradigm Suite version 4.1. We recommend users to use the flow of events tool
to document the internal flow of use case rather than making use of use case description. But for the old version users, they can still activate the
Description pane to access the saved data.

Obsolete use case description

Documenting use case details P. 147

You can convert the obsolete use case details to flow of events by clicking on the Convert button at the bottom right corner.

Convert use case description

Documenting use case details P. 148

Documenting flow of events
A flow of events refers to the steps required to go through and then fulfill a use case. Furthermore, multiple flows of events can be defined under a
use case. A few more features are applied in the flow of events, such as model element link presentation options, extension and generating activity
diagram.

Opening flow of events editor

1. In a use case diagram, right click on the target use case and select Open Use Case Details... from the pop-up menu.
2. When the details pane pops out, select the Flow of Events tab.

Flow of Events tab

The flow of events editor

The upper part is the flow of events pane for editing the flow of events step by step while the bottom part is the extension pane for editing extension of
sub item. Furthermore, when Main is chosen from the drop-down menu of (Hide testing procedures), two columns of procedures and expected results
will be shown as testing procedure in the flow of events pane.

The flow of events editor

Button Name Description

Drop-down menu of Flow of Events You may select Manage... from the drop-down menu to create new flow of
events.

Control menu You may select various function in the menu:

Step (Enter): Enter next step.
Extension (Shift+Enter): Enter extension for the selected step.
If: Enter conditional situation for the selected step.
Else if: Insert another situation under If.
Else: Insert it to control If and Else if.
Clear control, Go to previous condition and Go to end.
While:
For each:
Loop until:
Exit:

Documenting flow of events P. 149

Jump:

Add menu Select an existing use case/ actor/ requirement in the current project and insert
it in the selected step for referenced link.

Hyperlink... Add a link in the selected step for reference.

Font Select font effect for the highlighted text: Bold, Italic and Font Color.

Font size Select font size for the highlighted text:

Grow Font: To multiply the font size of flow of events and extension content.
Shrink Font: To reduce the font size of flow of events and extension content.
Default Font: To reset the font size to default.
Moreover, you can adjust the font size for the highlighted text manually by
slider.

Move Up Move a selected step upward.

Move Down Move a selected step downward.

Descrease Indent Decrease the indentation of flow of events by one level.

Increase Indent Increase the indentation of flow of events by one level.

Delete Step Delete the selected step.

Undo Undo a previous action.

Redo Revert a previous action.

Synchronize to Activity Diagram Synchronize the flow of events to activity diagram. If no activity diagram has
created previously, a new activity diagram will be generated.

Model Element Link Presentation Options To select the presentation for use case link/ actor link/ requirement link.
Name : To display the name of model element only.
ID : To display the ID of model element only.
ID: Name: To display both the name and ID of model element.

Drop-down menu of Testing Procedure Select Main to create testing procedure while select Manage... to create a new
testing procedure. Columns of procedures and expected results will be shown
respectively on the step pane for editing testing procedure.

Buttons in flow of events editor

Documenting flow of events

1.
Click on the first row to start editing, press Enter or click from the control menu after finish editing the first event and then go to the next
event.

Enter the first event

Documenting flow of events P. 150

2. Repeat the previous steps for creating as much as events you need until all events are documented.

Fill flow of events

NOTE: To add a sub event, click on the row of sub event, and either press the Tab/Ctrl-Period button or click on the button at the toolbar to
indent the event row. On the contrary, press Shift-Tab/Ctrl-Comma or click on the button to decrease the indentation.

Inserting actor/usecase/requirement link

A new feature of actor/ usecase/ requirement link can be attached in a specific event with different presentations.
Select actor/ usecase/ requirement link from the add menu.

Select Actor...

When the Select [model element] dialog box pops out, select a specific one and then click OK button to insert.
As a result, the actor/ usecase/ requirement link will show on the specific event.

An actor link is applied

The presentation of link can be customized by pressing Model Element Link Presemtatopm Options button. Select Name, ID or ID: Name from
the corresponding drop-down menu in Model Element Link Presentation Options dialog box. Selecting Name refers to display the name of model
elements only while selecting ID refers to display the ID of model element only. Selecting ID: Name refers to display both the name and ID of model
element.

Select a presentation option

NOTE: The searching scope of selecting actor/ usecase/ requirement in the dialog box can be limited by selecting a specific diagram from the
drop-down menu.

Documenting flow of events P. 151

Adding extension
An extension can be seen as an extension point of use case. It documents the alternative flow that can be extended from the main flow. To add an
extension:
1.
Select a specific event and press for adding extension.
2. You may enter a sub item of an event in the extension pane. Press the Enter key to add a sub item.

Fill extensions

NOTE:
To add a sub item, click on the row of sub event, and click at the toolbar to indent the event row. On the contrary, click to
decrease the indentation.

Documenting testing procedure

Testing procedure can be documented for each step of the flow. To document testing procedure:
1. Choose Main from the drop-down menu of Testing Procedure to reveal the columns of Procedures and Expected Results respectively.

Select Main

2. Enter the testing procedure for the event that we need to test in Procedures text field.

Enter testing procedures

Documenting flow of events P. 152

3. Enter the result we expected for the testing procedure in Expected Results text field.

Enter expected results

4. Repeat the previous steps until finish documenting the testing procedure.

Creating multiple flow of events

1. To create a new flow of events, select Manage... from the drop-down menu of Flow of Events at the toolbar.

Create multiple flow of events

2. When the Flow of Events dialog box pops out, click the New Flow of Events button to create a new flow of events.

Create a new flow of events

3. Enter the name of flow of events in Input dialog box. Click OK to confirm.
4. Click OK button to close the Flow of Events dialog box. As a result, the newly created flow of events will be available from the drop-down
menu.

Generating activity diagram from flow of events

To generate activity diagram from flow of events, right click on the background of flow of events editor and select Synchronize to Activity Diagram
from the pop-up menu.

Generate activity diagram from flow of events

NOTE: If you want to view the specific event in an activity diagram, right click on the event and select Open "[step]" Activity Action from the
pop-up menu.

Documenting flow of events P. 153

Elaborating use case
A use case can be elaborated by using sequence diagrams and activity diagrams to model its interactions and activity flows respectively.

Elaborating use case by sequence diagrams

A use case can be elaborated by using sequence diagrams as a sub diagram.

Creating a sub diagram

Right click on the target use case and select Sub Diagrams > Sequence Diagram > Create Sequence Diagram from the pop-up menu.

Create a sequence diagram as sub diagram

Drawing sequence diagram

The sequence diagram is created to show how users can interact with the procedure in the use case.

Draw a sequence diagram

Navigating to parent use case

If you want to return to the parent use case, click the parent use case's name on the diagram title bar.

Navigate to parent use case

Elaborating use case by activity diagrams

In addition, a use case can be elaborated by using activity diagrams to fill in the flow of events of a use case and synchronize the events to an activity
diagram.

Synchronizing flow of events to activity diagram

1. Right click on the target use case and select Open Use Case Details... from the pop-up menu.

Open use case details

Elaborating use case P. 154

2. When the details dialog box pops out, select the Flow of Events tab.

Open flow of events editor

3. Start editing the steps under flow of events pane. After finish editing, right click on the background of flow of events and select Synchronize to
Activity Diagram from the pop-up menu.

Generate activity diagram from flow of events

Navigating to flow of events

If you want to return to the flow of events, right click on a target action in activity diagram and select Related Elements > Open Flow of event from the
popup menu.

Open flow of events from activity diagram

Elaborating use case P. 155

Updating activity diagram from flow of events
If you have made some changes on flow of events, you can synchronize the changes to activity diagram. Right click on the background of flow of
events and select synchronize to the name of activity diagram from the pop-up menu.

Update changes from flow of events to activity diagram

Elaborating use case P. 156

Managing actors with actors grid
Actors Grid is a table with actors listed in it. It lets you to access all actors in a project or diagram, check their related use cases, lookup and create
actors.

Creating the actors grid

Select UML > Actor Grid from the toolbar.

Open Actor Grid

The overview of actors grid

The actors grid

Field Description

Click this button to reveal Name and Model Element. To hide these them, click this button again.

Create a new actor.

To find an actor by providing its name or documentation.

To open the specification of actor selected in grid.

To show the view(s) of actor selected in grid.

To visualize an actor selected in grid.

Add/ remove property column(s) in Term list.

Managing actors with actors grid P. 157

To update the display on the Term list.

To select the scope for showing mdoel elements on Term list.

To filter actors by name. The rubber on the right hand side is for clearing the filter content.

The fields in actors grid

Accessing use case from actor

Click on the name of use case in the Related use cases cell of the actor that we want to access its related use case.

Access use case from actor

Creating actor
1.
Click on above the grid.

Create an actor in grid

2. Name the actor. You may optionally reset the ID by double-clicking on the ID cell and entering a new one.

Name actor

NOTE: The actors created in actors grid are automatically put under the Actors model. You may move to another model through dragging and
dropping in Model Explorer.

Visualizing an actor
You can form a diagram with actor, or show it in an existing diagram by visualizing it in actors grid. To visualize an actor:
1. Select the actor to visualize.

Select an actor to visualize

2.
Click on above the grid.

Click Visualize button

Managing actors with actors grid P. 158

3. If you want to visualize actor in a new diagram, check Create new diagram, select the type of diagram to create and specify the diagram name.

Name a new diagram

If you want to visualize actor in an existing diagram, check Show in existing diagram and select a diagram in the diagram list.

Select an existing use case diagram to visualize the actor

4. Click Create button at the bottom of the dialog box.

Managing actors with actors grid P. 159

Filtering actors
By filtering actors, actors that do not match the required naming convention are filtered. To filter, enter the name of actor, or part of its name at the top
right of grid. You can make use of the asterisk (*) character to represent any character(s).

Filter actor by name

Finding actor
To find out actors that match specific naming or documentation pattern:
1.
Click above the grid.

Find an actor

2. In the Search Text text box, enter the text to search. Specify whether to search the names and/or documentation of actors. Click Find button.
As a result, the grid is updated to highlight the matched actor(s).

The matched actors are highlighted

Managing actors with actors grid P. 160

Managing use cases with use cases grid
Use Cases Grid is a table with use cases listed in it. It lets you to access all use cases in a project or diagram, check their related actors, lookup and
create use case.

Creating the use case grid

Select UML > Use Case Grid from the toolbar.

Open Use Case Grid

The overview of use cases grid

The use cases grid

Button Name Description

Configure Grid Click this button to reveal Name and Model Element. To hide these them, click this button
again.

Create Use Case Create a new use case.

Find To find a use case by providing its name or documentation.

Open Specification... To open the specification of use case selected in grid.

Open Use Case Detail To open the use case details of use case selected in grid.

Show View... To show the view(s) of use case selected in grid.

Visualize... To visualize a use case selected in grid.

Managing use cases with use cases grid P. 161

Configure columns... Add/ remove property column(s) in Term list.

Refresh To update the display on the Term list.

Project To filter use cases by selecting the diagram(s) (or all diagrams) that contain the use
casesuse case.

Use Case's name To filter use cases by name. The rubber on the right hand side is for clearing the filter
filter content.

The fields in use cases grid

Accessing actor from use case

Click on the name of actor in the Primary Actors/Supporting Actors column of the use case that we want to access its related actor.

Access actor from use case

Creating use case

1.
Click on above the grid.

Create a use case

2. Name the use case. You may optionally reset the ID by double-clicking on the ID cell and entering a new one.

Name use case

NOTE: The use cases created in use cases grid are automatically put under the Use Cases model. You may move to another model through
dragging and dropping in Model Explorer.

Browsing use case's details

To browse for the details of a use case, select the use case in grid and click on the button. This opens its use case details.

Visualizing a use case

You can form a diagram with use case, or show it in an existing diagram by visualizing it in use cases grid. To visualize a use case:

Managing use cases with use cases grid P. 162

1. Select the use case to visualize.

Select a use case to visualize

2.
Click on above the grid.

Click Visualize button

Managing use cases with use cases grid P. 163

3. If you want to visualize use case in a new diagram, check Create new diagram, select the type of diagram to create and then specify the
diagram name.

Name a new diagram

If you want to visualize use case in an existing diagram, check Show in existing diagram and select a diagram in the diagram list.

Select an existing use case diagram to visualize the use case

4. Click Create button at the bottom of the dialog box.

Managing use cases with use cases grid P. 164

Filtering use cases
By filtering use cases, use cases that do not match the required naming convention are filtered. To filter, enter the name of use case, or part of its
name at the top right of grid. You can make use of the asterisk (*) character to represent any character(s).

Filter use case by name

Finding use case

To find out use cases that match specific naming or documentation pattern:
1.
Click above the grid.

Find a use case

2. In the Search Text text box, enter the text to search. Specify whether to search the names and/or documentation of use cases. Click Find. As a
result, the matched use case(s) will be highlighted.

Enter use case name, check Name and click Find button

Managing use cases with use cases grid P. 165

Drawing activity diagrams
Activity diagram is a flowchart-based diagram showing flow of control from activity to activity. It shows concurrency, branch, control flow and object
flow. Swimlane, furthermore, is used for partitioning the activity states.

Creating activity diagram

Right click Activity Diagram on Diagram Navigator and select New Activity Diagram from the pop-up menu to create an activity diagram.

Create activity diagram

Creating swimlane
You can click either Horizontal Swimlane or Vertical Swimlane on the diagram toolbar.

Create swimlane

Click on the diagram to create the swimlane.

Swimlane created

Double-click the partition name to rename it.

Rename partition

Drawing activity diagrams P. 166

Inserting partition to swimlane
To insert partition to swimlane, right-click on a partition and select Insert Partition After from the popup menu.

Insert partition to swimlane

A partition is inserted.

Partition inserted

Creating initial node

Click Initial Node on the diagram toolbar.

Create initial node

Click inside the partition to create the initial node there.

Initial node created

Creating action
Mouse over the initial node until its resources are visible. Click on the Control Flow -> Action resource and drag.

Create action

Move the mouse to where you want to place the action to, and then release the mouse button. An action is created and is connected to the initial node
with a control flow.

Action created

Drawing activity diagrams P. 167

Similarly you can create a new action using the Control Flow -> Action resource of an action.

Create a new action from an action

A new action is created and is connected to the action with a control flow.

Action created

Continue to complete the activity diagram.

Completed activity diagram

Working with scenario

A scenario is a diagram formed by the internal interaction of a sequence of action, modeled by their sub-diagrams. With scenario, you can produce
a diagram which presents an overview of an execution path in activity diagram, so as to know how user and system communicate with each other in
order to complete the flow.

Producing scenario from activity diagram

Drawing activity diagrams P. 168

1. Right click on the activity diagram that contains the flows that you want to produce a scenario, and select Scenarios > Edit Scenarios... from
the popup menu.

Edit scenarios

2. In the Edit Scenarios dialog box, click Add... button at the bottom left corner.

Add a scenario

Drawing activity diagrams P. 169

3. Select a path for generating scenario. Click OK to confirm.

Select a path for generating scenario

NOTE: A path is a continuous flow of actions in the diagram, with an initial node placed at the beginning of the actions. Multiple paths are
obtained by determining the existence of decision nodes within the flow.

4. Name the scenario. Add description if necessary.

Name and describe scenario

5. The actions being involved in the flow are listed in the Path table. For actions that have sub-diagram(s), pick up the sub-diagram in Diagram
column, or just create a new one. You may, however, leave it unspecified, which cause that action to be ignored when producing scenario.

Select diagram for action

Drawing activity diagrams P. 170

6. Click on the arrow beside the Generate button and select the type of diagram of the scenario.

Generate scenario with specific diagram type

Updating scenario
Whenever the sub-diagram(s) of action(s) are updated, you can update the scenario to make it represents the latest information of interaction. To
update scenario, right click on the activity diagram that have scenario produced before, select Scenarios, then the name of scenario from the popup
menu.

Drawing activity diagrams P. 171

Drawing state machine diagrams
State machine diagram shows flow of control from state to state within single object. It usually contains simple states, composite states, composite
states, transitions, events and actions.

Creating state machine diagram

Right click State Machine Diagram on Diagram Navigator and select New State Machine Diagram from the pop-up menu to create a state machine
diagram.

Create state machine diagram

Creating states and transitions

After creating a state machine diagram, an initial pseudo state appears by default. Move the mouse over it and click its resource icon Transition ->
State.

Create state from initial pseudo state

Drag it to your preferred place and then release the mouse to confirm the place. As a result, a state is created and is connected to the initial pseudo
state with a transition.

State and transition created

Similarly, you can use the Transition -> Final State resource to create a final state.

Create final state

Drawing state machine diagrams P. 172

Final state does not show caption by default. To show it, right-click on the diagram and select Presentation Options > Show Shape Caption > Final
State.

Show caption of final state

Adding region to state

To model substates of a composite state, you need to add one or more regions to it. To add a region, right-click the state and select Add Horizontal
Region from the popup menu.

Add region to state

Next, you can draw the substates inside the region.

Substates in a composite state

Drawing state machine diagrams P. 173

Modeling properties of transition
To model properties of transition such as effect and guard, right-click the transition and select Open Specification... from the pop-up menu.

Open specification of transition

When the Transition Specification dialog box pops out, you can edit its name, effect and guard. Next, click Edit... button of the Effect property.

Transition Specification dialog box

In Activity Specification (Effect) dialog box, change its name, and then click OK button to apply the change.

Edit effect property of transition

Click OK in the Transition Specification dialog box to close it. The name and effect are shown on the transition caption.

Name and effect shown in caption of transition

Drawing state machine diagrams P. 174

Drawing timing diagrams
Timing diagram shows time, event, space and signal for real-time and distributed system.

Creating timing diagram

Right click Timing Diagram on Diagram Navigator and select New Timing Diagram from the pop-up menu to create a timing diagram.

Create timing diagram

Creating timing frame

To create timing frame, click Timing Frame on the diagram toolbar and then click on the diagram.

Create timing frame

Double click on the top left corner of the frame to rename it.

Rename frame

The name of a timing frame is usually preceded by the sd keyword.

Frame renamed

Adding lifeline to frame

To add lifeline to frame, right-click the frame and select Add Lifeline from the pop-up menu.

Add lifeline

Double-click on the name of the lifeline to rename it.

Drawing timing diagrams P. 175

Adding time unit to frame
To add time unit to frame, right-click the frame and select Add Time Unit from the pop-up menu.

Add time unit

Repeat the step to add as many as time units you need. Double-click on a time unit to rename it.

Rename time unit

Adding state/condition to lifeline

To add state/condition to lifeline, right-click the lifeline and select Add State/Condition from the pop-up menu.

Add state/condition

Double click on the name of the state/condition to rename it.

Dragging time instance

Mouse over the line segment of a time instance, click and drag it.

Drag time instance

Drawing timing diagrams P. 176

Release the mouse button when reached the target state/condition.

Dragged time instance

You can also move a group of time instances that are at the same state/condition. Mouse over the time instances and you will see a blue line above
them, click and drag on the blue line.

Move a group of time instances

Release the mouse button when reached the target state/condition. The group of time instances is moved at once.

Moved group of time instances

Adding time messages to frame

To add time messages to frame, right-click the frame and select Edit Frame... from the pop-up menu.

Edit frame

In the Edit Frame dialog box, open the Time Messages tab and click Add... button.

Add time message

Drawing timing diagrams P. 177

When the Add Time Message dialog box pops out, enter name and select the start lifeline, start time, end lifeline and end time for this time message.
Note that as time units may be unnamed, when selecting start/end time you should check the relative position of the time unit in the list.

Select end time of time message

The time message is shown on the frame.

Time message

Drawing timing diagrams P. 178

Switching to compact view mode
To switch to compact view mode, right-click the frame and select View Mode > Compact from the popup menu.

Switch to compact view mode

The frame will be shown in compact mode.

Frame shown in compact mode

Drawing timing diagrams P. 179

Drawing sequence diagrams
A sequence diagram is used primarily to show the interactions between objects that are represented as lifelines in a sequential order.

Creating sequence diagram

Right click Sequence diagram on Diagram Navigator and select New Sequence Diagram from the pop-up menu to create a sequence diagram.

Create sequence diagram

Enter name for the newly created sequence diagram in the text field of pop-up box on the top left corner.

Creating actor
To create actor, click Actor on the diagram toolbar and then click on the diagram.

Create actor

Creating lifeline
To create lifeline, you can click LifeLine on the diagram toolbar and then click on the diagram.
Alternatively, a much quicker and more efficient way is to use the resource-centric interface. Click on the Message -> LifeLine resource beside an
actor/lifeline and drag.

Create lifeline

Move the mouse to empty space of the diagram and then release the mouse button. A new lifeline will be created and connected to the actor/lifeline
with a message.

Lifeline and message created

Drawing sequence diagrams P. 180

Auto extending activation
When create message between lifelines/actors, activation will be automatically extended.

Auto extending activation

Using sweeper and magnet to manage sequence diagram

Sweeper helps you to move shapes aside to make room for new shapes or connectors. To use sweeper, click Sweeper on the diagram toolbar (under
the Tools category).

Sweeper

Click on empty space of the diagram and drag towards top, right, bottom or left. Shapes affected will be swept to the direction you dragged.
The picture below shows the actor Inspector Assistant is being swept towards right, thus new room is made for new lifelines.

Sweep towards right

Drawing sequence diagrams P. 181

The picture below shows the message specify visit time is being swept downwards, thus new room is made for new messages.

Sweep downwards

You can also use magnet to pull shapes together. To use magnet, click Magnet on the diagram toolbar (under the Tools category).

Magnet

Click on empty space of the diagram and drag towards top, right, bottom or left. Shapes affected will be pulled to the direction you dragged.

Drawing sequence diagrams P. 182

The picture below shows when drag the magnet upwards, shapes below dragged position are pulled upwards.

Pull shapes upwards using magnet

Creating combined fragment for messages

To create combined fragment to cover messages, select the messages, right-click on the selection and select Create Combined Fragment, and then
select a combined fragment type (e.g. loop) from the popup menu.

Create combined fragment for messages

Drawing sequence diagrams P. 183

A combined fragment of selected type will be created to cover the messages.

Combined fragment created

Developing sequence diagram with quick editor or keyboard shortcuts

In sequence diagram, an editor appears at the bottom of diagram by default, which enables you to construct sequence diagram with the buttons there.
The shortcut keys assigned to the buttons provide a way to construct diagram through keyboard. Besides constructing diagram, you can also access
diagram elements listing in the editor.

The quick editor

Editing lifelines
There are two panes, Lifelines and Messages. The Lifelines pane enables you to create different kinds of actors and lifelines.

Lifelines pane in quick editor

Button Shortcut Description

Alt-Shift- To create an actor

Alt-Shift-L To create a general lifeline

Drawing sequence diagrams P. 184

Alt-Shift- To create an <<entity>> lifeline
E

Alt-Shift- To create a <<control>> lifeline

Alt-Shift- To create a <<boundary>> lifeline

Alt-Shift- To open the specification of the element chosen in quick editor

Ctrl-Del To delete the element chosen in quick editor

Ctrl-L To link with the diagram, which cause the diagram element to be selected when selecting an element in editor, and vice versa

Buttons in Lifelines pane

Editing messages
The Messages pane enables you to connect lifelines with various kinds of messages.

Messages pane in quick editor

Button Shortcut Description

Alt-Shift-M To create a message that connects actors/lifelines in diagram

Alt-Shift-D To create a duration message that connects actors/lifelines in diagram

Alt-Shift-C To create a create message that connects actors/lifelines in diagram

Alt-Shift-S To create a self message on an actor/lifeline in diagram

Alt-Shift-R To create a recursive message on an actor/lifeline in diagram

Alt-Shift-F To create a found message that connects to an actor/lifeline

Alt-Shift-L To create a lost message from an actor/lifeline

Alt-Shift-E To create a reentrant message that connects actors/lifelines in diagram

Ctrl-Shift-Up To swap the chosen message with the one above

Ctrl-Shift- To swap the chosen message with the one below

Down

Ctrl-R To revert the direction of chosen message

Alt-Shift-O To open the specification of the message chosen in quick editor

Ctrl-Del To delete the message chosen in quick editor

Drawing sequence diagrams P. 185

Ctrl-L To link with the diagram, which cause the message to be selected when selecting a message in editor, and vice versa

Buttons in Messages pane

Expanding and collapsing the editor

To hide the editor, click on the down arrow button that appears at the bar on top of the quick editor. To expand, click on the up arrow button.

Collapse the quick editor

Setting different ways of numbering sequence messages

You are able to set the way of numbering sequence messages either on diagram base or frame base.

Diagram-based sequence message

Right click on the diagram's background, select Sequence Number and then either Single Level or Nested Level from the pop-up menu.

Diagram-based pop-up menu

If you choose Single Level, all sequence messages will be ordered with integers on diagram base. On the other hand, if you choose Nested Level, all
sequence messages will be ordered with decimal place on diagram base.

Single level

Drawing sequence diagrams P. 186

Frame-based sequence message
Right click on the diagram's background, select Sequence Number and then either Frame-based Single Level or Frame-based Nested Level from
the pop-up menu.

Frame-based pop-up menu

When you set the way of numbering sequence messages on frame base, the sequence messages in frame will restart numbering sequence message
since they are independent and ignore the way of numbering sequence message outside the frame.

Frame-based nested level

Drawing sequence diagrams P. 187

Drawing communication diagrams
Communication diagram is designed for illustrating the dynamic view of the system. It emphasizes the structural organization of the objects' send and
receive messages.

Creating communication diagram

Right click Communication Diagram on Diagram Navigator and select New Communication Diagram from the pop-up menu to create a
communication diagram.

Create communication diagram

Creating actor
To create actor, click Actor on the diagram toolbar and then click on the diagram.

Create actor

Create lifeline

Move the mouse to empty space of the diagram and then release the mouse button. A new lifeline will be created and connected to the actor/lifeline
with a link (the line) and a message (the arrow).

Lifeline, link and message created

Creating message on link

To create message on link, click its Create Message resource.

Create message on link

Drawing communication diagrams P. 188

A message will be created on the link.

Message created on link

Editing sequence number of messages

To edit sequence number of messages, for example, to show certain messages are in nested level of interaction, right-click the diagram and select
Reorder Messages ... from the pop-up menu.

Reorder messages

When the Communication Diagram Specification dialog box appears, the Message tab is opened by default. Double click on the Sequence # cell of
a message to edit it. Click OK button to apply the changes.

Edit sequence number of messages

Drawing communication diagrams P. 189

The sequence number of messages is updated.

Sequence number of messages updated

Drawing communication diagrams P. 190

Drawing interaction overview diagrams
Interaction overview diagram is the variant of activity diagram. Interaction overview diagrams overview control flow. The main element, frame shows
any type of interaction diagram.

Creating interaction overview diagram

Right click Interaction Overview Diagram on Diagram Navigator and select New Interaction Overview Diagram from the pop-up menu to create an
interaction overview diagram.

Create interaction overview diagram

Creating initial node

To create initial node, click Initial Node on the diagram toolbar and then click on the diagram.

Create initial node

An initial node is created. The caption of initial node is hidden by default, to show it, right-click on the diagram and select Presentation Options >
Show Shape Caption > Initial Node from the pop-up menu.

Show caption of initial node

Creating decision node

To create a decision node from an initial node, move the mouse over the initial node and press its resource icon Generic Resource.

Generic resource

Drawing interaction overview diagrams P. 191

Drag it to your preferred place and then release the mouse button. Select Control Flow -> Decision Node from the pop-up menu.

Create decision node

If you want to show the caption of decision node, right click on the diagram background and select Presentation Options > Show Shape Caption >
Decision Node from the pop-up menu.

Creating interaction use

To create an interaction use, move the mouse over a shape and press its resource icon Control Flow -> Interaction Use.

Create interaction use

Drag it to your preferred place and then release the mouse button. An interaction use is created and connected to the shape you selected with a control
flow.

Interaction use and control flow created

You can make the interaction use refer to a diagram by right clicking on it and select Refers to > New Sequence Diagram from the pop-up menu.

Make interaction use refers to diagram

When sequence diagram is created, rename the diagram.

Rename
sequence diagram

Drawing interaction overview diagrams P. 192

When you return to the interaction overview diagram, you can see the interaction use caption shows the diagram it refers to.

Interaction use caption updated

Creating fork node

To create a fork node, move the moue over a shape and press its resource icon Control Flow -> Fork Node.

Create fork node

Drag it to your preferred place and then release the mouse button. A fork node is created and connected to the shape you selected with a control flow.
The fork node created is vertical by default. If you want to change it to horizontal, right click on the fork node and select Orientation > Horizontal from
the pop-up menu.

Change orientation of fork node

Moreover, if you want to show the caption of fork node, right click the diagram and select Presentation Options > Show Shape Caption > Fork Node
from the pop-up menu.

Creating interaction
To create an interaction, move the mouse over a shape and press its resource icon Control Flow -> Interaction.

Create interaction

Drag it to your preferred place and then release the mouse button. An interaction is created and connected to the shape you selected with a control
flow.

Drawing interaction overview diagrams P. 193

A new sequence diagram is created and associated with an interaction by default. To open it, right click on the interaction and select Associated
Diagram > (target diagram name).

Open associated diagram of interaction

Draw the sequence diagram.

Sequence diagram

When you return to the interaction overview diagram, you can see the interaction shows the thumbnail of the sequence diagram.

Updated diagram thumbnail in interaction

Creating join node

To create a join node, move the mouse over a shape and press its resource icon Control Flow -> Join Node.

Create join node

Drag it to your preferred place and then release the mouse button. A join node is created and connected to the shape you selected with a control flow.
The join node created is vertical by default, to change it to horizontal, right-click on the join node and select Orientation > Horizontal from the pop-up
menu.
Moreover, if you want to show the caption of join node, right click the diagram background and select Presentation Options > Show Shape Caption >
Join Node from the pop-up menu.

Creating activity final node

To create an activity final node, move the mouse over a shape and press its resource icon Control Flow -> Activity Final Node.

Create activity final node

Drawing interaction overview diagrams P. 194

Drag it to your preferred place and then release the mouse button. An activity final node is created and connected to the shape you selected with a
control flow.

Activity final node and control flow created

If you want to show the caption of activity final node, right click on the diagram background and select Presentation Options > Show Shape Caption
> Activity Final Node from the pop-up menu.
Continue to complete the diagram.

Completed diagram

Drawing interaction overview diagrams P. 195

Drawing class diagrams
A class diagram shows the objects that are required and the relationships between them. Since it provides detailed information about the properties
and interfaces of the classes, it can be considered as the main model and regard the other diagrams as supplementary models.

Creating class diagram

Right click Class Diagram on Diagram Navigator and select New Class Diagram from the pop-up menu to create a class diagram.

Create class diagram

Creating class
To create class, click Class on the diagram toolbar and then click on the diagram.

Create class

A class will be created.

Class created

Creating association
To create association from class, click the Association -> Class resource beside it and drag.

Create association

Drag to empty space of the diagram to create a new class, or drag to an existing class to connect to it. Release the mouse button to create the
association.

Association created

Drawing class diagrams P. 196

To create aggregation, use the Aggregation -> Class resource instead.

Create aggregation

To edit multiplicity of an association end, right-click near the association end, select Multiplicity from the popup menu and then select a multiplicity.

Edit multiplicity

To show the direction of an association, right click on it and select Presentation Options > Show Direction from the pop-up menu.

Show direction

Drawing class diagrams P. 197

The direction arrow is shown beside the association.

Direction shown

Creating generalization
To create generalization from class, click the Generalization -> Class resource beside it and drag.

Create generalization

Drag to empty space of the diagram to create a new class, or drag to an existing class to connect to it. Release the mouse button to create the
generalization.

Generalization created

Creating attribute
To create attribute, right click the class and select Add > Attribute from the pop-up menu.

Create attribute

An attribute is created.

Attribute created

Creating attribute with enter key

After creating an attribute, press the Enter key, another attribute will be created. This method lets you create multiple attributes quickly and easily.

Create attribute with Enter key

Drawing class diagrams P. 198

Creating operation
To create operation, right click the class and select Add > Operation from the pop-up menu.

Create operation

An operation is created.

Operation created

Similar to creating attribute, you can press the Enter key to create multiple operations continuously.

Drag-and-Drop reordering, copying and moving of class members

To reorder a class member, select it and drag within the compartment, you will see a thick black line appears indicating where the class member will be
placed.

Reorder class member

Release the mouse button, the class member will be reordered.

Class member reordered

To copy a class member, select it and drag to the target class while keep pressing the Ctrl key, you will see a thick black line appears indicating where
the class member will be placed. A plus sign is shown beside the mouse cursor indicating this is a copy action.

Copy class member

Release the mouse button, the class member will be copied.

Class member copied

Drawing class diagrams P. 199

To move a class member, select it and drag to the target class, you will see a thick black line appears indicating where the class member will be
placed. Unlike copy, do not press the Ctrl key when drag, the mouse cursor without the plus sign indicates this is a move action.

Move class member

Release the mouse button, the class member will be moved.

Class member moved

Model name completion for class

The model name completion feature enables quick creation of multiple views for the same class model. When create or rename class, the list of
classes is shown.

Model name completion

Type text to filter classes in the list.

List filtered by typed text

Press up or down key to select class in the list, press Enter to confirm. Upon selecting an existing class, all class members and relationships are shown
immediately.

Multiple views of the same model

Drawing class diagrams P. 200

Continue to complete the diagram.

Completed diagram

Generalization set
A generalization set defines a particular set of generalization relationships that describe the way
in which a general classifier (or superclass) may be divided using specific subtypes. To define a generalization set, select the generalizations to
include, right click and select Generalization set > Create Generalization Set... from the popup menu.

Create a generalization set

Drawing class diagrams P. 201

Name the set in the Manage Generalization Sets dialog box, and confirm by pressing OK.

Name the generalization set

The selected generalizations are grouped. Adjust the connector to make the diagram tidy.

Adjust connector

Repeat the steps for other generalizations.

Generalization sets defined

Drawing class diagrams P. 202

Defining delegate method for class
When project's programming language is set to be Visual Basic or C#, it is possible to define delegate method for classes. To define delete method,
right click on the class and select Stereotypes > Delegate from the pop-up menu.

Stereotype class as Delegate

Hiding (and showing) attributes and operations

Per workspace
This applies to new classes that will be created in a project opened in specific workspace. To change the setting:
1. Select Tools > Options from the main menu to open the Options dialog box.
2. Click Diagramming on the list.
3. Open the Class tab.
4. Click Presentation tab.
5. Change the settings for Show attribute option and/or Show operation option.

Show or hide operations

Per diagram
This applies to classes in specific diagram. To change the setting:
1. Right click on the class diagram to set the option.
2. Select Presentation Options > Attribute Display Options / Operation Display Options from the pop-up menu.

Drawing class diagrams P. 203

3. Select Hide All / Show All / Show Public Only.

Change the operations' presentation options for classes in diagram

Per class
This applies to specific class. To change the setting:
1. Right click on the class to set the option.
2. Select Presentation Options > Attributes / Operations from the popup menu.
3. Select Hide All / Show All / Show Public Only.

Change the operations' presentation options for a class

For specific attribute/operation

Instead of showing or hiding all members or public members, you may show/hide specific class member per class. To do this:
1. Right click on the class to set the option.

Drawing class diagrams P. 204

2. Select Presentation Options > Attributes / Operations > Customized... from the pop-up menu.

Show or hide specific class member

3. Select Customized under the drop down menu of Show.

Select Customized in dialog box

Drawing class diagrams P. 205

4. Select the member(s) to hide and click > to hide them.

Select attributes to hide

5. Click OK button to confirm.

Setting initial (default) value for attribute

Initial value can be set to an attribute, indicating the default value of the attribute when the owning object is instantiated. You can give a text value for
initial value, or select an attribute of another class. To set initial value to an attribute:
1. Open the specification dialog box of attribute by right clicking on the attribute and selecting Open Specification... from the popup menu.

Opening the attribute specification

Drawing class diagrams P. 206

2. In the General page of the specification dialog box, enter the initial value in initial value field if it is a text value, or popup the drop down menu to
select a public and static field of any class to be the value.

Selecting an initial value

NOTE: In order to select the attribute of another class to be the default value, make sure the attribute you want to select is static (i.e. set to be in
classifier scope) and is public (so that other classes can access).

3. Click OK to confirm.

Drawing class diagrams P. 207

Drawing object diagrams
Object diagram shows a snapshot of instances of things in class diagram. Similar to class diagram, it shows the static design of system from the real or
prototypical perspective.

Creating object diagram

Right click Object Diagram on Diagram Navigator and select New Object Diagram from the pop-up menu to create an object diagram.

Create object diagram

Creating instance specification

To create instance specification, click Instance Specification on the diagram toolbar and then click on the diagram.

Create instance specification

An instance specification will be created.

Instance specification created

Selecting classifiers
To specify classifiers for an instance specification, right-click it and select Select Classifier > Select Classifier... from the pop-up menu.

Select classifier

Drawing object diagrams P. 208

When the Instance Specification Specification dialog box pops out, the Classifiers tab is opened by default. Select the classifier on the left and click
Add Selected button to add it.

Add selected classifiers

Click OK button to close the specification dialog box. The selected classifiers are assigned to the instance specification.

Classifiers assigned

Defining slots
To define slots for an instance specification, right-click it and select Slots. .. from the pop-up menu.

Defining slots

Drawing object diagrams P. 209

The Instance Specification Specification dialog box appears with the Slots tab selected. Select the features that you want to define slots on the left
and click Define Slot.

Select features to define slots

Select a slot in Defined slots and click Edit Values... button.

Edit values of slot

Drawing object diagrams P. 210

The Slot Specification dialog box pops out, the Values tab is opened by default. Click Add button and select Text from the pop-up menu.

Add text value

Enter the value when prompted. Close the specification dialog boxes to apply the changes, defined slots will be shown in the instance specification.

Defined slots shown

Creating link
To create link from instance specification, click the Link -> Instance Specification resource beside it and drag.

Create link

Drag to empty space of the diagram to create a new instance specification, or drag to an existing instance specification to connect to it. Release the
mouse button to create the link.

Link created

Drawing object diagrams P. 211

Continue to complete the diagram.

Completed diagram

Drawing object diagrams P. 212

Drawing package diagrams
Package diagram shows the arrangement and organization of model elements in middle to large scale project. It can show both structure and
dependencies between sub-systems or modules.

Creating package diagram

Right click Package Diagram on Diagram Navigator and select New Package Diagram from the pop-up menu to create a package diagram.

Create package diagram

Creating package
To create package, click Package on the diagram toolbar and then click on the diagram.

Create package

A package will be created.

Package created

Assigning stereotypes
Right click on the package and select Stereotypes > Stereotypes... from the pop-up menu.

Assign stereotypes

When the Package Specification dialog box pops out, the Stereotypes tab is opened by default. The list on the left shows the selectable stereotypes.

Drawing package diagrams P. 213

If the stereotype you want to use is not on the list, click Edit Stereotypes... button.

Edit stereotypes

Click Add... button in the Configure Stereotypes dialog box.

Add stereotype

Drawing package diagrams P. 214

Enter name for the new stereotype (e.g. facade). Click OK button in Stereotype Specification dialog box and the Configure Stereotypes dialog box.
You will see the added stereotype appears on the list in Package Specification dialog box. Select it and click Add Selected button. Next, click OK
button to proceed.

Add selected stereotypes

Close the specification dialog box. Stereotypes will be applied to the package.

Stereotypes assigned

Continue to complete the diagram.

Completed diagram

Drawing package diagrams P. 215

Drawing composite structure diagrams
Composite structure diagram visualizes the internal structure of a class or collaboration. It is a kind of component diagram mainly used in modeling a
system at micro point-of-view.

Creating composite structure diagram

Right click Composite Structure Diagram on Diagram Navigator and select New Composite Structure Diagram from the pop-up menu to create a
composite structure diagram.

Create composite structure diagram

Creating class
To create class, click Class on the diagram toolbar and then click on the diagram.

Create class

A class will be created.

Class created

Creating part
To create part, move the mouse over the target class, press its resource icon New Part.

Create part

A part will be created.

Part created

Creating port
To create port, move the mouse over the target class, press its resource icon New Port.

Create port

Drawing composite structure diagrams P. 216

A port will be created.

Port created

Specifying type of port

Right-click the port and select Open Specification... from the pop-up menu. The Port Specification dialog box appears.
Click the combo box of Type and select a class.

Select type

Click OK button to apply the changes. Type will be shown on the caption of the port.

Type shown on port

Creating connector
To create connector, click Connector on the diagram toolbar.

Create connector

Drag from the source shape, move the mouse over the target shape and then release the mouse button to create the connector.

Connector created

Drawing composite structure diagrams P. 217

Continue to complete the diagram.

Completed diagram

Drawing composite structure diagrams P. 218

Drawing component diagrams
Component diagram shows the physical aspect of an object-oriented software system. It illustrates the architectures of the software components and
dependencies between them.

Creating component diagram

Right click Component Diagram on Diagram Navigator and select New Component Diagram from the pop-up menu to create a component
diagram.

Create component diagram

Creating component
To create component, click Component on the diagram toolbar and then click on the diagram.

Create component

A component will be created.

Component created

Assigning stereotypes
Right click on the package and select Stereotypes > Stereotypes... from the pop-up menu.

Assigning stereotypes

Drawing component diagrams P. 219

When the Component Specification dialog box pops out, the Stereotypes tab is opened by default. The list on the left shows the selectable
stereotypes.
If the stereotype you want to use is not on the list, click Edit Stereotypes... button.

Edit stereotypes

Click Add... button in the Configure Stereotypes dialog box.

Add stereotype

Drawing component diagrams P. 220

Name the stereotype (e.g. application) in the Stereotype Specification dialog box and then click OK button to close it. Click OK button in the
Configure Stereotypes dialog box. The added stereotype will then be shown on the list in the Component Specification dialog box. Select it and
click Add Selected button. Finally, click OK button to confirm.

Add selected stereotypes

Close the specification dialog box. Stereotypes will be applied to the package.

Stereotypes assigned

Creating provided interface

To create provided interface for a component, move the mouse over the target component and press its resource icon Realization -> Interface.

Create provided interface

Drag it to your preferred place to create a new interface, or drag to an existing interface to connect to it. Release the mouse button to create the
required interface.

Provided interface created

Creating required interface

To create required interface for a component, move the mouse over the target component and press its resource icon Usage-> Interface.

Create required interface

Drawing component diagrams P. 221

Drag it to your preferred place to create a new interface, or drag to an existing interface to connect to it. Release the mouse button to create the
required interface.

Required interface created

Creating dependency
To create dependency, click Dependency on the diagram toolbar.

Create dependency

Drag from the source shape, move the mouse over the target shape and then release the mouse button to create the dependency.

Dependency created

Continue to complete the diagram

Completed diagram

Drawing component diagrams P. 222

Drawing deployment diagrams
Deployment diagram shows the physical aspects of an object-oriented system. It also shows the configuration of run time processing nodes and
artifacts.

Creating deployment diagram

Right click Deployment Diagram on Diagram Navigator and select New Deployment Diagram from the pop-up menu to create a deployment
diagram.

Create deployment diagram

Creating node model element

To create node model element, right click on the background of Model Explorer and select Model Element > New Model Element from the pop-up
menu.

Create model element

In the New Model Element dialog box, type Node (Deployment) in Model element type, type the node name in Model element name. Click OK to
confirm.

Create node

Drawing deployment diagrams P. 223

A node model element will be created.

Node created

Creating instance of node

To create instance of node, click Instance Specification on the diagram toolbar and then click on the diagram.

Create instance specification

An instance specification will be created.

Instance specification created

Selecting classifiers
To specify classifiers for an instance specification, right-click it and select Select Classifier > Select Classifier... from the pop-up menu.

Select classifier

Drawing deployment diagrams P. 224

When the Instance Specification Specification dialog box pops out, the Classifiers tab is opened by default. Select the classifier(s) on the left and
click Add Selected button to add them.

Add selected classifiers

Click OK button to close the specification dialog box. The selected classifiers are assigned to the instance specification.

Classifiers assigned

Creating link
To create link from instance specification, move the mouse over the target shape and press its resource icon Link -> Instance Specification.

Create link

Drag to empty space of the diagram to create a new instance specification, or drag to an existing instance specification to connect to it. Release the
mouse button to create the link.

Link created

Creating instance of component

Similar to creating instance of node, you first create a component model element, and then create an instance specification, but this time assigns a
component to the instance specification as classifier. After that the instance specification will be displayed as a component.

Instance of component

Drawing deployment diagrams P. 225

Creating dependency
To create dependency, click Dependency on the diagram toolbar.

Create dependency

Drag from the source shape, move the mouse over the target shape and then release the mouse button to create the dependency.

Dependency created

Continue to complete the diagram.

Completed diagram

Drawing deployment diagrams P. 226

Modeling and documenting test cases
Produce test case from requirement
1. In a requirement diagram, move the mouse cursor over the requirement that we want to produce Test Case.

Moving mouse cursor over requirement

2. Press on the Verify <- Test Case resource of requirement and drag.

Create test case through the resource centric interface

3. Release the mouse button to create a test case. Name it.

Test case is created

Creating test case and link to requirement

1. In a requirement diagram, click the Test Case button on the diagram toolbar and then click on the diagram.

Create Test Case

2. Press on the Verify -> Requirement resource of test case and drag.

Linking Requirement with Test Case

Modeling and documenting test cases P. 227

3. Move the mouse over a requirement and then release the mouse button, a Verify relationship will be created from the test case to the
requirement.

Verify relationship created

Documenting test case

1. Right click on a test case and select Open Specification... from the popup.

Open specification of test case

2. In the Test Plans tab, fill in the Steps, Procedures and Expected Results.

Test Plan filled

Modeling and documenting test cases P. 228

Drawing requirement diagrams
Creating requirement diagram
To create requirement diagram, right click Requirement Diagram on Diagram Navigator and select New Requirement Diagram from the pop-up
menu.

Create new requirement diagram

Creating requirement
To create a Requirement, click the Requirement button on the diagram toolbar and then click on the diagram.

Create requirement

Decomposing requirement
To decompose a Requirement, click the Containment -> Requirement resource and drag.

Decomposing Requirement

Creating requirement diagram P. 229

Move the mouse over empty space of the diagram and then release the mouse button, a Requirement together with a Containment relationship will be
created.

Requirement and Containment created

Inline editing requirement properties

To inline edit the property of a Requirement (e.g. ID), double-click on the property, enter new value and press Enter to confirm.

Inline editing Requirement properties

Edit requirement properties with specification dialog box

You can also open specification dialog box of a Requirement to edit its properties. Click Open Specification resource of the Requirement.

Open specification of Requirement

Creating requirement diagram P. 230

The Requirement Specification dialog box shows. Edit the properties and click OK button to apply the changes.

Requirement Specification

Creating test case and link to requirement

To create a Test Case, click the Test Case button on the diagram toolbar and then click on the diagram.

Create test case

Click Verify -> Requirement resource of Test Case and drag.

Linking Requirement with Test Case

Move the mouse over a Requirement and then release the mouse button, a Verify relationship will be created from the Test Case to the Requirement.

Verify relationship created

Creating requirement diagram P. 231

Defining your own set of requirement types
Users can record and present requirements as boxes visually through requirement modeling. The name of requirements summarizes the requirement
while a set of attributes defines the requirement. The default requirement box allows users to specify general attributes, such as ID, source, kind, verify
method, risk and status. Moreover, you are allowed to customize your own requirement types that contain attributes related to your domain.

Creating new requirement type

Before creating new Requirement type, create a new requirement diagram or open your target requirement diagram where you want to customize your
our own requirement types. Select Tools > Configure Requirements... from the main menu.

Configure Requirements

The Configure Requirements dialog box appears. Click Add to add a new requirement type.

Configure Requirements dialog box

Enter name of the Requirement type in Name field.

Enter name for Requirement type

Customizing requirement types P. 232

Add attributes for the requirement type to make it meaningful. Click Add button below the attribute table and select an attribute.

Add documentation attribute

Name the newly created attribute. Create as much as attribute you need by following the previous step.
NOTE: If you select Enumeration Attribute from the drop-down menu, Edit Enumeration... button will appear. Click Edit Enumeration... button
to edit it.
Besides defining attributes, you can format the requirement type with fill, line and font. Click the ... button of Fill if you want to customize a color for the
requirement type.

Customize color for requirement type

NOTE: Click the ... button of Line if you want to customize its line property while click the ... button of Font if you want to customize its font
property.

Customizing requirement types P. 233

Once you finish configuring requirement types, click OK button to return to your target requirement diagram.

Finished configuring

Finally, you can see the customized requirement type is available on the diagram toolbar. You can select and click it on the diagram to create the
shape.

The customized requirement type

Customizing requirement types P. 234

Managing requirements with requirements grid
Requirements Grid is a table with requirements listed in it. It enables you to access all requirements in a project or diagram, lookup requirements by
criteria and create requirements.

Creating the requirements grid

Select Requirement > Requirement Grid from the toolbar.

Open Requirement Grid

The overview of requirements grid

The requirements grid

Field Description

Click this button to reveal Name and Model Element. To hide these them, click this button again.

Create a new requirement.

To find a requirement by providing its name or documentation.

Requirements grid P. 235

To open the specification of requirement selected in grid.

To show the view(s) of requirement selected in grid.

To visualize a requirement selected in grid.

To filter requirements by selecting the diagram(s) (or all diagrams) that contain the requirements.

Add/ remove property column(s) in Term list.

To update the display on the Term list.

To filter requirements by name. The rubber on the right hand side is for clearing the filter content.

The fields in requirements grid

Creating requirement
1.
Click on above the grid.

Create a requirement

2. Name the requirement. You may optionally reset the ID by double-clicking on the ID cell and entering a new one.

Name requirement

NOTE: The requirements created in requirements grid are automatically put under the Requirements model. You may move to another model
through dragging and dropping in Model Explorer.

Visualizing a requirement
You can form a diagram with requirement, or show it in an existing diagram by visualizing it in requirements grid. To visualize a requirement:
1. Select the requirement to visualize.

Select a requirement to visualize

2.
Click on above the grid.

Create visualize

Requirements grid P. 236

3. If you want to visualize requirement in a new diagram, keep Create new diagram selected, select the type of diagram to create and specifying
the diagram name.

Name a new diagram

If you want to visualize requirement in an existing diagram, select Show in existing diagram and select a diagram in the diagram list.

Select an existing requirement diagram to visualize the requirement

4. Click Create button at the bottom of the dialog box.

Requirements grid P. 237

Filtering requirements
By filtering requirements, requirements that do not match the required naming convention are filtered. To filter, enter the name of requirement, or part
of its name at the top right of grid. You can make use of the asterisk (*) character to represent any character(s).

Filter requirement by name

Finding requirement
To find out requirements that match specific naming or documentation pattern:
1.
Click above the grid.

Find a requirement

2. In the Search Text text box, enter the text to search.

Enter requirement name and check Name

3. Click Find. As a result, the matched requirement(s) will be highlighted in grid.

Finding result

Requirements grid P. 238

Recording requirements
Before you start business process modeling, you usually need to talk to the customers or meet them to know what they need, and to familiarize
yourself with their company's operations as well as their problems. During the meeting you can collect useful information from customer, which include
the conversation log, documents. You can make use of textual analysis, a text-based editor, to help record those textual information. In addition to a
plain text editor, you can identify important terms or objects (e.g. class, use case) from the problem description.

Creating textual analysis

To create textual analysis, right click Textual Analysis on Diagram Navigator and select New Textual Analysis from the pop-up menu.

Create a textual analysis

Entering problem statement

Three ways of entering problem statement are provided in VP-UML.
• Typing on the editor
• Importing an external text file
• Copying and pasting from an external source
To type in the editor, type the problem statement directly on the editor.
To import a text file, click Import Text File on the toolbar.

Import text file

When the Open dialog box pops out, select a text file to import. As a result, the imported problem statement will be shown on the text area.

Recording requirements P. 239

To copy and paste from an external source, press Ctrl + C on the selected text and press Ctrl + V for pasting it on the editor.

Completed problem statement

Recording requirements P. 240

Identifying important terms
In textual analysis, you identify important terms by adding them to glossary, and clarify them by defining aliases and entering documentation.
1. Highlight the specific term on the left hand side editor, right click on it and select Add [the highlighted term] to Glossary from the pop-up
menu.

Add "OTV" to Glossary

2. When the Glossary Grid page unfolds, enter name for the glossary grid and then right click on the newly created term and select Open Term
Editor from the pop-up menu.

Right click to open term editor

3. In the Term Editor page, open Definition tab.

4. You can define aliases for the term and enter documentation as definition for the term. To insert an alias, click Add button to type the alias in the
pop-up Input dialog box. To enter the definition of the term, enter under Definition directly.

Define aliases and enter definition

Identifying important terms P. 241

5. As a result, the columns of Aliases and Documentation are filled when you return Glossary Grid page.

Completed glossary grid

NOTE: If the Aliases column is hidden, you can click Configure Columns... button. Open Properties tab and select it under Details folder.

Identifying important terms P. 242

Identifying candidate objects
By studying the problem statement, you can extract words or phrases that are relevant to the system and convert them into model elements, such as
classes, use cases (system goals) and action, etc. Those objects are regarded as candidate objects. You can extract word or phrases from problem
statement to become specific type of candidate objects, and list them next to the editor, at the right hand side.
To create a candidate object, highlight a word/ phrase on the editor, drag it on the right-hand side text field and release the mouse until after it has
reached the right-hand side text field.

Extract words

As soon as a candidate object is created on the right-hand side, all occurrences of the candidate object name are highlighted on the left-hand side.

Candidate object name is highlighted

The candidate object is set as class type by default.

To change the candidate object type, right click on the candidate object and select the preferred model element type from the pop-up menu.

Change candidate object type

Alternatively, you can create a candidate object and select your preferred type of model element simultaneously. Highlight a word/ phrase on the left-
hand side editor, right click to select add text with your preferred type of model element from the pop-up menu.

Create a candidate object with preferred type

As a result, a candidate object with your selected type of model element will be shown on the right-hand side.

Identifying candidate objects P. 243

Writing description for candidate objects
The table on the bottom right of the textual analysis editor allows you to view and edit details of candidate objects. You can edit description of a
candidate object by double clicking on the Class Description cell. Moreover, you may resize its cell to create more spaces by dragging on its bottom
line.

Edit in class description cell

Identifying candidate objects P. 244

Forming diagram from candidate objects
You can form a diagram from candidate objects, or show it in an existing diagram by visualizing it. First, you need to create model element from a
candidate object. To create model element for candidate object, right click on a candidate object and select Create Model Element (the specific type of
model element) from the pop-up menu.

Create a model element

When the Visualize Model Element dialog box pops out, check Create new diagram if you want the model element to be shown on a new diagram or
check Show in existing diagram if you want the model element to be shown on a specific existing diagram. Finally, click the Show button to proceed.

Check an option in Visualize Model Element dialog box

As a result, the model element will be shown on the selected diagram.

Forming diagram from candidate objects P. 245

NOTE: If you have already made a model element for the candidate object, the Create Model Element option will be hidden even after you right
click on it.

Forming diagram from candidate objects P. 246

Drawing CRC card diagram
Class-Responsibility Collaborator (CRC) card visualize classes in card-like presentation. Each CRC card contains information like the description of
class, its attributes and responsibility. A CRC card diagram is a holder of these cards.

Creating CRC card diagram

To create a CRC Card diagram, right click on CRC Card Diagram in Diagram Navigator and select New CRC Card Diagram from the pop-up menu.

Create CRC card diagram

Creating CRC card

Click CRC Card on the diagram toolbar and then click on the diagram to create a CRC card. You can create as many as CRC card on a diagram by
repeating this step.

Create CRC card

Editing CRC card properties

All properties in a CRC card must be edited inline. To edit, double click on the desired field, update its value, and click on the diagram background to
confirm editing.

Edit description

Drawing CRC card diagram P. 247

Adding attributes
Right-click on the Attributes heading and select Add > Attribute from the pop-up menu.

Add attribute

Enter the name and description. Repeat this step until all attributes are added.

Attribute added

Adding responsibilities
Right-click on the Responsibilities heading and select Add > Responsibility from the pop-up menu. Similar to creating an attribute, enter the name
and collaborator of each responsibility to show the relationship with other parties.

Add responsibility

Drawing CRC card diagram P. 248

Creating user interface diagram
You can design the graphical user interface of your application or system by using user interface diagram. The diagram toolbar of User Interface
provides you with common GUI components like frame, text fields, labels, buttons, etc. You can select appropriate components and drag them to
diagram to construct the GUI. You can also change the appearance of user interface by modifying GUI components' properties.
To create a user interface diagram:
1. Right click on User Interface and select New User Interface from the pop-up menu on Diagram Navigator.

Create a User Interface diagram through Diagram Navigator

NOTE: Alternatively, you can create a User Interface diagram with the steps below:
• Select New Diagram > Others > User Interface from the main menu.
• Click on the New User Interface button under Diagramsicon on toolbar
• Click on New User Interface in Start Page

2. Name your screen design by filling in the diagram name.

Enter the diagram name

3. Press Enter to confirm the diagram name. As a result, the name for User Interface diagram is created.

A User Interface diagram is created

Creating user interface diagram P. 249

Frame
A Frame is a top-level window with a title and a border. The size of the frame includes any area designated for the border. User can add components
on a frame.

Creating a frame
1. Select the Frame tool from the diagram toolbar.

Select Frame

2. Press on diagram to set the position of the frame. Drag diagonally from the starting point to expand the frame.

Drag diagonally to expand the frame

3. Release the mouse button to confirm the size of frame.

4. Enter the frame title and press Enter to confirm.

A frame is created

Frame properties
The appearance of frame can be changed by editing its properties. To configure a frame, right click on the Frame and select Open Specification...
from the popup menu. The UI tab is where user can configure a frame.

Property Description

Title Title refers to the text that appear at the top of frame, which use to be the caption of application or the function of opening frame.

Icon Icon is the tiny image that appear at the top left of frame. Users are required to provide a valid image file as icon.

Iconifiable The Iconifiable state controls whether the minimize button is shown or not. When Iconifiable is set, the minimize button is shown,
otherwise hidden.

MaximizableThe Maximizable state controls whether the maximize button is shown or not. When Maximizable is set, the maximize button is shown,
otherwise hidden.

Closable The Closable state controls whether the close button is shown or not. When Closable is set, the close button is shown, otherwise
hidden.

Description of frame properties

Frame P. 250
Label
A label is a text component that appears on a screen. The text "User", "Password", "Address" appear on a registration form are examples of labels.

Creating a label
1. Select the Label tool from the diagram toolbar.

Select Label from

diagram toolbar

2. Click on a container (e.g. a Frame) or diagram background to create a label.

3. Enter the label caption and press Enter to confirm the caption of label.

A label is created

Label properties
The appearance of label can be changed by editing its properties. To configure a label, right click on the label and select Open Specification... from
the popup menu. The UI tab is where user can configure a label.

Property Description

Caption Caption is the text appear in a label.

Mnemonic
Mnemonic is a key which enables users to select a label by simultaneously pressing the Alt key and the mnemonic key on the keyboard.

Description of label properties

Label P. 251
Text field
Text Field is a component that allows the editing of a single line of text. Fields in a registration form are typical examples of text fields.

Creating a text field

1. Select the Text Field tool from the diagram toolbar.

Selecting Text Field

from diagram toolbar

2. Press to set the position of the text field. Drag diagonally from the starting point to expand the text field.

Drag diagonally to expand the text field

3. Release the mouse button to confirm the size of text field.

4. Enter the text field text and press Enter to confirm the title of text field.

A text field is created

Text field properties

The appearance of text field can be changed by editing its properties. To configure a text field, right click on the text field and select Open
Specification... from the popup menu. The UI tab is where user can configure a text field.

Property Description

Text Text refers to the text that appears in the text field.

Description of text field properties

Text field P. 252

Scrollbar
A scrollbar is a bar with a knob which appears at the bottom or right of a container, such as a frame. The user positions the knob in the scrollbar
to determine the contents of the viewing area. The program typically adjusts the display so that the end of the scrollbar represents the end of the
displayable contents, or 100% of the contents. The start of the scrollbar is the beginning of the displayable contents, or 0%. The position of the knob
within those bounds then translates to the corresponding percentage of the displayable contents.

Creating a scrollbar
1. Select the Horizontal/Vertical Scrollbar tool from the diagram toolbar. You can change between a horizontal or a vertical scrollbar tool by
clicking on the tiny reverted triange, and selecting the preferred type of scrollbar from the popup menu.

Select Horizontal Scrollbar

from diagram toolbar

2. Click on a container (e.g. a Frame) or diagram background to create a scrollbar. If you create inside a container, and if it has no scrollbar with
same orientation exists, the scrollbar will be docked to the bottom or the right of the container, depending on the scrollbar orientation.

Scrollbar is created

Change orientation with resource-Centric interface

A scrollbar can be oriented horizontally or vertically, which determines the contents of the viewing area when being scrolled. User can change the
orientation of a scrollbar easily through the resource-centric interface. When a scrollbar is put inside a container, changing orientation will automatically
dock to the bottom or the right of container. To change scrollbar orientation:
1. Move the mouse over the scrollbar.
2. Click on the resource icon Switch Orientation.

Click on the resource icon for switching Scrollbar Orientation

3. The orientation of scrollbar will then be switched.

Scrollbar Orientation switched from horizontal to vertical

Automatic sticking scrollbar to frame

In a normal User Interface design, scrollbars, no matter horizontal or vertical, are placed at the bottom or on the right of a container component. VP-
UML follows this practice. When creating a scrollbar in a container component, or when moving a scrollbar into a container component, the scrollbar
will be docked to the border of component automatically.

Scrollbar P. 253
Scrollbar properties
The appearance of scrollbar can be changed by editing its properties. To configure a scrollbar, right click on the scrollbar and select Open
Specification... from the popup menu. The UI tab is where user can configure a scrollbar.

Property Description

Orientation It indicates if the scroll bar is vertical or horizontal.

Block Amount the value changes when the scrollbar track is clicked on either side of the knob.
increment

Unit increment Amount the value changes when the end arrows of the scrollbar are clicked.

Minimum The minimum value of scrollbar.

Maximum The maximum value of scrollbar.

Value Value which controls the location of the scroll bar knob.

Description of scrollbar properties

Scrollbar P. 254
Combo box
Combo box is a component that combines a button and a drop-down list. The user can select a value from the drop-down list, which appears at the
user's request.

Creating a combo box

1. Select the Combo Box tool from the diagram toolbar.

Selecting Combo Box

from diagram toolbar

2. Click to set the position of the combo box. Drag diagonally from the starting point to expand the combo box.

Drag diagonally to expand the Combo box

3. Release the mouse button to confirm the size of combo box.

Combo box is created

Editing combo box values

1. Right click on the combo box and select Open Specification... from the popup menu.
2. In the UI tab of the UIComboBox Specification dialog box, click Add.
3. Enter the value for of item in Input dialog box and click OK to confirm.
4. Repeat step 2 and 3 to create all the combo box items.

Combo box items are created

5. Click OK to confirm editing.

Combo box P. 255

Combo box properties
The appearance of combo box can be changed by editing its properties. To configure a combo box, right click on the combo box and select Open
Specification... from the popup menu. The UI tab is where user can configure a combo box.

Property Description

Items The items that can be selected by users.

Selected The default selected item.

item

Description of combo box properties

Combo box P. 256

List
List is a component that list out all available selection in rows, and allow the selection of values in it.

Creating a list
1. Select the List tool from the diagram toolbar.

Selecting List from

diagram toolbar

2. Press to set the position of the list. Drag diagonally from the starting point to expand the list.

Drag diagonally to expand the List

3. Release the mouse button to confirm the size of list.

List is created

Editing list values

1. Right click on the list and select Open Specification... from the popup menu.
2. In the UI tab of the List specification dialog box, click Add.
3. Enter the value for of item in Input dialog box and click OK to confirm.

List P. 257
4. Repeat step 2 and 3 to create all the list items.

List items are created

5. Click OK to confirm editing.

List properties
The appearance of list can be changed by editing its properties. To configure a list, right click on the list and select Open Specification... from the
popup menu. The UI tab is where user can configure a list.

Property Description

Values The items that can be selected by user.

Selected value The default selected item in the list.

Horizontal scroll bar Determines when a horizontal scrollbar will appear in a list.

Vertical scroll bar Determines when a vertical scrollbar will appear in a list.

Description of list properties

List P. 258
Table
Table is used to display and edit regular two-dimensional tables of cells.

Creating a table
1. Select Table from the diagram toolbar.

Select Table from

diagram toolbar

2. Press to set the position of the table. Drag diagonally from the starting point to expand the table.

Drag diagonally to expand the Table

3. Release the mouse button to confirm the size of table.

Table is created

Editing table contents

Basic setup
To insert columns and rows into a table:
1. Right click on the table and select Open Specification... from the popup menu.

Table P. 259
2. In the UI tab of the UITable Specification dialog box, click either Insert Column to Left or Insert Column to Right to insert the first column.

Insert a column into table

3. Enter the column name in Input dialog box and click OK to confirm.
4. Repeat step 2 and 3 to create all columns.
5. Click Insert Row Below to insert a row. Note that a row can be inserted only when a column exists.

Insert a row into table

6. A row is created with empty cell(s). Fill in the cell(s) if necessary. Cell can be edited by double clicking or by pressing the F2 key.
7. Repeat step 5 and 6 to create all rows.

Table P. 260
8. Click OK to confirm editing.

Table with data

Removing a column
To remove a column in a table, open UITable Specification dialog box, open the UI tab, right click on a cell of a column and select Remove Column
in the pop-up menu.

To remove a column in table

Table P. 261
Removing a row
To remove a row in a table, open UITable Specification dialog box, open the UI tab, right click on a row and select Remove Row in the pop-up menu.

To remove a row in table

Reordering rows
To reorder rows, open UITable Specification dialog box, open the UI tab,select the row(s) to reorder, and click on the Move Selected Rows Up or
Move Selected Rows Down button.

Moving a row in table upwards

Table P. 262
Table properties
The appearance of table can be changed by editing its properties. To configure a table, right click on the table and select Open Specification... from
the pop-up menu. The UI tab is where user can configure a table.

Property Description

Row The height of rows in table.

height

Determines when a horizontal scrollbar will appear in a table.

Determines when a vertical scrollbar will appear in a table.

Determines how the widths of columns will be affected when other columns in the table are being resized.
Off: Disable auto resizing.
Next column: When a column is being resized, all columns on the right and left of margin are updated.
Subsequent columns: When a column is being resized, all columns on the right are resized at the same time.
Last column : When a column is being resized, width of the right-most column are updated.
All columns: When a column is being resized, widths of all columns are changed.

Determines the color of grid in table.

Determines the visibility of horizontal lines in table.

Determines the visibility of vertical lines in table.

Description of table properties

Table P. 263
Tree
A Tree is a component that displays a set of hierarchical data as an outline.

Creating a tree
1. Select the Tree tool from the diagram toolbar.

Selecting Tree from

diagram toolbar

2. Press to set the position of the tree. Drag diagonally from the starting point to expand the tree.

Drag diagonally to expand the Tree

3. Release the mouse button to confirm the size of tree.

Tree is created

Editing tree contents

Basic setup
To insert columns and rows into a tree:
1. Right click on the tree and select Open Specification... from the popup menu.

Tree P. 264
2. In the UI tab of the UITree Specification dialog box, click either Insert Node Below or Insert Node Above to insert the first column. Note that
Insert Node Below/Above means to create an adjacent node.

Insert a node into tree

3. Enter the node name in Input dialog box and click OK to confirm.
4. To add a child node, select an existing node.

Tree P. 265
5. Click Add Child Node.

Insert a child node

6. Enter the node name in Input dialog box and click OK to confirm.
7. Repeat step 2 to 6 to create all nodes.
8. Click OK to confirm editing.

Tree P. 266
Removing a node
To remove a node in a tree, open the specification dialog box of the tree, open the UI tab, right click on the node(s) to remove and select Remove
Node in the popup menu.

To remove a node in tree

Tree P. 267
Reordering nodes
To reorder nodes, open the specification dialog box of the tree, open the UI tab, select the node(s) to reorder, and click on the Move Up or Move
Down button.

Moving a node in tree upwards

Tree properties
The appearance of tree can be changed by editing its properties. To configure a tree, right click on the tree and select Open Specification... from the
popup menu. The UI tab is where user can configure a tree.

Property Description

Root visible Determines whether the root of tree will appear.

Show root handles Determines whether the expand/collapse button for root will appear.

Row height The height of nodes in tree.

Horizontal scroll bar Determines when a horizontal scrollbar will appear in a tree.

Vertical scroll bar Determines when a vertical scrollbar will appear in a tree.

Node icons Set the image icon to appear for a node when at different state.
Default node icon: Icon for all nodes when default icon for collapsed and expanded nodes
are not set.
Default collapsed icon: Icon for collapsed nodes. It overwrites the default node icon
setting.
Default expanded icon: Icon for expanded nodes. It overwrites the default node icon
setting.

Description of tree properties

Tree P. 268
Web Label
A web label is a text component that appear on a screen. The text "User", "Password", "Address" appear on a registration form are examples of labels.

Creating a label
1. Select the Web Label tool from the diagram toolbar.

Selecting Web Label

from diagram toolbar

2. Click on a container (e.g. a Web Panel) or diagram background to create a web label.
3. Enter the label caption and press Enter to confirm the caption of label.

A label is created

Label properties
The appearance of web label can be changed by editing its properties. To configure a web label, right click on the label and select Open
Specification... from the popup menu. The UI tab is where user can configure a label.

UIWebLabel Specification's UI tab

Property Description

Text Text is the text appear in a label.

For Specifies which form element a label is bound to.

Description of web label properties

Web Label P. 269

Web Button Input
A web button is a component on a web form which triggers certain action when being clicked. The button "Validate" that appear on a registration form is
an example of web button.

Creating a web button

1. Select the Web Button Input tool from the diagram toolbar.

Selecting Web Button

Input from diagram toolbar

2. Click on a container (e.g. a web panel) or diagram background to create a button.

3. Enter the button caption and press Enter to confirm the caption of button. This creates the button.

A button is created

Web button input properties

The appearance of web button can be changed by editing its properties. To configure a button, right click on the button and select Open
Specification... from the popup menu. The UI tab is where user can configure a button.

UIWebButtonInput Specification's UI tab

Property Description

ID ID is the ID of web button.

Value Value is the text appear on a web button input.

Description of web button properties

Web Button Input P. 270

Web Text Input
Web Text Input is a component that allows the editing of a single line of text. Editable text fields in a registration form are typical examples of text
inputs.

Creating a web text input

1. Select the Web Text Input tool from the diagram toolbar.

Selecting Web Text Input

from diagram toolbar

2. Press to set the position of the text input. Drag diagonally from the starting point to expand the text input.

Drag diagonally to expand the text input

3. Release the mouse button to confirm the size of text input.

4. Enter the text input text and press Enter to confirm the title of text input.

A text input is created

Text input properties

The appearance of text input can be changed by editing its properties. To configure a text input, right click on the text input and select Open
Specification... from the popup menu. The UI tab is where user can configure a text input.

UIWeb TextInput Specification's UI tab

Property Description

ID ID refers to the ID of text input on a form.

Value Value refers to the text that appears in the text input.

Description of web text input properties

Web Text Input P. 271

Web Combo Box
Web Combo box is a component that combines a button and a drop-down list. User can select a value from the drop-down list to make a decision.

Creating a web combo box

1. Select the Web Combo Box tool from the diagram toolbar.

Selecting Web Combo

Box from diagram toolbar

2. Press to set the position of the combo box. Drag diagonally from the starting point to expand the combo box.

Drag diagonally to expand the Combo box

3. Release the mouse button to confirm the size of combo box.

Combo box is created

Editing combo box values

1. Right click on the combo box and select Open Specification... from the popup menu.
2. In the UI tab of the UIWebComboBox Specification dialog box, click Add.
3. Enter the value for of item and click OK to confirm.
4. Repeat step 2 and 3 to create all the combo box items.

Combo box items are created

5. Click OK to confirm editing.

Web Combo Box P. 272

Combo box properties
The appearance of web combo box can be changed by editing its properties. To configure a combo box, right click on the combo box and select Open
Specification... from the popup menu. The UI tab is where user can configure a combo box.

UIWebComboBox Specification's UI tab

Property Description

ID ID of the combo box in web form.

Options The items that can be selected by users. You can optionally mark the default item's Selected to be
true.

Description of web combo box properties

Web Combo Box P. 273

Web List
Web list is a component that lists out all available selection in rows, and allows the selection of values in it.

Creating a list
1. Select the Web List tool from the diagram toolbar.

Selecting Web List

from diagram toolbar

2. Press to set the position of the list. Drag diagonally from the starting point to expand the list.

Drag diagonally to expand the List

3. Release the mouse button to confirm the size of list.

List is created

Editing list values

1. Right click on the list and select Open Specification... from the popup menu.
2. In the UI tab of the UIWebList Specification dialog box, click Add.
3. Enter the value for of item in Input dialog boxand click OK to confirm.
4. Repeat step 2 and 3 to create all the list items.

Web List P. 274

5. Click OK to confirm editing.

List with values

List properties
The appearance of web list can be changed by editing its properties. To configure a list, right click on the list and select Open Specification... from the
popup menu. The UI tab is where user can configure a list.

UIWebList Specification's UI tab

Property Description

ID ID of list in form.

Options The items that can be selected by users. You can optionally mark the default item's Selected to be
true.

Multiple Determine whether the list supports single or multiple item selection.

Description of web list properties

Web List P. 275

Web Password Input
Web Password Input is a component that allows the entering of password. Text entered will be shown as dots, which act as a mask of password.

Creating a web password input

1. Select the Web Password Input tool from the diagram toolbar.

Selecting Web Password

Input from diagram toolbar

2. Press to set the position of the password input. Drag diagonally from the starting point to expand the password input.

Drag diagonally to expand the password input

3. Release the mouse button to confirm the size of password input and press Enter to confirm the title of password input.

A password input is created

Password input properties

The appearance of password input can be changed by editing its properties. To configure a password input, right click on the password input and
select Open Specification... from the popup menu. The UI tab is where user can configure a password input.

UIWebPasswordInput Specification's UI tab

Property Description

ID ID refers to the ID of password input on a web form.

Web Password Input P. 276

Value Value refers to the underlying password of the password input.

Description of web password properties

Web Password Input P. 277

Web File Input
Web File Input is a component that involve a text field which represent file field, and a Browse button for locating the file to select.

Creating a web file input

1. Select the Web File Input tool from the diagram toolbar.

Selecting Web File Input

from diagram toolbar

2. Press to set the position of the file input. Drag diagonally from the starting point to expand the file input.

Drag diagonally to expand the file input

3. Release the mouse button to confirm the size of file input and press Enter to confirm creation.

A file input is created

Web File Input P. 278

File input properties
The appearance if web file input can be changed by editing its properties. To configure a file input, right click on the file input and select Open
Specification... from the popup menu. The UI tab is where user can configure a file input.

UIWebFileInput Specification's UI tab

Property Description

ID ID refers to the ID of file input on a web form.

Description of web file input properties

Web File Input P. 279

Annotating the UI design with callout shape
Annotation is extra information, such as comments, notes, explanation, or other type of external mark that describes a model. It is an effective way to
edit and review work in a work group environment. Designers often need to be able to jot down information which should not be part of the model itself.
In this situation, annotation helps. For instance, annotation can be added to a User Interface design to specify validation checking.
To annotate a User Interface design:
1. Select Callout from the diagram toolbar. Note that the Callout is under the Common category.

Select Callout from

diagram toolbar

2. Click on the diagram to create a Callout shape. Enter the content of annotation. Formatting can be applied through the buttons at the bar above
the callout shape.

Enter the content of Callout shape

3. We need to attach the pointer of Callout shape to the User Interface component that needs to be annotated. Drag on the end of Callout shape's
pointer towards the User Interface component.
4. Release the mouse button to confirm the pointer position when reached the component.
5. Click on the diagram background to confirm editing.

Using Callout shape to annotate a text field

Annotating the UI design with callout shape P. 280

6. Repeat the above steps to annotate the whole design with Callout shapes.

User Interface diagram with annotations

Annotating the UI design with callout shape P. 281

Identify glossary term
You identify specific terms by adding them to glossary, and clarify them by defining aliases and entering documentation in any textual documents.
1. Highlight the specific term on Documentation editor, right click on it and select Add "[the highlighted term]" to Glossary from the pop-up
menu.

Add "online register" to glossary

2. When the Glossary Grid page is opened, right click on the newly created term and select Open Term Editor from the pop-up menu.

Right click to open term editor

3. In the Term Editor page, open Definition tab.

4. You can define aliases for the term and enter documentation as description for the term. To insert an alias, click Add button and type the alias in
the pop-up Input dialog box. To enter definition, enter under Definition directly.

Define aliases and enter definition

5. As a result, the columns of Aliases and Documentation are filled when you return Glossary Grid page.

Completed glossary grid

Identify term from flow of events

Highlight the specific term on flow of events editor, right click on it and select Add "the highlighted term" to Glossary from the pop-up menu.

Add "online register" to Glossary

Identify glossary term P. 282

Identify term from textual analysis
Highlight the specific term on textual analysis, right click on it and select Add "the highlighted term" to Glossary from the pop-up menu.

Add "archived" to Glossary

Identify glossary term P. 283

Glossary grid
Glossary grid is a table where you can identify specific glossary term. In addition, you can define aliases and enter documentation for the glossary
term. With Visual Paradigm for UML (VP-UML), you can categorize the terms by defining and assigning label(s) to them.

Creating glossary grid

To open a grid diagram, select Requirement > Glossary Grid from the toolbar.

Open Glossary Grid

Overview of glossary grid

Glossary grid

No. Name Description

1 Name You can enter the name of grid in here.

2 Model Element You can select the model element you want to be listed in grid from the drop-dwon menu.

3 Configure Grid Click this button to reveal Name and Model Element. To hide these them, click this button again.

Glossary grid P. 284

4 Create Term (Insert) Click this button to create a new term.

5 Find To search a term/ phrase, click this button. Enter the keyword of your term/ phrase in Search Text text field and check
the searching field: Name, Aliases, Label or Documentation.

6 Open Term Editor Click this button to open Term Editor page of the selected term. In Term Editor page, you can define the term,
stereotypes and tagged values.

7 Open Specification... Click this button to open the specification dialog box of the selected term. In Term Specification dialog box, you can
define aliases, assign label and enter documentation.

8 Export to Excel To save and export the selected term into a new Excel.

9 Import to Excel To import the selected term to an existing Excel.

10 Show View Click this button to show the orginal model element of the selected term.

11 Visualize... Click this button to duplicate the selected model element on the chosen digram (in either new diagram or existing
diagram).

12 Manage Label Label can be defined to categorize terms. This button is for adding, editing and deleting labels.

13 Configure columns... Add/ remove property column(s) in Term list.

14 Fresh To update the display on the Term list.

15 Project To select the scope for showing mdoel elements on Term list.

16 Filter Term To enter the keyword of your target term with *, you can find it in shortcut.

17 Clear filter To clear all words you typed in Filter Term.

18 Term list All created term will be listed in here.

The overview of glossary grid

Organizing terms with labels

With VP-UML, you can categorize the terms by defining and assigning label(s) to them.

Defining label
1. After you have selected a term in any textual documentation to add it to glossary, the glossary grid is opened. Click Manage Label button.

Click Manage Label

Glossary grid P. 285

2. In the pop-up Manage Label dialog box, click Add... button to create a label.

Add a label

3. In the Glossary Label Specification dialog box, name the label and select a color for it. Click OK button to confirm.

Enter name and select a color

4. Click OK button in the Manage Label dialog box.

Assigning label
1. Let's assign a specific label to the corresponding term. Click the small plus button under Labels column of your target term.

Click the small plus button

NOTE: If the Labels column doesn't show on the grid, you can click the Configure columns... button. Open Properties tab and select it under
Others folder..

Glossary grid P. 286

2. In the pop-up Add Label dialog box, check a label and then click OK button.

Check a label

NOTE: You can apply multiple labels to a term. Check the applicable labels in the Add Label dialog box.

3. As a result, a specific label is assigned to the corresponding term.

Membership is assigned to general

Filtering terms with specific label

1. If you want to list terms of specific label, click the combo box of Project and select With Label....

Select With Label...

Glossary grid P. 287

2. In the Scope dialog box, check the specific label you want to be listed and then click OK button.

Check Membership

3. As a result, terms with specific label are listed in the grid.

Terms with Membership label are listed

Exporting glossary to Excel

You can export the glossary, along with its terms into an Excel file, and import it back to share with your teammates.
1. In the Glossary Grid, click Export to Excel button.

Click Export to Excel button

2. In the Export Excel dialog box, enter the output directory. Click Export button.

Enter the output directory

Glossary grid P. 288

3. To import the Excel back to your project for a mass modification or review, select File > Import > Excel... from the main menu.

Import the Excel

Glossary grid P. 289

Creating ArchiMate diagram
ArchiMate is a modeling technique for describing enterprise architectures. It divides architecture into three layers - business layer, application layer
and technology layer. The business layer offers products and services to external customers. The application layer supports business layer and the
technology layer offers infrastructural services for application layer.

A part of a sample ArchiMate diagram

Creating ArchiMate diagram

To create an ArchiMate diagram, right click on ArchiMate Diagram in Diagram Navigator and select New ArchiMate Diagram from the popup menu.

To create an ArchiMate diagram through Diagram Navigator

Notations - Business Layer

Name Representation

Business actor

Business role

Creating ArchiMate diagram in VP-UML P. 290

Business
collaboration

Business process

Business function

Business interaction

Business event

Junction

Business service

Business interface

Business object

Product

Contract

Representation

Meaning

Value

A list of supported notations in ArchiMate diagram, for business layer

Notations - Application Layer

Name Representation

Application collaboration

Application component

Application service

Application function

Application interaction

Creating ArchiMate diagram in VP-UML P. 291

Application interface

Data object

A list of supported notations in ArchiMate diagram, for application layer

Notations - Technology Layer

Name Representation

Node

Device

System software

Infrastructure interface

Infrastructure service

Artifact

Communication path

Network

A list of supported notations in ArchiMate diagram, for technology layer

Changing the appearance of some notations

Some of the ArchiMate notations support different ways of presentation. Take node in technology layer as example, to change to another presentation,
right click on the node and select Presentation Options > Display Option, Show as Box/Symbol from the popup menu.

To change the presentation of a node

Node shown as box or symbol

Creating ArchiMate diagram in VP-UML P. 292

Creating ArchiMate diagram in VP-UML P. 293
Creating grid diagram
VP-UML introduces model element grids to provide a convenient way to model and overview the requirements, use cases and actor within your project.
You can also create a grid to list whatever model element type you like, and customize the properties of model element being shown inside the grid.
To create a grid diagram:
1. Select Diagrams > Grid Diagram from the toolbar.

Click Grid Diagram

2. When the Grid Diagram is opened, enter name for the grid.

Enter grid's name

Creating grid diagram P. 294

3. Select a model element type from the combo box of Model Element.

Select use case

The model element of selected type will then be shown on the grid.

The model element of selected type is shown

Creating grid diagram P. 295

Creating element in grid
Besides creating elements by drawing them on diagram, you can also create them in grid. Creating elements in grid gives you an overview on all
elements of same type.
1. Click on the Create [element] button, where element refers to the type of model element you have chosen in the Model Element's combo box.

Click Create Use Case button

2. Enter name for the newly created model element and then press Enter to confirm.

Enter name

Creating element in grid P. 296

Adding/removing property columns
In grid, rows represent model elements while the columns show their properties. Name and documentation columns are shown by default, in addition,
you can optionally add or remove columns to display the data you are interested in.

Adding extra property column

1. Click Configure Columns... button.

Click Configure Columns... button

2. In the Configure Columns dialog box, select your preferred property under Properties tab and then click OK button.

Select Model Type

As a result, the selected property column is inserted in the grid.

Model Type column is added

Removing property column

1. Click Configure Columns... button.

Adding/removing property columns P. 297

2. In the Configure Columns dialog box, select your undesired property under Selected Columns and then click OK button.

Remove Model Type column

As a result, the deselected property column will be removed from the grid.

Adding/removing property columns P. 298

Setting the scope of grid content
In grid, you can customize the scope of grid content after you have created various types of model elements. After that, your desired model elements
within a particular scope will be shown on the grid.
To set the scope of grid content:
1. Select your desired scope from the combo box of Project.

Select scope

NOTE: Within Model or Package: Select this when you want to show all selected model element types within a particular model/ package.
Root Model Element: Select this when you want to show all selected model element types under root node.
All Diagrams: Select this when you want to show all selected model element types within all diagrams.
Within Diagram: Select this when you want to show all selected model element types within a particular diagram.
No Diagram: Select this when you want to show all selected model elements without diagram.

2. As a result, grid content is updated to list the model elements that fit the selected scope.

Grid content is updated

Setting the scope of grid content P. 299

Filter and find
VP-UML introduces model element grids to provide a convenience way to model and overview the requirements, use cases and actor within your
project. Except creating a grid with your preferred model element type, you can also search your target model element in shortcut through filter and
find.

Filtering
1. Type the word/ phrase in filter.
2. Model element(s) matching the word/ phrase you typed will be shown in the grid subsequently.

Model elements match the word/ phrase you typed

Finding
1. Click Find button.

Click Find button

2. Type the word/ phrase in Search Text and then check either Name or Documentation (or both) . Check Name if you want to search the name
model elements matches the word/ phrase you typed while check Documentation if you want to search the documentation of model elements
matches the word/ phrase you typed. Check both if you want to search the name or the documentation of model elements matches the word/
phrase you typed.

Check Name

3. Click Find button behind Search Text.

Click Find button

Model element(s) matching the word/ phrase you typed will be highlighted in the grid subsequently.

The matched model elements are highlighted

Filter and find P. 300

Drawing entity relationship diagram
ERD, short for entity relationship diagram, is a kind of diagram for presenting the properties as well as the relationships between data or participants.
Database designer use of ERD to model physical structure of a relationship database, while business analyst uses ERD to model the data that is
logically required or produced by processes.

Creating entity relationship diagram

Right click on Entity Relationship Diagram from Diagram Navigator and select New Entity Relationship Diagram from the pop-up menu.

Create entity relationship diagram

Enter the name for the diagram. At the same time, a Data Model selection box appears on the top right corner of the diagram.

Select data model

All model elements created on diagram will follow this Data Model setting. Only Physical Model will be able to generate SQL. Leave it as default
(Physical Model).

Drawing entity
Click Entity from diagram toolbar and drag it on the diagram pane.

Create entity

Click on diagram and specify the entity name.

Rename an entity

Entity Relationship Diagram(ERD) P. 301

Right click on the entity and select New Column from the pop-up menu, or press Alt+Shift+C.

Create column

The column can be set with primary key by right clicking the column and selecting Include in primary key from the pop-up menu.

Set as primary key

Drawing relationships
Point on the entity and either click or drag its resource icon to create another entity.

Create relationship

As a result, a new entity is created with foreign key column(s), referencing the original entity's primary key column(s).

Rename relationship

Follow the same steps to create other entities and relationship until the diagram looks like the picture below.

Complete ERD

Entity Relationship Diagram(ERD) P. 302

Drawing many-to-many relationship
Click or drag Many-to-Many relationship resource icon of an entity.

Create many-to-many relationship

Many-to-Many relationship will auto convert to two One-to-Many relationships and a join table. The primary key both tables will be used to create
foreign key columns in join table as composite primary key.

Created join table with one-to-many relationships

Defining default schema

A default schema can be set on diagram, to make entities to be created on the diagram share the same schema. To define a default schema on
diagram:
Right click on the diagram background and select Open Specification... from the pop-up menu.

Select Open Specification... from the pop-up menu

Entity Relationship Diagram(ERD) P. 303

Specify the default schema in the Entity Relationship Diagram Specification dialog box. Click OK to confirm the change.

Specify default schema

Now, when you create an entity on the diagram, the entity will be under the default schema.

An entity with myschema as its schema

NOTE: In order to move entities in a diagram to a schema, define default schema on the owning entity relationship diagram, right click on the
diagram and select Apply Default Schema from the pop-up menu. This will make all entities that have master view on the erd to share
the schema defined.

Entity Relationship Diagram(ERD) P. 304

Drawing sequence
Creating sequence
Click Sequence from diagram toolbar and drag it on the diagram pane.

Create sequence

Type the name for sequence when it is created.

Rename sequence

Right click on the sequence and select Open Specification... from the pop-up menu. In Sequence Specification dialog box, specify sequence
attributes.

Specify sequence attributes

NOTE: Generate sequence is only supported in DB2 and Oracle.

Select sequence for entity

After creating an entity and a primary key column, right click on the primary key column and select Open Specification... from the pop-up menu.

Drawing sequence P. 305

In Column Specification dialog, select sequence for ID Generator, and select the sequence name for Key.

Select sequence for entity

When using Object-Relational Mapping feature, the primary key value will be inserted automatically from the sequence.

Drawing sequence P. 306

Drawing stored procedures
Creating stored procedures shape
Click Stored Procedures from diagram toolbar and drag it on the diagram pane.

Create stored procedure shape

Specify the name for the newly created stored procedures and press Enter.

Rename
procedure shape

NOTE: Procedure shape is a virtual container to group a set of stored procedures. It is not a stored procedure.

Creating procedure
Right click on the stored procedures and select New Procedure from the pop-up menu, or press Alt+Shift+P.

Create stored procedure

After the new procedure is created, right click on it and select Open Specification... from the pop-up menu. In Procedure Specification dialog box,
specify the create statement and create parameters if necessary.

Specify create statement in Procedure Specification dialog box

Moving or duplicating a procedure to another procedure container

Drawing stored procedures P. 307

1. Select the procedure to move or duplicate.

Select procedures to move or duplicate

2. Drag over the target procedure container.

Drag procedure towards the target procedures container

3. If you want to duplicate the procedures, press on the Ctrl key and release the mouse button. If you want to move them from source to target
procedure container, just release the mouse button.

Procedures are moved

Creating stored procedure resultSet

Click Stored Procedure ResultSet from diagram toolbar and drag it on the diagram pane.

Create stored procedure resultset

After specify the name for the newly created resultset, press Enter.

Rename stored procedure resultset

The way of creating resultset column is the same as creating entity column.

Drawing stored procedures P. 308

Right click on the procedure that created above, select Open Specification... from the pop-up menu. In Procedure Specification dialog box, specify
stored procedure return resultset.

Specify stored procedure return resultset

Drawing stored procedures P. 309

Drawing triggers
Create a triggers shape
Click Triggers from diagram toolbar and drag it on the diagram pane.

Create triggers shape

After specify the name for the newly created triggers, press Enter.

Rename a triggers shape

Create a new trigger

Right click the triggers and select New Trigger from the pop-up menu, or press Alt+Shift+T.

Create a new trigger

In Triggers Specification dialog box, specify the create statement.

Specify the create statement in Trigger Specification dialog box

Move or duplicate triggers to another trigger container

1. Select the trigger to move or duplicate.

Selecting triggers to move or duplicate

Drawing triggers P. 310

2. Drag over the target trigger container.

Dragging trigger towards the target triggers container

3. If you want to duplicate the triggers, press on the Ctrl key and release the mouse button. If you want to move them from source to target trigger
container, just release the mouse button.

Triggers are moved

Drawing triggers P. 311

Controlling primary key values using ID generator
ID generator defines how a unique value will be produced for a primary key column. You can assign an ID generator to a primary key column for which
strategy will be used when generating an ID in runtime.
1. Right click the primary key column that you want to select an ID generator for and select Open Specification... from the pop-up menu.

Select Open Specification... from the pop-up menu

Controlling primary key values using ID generator P. 312

2. In Column Specification dialog box, select the ID Generator and then click OK to confirm.

Select an ID generator in Column Specification dialog box

ID Generator Description

assigned lets the application to assign an identifier to the object before is called.

guid uses a database-generated GUID string on MS SQL Server and MySQL.

hilo uses a hi/lo algorithm to efficiently generate identifiers of type , or , given a table and column as a source of hi values. The
hi/lo algorithm generates identifiers that are unique only for a particular database.

identity supports identity columns in DB2, MySQL, MS SQL Server, Sybase and HypersonicSQL. The returned identifier is of type ,
or .

increment generates identifiers of type , or that are unique only when no other process is inserting data into the same table. Do not
use in a cluster.

native (default) picks , or depending upon the capabilities of the underlying database.

seqhilo uses a hi/lo algorithm to efficiently generate identifiers of type , or , given a named database sequence.

sequence uses a sequence in DB2, PostgreSQL, Oracle. The returned identifier is of type , or

The description of available ID Generator

Controlling primary key values using ID generator P. 313

Customizing ID generator
Besides the built-in strategies for generating ID, user can implement how ID will be generated by customizing an ID generator.
1. In Class Diagram, create the ID generator class, and stereotype it as ORM ID Generator.

An ID generator class

2. Rigth click on the primary key column that you want to select an ID generator for and select Open Specification... from the pop-up menu.

Click Open Specification... from the pop-up menu

3. In the Column Specification dialog box, select the class in the ID Generator.

Select an ID generator in Column Specification dialog box

4. Click OK to confirm.

Customizing ID generator P. 314

5. After generated ORM code, look for the ID generator class and implement the generate method by return an Integer or Long.
/**
* Licensee: VP Development
* License Type: Purchased
*/
import java.io.Serializable;
import org.hibernate.engine.SessionImplementor;
import org.hibernate.id.IdentifierGenerator;
public class ProductIDGenerator implements IdentifierGenerator {
public Serializable generate(SessionImplementor session, Object object) {
//TODO: Implement Method
throw new UnsupportedOperationException();
}
}
//ORM Hash:fae9faed19486e5f2b85c9d2d0d52cd9

Customizing ID generator P. 315

Drawing View
Drawing view
Click View from diagram toolbar and drag it on the diagram.

Creating view

Click on diagram and specify the view name.

Naming a view

To create a column in view, right click on the view and select New Column from the pop-up menu, or press Alt+Shift+C.

Create column

Enter the column name and press Enter to confirm.

Column created

Drawing View P. 316

Generate class diagram from ERD
1. Open an existing ERD or create a new ERD.

ERD

2. Right click on the diagram's background and select Synchronize to Class Diagram from the pop-up menu.

Synchronize to class diagram

Generate class diagram from ERD P. 317

3. In the Synchronize from Entity Relationship Diagram to Class Diagram dialog box, select the target diagram and click OK button.

Select diagram for synchronize

4. If there are new ERD model elements created since last synchronize, a Synchronize to Class Diagram dialog box will show for you to rename
the generated model elements. Click OK button after finish renaming.

Synchronize to Class Diagram dialog box

Generate class diagram from ERD P. 318

5. A class diagram with generated classes and associations is created.

Generated class diagram

Generate class diagram from ERD P. 319

Synchronize from class diagram to ERD
1. Select ORM-Persistable Class from the diagram palette.

Create ORM-Persistable class

2. Click on the diagram to name it as Supplier, create attributes and association as follow.

Create Supplier class

3. Add name attribute to Product_Type class.

Create attribute

4. Right click on diagram, select Synchronize to Entity Relationship Diagram from the popup menu.

Synchronize to Entity Relationship Diagram

Synchronize from Class Diagram to ERD P. 320

5. A Synchronize to Entity Relationship Diagram dialog appears. Select Auto Generate in Select Primary Key table and rename the entity/
column if necessary. Click OK button to continue.

Synchronize to Entity Relationship Diagram dialog box

6. New entities and column are created on the ERD.

Synchronized ERD

Synchronize from Class Diagram to ERD P. 321

Configure key naming pattern
1. Select Tools > Options... from the main menu.

Open Options dialog box

2. Select Diagramming from the list on the left and open ERD & ORM tab.

Open ERD & ORM tab

Configure key naming pattern P. 322

3. Change Primary Key Pattern and Foreign Key Pattern.

Change primary key and foreign key pattern

4. Create a new ORM-Persistable class on class diagram and synchronize to ERD.

5. In the Synchronize to Entity Relationship Diagram dialog box, the primary key column name is newly generated.

Default primary key column name

6. Create a relationship from the target entity to the newly created entity. As you can see, a foreign key column named is created automatically.

Default foreign key column name

Configure key naming pattern P. 323

Drawing business process diagrams
Business Process Modeling Notation (BPMN) is a graphical representation for designing and modeling business processes visually. It is a standard for
business process modeling, and provides a graphical notation for specifying business processes in a business process diagram (BPD).

Creating business process diagram

To create a business process diagram, right click on Business Process Diagram in Diagram Navigator and select New Business Process Diagram
from the pop-up menu.

Create business process diagram

Creating pool
To create pool, click Horizontal Pool on the diagram toolbar and then click on the diagram.

Create pool

Adding lane to pool

To add lane to pool, right-click the pool and select Add Lane from the pop-up menu.

Create lane

Creating start event

To create start event, click Start Event on the diagram toolbar and then click on the diagram.

Create start event

Creating task
To create task from a start event, click on the Sequence Flow -> Task resource beside it and drag.

Create task

Drawing business process diagrams P. 324

Move the mouse to where you want to place the shape to and then release the mouse button. A task is created and connected to the start event with a
sequence flow.

Task and sequence flow created

Creating message flow

To create message flow, click Message Flow on the diagram toolbar.

Create message flow

Drag from the source shape, move the mouse over the target shape and then release the mouse button to create the message flow.

Connect shapes with message flow

Automatic connection rule checking

VP-UML provides automatic connection rule checking to make sure your business process diagram is in compliance with the BPMN specification.

Drawing business process diagrams P. 325

For example, if you move a task from one pool to another, and if this task is connected with another shape with sequence flow, the Invalid Connection
Detected dialog box shows to advice you to change sequence flow to message flow.

Invalid connection detected

Click OK button to accept the correction. The sequence flow is changed to message flow automatically.

Sequence flow changed to message flow

Creating gateway
To create gateway from a task, click on the Sequence/Message Flow -> Gateway resource beside it and drag.

Create gateway

Drawing business process diagrams P. 326

Move the mouse to where you want to place the shape to and then release the mouse button. A gateway is created and connected to the task with a
sequence flow.

Gateway and sequence flow created

Creating intermediate event

To create intermediate event from a task, click on the Sequence/Message Flow -> Intermediate Event resource beside it and drag.

Create intermediate event

Move the mouse to where you want to place the shape to and then release the mouse button. An intermediate event is created and connected to the
task with a sequence flow.

Intermediate event and sequence flow created

Creating text annotation

To create text annotation from a task, click on the Association -> Text Annotation resource beside it and drag.

Create text annotation

Move the mouse to where you want to place the shape to and then release the mouse button. A text annotation is created and connected to the task
with an association.

Text annotation and association created

Splitting sequence flow with shape

You can use the split sequence flow utility to split a sequence flow by task, sub-process, intermediate event or gateway.
Before this, you may want to move some shapes aside to make room for the new shape. Select Sweeper on the diagram toolbar.

Sweeper

Drawing business process diagrams P. 327

Click on the diagram and drag to sweep shapes aside, release the mouse button when enough room is made.

Sweep shapes aside to make more room

Click the Split with Shape resource beside the sequence flow.

Split with Shape resource

Select the shape type to split the sequence flow.

Select shape type to split sequence flow

The sequence flow is split by the selected type of shape.

Sequence flow split by the selected type of shape

Forming sub-Process diagram

To create sub-process for shapes, select the shapes in diagram, right click on the selection and select Form Sub-Process Diagram from the pop-up
menu.

Form sub-process diagram

A new diagram is created with the selected shapes.

Form sub-process diagram

Drawing business process diagrams P. 328

When you return to the original diagram, you will see the selected shapes are transformed to a sub-process.

Shapes transformed to sub-process

Continue to complete the diagram.

Completed diagram

Assigning IDs to model elements

It is possible to assign IDs to objects in business process diagram. By default, IDs are assigned by following the order of object creation, starting from
number 1. However, you can define the format, or to enter an ID manually.

Defining the format of ID

To define the format of ID, open the Options dialog box by selecting Tools > Options from the main menu. Select Diagramming from the list on the
left hand side, and open the Business Process tab. From there you can adjust the format, and control whether or not to display the ID on diagram,
and the position of ID.

Define format of ID

Drawing business process diagrams P. 329

Below is a description of options.

Option Description

Prefix Text to add before the number

Num of digits The number of digits of the number. For example, when digit is 3, ID "1" will become "001"

Suffix Text to append to the number

Show ID Whether or not to show ID on diagram, and whether to show it as label that attach to a shape, or as text below caption
option

Options for formatting ID

Showing ID on diagram
By default, ID is just a text property that won't appear on diagram. However, you can make it appear either near or within a shape.

Different looks of a task when ID is not shown, ID is shown as label and ID is shown below caption

To configure how to show ID (or not to show ID), you can either set the global option (refer to the previous section), or set it through diagram's option
by right clicking on the business process diagram, selecting Presentation Options >Configure Show ID Options from the popup menu.

Show ID on a diagram

Drawing business process diagrams P. 330

In the Configure Show ID Options dialog box, click on the drop down menu Show ID Options and select if you want to show IDs, and if yes, where to
show - below caption or as a label.

To configure the whether or not to show ID

If you selected to show as label, you can adjust in further the position of ID, relative to the shape (e.g. Top right of task) and the rotation.

To make ID of task show as label, position at the left of shape

ID assignment
There are several ways that you can assign an ID to an element, including:
• Through the specification dialog box (Right click on it and select Open Specification... from the pop-up menu)
• Through the ID label (available only when ID is shown as label on diagram)
• Through the Property Pane

Drawing business process diagrams P. 331

Setting task/sub-process/gateway/event type
To change the type of task/sub-process/gateway/event, right click on the shape and select Type, and then the target type from the pop-up menu.

Select task type

Drawing business process diagrams P. 332

Setting loop type for task and sub-process
To set the loop type for task/sub-process, right click on the shape and select Open Specification... from the pop-up menu. In the specification dialog
box, update the Loop Type selection and click OK button to confirm editing.

Edit the loop type

Drawing business process diagrams P. 333

Drawing data flow diagrams
Data flow diagram is a well known approach to visualize the data processing in business analysis field. A data flow diagram is strong in illustrating the
relationship of processes, data stores and external entities in business information system.

Creating data flow diagram

To create a data flow diagram right click on Data Flow Diagram in Diagram Navigator and select New Data Flow Diagram from the pop-up menu.

Create data flow diagram

Creating external entity

To create external entity, click External Entity on the diagram toolbar and then click on the diagram.

Create external entity

An external entity is created.

External entity created

Creating process
To create process from external entity, click the Data Flow -> Process resource beside it and drag.

Create process

Move the mouse to empty space of the diagram and then release the mouse button, a process will be created and connected to the external entity with
a data flow.

Process and data flow created

To edit properties of the process, right click on it and select Open Specification from the pop-up menu.

Drawing data flow diagrams P. 334

Edit properties such as ID and Location in the Process Specification dialog box, click OK button to apply the changes.

Process specification dialog box

The process is updated.

Process updated

Creating data store

To create data store from process, click the Data Flow -> Data Store resource beside it and drag.

Create data store

Move the mouse to empty space of the diagram and then release the mouse button, a data store will be created and connected to the process with a
data flow.

Data store and data flow created

Continue to complete the diagram.

Completed diagram

Drawing data flow diagrams P. 335

Drawing event-driven process chain diagrams
EPC diagram, short for event-driven process chain diagram, is a flowchart based diagram that can be used for resource planning and identifying
possible improvements of a business process.

Creating event-driven process chain diagram

To create an EPC diagram, right click on EPC Diagram in Diagram Navigator and select New EPC Diagram from the pop-up menu.

Create EPC diagram

Creating event
To create event, click Event on the diagram toolbar and then click on the diagram.

Create event

An event will be created.

Event created

Creating function
To create function from event, click the Control Flow -> Function resource beside it and drag .

Create function

Move the mouse to empty space of the diagram and then release the mouse button, a function will be created and connected to the event with a
control flow.

Function and control flow created

Drawing event-driven process chain diagrams P. 336

Creating operator
To create operator (e.g. XOR operator) from event, click the Control Flow -> XOR Operator resource beside it and drag .

Create operator

Move the mouse to empty space of the diagram and then release the mouse button, an operator will be created and connected to the function with a
control flow.

Operator and control flow created

Creating process path

To create process path from event, click the Control Flow -> Process Path resource beside it and drag .

Create process path

Move the mouse to empty space of the diagram and then release the mouse button, a process path will be created and connected to the event with a
control flow.

Process path and control flow created

Creating information resource

To create information resource, click Information Resource on the diagram toolbar and then click on the diagram.

Create information resource

An information resource will be created. To connect the information resource with a function using information flow, click the Information Flow ->
Function resource and drag.

Create information flow

Mouse over a function and then release the mouse button, an information flow will be created.

Information flow created

Drawing event-driven process chain diagrams P. 337

Continue to complete the diagram.

Completed diagram

Drawing event-driven process chain diagrams P. 338

Drawing process map diagram
Process map diagram gives an overview that shows the processes needed to approach a business goal. It is rather in an upper level of analyzing and
understanding a business process.

Creating process map diagram

To create a process map diagram, right click on Process Map Diagram in Diagram Navigator and select New Process Map Diagram from the pop-
up menu.

Create process map diagram

Creating receive
To create receive, click Receive on the diagram toolbar and then click on the diagram.

Create receive

A receive will be created.

Receive created

Creating process
To create process from receive, click the Process Link -> Process resource beside it and drag .

Create process

Move the mouse to empty space of the diagram and then release the mouse button, a process will be created and connected to the receive with a
process link.

Process created

Drawing process map diagram P. 339

Creating send
To create send from process, click the Process Link -> Send resource beside it and drag .

Create send

Move the mouse to empty space of the diagram and then release the mouse button, a send will be created and connected to the process with a
process link.

Send created

Continue to complete the diagram.

Completed diagram

Drawing process map diagram P. 340

Drawing organization charts
An organization chart is a diagram that visualizes the formal structure of an organization as well as the relationships and relative ranks of its positions.
It is usually drawn and read from the top to the bottom. The default unit will pop out when a new organization chart is created.
In VP-UML, organization chart is not only a diagram, but also a reference used for other parts of your model. For example, you may use an
organization chart to depict the company hierarchy involved in a business process model. Its prime function is to help a business analyst to visualize
efficiently the company structure as well as the division of works when performing business analysis.
The completed organization chart is shown as follows:

Completed organization chart

Creating an organization chart

Right Click Organization Chart in Diagram Navigator and select New Organization Chart from the popup menu.

Create new organization chart

Creating a subordinate
Subordinate, which is subject to the superior, is belonging to a lower rank. To create a subordinate under a superior unit:
1. Move mouse pointer on a unit and press its resource icon New Subordinate.

Create subordinate

2. Name the newly created subordinate unit and press Enter to confirm editing.

Creating a coworker
The coworker is a fellow worker of the same rank to the branch next to it. To create a coworker next to an existing unit:

Drawing organization charts P. 341

1. Move the mouse pointer a unit and click its resource icon New Coworker, either on its left or right hand side.

Create coworker

2. Name the newly created coworker unit and press Enter to confirm editing.

NOTE: Clicking left resource icon will create coworker on the left of the unit, while clicking right resource icon will create coworker on its right.

Relocating a branch
A unit can be relocated even when it has been placed under the subordination of another unit.
1. Press on a branch you want to relocate and drag it to the preferred branch.

Moving a unit

2. Release the mouse to confirm the position.

Completed relocating a branch

NOTE: If you are not satisfied the relocation, press Esc to cancel the movement.

Drawing organization charts P. 342

JPDL generation in VP-UML
1. Model the process in a business process diagram.

A business process diagram

2. Right click on the diagram's background and select jPDL Diagram in the popup menu.

Set diagram to be a jPDL diagram

JPDL generation P. 343

3. Right click on the diagram's background and select Utilities > Generate jPDL... in the popup menu.

Generate jPDL

4. Select the folder to generate jPDL to. When generation is done, you should see the following files in the chosen folder:
• A zip file containing the deployable process archive
• gpd.xml (The graphical process definition)
• processdefinition.xml (The process definition)
• processimage.jpg (The image file of business process diagram)
Now, you can deploy the jPDL.

The jBPM console

JPDL generation P. 344

What is simulacian?
The objective of performing business process modeling is to facilitate the communication with stakeholders, to perform cost and benefit analysis and
to perform process improvement, etc. Simulacian is a set of value-added tools designed to aid business process modeling. With simulacian, you
can simulate the execution of business process for studying the resource consumption (e.g. human resources, devices, etc.) throughout a process,
identifying bottlenecks, quantifying the differences between improvement options which helps study and execute process improvements.

Simulating a business process with Simulacian

Key concepts

What is simulacian? P. 345

Resources
Resources refer to any kind and form of input essential for the execution of a process. Each resource has three properties - name, type and amount.
There are two types of resources - available resources and required resources. Available resources refer to the resources that can be used by
business process, but may not be fully used. For example, a post office has 10 counters as resources, but only 3 are in used at peak hours. Required
resources is a flow object wide option. You can set the resource and the amount of resource required by completing a flow object. For example, task
Answering Enquiry requires 1 counter as resource.

Required and available resources

Very often, the allocation of resource is critical to the efficiency of a business process. For example, if there are more available staffs and counters, this
helps increase the efficiency of customer service. But of course, if the available staffs and counters are more than enough, those non-used resources
are wasted. With simulacian, you can determine the optimal resource allocation by evaluating the resource consumption of current process.

Duration
Duration is the time elapsed from the entering of flow object until the leaving of that flow object. It is understandably that the duration of flow object has
significant effect to the efficiency of a business process. Imagine if it takes 5 minutes to complete the process of just one payment in a supermarket,
there will accumulate a long queue waiting for paying.

Input
Input is a way of simulating a given business process. It has a name that describe the input, and an instance, which is a number that represent the
number of time the input will happen at a particular instant. If you have modeled a general order processing system, you can add an input public
holiday, with instance 100 to represent the case that in public holiday there will be 100 customers that need to undergo payment. In order to help you
improve your process, you must set input that reflect the reality. If you set 10000 as instance of input public holiday which will never happen, you will
not obtain useful information to aid in process improvement.

Simulation
Once you have specified the available and required resources, the duration of flow objects and added input(s), you can run simulation. During
simulation, diagram will be locked to avoid collision between your edit action and the simulation operation. Executing jobs are represented by a running
green gear shape, with a number indicating the number of running job, and are attached to the task where the job is being processed. Pending jobs are
represented by inverted triangles, with a number indicating the number of pending jobs.

Executing and pending jobs

What is simulacian? P. 346

Performance analysis through charts
During simulation of business process, you can identify the bottleneck(s) by observing the occurrence of pending jobs (i.e. the inverted triangle). This
works well in a relatively small process. However, if your business process diagram is large you may not be able to study the simulacian outcome just
by observation because the simulcian can be lengthy and involve several bottlenecks. Furthermore, you may want to know the exact figure of resource
consumption for conducting a more accurate resource re-allocation plan. In those cases, you can produce simulacian charts that reports the completion
of inputs, resource usage and queue time of flow objects against time.

Different kinds of chart

What is simulacian? P. 347

Simulacian control panel
In order to simulate a business process you need to define simulation details like available and required resources, duration of tasks/sub-processes,
instances of pools/lanes and inputs. All these information can be defined in simulacian control pane, which is a pane that display at the bottom of
diagram, important for adjusting any settings related to simulacian. The panel will be updated base on your selection in active diagram. Besides setting
simulacian details, start/pause of simulation can also be done in the panel.

Opening simulacian control panel

To open the simulacian control panel, right click on the business process diagram that you want to simulate and select Show Simulacian Control
Panel from the popup menu.

Opening simulacian control panel

NOTE: You can open simulacian control panel only for diagram that has selected Simulacian as diagram type. To check/edit diagram type, right
click on the background of business process diagram and select Diagram Type from the popup menu.

Overview of simulacian control panel

Common

An overview of simulacian control panel

No. Name Description

1 Start / Pause Click to start simulation when paused or stopped, base on the resource, duration and input settings, or to pause a simulation
when it is playing.

2 Stop Stop a simulating business process.

3 Clock Displays the time elapsed from the beginning of simulation until the current moment. It is for reflecting the duration of the
execution of business process, and is based on the selection of time scale.

4 Time scale Control the speed of simulation. For example, a selection of 10 mins scale simulates the business process in speed 10 min
per second.

Simulacian control panel P. 348

5 Simulacian Click to display a new window that display the completion, resource usage and queue time charts base on the settings of
charts resource, duration and input. You can treat it as a chart form of simulation outcome.

6 Close Click to close the simulacian control panel. You can open it again by right clicking on the business process diagram and
selecting Show Simulacian Control Panel from the popup menu.

Description of simulacian control panel

When selected pool/lane

An overview of simulacian control panel while selected pool/lane

No. Name Description

1 Instance When you model a business operation in business process diagram, you use pools and lanes to represent
participants and sub-participants of the process, such as Client and Receptionist. No matter how many actual
participants are there, you will still use a single pool (or lane) to represent all of them. For example, you will draw a
pool Receptionist to represent all receptionists instead of drawing 5 pools for representing the fact that there are 5
receptionists.
Here the Instance field let you set the number of instances of selected pools or lanes. If there are 5 receptionists,
enter 5 for instance of pool/lane Receptionist.
Provided that there are sufficient resources for performing jobs, the number of instances affects the performance
of process - The more instances, the more efficient. During process improvement, you can adjust the instance to
evaluate the impact of increasing or decreasing the number of staff to handle certain job.

2 Show inputs Inputs are the expected way of executing a business process during simulacian. Click Show Inputs to list the inputs,
and add/remove inputs in further.

3 Available resources The table of available resources list the resources needed by the business process. For example, a process of body
checking has resources X-Ray room and reception counter. Each resource has a name, a type and its amount.

4 Add available resource Click to add an available resource by giving its name, selecting/entering its type and setting its amount.

5 Remove available Select an available resource and click this button to remove it.
resource

Description of simulacian control panel while selected pool/lane

When selected flow objects

Simulacian control panel P. 349

An overview of simulacian control panel while selected flow object

No. Name Description

1 Duration The time the selected flow object need to take to process and complete a job. The 4 boxes d, h, m and s mean day,
hour, minute and second, respectively. For example, it takes five 5 minutes to present a report to client in a body
check operation, set the business task Present Report's duration to be 5 m, meaning 5 minutes.
The duration setting affects the performance of process - The less time needed, the more efficient. However, do not
forget that the less time it takes to complete a task may affects the quality of work. During process improvement, you
need to keep the balance between efficiency and quality of work, and adjust the duration accordingly.

2 Show inputs Inputs are the expected way of executing a business process during simulacian. Click Show Inputs to list the inputs,
and add/remove inputs in further.

3 Required resources The resources the participant needed in order to complete a job when processing the selected flow object. The
Resource column shows the names of resources. The Amount column shows the number of resource needed to
use in completing the task per participant. For example, to present report to client, you need one resource Meeting
Room, and one resource Projector.

4 Add required resource Click to add the resource the participant needed in order to complete a job when processing the selected flow object.
Make sure you have available resources defined in order to select a required resource. Also note that you cannot
set an amount that exceed the amount set in available resource. For example, if you have 6 available projector
(resource), the maximum of projector a flow object can require is from 0 to 6.

5 Remove required Select a required resource and click this button to remove it.
resource

6 Available resources The table of available resources list the resources needed by the business process. For example, a process of body
checking has resources X-Ray room and reception counter. Each resource has a name, a type and its amount.

7 Add available resource Click to add an available resource by giving its name, selecting/entering its type and setting its amount.

8 Remove available Select an available resource and click this button to remove it.
resource

Description of simulacian control panel while selected flow objects

When selected diagram background / showing inputs

An overview of simulacian control panel while selected diagram background or showing inputs

No. Name Description

1 Inputs Inputs are the definitions of how to execute a business process during simulation. An input consists of a selection
of possible execution path formed by flow objects in diagram, with the number of instances, which represents the
number of time the path will be executed at a specific instant.
For example, if you want to simulate the case that there are 10 clients needed to perform body checking in a
business process of body checking, to see if the process can handle this situation well, you will add an input
Performing body check, with 10 as number of instances.

2 Add input Click this button to add an input with name and number of instances.

3 Remove input Select an input and click this button to remove it.

4 Path The flow objects involved in an input. If there is a gateway in your diagram, you need to make a decision to the
outgoing path of the gateway object.

5 Highlight in diagram Check this button to make the diagram highlight the path involved in the input selected in Inputs table.

Simulacian control panel P. 350

7 Add available resource Click to add an available resource by giving its name, selecting/entering its type and setting its amount.

8 Remove available Select an available resource and click this button to remove it.
resource

Description of simulacian control panel while selected diagram background or showing inputs

When simulating

An overview of simulacian control panel while simulating

No. Name Description

1 Pause To temporarily pause a simulation.

2 Stop To stop simulating the business process.

3 Clock Displays the time elapsed from the beginning of simulation until the current moment. It is for reflecting the duration of the execution of
business process, and is based on the selection of time scale.

4 Inputs A list of inputs with their completeness throughout the simulation. The Processing column shows the jobs under processing by the
simulating process. The Instances column shows the amount of non-completed jobs. It should keep decreasing, and become 0 at the
end of simulation.

5 ResourcesA list of resources with the status of consumption throughout the simulation. The Processing column shows the amount of resources
be consumed by the simulating process. The Instances column shows the total amount of resources. You can observe this table to
study the current resource allocation.

6 Results A list of completed inputs. The Instances column shows the amount of completed inputs.

Description of simulacian control panel while simulating

Simulacian control panel P. 351

Simulating business process
In order to simulate a business process, you must provide performance-related information to the business process diagram, such as resource
consumption and duration of flow objects, so that simulacian can analyze the information and conduct a simulation. Below are what you have to do to
start simulation.
1. Right click on the background of the business process diagram that you want simulate and select Diagram Type > Simulacian from the popup
menu.

Set diagram's type to Simulacian

2. In the Simulacian Control Panel, click Add under Available resources to define the resources that can be used by the flow objects in the
business process diagram in order to complete the tasks. If you want to know more about resources, please refer to the chapter What is
simulacian?.

To add available resources

3. For each of the flow objects, select it in diagram, and click Add under Required Resources in Simulacian Control Panel to add the
resource(s) the participant needed to complete the job when reaching the selected flow object.

To add required resources

Simulating business process P. 352

4. For each of the flow objects, select it in diagram, and set in Simulacian Control Panel its duration, which is the time it takes to get completed. If
you want to know more about duration, please refer to the chapter What is simulacian?.

To set the duration of flow object

5. For each lane and pool (without lane), select it in diagram, and set its instance in Simulacian Control Panel, which represents the number of
participants that take part in the process.

To set instance of pools or lanes

6. Click on the background of diagram or click Show Inputs in Simulacian Control Panel.
7. Click Add under Inputs in Simulacian Control Panel to add the paths to be executed during simulation. For each input, set the name that
describe the path, and the number of instances for the number of copies of the path to execute.

To add input

Simulating business process P. 353

8. Click Start in Simulacian Control Panel to start simulation.

Start simulation

Now, you can watch the simulation in diagram, to see the executions of inputs and identify bottlenecks.

Simulation is running

Simulating business process P. 354

Simulacian charts
Sometimes, just by watching the simulacian outcome is not enough in finding out the bottleneck, especially when the diagram is large, and have many,
many bottlenecks. In such cases, you can produce charts for simulacian outcome, which helps quantify resource consumption and queuing time for
each flow object.
To read the charts, click Simulacian Charts in simulacian control panel.

To open simulacian charts window

Completion chart
The completion chart primarily shows the status of inputs completion against time.

An overview of completion chart

No. Name Description

1 Resource usage Click to show resource usage chart.

2 Queue time Click to show queue time chart.

3 Time scale Control the length of chart by selecting a time scale.

4 Auto refresh Check to let the chart body auto update against chart settings such as time scale and selection of inputs. Uncheck to
update manually by clicking Refresh.

5 Refresh Click to update the chart body against the chart settings such as time scale and selection of inputs. This button is
available only when Auto Refresh is unchecked.

6 Not yet started inputs Check or uncheck the inputs to show or hide in chart the change of the amount of not-yet-started inputs throughout
simulation.

7 Processing inputs Check or uncheck the inputs to show or hide in chart the change of the amount of processing inputs throughout
simulation.

8 Completed inputs Check or uncheck the inputs to show or hide in chart the change of the amount of completed inputs throughout
simulation.

Simulacian charts P. 355

9 Chart body The chart body.

10 Export Click to export the opening chart to Microsoft Excel or image file.

11 OK Click to close the simulacian charts window and go back to the diagram.

Description of completion chart

Resource usage chart

The resource usage chart shows the percentage of resource consumption throughout simulation. If a resource has its peak reaching 100%, it means
that the allocation of that resource is in optimum state. If the peak is below 100%, it means that some of the resources are not used throughout the
simulation, which usually signifies that they are wasted, and you should consider to adjust the amount of available resource to optimize the resource
consumption.

An overview of resource usage chart

No. Name Description

1 Complete Click to show completion chart.

2 Queue time Click to show queue time chart.

3 Show by Select what to present in the chart.

Resource - Cause the chart to presents the resource consumption of each available resource.
Resource Type - Cause the chart to presents the resource consumption of resource types.

4 Time scale Control the length of chart by selecting a time scale.

5 Auto refresh Check to let the chart body auto update against chart settings such as whether to show by resource or resource type, time scale
and selection of resources and resources type. Uncheck to update manually by clicking Refresh.

6 Refresh Click to update the chart body against the chart settings such as whether to show by resource or resource type, time scale and
selection of resources and resources type. This button is available only when Auto Refresh is unchecked.

7 Resources Check or uncheck the resources to show or hide their usage in chart. This pane is active only when Resource is selected in the
drop down menu Show By.

8 Resource Check or uncheck the resource types to show or hide their usage in chart. This pane is active only when Resource Type is
types selected in the drop down menu Show By.

Simulacian charts P. 356

9 Chart body The chart body.

10 Export Click to export the opening chart to Microsoft Excel or image file.

11 OK Click to close the simulacian charts window and go back to the diagram.

Description of resource usage chart

Queue time chart

The queue time chart shows the time the flow objects spent on waiting, which corresponds to the time an inverted triangle appear during simulacian.
You may study whether the queue time of certain flow object is reasonable or not, and think of the improvement.

An overview of queue time chart

No. Name Description

1 Completion Click to show completion chart.

2 Resource Click to show resource usage chart.

usage

3 Time scale Control the length of chart by selecting a time scale.

4 Auto refresh Check to let the chart body auto update against chart settings such as time scale and selection of nodes. Uncheck to update
manually by clicking Refresh.

5 Refresh Click to update the chart body against the chart settings such as time scale and selection of nodes. This button is available only
when Auto Refresh is unchecked.

6 Nodes Check or uncheck flow objects nodes to show or hide their queue time in chart.

7 Chart body The chart body.

8 Export Click to export the opening chart to Microsoft Excel or image file.

9 OK Click to close the simulacian charts window and go back to the diagram.

Description of queue time chart

Simulacian charts P. 357

Drawing mind mapping diagram
Mind mapping is a tool to help you in brainstorming and organizing ideas, concepts, words, tasks through a visual note-taking way. It sometimes helps
to capture requirements and business process, too. Modelers can create and link model element (such as task, use case, classes) with mind mapping
node. The traceability can be kept between initial idea (mind mapping node) and detail design elements (e.g. class).

Creating mind mapping diagram

To create a mind mapping diagram:
1. Right click on the node Mind Mapping Diagram in Diagram Navigator and select New Mind Mapping Diagram in popup menu.

Create a mind mapping diagram

2. This create a mind mapping diagram with a central idea node appear in it. Immediately name the central idea node and press Enter to confirm.
You can then start drawing the diagram by branching nodes from the central idea nodes.

Naming central idea node

Creating branch with resource centric interface

Mind mapping is formed by nodes that represent ideas or concepts. They are connected with each other, showing the flow of thinking. To create a new
branch of nodes from an existing node:
1. Move the mouse pointer over a node. Press on the resource icon Branch -> Node.

To create a node

2. Drag it out. Release the mouse button to create the node.

A node is created

3. Name the node and press Enter to confirm. Create the other nodes by repeat the same steps.

A mind mapping diagram is created

Drawing mind mapping diagram P. 358

Formatting nodes
You can set colors to nodes to represent different kinds of idea and concepts. You can also set icon(s) to a node to represent the nature of a node,
such as a telephone icon for concepts related to contacting some body.

Changing the line, fill or font style of node

1. Select the node(s) that you want to format. Multiple node selection can be made by a range selection or by pressing the Ctrl key and select the
nodes subsequently.
2. Move the mouse pointer to a node within the selection. Click on the Format resource icon.

To format nodes

3. Select either Line..., Fill... or Font... from the popup menu to change specific type of format. (Read the coming sub-sections for details about
line, fill and font settings)
Once you have confirmed your selection, your choice will be memorized. When you want to apply the settings on other nodes, you can select the new
nodes, re-open the same popup menu, and select the setting through the popup menu.

Choosing a color for node

Line
Line settings control the appearance of border around node(s). You can adjust the style (e.g. dash, solid), the weight, which is the thickness of line, the
color and the level of transparency.

Nodes with brown border

Fill
Fill settings control the background color of node(s). You can apply solid and gradient colors, as well as to control the transparency.

Nodes with gray background

Font
Font settings control the font style, size, type and color of text appear on a node.

Nodes with Times new roman text

Formatting nodes P. 359

Changing icon of node
1. Select the node(s) that you want to set icon. Multiple node selection can be made by a range selection or by pressing the Ctrl key and select the
nodes subsequently.
2. Move the mouse pointer to a node within the selection. Click on the Format resource icon, then select Icons... from the popup menu.

To edit icons for a node

A node with icons

Formatting nodes P. 360

Linking nodes
Other than the traditional branch connector that represents a generation of idea, you can link related ideas and concepts by using a link connector.
There is no exact definition about how two nodes can said to be related. It is up to the designer whether to link the nodes or not. As long as you want to
represent that two nodes and related, and the relationship is meaningful, you can add a link between them.
To link nodes:
1. Move the mouse cursor over the source node. Press on any of the resources: Link, To Link, From Link. To and From links are directed
relationship, which shows an arrow to indicate the flow from source to target node.

To link to antoher node

2. Drag to the target node and release the mouse button.

NOTE: Unlike the usage of traditional resource icons, the Link resources must be released on an existing node. Releasing on diagram will not
result in creating a new node.

3. Optionally enter the name of link. Press Enter to confirm editing.

Link is created between nodes

Linking nodes P. 361

Reference to resources
You can add references to node, to reference to both internal and external resources such as a shape, a diagram, a file, a URL, etc. For example, to
make a node Prepare Agenda link to a document of agenda template. This makes a mind map more informative by providing additional information
from a mind map which might be casually developed.
To add a reference:
1. Right click on the node you want to add reference and select Open Specification... from the popup menu.

Opening node specification

2. In the node specification, open the References tab. Right click on the center of pane and select the type of reference to add from the popup
menu.

Going to add a reference

Type of reference Description

File An external file.

Folder An external folder.

URL A URL. For example, http://www.visual-paradigm.com

Diagram A diagram in the opening project, such as a requirement diagram.

Shape A shape in the opening project, such as a use case shape on a use case diagram.

Model element A model element in the opening project, such as a use case.

Description of different kinds of reference

3. Supply the information of reference such as the file path of a file reference, a diagram for a diagram reference.
4. Click OK to confirm.
Once a reference has been added, you can open it from the References tab by right clicking on it and selecting Open... from the popup menu.

Opening a referenced file

Reference to resources P. 362

Relocating a branch
In case a branch of nodes is mis-positioned, you can reposition it to under another node through drag and drop. Here are the steps:
1. Press on the pointer end of the first node of a branch that you want to reposition.

Pressing on the pointer end of a node

2. Drag to node that you want to move the branch to.

Dragging over the target node

3. Release the mouse button.

Mouse button released

Relocating a branch P. 363

Layout diagram
In a mind mapping diagram, ideas are stretching out across, which leads difficulties in tracing nodes with different ideas due to the unorganized nodes.
It will be time consuming to rearrange the idea nodes manually. This also affects our brainstorming procedure by caring the tidiness of diagram. By
performing a layout, you can keep brainstorming and drawing the diagram without caring about the tidiness of the diagram. You can perform a layout
once the diagram is drew. Any nasty diagrams can be well organized in a breeze.

Diagram based
By performing a diagram based layout, all idea nodes in diagram are included in the range of layout. To perform a diagram based layout, right click on
the central idea node and select Layout Node from the popup menu.

To layout nodes on a diagram

Result of diagram based layout - all nodes are layout-ed

Layout nodes and diagram P. 364

Using resource-centric interface
Mouse gesture enables you to layout shapes on a diagram through the movement of mouse. To perform a layout with mouse gesture, right press on
the diagram background, sketch a "L" like gesture path and release the mouse button to execute layout.

Layout diagram with mouse gesture

Node based
By performing a node based layout, only the chosen node and its descendant nodes are included in the range of layout. To perform a node based
layout, right click on the idea node and select Layout Node from the popup menu.

To perform a node based layout

Layout nodes and diagram P. 365

Result of node based layout - only Schedule node is layout-ed

Layout nodes and diagram P. 366

What is animacian?
Animacian is a tool that helps you make possible paths in an active diagram by presenting the paths in animation form. This can make your design
more attractive by animating it. Besides, you can control the flow of animation yourself to help demonstrating your work to client with your annotation. It
also calculates all possible paths of the interaction, making the design more accurate.

Animating paths in diagram

Animation can be played directly on diagram. When the animation begins, a tiny black dot will be attached to the begining of the path selected to
animate. During the animation, the black dot will traverse through the path, shapes that lie on the path will be painted in purple one by one, when being
approached by the black dot, until the black dot reached the end of the path.

An animating path

Automatic paths identification

Interconnected shapes form a path. It is possible to have multiple paths on a diagram. Animacian helps finding out all possible paths in a diagram.
When opening the Animacian dialog box, valid paths on the opening diagram will be identified and listed for selection. You can then select a path to
animate. Unclosed paths or paths that does not obey the notation are classified as invalid, thus won't be available for playing animation.

Filter business paths base on conditions

The Animacian dialog box is where you can configure animation and select path to animate. You can apply filter on path identification, which clears
undesired path that does not match certain condition. To configure filter:

What is animacian? P. 367

1. Click Filter... button in the Business Process Diagram Animacian dialog box.

Click the Filter... button

2. In the Filter Configuration dialog box, conditional flows, if any, are listed. Click on a drop down menu to select the expected outgoing flow of a
condition. By doing so, only paths that cover the selected flow are identified, the rest will be ignored.

Configure filter

NOTE: A condition can have more than two outgoing flows. You can allow multiple outgoing flows by pressing the ... button next to the drop
down menu, and selecting the flows in the Select Multiple Values dialog box.

What is animacian? P. 368

3. Click OK to confirm. The identified paths will be reduced accordingly.

Paths are reduced as a result of applying filter

Walking through a path step-by-Step

Instead of letting the animation to run itself, you can control it yourself. The horizontal bar that appear at the bottom of VP-UML when animating lets

you control the animation. Besides pausing, playing and stopping the animation, you can also move a shape backward or forward by pressing the

and button. By making use with the forward and backward buttons, you can walk through a path shape by shape.

Walk though a path step by step

Showing documentation of current step when playing animation

When walking through a path, the documentation of the visiting shape, if written, will appear instantly at the bottom right corner of VP-UML.

What is animacian? P. 369

To turn this function on or off, open the Animacian dialog box, then check or uncheck Show documentation when playing.

Uncheck Show documentation when playing

What is animacian? P. 370

Animating business process diagram
By animating a business process diagram with Animacian, you can see the flow of tasks within a process, from the beginning until the end. This does
not only help to understand a process, but also trace the bottleneck and look for improvements.

Launching an animation
1. Select Tools > Animacian... from the main menu.

Launch Animacian through the main menu

2. In Business Process Diagram Animacian dialog box, select a path and then click Play.

Clicking Play in Business Process Diagram Animacian dialog box

NOTE: Animacian can also be started by using any of the ways below:
• Right-click on the diagram background and select Utilities > Animacian... from the popup menu.
• Click the drop-down menu of Modeling Tools and select Animacian... on the toolbar.

Animating business process diagram P. 371

Overview of Animacian
The Business Process Diagram Animacian dialog box will pop out after clicking Animacian.... This dialog box is where you can select an execution
path to play an animation.

Business Process Diagram Animacian dialog box

No. Name Description

1 Backward Move one shape backward in the flow.

2 Play Play or continue to play the animation with Animacian minimized.

3 Stop Terminate the animation.

4 Forward Advance to the next shape in the flow.

5 Slider It is used for controlling the flow of animation.

6 Paths It provides two ways of producing animation for the possible paths.
Automatic: It is chosen by default. This helps you to detect all possible paths automatically.
Manual: Choose this option when you want to select the possible path(s) manually.

7 Paths list It lists all possible ways of executing a business process. By default, paths are named as Path1, Path2, and so forth.
You can rename them by double clicking on them and giving meaningful names.

8 Components list It displays all components of the selected path. Pressing on a component will highlight the first shape of the chosen
path until the chosen shape in the diagram.

9 Refresh It is used for re-identifying the paths base on filter assignment and diagram content.

10 Filter... It helps removing the non-selected paths by specifying the end result of fork nodes.

11 Filter invisible shapes A shape can be set invisible on a diagram, or become invisible due to belonging to an invisible layer. By checking this
option, invisible shapes will be ignored when calculating paths. By unchecking, invisible path will be included when
calculating paths. By unchecking, you will see a black ball fly on diagram without attaching to the invisible shape(s)
when executing a path.

12 Flow It provides three options for viewing the possible paths in Paths list.
All Flow: Make a path continue when reaching sequence and message flow.
Sequence Flow Only: Ignore message flows on diagram. When a path reaches a message flow, end the path.
Message Flow Only: Ignore sequence flows on diagram. When a path reaches a message flow, end the path.

13 Export to Flash... Select an output path for exporting this diagram's animation to Adobe Flash.

14 Minimize Click to minimize this dialog box.

15 Options pane The Options pane helps you to configure animation.

Animating business process diagram P. 372

Show invalid paths: It lists not only the valid and selected path, but also the invalid and non-playable paths in the
Paths list.
Dim other path: It dims the components that are not a part of the selected path.
Show start node when switch path: Jump to the first node of the selected path, or keep staying at the current viewing
field.
Minimize when play: It minimizes this dialog box when playing an animation.
Lock diagram when playing: It locks the diagram when playing the animation to prevent accidental editing.
Show documentation when playing: It shows documentation of shape at the bottom right of diagram when playing
the animation.
Play voice when playing: Voice can be recorded as documentation of model element. Check this if you want to play
recorded voice when running animation.

16 Advanced Options... It provides the color and speed options for animation.

17 OK Click this button to confirm the settings and close Animacian.

18 Cancel Click this button to close Animacian without saving the editing.

Description of Business Process Diagram Animacian dialog box

Advanced options

Advanced Options dialog box

Name Description

Visited error fill color The background color of visited shape that cause an error. An error means the flow object that causes a
path invalid.

Visited fill color The background color of visited shapes.

Active shape initial fill color When playing an animation, a tiny black ball will traverse the chosen path, from one shape to another.
When it reaches a shape, the shape will render with a transition effect that means transiting from an initial
color to visited fill color. This option manages the initial background color for visiting shape.

Visited line color The line color of visited shapes.

Visited font color The font color of visited shapes.

Visited line width The thickness of visited shape's border.

Ball color The color of ball that goes through a path during animation for indicating the progress of flow.

Speed The pace of animation.

Flash progress bar background color 1 The background color for the top of progress bar in exported Flash movie.

Flash progress bar background color 2 The background color for the bottom of progress bar in exported Flash movie.

The description of Advanced Options dialog box

Animating business process diagram P. 373

Naming a path
The Paths list displays all possible animation paths of your diagram. Each path represents a possible way to go through the diagram. By default, paths
are named as Path1, Path2, and so forth. It is recommended to name to the path(s) for better clarification.
1. To rename a path, move the mouse pointer on a path in the list and double click on it.
2. Enter the name of path.
3. Press Enter to confirm editing.

Naming the paths

Creating a manual path

In Business Process Diagram Animacian dialog box, all paths are listed in Paths list by default. However, you can manage the flow of animation
with your own choice. To create a manual path:
1. Select Manual in Paths.

Selecting Manual in Paths

2. Press Add Path to insert a new path.

3. Select the shapes that are shown on the Components list to direct the flow of animation.
4. Click OK to confirm editing.

Animating business process diagram P. 374

Handling decision
You should choose an outgoing flow when there is a gateway in the flow. Different decisions will lead to different forks and make a different outcome
for the flow of animation. Make either decision to view the outcome.

Making a decision for the flow of path

Reviewing an animation
1. When everything is ready, click Play to start the animation of the selected path.
2. After click Play, Business Process Diagram Animacian dialog box will be minimized to the bottom of your diagram, with several buttons and a
slider revealing on it.
Button Name Description

BackwardMove one shape backward in the flow.

Pause Temporary stop playing the movie. Press Play

to continue to play.

Play Play or continue to play the animation.

Forward Advance to the next shape in the flow.

Stop Terminate the animation.

MaximizeMaximize Animacian.

Description of Animacian bar

3. When the animation starts, a black ball will appear at beginning of path and traverse through the path until the end.

Animating business process diagram P. 375

4. When the black ball reaches a shape, the shape will turn into purple.

Reviewing the animation

Animating business process diagram P. 376

Animating sequence diagram
By animating a sequence diagram with Animacian, you can see interaction between lifelines and the flow of message calls in active.

Launching an animation
1. Select Tools > Animacian... from the main menu.

Launch Animacian through the main menu

2. In Sequence Diagram Animacian dialog box, select a path and then click Play.

Clicking Play in Sequence Diagram Animacian dialog box

Animating sequence diagram P. 377

Overview of Animacian
The Sequence Diagram Animacian dialog box will pop out after clicking Animacian.... This dialog box is where you can select an execution path to
play an animation.

Sequence Diagram Animacian dialog box

No. Name Description

1 Backward Move one shape backward in the flow.

2 Play Play or continue to play the animation with Animacian minimized.

3 Stop Terminate the animation.

4 Forward Advance to the next shape in the flow.

5 Slider It is used for controlling the flow of animation.

6 Paths It provides two ways of producing animation for the possible paths.
Automatic: It is chosen by default. This helps you to detect all possible paths automatically.
Manual: Choose when you want to select the possible path(s) manually.

7 Paths list It lists all possible ways of executing a sequence. By default, paths are named as Path1, Path2, and so forth. You can
rename them by double clicking on them and giving meaningful names.

8 Components list It displays all components of the selected path. Pressing on a component will highlight the first shape of the chosen
path until the chosen shape in the diagram.

9 Refresh It is used for re-identifying the paths base on filter assignment and diagram content.

10 Filter... It helps removing the non-selected paths by specifying the end result of fork nodes.

12 Export to Flash... Select an output path for exporting this diagram's animation to Adobe Flash.

13 Minimize Click to minimize this dialog box.

14 Options pane The Options pane helps you to configure animation.

Animating sequence diagram P. 378

Minimize when play: It minimizes this dialog box when playing an animation.
Lock diagram when playing: It locks the diagram when playing the animation to prevent accidental editing.
Show documentation when playing: It shows documentation of shape at the bottom right of diagram when playing
the animation.
Play voice when playing: Voice can be recorded as documentation of model element. Check this if you want to play
recorded voice when running animation.

15 Advanced Options... It provides the color and speed options for animation.

16 OK Click this button to confirm the settings and close Animacian.

17 Cancel Click this button to close Animacian without saving the editing.

Description of Sequence Diagram Animacian dialog box

Advanced options

Advanced Options dialog box

Name Description

Visited error fill color The background color of visited shape that cause an error. An error means the flow object that causes a
path invalid.

Visited fill color The background color of visited shapes.

Visited line color The line color of visited shapes.

Visited font color The font color of visited shapes.

Visited line width The thickness of visited shape's border.

Ball color The color of ball that goes through a path during animation for indicating the progress of flow.

Speed The pace of animation.

Flash progress bar background color 1 The background color for the top of progress bar in exported Flash movie.

Flash Progress Bar background color 2 The background color for the bottom of progress bar in exported Flash movie.

The description of Advanced Options dialog box

Animating sequence diagram P. 379

1. To rename a path, move the mouse pointer on a path in the list and double click on it.
2. Enter the name of path.
3. Press Enter to confirm editing.

Naming the path

Creating a manual path

In Sequence Diagram Animacian dialog box, all paths are listed in Paths list by default. However, you can manage the flow of animation with your
own choice. To create a manual path:
1. Select Manual in Paths.

Selecting Manual in Paths

2. Press Add Path to insert a new path.

3. Select the shapes that are shown on the Components list to direct the flow of animation.
4. Click OK to confirm editing.

Animating sequence diagram P. 380

Handling decision
You should choose an operand when there is more than one option in the interaction. Different decisions will lead to different forks and make a different
outcome for the flow of animation. Make either decision to view the outcome.

Making a decision for the flow of path

Reviewing an animation
1. When everything is ready, click Play to start the animation of the selected path.
2. After click Play, Sequence Diagram Animacian dialog box will be minimized to the bottom of your diagram, with several buttons and a slider
revealing on it.
Button Name Description

BackwardMove one shape backward in the flow.

Pause Temporary stop playing the movie. Press Play

to continue to play.

Play Play or continue to play the animation.

Forward Advance to the next shape in the flow.

Stop Terminate the animation.

MaximizeMaximize Animacian.

Description of Animacian bar

3. When the animation starts, a black ball will appear at beginning of path and traverse through the path until the end.

Animating sequence diagram P. 381

4. When the black ball reaches a shape, the shape will turn into purple.

Reviewing the animation

Animating sequence diagram P. 382

Animating activity diagram
By animating an activity diagram with Animacian, you can see the flow of actions in active.
1. Select Tools > Animacian... from the main menu.

Launch Animacian through the main menu

2. In Activity Diagram Animacian dialog box, select a path and then click Play.

Clicking Play in Activity Diagram Animacian dialog box

Animating activity diagram P. 383

Overview of Animacian
The Activity Diagram Animacian dialog box will pop out after clicking Animacian.... This dialog box is where you can select an execution path to play
an animation.

Activity Diagram Animacian dialog box

No. Name Description

1 Backward Move one shape backward in the flow.

2 Play Play or continue to play the animation with Animacian minimized.

3 Stop Terminate the animation.

4 Forward Advance to the next shape in the flow.

5 Slider It is used for controlling the flow of animation.

6 Paths It provides two ways of producing animation for the possible paths.
Automatic: It is chosen by default. This helps you to detect all possible paths automatically.
Manual: Choose when you want to select the possible path(s) manually.

7 Paths list It lists all possible ways of executing an Activity. By default, paths are named as Path1, Path2, and so forth. You can
rename them by double clicking on them and giving meaningful names.

8 Components list It displays all components of the selected path. Pressing on a component will highlight the first shape of the chosen
path until the chosen shape in the diagram.

9 Refresh It is used for re-identifying the paths base on filter assignment and diagram content.

10 Filter... It helps removing the non-selected paths by specifying the end result of fork nodes.

12 Export to Flash... Select an output path for exporting this diagram's animation to Adobe Flash.

13 Minimize Click to minimize this dialog box.

14 Options pane The Options pane helps you to configure animation.

Animating activity diagram P. 384

15 Advanced Options... It provides the color and speed options for animation.

16 OK Click this button to confirm the settings and close Animacian.

17 Cancel Click this button to close Animacian without saving the editing.

Description of Activity Diagram Animacian dialog box

Advanced options

Advanced Options dialog box

Name Description

Visited error fill color The background color of visited shape that cause an error. An error means the flow object that causes a
path invalid.

Visited fill color The background color of visited shapes.

Visited line color The line color of visited shapes.

Visited font color The font color of visited shapes.

Visited line width The thickness of visited shape's border.

Ball color The color of ball that goes through a path during animation for indicating the progress of flow.

Speed The pace of animation.

Flash progress bar background color 1 The background color for the top of progress bar in exported Flash movie.

Flash progress bar background color 2 The background color for the bottom of progress bar in exported Flash movie.

The description of Advanced Options dialog box

Animating activity diagram P. 385

1. To rename a path, move the mouse pointer on a path in the list and double click on it.
2. Enter the name of path.
3. Press Enter to confirm editing.

Naming the paths

Creating a manual path

In Activity Diagram Animacian dialog box, all paths are listed in Paths list by default. However, you can manage the flow of animation with your own
choice. To create a manual path:
1. Select Manual in Paths.

Selecting Manual in Paths

2. Press Add Path to insert a new path.

3. Select the shapes that are shown on the Components list to direct the flow of animation.
4. Click OK to confirm editing.

Animating activity diagram P. 386

Handling decision
You should choose an outgoing flow when there is more than one option in the flow. Different decisions will lead to different forks and make a different
outcome for the flow of animation. Make either decision to view the outcome.

Making a decision for the flow of path

Reviewing an animation
1. When everything is ready, click Play to start the animation of the selected path.
2. After click Play, Activity Diagram Animacian dialog box will be minimized to the bottom of your diagram, with several buttons and a slider
revealing on it.
Button Name Description

BackwardMove one shape backward in the flow.

Pause Temporary stop playing the movie. Press Play

to continue to play.

Play Play or continue to play the animation.

Forward Advance to the next shape in the flow.

Stop Terminate the animation.

MaximizeMaximize Animacian.

Description of Animacian bar

3. When the animation starts, a black ball will appear at beginning of path and traverse through the path until the end.

Animating activity diagram P. 387

4. When the black ball reaches a shape, the shape will turn into purple.

Reviewing the animation

Animating activity diagram P. 388

Export animation to adobe flash
Exporting flash movie from animacian
1. To launch Animacian, select Tools > Animacian from the main menu.

Open Animacian through the main menu

NOTE: Animacian can also be started by any of the ways below:

• Right click on the diagram background and select Utilities > Animacian... from the popup menu.
• Click the drop-down menu of Modeling Tools and select Animacian... on the toolbar.

The Business Process Diagram Animacian dialog box pops out. You can select an execution path to play an animation in the dialog box.
2. From the Paths list, select the execution paths to export as Flash movie.

Select paths to animate

Export animation to Adobe Flash P. 389

3. Click the Export to Flash... button.

Click the Export to Flash... button

This shows the Export to Flash dialog box.

The Export to Flash dialog box

Here is a description of the Export to Flash dialog box.

Region Description

Path The path of the exported HTML file. Flash movie file (.swf) will also be exported to the same folder as the HTML file.

Launch When checked, default web browser will automatically start and play the exported Flash movie.
Viewer

Dimension The width and height of viewing region of Flash.

Available Available paths that can be selected to export to Flash movie for animation.

Selected Selected paths to export to Flash movie for animation.

Description of the Export to Flash dialog box

4. An HTML web page will be exported. Specify the path of the HTML file. Note that the Flash movie files (.swf) will be exported to the same folder
as the HTML file.
5. Choose or enter the dimension of movie if necessary. Note that the dimension determins the size of viewable region instead of the size of
diagram.

Select the Flash movie dimension

6. Click Export button.

Click the Export button

Export animation to Adobe Flash P. 390

7. Open the HTML file in the web browser to play the movie.

Animation is playing

8. If there are more then one path being selected, you can click on the drop down menu at top right corner and select another path to play with.

Navigation in exported movie

You can control the flow of movie by clicking on the buttons at the bottom of the movie or by pressing shortcut keys. Here is a list of buttons.

Button Description

Backward. Move one shape backward in the flow.

Pause. Temporary stop playing the movie. Can play again by pressing the
button.

Play. Play or continue to play the movie content.

Forward. Advance to the next shape in the flow.

Stop. Terminate the movie.

Buttons in exporting Flash movie

You can also click on the slider to move the animation to a desired position.

Navigate in the Flash movie by dragging slider

Export animation to Adobe Flash P. 391

Depending another project
Depending another project enables you to reference to another project, and use its model elements in developing your own project. You can organize
your model elements in a more disciplined approach by having one project per library project. This also helps you to "slim up" projects through breaking
down a project into smaller pieces. Moreover, you can reference to other projects, and create an overview project for them.
To reference to another project:
1. Right click on the background of any of the following panes and select Manage Dependent Project... from the pop-up menu.
• Diagram Navigator
• Model Explorer
• Logical View

Right click on Diagram Navigator and

select Manage dependent project...

2. In the Manage Dependent Projects dialog box, click Add button.

Click Add button

3. In the Open dialog box, choose the Agilian project file (*.vpp) to reference to and click Open.
4. When you return the Manage Dependent Projects dialog box, click Close button.

Depending Another Project P. 392

Referencing other projects' model elements
Once a dependent project has been established, you can develop your model using model elements in dependent project. To do this:
1. In Model Explorer, click on the drop-down menu at the top of the pane and select the project that contains the model elements you want to use.

Select a dependent project

NOTE: By selecting the first selection (Current), model elements in the current project will be listed.

2. In the model element list, drag the target model element(s) and drop it/ them on diagram. This creates views from them. In addition, you may
continue modeling with the referenced elements. Note that Views for dependent project are read-only (i.e. non edit-able).

Drag model elements from dependent project

NOTE: Alternatively, you can right click on the model elements and select Create View in Active Diagram from the pop-up menu.

Indicating dependent elements on diagram

In order to know which shape(s) on a diagram comes from a dependent project, you can enable to model element indicators. Click on the Show Model
Element Indicators button at the top of diagram toolbar.

To show model element indicators

After that, you can see the indicator, which is a small arrow, appear at the shapes that are referencing a dependent project.

Model element indicator appears

Referencing other projects' model elements P. 393

Mirroring model element
Due to views of dependent model elements are read-only, you cannot add shapes in it. This may be a problem when you want to use dependent
packages in your project, and to add model elements such as classes in it. To overcome this problem, you can create a mirror of container-typed
dependent model element. By mirroring, a dependent element is localized partially by keeping a mirrored copy in your project which echoes the
element in dependent project. The mirrored copy can be accessed in Model Explorer that lists model elements in current project, but not editable.
To create a mirror from a container-typed dependent model element (e.g. package, pools/lanes), right click on the element in Model Explorer and
select Create Mirror Model Element from pop-up menu.

Mirror a dependent class

By doing so, you can use it in your project and add shapes in it. If you have already created a view for a non-mirrored element and you want to create a
mirror, you may right click on the shape and select Convert to Mirror from pop-up menu.

Mirroring model element P. 394

Viewing dependent diagrams
Sometimes, you may want to take a look at the design created in dependent project to make yourself familiar with it. Instead of the traditional way of
opening a project, you can read diagrams of dependent diagrams by scrolling down to the bottom of diagram navigator, expanding the dependent
project node and double clicking on a diagram node to open it. Note that the diagram is read-only.

Reading diagram in dependent project

Viewing dependent diagrams P. 395

Duplicating element from linked project
When we have added a dependent project, we say we are referencing that project. By reference, it’s like a linkage that points to the actual data
stored in dependent project. Those elements borrowed from dependent project are not editable by current project.
Sometimes, you need the elements created in another project, not to appear as form of references, but to make it become your own data. You will
need to duplicate element from linked project. To duplicate a model element:
1. Open the Model Explorer.
2. Right click on the element you want to duplicate ands elect Duplicate to Current Project from the popup menu.

Duplicate a model element

The duplicated element can be found in Model Explorer, under current project.

Duplicated element appear in model explorer

Duplicating element from linked project P. 396

What is nickname?
We all have a name, and we may have multiple names such as nicknames or names in other languages. This is the same for your VP-UML project
content. While we have applied certain language in naming and documenting model elements, we may have the need to model with another language
to satisfy the readers of model. The nickname feature is designed to let you define multiple language sets for a model. Further to the definition of
nickname, you also can make use of the translate function to translate your work into another language.
One model element can have one Original name and multiple nicknames, and the same for documentation. With nickname, you can define and
view different names without affecting the original name of model elements. You can disable the effect of nickname anytime by switching to Original
nickname. Features that related to code generation will always use Original name, i.e. changing Class's name in other nicknames will not affect the
generated code.

The following image shows the diagram in original name:

Original name

After you define a nickname and rename model element, the diagram will be switched to the selected nickname.

Select a nickname

What is nickname? P. 397

Multi-national team
If you are working in a team and your members using different languages, you can define model elements name and documentation in multiple
languages. Each member can choose their own language for modeling or view diagrams. The following example demonstrates the Business Process
Diagram in English and French:

Original version of a business process

You can create a French nickname and rename the model elements:

Chinese version of a business process

Now you can switch between English (Original) and Traditional Chinese anytime, or even creating more nicknames.

What is nickname? P. 398

Increase readability of entity relationship diagram
The name of Entity will be used to generate SQL, but Database Management System (DBMS) has many constraints on the name of Entity, Column,
etc, and each DBMS are different. These constraints include the length of the name, reserved keywords, special characters, etc. They restricted the
database designer to create an Entity Relationship Diagram (ERD) with meaningful names. With nickname, you can freely change any names to
create a high readability ERD without affecting the generated SQL. The following diagram display ERD in nickname but generate SQL in original name:

Generate SQL with original name

What is nickname? P. 399

Configure nickname
You can add a nickname through the nickname drop down menu that appears in toolbar, or through the appropriate menu under the View menu in
menu bar. By adding a nickname, you can start editing the names and documentations of model elements under the new nickname.

Overview of Configure Nickname dialog box

An overview of Configure Nickname dialog box

No. Name Description

1 Original user The language (e.g. English) of the Original nickname The selection only affects the outcome of translation.
language

2 Nickname list List all the nicknames.

3 Add Click to add a nickname with a name.

4 Add user language Click to add a nickname with selected language.

5 Rename Click to rename a chosen nickname.

6 Remove Click to delete a chosen nickname.

7 Export Click to export an XML file that contains information about the original name and nickname of the name and
documentation of model elements that are named differently in nickname.

8 Import Click to import the XML exported from Configure Nickname dialog box.

9 OK Click to apply the nickname configuration and close this dialog box.

10 Cancel Click to close the dialog box without applying the changes.

Description of Overview dialog box

Adding nickname

Configure nickname P. 400

1. Click on the drop down menu of Modeling Tools on the toolbar and select Nicknames > Configure Nicknames....

Configure Nicknames

NOTE: If you do not see this drop down menu, it could be due to the toolbar is being turned off. You can show it by right clicking on the empty
space on the toolbar and selecting Nickname from popup menu, or simply, access the same function by selecting View > Nicknames >
Configure Nicknames... from the main menu.

2. The current working copy is by default in Original nickname, with English as user language. Click Add in the Configure Nickname dialog box.
3. In the Input dialog box, enter the name of the nickname set and click OK to confirm. Click OK to close the Configure Nickname dialog box.

Two nicknames are added

Renaming nickname

Configure nickname P. 401

1. Click on the drop down menu of Modeling Tools on the toolbar and select Nicknames > Configure Nicknames....

Configure Nicknames

NOTE: This is If you do not see this drop down menu, it could be due to the toolbar is being turned off. You can show it by right clicking on
the empty space on the toolbar and selecting Nickname from popup menu, or simply, access the same function by selecting View >
Nicknames > Configure Nicknames... from the main menu.

2. In the Configure Nickname dialog box, select the nickname to rename. Click Rename.

NOTE: You are not allowed to rename the original nickname.

3. In the Input dialog box, enter the name of the nickname set and click OK to confirm. Click OK to close the Configure Nickname dialog box.

Removing nickname
1. Click on the drop down menu of Modeling Tools on the toolbar and select Nicknames > Configure Nicknames....

Configure Nicknames

2. In the Configure Nickname dialog box, select the nickname to remove. Click Remove. Click Yes when you are asked for confirmation

NOTE: You are not allowed to remove the original nickname.

Configure nickname P. 402

Specifying user language for the nickname
There must be an original nickname in every project, namely Original, representing the most standard version of language of project. You can specify
the language for the original nickname, such as German. The language you have set affects the outcome of translation.

Select original user language

To add a nickname in specific language, click on the Add User Language... button and select a language.

Add a user language

Configure nickname P. 403

Using nickname
Once you have defined a nickname, you can start updating your model by entering the new names and documentations of model elements.

Start updating elements' nickname

1. From the application toolbar, select the nickname you need to work with.

Select a nickname to work with

2. Start renaming model elements and updating their documentation. The changes you make will only be applied to the selected nickname.

Update the name and documentation of elements under a nickname

Switching between nicknames

The names and documentations of model elements are language specific. This means that, the change you make applies only to a specific nickname.
Once you have switched to another nickname, the names and documentations of model elements will be updated to show the definition under the new
nickname.
To switch between nicknames, select the nickname to switch to from the drop down menu of nickname in application toolbar.

Switch nickname

Using nickname P. 404

Translation
Further to the definition of nickname, you also can make use of the translate function to translate your work into another language. This is particularly
useful when you want to add a new nickname for another different language, without entering all names and documentations from the beginning.
To perform a translation:
1. Right click on the shape you want to perform translation and select Translate... from the pop-up menu.

Perform translation on a shape

NOTE: Make sure you are working under a nickname in order to see the Translate menu.

Translation P. 405
2. In the Translate dialog box, the left hand side displays the name and documentation of the chosen shape in the language set for original
nickname, which is English by default, while the right hand side displays name and documentation in the language of the active nickname.

Translation outcome

3. Review and make necessary correction to the translated outcome. You can change to translate to another language by selecting a different
language from the drop down menu at the bottom right corner of dialog box, and then click the Translate button. Click OK button to proceed
with translation.

A translated business task

Translation P. 406
What is visual diff?
The situation of comparing two diagrams is common. For example, comparing an ERD of conceptual model with an ERD of physical model and
comparing a domain class diagram with a class diagram ready for implementation. VP-UML allows you to compare the differences between diagrams
in order to trace the changes between them.

Diagram comparison
With the feature of Visual Diff, two diagrams can be compared to recognize their differences. Changes, such as modification of properties (e.g. name)
and addition/removal of containing models, thereby can be found easily.

The overview of Visual Diff dialog box

Various comparison strategies

A comparison strategy determines how two diagrams will be compared. Each strategy is used for its own specific purpose. You can select the
appropriate strategy that suits your case most. The following is the description of strategies:

Strategy Description

ID Shapes will be matched base on their internal ID. Differences between shapes that have same ID will be displayed in the result pane. This
strategy is usually used to visualize the changes of same shapes in two projects.

Name Shapes will be matched base on their names. This strategy is useful when visualizing differences for external works. One of typical
examples is to compare databases and class models.

Transitor Shapes will be matched base on their transition established by Model Transitor. This way of comparison is usually used to visualize the
differences between model elements.

Description of comparison strategies

Comparing view only, model element only, or both

Comparison is divided into view, model element and both of them. The selected option from the drop-down menu of Compare determines the display
for comparison. By selecting View, the differences in view settings, such as the coordination of shapes, will be considered as changes. By selecting
Model Element, the differences in model element level, such as their names, will be considered as changes. By selecting All, the differences in both
view settings and model element level are displayed.

What is visual diff? P. 407

The following screenshot displays both view and model element differences:

Compare All

The result of selecting View is shown as follows:

Compare View

What is visual diff? P. 408

The result of selecting Model Element is shown as follows:

Compare Model Element

What is visual diff? P. 409

Comparing from the left to the right and vice versa
Comparisons are made between two diagrams, which are put on the left and the right hand side in the Visual Diff dialog box respectively. By default,
comparison is based on left hand side, which means, if a shape does not exist on the left hand side but on the right hand side, the shape will be
considered as newly added in the result pane. The base can be swapped from the right to the left, and vice versa. By doing so, the absence of shape
on the left hand side will result in a report of deleted shape.

Comparing diagrams with right hand side as base

What is visual diff? P. 410

The result of left hand side as base is shown below. The deleted model element is regarded as an addition (it indicates as New).

Comparing diagrams with left hand side as base

Exporting a report of differences

A report of the current comparing diagrams can be saved in your computer as PDF. Click Export PDF... button on the bottom left corner of the dialog
box. Select a directory for storing in Export PDF dialog box and then click Save button.

Click Export PDF... button

What is visual diff? P. 411

Comparing as-is and to-be business process diagram
In this page, two Business Process Diagrams are compared: one for modeling the As-is Process and another for modeling the To-be Process. The
features of Visual Diff are applied in order to find the differences between them.

Comparing as-is and to-be business process diagram P. 412

1. In As-Is Process diagram, select Tools > Visual Diff... from the main menu.

Launch Visual Diff through the main menu

NOTE: Alternatively, you may start Visual Diff as follows:

• Right click on diagram background and select Utilities > Visual Diff... from the pop-up menu.
• Click the drop-down menu of Modeling Tools and select Visual Diff... on the toolbar.

The overview of Visual Diff dialog box:

Comparing as-is and to-be business process diagram P. 413

2. In Visual Diff dialog box, the left hand side window shows the currently opened diagram by default. You may remain it unchanged; otherwise
uncheck Use Working Project on the left hand side if you want to select a diagram in other projects to compare with. Click ... button in Project
to select the directory of other projects. Similarly, check/ uncheck Use Working Project on the right hand side window.

Check Use Working Project

3. Select the To-be Process diagram to compare with from the drop-down menu of Diagram.

Select a diagram for comparison

The two diagrams are shown side by side on display pane. However, the ways of comparison has not yet been configured. Let's configure them
one by one in the following steps.

Two diagrams are selected

4. Select an option in Strategy.

Select a strategy

Comparing as-is and to-be business process diagram P. 414

5. Select an option in Compare.

Select a compare

6. Choose an option in Base.

Choose a base

7. Select an option in Filter.

Select a filter

8. Once everything is set, the differences of the two diagrams will be shown on the result pane.
9. If you want to view a specific shape, you may click its node on the result pane, and then the selected shape will be painted in dark purple on the
display pane.

Select a node on the result pane

Comparing as-is and to-be business process diagram P. 415

Comparing logical and physical ERD
Entity relationship diagram (ERD) represents a detailed picture of the entities needed for a business. In forward engineering, ERD will be transformed
into a relational database eventually. There are at least two types of ERD – Logical and Physical. They are used in different stages of
development, and are inter-related.
Logical ERD models information gathered from business requirements. Entities and relationships modeled in such ERD are defined around the
business's need. The need of satisfying the database design is not considered yet.
Physical ERD represents the actual design of database. It deals with conversion from logical design into a schema level design that will be transformed
into relational database. When modeling a physical ERD, Logical ERD is treated as base, refinement occurs by defining primary keys, foreign keys and
constraints. Sometimes, relationships need to be resolved by introducing additional tables, like a Linked table for a many to many relationship.
Since physical ERD and logical ERD represent the business requirement and database schema respectively, comparing physical and logical ERD
helps to find out the differences between them in order to confirm the database is exactly following the initial business requirements regardless of the
changes.
Two ERDs are compared: one for modeling the Logical Model and another one for modeling the Physical Model. With the features of Visual Diff, the
differences between Logical and Physical ERD can be found easily.

Comparing logical and physical ERD P. 416

1. In Logical ERD diagram, select Tools > Visual Diff... from the main menu.

Launch Visual Diff through the main menu

NOTE: Alternatively, you can start Visual Diff as follows:

• Right click on diagram background and select Utilities > Visual Diff... from the pop-up menu.
• Click the drop-down menu of Modeling Tools and select Visual Diff... on the toolbar.

The overview of Visual Diff dialog box:

Comparing logical and physical ERD P. 417

Select Use Working Project

3. Select the Physical ERD to compare with from the drop-down menu of Diagram.

Select a diagram

The two diagrams are shown side by side on display pane. However, the ways of comparison has not yet been configured. Let's configure them
one by one in the following steps.

Two diagrams are selected

4. Select an option in Strategy.

Select a strategy

Comparing logical and physical ERD P. 418

5. Select an option in Compare.

Select a compare

6. Choose an option in Base.

Select a base

7. Select an option in Filter.

Select a filter

Select a node in the result pane

Comparing logical and physical ERD P. 419

Defining design pattern
In VP-UML, design pattern is a part of diagram that can be used in many different diagrams, thus form a pattern. Design pattern typically shows the
shapes and more importantly, the relationships between the shapes. You can define and reuse design pattern in your project, across projects, or share
with your team members. You can define and apply design patterns on any kinds of diagram.
In order to apply a pattern, you need to define it first, and save it as a pattern file ready for being used. To define a pattern, draw the pattern on
diagram. After that, you can save the pattern, which is the diagram content as a pattern file.

Defining design pattern

1. In the diagram where the pattern was drew, select the shapes to be involved in pattern.
2. Right click on any selected shapes, select Define Design Pattern... from the popup menu.

Defining design pattern

3. A design pattern is needed to save as a file. In the Define Design Pattern dialog, specify the name and file name for the pattern, with .pat as
extension. You can save the pattern file to workspace for ease of sharing with other projects that will be opened in current workspace. Besides,
you can save to another directory and share the .pat file with your team member for reusing. Click OK button to finish defining design pattern.

Naming design pattern

Defining design pattern P. 420

Applying design pattern
You can apply a previously defined design pattern into your diagram, and modify it to make it fit into your design. To apply a design pattern:
1. Open an existing diagram where you want to apply a design pattern or create a new diagram.
2. Right click on diagram, select Utilities > Apply Design Pattern... from the pop-up menu.

Apply design pattern

3. In Design Pattern dialog, you can see a list of defined patterns, select Factory from the list.

Select pattern

If you have a .pat file, click Add button to import into the list.

Add pattern

Applying design pattern P. 421

4. For searching a specify shape on the defined pattern, select the shape from the drop-down menu of Diagram Element to filter the list.

Fill in values

You can also click on the shape or select a diagram element from the Diagram Element combo box to filter the list.
5. Finally, click OK button. The pattern will be applied to the diagram.

Applying design pattern P. 422

Synchronize design pattern with teamwork server
Teamwork server can synchronize design patterns defined and saved to workspace, you can then share the design patterns with your team members.
This feature is available to Visual Paradigm Teamwork Server, Subversion, CVS and Perforce.

Synchronize local design pattern to server

1. Click Team Collaboration > Open Teamwork Client on toolbar, or select Tools > Teamwork > Open Teamwork Client... from the main
menu.
2. Login to the teamwork server.
3. In the Teamwork Client dialog box, select Repository > Synchronize Design Pattern to Server from the menu.

Synchronize Design Pattern to Server

4. In the Pattern Synchronization dialog box, verify your desired design pattern and action and click OK button to continue. The pattern will be
committed to teamwork server.

Commit pattern

Synchronize design pattern from server

1. Start VP-UML with another user and use a different workspace.
2. Create a diagram.
3. Right click on the diagram's background, select Utilities > Apply Design Pattern... from the pop-up menu.
4. After you open the Teamwork Client dialog box, select Repository > Synchronize Design Pattern to Server.

Synchronize Design Pattern to Server

Synchronize design pattern with teamwork server P. 423

5. When the Pattern Synchronization dialog box pops out, it displays that your pattern is available for update from teamwork server. Click OK
button and the pattern will be updated from teamwork server to workspace.

Update pattern

6. Open an existing diagram where you want to apply a design pattern or create a new diagram. Right click on the diagram background and select
Utilities > Apply Design Pattern... from the pop-up menu. The design pattern is available on the list of Design Pattern dialog box. You can
now select the pattern and apply to your project.

Apply design pattern again

Synchronize design pattern with teamwork server P. 424

Model transitor for shape
You can use different diagrams for modeling different phrases of development, such as a diagram for modeling the current system, and another
diagram for modeling to system to be implemented. In order to trace the evolution of model elements across diagrams, you can make use of model
transitor. Model transitor enables you to establish transit relationship between shapes. With the transition relationship, you can trace between shapes
across diagrams.

Adding a transition between shapes

1. Right click on the shape you want to add a transition. It can be the source or target shape within the transition to add.

Right clicking on a class

2. If you are right clicking on the source shape, select Related Elements > Transit To > Manage Transit To... from the popup menu. If you are
right clicking on the target shape, select Related Elements > Transit To > Manage Transit From... from the popup menu.

To manage transition

3. In the Manage Transit To/From Model Elements dialog box, select the shape(s) you want to transit to/from. You can select multiple shapes to
transit to/from. For example, an initial Purchase Order class will be transited to an Order class and an OrderItem class.

Select shapes to transit to

Model transitor for shape P. 425

Navigating transited shape
Once a transition is added between two shapes, you can navigate between them. There are two methods to navigate to a transited shape. The first
way is to go through the transitor popup menu of a shape. Right click on a shape and select Related Elements > Transit From/To from the popup
menu, then the shape to navigate to.

Navigate to a transited shape through the popup menu

The second method is to make use of the resource centric interface. Here are the steps:
1. Move the mouse pointer over the shape that you want to navigate to its transited shape.
2. Press on the Model Transitor resource icon below the shape. Select Transit From/To, then the shape to navigate to.

Navigate to a transited shape through the resource centric interface

Removing a transition
To remove a transition between shapes:
1. Right click on a shape and select Related Elements > Transit From/To > Manage Transit From/To from the popup menu.
2. In the Manage Transit To/From Model Elements dialog box, de-select the shapes that you do not want to transit with. Click OK to confirm.

De-select shapes to withdraw from transition

Model transitor for shape P. 426

Model transitor for diagram (diagram transitor)
You can use different diagrams for modeling different phrases of development, such as a diagram for modeling the current system, and another
diagram for modeling to system to be implemented. Sometimes, diagrams across phrases are similar, but little variation. Model transitor enables you
to duplicate a diagram with transition added in between. You can then continue modeling in the new diagram by using the original diagram's content as
base.

Transiting to a new diagram

1. Right click on the background of diagram that you want to transit from. Select Utilities > Transit to New Diagram... from the pop-up menu.

To transit to a new diagram

2. The Select Parent Model of New Diagram dialog box appears, enabling you to select a model for storing diagram. Visual Paradigm
encourages structuring project with model for easier accessing of model elements and increasing application performance. If you want to place
the new diagram in a model, select one or click New Model button at the top right to create one and select it. If you do not want to store diagram
inside any model, do not make any model selection. Click OK button to continue.

Selecting a model for storing the new diagram

3. You can then start editing the new diagram.

Editing transited diagram

Model transitor for diagram P. 427

Navigating transited shape
By adding a transition between diagrams, transitions are automatically added between shapes in the two diagrams. With the transition between
shapes, you can navigate between them. There are two methods to navigate to a transited shape. The first way is to go through the transitor popup
menu of a shape. Right click on a shape and select Related Elements > Transit From/To from the popup menu, then the shape to navigate to.

Navigate to a transited shape through the pop-up menu

The second method is to make use of the resource centric interface. Here are the steps:
1. Move the mouse over the shape that you want to navigate to its transited shape.
2. Press on the Model Transitor resource icon below the shape. Select Transit From/To, then the shape to navigate to.

Navigate to a transited shape through the resource centric interface

Model transitor for diagram P. 428

Applying stereotype to model element
A stereotype defines how a model element may be extended, and enables the use of platform or domain specific terminology or notation in place of, or
in addition to, the ones used for the extended metaclass. In VP-UML, you can apply one or more stereotypes to model elements, and decide whether
or not to visualize the stereotype or tagged values in views. To apply stereotype to model element:
1. Right click on the model element, or the view of the model element that you want to apply stereotype to. Select Stereotypes from pop-up menu.

To select a stereotype

Depending on the type of model element you are selecting, there may be a list of suggested stereotypes listing in the menu popped up. It
consists of both the recently used stereotypes and stereotypes that place at the top of stereotype list. If you see the stereotype you want to
apply, select it. Otherwise, select Stereotypes... at the bottom of the menu to look for others.
2. In the Stereotypes tab of specification dialog box, select the stereotype you want to apply, then click > to assign it to the Selected list.

Stereotype Enum is selected

NOTE: You can also double click on a stereotype to apply it.

NOTE: While clicking on > applies the selected stereotype to model element, you can click < to remove a stereotype selected in Selected list.
If you want to apply ALL available stereotypes to model element, click >>, and likewise, clicking on << removes all the applied
stereotypes.

3. Click OK to confirm. The stereotype will then be shown within a pair of guillemets above the name of the model element. If multiple stereotypes
are applied, the names of the applied stereotypes are shown as a comma-separated list with a pair of
guillemets.

Stereotype Enum is applied to a class

Apply Stereotype to Model Element P. 429

Robustness analysis icon
Robustness analysis helps to find out the relationships between actor, boundary, control and entity objects.

Robustness analysis icons

To draw a robustness analysis diagram with robust analysis symbols:

1. Create a class in diagram.
2. Depending on the type of robustness analysis symbol you want to create, apply either boundary, control and entity stereotype to the class.

To apply entity stereotype to User class

NOTE: If you want to let a class display as traditional class shape instead of robustness analysis icons, right click on the class and de-select
Presentation Options > Display as Robustness Icon from the popup menu.

Presenting a shape as stereotype icon

You can specify icon for a stereotype (Read the next chapter for details). When a stereotype is applied to a model element, you can let the stereotype
icon show above the name of model element, which is the default presentation, or to make the model element show as the icon. To present a shape as
stereotype icon, right click on the shape and select Presentation Options > Stereotype Icon from the popup menu.

Different presentations of a model element with a stereotype that has icon defined

Showing or hiding stereotype

By default, applied stereotypes are shown within a shape. Yet, it is up to you whether to show or hide them. Furthermore, you can choose not to
display the stereotypes, but to display only their tagged values.
To update the visibility of stereotypes, right click on the background of diagram where the shapes exist. Select/De-select Presentation Options >
Show Stereotypes from the popup menu.

A use case with stereotype names shown and hidden

Apply Stereotype to Model Element P. 430

Configure stereotypes
You can configure stereotypes, not just to create and name stereotypes for specific model element types, but also to format stereotypes like to set their
colors, line formatting and font, and to define their tagged values. By configuring stereotypes, domain specific stereotype set can be built.
To configure stereotypes:
1. Select Tools > Configure Stereotypes... from the main menu.

Configure stereotypes

2. Click on the drop down menu Scope at the top left corner of the Configure Stereotypes dialog box, select whether to configure stereotypes in
workspace or in the opening project.

NOTE: Initially, stereotypes exist in workspace rather than in project. When you apply a stereotype to any model element, a copy of that
stereotype will be made from workspace to project.
By modifying stereotype in workspace, changes will not be applied to current project nor any project that has used the stereotype
because the stereotype copied to project is being followed. If you want to configure stereotype only in current project, you must select
Project as scope, or select Workspace but let the option Apply changes to stereotypes in current project on to make changes apply
on both workspace and project.

3. Select the type of model element that you want to add stereotype or edit its existing stereotypes.

Select class to edit its stereotypes

4. You may now perform any of the following action:

• If you want to edit an existing stereotype, select the stereotype and click Edit....
• If you want to add a stereotype, click Add....
• If you want to remove a stereotype, select the stereotype and click Remove.

5. If you are adding or editing a stereotype, update its specification and click OK to confirm editing. For details about editing a stereotype, read the
coming section.
6. Click OK to confirm.

An overview of Configure Stereotypes dialog box

Configure stereotypes P. 431

An overview of Configure Stereotypes dialog box

No. Name Description

1 Scope Initially, stereotypes exist in workspace rather than in project. When you apply a stereotype
to any model element, a copy of that stereotype will be made from workspace to project.
By modifying stereotype in workspace, changes will not be applied to current project nor
any project that has used the stereotype because the stereotype copied to project is being
followed. If you want to configure stereotype only in current project, you must select Project
as scope, or select Workspace but let the option Apply changes to stereotypes in
current project on to make changes apply on both workspace and project.

2 Model element list A list of categorized model element types. You can select a type to configure its stereotypes.

3 Stereotypes A list of stereotypes of the selected model element type.

4 Apply changes to stereotypes in current project Available only when scope is Workspace, this option cause the stereotype configuration
applies to both stereotypes in workspace and project, when pressing OK .

5 Duplicate Click to duplicate the stereotype selected in Stereotype pane.

6 Import Click this to import stereotype configuration (an XML) produced by others. Once clicked,
the Import Stereotypes dialog box will popup. You need to choose the XML file to import.
At the bottom of the dialog box, there is an option Add and update only (do not delete
stereotypes). When checked, VP-UML will only add and update stereotypes from XML.
When unchecked, VP-UML will add and update stereotypes, and additionally delete
stereotypes that are not defined within the XML.

7 Export Click to export stereotype configuration to an XML file.

8 Add Click this to add a stereotype for the selected type of model element.

9 Edit Click to edit the selected stereotype.

10 Remove Click to delete the selected stereotype.

11 OK Click to apply the configuration and close the dialog.

12 Cancel Click to discard the changes (if any) and close the dialog box.

13 Help Click to open the Help contents.

Description of Configure Stereotypes dialog box

Configure stereotypes P. 432

Editing stereotype
By adding or editing a stereotype, you can specify its icon and adjust its fill, line and font style in the General page within the Stereotype
Specification.

Editing stereotype

By applying a stereotype that has icon defined to a model element, the icon above the name of model element, near the stereotype. You can optionally
make the model element show as the icon. For details, read the previous chapter. To specify icon, click on the ... button near the preview of Icon. Then,
select the image file of icon.
Fill, line and font styles will be applied automatically to model elements that have the stereotype applied. To adjust fill/line/font, check the corresponding
Use button. Then, click on the ... button to edit the settings.

Defining tagged values for stereotypes

A stereotype may have properties, which may be referred to as tag definitions. When a stereotype is applied to a model element, the values of the
properties may be referred to as tagged values.
You can define tagged values for stereotypes. By doing so, when you apply the stereotype with tagged values defined to a model element, you can fill
in the values for the model element.
1. Select Tools > Configure Stereotypes... from the main menu.
2. In the Configure Stereotypes dialog box, select the stereotype that you want to define tagged value and click Edit. If you want to add a new
stereotype, select the base model type and click Add...
3. In the Stereotype Specification dialog box, open the Tagged Value Definitions tab.
4. Click Add. Select the type of tagged value to define. The type of tagged value limits the type of content user can enter for a tag.

Adding a tag

Tag type Description

Text The most common and general type of tagged value that consists of words.

Multi-line Text The value of tag is a text in multiple lines.

Model element The value of tag is a model element in project.

Enumeration The value of tag can be chosen from a list of possible values. For example, to select "red" out of values red, green
and blue.

Integer The value of tag must be a real number.

Floating point The value of tag must be a number that consists of one or more digits.
number

Type of tags

Configure stereotypes P. 433

5. Double click the name cell and enter the name of tag. Repeat step 4 and 5 to add all tagged values for this stereotype.

Tags defined for an API stereotype

6. You can assign a default value to a tag by editing the Default Value cell. Usually, you give a tag a default value when the value is true in most
cases. For example, a tag "in-door-temperature" can have "25" as default value.

Configure stereotypes P. 434

Shortcut of creating stereotyped model element
One of the ways of creating a shape is by selecting the element type in diagram toolbar, and clicking on diagram to create a shape of that type. If then
you want to apply a stereotype to that model element, you will open the specification dialog box and make a stereotype selection. These steps can be
simplified by adding a shortcut in diagram toolbar, for creating a type of model element with specific stereotype pre-set. To do so:
1. In any diagram, click on the double down arrow button at the top of diagram toolbar, then select Configure Buttons... from the popup menu.

To configure buttons

2. In the Configure Buttons dialog box, expand the node(s) of model element type(s) that you want to add shortcut for. Select the stereotype that
you need to apply to that type of model element in future. Click > or double click on it to assign. Click OK to confirm.

Configure buttons in diagram toolbar

3. After all, you can find the shortcuts in diagram toolbar, under the selected type(s) of model elements. By selecting a stereotyped model element
type and click on diagram, you can create a shape with stereotype applied.

Create a stereotyped shape

Shortcut of creating stereotyped model element P. 435

Creating a profile
A UML profile provides a generic extension mechanism for customizing UML model elements for different purposes. Profiles are defined using
stereotypes and tagged values definition for specific types of model elements. You can tailor UML meta model for different domains and platforms by
creating and developing a profile.
1. In Model Explorer, right click on the project root node and select Create Profile from the pop-up menu.

Creating a profile

2. Name the profile in Profile Specification and click OK to confirm. The naming should be clear enough to identify the part of the domain
you want to create a profile for. For example, a Vehicle profile for managing stereotypes around different car types; a Transaction profile for
managing stereotypes related to trading and loaning of cars.

Naming the profile

3. Repeat step 1 and 2 to create all the profiles.

All profiles are created

A profile consists of domain-specific stereotypes and tagged values definition. To develop a profile, you need to create a profile diagram. For details
about how to create and draw a profile diagram, read the next chapter.

Creating a profile P. 436

Drawing a profile diagram
A profile diagram enables you to create domain and platform specific stereotypes and define the relationships between them. You can create
stereotypes by drawing stereotype shapes, and relate them with composition or generalization through the resource-centric interface. You can also
define and visualize tagged values of stereotypes.

Creating a profile diagram

To create a profile diagram:
1. Right click on a profile in Model Explorer and select Sub Diagrams > New Profile Diagram from the pop-up menu.

Create a profile diagram

2. Name the diagram and press Enter to confirm. By default, the name of profile is applied as the name of diagram. If you attempt to create only
one profile diagram for a profile, and if your profile was well-named, you can keep using the profile name as diagram name.

Naming a profile diagram

Drawing a stereotype
To draw a stereotype in profile diagram:
1. Select Stereotype in diagram toolbar.

Selecting Stereotype
in diagram toolbar

2. Click on the diagram to create a stereotype.

Drawing a profile diagram P. 437

3. In the Select Base Type of Stereotype dialog box, select the base type of stereotype from the model type tree. A base type is the type of
model element that the stereotype will extend.

Selecting a base type

4. Click OK. Name the stereotype and press Enter to confirm creation.

Defining tagged values for stereotypes

Drawing a profile diagram P. 438

3. Click Add. Select the type of tagged value to define. The type of tagged value limits the type of content user can enter for a tag.

To add a tag

Tag type Description

Text The most common and general type of tagged value that consists of words.

Multi-line Text The value of tag is a text in multiple lines.

Model element The value of tag is a model element in project.

Enumeration The value of tag can be chosen from a list of possible values. For example, to select "red" out of values red, green
and blue.

Integer The value of tag must be a real number.

Floating point The value of tag must be a number that consists of one or more digits.
number

Type of tags

4. Double click the name cell and enter the name of tag. Repeat step 3 and 4 to add all tagged values for this stereotype.

Tags defined for an Vehicle stereotype

5. You can assign a default value to a tag by editing the Default Value cell. Usually, you give a tag a default value when the value is true in most
cases. For example, a tag "in-door-temperature" can have "25" as default value. By confirming changes, you can see the stereotype show on
diagram, with tagged values show below the stereotype name.

Stereotypes with tagged values defined

Relating stereotypes
Stereotypes can be related with each other by composition or generalization. Relating stereotypes not just affect the modeling in profile, but also the
model elements that the stereotypes will be applied to.

Drawing a profile diagram P. 439

Composition
A composition relationship shows a "part of" relationship between stereotypes. The composite stereotype has responsibility for the existence and
storage of the composed stereotype.

Composition between stereotypes

To create a composed stereotype:

1. Move the mosue pointer over a stereotype. Press on the resource icon Composition > Stereotype from the popup menu.

To create a composition

2. Drag it out. Release at the position you want to create the composed stereotype. Select base class, name the stereotype and press Enter.
Since composition models a "part of" relationship, when you apply a composite stereotype to a model element, you can add tagged value defined in
composed stereotype in the model element. For example, stereotype Vehicle is composed of stereotype Wheel. If you apply stereotype Vehicle to a
class, you can specify the properties of tagged values as defined by both stereotype Vehicle and Wheel.

Generalization
A generalization relationship shows a "kind of" relationship between stereotypes.

A generalization relationship

To create a specific stereotype from a general stereotype:

1. Move the mosue pointer over a stereotype. Press on the resource icon Generalization > Stereotype from the popup menu.

To create a generalization relationship

2. Drag it out. Release at the position you want to create the specialized stereotype. Select base class, name the stereotype and press Enter.
Since generalization models a "kind of" relationship, when you apply a specialized stereotype to a model element, you can add tagged value defined
in general stereotype in the model element. For example, stereotype Vehicle is a generalized stereotype of Truck. If you apply stereotype Truck to a
class, you can specify the properties of tagged values as defined by both stereotype Vehicle and Truck.

Drawing a profile diagram P. 440

Creating diagrams
You can create diagrams to help visualize what you did, what you are doing and what you need to do on your target system or application. There are
different types of diagrams to fulfill different needs, categorized as UML diagrams, requirements capturing, database modeling, business process
modeling and others. Here are the three possible ways of creating a diagram:
• Through toolbar
• Through the File menu
• Through the pop-up menu on Diagram Navigator
To create a diagram through toolbar:
Select the icon of a specified diagram under diagram category on the toolbar.

Select UML icon on the toolbar

To create a diagram through File menu:

Creating Diagrams P. 441

1. Select File > New Diagram > New Diagram... from the main menu.

Select New Diagram... from the main menu

2. When the New Diagram dialog box pops out, select a category under Categories and select a diagram type on the right-hand side. Specify the
newly created diagram's name and also the documentation.

New Diagram dialog box

To create diagrams through the pop-up menu on Diagram Navigator:

Creating Diagrams P. 442

Right click on a specified diagram type node on Diagram Navigator and select the specified new diagram type from the pop-up menu.

Select New Class Diagram from the

pop-up menu on Diagram Navigator

Drawing shapes
After creating a new diagram, diagram elements can be created as well through the diagram toolbar. In this section, these techniques of drawing
shapes will be explicated:
• Creating Shapes
• Creating Connectors
• Creating Self-Connection

Creating shapes
To create a shape, click a diagram element from the diagram toolbar and click it on the diagram pane for creating. The generated element will appear
to have a default size.

Click an actor on the diagram pane

For defining a specific shape size, drag a specific boundary with the mouse after clicking a diagram element from the diagram toolbar.

Drag a specific boundary with the mouse

Creating Diagrams P. 443

Alternatively, a diagram element can be created by dragging the diagram element and then dropping it on the diagram pane.

Drag and drop to create a shape

In addition, you can add a shape through the pop-up menu of diagram. Right click on the diagram background, select Add Shape and then a specific
shape from the pop-up menu.

Create a shape through the pop-up menu of diagram

Creating connectors
To create a connector, select the desired connector from the diagram toolbar, drag the connector from the source shape to the destination shape.
Since VP-UML provides a continuous UML syntax checking, if you create an invalid connection, a stop sign will be pop-out. For instance, you are not
allowed to connect an actor and a use case with a generalization relationship.

An invalid connection is created

If the connection is valid, a blue rectangle surrounding the destination shape can be seen.

A valid connection is created

Moreover, connectors can be created through resource icons:

Creating Diagrams P. 444

Move the mouse over the source shape, press one of its resource icons and drag it to the destination shape.

Press a resource icon to connect shapes

If you release the mouse on an empty space, a new shape will be created with a connector.

Creating self-connection
Some shapes can make a connection for itself, for example, Self-Association of a Class in class diagram and Self-Link of an Object in
communication Diagram. To create a self-connection, select the connector from the diagram toolbar and then click on the target shape. Alternatively,
you can press the target shape's resource icon directly.

Self-Connection is created

Creating turning point on connector

A turning point is a point on a connector where a bending take place. To create a turning point on an existing connector, press on the connector and
drag to bend the connector.

Create turning point on existing connector

You can also create a turning point when creating a creator through the resource centric interface. When dragging out a resource-icon, press the Shift
button at where you want to create the turning point.

Create turning points when creating shape by dragging a resource

If you try to create connector by clicking on a resource icon, click at where you want to create a turning point to create it.

Create turning points when creating shape by clicking a resource

Creating Diagrams P. 445

Resource-centric interface
Visual Paradigm is the first vendor to introduce the resource centric diagramming interface. The resource centric interface greatly improves the
efficiency of modeling. You don't have to traverse between the toolbar and the diagram to create diagram elements, make connections and modify the
diagrams. The resource centric interface can make sure the modeler is able to create a diagram with correct syntax more quickly.
There are tree types of resource icons:
• Connection Resource
• Manipulation Resource
• Branching Resource

Connection resource
It is designed for creating elements and making connections.

Create association with connecting a new or existing use case

Manipulation resource
You can use Manipulation Resource to modify properties or appearance of elements. For example, you can show or hide compartments, add
references, add sub-diagram and fit size.

Fit size through manipulation resource

Branching resource
Branching Resource helps you to create decision structure in diagram.

Create decision structure through branching resource

Drawing freehand shapes

Freehand shape is a kind of general graphic shapes. Pen shapes, pencil shapes, and some regular shapes like circle, rectangle and arrow are
available. Freehand shape can be used for annotating diagram. For example, you can use freehand shapes to emphasize some shapes.

Creating Diagrams P. 446

A specific shape can be highlighted with a pencil shape.

Pencil

An outstanding text can be shown with word art.

Word Art

A freehand shape style can be formatted in order to address your information.

Styled freehand shapes

Changing package header

You can specify the parent package of any diagram through Package Header.

Creating Diagrams P. 447

Package header when diagram created
When a diagram is created, the package header will be unfolded as it allows you to specify the parent package of the diagram. Specify the package by
entering the fully qualifier name of the package.

Specify parent package in package header

After entering the name of parent package, you will find that the diagram name is the same as the name of parent package.

Diagram name will be same as fully qualify of parent package

The diagram name can be renamed. However, the name of parent package won't be changed following with the diagram name.
You can open specification of parent package by pressing the Open Specification button on the right-hand side of the parent package name.

Open Specification

You can rename the parent package of the diagram by double clicking on it.

Double click on the parent package

A new package will be created if you enter a completely new package name. If the previous parent package does not contain elements, it will be
deleted. That means the documentation (or other properties) of previous parent package will be lost.

Creating Diagrams P. 448

A package header can be either shown or hidden through the pop-up menu of diagram. Right click on the diagram background and select
Presentation Options > Show Package Headerfrom the pop-up menu.

Show/hide package header

Justifying shape name

In Visual Paradigm, a shape name is aligned center horizontally, and top or middle vertically, depending on the characteristic of shapes. However, the
shape name can be realigned. Even if a language, such as Modern Hebrew, that is written from the right to the left can be displayed on a shape clearly.

Adjusting shape name's position

Creating Diagrams P. 449

1. Right click on the diagram background, select Presentation Options > Model Element Name Alignment and then select a specific alignment
option from the pop-up menu.

Select an alignment option from the pop-up menu

2. As a result, all shapes' name in the whole diagram will turn into the alignment option you set previously.

All shapes' names turn into middle right

Apart from the whole diagram setting, a specific shape can also be set:

Creating Diagrams P. 450

1. Right click on a shape, select Presentation Options > Model Element Name Alignment and then select a specific alignment option from the
pop-up menu.

Select an alignment option from the pop-up menu

2. As a result, the specific shape will turn into the alignment option you set previously.
In addition to the current diagram, future diagrams can also be set:
1. Select Tools > Options... from the main menu.
2. In the Options dialog box, select the Diagramming category, check an option out of Model Element Name Alignment section under the
Appearance tab.

Check an alignment option in the Options dialog box

Creating Diagrams P. 451

Exceptions
Although most shape' name can be justified, some are exceptional. Two main kinds of shapes that their name cannot be justified are introduced as
follows:
On one hand, shapes neither with floating name label (freely movable) nor with a label outside the shape can be justified. Actor, Initial Pseudo Node
and BP Start Events are examples of this kind of shape.

Floating name label

On the other hand, the names of container shapes are not available for positioning. Since their “bodies” are used for containing other
shapes, thereby, they have a limited scope of displaying names. Package, State and System are example of this kind of shape.

Container shape

Enabling and disabling minimum shape size

Since all shapes have their own default minimum size, users are not allowed to resize them to smaller than the minimum size. The default setting
helps to ensure those compact shapes are clear enough to be seen on a diagram under normal circumstance. The minimum size of a shape can be
determined by pressing its fit size button.

The minimum size of a shape can be determined by pressing its fit size button

Now, it is possible to disable such setting, so that shapes can be resized to extremely small in size, despite their minimum size:
1. To disable the function of the minimum size checking, select Tools > Options... from the main menu.
2. In the Options dialog box, select the Diagramming category and uncheck Enable minimum size under Appearance tab. Click OK to
confirm.

Uncheck Enable minimum size

3. After that, you can resize a shape to the size as small as you want.

Creating Diagrams P. 452

4. Furthermore, select other shapes and select an option from the drop-down menu of resource icon Same Width.

Select an option from the drop-down menu of resource icons

5. As a result, other shapes will turn into the same size as the shape you have done previously.

All shapes are turned into the same small size

Undo and redo

During the process of editing a diagram, you may make some careless mistakes, such as accidentally deleting a shape. You can use the Undo
function to cancel the previous action. On the contrary, you may re-perform the action through the Redo function. Note that the undo/redo feature in
VP-UML is diagram based.

Undo
You can roll back undesirable changes by performing Undo. Undo function can be executed in the following three ways:
• Select Edit > Undo from the main menu.
•
Click the Undo button on toolbar.
• Press Ctrl-Z.

Redo
This feature is to re-perform actions that have just been undone. Redo function can be executed in the following three ways:
• Select Edit > Redo from the main menu.
•
Click the Redo button on toolbar.

Creating Diagrams P. 453

• Press Ctrl-Y.

Showing name for undo and redo action

It's hard for us to remember all actions we have done previously. By VP-UML, we can recall the actions we have done before.
You can find an action name of undo/ redo by clicking Edit from the main menu.

Menu shows Undo/Redo name

On the other hand, you can also find the action name of undo/ redo on toolbar button's tooltip. Move the mouse over the Undo or Redo button and
then a tooltip with Undo/ Redo action name will appear.

Toolbar button's tooltip shows undo action

Creating Diagrams P. 454

Resource centric interface
Visual Paradigm is the first vendor to introduce the resource centric diagramming interface. The resource centric interface greatly improves the
efficiency of modeling. It can make sure the modeler is able to create a diagram with correct syntax more quickly. The utmost importance thing is
that you don't have to go back and forth between the toolbar and the diagrams for creating diagram elements, making connections and modifying the
diagrams.

Resource centric interface on action

NOTE: To check or uncheck the options (including Resources, Group Resources, Extra Resources and Generic Resources Only) on
resource centric interface, select View > Resource Centric from the main menu.

Creating shapes through resource centric interface

Instead of clicking shapes one by one from the diagram toolbar, you can create another shape from an existing shape on the diagram.
1. Move the mouse on a shape and select a resource icon out of resource centric interface.

Create a use case with resource centric interface

2. Drag the resource icon and release it until reaching to your preferred place.
3. As a result, another shape is created and linked with the previous shape.

Release the mouse to create use case

Connecting shapes through resource centric interface

For relating two shapes together, you have to link a shape to another. With resource centric interface, you can not only link them up, but also select an
appropriate relationship for them.
1. Select two shapes from the diagram toolbar and drag them on the diagram individually. Move the mouse on one shape and select a resource
icon out of resource centric interface.

Create Use Case with Association

2. Drag the resource icon and release it until reaching to another shape.
3. As a result, two shapes are linked together.

Release the mouse to create Association connecting with the Use Case

Resource Centric Interface P. 455

Using quick connect
With quick connect, you are able to search the preferred shape and connect to it on the diagram accurately and quickly.
1. After creating some shapes on diagram, move the mouse on a shape and click a resource icon out of resource centric interface. The Quick
Connect dialog box will be shown subsequently.

Quick Connect dialog box

2. You can either create a new shape or select an existing shape by typing its name in the text field of Quick Connect dialog box. To select an
existing shape, enter its full name directly or just type the first letter of its name. As a result, a list of shapes which match with the word(s) you
typed will display.
3. After you click a shape's name on the drop-down list, the shape will be spotlighted on the diagram immediately.

Use Case is spotlighted

4. Confirm the selection, press Enter. The two shapes will be linked automatically.

An actor is linked with a use case

NOTE: You should click the resource icon in accordance with the existing shapes on your diagram. If the shape does not exist on the diagram,
the Quick Connect dialog box will not pop out even when you click the resource icon.

Managing transition of shapes

Model transitor enables you to trace between model elements across different phrases of development. Once a transition is created between two
shapes, you can navigate between them through the resource centric interface.

Resource Centric Interface P. 456

Move the mouse on a shape and select Model Transitor> Transit To and then select the shape's name you would like to transit to/from from the pop-
up menu. As a result, the vision will be diverted to the selected shape after transition is selected. Thereafter, you can transit to/ from between these two
shapes.

Transit from one shape to another

NOTE: Transition does apply not only on two shapes on the same diagram, but also two shapes in different diagrams.

Adding and opening reference

For providing extra information to shapes, you can insert both internal and external resources, such as a shape, a diagram, a file, a URL through the
resource centric interface. After editing references, they can be opened throughout the resource centric interface.
1. Move the mouse on a shape that you would like to insert references for, press resource icon Resources at the bottom left corner and select a
reference option from the pop-up menu.

Select Add File...

from the pop-up menu

Resource Centric Interface P. 457

2. Insert the corresponding resource in References tab of your shape's specification dialog box.

Insert a file in Class Specification dialog box

3. After adding reference, you can click resource icon Resources again and the reference you have just created will be revealed on the pop-up
menu.

The newly created reference

Splitting connection by shape

Resource centric supports some connectors (e.g. Control Flow in Activity Diagram) with splitting the connector by adding another shape.
1. Move the mouse on the connector between two shapes and select a split resource icon out of resource centric interface.

Select a split resource icon

2. As a result, an extra shape is inserted between two existing shapes.

Control Flow is split by Decision Node

NOTE: There is an orange asterisk on the split resource icon.

Resource Centric Interface P. 458

Creating structure
Resource centric interface supports some models (e.g. Action in Activity Diagram) with creating a structure of models. Instead of creating shapes one
by one, branch resource icon helps speed up the shape creation process; you thereby can create several shapes simultaneously.
1. Move the mouse on a shape and select a branch resource icon out of resource centric interface.

Select Create Branch with Decision

Node on resource centric interface

2. Drag the resource icon and release it until reaching to your preferred place.
3. As a result, two shapes and a decision node are created and connected.

Create Decision Node and Actions

NOTE: There is an orange asterisk on the branch resource icon.

Group selection resource

When a great amount of shapes are displayed on the diagram disorderly, resource centric interface can support alignment and grouping after selecting
several shapes.
1. Select several shapes on diagram.
2. Move the mouse on the last selected shapes and group selection resources will be shown instantly.

Group Selection Resources are shown

3. Press the reversed triangle of Align Top and select an alignment option from the drop-down menu.

Select Align Top from the drop-down menu

Resource Centric Interface P. 459

Tagged values
In VP-UML, tagged values are properties defined by user and can be added to a model element. VP-UML supports either defined tagged values
in stereotype or tagged values without stereotype. In UML 1.1, stereotypes and tagged values were used as string-based extensions that could be
attached to UML model elements. In UML 2.x, stereotypes and tagged values will be defined in Profile that can provide more structure and precision to
the definition.

Adding user-defined tags

1. Right click on the selected shape and select Open Specification... from the pop-up menu.

Right click to select Open Specification...

2. In Specification dialog box, select Tagged Values tab and click Add button to select an option of value type.

Add an option of value type

Different types of tagged values

Text
Text supports string-based value.
In Specification dialog box, select Tagged Values tab, click Add button and select Text from the pop-up menu. Enter the text in the text field directly.

Add text

Multi-line Text
Multi-line Text supports multi-line string.
1. In Specification dialog box, select Tagged Values tab, click Add button and select Multi-line Text from the pop-up menu. Click the ... button
of Value.

Add multi-line text

Tagged Values P. 460

2. When Edit Value dialog box pops out, enter the multi-line text. Click OK button to finish editing.

The Edit Value dialog box

Model Element
Model Element supports reference(s) of model element.
1. In Specification dialog box, select Tagged Values tab, click Add button and select Model Element from the pop-up menu. Click the reverse
triangle button of Value.

Add model element

2. When the Select Model dialog box pops out, check Model and select a model element. Click OK button to confirm.

Select a model element

Integer
Integer supports values with numbers only.

Tagged Values P. 461

In Specification dialog box, select Tagged Values tab, click Add button and select Integer from the pop-up menu. Enter a number in Value.

Add integer

Floating Point Number

Floating Point Number supports values with decimal places.
In Specification dialog box, select Tagged Values tab, click Add button and Floating Point Number from the pop-up menu. Enter a number with
decimal places in Value.

Add floating point number

HTML
HTML is a hidden tagged value. To reveal this option, select Tools > Options... from the main menu. When the Options dialog box pops out, select
Diagramming > Environment tab and check Stereotype support HTML tagged value.
In Specification dialog box, select Tagged Values tab, click Add button > HTML Text from the pop-up menu and click ... button in Value when the
option for HTML is revealed.

Add HTML text

When Edit Value dialog box pops out, enter the text. You can format the HTML text content with the toolbar, for example, changing the font color of
selected text and underlining selected text.

Format the HTML text content

Click OK button to finish editing.

Tagged Values P. 462

Editing tagged values
You can enter the user-defined tagged value's name, select its type and enter its value.

Edit name, type and value on user-defined tagged value

The value of stereotype can be edited, however, its name and its type cannot be edited as they are defined in stereotype.

Visualizing tagged values on diagram

Right click on the diagram background and select Presentation Options > Show Tagged Values from the pop-up menu.

Show tagged values

If it is defined, the tagged values will be seen within the shape(s) on the diagram.

Tagged values are shown

Tagged Values P. 463

Spell checking
You will never find it hard to avoid making mistakes in your diagram after using spell checking. It can help you to correct both typing mistakes and
spelling mistakes, however, it is slightly different from other spelling and grammar checking tools you have used before. It doesn't check your whole
diagram automatically, but underlines wrong words with a curve line.

Correcting a word
If you type an incorrect word mistakenly, you can:
• Either re-type the word correctly or
• Right click on the wrong word and then select one out of the suggest words.

Adding a new word to dictionary

Sometimes, the dictionary cannot recognize the word you type and it doesn't always mean you type an incorrect word . It may be a rare word or a new
word that you create, for example, your company's name. You can simply right click on the wrong word and select Add to dictionary to add a new
word to dictionary. You type this word again next time, it won't be marked as a wrong word.

Adding a new word to dictionary

Changing the language of dictionary

The dictionary usually defaults as American English for spell checking. If you want to change the language of dictionary, you just need to:
1. Click Tools > Options > Spell Checking.
2. For example, you can change from American to British.

Changing the language of dictionary

NOTE: There are a few more languages in dictionary that can be used, such as French and German.

Spell Checking P. 464

More options of spell checking
There are a few more options of spell checking, for example Ignore words with numbers and Ignore Internet and file address. Check the item you
want to be included in spell checking while uncheck the item you don't want to be included.

Checking other options of spell checking

Spell Checking P. 465

Using project management properties
Project management properties are a set pre-defined properties, made for recording additional management-level information for all kinds of project
data (e.g. diagrams, model elements, diagram elements). Here are all the project management properties you can find:

Property name Description

Process Specify the part of the process where the editing element is involved. Three sub-properties for further specification. They include:
Iteraction, Phase and Discipline.

Version The stage of the editing element. For example, you may have two class diagrams for modeling the a system from design and
implementation angles respectively. The two diagrams will have version 1.0 and 2.0, to show the progress of work.

Priority The importance of editing element.

Status The status of editing element. It is particular useful for use case and BPMN activity shapes, for setting their status such as
Proposed, Planned, Tested, etc.

Difficulty How difficult it is to complete the goal as modeled by the edting element.

Author The person who created the editing element. This is particular useful in a team working environment. Once the author is known
you can contact that person in case you have questions about a part of a model.

Create date The date and time when the editing element was created. This property is a read-only property that is filled automatically to all
time elements when creation.

Last modified The date and time when the editing element was modified. This property is a read-only property that is filled automatically to all
elements when the project file is being saved .

A list of project management properties

Further to recording project management properties, you can print those properties in report, too.

Editing project management properties

Like all the other specification level properties, project management properties can be edited through the specification dialog box of all diagrams, model
and diagram elements. Select the desired diagram/model element/diagram element. Right click and select Open Specification... from the popup
menu. Under the tab Project Management you can find the properties of the chosen element.

Editing project management properties

Using project management properties P. 466

Project management properties in report generation
Like most other properties, project management properties will be presented in PDF, HTML and Word report, too. Furthermore, you can filter the
elements to present in report by project management properties when editing template.

Editing project management filter in editing report template

Using project management properties P. 467

Configuring project management properties
For each project management property, there are several default values available for selection. For example, values "1.0" and "2.0" can be selected for
property Version. You can edit an existing value, or add additional values to a property by editing the look-ups.
To configure a property:
1. Select Tools > Project Management Look-ups... from the main menu.

To edit project management property look-ups

2. In the Project Management Look-ups dialog box, open the tab of the property that you want to edit its look-ups.
3. If you want to rename a value, double click and re-enter its value. If you want to add a lookup value, click Add at the bottom right corner.

To add a version

Configuring project management properties loop-up P. 468

RTF documentation
With rich text format (RTF), you can format the text in documentation editor, such as making it bold, italic, or adding tables within the text. In addition to
formatting, RTF supports users to add linkage to another model element, save documentation as template and furthermore reuse the template.

Viewing and editing the documentation of model element

To view or edit the documentation of model element, right click on the model element and select Open Specification... from the pop-up menu.

Open specification

Alternatively, click the Documentation pane after select a specific model element on the diagram pane.

Documentation pane

Documentation editor
The documentation pane is where you can describe the selected model element. With the editor's toolbar, you can format the content, save as
template, reuse the existing template, add model elements and print the content.

The overview of documentation editor

RTF documentation P. 469

The toolbar on documentation editor

No. Name Description

1 HTML HTML - Read and edit the real content.

HTML Source - Read and edit the HTML source of content.
Plain Text - Read and edit plain text of content without formatting.

2 Bold Set the highlighted text to bold.

3 Italic Set the highlighted text to italic.

4 Underline Underline the highlighted text.

5 Alignments Set the alignment of highlighted text to the left, the center or the right.

6 Ordered list Add a numbered list.

7 Un-ordered list Add a list with bullet points.

8 Font Select the font family of highlighted text.

9 Font size Select the size of highlighted text.

10 Font color Select the color of highlighted text.

11 Table Add a table.

12 Background Select the background color of highlighted text.

color

13 Clear formats Clear formats of the whole editor to convert the content to plain text.

14 Link Add a hyperlink.

15 Image Add an image.

16 Add Model Insert an existing model element or create a new one.

Element

17 Template Save as Template...: Save the current documentation content as a template.

Manage Template...: Delete the saved template.

18 Print Print the documentation content.

19 Editor pane Enter and start editing the documentation content.

The description of documentation editor

Editing documentation
Saving a template

RTF documentation P. 470

1. The documentation you typed can be saved as template in the documentation editor. Choose Save as template... from the drop-down menu of
Template.

Choose Save as template...

2. In the Input dialog box, enter the template name and click OK button to confirm.

Enter template name

Reusing a template
1. In the documentation editor, an existing template can be reused. Select a saved template from the drop-down menu of Template.

Select a template

2. As a result, the selected template will be shown on the documentation editor.

Adding model element

1. Click Add Model Element button on the editor's toolbar after decided a place for inserting a model element.

Click Add Model

Element button

RTF documentation P. 471

2. In Select Model dialog box, select an existing model element on the list. If you want to modify the selected model element, you can click Open
Specification... button. On the other hand, you can create a new model element by clicking New... button after select a model element on the
list.

Click Open Specification... button

3. Finally, click OK button to confirm.

4. Consequently, the name of inserted model element will be shown on the documentation pane with underline. If you want to preview the inserted
model element, you can right click on its name and select Show View... from the pop-up menu. After the Show View dialog box pops out, you
can preview it in the Preview window. If you want to view the actual model element on the diagram, you can click Go to View button.

Click Show View... from the pop-up menu

Printing documentation
1. After clicking the Print button, the Page Setup dialog box will pop out.

Click Print button

RTF documentation P. 472

2. In Page Setup dialog box, select size and source for paper, check an option under Orientation and enter the inches for the paper margins.

The Page Setup dialog box

3. Click OK button to confirm printing.

RTF documentation P. 473

Voice documentation
In addition to textual description for your model elements, you can record voice documentation, or embbed audio files.

Viewing and editing the documentation of model element

To read or edit the documentation of model element, right click on a model element and select Open Specification... from the pop-up menu to unfold
Specification dialog box.

Open specification

Alternatively, click the Documentation pane after select a model element on the diagram.

Documentation pane

Recording voice
1. Right click on a model element and select Open Specification... from the pop-up menu.
2. In Specification dialog box, click Record... button on the bottom left corner of dialog box.

Click Record... button

3. In the Record Voice dialog box, click the Record button to start recording.

Start recording

NOTE: Make sure your audio input device is active before operate voice documentation.

4. Click the Stop button when you want to end the recording.

NOTE: Play the recorded voice by pressing the Play button; record again by pressing the Clear button, and rerun the previous steps.

Voice documentation P. 474

5. Enter the name for recorded voice clip in the text field of Name.

Name voice clip

6. Click OK button to confirm recording.

Linking voice to documentation

1. Right click on a model element and select Open Specification... from the pop-up menu.
2. In Specification dialog box, choose Manage... button on the bottom left corner of dialog box.

Click Manage... button

3. In the Manage Voice dialog box, click the Add button, and choose either Embedded or Link to File.

Click Add button

4. If you choose Embedded, record a voice clip when the Record Voice dialog box pops out; if you choose Link to File, select an audio file when
the Open dialog box pops out.

Voice documentation P. 475

5. The voice clip can be renamed in the text field of Name.

Rename a voice clip

6. Click OK button to confirm.

Voice documentation P. 476

Applying fill, line and font styles on diagram elements
You can change the diagram element's style in the Formats dialog box. To open the Formats dialog box, right click on the shape and select Styles
and Formatting > Formats... from the pop-up menu.

Select Formats... from the pop-up menu

Formats dialog box

You can change the following settings from the Formats dialog box:
• Changing shapes foreground style
• Changing shapes font style
• Changing shapes background style

Applying fill, line and font styles on diagram elements P. 477

Changing shapes foreground style
In the Format dialog, you can change the foreground style in the Font section. Just click on the ... button beside the Color field to select a color either
from the Default page (which shows predefined colors) or from the Custom page (which shows a larger variety of colors, and allows you to define any
custom colors). If you want to specify a custom color, you can switch to the Custom pane.

Font section

After change the font color, the preview will update automatically.

Changing shapes font style

In the Font section, you can also change the font name, style and size.

Change font style

Field Description

Font Select different types of font. The number of fonts depends on the fonts available in your computer.
Name

Font Select the style of font. You can select one of the 4 styles, a preview will be shown for each of the style items.
Style

Font Select the size of font. You may either click on the default sizes or enter the font size in the text fields.
Size
The Preview pane displays the selected font format.

Applying fill, line and font styles on diagram elements P. 478

Changing shapes background style
You can click on the Background tab to custom the background style.

Change background style

In the Background tab, it allows you to select a solid fill color or a gradient fill color as well as define its transparency.

Field Description

Fill Style Select the fill style of the fill color. It can either be Solid (a single color) or Gradient (a fill color that is mixed by two colors).

Transparency Specify the transparency of the fill color. The greater the value, the more transparent is the shape. 0 (zero) transparency makes
the fill color completely opaque, while 100 (one hundred) transparency makes the fill color completely transparent.
You can adjust the transparency by dragging the slider, or by typing the value in the text field.

Alternatively, you can click the Opaque button to set the fill color to opaque, or click the Transparent button to set the fill
color to transparent.

Preview The Preview pane displays a rectangle that is filled with the editing fill color. The background is checked so that you can also
preview the transparency of the fill color as well.

Save as Save the current fill color as the default fill color for new shapes, click the Set as Default button.
Default

Reset to Reset the current fill color to the default fill color, click the Reset to Default button.
Default

Applying fill, line and font styles on diagram elements P. 479

Upon selecting Gradient from the Fill style field you will see the detail pane for formatting a gradient fill color.

Check gradient fill style

Field Description

Color 1 You can select the first color of the gradient from the Color 1 field. To select a color click the ... button or double-click on the
color editor. A color chooser will appear for you a select a color.

Color 2 You can select the second color of the gradient from the Color 2 field. To select a color click the ... button or double-click on
the color editor. A color chooser will appear for you to select a color.

Gradient Color The Gradient Color Themes pane displays a list of pre-defined gradient color themes.
Themes To add a new color theme select Color 1 and Color 2 then click the Add to Themes... button. Please note that you must
select a combination of colors that does not already exist in the color themes.
To rename a theme click on the Rename... button or double-click on the desired theme. An input dialog will appear for you to
enter a new name.
To remove a theme select the theme and click on the Remove button, or use the Delete key instead.

Gradient Style The Gradient Style pane allows you to select the gradient style of the gradient fill color (the angle of how the gradient color is
drawn). There are sixteen pre-defined gradient styles, which are shown as toggle button in the Gradient Style pane. To select
a gradient style to use click on one of the styles.
Click OK button to confirm editing. As a result, the shape is changed into formatted style.

Change shape background style result

Applying fill, line and font styles on diagram elements P. 480

Changing connector line style
To change the connector line style through Property pane, select the target connector on the diagram, click the ... button in Foreground row of the
Property pane.

Change connector line style on property pane

You can format the line style in the line section. It allows you to adjust weight (thickness), color and transparency.

Line section

Field Description

Weight Adjust the weight (thickness) of a line. The greater the value, the thicker the line. You can use the up/down button to increase/decrease
the line weight, or you can type directly into the text field. The line weight ranges from 1 to 20.

Color Specify the line color. Click on the ... button beside the Color field to select a color, either from the Default page (which shows
predefined colors) or from the Custom page (which shows a larger variety of colors, and allows you to define any custom colors).

NOTE: Only integer values can be used for line weight. If you type 2.8 in the text field, 2 will be applied instead.

TransparencySpecify the transparency of the line. The greater the value, the more transparent the line. 0 (zero) transparency makes the line
completely opaque, while 100 transparency makes the line completely transparent.
You can adjust the transparency either by dragging the slider, or by typing the value in the text field. Alternatively you can click on the

Opaque button to set the fill color to opaque, or click on the Transparent button to set the fill color to transparent.

Preview The Preview pane displays a rectangle surrounded by the line with the selected line format applied.

Changing connector background style

Upon selecting the Background tab, it allows you to specify the background fill style of the line. Click OK button to apply the settings.

Change connector style result

Applying fill, line and font styles on diagram elements P. 481

Managing and applying styles
VP-UML allows you to define you own style and apply to other shapes by simple steps.

Adding style
To open the style dialog box, Select View > Styles... from the main menu.

Click Styles... from the main menu

In the Style dialog box, click Add... to create and edit a new style.

Style dialog box

Managing and applying styles P. 482

In the Edit Style dialog, you can change the name, foreground line style, font style, background style and arrow style. Click OK button after you finish
editing the setting.

Edit Style dialog box

As a result, the style is created.

Style added

Applying style
Upon keeping the Style dialog box open, select a target shape on the diagram and click Apply in the Style dialog box.

Managing and applying styles P. 483

As a result, the shape is changed into the newly created style.

Apply style to selected shape

Managing and applying styles P. 484

Setting line style
Connectors are the lines that connect two shapes. When more shapes are created and more connectors appear, you may find that it is difficult to
handle the straight spaghetti-like connectors. To overcome this problem, VP-UML provides five connector styles to help you handle the connectors,
namely Rectilinear, Oblique, Curve, Round Oblique and Round Rectilinear.

Setting connector line style

To change the line style, right click on the target connector and select Style and Formatting > Connector Style and one of five line style options from
the pop-up menu.

Change line style

As a result, the connector is changed into the selected line style.

Change line style

Line style options

Name Sample

Rectilinear

Setting line style P. 485

Oblique

Curve

Round Oblique

Round
Rectilinear

Setting diagram base line style

Beside the five styles mentioned above, there also have Follow Diagram feature, you don't need to set the connector one by one if you want to
change all connectors in the diagrams which defined as Follow Diagram.
To change the style of all lines on diagram, right click on the diagram background, select Connectors and one of five line style options from the pop-up
menu.

Change diagram line style

Setting line style P. 486

As a result, all lines on the diagram are changed into the selected line style.

All lines are changed into curve

Setting line style P. 487

Setting line jumps options
As more diagram elements on your diagram, more miscellaneous connectors are overlapped with each other. It is impossible to explicate on those
intersections which connector you indicate. The advantage of Line Jumps is making one of the two connectors different to another to indicate that
which connector links with which diagram element clearly. Visual Paradigm for UML (VP-UML) provides four line jumps options to help you to
distinguish connectors. Furthermore, the enhanced feature of line jumps in VP-UML 8.0 enables you to set different size of line jumps.

Setting connector line jumps options

To change the jumps option of a connector, right click on the connector, select Style and Formatting > Connector Style and then select an option
under Line Jumps.

Set Arc

Arc sample

NOTE: The line jumps options are available only when two connectors are overlapped.

Line jump options

Name Sample

Off

Setting line jumps options P. 488

Arc

Gap

Square

The description of 4 line jump options

Setting diagram base line jumps options

In addition to the 4 options mentioned above, Follow Diagram is another choice for altering the connectors. The main feature of Follow Diagram is, all
connectors in the diagrams can be changed simultaneously instead of setting one by one.
Right click on the diagram's background, select Connectors and select an option under Line Jumps from the pop-up menu.

Select Gap from the pop-up menu

Setting line jump for new project

1. Select Tools > Options from the main menu to open the Options dialog box.
2. In the Options dialog box, click the Diagramming page, open the Connector tab and select the Line Jumps style, or select Off to disable it.
At last, click OK to confirm the changes.

Setting different line jump size

You can enlarge the line jump size to make the selected line jump (or all line jumps) on the connector(s) more obvious. Furthermore, the size of line
jump can be customized in either the current diagram or the future diagram. If you only want to set to the connectors of current diagram, right click
on the diagram's background, select Connectors and then a size option from the pop-up menu. Otherwise, if you want to set to the connectors of
future diagram, set it through Options dialog box. Three size are availabe for chooising. Normal is the standard size by default while extra large is the
maximum size.

Setting line jumps options P. 489

Setting line jump size for current diagram
1. Right click on the diagram's background, select Connectors and then a size option from the pop-up menu.

Set Large

2. The line jump(s) on the current diagram will turn into the size you selected.

Arc in large size

Setting line jump size for future diagram

1. Select Tools > Options from the main menu to open the Options dialog box.
2. In the Options dialog box, click Diagramming page and open Connector tab.
3. Under the Line Jumps section, check an line jump option and then select a line jump size option from Line jump size's drop-down menu.

select Large from the drop-down menu

Setting line jumps options P. 490

Setting connector caption orientation
Visual Paradigm supports a number of ways of aligning connector caption, which apply on different modeling preferences. By default, the caption
of a connector is aligned horizontal only, but you also can customize it to Follow Diagram, Horizontal Only, Horizontal or Vertical Only, Follow
Connector Angle, and Follow Connector Angle and Keep Text Up Right. You can either customize it one by one or change all connectors in the
diagram which defined Follow Diagram.

Setting connector caption orientation

Sample class diagram 1

To customize the caption orientation option of a specify connector, select the connector, right click and select Style and Formatting > Connector
Style, and then select one out of four options under Caption Orientation.

change caption orientation to Follow Connector Angle

Setting connector caption orientation P. 491

Follow Connector Angle sample

Caption orientation options

Name Sample Description

Horizontal Only The caption of connector is aligned horizontally.

Horizontal or Vertical Only The caption of connector is aligned either

horizontally or vertically, according to the connector.

Follow Connector Angle The caption of connector is aligned the diagonal

angles of both shapes.

Follow Connector Angle and Keep Text Up Right The caption of connector is aligned the diagonal
angles of both shapes, but keeps top right.

The description of 4 caption orientation options

Setting connector caption orientation P. 492

Setting diagram base connector caption direction
In addition to the 4 options mentioned above, Follow Diagram is another choice for altering the connector. The main feature of Follow Diagram is, all
connectors in the diagrams can be changed simultaneously instead of setting one by one.

Sample class diagram 2

Right Click on the diagram background, select Connectors and select one out of four options under Caption Orientation from the popup menu.

Change caption orientation by diagram popup menu

Setting connector caption orientation P. 493

Workspace wide
Workspace wide setting affects the new connectors being created in projects created or will be created under the current workspace, including the
opening project. To set, select Tools > Options from the main menu.

Clicking Options... in popup menu

Setting connector caption orientation P. 494

In the Options dialog box, open the Diagramming page, switch to the Connector tab and select the desired way of aligning caption under the
Caption Orientation drop down menu. At last, click OK to confirm the changes.

Selecting Horizontal only in Options dialog box

Setting connector caption orientation P. 495

Format copier
Format is defined as the properties for a shape in terms of fill, line and font. Shapes are formatted for two major reasons: making your project more
attractive and giving emphasis on the meaning of shapes. However, it would be troublesome and time-consuming to repeat the same action when you
need other shapes to have exactly the same format as the previous one you have already done. Format copier can deal with this problem for you. It's
so handy that you can clone the formatting properties from one shape to another or even more.

Copying format to another shape

If you want another shape to have exactly the same formatting properties as the previous one you have done, you can simply:
1. Click on the shape that you want its format to be cloned.
2. Click on the Format Copier button in toolbar.

Click Copier

3. Click the shape you want to format.

Clone the format property from one shape to another

NOTE: You can copy formatting to another type(s) of shape.

Copying format to multiple shapes

If you want the format properties of your previous shape to be cloned to more than one shape, you should:
1. Click on the shape that you want its format to be cloned.
2. Double click the Format Copier button on toolbar.

Double click Copier

Format copier P. 496

3. Click the shape you want to format.

Clone the format property from one to multiple shapes

NOTE: If you don't want the format properties to be cloned to other shapes any more, you should cancel cloning by clicking Format copier once
again.

NOTE: You can only copy format to shapes within the same diagram.

Format copier P. 497

Automatic diagram layout
VP-UML provides a layout facility for arranging diagram elements in diagrams. Diagram elements do not overlap and the relationship links do not cross
over each another. Different layout styles and configurable options are provided, which allows extremely flexible and sophisticated layouts to be applied
to diagrams.

Automatic layout diagram

There are a few different kinds of layouts: Auto Layout, Orthogonal Layout, Hierarchic Layout, Directed Tree Layout, Balloon Tree Layout,
Compact Tree Layout, Horizontal-Vertical Tree Layout, BBC Compact Circular Layout, BBC Isolated Circular Layout, Single Cycle Circular
Layout, Organic Layout and Smart Organic Layout.

Auto layout
Selecting auto layout signifies that the most suitable layout is arranged for shapes automatically. It is the best choice for users when they have no
preference in selecting a specific layout. To apply Auto Layout to the diagram, right click on the diagram and select Layout > Auto Layout from the
pop-up menu.

Select Auto Layout

Class diagram (Hierarchy base / factory class diagram)

Automatic Diagram Layout P. 498

Hierarchy base (Factory class diagram)

Class diagram (Navigation base / mediator class diagram)

Automatic Diagram Layout P. 499

Navigation base (Mediator class diagram)

Activity diagram

Automatic Diagram Layout P. 500

Auto Layout of activity diagram

State machine diagram

Automatic Diagram Layout P. 501

Auto layout of state machine diagram

Communication diagram

Auto layout of communication diagram

Other diagrams

Automatic Diagram Layout P. 502

Auto layout of other diagrams

Automatic Diagram Layout P. 503

Orthogonal layout
Shapes are arranged based on the topology-shape-metrics approach in orthogonal layout. It is the best way for users to arrange shapes and
connectors in Class Diagrams. As it is default layout in VP-UML, every time you drag the models from the Model Tree to a diagram, the orthogonal
layout will be applied to arrange the newly created shapes in the Class Diagram.

Automatic Diagram Layout P. 504

Layout Grid Size: the virtual grid size for layout. Each shape will be placed in accordance with its center point lays on a virtual grid point.

Orthogonal Layout setting

Automatic Diagram Layout P. 505

Hierarchic layout
Hierarchic Layout arranges shapes in a flow. It is the best way for users to arrange shapes that have hierarchical relationships, such as generalization
relationships and realization relationships.

Hierarchic Layout

Automatic Diagram Layout P. 506

Min. Layer Distance: the minimal horizontal distance between the shapes.
Min. Shape Distance: the minimal vertical distance between the shapes.
Min. Connector Distance: the minimal vertical distance of the connector segments.
Orientation: the layout direction for arranging nodes and connectors -top to bottom, left to right, bottom to top, and right to left.
Shape Placement: affects the horizontal spacing between shapes, and the number of bends of the connectors -pendulum, linear segments, polyline,
tree and simplex.

Hierarchical Layout setting

Automatic Diagram Layout P. 507

Directed tree layout
Directed Tree Layout, which is one of the tree layouts in VP-UML, arranges shapes in a tree structure. It is the best way for users to arrange shapes
except those which have hierarchical relationships, such as generalization relationships and realization relationships.

Directed Tree Layout

Automatic Diagram Layout P. 508

Min. Layer Distance: the minimal horizontal distance between the shapes.
Min. Shape Distance: the minimal vertical distance between the shapes.
Orientation: the layout direction for arranging nodes and connectors – top to bottom, left to right, bottom to top, and right to left.
Connector End Point Style: how the connector end points will be placed – shape centered, border centered, border distributed.
Orthogonal Connector: whether the connectors will be arranged in orthogonal.

Directed Tree Layout setting

Automatic Diagram Layout P. 509

Balloon tree layout
Balloon Tree Layout, which is one of the tree layouts in VP-UML, arranges shapes in a tree structure in a radial fashion. It is the best way for users to
arrange large trees.

Automatic Diagram Layout P. 510

Min. Connector Length: the minimal distance between the connectors and shapes.
Preferred Child Wedge: the angle at which the child node will be placed around its parent node.
Preferred Root Wedge: the angle at which a node will be placed around the root node.
Root Node Policy: determines which node is chosen as the tree root node for layout – directed root, center root, and weighted center root.

Balloon Tree Layout setting

Automatic Diagram Layout P. 511

Compact tree layout
Compact Tree Layout, which is one of the tree layouts in VP-UML, arranges shapes in a tree structure. The aspect ratio (relation of tree width to tree
height) of the resultant tree can be set.

Automatic Diagram Layout P. 512

Horizontal Spacing: the horizontal spacing between the shapes.
Vertical Spacing: the vertical spacing between the shapes.
Min. Connector Length: the vertical distance of the connector segments.
Aspect Ratio: the relation of the tree width to the tree height.

Compact Tree Layout setting

Horizontal-Vertical tree layout

Horizontal-Vertical Tree Layout, which is one of the tree layouts in VP-UML, arranges shapes in a tree structure horizontally and vertically.

Horizontal-Vertical Tree Layout

Automatic Diagram Layout P. 513

Horizontal Spacing: the horizontal spacing between the shapes.
Vertical Spacing: the vertical spacing between the shapes.

Horizontal-Vertical Tree Layout setting

Automatic Diagram Layout P. 514

BBC compact circular layout
BBC Compact Circular Layout, which is one of the circular layouts in VP-UML, arranges shapes in a radial tree structure. The detected group is laid out
on the separate circles. It is the best way for user to arrange shapes that belong to more than one group with a ring structure.

BBC Compact Circular Layout

Automatic Diagram Layout P. 515

Maximal Deviation Angle: the maximal angle of deviation.
Preferred Child Wedge: the angle at which the child node will be placed around its parent node.
Minimal Edge Length: the minimal distance between the shapes.
Compactness Factor: the parameter that affects the length of connector. The smaller the compactness factor, the length of connectors will be shorter
and the layout will be more compact.
Allow Overlaps: whether the shape can be overlapped.

BBC Compact Circular Layout setting

Automatic Diagram Layout P. 516

BBC isolated circular layout
BBC Isolated Circular Layout, which is one of the circular layouts in VP-UML, arranges shapes into many isolated ring structures. It is the best way for
users to arrange shapes that belong to one group with ring structure.

BBC Isolated Circular Layout

Automatic Diagram Layout P. 517

BBC Isolated Circular Layout setting

Automatic Diagram Layout P. 518

Single cycle circular layout
Single Cycle Layout, which is one of the circular layouts in VP-UML, arranges shapes in circular structure in single circle.

Single Cycle Circular Layout

Automatic Diagram Layout P. 519

Choose radius automatically: determine the radius of circular structure automatically or manually.
Minimal Node Distance: the minimal distance between the nodes.
Fixed radius: the radius of circular structure.

Single Cycle Circular Layout setting

Automatic Diagram Layout P. 520

Organic layout
Organic Layout, which is one of the organic layouts in VP-UML, arranges shapes in a star or ring structure. It is the best way for users to arrange the
shapes that have highly connectivity relationship.

Organic Layout

Automatic Diagram Layout P. 521

Activate Deterministic Mode: whether the layouter is in deterministic mode.
Activate Tree Beautifier: whether or not to activate the subtree beautifier.
Attraction: the degree of the attraction between shapes.
Final Temperature: the factor that affects the distance between shapes.
Gravity Factor: the factor that affects the distance between shapes and the center.
Initial Placement: the initial value of placement.
Initial Temperature: the initial value of temperature.
Iteration Factor: the degree of iteration.
Maximum Duration: the maximum degree of duration.
Obey Node Size: the size of obey shapes.
Preferred Edge Length: the preferred length between the nodes.
Repulsion: the factor that affects the distance between shapes which belong to the same ring or star structure.

Organic Layout setting

Automatic Diagram Layout P. 522

Smart organic layout
Smart Organic Layout, which is one of the organic layouts in VP-UML, is a variant of the Organic Layout. It can set the ratio of the quality: producing
time of layout and controls the compactness of layout.

Smart Organic Layout

Automatic Diagram Layout P. 523
Compactness: the factor that sets less/more compact layout.
Deterministic: whether the layouter is in deterministic mode.
Minimal Node Distance: the minimal distance between nodes.
Node Overlaps Allowed: whether the node can be overlapped.
Node Size Aware: whether the node size can be aware.
Preferred Minimal Node Distance: the preferred minimal distance between the nodes.
Quality Time Ratio: the ratio of the quality of layout to the producing time of layout.

Organic Layout setting

Automatic Diagram Layout P. 524

Automatic layout selected shapes
To layout all the shapes in the diagram, right-click on the diagram and select Layout from the pop-up menu.

Perform layout with all shapes of diagram

Automatic Diagram Layout P. 525

To layout the selected shapes, right-click on the selection and select Layout from the pop-up menu (make sure there are more than one diagram
elements selected).

Perform layout with selected shapes

Automatic route connectors

There are 2 kinds of layouts which do not change the location of shapes, only change the connectors: Organic Edge Route Layout and Orthogonal
Edge Route Layout

Automatic Diagram Layout P. 526

Organic edge route layout
Organic Edge Route Layout, which is one of the edge route layouts in VP-UML, arranges the connectors without affecting the location of shapes. It can
ensure that the shapes will not overlap and keep a specific minimal distance.

Organic Edge Route Layout

Automatic Diagram Layout P. 527

Minimal Distance: the minimal distance of the connectors.
Route All: whether all the connectors will be routed.
Use Existing Beans: whether using existing bends.

Organic Edge Route Layout setting

Automatic Diagram Layout P. 528

Orthogonal edge route layout
Route Connectors can arrange the connectors using vertical and horizontal line segments only. It is the best way for users to arrange the connectors
that have complicated route.

Orthogonal Edge Route Layout

Automatic Diagram Layout P. 529

Center to space ratio: the ratio of center to the distance between center and nodes.
Coupled distances: the distance between coupled nodes.
Crossing cost: the cost of crossing connectors.
Custom border capacity: the capacity of the border.
Local crossing minimization: whether the local crossing of connectors will be minimized.
Minimum distance: the minimum distance of connectors.
Minimum distance to node: the minimum distance between the shapes.
Rerouting: whether the connector that has many crossings will be rerouted.
Routing style: the style of routing.

Orthogonal Edge Route Layout setting

Automatic Diagram Layout P. 530

Fit shape size
In some cases, shapes are found oversized. For better presentation, you may need to resize them smaller. Fit size can help you to adjust shapes into
the smallest size based on their content, such as the name of shape. The size of shapes can be fixed either manually or automatically.

NOTE: The size of shapes can be fixed automatically by right clicking on the diagram's background and checking Diagram Content> Auto Fit
Shapes Size.

Fit selected shapes size

To adjust a shape size, move the mouse on a shape and fit size resource centric interface will be shown. Click Fit Sizeresource icon at the bottom of
the shape.

Click Fit Size

To fit several shapes' size, select those shapes, right click on a selected shape and then select Selection > Fit Size from the pop-up menu.

Fit size for several shapes from the pop-up menu

Each shape will be adjusted to its fit size in accordance with its content, instead of fixing all selected shapes into the exactly same size.

Shapes are fitted size

Fit Shape Size P. 531

Check/uncheck automatic fit shape size mode
You can check/ uncheck the Auto Fit Shapes Size on diagram to make all the shapes on the diagram to be fitted size automatically. To do so, right
click on the diagram's background, select Diagram Content > Auto Fit Shapes Size from the pop-up menu.

Check Auto Fit Shapes Size from the pop-up menu

All the shapes are subsequently fitted size and they will become non-sizable.
If the content of shape is changed, the shape itself will be resized automatically.

Class shape is resized automatically after new attribute added

You can also check Auto Fit Size for future usage.
1. Select Tools > Options... from the main menu to unfold Options dialog box.

Fit Shape Size P. 532

2. In the Options dialog box, press the Diagramming category, select the Shape tab and check Auto fit size (diagram-based).

Check Auto fit size (diagram-based) in the Options dialog box

Fit Shape Size P. 533

Diagram element selection
When a number of diagram elements need selecting simultaneously, diagram element selection supports this purpose. You can either click directly with
hot keys or select a range of selection with the mouse. A specific type of diagram element(s) on a diagram can be selected as well.

Selecting multiple shapes

Multiple shapes can be selected by either selecting a range of shapes with the mouse on diagram or clicking shapes with pressing hot keys.

Selecting a range of shapes with the mouse

1. For selecting multiple shapes, drag them from corner to corner diagonally with the mouse. They will then be surrounded by a rectangle
individually.

Select multiple shapes with the mouse

2. After releasing the mouse, those shapes will be selected.

Shapes are selected

Diagram Element Selection P. 534

Clicking with pressing ctrl/Shift key
Click a shape in advance and then click other shapes with pressing Ctrl or Shift key. As a result, those shapes will be selected.

Click shapes with pressing Ctrl or Shift key

Handi-Selection
In some cases, the shapes are too complicated and more seriously, the whole diagram is extremely enormous that neither selecting a range of shapes
with the mouse nor clicking shapes with pressing Ctrl or Shift key are the most suitable application. It is hard to drag the mouse on the large diagram,
or is troublesome to click on many shapes. Using Handi-Selection is probably the best choice for you in this situation.

Diagram Element Selection P. 535

1. Right click on the diagram's background where is in the vicinity of those shapes you are going to select, select Handi-Selection and then select
a scope for selecting shapes (i.e. above/ below/ left/ right) from the pop-up menu.

Select all shapes on the right from the pop-up menu

2. As a result, all the shapes of the particular scope will be selected.

All shapes on the right are selected

Diagram Element Selection P. 536

Selecting same type of shapes
When you want to select a few shapes of same types on the diagram, right click on a shape and select Selection > Select All of Same Type from the
pop-up menu. As a result, other shapes of same type as the shape you selected previously will be selected.

All shapes of same type are selected

Inverse selection
Shapes can be selected inversely. Right click on a shape that you don't want to be selected and select Selection > Select Inverse from the pop-up
menu. As a result, all shapes will be selected except the shape you right clicked on previously.

Selection is inversed

Diagram Element Selection P. 537

Copy and paste
You can create a view of a model element by copying a view and pasting as view, while pasting as model creates a new model from the copied one.

Copying within VP-UML

1. Right click on the selected shape(s), select Copy > Copy within VP-UML from the pop-up menu.

Copy selected shapes with VP-UML EE

2. After you switch to the destination diagram, right click on the diagram background and select either Paste View or Paste Model from the pop-up
menu. The feature of Paste view refers to present the same model element in another view under a new context. The shape is pasted without
creating model; while the feature of Paste Model refers to duplicate the shape and present it in a new view. The model will be copied and
pasted on the diagram. The new model will be named with appending a sequential number.

Paste the selected shape

Copying to clipboard as image (JPG)

1. Right click on the selected shape(s) and select Copy > Copy to Clipboard as Image (JPG) from the pop-up menu.

Copy and paste P. 538

2. When the Copy as Image Option dialog box pops out, select an option from the drop-down menu of Copy type. Click Copy button to proceed.

Select an option from the drop-down menu of Copy type

3. You should select a destination document (e.g. MS Word) for pasting the copied shape(s) to do further documentation. After you switch to the
destination document, right click on the desired place and select Paste from the pop-up menu.
4. As a result, your selected shape(s) will be pasted on the destination document.

Copying to clipboard as image (EMF)

1. Right click on the selected shape(s) and select Copy > Copy to Clipboard as Image (EMF) from the pop-up menu.
2. When the Copy as Image Option dialog box pops out, select an option from the drop-down menu of Copy type. Click Copy button to proceed.
3. EMF is a kind of scalable image which can be pasted on a document for further documentation. After you switch to the destination document,
right click on a desired place and select Paste from the pop-up menu.
4. As a result, your selected shape(s) will be pasted on the destination document.

Copying as XML
You can convert selected shapes into XML which contain the data of selected shapes in XML format. The XML data can then be imported into another
project.
1. Right click on the selected shapes and select Copy > Copy as XML from the pop-up menu.
2. Open a text editor and create a new text file. Paste the XML there and save it as an XML file.
3. After that, the file can be imported to another project by selecting File > Import > XML.
4. When Import XML dialog box pops out, select the xml file path. Finally, click OK button to proceed.

Select the xml file path

Copying to Diagram
1. You can also copy the selected shape(s) to either a new diagram or an existing diagram. Right-click on the selected shapes, select Copy >
Copy to Diagram... from the pop-up menu.

Copy and paste P. 539

2. When the Copy to Diagram dialog box pops out, check Create new diagram if you want to paste to a new diagram or check Select an
existing diagram if you want to paste to an existing diagram.

Check Create new diagram

3. Click Copy to button. As a result, the selected shape(s) will be duplicated on the selected diagram.

Duplicating
With the feature of duplicate, shapes can be duplicated on the same diagram instantly.
1. Right click on the selected shape(s) and select Duplicate from the pop-up menu.

Duplicate a selected shape

Copy and paste P. 540

2. As a result, the selected shape(s) will be duplicated.

The shape is duplicated

Copy and paste P. 541

Alignment guide
Alignment is the adjustment of an object in relation with other objects. Therefore, the diagram alignment means adjusting a shape's position with
another's (or others') in a straight line or in parallel lines. When you drag shapes, alignment guide will appear to let you position the dragging content in
accordance with existing shape(s).

Showing edges alignment guide

When you drag a shape upward or downward, two horizontal lines will reveal on the both edge of the shape as an offer of assistance for adjusting the
shape's position.

Drag upward

Similarly, when you drag a shape to the left or the right, two vertical lines will reveal on the both edge of the shape.

Drag to the right

Showing center alignment guide

When you drag a shape upward or downward, a horizontal line will reveal in the center of the shape as an offer of assistance for adjusting the shape's
position.

Drag upward

Similarly, when you drag a shape to the left or the right, a vertical line will reveal in the center of the shape.

Drag to the right

Changing alignment guide options

If you want the alignment guide to help you to position when you drag shapes, check Show diagram alignment guide; on the contrary, uncheck it if
you don't need a help. Two Choices are provided in alignment guide: Show edges and Show center. Choose Show edges if you want two horizontal
lines to reveal on the both edge of the moving shape while choose Show center if you want a horizontal line to reveal in the center of the shape.
1. Select Tool > Options... from the main menu to unfold Options dialog box.

Alignment guide P. 542

2. In shortcut, typing Alignment guide on top-left text field for searching. It will be shown that the option of alignment guide is on Diagramming
category, Environment tab shortly. As you see, the option will be highlighted for your convenience.

Change alignment guide options

3. The option for alignment guide is checked as default. The next step you need to do is to choose either Show edges or Show center for your
diagrams.
4. Uncheck Show diagram alignment guide if you do not want the assistance of alignment guide when dragging shapes.

Alignment guide P. 543

Reverse connector direction
The flow between shapes is represented by connectors, for example, a sequence message between two lifelines of Student and StudentController
which represents the call from Student to StudentController. If the flow is created mistakenly, or the flows need reverting due to an updated data, the
flows can be fixed by reverting connectors.

Reverse connector direction

1. Right click on the connector between two shapes and select Reverse Connector from the pop-up menu.

Select Reverse Connector from the pop-up menu

2. As a result, the flow of connector is reversed.

Connector is reversed

NOTE: The function of reverse connector is not only for reverting the connector's direction, but also for repositioning the information contained
by the end of connection. For connectors like association, each end contains specific information like multiplicity, role name, visibility, etc.
Reverting connector will also swap the information.

NOTE: Connectors, such as create message in sequence diagram, are not reversible.

Reverse connector direction P. 544

Visualize model elements on diagram
Model elements are fundamental parts of a project. While a model element can be shown on more than one diagram, a diagram can also show a
model element more than once. They, which can be found in Model Explorer or Class Repository, contain metadata and can be shown in diagram
for visualizing the data. For example, a stick figure for an actor model element.
To visualize a model element or several model elements:
1. Select a model element (or as many as model elements you preferred) from Model Explorer.

Select several model elements from Model Explorer

2. Hold on the mouse and drag it on the diagram pane. As a result, the views of the selected model element(s) will be shown on diagram.

Drag the model elements on diagram

Visualize model elements on diagram P. 545

Visualize related model elements
Sometimes, several model elements that related to the current model element(s) are hidden for various reasons. These related model elements, in
fact, can be revealed through the feature of visualize related model element. With this feature, the relationship between model elements can be viewed
thoroughly.
1. Right click on a model element and select Related Elements > Visualize Related Model Element... from the pop-up menu.

Select Visualize Related Model Element...

2. When Visualize Related Model Element dialog box, check the related element(s) you want to be shown with the corresponding relationship on
the diagram in Visualize. Click Visualize button to proceed.

Visualize Related Model Element dialog box

Visualize related model elements P. 546

3. As a result, the related models with connectors are shown on the diagram.

Related model elements are visualized

Visualize related model elements P. 547

Adding comments
VP-UML supports comments on model elements. Since comments are usually used to record the progress and status of model elements, they are
regarded as a textual annotation for model elements.

Adding comment to model element

1. For adding comment in a particular shape, right click on the shape and select Open Specification... from the pop-up menu.

Open specification

2. In Specification dialog box, select Comments tab and click Add... button to create a comment.

Add comment

Adding comments P. 548

3. In Comment Specification dialog box, enter summary, author and date time respectively. Select OK button to confirm editing.

Enter information in Comment Specification dialog box

4. As a result, the comment you entered previously is shown on Specification dialog box.

Comment is shown

Managing comment of model element

1. To modify comment in a particular shape, right click on the shape and select Open Specification... from the pop-up menu.

Adding comments P. 549

2. In Specification dialog box, click Comments tab, select a specified summary comment and click Open Specification... button to proceed.

Open specification

3. In Comment Specification dialog box, modify information and select OK to confirm changing.

Modify information

Adding comments P. 550

Pinning connector ends
Connectors can be either pinned temporarily or pinned permanently. Connector ends help you to point out a specific position of shapes with pin.

Adjusting connector ends temporarily

1. Connectors can be joined at same point of a shape on the diagram. To do so, drag one end of a connector to the shape.

Drag one end of a connector to a shape

2. The connector is temporarily pinned. A dialog box will be shown on the top right corner of diagram to instruct you how to pin the connector.

Connector is temporarily pinned

3. Since the connector that links from shape and to shape together is temporarily pinned, either from shape or to shape is moved, the connector
between them will be unpinned.

Connector is unpinned

Pinning connector ends

1. Move the mouse over a connector and press its resource icon Pin.

Press resource icon Pin

Pinning connector ends P. 551

2. Drag one end of connector to point out a specific position. Note that no dialog box of temporary pin will be shown this time.

Drag one end of connector to point out a specific position

3. Moving either from shape or to shape will not unpin the connector.

Connector is still pinned

Pinning connector ends P. 552

Align and distribute diagram elements
VP-UML supports two types of positioning features: alignment and distribution which allow the positioning of selected shapes in accordance with the
alignment/ distribution option through the toolbar or grouping resource icons. Alignment refers to the edges and the centers of selected shapes are
aligned to each other while distribution refers to selected shapes are distributed in same direction based on their centers or edges.

Aligning diagram elements

Select a few model elements with the mouse on the diagram pane before executing alignment.

Selected shapes

through main menu

1. Select Edit > Align Shapes and then an alignment option from the main menu.

Select Edit > Align Shapes > Right from the main menu

Align and distribute diagram elements P. 553

2. As a result, the alignment of all selected shapes is based on the last selected shape. Note that the last selected shape refers to the shape with
no-filled selector.

Shapes are aligned

3. For turning the non-selected shape into the last selected shape, click a shape with pressing Ctrl key.

Change the last selected shape

through grouping resource icons

1. When move the mouse over one of the selected shapes, grouping resource icons will be shown.
2. Select an alignment option from the drop-down menu of Align Top on the grouping resource icons.

Select Align Left on resources

Align and distribute diagram elements P. 554

3. As a result, all selected shapes are aligned in accordance with the last selected shape.

Shapes are aligned

Setting model elements same width and height

Besides aligning the shapes, shapes can also be resized through the toolbar or grouping resource icons or Align Shapes Dialog.

through main menu

Select Edit > Align Shapes and an alignment option from the main menu.

Resize through main menu

Align and distribute diagram elements P. 555

As a result, the shapes are resized.

Shapes are resized

through grouping resources

Select an option from the drop-down menu of Same Width on grouping resource icons after select a few shapes on the diagram pane.

Resize through grouping resources

through align shapes dialog

After select a few shapes on the diagram pane, select either Align Shapes > Align Shapes on toolbar or Edit > Align Shapes > Align Shapes...
from the main menu to unfold Align Shapes Dialog. You can select an option by clicking the option button on the Align Shapes Dialog directly.

Align Shapes Dialog

Distributing diagram elements

In addition, model elements can be distributed in various directions through the toolbar or grouping resource icons.

Align and distribute diagram elements P. 556

through toolbar
Select a distribution option from the drop-down menu of Distribute Shape on the toolbar after select a few shapes on the diagram pane.

Select Distribute Shapes > Vertically from the main menu

through grouping resource icons

Select a distribution option from the drop-down menu of Distribute Horizontally on grouping resource icons after select a few shapes on the diagram
pane.

Distribute shapes on grouping resource icons

Align and distribute diagram elements P. 557

Adjusting caption's position and angle in BPD
In BPD, for shapes like event and gateway, their names are put outside and below the shape, which may overlap with outgoing sequence or message
flow, making the name hard to read. To solve this problem, you can choose to place the caption elsewhere. Furthermore, you can rotate the caption to
make it easier to read in print out.
To set the position and angle of start, intermediate or end event, or gateway:
1. Right click on the shape and select Presentation Options > Caption Placement... from the popup menu.

To change caption placement

2. Choose the placement, which is the position of caption. For some of the placement options, you can choose additionally the rotation of
placement. You can preview the changes in the preview pane.

To choose a placement option

3. Click OK to confirm.

Caption position updated

Adjusting caption's position and angle in BPD P. 558

Sweeper and Magnet
Modifying your diagrams from time to time is no longer a drag-- let's take our utilities: sweeper and magnet which can help you to modify your diagrams
easily. With these two features, you can move diagram elements easily without worrying too much about the layout. Sweeper can help you to increase
more space between the diagram elements while magnet can help you diminish the space.

Sweeper
The sweeper is one of the useful features for editing your diagrams. If you have ever experienced of moving the diagram elements without any tools,
you probably understand how hard it is to manage the space between the diagram elements. Using sweeper to extend the space between the diagram
elements allows you to move your diagram elements conveniently.
You can move the diagram elements by following the simple steps below:
1. Click Sweeper button from the diagram toolbar.

Click Sweeper

2. Move the mouse on the diagram pane where you would like to move diagram elements.
3. Hold onto your mouse and move the line horizontally or vertically.

Moving down the diagram element horizontally

Magnet
The magnet is another convenient feature for you to move your diagram elements. If you want to move a few diagram elements, you should try
magnet. Its function is to diminish the space between the diagram elements and make your diagrams much tidier for printing. The steps of applying
magnet on your diagram are shown as follows:

Sweeper and magnet P. 559

1. Click Magnet button from the diagram toolbar.

Click Magnet

2. Move the mouse on the diagram pane where you would like to move diagram elements.
3. Hold onto your mouse and move the line horizontally or vertically.

Moving up the diagram element horizontally

Sweeper and magnet P. 560

Mouse gestures
A variety of shapes and model elements can be created by sketching a path directly on the diagram pane with dragging the right mouse button to
form a gesture. For your convenience and quick creation, mouse gestures allow you to execute common commands and create UML models within all
diagrams.

Drawing shapes
1. To start using a mouse gesture, press the right mouse button and drag it until finish drawing a shape.

Drawing clockwise rectangle

2. When the shape is done, release the mouse. After the shape is created, the action description will be shown on top right corner of the diagram.

Class created

Creating Class member

You can learn how to create attribute and operation within the class in the following sub-sections.

Creating an attribute
1. To create attribute, draw a line from the right to the left within the class. As a result, an attribute is created.

Attribute is created

2. If you draw the line until outside the class, an attribute with <<Property>> stereotype will be created.

<<Property>> is created

Creating an operation
1. To create operation, draw a line from the left to the right within the class, an operation with protected visibility is created.

Operation is created

Mouse gestures P. 561

2. If draw the line until outside the class, a public operation will be created.

Public operation is created

Connecting shapes
1. Draw a line from one shape to another.

Drawing from a shape to another

2. After the mouse is released, a connector is created between two shapes.

Association created

Creating a new shape

1. A new shape can also be created. To do so, draw a line from an existing shape to your preferred place.

Drawing to empty area

Mouse gestures P. 562

2. After the mouse is released, a pop-up menu will be shown. You can select your preferred type of connector and shape from the pop-up menu.

Create generalization with class

3. The two shapes with connector are created.

Class with generalization created

List of supported mouse gestures

General

Icon Description

Layout diagram

Open diagram specification

Connect new shape

Connect existing shape

Close Diagram

Mouse gestures P. 563

Thumbnail view

The description of general mouse gestures

Activity diagram

Icon Description

Action

Activity

Decision Node

Initial Node/Finial Node (If there is no Initial Node, an Initial Node will be created. Else if there is no Final Node, a Final Node will be created.)

The description of mouse gestures for activity diagram

Activity diagram (UML 1.x)

Icon Description

Action State

Sub-Activity

Swimlane

Horizontal Synchronization Bar

Vertical Synchronization Bar

Initial State/Final State (If there is no Initial State, an Initial State will be created. Else if there is no Final State, a Final State will be created.)

The description of mouse gestures for activity diagram

Business process diagram

Icon Description

Mouse gestures P. 564

Sub-Process

Pool/Task

Horizontal
Lane

Vertical Lane

The description of mouse gestures for business process diagram

Class diagram

Icon Description

Sync. to ERD

Class

Package

Add attribute (Add an attribute to class. If mouse released outside the class, getter and setter property will be set to true.)

Add operation (Add an operation to class. If mouse released inside the class, visibility will be protected, otherwise it will be public.)

The description of mouse gestures for class diagram

Communication diagram

Icon Description

Sync. To Sequence
Diagram

Lifeline

Actor

Package

Mouse gestures P. 565

The description of mouse gestures for communication diagram

Component diagram

Icon Description

Component

Instance Specification

Package

The description of mouse gestures for component diagram

Composite structure diagram

Icon Description

Class

Interface

Collaboration

Collaboration Use

The description of mouse gestures for composite structure diagram

Data flow diagram

Icon Description

Process

External Entity

Data Store

The description of mouse gestures for data flow diagram

Deployment diagram

Icon Description

Node

Mouse gestures P. 566

Component

Instance Specification

Package

The description of mouse gesture for deployment diagram

EJB diagram

Icon Description

Entity Bean

Message-Driven
Bean

Session Bean

Package

The description of mouse gestures for EJB diagram

Entity relationship diagram

Icon Description

Sync. to Class Diagram

Entity

Add column

The description of mouse gestures for ERD

Interaction overview diagram

Icon Description

Interaction

Decision Node

Mouse gestures P. 567

Initial Node/Final Node (If there is no Initial Node, an Initial Node will be created. Else if there is no Final Node, a Final Node will be created.)

The description of mouse gestures for interaction overview diagram

Mind mapping diagram

Icon Description

Node

The description of mouse gesture for mind mapping diagram

Object diagram

Icon Description

Instance Specification

Class

Package

The description of mouse gestures for object diagram

ORM diagram

Icon Description

Sync. Classes -> Entities

Sync. Entities -> Classes

Class

Entity

Package

The description of mouse gestures for ORM diagram

Overview diagram

Icon Description

Diagram
Overview

Mouse gestures P. 568

The description of mouse gesture for overview diagram

Package diagram

Icon Description

Package

The description of mouse gesture for package diagram

Sequence diagram

Icon Description

Sync. to Communication
Diagram

Lifeline

Actor

Alt

Loop

The description of mouse gestures for sequence diagram

State machine diagram

Icon Description

State

Submachine State

Initial Node/Final Node (If there is no Initial State, an Initial State will be created. Else if there is no Final State, a Final State will be created.)

The description of mouse gestures for state machine diagram

State machine diagram (UML 1.x)

Icon Description

State

Concurrent State

Mouse gestures P. 569

Submachine State

Horizontal Synchronization Bar

Vertical Synchronization Bar

Initial State/Final State (If there is no Initial State, an Initial State will be created. Else if there is no Final State, a Final State will be created.)

The description of mouse gestures for state machine diagram (UML 1.x)

Timing diagram

Icon Description

Frame

The description of mouse gesture for timing diagram

Use case diagram

Icon Description

Use Case

Actor

Package

The description of mouse gestures for use case diagram

Mouse gestures P. 570

Jumping to shape
For searching a shape/shapes faster, the application of the jump to shape/shape facility is introduced. You can select either jump to a model element in
an active diagram, or jump to any model elements in the current project, or even jump to a diagram in current project.

Jumping to a diagram/model element in project

If there is an active diagram opened, you can jump to the model element in the active diagram.
1. You can select Edit > Jump to Element in Active Diagram... from the main menu or press Ctrl+J to unfold Jump to dialog box.

Select Jump to Element in Active

Diagram from the main menu

2. Apart from jumping to element in active diagram, you can also jump to any element within the project. You may select Edit > Jump to
Element... from the main menu or press Ctrl+Shift+J to unfold Jump to dialog.
3. In Jump to dialog box, if you want all elements within project to be searched, uncheck the Active diagram only checkbox. In some cases, the
checkbox is disabled because no diagram is opened.

Jump to dialog box is shown

Jumping to shape P. 571

4. Enter a word in the text field, a list of model element's name that starts with the word you typed will be shown .

A list of possible shapes is shown

5. Press Down key to search for the model element's name if the list is too long. Click your preferred model element's name and it will be spot-
lighted on the active diagram.

Shape is spot-lighted

Jumping to shape P. 572

6. Press Enter to confirm jump to the model element. Finally, the Jump to dialog box will then be hidden and the model element will be selected
on diagram.

Shape is selected after confirm jump to

Jumping to shape P. 573

Filtering with wild card character
For quick search, you can type a word with * in the text field. The asterisk can substitute a character or a word when you don't remember the exact
spelling. As a result, all names of shape that similar to the word you typed will be shown.

Entering name with *

Jumping to diagram

Jumping to shape P. 574

1. To do so, select Edit > Jump to Diagram... from the main menu or press Ctrl+Shift+D to show Jump to dialog box.

Select Jump to Diagram... from the main menu

2. Jump to dialog box is shown with selected Diagram in combo box. It means Jump to dialog box will search all diagrams within the project.

Jump to dialog will search all diagrams within the project

3. Enter a word out of the whole diagram's name will show a list of diagrams' names similar with the word you typed . Select the diagram and press
Enter will open the diagram.

Select the diagram on list

Easy navigation to connected elements

If you have an oversized diagram that the from/to model elements of connector can't be shown on the screen, it is hard for you to know the from/to
model elements. VP-UML supports Scroll to function to scroll to from/to model element of a connector. If you want to know which model element is the
from model element that is connected with a model element .
To achieve this:

Jumping to shape P. 575

1. Right click on the connector and select Scroll to and then select Source with parentheses from the pop-up menu. (The word in parentheses is
the name of the from model element.)

Scroll to from model element

2. The from model element is subsequently selected on diagram.

From model element is selected

Jumping to shape P. 576

Grouping diagram elements
After you have aligned shapes to a group of shapes, in some cases, you want to move a number of shapes simultaneously, or make them share the
same formatting properties, like background color and line formatting. Grouping can help you for this purpose exactly. By grouping shapes, shapes
within the group will move together when moving any shape inside the group. If you edit formatting of one shape, all shapes will also be shared.

Grouping diagram elements

1. Select the shapes you want them to be grouped together.

Select several shapes

2. Click resource icon Group to group the selected shapes.

Group through resource icon Group

3. When you move a shape, other shapes within the same group will also be moved.

All shapes in group are moved together

Grouping diagram elements P. 577

Ungrouping diagram elements
To ungroup the shapes, click resource icon Ungroup.

Click Ungroup

Grouping diagram elements P. 578

Show/hide diagram elements
On a compact diagram, to hide or show some of the shapes is necessary. You can choose to hide away diagram elements on a diagram temporarily.
For example, hiding away annotation shapes which record internal communications before printing out a diagram for customers' review. In VP-UML,
hiding of diagram elements can be done per shape, per shape type or by stereotype.

Hiding selected diagram element(s)

Right click on the selected shape(s) and select Selection > Hide from the pop-up menu.

Select Hide from the pop-up menu

Show/hide diagram elements P. 579

Apart from the selected shapes, its related shape(s) (e.g. children and relationship) will also be hidden.

The selected shape and its related shapes are hidden

NOTE: To hide a shape will also make the connectors that attached to it hidden.

NOTE: To hide a container shape (e.g. package) will also make the contained shapes hidden.

Show/hide diagram elements P. 580

Hiding diagram elements by shape type
All the shapes with same type from the diagram can also be hidden. Right click on the diagram's background and select Diagram Content > Show/
Hide > Hide by Shape Type, and then select the shape you want to be hidden from the pop-up menu. As a result, all shapes with the same type you
selected will be hidden.

Hide all shapes by shape type

Show/hide diagram elements P. 581

Hiding diagram elements by stereotype
The stereotype of all diagram elements from the diagram can be hidden. Right click on the diagram's background and select Diagram Content >
Show/Hide > Hide by Stereotype, and then select one stereotype out of the list from the pop-up menu. As a result, all shapes with same stereotype
you selected will be hidden.

Hide all shapes by stereotype

Show/hide diagram elements P. 582

Showing all hidden diagram elements
All hidden shapes from the diagram can be shown again. Right click on the diagram's background and select Diagram Content > Show/Hide > Show
all Diagram Elements. As a result, the hidden shapes will be shown on the diagram.

Managing show/Hide of specific diagram element(s)

A better management of showing and hiding the shapes can be done in Show Hide Diagram Elements dialog box.
1. Right click on the diagram's background, select Diagram Content > Show/Hide > Show/Hide Diagram Elements... from the pop-up menu.

Select Show/Hide Diagram Elements... from the pop-up menu

Show/hide diagram elements P. 583

2. When Show Hide Diagram Elements dialog box is unfolded, you may select the shape(s) you would like to be hidden or to be shown. Click the
diagram element you would like to move to Hide list and press Hide Selected button; on the other hand, click the diagram element you would
like to remove it back to Show list and press Show Selected button. For moving all diagram elements to Hide list, press Hide All button; press
Show All button, vice verse. Finally, click OK to confirm.

Select a diagram element to be moved to Hide list

NOTE: If a shape is selected from Show list, the related shape(s) of the selected shape will be also removed to Hide list

Show/hide diagram elements P. 584

Layer
If you have ever experienced how hard it is to deal with a number of shapes, try the application of multi-layers. VP-UML supports multi-layers to help
you manage different shapes efficiently. The functions of layer assist you in assigning different shapes into different layers, hiding unnecessary shapes,
locking shapes and selecting shapes in shortcut.

Creating a layer
1. Right click on the diagram background and select Layers... from the pop-up menu.

Select Layers... from the pop-up menu

2. In Diagram Layers dialog box, click Create new layer button to create a new layer.

Create a new layer in Diagram Layers dialog box

Layer P. 585
3. Finally, define the name for the newly created layer.

New layer will be an active layer

Sending shapes to a layer

The existing shapes are kept in default layer. However, both existing shapes and the newly created shapes on diagram can be sent to a new layer.
Create a new layer just like the steps of previous section. Right click on a shape and select Layers, and then select the new layer you have created.

Send the shape to a new layer

As a result, the shape you selected will be sent to the new layer.

Layer P. 586
Hiding shapes on a layer
In Diagram Layers dialog box, you can make a layer invisible on diagram. To do so, uncheck Visible of the layer.

Shapes on the layers are invisible on diagram

Locking shapes on a layer

In Diagram Layers dialog box, check Locked to make all shapes in that layer immovable and unable for editing while uncheck Locked to make them
movable and editable.

Shapes on the selected layer are locked

Layer P. 587
Selecting shapes on a layer
You can also select all shapes of the selected layer. To do so, click Select shapes in selected layers button in Diagram Layers dialog box.

Shapes of the layer are selected on diagram

Layer P. 588
Making shape non-selectable
If you find it annoying to move some shapes carelessly or select some shapes accidentally, the function of selectable/non-selectable would be your
ideal trouble-shooter. This page is going to teach you how to make shapes non-selectable or even change them back to selectable with only few clicks.

Changing the shape to non-selectable

1. Right click on the selected shapes, uncheck Selection > Selectable from the pop-up menu.

Selected shape to be non-selectable

2. After the shape is non-selectable, click the shape cannot make it to be selected. Neither will the shape be selected by mouse dragging on
diagram.
3. Therefore, the non-selectable shape(s) will not be moved when other shapes are moved.

Changing the shape to selectable again

To make the shape selectable again, right click on the non-selectable shape and select Selectable from the pop-up menu.

Select Selectable

Making shape non-selectable P. 589

Setting all shapes to selectable or non-selectable
To makes all shapes on the diagram to be selectable or non-selectable, right click on the diagram background, select Diagram Content and then
select either Make All Shapes Selectable or Make All Shapes Non-Selectable from the pop-up menu.

Select Make All Shapes Selectable

Making shape non-selectable P. 590

Locking diagram
For reviewing the diagram, the application of lock diagram is the straight way. Diagram can be locked to be read-only. After it is locked, any shapes on
the diagram cannot be modified, inserted or deleted.

Locking the diagram

To lock the diagram, right click on the diagram background and select Diagram Content > Lock Diagram from the pop-up menu.

Lock the diagram

After it is locked, the diagram toolbar is disabled subsequently. As a result, no shapes can be selected and the diagram becomes read-only. As you
can see the Diagram Locked dialog box is shown at the bottom left of the diagram, however, close this dialog box will not unlock the diagram.

Diagram is locked

Locking diagram P. 591

Unlocking the diagram
To unlock the diagram, you should click Unlock button on the Diagram Locked dialog box.

Click Unlock in the Diagram Locked dialog box

Alternatively, you can right click on the diagram background and select Diagram Content > Lock Diagram from the pop-up menu.

Unlock the diagram from the pop-up menu

Locking diagram P. 592

Showing model element in multiple diagrams (Context base modeling)
You can show a model element in multiple diagrams to fit into different contexts. To show model elements on different diagrams, you may drag and
drop the model element(s) from the tree to the diagram, or copy and paste it as view.

Reusing model elements

In Model Explorer, a model element or several model elements from the source diagram can be dragged from the tree and drop it/ them on the
destination diagram.

Drag a model element from the tree

Alternatively, you may copy and paste the selected model element(s) as view in destination diagram. Right click on the selected model element(s) in
the source diagram and select Copy > Copy with VP-UML from the pop-up menu.

Copy a model element

When you switch to the destination diagram, right click on the preferred place that you want the copied model element(s) to be pasted on and select
Paste View from the pop-up menu.

Class PrivateCar is pasted as a new view

NOTE: Choosing Paste Model means a new model element will be created and shown on the destination diagram.

The relationship between the model elements may not be shown on diagram. If you want their relationship to be revealed, right click on the model
element, select Related Elements > Visualize Related Model Element... from the pop-up menu.
When the Visualize Related Model Element dialog box pops out, check a relationship for the model element(s) and then click the Visualize button to
proceed.

Showing model element in multiple diagrams (Context base modeling) P. 593

As a result, their relationship is shown on the diagram.

Relationship is visualized

Opening other views

You can find out the source diagram of a model element by right clicking on it and select Related Elements > Show Other Views... from the pop-up
menu.

Click Show Other Views...

Showing model element in multiple diagrams (Context base modeling) P. 594

All diagrams, which contain the same model elements you selected, are listed and shown in the Show View dialog box. You can check a diagram
under Views and preview it under Preview; furthermore, click Go to View button to jump to and view the actual diagram.

Show View dialog box

Enforcing master view between model element and shape

If a model element is shown on different diagrams, you can define a shape to be the master view of the model element. Right click on the selected
shape, select Selection > Set as Master View from the pop-up menu.

Set as Master View

NOTE: If the shape you right click on is already the master view, the option of Set as Master View won't be shown on the pop-up menu.

Showing model element in multiple diagrams (Context base modeling) P. 595

Using overview diagram
When various diagrams with different contexts are modeled in your system, an overview diagram can be created to illustrate their relationships related
each other. With the overview diagram, you can have an overview of your system, after all, you can study their relationships. Since the overview
diagram is consist of thumbnail of diagrams that you have created previously, the overview of each diagram if find to be related to another diagram can
be linked up with connectors.

Creating an overview diagram

To create an overview diagram, select File > New Diagram > Others > Overview Diagram from main menu.

Create a new overview diagram

As a result, an empty overview diagram is created. Create overviews of diagrams and relate them to illustrate their relationship with each other.

The overview diagram

Using overview diagram P. 596

Creating an overview of new diagram
You can create a diagram from overview diagram. To create a new diagram from overview diagram, select your preferred diagram type from the
diagram toolbar and drag it on the diagram pane.

Create a use case diagram overview

The new diagram will be opened subsequently. Enter a name for new diagram and start working on it.
If you go back to the overview diagram, the preview of newly created diagram can be seen. If you realize that the diagram in diagram overview is too
small and vague for previewing, you may resize the diagram overview by dragging its bottom right corner.

The newly created diagram is shown on overview diagram

Creating an overview of existing diagram

Besides creating an overview diagram of new diagram, you can also create an overview of existing diagram.
1. Create a diagram overview from the toolbar of overview diagram.

Create a diagram overview

2. Right click on the diagram overview and select Associate to Diagram... from the pop-up menu.

Using overview diagram P. 597

3. Select a diagram that you want to be shown on diagram overview and select OK button.

Select an existing diagram

4. As a result, the selected diagram will be shown on diagram overview. If you realize that the diagram in diagram overview is too small and vague
for previewing, you may resize the diagram overview by dragging its bottom right corner.

The selected diagram is shown

Visualizing sub-diagram
When a diagram overview you created has a sub-diagram, you can connect them together and make them shown on the current overview diagram.
Move the mouse over a diagram overview and click its resource icon Visualize Related Diagrams.

Press Visualize Related Diagrams

Using overview diagram P. 598

As a result, the sub-diagram will be shown and both diagram overviews are connected.

Two diagram overviews are connected

Selecting a connector for diagram overviews

In order to present a relationship between two diagrams, different connectors should be used. Diagram containment is used when a diagram contained
is a part of the containing diagram overview while directional generic connector is used to model the sequence of diagrams, from advance to another.
Select a connector from the diagram toolbar and drag it from the source diagram overview to the destination diagram overview.

Select Diagram Containment

Using overview diagram P. 599

UML note
In VP-UML, UML notes can be created and attached to a shape via an anchor connector. The premier advantage of using UML notes is annotating a
specific model element on the diagram with normal text or HTML text, or to define OCL.

Creating a UML note with resource centric

1. Move the mouse over a shape and select a note resource icon.

Mouse the mouse over a shape

2. Drag it to a desired place on the diagram pane.

Drag the resource icon

3. Release the mouse. The shape is connected with the newly created note.

Note created

Editing UML note content

1. Double click the note to start editing its content. Note that the toolbar above the note can be used to format its content.

Start editing

2. Drag the bottom right corner of note to resize it.

Resizing

3. Click on the diagram background to confirm editing the note.

UML note P. 600

Callout shape
Callout shape is a label that is used for explanation on your model elements. Inserting callout shape aims to draw others' attention and give them
additional remarks. Basically, its function is similar to a photo caption or a comment. However, it does more than merely either a photo caption or a
comment. In fact, it looks more likely to a dialog box that you can place it next to your model elements.

Adjusting the direction of callout shape pointer

1. A remark can be inserted by selecting Callout from the diagram toolbar and dragging it to the model elements directly on the diagram pane.
2. The direction of callout shape pointer can be adjusted by simply dragging the pointer's end.

Adjust the pointer

3. The pointer can be adjusted to point out a more specific position, such as pointing to the name of diagram element, or a specific class member
(attribute/operation) out of a class.

Adjust the pointer to a specific class member out of a class

NOTE: You can not only adjust the pointer's direction, but also its length.

Repositioning the shape

The position of callout shape can be moved by dragging the + icon that is located on the top right corner of the callout. This icon is used to reposition
the shape in a straight and simple way.

Reposition the shape

NOTE: The callout shape will be moved but the position of its pointer won't be changed if you only drag the + icon. This helps you to remain the
pointing and move the callout shape simultaneously.

Editing callout shape content

The content of callout shape can be edited by double clicking on the callout shape.

Callout shape P. 601

Emphasizing the content of callout shape
Formatting buttons can be used to insert formatting for the text in order emphasize your key points while you are editing the content, such as changing
font color. This helps to enhance the visual effect of the text as well.

Format the text

Callout shape P. 602

Freehand shapes
Freehand shapes are multi-functional features in VP-UML. With freehand shapes, you can not only draw various kinds of shapes, but also insert an
annotation. If you want to stress an important message with visual effect, you may use word art rather than using a note or a callout because you can
reshape the text in word art, however, not in a note or a callout. Moreover, the shapes in freehand are flexible that you can twist them freely, but you
can only resize a note or a callout.

Freehand toolbar interface

Summary of freehand shapes

Shape Type Sample

Pencil

Pen

Calligraphic Tool

Connector

Line

Label Line

Path Rectangle

Rectangle

Freehand shapes P. 603

Round Rectangle

Round Rectangle 2

Diamond

Parallelogram

Trapezoid

Isosceles
Trapezoid

Path Ellipse

Ellipse

Arc

Chord

Pie

Regular Polygon

Freehand shapes P. 604

Isosceles Triangle

Hexagon

Arrow

Two Head Arrow

Spiral

Text

Word Art

Summary of freehand shape

NOTE: Freehand can be switched on by clicking on diagram toolbar and select Category > Freehand from the pop-up menu.

Drawing free style path with pencil

1. Press on the empty space on diagram pane and drag to form the outline.

Drawing with pencil

2. Release the mouse and new freehand shape will then be created.

Activating the fine editing selector

Fine editing selector shows a second later after the freehand shape is being selected. To show it immediately, press keyboard ' N' key.
Press on a yellow selector for selecting and the selected selector will turn into orange. More fine editing selectors will appear for curve adjustment.

Selected fine editing selector

Freehand shapes P. 605

Drawing curve with pen
1. Click on empty space on diagram pane and drag it to create the first stroke.

Straight line created

2. To create a curve, press and move the mouse. The indication line will appear. Release the mouse button when finishing editing. On the other
hand, the last stroke can be cancelled by right clicking on the diagram.

Creating curve

3. To confirm editing of the freehand shape, double click on diagram and a new freehand shape will be created. If the point returns to the starting
point, it will form a closed path.

A close path

Drawing calligraphic path with calligraphic tool

1. Press on the diagram and drag to form the outline of shape. Release the mouse to create the shape.

Freehand shape created

2. By combining several other calligraphic shapes, you can create a complete diagram.

Calligraphy example

Draw straight and curve line with connector

Freehand shapes P. 606

1. Press on a source shape and drag it to the destination shape.

Connecting shapes

2. Release the mouse and a new connector will be created between them.

A line is created

Bend a straight connector into a curve

1. Press on a straight connector.

Clicking on straight line

2. Bend it to your preferred direction and it will become a curve connector.

A curve connector

Split a straight connector

1. Press the Ctrl key.
2. Click on the specified location to split. A new point at where you have clicked will turn into orange.

Splitting line

Freehand shapes P. 607

3. Drag on that point to split the line.

Moving mid point

Drawing straight and curved line

1. Press on the diagram pane and drag to form the outline.
2. Release the mouse button and a straight line will be created.

Line created

Bend a straight line into a curve

1. Select a straight line for a second to wait for the fine editing selectors popping out.

Showing fine editing selector

2. Press on the straight line. Drag it to bend into your preferred direction.

Dragging line as curve

Split straight line

1. Press the Ctrl key.
2. Click on the specified location to split. A new point at where you have clicked will turn into orange.

Splitting line

Freehand shapes P. 608

3. Drag on that point to split the line.

Moving mid point

Drawing labelled line

1. Press on the diagram and starting dragging to form its outline.
2. Release the mouse button to create the labelled line.

Freehand shape created

3. Double click on the line. Enter the name for the line.
4. Press Enter to confirm editing.

Label Line

5. You may drag the yellow selector to modify the line's outline.

Drawing rectangle
Click on the diagram to create a rectangle.

Freehand shape created

Drawing path rectangle

Click on the diagram to create a path rectangle.

Freehand shape created

Freehand shapes P. 609

What's the difference between rectangle and path rectangle?
Path rectangle is formed by path, which enables you to freely reshape it, while rectangle always keeps shape as a rectangle.

Drawing rounded rectangle

Click on the diagram to create a rounded rectangle.

Freehand shape created

Drawing rounded rectangle 2

Click on the diagram to create a rounded rectangle 2.

Freehand shape created

What's the difference between rounded rectangle and rounded rectangle 2?

Rounded rectangle uses a single control point to control the deepness of corner, which ensures that the four corners remain consistent while rounded
rectangle 2 uses two points to control the deepness of corner, which can produce irregular corners.

Drawing diamond
Click on the diagram to create a diamond shape.

Freehand shape created

Drawing parallelogram
Click on the diagram to create a parallelogram shape.

Freehand shape created

Drawing trapezoid
1. Click on the diagram to create a trapezoid shape.

Freehand shapes P. 610

2. You can adjust the slope by dragging the fine editing selectors in yellow.

Other trapezoid outline

Drawing isosceles trapezoid

1. Click on the diagram to create an isosceles trapezoid shape.
2. You can reshape the Isosceles Trapezoid by dragging the fine editing selectors in yellow.

Other isosceles trapezoid outline

Drawing ellipse
Click on the diagram to create an ellipse shape.

Freehand shape created

Drawing path ellipse

Click on the diagram to create a path ellipse shape.

Freehand shape created

What's the difference between ellipse and path ellipse?

Path ellipse is formed by path, which enables you to freely reshape it while ellipse always keeps shape as an oval.

Drawing arc
1. Click on the diagram to create an arc shape.

Freehand shapes P. 611

2. You can extend the line by dragging on the fine editing selectors in yellow.

Other arc outline

Drawing chord
1. Click on the diagram to create a chord shape.
2. You can extend the arc of chord by dragging on the fine editing selectors in yellow.

Other Chord outline

Drawing pie
1. Click on the diagram to create a pie shape.
2. You can extend the arc of pie by dragging on the fine editing selectors in yellow.

Other pie outline

Drawing hexagon
Click on the diagram to create a hexagon shape.

Freehand shape created

Drawing regular polygon

1. Click on the diagram to create a regular polygon shape.

Freehand shapes P. 612

2. You can modify the outline of shape by dragging the fine editor selectors in yellow.

Other regular polygon outline

Drawing isosceles triangle

Click on the diagram to create an isosceles triangle shape.

Freehand shape created

Drawing single head arrow

1. Click on the diagram to create an arrow shape.
2. You can reshape it by dragging the fine editing selectors in yellow.

Other Arrow Outline

Drawing two head arrow

1. Click on the diagram to create a two head arrow shape.
2. You can reshape it by dragging the fine editing selectors in yellow.

Other two head arrow outline

Drawing spiral
1. Click on the diagram to create a spiral shape.

Freehand shapes P. 613

2. You can reshape it by dragging the fine editing selectors in yellow.

Other Spiral outline

Inserting text
1. Click on the diagram to create a text shape, and input the text. You can press Enter to insert line break.

Input the text in text shape

2. You can click Ctrl while pressing Enter to confirm editing.

Inserting word art

1. Click on the diagram to create a word art shape, and input the text. You can press Enter to insert line break.
2. You can click Ctrl while pressing Enter to confirm editor.

Freehand shape created

3. You can reshape it by dragging the fine editing selectors in yellow.

Editing word art

Freehand shapes P. 614

Reference to external resources
Additional references can be attached to a shape through resource icon References, such as inserting a file, a folder and a URL. After that, you can
open and view the inserted references through resource icon References.

Adding external resources

Adding a file reference
1. Move the mouse over a shape to add reference, click the resource icon References and select Add File... from the pop-up menu.

Click Add File...

2. When the specification dialog box pops out, enter the referenced file path or select the file path by clicking ... button. You may also enter the
description for the file in Description.

Enter file reference path

3. Click OK button to confirm the creation for file.

Adding a folder reference

1. Move the mouse over a shape to add reference, click the resource icon References and select Add Folder... from the pop-up menu.

Click Add Folder...

Reference to external resources P. 615

2. When the specification dialog box pops out, click the ... button in Path to select a folder path.

Click the ... button

3. When Select Directory dialog box pops out, select a folder to be referenced and click OK button.
4. You may enter the description for the folder. Finally, click OK button to confirm the creation for folder.

Adding a URL reference

1. Move the mouse over a shape to add reference, click the resource icon References and select Add URL... from the pop-up menu.

Click Add URL...

2. When the specification dialog box pops out, enter the URL path. You may also enter the URL name and the description for the URL.

Enter URL path

3. Click OK button to confirm the creation for URL.

Opening external resources

Move the mouse over a shape to open reference, click the resource icon References and select an external resource from the pop-up menu.

Reference to external resources P. 616

If you select a URL reference to open, it will be opened by default web browser. If you select a file reference to open, it will be opened by your system
with the program used to open this kind of file. If you select a folder reference to open, it will be opened by your system automatically.

Open a URL reference

Editing references
1. Move the mouse over a shape and press it resource icon References and select Edit References... from the pop-up menu.
2. When the specification dialog box pops out, double click on the row of reference you want to enter its description or modify it.
3. Enter the description or modify it under Description column.

Enter the description

4. Finally, click Enter button to confirm editing.

Removing a reference
1. Move the mouse over a shape which has references, click its resource icon References and select Edit References... from the pop-up menu.
2. When the specification dialog box pops out, select a reference to be removed on the list and press Remove button to delete the selected
reference.

Select a reference to remove

3. Finally, click OK button to confirm the reference removal.

Reference to external resources P. 617

Reference to diagrams and shapes
Additional references can be attached to a shape through resource icon References, for example, inserting a diagram and a shape. After that, you can
open and view the inserted references through resource icon References.

Reference to diagrams
1. Move the mouse over a shape, press its resource icon References and select Edit References... from the pop-up menu.

Click Edit References...

2. When the specification dialog box pops up, click Add Diagram... button.

Click Add Diagram...

3. In Select Diagram dialog box, check an existing diagram or create a new diagram by clicking the icon under Diagrams.

Check an existing diagram

Reference to diagrams and shapes P. 618

4. You may enter the description for the diagram in the specification dialog box. Finally, click OK button to confirm the reference creation.

Enter description

Reference to shapes
1. Move the mouse over a shape, press its resource icon References and select Edit References... from the pop-up menu.
2. When the specification dialog box pops up, click Add Shape... button.

Click Add Shape...

3. In Select Shape dialog box, check a shape to be referenced and click OK button.

Check a shape

4. Enter the description for the shape in the specification dialog box. Finally, click OK button to confirm the creation of shape.

Opening a reference
Move the mouse over a shape, press its resource icon References and select a shape/ a diagram to open from the pop-up menu. If you select a
shape to open, it will switch to the diagram where the shape belongs to and the shape will be selected by filled-selector. If you select a diagram to
open, it will switch to the selected diagram immediately.

Open a shape reference

Reference to diagrams and shapes P. 619

Enter the description

4. Finally, click Enter button to confirm editing.

Select a reference to remove

3. Finally, click OK button to confirm the reference removal.

Reference to diagrams and shapes P. 620

Elaborating model element with sub diagram
Each notation has its own meaning and semantic. For example, you use a use case to present users' goals (system functions) but not how to achieve
the goals. In order to model other aspects like the dynamic behavior of use case, you can elaborate a model element with a proper type of sub-diagram
and contribute the details on the model element.

Creating a new sub diagram

Move the mouse over a shape, press its resource icon Sub Diagrams when it reveals and select Add and then a preferred type of diagrams from the
pop-up menu.

Add a sub diagram

NOTE: Inserting a sub diagram on a model element, all child model elements of the sub diagram will also be attached.

Adding an existing diagram as sub diagram

Right click on a selected shape, select Sub Diagrams > Add Existing Diagrams... from the pop-up menu.

Add an existing diagram as sub diagram

Elaborating model element with sub diagram P. 621

When the Add Sub Diagrams dialog box pops out, select a sub diagram and then click OK button.

Add Sub Diagrams dialog box

Removing sub diagram

1. Move the mouse over a shape, press its resource icon Sub Diagrams and select Edit Sub Diagrams... from the pop-up menu.

Click Edit Sub Diagrams...

2. In the specification dialog box, select a sub diagram that you want it to be removed from the list and click Remove button. When the Confirm
Remove dialog box pops out, click Yes button to confirm the deletion.
3. Finally, click OK button to proceed.

Elaborating model element with sub diagram P. 622

Showing sub diagrams and reference indicators
The indicator of sub-diagrams and references helps you identify which shapes in diagram have sub-diagrams and/ or attached with references. The
indictor can be shown through the button on diagram toolbar.
1. Click Always Show Reference, Sub Diagram, Model Transitor and Documentation Resource button on diagram toolbar.

Click Always Show Reference, Sub Diagram, Model

Transitor and Documentation Resource button

2. As a result, references resource icon and sub-diagrams resource icon are shown.

References resource icon and sub-diagrams resource icon are shown

NOTE: The indicator of sub-diagrams and references can be hidden by clicking Always Show Reference, Sub Diagram, Model Transitor and
Documentation Resource button once again.

Showing sub diagrams and reference indicators P. 623

Creating shape in shape editor
Although UML and BPMN are well-established notations, sometimes they still not rich enough to express domain specific idea. Shape Editor is a
diagramming tool for you to design your own notation (stencil). Notations created can be incorporated into diagrams in VP-UML. To use shape Editor:

Creating Shape in Shape Editor P. 624

1. To launch Shape Editor, select Tools > Shape Editor... from the main menu.

Open Shape Editor through the main menu

Shape Editor is opened.

Shape Editor

Creating Shape in Shape Editor P. 625

2. A shape need to be created under a stencil, while a stencil is put under a category, under a gallery. To create a gallery, right-click on the Stencil
pane and select Add Gallery in the popup menu.

To add a gallery

3. Enter the gallery name and press the Enter key to confirm editing.

Naming a gallery

4. To create a category, right click on a gallery and select Add Category in the popup menu.

To add a category

5. Enter the category name in the Input dialog box and click OK button to confirm.

Creating Shape in Shape Editor P. 626

6. To create a stencil, right click on a category and select Add Stencil in the pop-up menu.

To add a stencil

7. Enter the stencil name and press the Enter key to confirm editing.

Naming a stencil

8.
To create a shape, click on the ( New Shape) button in the bottom part of the Stencil pane to create a blank drawing for drawing the shape.

Add a shape

Creating Shape in Shape Editor P. 627

9. Draw the shape in the drawing pane.

Draw a shape in drawing pane

10. Save the drawing by selecting File > Save from the main menu.

Save the drawing

Shapes created in Shape Editor can be used in VP-UML. For details, please refer to the next section.

Creating Shape in Shape Editor P. 628

Creating shapes from stencil pane
The Stencil pane is where user-created stencil shapes are stored. User can create a stencil shape on diagram by first displaying a stencil, dragging
and dropping a shape from Stencil pane to diagram. Below are the steps in detail.
1. Open the Stencil pane. It is by default resided at the panes at the bottom left of VP-UML. If it does not appear, select View > Panes > Stencil
from the main menu.
2.
Click on the (Add Stencil) button in the top of Stencil pane. This pops up a list of gallery. Select the stencil to add. The stencil is then added
to the Stencil pane.

Add a stencil

NOTE: You can add multiple stencil by repeating this step.

3. Press on a shape in the Stencil pane and drag it out of the Stencil pane and drop it on the diagram to create the shape.

Dragging shape out of Stencil pane

4. You can also use generic connector to connect built-in notations shapes and stencil shapes. To do so, select Generic Connector in the
diagram toolbar, under the Common category.

Select Generic Connector

from the diagram toolbar

5. Press on the source shape, hold the mouse button, move the mouse cursor to the target shape and release the mouse button.

Connecting an Actor with a stencil shape

Creating Shapes from Stencil Pane P. 629

Hiding user interface components
You may want to hide away some diagram types, menu items or toolbar items to avoid your team creating wrong types of model. This can be done by
user interface (UI) customization.
1. Select Help > Customize UI... from the main menu.

Open the customize UI dialog box

2. In the Customize UI dialog box, select the menu(s)/toolbar button(s)/pop-up menu(s) to hide, and click on the > button to hide them.

Select the menus to hide

3. Click OK button to confirm. By restarting the application, the selected user interface componenets will be hidden.

User interface components are hidden

Hiding user interface components P. 630

Adjusting user interface font
VP-UML runs with a screen design that is friendly enough for most users, but you can customize it to make it suit your preference. One of the possible
customization is to adjust the font settings for text appears on user interface, like the button caption for tools in toolbar, diagram editor tab's title, menus'
captions, etc. The settings will be stored in workspace. Hence, you can keep the settings every time you run VP-UML.
To adjust font settings:
1. Select Tools > Options from the main menu.
2. Select General from the list on the left hand side.
3. Open the Appearance page.
4. Check Change application font in the Font section. Adjust the font type and size.

Adjusting font settings

5. Click OK.

Adjusting user interface font P. 631

6. Restart the application to let the settings take effect.

Updated user interface

Adjusting user interface font P. 632

Instant reverse Java sources and classes
Instant reverse is a process to produce UML class model from a given input of source code. With instant reverse, you can reverse a snap shot of your
code-base to UML classes and form class diagram in further. By bringing code content into visual UML model, this helps programmers or software
engineers to review an implementation, identify potential bugs or deficiency and look for possible improvements. Apart from this, developers may
reverse a code library as UML classes, and construct model with them, like to reverse a generic collection framework and develop your own framework
by extending the generic one. In this chapter, we will go through the instant reverse of Java.

Reverse engineering UML classes from source files

1. Select Tools > Instant Reverse > Java. .. from the main menu.

Perform instant reverse

Reverse engineering of Java sources and classes P. 633

2. In the Instant Reverse dialog box, add the file or folder path of source by clicking on the appropriate Add button at the right hand side of the
dialog box. There are four kinds of supported sources: Jar file, class folder, a zip of source or a folder of source files.

The Instant Reverse dialog

NOTE: You can reverse multiple source paths by adding them one after the other. You can add different kinds of source. For example, you can
reverse a jar as well as a folder of source file at the same time.

3. You can place reversed classes to specific model. For example, to place legacy code to a model named Old, to place system prototype to a
model named Prototype and so forth. To do this:
1. Click on the ... button at the end of the Reverse to Model row.
2. In the Select Parent Model dialog box, either select an existing model, or create one by clicking New Model.
3. Click OK to confirm.

4. By default an on-demand reverse engineering will be carried out, which means to form indexes to the added path(s) instead of actually reversing
them. For details about on demand reverse engineering, refer to the section below. If you want to carry out actual reverse engineering, uncheck
Reverse source on demand.
5. Click OK to start reversing.
6. Upon finishing, the class repository will be popped up, listing the reversed classes (or indexes of classes if you are running an on-demand
reverse engineering).

NOTE: By cancelling from forming diagram, it just means you do not want to form diagram with the reversed classes for the time being. You can
still look for the classes in Model Explorer or Class Repository, and possibly form diagram later on manually.

Overview of Instant Reverse

Reverse engineering of Java sources and classes P. 634

Overview of instant reverse dialog box

No. Name Description

1 Language The programming language for reversing.

2 Source paths A list of source paths to be reversed.

3 Add Jars Add a path of Jar file for reversing.

4 Add class folder Add a path of Java class folder for reversing.

5 Add zips Add a path of a zipped source folder for reversing.

6 Add source folder Add a path of Java source folder for reversing.

7 Set model Set the model for placing the reversed UML classes into.

8 Remove Remove selected source path(s) from the list of source paths.

9 Up Move selected source path(s) upward in the path list. It just affects the order of reversing, and have no impact on the
reversed UML classes.

10 Down Move selected source path(s) downward in the path list. It just affects the order of reversing, and have no impact on
the reversed UML classes.

11 Reverse source on By checking, this means to form indexes to the source path(s) instead of actually reversing them. For details about on
demand demand reverse engineering, refer to the section below.

12 Reverse package Analyze the sources and form package diagram when reverse. For details about reversing package diagram, refer to
diagram the section below.

13 OK Click to start reversing.

14 Cancel Click to cancel reversing and exit.

15 Help Click to read Help contents for instant reverse.

Description of instant reverse dialog box

On-demand reverse engineering

Consider if you have a zip file that contains million of Java source file, like the file src.zip of Java Development Kit (JDK), and now you want to make
the class java.util.Collection appear as UML class so that you can extend it when developing your own collection framework. Now, if you try to reverse
the zip file it will take you a long time to complete the reverse due to the amount of classes (and relationships) is just too many. With on-demand
reverse engineering, you will reverse the sources as indexes, and obtain an index tree in class repository. No actual UML classes will be reversed until
you trigger the reverse manually. This reduces the processing time significantly.

Reverse engineering of Java sources and classes P. 635

To perform on-demand reverse engineering, make sure the option Reverse source on demand is checked in the Instant Reverse dialog box.

The option Reverse source on demand

that appear in reverse dialog box

When finished instant reverse, you can lookup the index tree in class repository. Then, right click on the class you want to reverse and select Reverse
Resources to where Resources are the classes you have selected, and select either New Class Diagram or Class Repository from popup menu.
Both options will result in reversing the selection to UML classes, while the option New Class Diagram will create a class diagram and place the
classes in it.

Reversing a java source file from index tree

NOTE: On-demand reverse engineering is only available for Java

Forming class diagram from reversed classes

By the end of an instant reverse operation, you will be asked whether or not to form a class diagram with reversed UML classes. By selecting classes
and configuring the way to present them, and confirm, a diagram will then be form.

The Instant Reverse Form Diagram dialog box

Reverse engineering of Java sources and classes P. 636

NOTE: If you do not want VP-UML to ask you for forming diagram next time you perform instant reverse, uncheck Show this dialog after instant
reverse.

NOTE: The Form Diagram dialog box will only pop up when you were reversing source with on-demand turned off. If you have performed an on-
demand reverse engineering, you need to form diagram manually. For details, read the previous section.

Below is a description of this dialog, base on the tabs.

Select Class
The classes listing in the tree are those reversed from your code-base. You must select at least one class in order to form a class diagram. Notice that
forming diagram can be a costly operation if you have selected too many classes in forming diagram.

Form Diagram Options

Option Description

Show superclasses Show the generalization relationships between the selected elements and their super classes (ancestors) in the
new diagram.

Show subclasses Show the generalization relationships between the selected elements and their subclasses (descendants) in the
new diagram.

Show suppliers (interface) Show the realization relationships between the selected elements and their suppliers (interfaces) in the new
diagram.

Show clients Show the realization relationships between the selected elements and their clients (classes that implements
them) in the new diagram.

Show navigable classes Show the association relationships between the selected elements and their navigable classes (targets) in new
diagram.

Show non-navigable classes Show the association relationships between the selected elements and their non-navigable classes (sources) in
the new diagram.

Show containers Show the containment relationships between the selected elements and their containers (e.g. packages) in the
new diagram.

Show residents Show the containment relationships between the selected elements and their containers (e.g. packages) in the
new diagram.
Single level only - Show one level residents only in the new diagram.
All levels in single diagram - Show all level residents in the new diagram.
All levels in sub diagrams - Show all level residents in the new diagrams (multiple single level diagrams).

Show as containment relationships Show the containment relationships as connectors in the new diagram.
Notes: The containment relationships between classes are shown as connectors.

Description of form diagram options

Presentation Options

Option Description

Attribute options Show all - Show all attributes of classes in the new diagram.
Public only - Show all public attributes of classes only in the new diagram.
Hide all - Hide all attributes of classes in the new diagram.
Initial values - Show initial values of attributes of classes in the new diagram.

Operation Show all - Show all operations of classes in the new diagram.
options
Public only - Show all public operations of classes only in the new diagram.
Hide all - Hide all operations of classes in the new diagram.
Initial values - Show initial values of operations of classes in the new diagram.

Type options Fully-qualified - Show fully-qualified name of types.

Name only - Show name of types.
Relative - Show name of types relative to this class.

Description of presentation options

Reverse engineering of Java sources and classes P. 637

Reverse engineer package diagram from source files
By reverse engineering package diagram from source files, UML packages and the relationships in between will be produced.
1. Select Tools > Instant Reverse > Java ... from the main menu.
2. In the Instant Reverse dialog box, specify the path of the source file, or the folder that contain those files.

The instant reverse dialog

3. Check Reverse Package Diagram at the bottom of dialog box.

4. You can place reversed packages to specific model. To do this:
1. Click on the ... button at the end of the Reverse to Model row.
2. In the Select Parent Model dialog box, either select an existing model, or create one by clicking New Model.
3. Click OK to confirm.

5. Click OK to start reversing.

Reverse engineering of Java sources and classes P. 638

Instant reverse C++ header files
Instant reverse is a process to produce UML class model from a given input of source code. With instant reverse, you can reverse a snap shot of your
code-base to UML classes and form class diagram in further. By bringing code content into visual UML model, this helps programmers or software
engineers to review an implementation, identify potential bugs or deficiency and look for possible improvements. Apart from this, developers may
reverse a code library as UML classes, and construct model with them, like to reverse a generic collection framework and develop your own framework
by extending the generic one. In this chapter, we will go through the instant reverse of C++ header files.

Reverse engineering UML classes from source files

1. Select Tools > Instant Reverse > C++ Source ... from the main menu.

Perform instant reverse

Reverse engineering of C++ header files P. 639

2. In the Instant Reverse dialog box, specify the path of the source file, or the folder that contain those files. You can add multiple paths by clicking
the + button.

The Instant Reverse dialog

4. Click OK to start reversing.

5. Upon finishing, you will see the Instant Reverse Form Diagram dialog box appear. If you want to form a class diagram with the reversed
classes, select the classes to form diagram, configure the options and click OK to proceed. Read the next section for detail. If you do not want to
form diagram now, click Cancel to exit.

Overview of Instant Reverse

Reverse engineering of C++ header files P. 640

The instant reverse dialog box

No. Name Description

1 Language The language of source to reverse.

2 Update type Determine how to handle duplicated classes by selecting the Update Type. Below is a description of the update types:
Update duplicate class(es) - Update existing class(es) by source.
Replace duplicate class(es) - Discard existing class(es), overwrite by reversed source.

3 Path The path of source to reverse. You can click + to add multiple paths.

4 Exclude The paths to exclude when reverse. Click + to add a path to exclude, or click - to remove a chosen path.

5 Encoding The encoding of source file.

6 Reverse to model Place reversed classes to specific model. For example, to place legacy code to a model named Old, to place system
prototype to a model named Prototype and so forth.

7 Advanced options Click to configure any detailed options related to reverse in a new dialog box.

8 Reverse package Whether or not to reverse engineering package diagram from source files. UML packages and the relationships in
diagram between will be produced.

9 OK Click to start reversing.

10 Cancel Click to close instant reverse.

11 Help Click to read the Help contents.

Overview of instant reverse dialog box

Reverse engineering of C++ header files P. 641

Forming class diagram from reversed classes
By the end of an instant reverse operation, you will be asked whether or not to form a class diagram with reversed UML classes. By selecting classes
and configuring the way to present them, and confirm, a diagram will then be form.