Table of Contents

1. Introduction to Visual Paradigm for UML

1.1. About Visual Paradigm for UML

1.2. Editions

1.3. Features

1.4. Licensing

1.5. Software Maintenance

1.6. System Requirements

2. Installing Visual Paradigm for UML

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

2.2. Installing Visual Paradigm for UML on Mac OSX

2.3. Installing Visual Paradigm for UML on Linux

2.4. Switching edition

2.5. Uninstalling Visual Paradigm for UML

3. Getting started

3.1. Starting Visual Paradigm for UML

3.2. Interface Overview

4. User interface

4.1. Menu bar

4.2. Toolbar

4.3. Dockable User Interface

4.4. Diagram navigator

4.5. Model explorer

4.6. Class repository

4.7. Logical view

4.8. ORM pane

4.9. Property pane

4.10. Diagram overview

4.11. Documentation pane

4.12. Stencil pane

5. Working with Projects

5.1. Creating Project

5.2. Saving Project

5.3. Organizing diagrams by model explorer

5.4. Project dependency

5.5. Maintaining Backups

6. Key concepts

6.1. Model element and view

6.2. Master view and auxiliary view

Part II. Visual Modeling

1. Creating Diagrams

1.1. Creating Diagrams

1.2. Resource Centric Interface

1.3. Tagged Values

1.4. Spell Checking

2. Manipulating Diagrams

2.1. Automatic Diagram Layout

2.2. Fit Shape Size

2.3. Diagram Element Selection

2.4. Copy and paste

2.5. Alignment guide

2.6. Reverse connector direction

2.7. Visualize model element to diagram

2.8. Model commenting

2.9. Pinnable connector end

2.10. Align and distribute diagram elements

3. Drawing Annotations and Freehand Shapes

3.1. Annotate diagram elements with UML note shape

3.2. Annotate diagram element with callout shape

3.3. Drawing freehand shapes

4. Advanced Modeling Techniques

4.1. Sweeper and magnet

4.2. Mouse gestures

4.3. Jumping to shape

4.4. Grouping diagram elements

4.5. Show/hide diagram elements

4.6. Layer

4.7. Making shape non-selectable

4.8. Locking diagram

4.9. Showing model element in multiple diagrams (Context base modeling)

4.10. Using overview diagram

5. Resource Referencing

5.1. Reference to external resources

5.2. Reference to diagrams and shapes

5.3. Managing references

5.4. Elaborate model element with sub diagram

5.5. Showing sub diagrams and reference indicators

6. Style and Formatting

6.1. Changing diagram elements styles

6.2. Manage and apply styles

6.3. Setting line style

6.4. Setting line jumps options

6.5. Setting connector caption orientation

6.6. Format copier

7. Designing User Interface

7.1. Creating user interface diagram

7.2. Frame

7.3. Label

7.4. Text field

7.5. Scrollbar

7.6. Combo box

7.7. List

7.8. Table

7.9. Tree

7.10. Web Label

7.11. Web Button Input

7.12. Web Text Input

7.13. Web Combo Box

7.14. Web List

7.15. Web Password Input

7.16. Web File Input

7.17. Annotating the UI design with callout shape

8. Mind Mapping

8.1. Drawing mind mapping diagram

8.2. Formatting nodes

8.3. Linking nodes

8.4. Reference to resources

8.5. Relocating a branch

8.6. Layout nodes and diagram

9. Using Design Pattern

9.1. Defining design pattern

9.2. Applying design pattern

9.3. Synchronize design pattern with teamwork server

10. Model Element Nicknaming

10.1. What is nickname?

10.2. Configure nickname

10.3. Using nickname

10.4. Translation

11. Comparing Diagrams with Visual Diff

11.1. What is visual diff?

11.2. Comparing as-is and to-be business process diagram

11.3. Comparing logical and physical ERD

12. Animacian

12.1. What is animacian?

12.2. Animating business process diagram

12.3. Animating sequence diagram

12.4. Animating activity diagram

12.5. Export animation to Adobe Flash

13. Documenting Model Elements

13.1. RTF documentation

13.2. Voice documentation

14. Model transitor

14.1. Model transitor for shape

14.2. Model transitor for diagram

Part III. UML Modeling

1. Use Case Modeling

1.1. Drawing use case diagrams

1.2. Documenting use case details

1.3. Documenting flow of events

1.4. Elaborating use case

1.5. Managing actors with actors grid

1.6. Managing use cases with use cases grid

2. Requirement Modeling

2.1. Performing textual analysis

2.2. Drawing requirement diagrams

2.3. Defining your own set of requirement types

2.4. Drawing CRC card diagram

2.5. Managing requirements with requirements grid

3. Behavioral Modeling

3.1. Drawing activity diagrams

3.2. Drawing state machine diagrams

3.3. Drawing timing diagrams

4. Interaction Modeling

4.1. Drawing sequence diagrams

4.2. Drawing communication diagrams

4.3. Drawing interaction overview diagrams

5. Structure Modeling

5.1. Drawing class diagrams

5.2. Drawing object diagrams

5.3. Drawing package diagrams

5.4. Drawing composite structure diagrams

6. Deployment Modeling

6.1. Drawing component diagrams

6.2. Drawing deployment diagrams

7. Test Cases Modeling

7.1. Modeling and documenting test cases

Part IV. Business Modeling

1. Business Modeling

1.1. Drawing business process diagrams

1.2. Drawing data flow diagrams

1.3. Drawing event-driven process chain diagrams

1.4. Drawing process map diagram

1.5. Drawing organization charts

1.6. JPDL generation

2. Simulacian

2.1. What is simulacian?

2.2. Simulacian control panel

2.3. Simlauting business process

2.4. Simulacian charts

Part V. Database and ORM Modeling

1. Database Modeling

1.1. Entity Relationship Diagram(ERD)

1.2. Drawing sequence

1.3. Drawing stored procedures

1.4. Drawing triggers

1.5. Controlling primary key values using ID generator

1.6. Customizing ID generator

2. Generating Database

2.1. Database Configuration

2.2. Generating SQL for selected entities

2.3. Generating SQL for project

2.4. Generating alter statements

2.5. Export and import database configuration between projects

3. Reversing Database

3.1. Reversing database

3.2. Reversing DDL

4. Synchronization between ERD and Class Diagram

4.1. Generate class diagram from ERD

4.2. Synchronize from Class Diagram to ERD

4.3. Configure key naming pattern

5. Generating Object-Relational Mapping Code

5.1. Generating code and database

5.2. Lazy collection setting

5.3. Persistent API

5.4. Using generated code

Part VI. Stereotypes and Profile Management

1. Using Stereotypes

1.1. Apply Stereotype to Model Element

1.2. Configure stereotypes

1.3. Shortcut of creating stereotyped model element

2. UML profile management

2.1. Creating a profile

2.2. Drawing a profile diagram

Part VII. Team Collaboration

1. Team Collaboration with VP Teamwork Server

1.1. Introduction to team collaboration

1.2. The Teamwork Client

1.3. Checkout project

1.4. Commit

1.5. Update

1.6. Branching

1.7. Tagging

1.8. Revert (Roll back) changes

1.9. Export revision

2. Team Collaboration with Subversion

2.1. Working with teamwork client dialog box

2.2. Importing projects to Subversion

2.3. Checkout project from Subversion

2.4. Committing local modification to Subversion

2.5. Resolving conflicts

2.6. Updating latest revision from Subversion

2.7. Rolling back undesired changes by reverting changes

2.8. Browsing change histories (old revisions)

2.9. Isolating last long modifications with branches

2.10. Marking release or milestone with Tags

3. Team Collaboration with CVS

3.1. Working with teamwork client dialog box

3.2. Importing projects to CVS server

3.3. Checkout project from CVS server

3.4. Committing local modification to CVS server

3.5. Resolving conflicts

3.6. Updating latest revision from CVS server

3.7. Rolling back undesired changes by reverting changes

3.8. Browsing change histories (old revisions)

3.9. Isolating last long modifications with Branches

3.10. Marking release or milestone with tags

4. Team Collaboration with Perforce

4.1. Working with teamwork client dialog box

4.2. Importing projects to Perforce

4.3. Checkout project from Perforce

4.4. Committing local modification to Perforce

4.5. Resolving conflicts

4.6. Updating latest revision from Perforce

4.7. Rolling back undesired changes by reverting changes

4.8. Browsing change histories (old revisions)

4.9. Isolating last long modifications with branches

4.10. Marking release or milestone with tags

Part VIII. Documentation Publishing and Printing

1. Generating HTML/PDF/Word report

1.1. Generating report

1.2. Configuring report

2. Customizing report

2.1. Customizing report

2.2. Export/import report template

2.3. Diagram loop

2.4. Diagram summary

2.5. Element loop

2.6. Element summary

2.7. Custom content

2.8. Diagram Image

2.9. Property value

2.10. Page break

3. Publishing project to Web Site

3.1. Publish project using project publisher

3.2. Using the published contents

4. Report Writer

4.1. Installing report writer

4.2. Creating report

4.3. Introduction to report writer user interface

4.4. Constructing report

4.5. Updating report content

4.6. Export and import report

4.7. Customizing Report Writer Template

5. Printing Diagrams

5.1. Printing diagrams

5.2. Quick print

Part IX. Code Engineering

1. Instant Reverse

1.1. Reverse engineering of Java sources and classes

1.2. Reverse engineering of C++ header files

1.3. Reverse engineering of .NET dll and exec files

1.4. Reverse engineering of CORBA IDL source file

1.5. Reverse engineering of Ada 9x source files

1.6. Reverse engineering of XML

1.7. Reverse engineering of XML schema

1.8. Reverse engineering of Database through JDBC

1.9. Hibernate mapping file

1.10. Reverse engineering of PHP 5.0 source files

1.11. Reverse engineering of Python

1.12. Reverse engineering of Objective-C

2. Instant Generation

2.1. Instant Generator for Java

2.2. Instant generate for C# source code

2.3. Instant generate for VB.NET source code

2.4. Instant Generator for PHP source code

2.5. Instant Generator for ODL source code

2.6. Instant Generator for ActionScript source code

2.7. Instant Generator for IDL source code

2.8. Instant Generator for C++ source code

2.9. Instant Generator for Delphi source code

2.10. Instant Generator for Perl source code

2.11. Instant Generator for XML schema file

2.12. Instant Generator for Python source code

2.13. Instant Generator for Objective-C source code

2.14. Instant Generator for Objective-C 2.0 source code

2.15. Instant Generator for Ada95

2.16. Instant Generator for Ruby

2.17. Customizing code generation

3. Java Round-Trip

3.1. Generate or Update Java code from UML classes

3.2. Generate or update UML classes from Java code

4. C++ Round-trip

4.1. Generate or Update C++ code from UML classes

4.2. Generate or update UML classes from C++ code

5. State Machine Diagram Code Generation

5.1. Modeling guidelines

5.2. Generating state machine code

Part X. Interoperability

1. Export and Import XML

1.1. Exporting XML

1.2. Importing XML

2. Export and Import VP Project

2.1. Exporting VP project

2.2. Importing VP project

3. Export and Import Microsoft Excel

3.1. Exporting to Microsoft Excel

3.2. Importing Microsoft Excel file

3.3. Excel modification guidelines

4. Export and Import XMI

4.1. Exporting XMI

4.2. Importing XMI

5. Importing Visio Drawing

5.1. Importing Visio Drawing into VP-UML

6. Importing Rational Rose Model

6.1. Importing Rational Rose Model into VP-UML

7. Importing Rational Software Architect File

7.1. Importing Rational Software Architect EMX into VP-UML

7.2. Importing Rational Software Architect DNX into VP-UML

8. Importing Erwin Data Modeler Project File

8.1. Importing ERwin Data Modeler project file into VP-UML

9. Importing Telelogic Rhapsody and System Architect Project File

9.1. Importing Telelogic Rhapsody project

9.2. Importing Telelogic System Architect

10. Importing NetBeans 6.x UML Diagrams

10.1. Importing NetBeans 6.x UML diagrams into VP-UML

11. Exporting Diagram to Various Graphic Formats

11.1. Exporting active diagram as image

11.2. Exporting multiple diagrams as images

11.3. Exporting portion of diagram as image

Part XI. Impact Analysis

1. Introduction of Impact Analysis

1.1. Introduction of impact analysis

2. Analysis Diagram

2.1. Analyzing a model element

2.2. Updating analyzed result

2.3. Grouping of nodes

2.4. Opening view from node

3. Matrix Diagram

3.1. Creating a Matrix

3.2. Reading a matrix

Part XII. General

1. Using Shape Editor

1.1. Creating Shape in Shape Editor

1.2. Creating Shapes from Stencil Pane

2. Configure Environment Options

2.1. General Options

2.2. Diagramming options

2.3. View options

2.4. Instant reverse optons

2.5. ORM options

2.6. State code engine options

2.7. Office exchange options

2.8. User path options

2.9. Data type options

2.10. File type options

2.11. Code synchronization options

2.12. Spell checking options

2.13. Keys options

3. Automatic Update

3.1. Updating VP-UML with VP Suite update

3.2. Automatic update notification

4. Extend Functionalities with Open API

4.1. Introduction to plugin support

4.2. Implementing plugin

4.3. Deploying plugin

5. Command Line Operations

5.1. Exporting diagram image

5.2. Exporting and importing XMI

5.3. Exporting and importing XML

5.4. Generating ORM code and/or database

5.5. Generating report

5.6. Instant generator

5.7. Instant reverse

5.8. Java code synchronization

5.9. Project publisher

5.10. Updating teamwork project from server

5.11. Executing operations with Apache Ant

6. User Interface Customization

6.1. Hiding user interface components

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)

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
Click Next to proceed to the License agreement page.
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
Specify the directory for installing VP Suite. Click Next > to proceed to the next page.

The Select Destination Directory page
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
Select Visual Paradigm for UML. Click Next > to proceed to the product configuration page.

The product selection page
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

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

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

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

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)

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
Change directory to “VP Suite 4.0/bin” and execute VP Suite in it.

Launching VP Suite
Select Visual Paradigm for UML. Click Next > to proceed to the product configuration page.

The product selection page
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

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>

Pre-configure floating license server connection for floating license user

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

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.

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 “Not 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 (support-team@visual-paradigm.com) 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 (support-team@visual-paradigm.com) or the virus scanner vendor for assistance.

2. Installing Visual Paradigm for UML on Mac OSX

Table of Contents

4. Switching edition