Top Banner
VP-UML Quick Start Last Update: November 08, 2011 © Copyright 2002-2011 Visual Paradigm International Ltd.
38
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: Visual Paradigm

VP-UML

Quick Start

Last Update: November 08, 2011

© Copyright 2002-2011 Visual Paradigm International Ltd.

Page 2: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 2 of 38

Table of Contents

Table of Contents ........................................................................................................................................ 2

Getting Started ............................................................................................................................................ 3

Installing Visual Paradigm for UML (VP-UML) ...................................................................................................... 3 Starting Visual Paradigm for UML ........................................................................................................................... 5 Importing the License Key ........................................................................................................................................ 5 Selecting Workspace ................................................................................................................................................. 7 Environment .............................................................................................................................................................. 7 Saving and Opening Projects .................................................................................................................................... 8

Diagramming ............................................................................................................................................... 9

Creating Diagram ...................................................................................................................................................... 9 Creating Shapes ......................................................................................................................................................... 9 Connecting Shapes .................................................................................................................................................. 10 Documenting Model Elements ................................................................................................................................ 10 Formatting Shapes ................................................................................................................................................... 11 UML Modeling ....................................................................................................................................................... 13 Drawing Use Case Diagram .................................................................................................................................... 13 Documenting Use Case Details ............................................................................................................................... 13 Building Glossary .................................................................................................................................................... 14 Drawing Sequence Diagrams .................................................................................................................................. 16 Drawing an Activity Diagram ................................................................................................................................. 17 Drawing a Class Diagram ........................................................................................................................................ 18

Enterprise Architecture ............................................................................................................................ 19

Zachman Framework ............................................................................................................................................... 19 Business Motivation Model (BMM) ....................................................................................................................... 20 Business Decision Model ........................................................................................................................................ 21

Code Generation ....................................................................................................................................... 24

Java Round-Trip ...................................................................................................................................................... 24 C++ Round-Trip ...................................................................................................................................................... 24 Instant Generator ..................................................................................................................................................... 25 Instant Reverse ........................................................................................................................................................ 25 Instant Reverse Java Code to Sequence Diagram.................................................................................................... 25

Report Generation .................................................................................................................................... 26

Using Report Composer .......................................................................................................................................... 26 Project Publisher ..................................................................................................................................................... 27

Team Collaboration .................................................................................................................................. 29

Login to Server ........................................................................................................................................................ 29 Checkout and Open Project ..................................................................................................................................... 30 Commit Local Modification .................................................................................................................................... 31 Update Server Changes to Local ............................................................................................................................. 32 File Referencing with Teamwork Support .............................................................................................................. 33

Advanced Modeling .................................................................................................................................. 35

Using Nicknamer ..................................................................................................................................................... 35 Adding Referenced Project ..................................................................................................................................... 36 Impact Analysis with Matrix ................................................................................................................................... 38

Page 3: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 3 of 38

Getting Started

Installing Visual Paradigm for UML (VP-UML)

After you download Visual Paradigm for UML from our website, the next step is installing it. Simply follow the

instructions below.

1. Double-click the downloaded installer file, then click the Next button to go to the next page.

2. Read the License Agreement. Choose I accept the agreement after you finish reading the agreement and

fully understand and accept the terms. Click Next.

3. Select where you want to install VP Suite. Then click Next.

4. Select where you want to place the Start Menu folder, which determines where the program’s shortcut

appears on the Start menu. Click Next.

5. Select the file associations that you want to create.

6. Select the checkbox for Visual Paradigm for UML (VP-UML). Click Next.

Page 4: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 4 of 38

7. Enter the Product Configuration. Select the edition you’ve purchased or want to evaluate. Click Next.

8. Enter the Product License (optional). Click Next.

Note If you put the key and installer files in the same folder, it’ll automatically fill in the key address

for you in the file path. Wait a few seconds for installing and checking system environment.

9. Once the installation is completed, you can start it now by clicking Visual Paradigm for UML 8.3 and

then Finish. Or start it later by clicking Don’t start.

Page 5: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 5 of 38

Starting Visual Paradigm for UML

You can start Visual Paradigm for UML by selecting Start Menu > Visual Paradigm > Visual Paradigm for

UML 8.3 [Enterprise] Edition (or the edition you chose to install).

Importing the License Key

1. After you start VP-UML, you will be asked to provide a license key in the License Key Manager.

a) If you have purchased VP-UML, you should receive our notification (Email) with an activation code.

The same activation code can also be found from the license key listed in your customer account. Copy

the activation code.

Page 6: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 6 of 38

Click on Input activation code in the upper left corner. In the dialog box opened, paste in the code.

b) For evaluation, click either Try without key or Request key. Choosing Try without key provides a

10-day evaluation period without giving us your email account. For a slightly longer trial period, you

can select Request key requesting an evaluation key valid for up to 30 days. If you are our member

already, you will be asked to sign in after you click Request key. If you are not our member yet, you

need to first register as a member on the Internet by filling out a registration form. The key will be sent

to your email account automatically after you sign in.

Note If you are running the Community Edition, you can either try VP-UML for 1 hour without key,

or request a key that enables you to run permanently.

Page 7: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 7 of 38

Selecting Workspace

A workspace is a directory used to remember your own settings and preferences. You will be asked to select a

workspace every time you start VP-UML. If you would like to keep all application settings in one place, always start

with the same workspace. When you move to a new computer, just copy the workspace over to use the old settings

again. If you want to have a fresh working environment, start with a new workspace.

Environment

In the VP-UML environment, you will see areas such as the Menu bar, Toolbar, Diagram Navigator, Property pane,

Message Pane and Diagram Pane. The following table provides more details about each function.

Page 8: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 8 of 38

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 The toolbar is below the menu bar. It is an extension of the menu bar. All buttons are

presented in groups of icons which are readily accessible.

3 Diagram Navigator An area in which diagrams are listed and grouped by their type. You can access

existing diagrams as well as creating new ones here.

4 Properties Pane An area in which properties of the shape currently selected is displayed.

5 Message Pane An area displaying information or warnings from the system, if any.

6 Diagram Pane An area in which diagrams are displayed.

Saving and Opening Projects

To save your work, select either File > Save Project or File Save Project as…. When you save a file for the first

time, you can select where to save the project. It can be saved in the current workspace or another directory you

specify.

To open an existing project, select File > Open Project… from the main menu and select the project to open.

Page 9: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 9 of 38

Diagramming

After you familiarize yourself with the Visual Paradigm for UML environment, the next step would be to get to

know how to create a diagram. This chapter is going to show you not only how to create diagrams, but also how to

create and connect diagram elements (shapes), documents their details and format them. It will also provide a

general description of the nicknamer and layers feature.

Creating Diagram

To create a diagram (e.g. a use case diagram):

1. Right-click Use Case Diagram in the Diagram Navigator and select New Use Case Diagram from the

pop-up menu.

2. Name the new diagram Sales order system.

Creating Shapes

To create a shape in your diagram, select the shape type you want from the Diagram Toolbar. Click once on the

diagram to drop it at that location. You can resize it by dragging the black handles around it. Let’s continue with our

example.

1. Select Use Case from the Diagram Toolbar, click on the diagram and then drag the handles to resize.

Release the mouse to confirm creation.

2. Name the use case place order and press enter to confirm.

Page 10: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 10 of 38

Connecting Shapes

You can connect two shapes by making use of the resource icons surrounding a shape. Let’s say we want to

associate an actor with a use case. Place the mouse pointer over the actor for the resource icons to pop up. Click on

its Association resource icon and drag it to the use case, then release the mouse button.

Documenting Model Elements

You can enter a description for your shape in the Documentation Pane at the bottom left of the screen.

In addition to the form of text, you can also voice-record a description. Click the Record button at the bottom of the

Documentation Pane. In the Record Voice dialog box, click the red circle button to start recording and click the

button with a square inside to stop. To save your recording, click OK.

Note Make sure your recording device is available in order to use this feature.

Page 11: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 11 of 38

Formatting Shapes

You can format a shape based on your preference by right-clicking on it to select Styles and Formatting and then

Formats… from the pop-up menu. Let’s say you want to change the use case’s background color.

1. Right-click on the use case to select Styles and Formatting and then Formats… from the pop-up menu.

2. In the Formats dialog box, select a color such as green in the Background tab and click OK to confirm

the change. The use case will turn to green.

Take formatting the connector style as another example:

1. Right-click a connector and select Styles and Formatting and then Formats… from the pop-up menu.

Page 12: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 12 of 38

2. In the Formats dialog box, select blue as the line color and click OK to confirm. As a side note, the option

Weight is used to alter the thickness of the connector. The higher the value in Weight, the thicker the

connector will become.

Page 13: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 13 of 38

UML Modeling

Drawing Use Case Diagram

A use case diagram is designed to model the context of a system. In a use case diagram, all stakeholders and system

goals are identified to elaborate how the system is formed. The main elements of a use case diagram include use

case, actor and association (communication link).

The following simple use case diagram illustrates the basic requirements of enrolling in an overseas university. The

actor Student represents the role of the student while apply for student visa online, take a physical examination and

pay tuition fee are three things (goals) that the student would need to achieve. You can create actor Student from the

Diagram Toolbar, and the three use cases from the resource icon Association -> Use Case from the actor.

Documenting Use Case Details [Professional Edition or above]

Apart from naming a use case, you can also document its details. Right-click on a use case, such as Book Sport

Facility and select Open Use Case Details…. Open the Info tab and fill in the Rank, which indicates the

importance of this use case.

In the Flow of Events, you can tell others what needs to be done in order to attain the use case’s goal. Select the

Flow of Events tab and enter the step-by-step procedure. Below is the procedure of booking sports facility online.

First, Login; second, Select a sports facility and finally, Click [Confirm]. The first step is further broken down to

three sub-steps: Fill in the name, Fill in the password and Click [OK]. Press Tab to add a sub-step after a step. Enter

them one by one in the flow of events editor as shown below.

Page 14: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 14 of 38

You can insert an extension for a step to perform in different scenarios. For example, you can insert an extension for

Login. As the login system is for members only, non-memebers are redirected to another page instead of the login

page. To insert an extension for Login, click Login and then select the Extension menu (or press Shift-Enter). After

that, start editing the extension.

Building Glossary

A glossary is a place where domain-specific vocabularies are stored and managed. And you can build a glossary by

identifying terms from a flow of events.

1. Suppose online system homepage is a key phrase in a step of a flow of events. Select it in the flow of events,

right-click to select Add “online system homepage” to Glossary from the pop-up menu to extract it as a

term.

2. This opens a glossary with the term online system homepage added. Right-click on the term to select Open

Term Editor from the pop-up menu.

Page 15: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 15 of 38

3. Specify its alias. In the Term Editor, click Add and enter official site for the first alias. Repeat to add an

alias main page. Enter the term’s definition in the Definition section below.

Note Move your mouse pointer to the underlined term online system homepage in the Flow of Events,

the documentation of the term will appear automatically.

Page 16: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 16 of 38

Drawing Sequence Diagrams

A sequence diagram is used primarily to show interactions between objects that are represented as lifelines in a

sequential order. More importantly, lifelines show all of their interaction points with other objects in events. A

sequence diagram can be created by right-clicking Sequence Diagram in the Diagram Navigator and then

selecting New Sequence Diagram from the pop-up menu. Alternatively, you can create a sequence diagram as a

sub-diagram of a use case. Let’s see how that works.

1. Move the mouse pointer over the use case apply for student visa online. Click on the tiny resource icon at

the bottom right and select Add > Sequence Diagram from the popup menu.

2. The actor Student is created for you automatically. We will now create a lifeline with an interaction from

actor Student. Drag the actor’s resource icon Message -> LifeLine to where you want to place the new

lifeline. . Name the new lifeline online system and enter personal details for the message between them.

3. Repeat the same steps to create another lifeline database from online system.

Page 17: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 17 of 38

Drawing an Activity Diagram

An activity diagram is essentially a flowchart, showing flow of control from one activity to another. Unlike a

traditional flowchart, it can model the dynamic aspects of a system because it involves modeling the sequential steps

in a computational process. A new activity diagram can be created by right-clicking Activity Diagram in the

Diagram Navigator and selecting New Activity Diagram.

Taking using an ATM as an example:

1. Select Initial Node from the Diagram Toolbar and drag it onto the Diagram Pane.

2. Press the initial node’s resource icon Control Flow -> Action and drag it to the target position to create an

action.

3. Name the action insert card.

4. Terminate the activity by creating a final node via the resource icon Control Flow -> Activity Final Node

of the final action.

5. You can use a swimlane to group actions by participant. Select Horizontal Swimlane from the Diagram

Toolbar and drag it onto the diagram to create one. Double-click the head of the partitions and name them

user and ATM system, respectively. You can then move shapes into the appropriate partitions.

Page 18: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 18 of 38

Drawing a Class Diagram

A class diagram shows the blueprints of objects required by a system and the relationships between them. A new

class diagram can be created by right clicking on Class Diagram in the Diagram Navigator and then selecting New

Class Diagram from the pop-up menu. Taking bank account as an example:

1. Select Class from the Diagram Toolbar and drag it onto the diagram.

2. Name the class bank account. To create an attribute, right-click the class and select Add > Attribute from

the pop-up menu. You can create as many attributes as you need by pressing enter after adding a new entry.

In the bank account class, create two attributes -- name and balance, respectively.

3. Similarly, operations can be created by right clicking the class and selecting Add > Operation from the

pop-up menu. Create two operations, debit and credit, respectively.

4. Generalization is needed when you want to show the subclass from the super class. Move the mouse over

the super class, select its resource icon Generalization -> Class and then drag it to your preferred place.

5. Create two subclasses and name them saving account and term deposit account. Add attributes and

operations accordingly. The completed class diagram should look something like this.

A class can be associated with through the use of the resource centric interface. Move the mouse over the class

student. Press its resource icon Association -> Class and drag it to another class school.

To edit an association, double-click on it to open the Association Editor. In it, enter a name for the role of the

association in the middle text box and adjust properties like multiplicity and navigability as needed.

Page 19: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 19 of 38

Enterprise Architecture

There are tools that can help you define an enterprise by modeling the vision, goals and missions of business

activities.

Zachman Framework [Enterprise Edition]

Zachman Framework is basically a matrix which consists of six fundamental questions (What, how, where, who,

when, why) as columns with six different perspectives of a business as rows. It lets you define and view an

enterprise from a structured and systematic way. We will now look at how to create a Zachman Framework.

1. Select Enterprise on the toolbar and select Zachman Framework from the drop-down menu.

2. Click on a cell to edit.

3. You can add diagrams, terms and define business rules in this cell by clicking on the corresponding links.

You can also add a sub-level of Zachman Framework. To do that, click on the arrow button.

4. In the Sub-Level dialog box, select New Zachman framework. Click OK to continue.

5. From the sub-level Zachman framework, you can go back to the parent level by clicking the navigation link

at the top.

Page 20: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 20 of 38

Business Motivation Model (BMM) [Enterprise Edition]

A BMM diagram is used to identify, capture and design an organization’s motivation, vision, mission and strategy

visually. To create a BMM diagram:

1. Select Enterprise on the toolbar and select Business Motivation Model Diagram from the drop-down

menu.

2. Select Means from the Diagram Toolbar.

3. In the diagram click and drag your mouse pointer to form a rectangle. Release the mouse button and enter

Means for the name.

4. Select Mission from the Diagram Toolbar. Click inside the Mission shape to create a mission. Enter

Provide pizza to customers city-wide.

5. Use similar steps above to complete the diagram as shown below.

Page 21: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 21 of 38

Business Decision Model [Enterprise Edition]

Decision modeling is a technique that helps you capture and document business decisions by means of decision

model. For example, if you are a shop owner, you may want to define rules that control discounts given to

customers. With business decision model, you can document various discounts that salespersons can offer under

different conditions such as discount for VIPs and sales volume discount in a neat manner. To construct a decision

model:

1. Select Business on the toolbar and select Decision Model Diagram from the drop-down menu.

2. Name the diagram Determine Sales Discounts, which is designed to find out how to calculate sales

discounts.

3. Press Enter to confirm the diagram name. The business decision shape (in orange) is created for you

automatically. For the rule family shape (in yellow), name it Sales Discount Policy.

A rule family contains a set of rules, each form with a number of conditions and come up with one

conclusion. In this case, we may define a rule that says when the customer is a VIP, he/she gets a 10%

discount. If the total sales amount is over $1000, we offer a 40% discount. You can imagine that there are

many possible combinations of rules with different outcomes. It is the rule family’s responsibility to

manage all these rules. We will enter the rules in the panel at the bottom of the diagram later. Now, let’s

focus on the diagram first.

4. Customer type (VIP or not?), items discounts and total amount are what we called conditions. Different

conditions lead to different conclusions, i.e. the discount to offer in this case. There are two kinds of

conditions - atomic and non-atomic. Atomic conditions refer to those that cannot be divided. Non-atomic

conditions are those determined by some other conditions. Sales discount is an example of non-atomic

condition as it is determined by conditions like whether the item is a new arrival or an off-season one. To

model non-atomic condition, move the mouse pointer over the rule family Sales Discount Policy. Press its

resource icon New Child Rule Family and drag downwards.

5. Release the mouse button and name the new rule family Item Discount Policy.

6. We can add atomic conditions directly to the rule family. Right click on Sales Discount Policy and select

Add Condition from the popup menu. Name the condition Membership Type.

7. Add another condition to Sales Discount Policy: Total Amount.

Page 22: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 22 of 38

8. Add two conditions to Item Discount Policy: New Arrival, Off-Season Item.

9. Now, we can fill in the rules. Let’s focus on the Item Discount Policy first. Click on it.

10. The Rule Family Table panel at the bottom of the diagram lets you enter the rules within the rule family.

Click on the Add Rule button.

11. Enter 1 for the rule pattern.

12. If the item is neither newly arrived nor off-season, there will be no discount. Keep the conditions New

Arrival and Off-Season Item non-filled. Double click on the first cell in the Conclusion column and enter

No Discount as Operator, 0% off as Result.

13. Add another rule. Enter 2 for the rule pattern.

14. If the item is newly arrived, grant 10% discount. Double click on the first cell in the New Arrival column

and enter Is as Operator, Yes as Result. Double click on the first cell in the Conclusion column and enter

Normal Discount as Operator, 10% off as Result.

15. Add another rule. Enter 3 for the rule pattern. If the item is an off-season item, give a 40% discount. Try to

document this.

16. Let’s enter rules for the rule family Sales Discount Policy. Select it.

17. Create a rule in the Rule Family Table, with 1 as the rule pattern. Click on the first cell in the Item

Discount Policy column. You can select a conclusion defined in the sub-condition Item Discount Policy.

Page 23: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 23 of 38

Select No Discount, 0% off.

18. Double click on the first cell in the Membership Type column and enter No Discount as Operator, 0% off

as Result. Double click on the first cell in the Conclusion column and enter = as Operator, 0% off as

Result.

19. Enter the other rules. Here are all the rules:

Sub-Conditions Conditions Conclusion

Rule

Pattern

Item Discount Policy Membership Type Total Amount Sales Discount Policy

1 No Discount 0% off Not Member 0% off = 0% off

2 No Discount 0% off Not Member 0% off > $500 5% off = 5% off

2 No Discount 0% off Not Member 0% off > $1000 10% off = 10% off

2 Normal Discount 10% off Not Member 0% off > $500 5% off = 14.5% off

2 Normal Discount 10% off Not Member 0% off > $1000 10% off = 19% off

1 No Discount 0% off Normal Member 10% off = 10% off

1 Normal Discount 10% off Normal Member 10% off = 19% off

1 Big Sale 40% off Normal Member 10% off = 41% off

2 No Discount 0% off Normal Member 10% off > $500 5% off = 14.5% off

2 Normal Discount 10% off Normal Member 10% off > $500 5% off = 23% off

2 Big Sale 40% off Normal Member 10% off > $500 5% off = 49% off

2 No Discount 0% off Normal Member 10% off > $1000 10% off = 23% off

2 Normal Discount 10% off Normal Member 10% off > $1000 10% off = 27% off

2 Big Sale 40% off Normal Member 10% off > $1000 10% off = 51% off

2 Normal Discount 10% off VIP 25% off > $500 5% off = 36% off

2 Normal Discount 10% off VIP 25% off > $1000 10% off = 40% off

Page 24: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 24 of 38

Code Generation

Code generation is the process by which code generator generates source codes from UML class models. Instead of

starting from scratch, you can jump to edit the generated codes for necessary additions or changes. It helps cut down

the time needed to build your application.

Java Round-Trip [Professional Edition or above]

Round-trip engineering enables you to keep class model and source code in-sync. With Java round-trip, you can

reverse a code-base to VP-UML as class model, analyze, and make changes such as adding missing classes, and then

updating the changes to code, or vice versa.

To generate Java source code from class model, select Tools > Code Engineering > Java Round-trip >

Generate Code… from the main menu. Enter the output path in the Generate code dialog box and click OK to

generate.

To reverse a class model from code, select Tools > Code Engineering > Java Round-trip > Reverse

Code… from the main menu. The Reverse Code dialog box will pop up asking you to select a source file path.

Click OK to reverse.

C++ Round-Trip [Professional Edition or above]

To generate C++ for the whole project, click Tools > Code Engineering > C++ Round-trip > Generate

Code… from the main menu. The Generate Code dialog box will pop up asking you to select a path, click the

+ button to add a path. After selecting one, click OK to generate.

To reverse class model from code, select Tools > Code Engineering > C++ Round-trip > Reverse

Code… from the main menu. Select a source file path in the Reverse Code dialog box and click OK to reverse.

Page 25: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 25 of 38

Instant Generator [Standard Edition or above]

Instant generator produces source code from your model at a particular instant. Unlike the code generation support

in round-trip engineering, instant generator is a one-off. To generate code, select Tools > Code Engineering >

Instant Generator from the main menu, then select the programming language in which to generate.

Instant Reverse [Standard Edition or above]

Instant Reverse allows you to reverse different types of source into UML class models, such as Java source, Java

classes, C++ source etc. To reverse, select Tools > Code Engineering > Instant Reverse from the main menu, then

select the appropriate programming language. Select the source files and proceed.

Instant Reverse Java Code to Sequence Diagram [Professional Edition or above]

Sequence diagram can help represent interactions between objects in runtime. VP- UML enables you to reverse your

Java source code to sequence diagram. You can gain a better understanding of a piece of Java source code by

reading its corresponding diagram, instead of looking at possibly a thousand lines of code. To reverse Java code to

sequence diagram, select Tools > Code Engineering > Instant Reverse > Java to Sequence Diagram… from the

main menu. Add the folder that contains the source code, continue and select the source file. Finally, visualize the

code in a new diagram.

Page 26: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 26 of 38

Report Generation

Using Report Composer [Standard Edition or above]

You can develop professionally designed documentation using report composer. Apart from the diagram-based

report generation function, you can customize a report by adding elements to the report manually.

1. Open a use case diagram. Create one if you do not have one already.

2. Right-click in any white space in the diagram and select Utilities > Generate Use Case Report from the

popup menu. This produces a new report diagram.

3. Select another diagram in the Diagram Navigator.

4. Drag it onto the report composer.

The result should look something like this.

Page 27: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 27 of 38

5. Click on the Export button at the top right and select Word Report….

6. In the Export Word Report window, fill in the output path and click Export to produce a Word report

from Report Composer.

Project Publisher [Standard Edition or above]

1. You can publish your report to a website by selecting Tools > Project Publisher… from the main menu.

2. Enter the output path in the Project Publisher dialog box and click OK to publish.

3. It publishes the project, and opens the published content in a web browser. You should see four tabs:

Diagram Navigator, Model Explorer, Class Repository and Logical View on the left and your diagram on

the right. Click any diagram link on the left and the diagram will appear on the right.

Page 28: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 28 of 38

4. You can click on a shape in the image to go to its property details page.

Page 29: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 29 of 38

Team Collaboration

[Modeler Edition]

Your team can work together on the same project effectively through the teamwork collaboration feature. VP-UML

supports the integration with version control systems such as SVN, CVS, Perforce and Teamwork Server. In this

section, we will cover basic setup of Teamwork Server, where SVN, CVS and Perforce users can skip, and basic

teamwork operations with Teamwork Server. The techniques we will talk about here can also be applied to the

integration with SVN, CVS and Perforce.

Login to Server

You can start working by logging into the Teamwork Client in VP-UML, followed by managing, checking out and

opening the project. Manage Project means telling the client products that you are involved in a particular project.

1. In VP-UML, select Teamwork > Open Teamwork Client... from the main menu.

2. In the Login dialog box, enter 127.0.0.1 for server host, john for name and the password (what’s defined in

the previous section). Click OK.

3. In the Manage Project dialog box, select My Project and click > to manage it. Click OK to proceed.

Page 30: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 30 of 38

Checkout and Open Project

Checkout Project is for downloading a managed project from the server to your computer. Open Project is for

opening the downloaded project in VP-UML.

1. In the Teamwork Client dialog box, click Checkout at the bottom right corner of the dialog box.

2. Click Open Project.

Page 31: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 31 of 38

Commit Local Modification

Commit Local Modification refers to the process of uploading local modifications to the server. Create a simple

use case diagram as shown below.

1. Select Teamwork > Commit... from the main menu to commit your changes to the server.

2. The Commit dialog box displays the changes to be committed to the server. Click OK to proceed.

Page 32: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 32 of 38

Update Server Changes to Local

Update Server Changes to Local refers to the process of getting or downloading changes others have committed to

the server.

1. Ask another team member to start VP-UML on his/her computer.

2. Follow the steps listed in the Login to Server section to login to the server as user peter.

3. Checkout and open project My Project.

4. Open the only use case diagram, and rename the use case.

5. Follow the steps as described in the Commit section to commit the changes to the server.

6. Now, go back to john's environment.

7. Select Teamwork > Update... from the main menu.

8. The Update dialog box displays the changes to be updated from the server. Select Diagram > Use Case

Diagram1 : UseCaseDiagram > Buy Goods : Use Case. Click Compare. This is to have a look at the

changes before updating it. If the change is not desired, you may click Cancel to abort the process. Click

the OK button.

9. Check the use case. Its name should now be Buy Goods.

Page 33: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 33 of 38

File Referencing with Teamwork Support

When modeling, there may be external resources you want to attach to a model which help describe it in detail or

include data that cannot be modeled, like a text document. You can do this by adding file references to models. If

you are working in a team-based environment with Teamwork Server, you do not need to copy any referenced files

for other team members to open. Instead, you could commit your model along with the referenced files to the server.

1. Open the Teamwork Files pane in the panes group at the bottom left of the user interface.

2. Drag a file to the Teamwork Files pane.

3. Click OK when you are asked to confirm putting the file to workspace. You must click OK here. If not, the

file won't be added as a teamwork file nor committed to server.

4. Select Tools > Application Options from the main menu.

5. In the Application Options window, select User Path on the left hand side.

6. On the right hand side, click Add... and select Project Files Path from the popup menu. Click OK at the

bottom of the Options window to close it.

7. Move the mouse pointer over the use case Buy Goods to show the resource icons.

8. Click on the References resource icon at the bottom left of the requirement shape and select Add File...

from the popup menu.

Page 34: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 34 of 38

9. In the Use Case Specification window, click on the button ... next to the Path field.

10. Click on the shortcut Project Files Folder. Note that if you have not completed step 4 to 6, you will not see

this shortcut.

11. Select the teamwork file and click Open at the bottom right to choose it.

12. Click OK in Use Case Specification to return to the diagram.

13. Commit the changes to server. Note that the commit action will bring along the teamwork file(s) to server.

You may check it in the Commit window.

Page 35: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 35 of 38

Advanced Modeling

Using Nicknamer [Standard Edition or above]

Nicknamer is a feature which helps you to present a model with labels in different languages. This is particularly

useful to multinational corporations where there’s often a need in presenting a model in multiple languages for

different regions. As localization is created on the fly when requested, there is no need to keep various versions for

different languages. That means you only need to modify changes once only. By default, it is set in English. You can

add a new nickname, for example, Traditional Chinese.

1. Select View > Nicknames > Configure Nicknames… from the main menu.

2. In the Configure Nickname dialog box, click Add User Language and select Chinese (Traditional) in

the Add User Language dialog box and then click OK. Finally, click OK to go back to the diagram and

start working with the Chinese version of the model.

Note To reset the nickname back to English, select View > Nicknames > Original from the main

menu.

Page 36: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 36 of 38

Adding Referenced Project [Standard Edition or above]

To avoid creating the same things (e.g. a class) over and over again, it would be useful to have a generic library to

keep components for reuse. When you make any changes to the components in the library, those changes will ripple

down to where the components are actually used. In VP-UML, we call this generic library a “Reference Project”.

1. Right-click in any white space in the Model Explorer and select Manage Referenced Project… from the

pop-up menu.

2. When the Manage Referenced Projects dialog box pops up, click the Add button to select the reference

project(s) from your computer.

3. After adding the reference project(s), click the Close button in the Manage Referenced Projects window.

4. The referenced project(s) will be shown in the combo box in the Model Explorer. You can switch between

your working project and the referenced project(s) in this combo box.

Page 37: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 37 of 38

5. You can drag a model from a referenced project onto your diagram and connect it with your current project.

For example, you can drag the Administrator class onto the diagram as shown below.

6. The list of referenced models can be found by selecting List Referenced Model Element/Shape in the

combo box.

7. In the Diagram Navigator, scroll to the bottom. Expand the referenced project tree node and double-click

on a diagram (that you want to know more about) to open it. You can read the referenced project’s design

this way.

The benefit of using referenced model is to prevent your working project from becoming oversized as the

information of referenced model will not be stored. However, since the referenced model is read-only from its

source project, you cannot create a child to it. To deal with this problem, you can make use of Create Mirror

Model Element. The mirrored model element is also read-only on its properties, however, you can add a child

model to it.

Page 38: Visual Paradigm

Visual Paradigm for UML Quick Start

Page 38 of 38

Impact Analysis with Matrix [Professional Edition or above]

If you were to make a change to some model elements, it would be important to know which other elements will get

affected because of it. The Impact Analysis feature can help you with that. There are two options, Matrix and

Analysis Diagram, to choose from, depending on the scope of the analysis you need. Matrix (diagram) is a tool that

helps you identify the relationship between model elements of specific type(s), so as to study the consequence of

making certain changes. Let’s say we have two class diagrams:

To study the relationships between the classes:

1. In the Diagram Navigator, right click on Matrix Diagram (in the group Impact Analysis) and select

New Matrix Diagram from the pop-up menu.

2. In the matrix configuration page, specify a model element type to be the row and column items of the

matrix, respectively. In this case, select class for both row and column.

3. We want to see the relationships (e.g. association, dependency, etc.) between classes. Therefore, select

Relationship for By (By here means to compare row and column items by the selected criterion)

4. Click OK. This produces a chart which lists the classes in rows and columns, showing their relationships in

cells.