Académique Documents
Professionnel Documents
Culture Documents
P. 1
P. 2
1201
1205
1208
1215
1220
1223
1226
1229
1232
1235
1239
1242
1244
1252
1267
1283
1297
1298
1307
1320
1322
1324
1326
1328
1330
1332
1334
1336
1338
1339
1340
1364
1366
1371
1373
1375
1380
1385
1386
1387
1392
1427
P. 3
Editions
A summary of editions and their supported features.
Licensing
Visual Paradigm need to run with a key. This page shows you how to import different kinds of key into Visual Paradigm.
Software maintenance
Describes what software maintenance provides and tell you why you need it.
System requirements
A description of hardward requirements.
P. 4
BPMN, CORBA and UML are trademarks of the Object Management Group
C#, C++, MS SQL Server, Microsoft Windows, Microsoft Visio, VB.NET and Visual Studio are trademarks of Microsoft Corporation.
Cloudscape, DB2, Informix and Rhapsody are trademarks of International Business Machines Corporation.
Sybase ASE are Sybase SQL Anywhere are trademarks of Sybase Inc.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Trademark Disclaimer
P. 5
Class diagram
Sequence diagram
Communication diagram
Activity diagram
Component diagram
Deployment diagram
Package diagram
Object diagram
Timing 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:
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:
Organization Chart
Object-Relational mapping
Object-Relational Mapping enables you to access relational database in an object relational approach when coding. Visual Paradigm generates objectrelational 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:
VPository
Documentation generation
Share your design with your customers in popular document formats, including:
Microsoft Word
P. 6
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
P. 7
Editions
Belows are the kinds of features that can be found in each edition of Visual Paradigm. For details, please visit: http://www.visual-paradigm.com/
editions
Enterprise
Professional
Standard
Modeler
Community
UML Modeling
Requirement Diagram
SoaML Modeling
Glossary Grid
Mind Mapping
Visual Diff
Design Animation
Collaborative Modeling
Impact Analysis
Doc. Composer
The filled circle indicates the support of certain feature in certain edition
A summary of features supported by Visual Paradigm
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Full comparison of Visual Paradigm editions, from community edition to enterprise edition
Overview of Visual Paradigm enterprise edition, with features and strength listed
Overview of Visual Paradigm professional edition, with features and strength listed
Overview of Visual Paradigm standard edition, with features and strength listed
Overview of Visual Paradigm modeler edition, with features and strength listed
Editions
P. 8
Overview of Visual Paradigm community edition, with features and strength listed
Editions
P. 9
Licensing
Visual Paradigm needs to run with a valid license key. The various licensing options listed in this page vary in price and functionality.
Various licensing options
Single seat license
Visual Paradigm's single-seat (team-member-based) license allows one 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.
Edition
Unit price
Enterprise
$1399.00
$1678.50
Professional
$699.00
$838.50
Standard
$299.00
$358.50
Modeler
$99.00
$118.50
Community
Not applicable
Viewer
Free
Not applicable
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.
Edition
Unit price
Enterprise
$1818.50
$2182.00
Professional
$908.50
$1090.00
Standard
$388.50
$466.00
Modeler
$128.50
$154.00
Community
Not applicable
Not applicable
Viewer
Not applicable
Not applicable
Enterprise
$69.00
Professional
$35.00
Standard
$15.00
Modeler
$5.00
Community
Not applicable
Viewer
Not applicable
Price of subscription licenses (Prices are provided in US dollars)
Academic license
Academic licenses are available for higher education, with the aim of providing site licenses for the teaching of software engineering. Educational
institutions that join the Academic Partners Program are entitled to licenses for the Visual Paradigm Enterprise Edition, 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. 10
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Buy Visual Paradigm, the UML modeling software online in Visual Paradigm online store
Use Visual Paradigm for educational purposes. Join Visual Paradigm Academic Partner Program (VPAPP)
Wanna know more about how floating license can help you share license between users? Visit this page
Can you switch to another edition after purchase? Yes, you can. See how to do
Keep Visual Paradigm updated. Know more about Visual Paradigm's product maintenance policy
Licensing
P. 11
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
Typically, Visual Paradigm produces two to three versions per year, with approximately five to ten major new features and enhancements per version.
You are entitled to install any new versions of Visual Paradigm product that are released within your 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/
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 deliver 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.
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 builtin 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.
Price
Software maintenance is purchased on an annual basis (e.g., Aug 20, 2014 to Aug 19, 2015).
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
Enterprise
$279.50
$419.50
Professional
$139.50
$209.50
Standard
$59.50
$89.50
Modeler
$19.50
$29.50
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
Prices are provided in US dollar
Edition
1 Year Maintenance
1 Year Maintenance
Enterprise
$363.50
$545.50
Professional
$181.50
$272.50
Standard
$77.50
$116.50
Software maintenance
P. 12
Modeler
$25.50
$38.50
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
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Buy Visual Paradigm, the UML CASE Tool online in Visual Paradigm online store
Use Visual Paradigm for educational purposes. Join Visual Paradigm Academic Partner Program (VPAPP) for FREE
Can you switch to another edition after purchase? Yes, you can. See how to do
Software maintenance
P. 13
System requirements
Hardware requirements
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Download the community edition of Visual Paradigm - simply free for non-commercial use
System requirements
P. 14
P. 15
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.
Specify the directory for installing Visual Paradigm. 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) checked if you want your system able to open the project file upon direct
execution (i.e. double click). Click Next to start the file copying process.
7.
Upon finishing, you can select whether to start Visual Paradigm or not. Keep Visual Paradigm selected and click Finish will run Visual
Paradigm right away.
Windows 2000/NT/2003/XP/Vista/7/8
P. 16
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Download the community edition of Visual Paradigm - simply free for non-commercial use
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Have difficulties when installing Visual Paradigm? Contact us. We will help you out
Windows 2000/NT/2003/XP/Vista/7/8
P. 17
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.
Specify the directory for installing Visual Paradigm. Click Next to proceed to the next page.
5.
In the File Association page, keep Visual Paradigm Project (*.vpp) checked if you want your system able to open the project file upon direct
execution (i.e. double click). Click Next to start the file copying process.
6.
Upon finishing, you can select whether to start Visual Paradigm or not. Keep Visual Paradigm selected and click Finish will run Visual
Paradigm right away.
Mac OSX
P. 18
Download the community edition of Visual Paradigm - simply free for non-commercial use
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Have difficulties when installing Visual Paradigm? Contact us. We will help you out
Mac OSX
P. 19
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.
Specify the directory for installing Visual Paradigm. Click Next to proceed to the next page.
5.
Select a folder for creating symlinks. You may uncheck Create symlinks if you do not want to. Click Next to the start file copying process.
6.
Upon finishing, you can select whether to start Visual Paradigm or not. Keep Visual Paradigm selected and click Finish will run Visual
Paradigm right away.
P. 20
Installation FAQ
Question: What is the difference between Installer and InstallFree 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 InstallFree 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 in %HOME-DIR%\visualparadigm\
(e.g. C:\Users\Peter\visualparadigm\vp.log).
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 to 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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Download the community edition of Visual Paradigm - simply free for non-commercial use
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Have difficulties when installing Visual Paradigm? Contact us. We will help you out
P. 21
P. 22
If you want to evaluate Visual Paradigm, click this. You will then be asked to select the edition of product to evaluate. Visual Paradigm features vary by
product editions. For more details on the features supported by different editions, check the Edition Comparison page. Click on the Evaluate button to
confirm your edition selection. Then, you can start your 30 days evaluation.
If you have purchased a perpetual license and you want to activate Visual Paradigm with it, click this.
If you hold a single seat license, enter your activation code, your name and email address and click Activate. You can obtain the code by visiting
your customer account at our Customer Service Center . Alternatively, the licensee should have received our Email notification with activation code
included. Note that you can activate Visual Paradigm on both your desktop computer and laptop, provided that you are the only user and at most one
instance is started at a time.
If you use a floating license, expand the Floating License section, enter the connection settings of the host machine where the license is installed and
click Apply.
If you use a site license, expand the Site License section, enter your activation code, your name and email address and click Activate. Note that the
email address has to be under the organizational email domain entered when purchasing.
Subscription License
If you have subscribed to run Visual Paradigm on a time basis or if you are our academic partner , click this. Enter the login details of your customer
account and click Sign in to continue.
For academic partners, enter the activation code and click Activate. Note that Internet connection is required for license verification.
P. 23
Offline activation
When you try to activate Visual Paradigm without an active Internet connection, you will be prompted for offline activation. You will see a window with
a URL in it. To activate Visual Paradigm, copy the URL, pass the URL to a machine that can access the Internet. Visit the URL to obtain a key code.
Pass the key code back to the machine that requires activation. Paste the code at the bottom part of the popup window and click OK to finish the
activation process.
Starting Visual Paradigm (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 Visual Paradigm with a startup script in order to connect to the
server. Here are the steps:
1.
Copy Visual Paradigm.bat under the scripts folder of Visual Paradigm installation directory to become Startup.bat
2.
Edit Startup.bat
3.
Save
5.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Learn more about floating license - how to import, export, return a floating license
P. 24
2.
3.
4.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Full comparison of Visual Paradigm editions, from community edition to enterprise edition
Overview of Visual Paradigm enterprise edition, with features and strength listed
Overview of Visual Paradigm professional edition, with features and strength listed
Overview of Visual Paradigm standard edition, with features and strength listed
Overview of Visual Paradigm modeler edition, with features and strength listed
Overview of Visual Paradigm community edition, with features and strength listed
Can you switch to another edition after purchase? Yes, you can. See how to do
P. 25
Deleting license
You can allow activating Visual Paradigm on both your desktop computer and laptop, provided that you are the only user and at most one instance
is started at a time. The maximum allowable installations are three. If you want to de-activate a license, you have to go through the "Delete License"
process. By deleting a license, your license will be removed from your machine, meaning that you will not be able to run Visual Paradigm until a valid
license is provided again. To delete a license:
1.
Open the License Manager by selecting Windows > License Manager... from the toolbar.
2.
3.
Click Yes when you are prompted for confirmation. Visual Paradigm will then be exited.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Learn more about floating license - how to import, export, return a floating license
Deleting License
P. 26
3.
5.
6.
P. 27
8.
9.
Click OK to confirm. Visual Paradigm will be activated if the verification code is valid.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Learn more about floating license - how to import, export, return a floating license
P. 28
P. 29
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 30
User interface
This chapter walks through the various panes and components in user interface.
Interface overview
A summary of the user interface you can see when Visual Paradigm is started.
Main menu
The main menu enables you to access most of the core functions in Visual Paradigm.
Toolbar
The toolbar is a by default horizontal bar below the main menu bar which covers most of the core functions in Visual Paradigm.
Diagram navigator
Diagram navigator is a pane that lets you access and create diagrams.
Model explorer
Model explorer is a pane that lets you access and create models, and browse for their specifications.
Class repository
Class repository is a pane that lets you access and create classes, and browse for their specifications.
Logical view
Logical view is a pane that lets you organize diagrams with user-named views.
ORM pane
ORM pane serves two distinct purposes - to convert domain source code into UML persistable class model, and to convert database schema into entity
models.
Property pane
Property pane is a pane that lets you read and edit chosen element(s) 's properties.
Diagram overview
Diagram overview is a thumbnail of diagram which enables you to navigate and zoom into a diagram.
Documentation pane
Documentation pane is a pane that lets you read and edit documentation of chosen element.
Stencil pane
Stencil pane is a pane that list stencil, and lets you drag out a shape to diagram.
Diagram specification
Diagram specification enables you to adjust some of the diagram settings
Perspective
Perspective define way to position panes.
User interface
P. 31
Interface overview
Visual Paradigm 's user interface comprises a toolbar, a diagram editor and a status bar.
Name
Description
Toolbar
A tabbed toolbar that allows you to perform various operations in Visual Paradigm.
Diagram editor
Message pane
Notifications are shown here. You can also open the message pane and description pane from the bottom right of the status
bar.
Description of user interface
Related Resources
The following resources may help to you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Interface Overview
P. 32
Open - Open an existing project file either by selecting one from file chooser or from the list of recent opened project
Print - Open the Print tool to configure the printing and print
Properties - Edit the basic project properties like name, author and description
UeXceler - Open the UeXceler tool, which provides the necessary toolset for requirements management with the use of use case and user story
Format - Open the Format tool for configuring the formatting properties of the selected (shapes). These properties include the color and line
style of shape/connector.
Format Copier - Click once to copy the format of the select shape so that you can apply the format to another shape by clicking on that shape.
Double click to lock Format Copier so that you can paste the formatting to multiple shapes
Alignment - Align the selected shapes based on their top, bottom, left or right, or to set their width and/or height to be the same
Link - Toggle the Link box for you to paste a model element URL there and then visit the URL
Jump - Instantly open a model element or diagram by providing its name, or part of its name
Bookmarks - Bookmark a shape for quick accessing, or to manage the previously added bookmarks
Project Browser - Opens the Project Browser for browsing and accessing the diagrams, model elements and model structure of the opening
project.
Panes - Several panes are available for accessing different kinds of project data. For instance, the Model Explorer can be used to view model
hierarchy, while the Diagram Navigator can be used to find diagrams in ease. You can open a pane here.
Layers - Create multiple diagram layers to better categorize the different kinds of shapes
Toolbar
P. 33
Styles - Define the style. Each style carries a set of formatting properties. You can assign a style to a shape to apply those properties to that
shape
Zoom 100% - Restore the zoom ratio to 100%, which means, no zooming
Grid - Show, hide and configure the appearance of grid lines on diagram
Spell Checker - Enable or disable the spell checking feature, which is capable in verifying the correctness of shape names and descriptions and
when a problem found, underline it with a red line
Full Screen - Maximize the diagram editor by collapsing the toolbar and hiding the opened panes, if any
Model Indicator - Show a small icon on shape body for each these situations: that shape has description filled, has a sub-diagram, has
references, is an auxiliary view or is came from a referenced project
Login - Login to a version controlling system like VPository and Teamwork Server
Update - Grab the modifications made by your teammates from server to local
Teamwork Files - Togger the Teamwork Files pane for accessing the files that are kept with this project
Visual History - Check out and restore the old revisions of diagrams with the Visual History tool
Utilities - Perform operations like branching, tagging, exporting a specific revision, etc
Code - Generate code from class diagram, reverse engineer UML from code. A number of programming languages are supported
Requirement List - Open a list of SysML requirements elements. You can view, edit and create requirements there
Animation - Animate the active diagram. Only available when opening an Activity Diagram, Sequence Diagram or Business Process Diagram
Simulation - Open the Simulation panel when the active diagram is a Business Process Diagram
Nickname - The nickname feature allows you to define multiple name and description set for your model. You can configure and switch between
nicknames here
Glossary - Define project vocabularies with the use of the Glossary tool
Toolbar
P. 34
Auto-Hide Toolbar - Make the toolbar automatically collapsed when you are editing diagram
Configuration - Configure stereotypes, requirements, project management look-ups, user story tags, etc
Integration - Install the integration with IDEs such as Eclipse, NetBeans, IntelliJ IDEA and Visual Studio
Mouse Gestures - Check out the various kinds of supported mouse gesture
Online Support - Visit the Visual Paradigm Support page online to submit your support request
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Toolbar
P. 35
Diagram editor
Diagram editor is where you can view and edit your diagram. In this page you will learn how to operate with the diagram editor.
Overview of diagram editor
Name
Description
Navigation bar
Navigation bar consists of two parts. The left hand side contains a breadcrumb that shows the diagram name and
the location of the diagram. The right hand side contains two buttons. One for switching to another diagram, another
for opening the Project Browser.
Package header
The name of the package where the diagram resides. Package header is available only in some of the diagrams, but
not all. You can double click on it to edit it. By entering the name of another package, the diagram will be moved to
that package accordingly. You can click here to learn more about package header.
Diagram toolbar
The diagram toolbar provides you with the tools that you need to draw a diagram. Two kinds of tools can be found in
the toolbar:
Diagramming utilities like the pan tool, sweeper and magnet tool.
Diagram -specific tools like actor in Use Case Diagram, BPMN pool in Business Process Diagram. For details
about how to create a diagram with the toolbar, click here.
Diagram
Action bar
Click to toggle the action bar that provides you with access to the tools based on your selection. For instance, if you
have selected a Business Process Diagram, you can access tools like Working Procedure, Animation. If you have
selected a use case, you can access tools like Use Case Details.
Description of diagram editor
The breadcrumb
The breadcrumb displays both the name and location of the opening diagram. Location means the place where the diagram resides within the model
hierarchy. For example, if diagram "Bar" is put under model "Foo", you will see the breadcrumb structure Foo > Bar, where Foo is the name of the
model and Bar is the name of the opening diagram. Similarly, if the diagram is placed in a model and that model is placed inside another model, you
will see the breadcrumb structure ${name-of-grandparent} > ${name-of-parent} > ${name-of-diagram}.
The segments of a breadcrumb is clickable. You can click directly on the name in a segment to open up the corresponding shape, model or model
element.
A breadcrumb that shows the diagram name (i.e. System Overview) and the package where it resides (i.e. com.vp.demo.ims)
Using link
You may want to draw your teammates' attention to a specific diagram to discuss it. Instead of asking your teammates to read diagram "XYZ", you can
simply share the link of that diagram with them.
A link is a unique address of an element in a project. It is a general element accessing mechanism available in Visual Paradigm. You can share a link
with teammate, so to let him/her to locate a diagram, a shape or a model element quickly and accurately.
Diagram editor
P. 36
You can obtain the link of the opening diagram from the breadcrumb. Next to the diagram name in the breadcrumb, there is a link icon. Click on it.
Once you are given a link, no matter it's a diagram link, model element link or shape link, you can open the link in the diagram breadcrumb. Next to the
diagram name in the breadcrumb, there is a link icon. Click on it.
Open a link
Diagram overview
Diagram Overview is a pane where you can view and zoom in the opening diagram directly and quickly. You can open it only when the diagram size
exceeds the viewing region. When that happens, you will see a button appear at the bottom right corner of the diagram. You can click on it to open the
Diagram Overview.
Diagram editor
P. 37
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 in Diagram Overview which represents the visible area of
diagram in diagram overview.
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.
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Diagram editor
P. 38
Description Pane
Description 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, font color, etc.
Opening and closing the Description Pane
Description Pane can be opened by clicking on Description button at the bottom right corner of the status bar. To close it, either click the same button
again or press the X button at the top right corner of the Description Pane.
Description Pane
Button
Name
Bold
Description
Alignments
Set the alignment of highlighted text to the left, the center or the right.
Ordered list
Font
Table:
Add a table.
Background color
Clear Formats
Clear formats of the whole editor to convert the content to plain text.
Add
Template
Find
Record
Description pane
P. 39
Manage: Add or remove audio clips. You may also link to an external audio file.
Description of Description Pane
NOTE:
The formatting toolbar is by default hidden for description pane shown in specification window. In order to show the formatting toolbar,
simply click on the editor.
Floating mode
The Description Pane has a fixed position and size by default, which means that you cannot move it nor to resize it. However, you can change it to
Floating mode so that the Description Pane can be moved and resized. You can even move it out of the application window.
To change the Description Pane to Floating mode, click Float in the title bar of the Description Pane. Or you can simply drag the title bar of the
pane to change it to Floating mode.
In Select Model Element window, select an existing model element on the list. If you want to modify the selected model element, you can click
Open Specification... button.
4.
Consequently, the name of inserted model element will be shown on the description 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 window 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.
Description pane
P. 40
Voice description
In addition to textual description for your model elements, you can record voice description or embbed audio files.
Recording voice
1.
2.
In the Record Voice window, click the Record button to start recording.
Start recording
NOTE:
3.
Click the Stop button when you want to end the recording.
NOTE:
4.
Make sure your audio input device is active before operate voice description.
Play the recorded voice by pressing the Play button; record again by pressing the Clear button and rerun the previous steps.
Enter the name for recorded voice clip in the text field of Name.
1.
In the Manage Voice window, click the Add button, and choose either Embedded or Link to File.
Description pane
P. 41
If you choose Embedded, record a voice clip when the Record Voice window pops out; if you choose Link to File, select an audio file when the
Open dialog box pops out.
4.
5.
You can also select an added audio clip and click Delete to remove it.
6.
Highlight the word or the lexis you would like to be defined and then right click on it. Select Add "[highlighted term]" to Glossary from the popup menu to switch to Glossary Grid.
In Glossary Grid, click Open Term Editor from the pop-up menu in order to fill more details about the new item. Alternatively, right click on the
term and select Open Term Editor from the pop-up menu.
In Term Editor page, click Add button to type the alias(es) for the new item.
Further information about the new item can be given by typing in the space under Definition.
Description pane
P. 42
Spell checking
When you type an incorrect word carelessly, Description Pane can offer you a help.
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.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Description pane
P. 43
Message Pane
The Message Pane appears at the bottom of the application window. It reports events that occur when using Visual Paradigm. Here are some cases in
which you will receive a message:
Refactoring failed
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Message pane
P. 44
Project Browser
The Project Browser provides you with different perpectives in viewing your opening project. With Project Browser, you can view and open the
diagrams in your project, browse model structure, check and open the recently modified diagram, etc.
Opening the Project Browser
There are two ways you can take to open the Project Browser:
Click on the Open Project Browser on the right hand side of the navigation bar of any diagram
Diagrams view
The Diagrams view enables you to browse the diagrams in the opening project. Diagrams are grouped by the categories they belong to. You can scroll
up and down to view the thumbnails of diagrams.
if you want to locate a diagram with its name, or part of its name, enter the search text in the Search field. The Diagrams view will be updated to list
only the diagrams that match with your search string. Note that you can use *, the wildcard character in filtering.
Project Browser
P. 45
By moving your mouse pointer over the forward and backward button, you can view the remaining diagrams of a diagram category, if any.
My Recent
My Recent lists the diagrams you opened recently, except the one currently opened. You can open a diagram by double clicking on its thumbnail.
Project Browser
P. 46
Team Recent
Team Recent lists the diagrams recently modified and committed by the team. You can open a diagram by double clicking on its thumbnail.
Searching
The search feature allows you to find model elements, views and diagrams quickly. You can perform a searching by entering the search string in the
Search field and then press Enter. When finished searching, search result will be displayed in Project Browser and you can open a diagram by
double clicking on its thumnail or view a model element's specification by double clicking on it directly.
Project Browser
P. 47
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Project Browser
P. 48
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 toolbar
Name
Icon
Description
Collapse
Expand
Refresh
Pop-up menu
Pop-up menu of logical view
Description
Teamwork
Refresh
Logical view
P. 49
Collapse All
Expand All
Description
Rename...
Add View
New Diagram
Set the current view structure as default so that another project that will be created under the
same workspace will share the same structure.
Teamwork
Collapse All
Expand All
Logical view
P. 50
Menu Title
Description
Add View
New Diagram
Collapse
Expand
Rename...
Delete
Logical view
P. 51
Logical view
P. 52
NOTE:
The sort function applies to the entire logical view instead of the selected node.
Logical view
P. 53
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.
2.
Select Teamwork and the action you want to perform from the pop-up menu.
Logical view
P. 54
Perform teamwork
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Logical view
P. 55
Creating project
This page shows you how to create a new project in Visual Paradigm.
Saving project
This page shows you how to save a project.
Project dependency
Establishing dependency between projects for model sharing.
Maintaining backups
Backup files will be saved from time to time. This page tells you more about backup, and how to retrieve works from backup files.
Project template
Project template enables you to specify the diagram to create by default when creating a new project.
Switch to diagram
You can open another diagram by double clicking on a tree node in Diagram Navigator. An alternative way is to open the Switch to Diagram dialog box,
select diagram and click Activate Selected Diagram.
P. 56
Creating project
Visual Paradigm 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 Project > New from the toolbar. The New Project window appears.
Name
Description
Name
Author
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.
Description
The project description. You can make use of the toolbar on top of the description pane to add
formatted content.
Check it to automatically fill the project management lookups such as iteration, version, etc with
default lookup values.
Cancel
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Creating Project
P. 57
Saving project
Visual Paradigm saves all project content to a single file, with file extension .vpp.
To save your work, select either Project > Save or Project > Save as... When you are saving a project for the first time, you will be asked to specify its
location. If you have connected to VPository/VP Teamwork Server, you can directly import your project to the server now. Otherwise, you can save the
file to a local directory.
Save Project
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Saving Project
P. 58
Select View > Project Browser from the toolbar to open the Project Browser.
2.
Creating model
To create a Model, right-click on the project node in Model Structure view 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.
NOTE:
When you draw a shape, its model element will be put under the same model as diagram.
P. 59
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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 60
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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Maintaining Backups
P. 61
Open Project Properties dialog box by selecting Project > Properties... from the toolbar.
2.
Enter project name, author, company and project description. Click OK button to confirm and close the dialog box. Note that you can enter
formatted text for project description.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 62
Switch Diagram
After you've opened a few diagrams, you can switch to your target diagram easily with the feature of Switch Diagram. Moreover, you can close
diagram(s) with this feature as well.
1.
After you've opened a few diagrams, Click the Switch Diagram button on the right of the diagram pane.
2.
Select a diagram
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Switch to Diagram
P. 63
P. 64
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
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 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
P. 65
NOTE:
Create a package
Drag the mouse to create a package surrounding those use cases.
P. 66
After selected, an extra slash will be shown on the left edge of the use case.
Business Model
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
P. 67
P. 68
Use
Case
Association
Actor
System
Include
Extend
Dependency
Generalization
Realization
Collaboration
List of UML notations available in UML use case diagram
Use Case
What is a use case in UML? According to the OMG Unified Modeling Language (OMG UML) specification (UML Superstructure Specification version
2.4.1, page 606), use case is:
A use case is the specification of a set of actions performed by a system, which yields an observable result that is typically of value for one or more
actors or other stakeholders of the system.
Association
P. 69
UML association
Actor and use case can be associated to indicate that the actor participates in that use case. Therefore, an association correspond to a sequence of
actions between the actor and use case in achieving the use case.
OMG UML Specification
What is an association in UML? According to the OMG Unified Modeling Language (OMG UML) specification (UML Superstructure Specification
version 2.4.1, page 36), association is:
An association describes a set of tuples whose values refer to typed instances. An instance of an association is called a link. A link is a tuple with one
value for each end of the association, where each value is an instance of the type of the end.
...
An association specifies a semantic relationship that can occur between typed instances. It has at least two ends represented by properties, each of
which is connected to the type of the end. More than one end of the association may have the same type.
An end property of an association that is owned by an end class or that is a navigable owned end of the association indicates that the association is
navigable from the opposite ends; otherwise, the association is not navigable from the opposite ends.
Actor
UML actor
Actors are the entities that interact with a system. Although in most cases, actors are used to represent the users of system, actors can actually be
anything that needs to exchange information with the system. So, an actor may be people, computer hardware, other systems, etc.
Note that actor represents a role that a user can play but not a specific user. So, in a hospital information system, you may have doctor and patient as
actors but not Dr. John, Mrs. Brown as actors.
OMG UML Specification
What is an actor in UML? According to the OMG Unified Modeling Language (OMG UML) specification (UML Superstructure Specification version
2.4.1), actor is:
An actor specifies a role played by a user or any other system that interacts with the subject. (The term "role" is used informally here and does not
necessarily imply the technical definition of that term found elsewhere in this specification.)
...
An Actor models a type of role played by an entity that interacts with the subject (e.g., by exchanging signals and data) but which is external to the
subject (i.e. in the sense that an instance of an actor is not a part of the instance of its corresponding subject). Actors may represent roles played by
human users, external hardware, or other subjects. Note that an actor does not necessarily represent a specific physical entity but merely a particular
facet (i.e."role") of some entity that is relevant to the specification of its associated use cases. Thus, a single physical instance may play the role of
several different actors and conversely, a given actor may be played by multiple different instances.
System
UML system
The scope of a system can be represented by a system (shape), or sometimes known as a system boundary. The use cases of the system are placed
inside the system shape, while the actor who interact with the system are put outside the system. The use cases in the system make up the total
requirements of the system.
OMG UML Specification
What is a system in UML? According to the OMG Unified Modeling Language (OMG UML) specification (UML Superstructure Specification version
2.4.1, page 608), system is:
If a subject (or system boundary) is displayed, the use case ellipse is visually located inside the system boundary rectangle. Note that this does not
necessarily mean that the subject classifier owns the contained use cases, but merely that the use case applies to that classifier.
P. 70
Include
UML include
An include relationship specifies how the behavior for the inclusion use case is inserted into the behavior defined for the base use case.
OMG UML Specification
What is an include in UML? According to the OMG Unified Modeling Language (OMG UML) specification (UML Superstructure Specification version
2.4.1, page 604), include is:
An include relationship defines that a use case contains the behavior defined in another use case.
Extend
UML extend
An extend relationship specifies how the behavior of the extension use case can be inserted into the behavior defined for the base use case.
OMG UML Specification
What is an extend in UML? According to the OMG Unified Modeling Language (OMG UML) specification (UML Superstructure Specification version
2.4.1, page 601), extend is:
A relationship from an extending use case to an extended use case that specifies how and when the behavior defined in the extending use case can be
inserted into the behavior defined in the extended use case.
...
This relationship specifies that the behavior of a use case may be extended by the behavior of another (usually supplementary) use case. The
extension takes place at one or more specific extension points defined in the extended use case. Note, however, that the extended use case is
defined independently of the extending use case and is meaningful independently of the extending use case. On the other hand, the extending use
case typically defines behavior that may not necessarily be meaningful by itself. Instead, the extending use case defines a set of modular behavior
increments that augment an execution of the extended use case under specific conditions.
Note that the same extending use case can extend more than one use case. Furthermore, an extending use case may itself be extended.
Dependency
UML dependency
A dependency relationship represents that a model element relies on another model element for specification and/or implementation.
OMG UML Specification
What is a dependency in UML? According to the OMG Unified Modeling Language (OMG UML) specification (UML Superstructure Specification
version 2.4.1, page 61), dependency is:
A dependency is a relationship that signifies that a single or a set of model elements requires other model elements for their specification or
implementation. This means that the complete semantics of the depending elements is either semantically or structurally dependent on the definition of
the supplier element(s).
Generalization
UML generalization
A generalization relationship is used to represent inheritance relationship between model elements of same type. The more specific model element
share the same specification with. the more general the model element but carries more details in extra.
OMG UML Specification
What is a generalization in UML? According to the OMG Unified Modeling Language (OMG UML) specification (UML Superstructure Specification
version 2.4.1, page 70), generalization is:
P. 71
A generalization is a taxonomic relationship between a more general classifier and a more specific classifier. Each instance of the specific classifier is
also an indirect instance of the general classifier. Thus, the specific classifier inherits the features of the more general classifier.
Realization
UML realization
A realization is a relationship between a specification and its implementation.
OMG UML Specification
What is a realization in UML? According to the OMG Unified Modeling Language (OMG UML) specification (UML Superstructure Specification version
2.4.1, page 131), realization is:
Realization is a specialized abstraction relationship between two sets of model elements, one representing a specification (the supplier) and the
other represents an implementation of the latter (the client). Realization can be used to model stepwise refinement, optimizations, transformations,
templates, model synthesis, framework composition, etc.
Collaboration
UML collaboration
OMG UML Specification
What is a collaboration in UML? According to the OMG Unified Modeling Language (OMG UML) specification (UML Superstructure Specification
version 2.4.1, page 174), collaboration is:
A collaboration describes a structure of collaborating elements (roles), each performing a specialized function, which collectively accomplish some
desired functionality. Its primary purpose is to explain how a system works and, therefore, it typically only incorporates those aspects of reality that are
deemed relevant to the explanation. Thus, details, such as the identity or precise class of the actual participating instances are suppressed.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
P. 72
P. 73
Entering details
Details are predefined and detailed fields of a use case, which includes level, complexity, status, implementation status, preconditions and postconditions, author and assumptions. Select an option for Level, Complexity, Use Case Status and Implementation Status from the drop-down
menu.
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
which support multiple line are allowed to add requirement links.
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 narrowed 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.
P. 74
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.
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 which 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.
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 subdiagram. On the other hand, select Add Existing Diagrams... if you want to add an existing diagram in your current project.
P. 75
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.
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.
P. 76
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 77
Class diagram
A class diagram models the classes of a system/application going to develop. In this chapter, you will learn how to create class diagram.
Class diagram
P. 78
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
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
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.
P. 79
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
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.
P. 80
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 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 reord a class member, select it and drag within the compartment, you will see a thick black line appears to indicate where the class member will be
placed.
P. 81
Selecting Dependency
2.
P. 82
4.
Release the mouse button to create the connector. While it looks like the connector is connecting the classes but not the members, if you check
its specification you can see that the connector is indeed connecting the members.
Relationship created
To create an enumeration, select Enumeration from the diagram toolbar and click on the diagram to create one.
Create an enumeration
To add an enumeration literal, right click on the enumeration class and select Add > Enumeration Literal from the popup menu.
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.
P. 83
Adjust connector
Repeat the steps for other generalizations.
P. 84
This applies to new classes that will be created in a project opened in specific workspace. To change the setting:
1.
Select Windows > Project Options from the toolbar to open the Options dialog box.
2.
3.
4.
5.
Change the settings for Show attribute option and/or Show operation option.
Per diagram
2.
Select Presentation Options > Attribute Display Options / Operation Display Options from the pop-up menu.
3.
P. 85
Per class
2.
Select Presentation Options > Attributes / Operations from the popup menu.
3.
Instead of showing or hiding all members or public members, you may show/hide specific class member per class. To do this:
1.
2.
Select Presentation Options > Attributes / Operations > Customized... from the pop-up menu.
P. 86
Open the specification dialog box of attribute by right clicking on the attribute and selecting Open Specification... from the popup menu.
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.
P. 87
NOTE:
3.
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).
Click OK to confirm.
Right click on the association (where the subset end exist) and select Open Specification... from the popup menu.
P. 88
2.
In the General tab, locate the association end where you want to define a subset. Click on ... for the Role property of the association end.
3.
In the Association End Specification, open the Subsetted Association Ends tab.
4.
From the list on the left hand side, click on the role you want to define subset for. Click > to select it. If you do not see any role listing there, make
sure your model respect the pattern similar to the class diagram above - The class of both association ends are subclasses, and there is an
association connecting their superclasses.
5.
6.
7.
Right click on the association end and select Presentation Options > Show Association End Property Strings from the popup menu to show
the subset.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 89
Sequence diagram
A sequence diagram is used primarily to show the interactions between objects that are represented as lifelines in a sequential order. In this chapter,
you will learn how to draw a sequence diagram.
Sequence diagram
P. 90
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
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.
P. 91
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.
P. 92
Sweep downwards
You can also use magnet to pull shapes together. To use magnet, click the Selector on the toolbar, then select Magnet.
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.
The picture below shows when drag the magnet upwards, shapes below dragged position are pulled upwards.
P. 93
P. 94
Move the mouse over the combined fragment and select Add/Remove Covered Lifeline... from the pop-up menu.
In the Add/Remove Covered Lifelines dialog box, check the lifeline(s) you want to cover or uncheck the lifeline(s) you don't want to cover.
Click OK button.
P. 95
Managing Operands
After you've created a combined fragment on the messages, you can also add or remove operand(s).
1.
Move the mouse over the combined fragment and select Operand > Manage Operands... from the pop-up menu.
Manage operands
2.
To remove an operand, select the target operand from Operands and click Remove button. Click OK button.
Remove Operand
Otherwise, click Add button to add a new operand and then name it. Click OK button.
P. 96
There are two panes, Lifelines and Messages. The Lifelines pane enables you to create different kinds of actors and lifelines.
Shortcut
Description
Alt-Shift-A
To create an actor
Alt-Shift-L
Alt-Shift-E
Alt-Shift-C
Alt-Shift-B
Alt-Shift-O
Ctrl-Del
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.
Shortcut
Description
Alt-Shift-M
Alt-Shift-D
Alt-Shift-C
Alt-Shift-S
P. 97
Alt-Shift-R
Alt-Shift-F
Alt-Shift-L
Alt-Shift-E
Ctrl-Shift-Up
Ctrl-Shift-Down
Ctrl-R
Alt-Shift-O
Ctrl-Del
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
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.
Right click on the diagram's background, select Sequence Number and then either Single Level or Nested Level from the pop-up menu.
P. 98
Single level
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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 99
Communication diagram
Communication diagram was designed for presenting the interactions between objects (i.e. lifelines). You will learn how to create communication
diagram in this chapter.
Communication diagram
P. 100
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
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 link (the line) and a message (the arrow).
P. 101
Reorder messages
When the Communication Diagram Specification window 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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 102
P. 103
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
P. 104
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 105
Activity diagram
Activity diagram is a flowchart-based diagram showing flow of control from activity to activity. It shows concurrency, branch, control flow and object
flow. You will learn how to create activity diagram in this chapter.
Activity diagram
P. 106
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
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
Partition inserted
P. 107
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
Similarly you can create a new action using the Control Flow -> Action resource of an action.
Action created
Continue to complete the activity diagram.
P. 108
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.
3.
P. 109
NOTE:
4.
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.
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.
Click on the arrow beside the Generate button and select the type of diagram of the scenario.
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.
P. 110
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 111
Component diagram
Component diagram shows the physical aspect of an object-oriented software system. You will learn how to create component diagram in this chapter.
Component diagram
P. 112
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
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 > Edit Stereotypes... from the pop-up menu.
Assign stereotypes
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.
P. 113
Edit stereotypes
Click Add... button in the Configure Stereotypes dialog box.
Add stereotype
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.
P. 114
Stereotypes assigned
P. 115
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
You can add attributes to a component. To show/hide the attributes for all components in a diagram:
1.
2.
Select Presentation Options > Component Display Options from the popup menu.
3.
Per component
You can add attributes to a component. To show/hide the attributes for a specific component:
1.
2.
Select Presentation Options > Show Attributes Mode from the popup menu.
3.
Select Follow Diagram/Show All/Hide All/Customized... from the popup menu. If you have selected the Customized option, you can select
the specific attribute(s) to be shown or hidden.
You can add operations to a component. To show/hide the operations for all components in a diagram:
1.
2.
Select Presentation Options > Component Display Options from the popup menu.
3.
P. 116
Per component
You can add operations to a component. To show/hide the operations for a specific component:
1.
2.
Select Presentation Options > Show Operations Mode from the popup menu.
3.
Select Follow Diagram/Show All/Hide All/Customized... from the popup menu. If you have selected the Customized option, you can select
the specific operation(s) to be shown or hidden.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 117
Deployment diagram
Deployment diagram shows the physical aspects of an object-oriented system. You will learn how to create a deployment diagram in this chapter.
Deployment diagram
P. 118
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Creating node
To create node, click Node on the diagram toolbar and then click on the diagram.
Node selected
To specify classifiers for an instance specification, right-click it and select Select Classifier > Select Classifier... from the pop-up menu.
Select classifier
When the Instance Specification Specification dialog box pops out, the Classifiers tab is opened by default. Click Add.... Then, select the
classifier(s) in the popup window and click OK.
Select node
Click OK button to close the specification dialog box. The selected classifiers are assigned to the instance specification.
P. 119
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
Instance of component
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
P. 120
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 121
Package diagram
Package diagram shows the arrangement and organization of model elements in middle to large scale project. You will learn how to create package
diagram in this chapter.
Package diagram
P. 122
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
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 > Edit 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.
If the stereotype you want to use is not on the list, click Edit Stereotypes... button.
P. 123
Edit stereotypes
Click Add... button in the Configure Stereotypes dialog box.
Add stereotype
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.
P. 124
Stereotypes assigned
Continue to complete the diagram.
Completed diagram
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 125
Object diagram
Object diagram shows a snapshot of instances of things in class diagram. You will learn how to create an object diagram in this chapter.
Object diagram
P. 126
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Selecting classifiers
Right-click on the desired instance specification shape and select Select Classifier > Select Classifier... from the pop-up menu.
2.
3.
In the Select Classifier window, select the class(es) to be the classifier of the instance specification. If you are referencing another project, you
can select its model element to be the classifier. Just change the from project selection at the top of the window.
Selecting classifier
4.
5.
Classifier selected
Defining slots
Right-click on the desired instance specification shape and select Slots. .. from the pop-up menu.
2.
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.
P. 127
Defining slot
3.
Edit values
4.
The Slot Specification window pops out, the Values tab is opened by default. Click Add button and select Text from the pop-up menu.
P. 128
6.
Click OK again in the Instance Specification Specification window to return to the diagram.
Creating link
To create link between instance specifications:
1.
2.
Press on the Link -> Instance Specification resource and hold the mouse button.
Create a link
3.
Drag to the target instance specification and release the mouse button.
Link created
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 129
P. 130
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
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
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.
P. 131
Select type
Click OK button to apply the changes. Type will be shown on the caption of the 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
Continue to complete the diagram.
Completed diagram
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
P. 132
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 133
Timing diagram
Timing diagram shows time, event, space and signal for real-time and distributed system. You will learn how to create timing diagram in this chapter.
Timing diagram
P. 134
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
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
Add lifeline
P. 135
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.
P. 136
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.
Edit frame
In the Edit Frame dialog box, open the Time Messages tab and click Add... button.
P. 137
Time message
To set the duration constraints of a lifeline, right-click on the lifeline and select Edit Lifeline... from the pop-up menu.
Edit lifeline
2.
In the Duration Constraints tab, click on the Add... button. In the Add Duration Constraint dialog box, select the appropriate Start time and
End time from the drop down menu. Fill in the duration constraint of the selected time on the Constraint field. Click on the OK button to close
the dialog box.
P. 138
P. 139
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 140
P. 141
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Generic resource
Drag it to your preferred place and then release the mouse button. Select Control Flow -> Decision Node from the pop-up menu.
P. 142
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.
P. 143
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.
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).
Sequence diagram
When you return to the interaction overview diagram, you can see the interaction shows the thumbnail of the sequence diagram.
P. 144
P. 145
Completed diagram
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 146
Requirement diagram
Requirement diagram lets you visualize system functions as well as the ways to test the functions. This chapter teaches you how to work with
requirement diagram.
Requirement diagram
P. 147
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
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
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.
P. 148
The Requirement Specification dialog box shows. Edit the properties and click OK button to apply the changes.
Requirement Specification
P. 149
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 150
Add attributes for the requirement type to make it meaningful. Click Add button below the attribute table and select an attribute.
P. 151
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.
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.
Once you finish configuring requirement types, click OK button to return to your target requirement diagram.
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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 152
Press on the Verify <- Test Case resource of requirement and drag.
Press on the Verify -> Requirement resource of test case and drag.
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.
P. 153
In the Test Plans tab, fill in the Steps, Procedures and Expected Results.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 154
Textual analysis
Textual analysis is a tool for recording customers' needs. Furthermore, it lets you extract key terms from a passage you recorded, and transform the
terms to model elements or put them into glossary to build a project -based dictionary.
Recording requirements
Document customers' needs by performing textual analysis.
Textual analysis
P. 155
Recording requirements
Before you start business process modeling, you usually have to discuss with your customers about their needs and to familiarize yourself with their
company's operations as well as their problems. During the meeting you can collect useful information from customers, including the conversation log
and documents. You can make use of textual analysis , a text-based editor to help recording 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
1.
Select Diagram > New from the toolbar.
2.
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Editor's toolbar
No.
Name
Description
Bold
Italic
Underline
Left Justify
Center Justify
Right Justify
Ordered list
Un-ordered list
Font
Font size
Font color
Recording requirements
P. 156
Table
Add a table.
Background color
Clear formats
Clear formats of the whole editor to convert the content to plain text.
Link
Add a hyperlink.
Image
Add an image.
Add Diagram
Add a diagram
Find
You can search your target word/phrase in problem statement in shortcut through here. Simply enter the word/
phrase in search field, as a result, the word/ phrase matching you typed will be highlighted.
To type in the editor, type the problem statement directly on the editor.
To import a text file, click Import File on the toolbar.
Import 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.
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.
Formatting text
Since Visual Paradigm supports rich text format (RTF), you can format the problem statement on the editor, such as making it bold, italic, or inserting a
table.
1.
Highlight OTV
2.
Next, click a corresponding button on the toolbar. i.e. Click Italic button to make the target word italic.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Recording requirements
P. 157
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Recording requirements
P. 158
Highlight the specific term on problem statement editor, right click on it and select Add [the highlighted term] to Glossary from the pop-up
menu.
When the Glossary Grid page is opened, right click on the newly created term and select Open Term Editor from the pop-up menu.
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.
OTV is defined
NOTE:
If the Aliases column is hidden, click Configure Columns..., open the Properties tab and select it under the Details folder.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
P. 159
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 160
Enter description
P. 161
NOTE:
The text you typed in Description cell will become the documentation of the corresponding model element.
2.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 162
Right click on the target candidate object and select Create [candidate object's type] Model Element from the pop-up menu.
In the Visualize Model Element dialog box, either check Create new diagram to show your model element on a new diagram or check Show
in existing diagram to show on an existing diagram. Finally, click the Show button to proceed.
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.
P. 163
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 164
P. 165
Check yellow
P. 166
Tile layout
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 167
P. 168
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Edit description
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.
P. 169
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
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 170
Glossary grid
The glossary grid is the primary area where you can read and define terms. You will learn how to create term in grid, and how to work with functions
like label configuration and Excel exporting.
P. 171
Highlight the specific term on Description editor, right click on it and select Add "[the highlighted term]" to Glossary from the pop-up menu.
When the Glossary Grid page is opened, right click on the newly created term and select Open Term Editor from the pop-up menu.
4.
You can define aliases for the term and enter definition 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.
As a result, the columns of Aliases and Description are filled when you return Glossary Grid page.
P. 172
Opening term
To read the definition of a term, press the Ctrl key and click on the term from description/flow of events content/shape name. By doing so, the glossary
grid will be opened, with the selected term highlighted.
To open a term
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 173
Name
Description
Name
Scope
The location to look for the terms to list in grid. By default, terms are found from the whole project. You
can change to find terms from specific model or package, or to find only terms right at the root level.
You can also restrict the scope to all diagrams, to within a specific diagram or to all terms that has not
been visualized in any diagram.
Filter
Apply filter to grid content. Text entered here is matched against the Name property of terms listed in
grid. terms that do not contain the entered text in their name are hidden.
Font Size
Configure Grid
Click to show/hide the grid configuration panel, which allows you to enter the name of grid, the model
element to be listed in grid, the scope and to apply filter to grid content.
New Term
Select a term in Glossary Grid and click this button to open the term editor for editing it.
Open Specification...
Select a term in Glossary Grid and click this button to open its specification.
10 Show View...
Select a term in Glossary Grid and click this button to list the diagrams that contains the view of the
selected term.
11 Visualize...
Select a term in Glossary Grid and click this button to show it in a new or existing diagram.
Select a term in Glossary Grid and click this button to add labels to it.
13 Manage Label...
14 Configure Columns...
15 Refresh
Click to refresh the grid content by showing the most updated information of terms listed.
16 Export to Excel
P. 174
18 List of terms
19 Search
20 Clear
2.
1.
Manage Label
2.
3.
In the Glossary Label Specification window, enter the name of label and give it a unique color.
1.
2.
Add label
NOTE:
3.
If the Labels column doesn't appear, click Configure columns..., open the Properties tab and select it under the Others folder..
P. 175
Add label
4.
1.
Configure Grid
2.
Adjust scope
3.
In the Scope window, select the label to be included into the scope.
Selecting label
4.
Click OK to confirm and return to the Glossary Grid. From now on, only terms that contain the selected labels will be listed in the grid.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 176
Grid diagram
A grid is capable in listing model elements in tabular form, with them appear as row and properties as columns. This chapter will teaches you how to
create and configure grid.
Grid diagram
P. 177
2.
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
6.
The Grid Diagram is opened. Select a model element type from the drop down menu of Model Element. Click More... to list all the available
choices. If you want to list multiple model element types say, class and use case, click "+" to add more type row(s).
Select Class
The model element of selected type will then be shown on the grid.
Related Resources
The following resources may help to you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 178
Click on the New [Element] button, where Element refers to the type of model element you have chosen in the Model Element's drop down
menu.
Enter name for the newly created model element and then press Enter to confirm.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 179
Configure Columns
2.
In the Configure Columns dialog box, select your preferred property under Properties tab and then click OK button.
Choose properties
3.
Grid updated
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 180
Configure Grid
2.
Select scope
NOTE:
Within Model or Package: Select this to show all selected model element types within a particular model/ package.
Root Model Element: Select this to show all selected model element types under root node.
All Diagrams: Select this to show all selected model element types within all diagrams.
Within Diagram: Select this to show all selected model element types within a particular diagram.
No Diagram: Select this to show all selected model elements without diagram.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 181
Configure Grid
2.
Enter in the Filter field the name of the model element(s) that you want to find or part of its name. You can use an asterisk (i.e. the * character)
to indicate wildcard characters. Upon typing, the grid is updated to exclude the rows that do not match with the entered text.
Searching
Enter in the Search field the key words of the model element(s) that you want to find. Key words refer to words that are contained by the properties
(columns) listed in grid. You can use an asterisk (i.e. the * character) to indicate wildcard characters. Upon typing, the grid is updated to highlight the
rows that match with the entered text.
Searching in grid
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 182
Right click on the column header at the top of a grid and select Add Tagged Value Column... from the popup menu.
Enter the tag name in the Input dialog box and click OK to confirm.
4.
You will see a new column appear in the last column of the grid.
Now, you can double click on a cell in that column to enter the value of the property (tag). When and only when you have entered a value, a tag
will be added into that specific model element. Note that once a tag is added, you cannot remove the tag by clearing the cell content. If you want
to remove the tag, you have to do it in the model element specification window.
P. 183
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 184
Event
An event in a business process refers to something that happens and affects the flow of process. This part will describe the various types of start,
intermediate and end event.
Gateway
Gateway is a kind of flow objects which is used to direct sequence flows within a process, based on certain condition(s). There are several kinds of
gateway for different kinds of control behavior. We will go through each of them in detail.
Data object
You can use data objects to model data within process flow. You will learn how to define states for data object.
P. 185
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
To define the format of ID, open the Project Options window by selecting Windows> Project Options from the toolbar. Select Diagramming from
the list on the left hand side and open the Model Generation tab. Click Add and then select the type of model element that you want to change its ID
format (E.g. Task). Then, you can adjust the format, say to specify the prefix, the number of digits and suffix.
Defining format of ID
Below is a description of the options.
Option
Description
Prefix
Num of digits
The number of digits of the number. For example, when digit is 3, ID "1" will become "001"
Suffix
GUID
A randomly generated string. Note that the string will be very long. And by selecting this option, the prefix, num of degits and suffix
options will be ignored.
P. 186
By default, ID is just a text property that won't appear in diagram. However, you can make it appeared 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 define the way ID is shown in BPD, open the Project Options window by selecting Windows > Project Options from the toolbar. Select
Diagramming from the list on the left hand side and open the Business Process > Behavior tab.
In the ID Generator Format section, select whether or not to show ID on diagram and whether to show it as a label that is attached to a shape or as
text below caption. If you select Show as Customized, you can edit in the table of model element the way ID is shown.
Note that the setting is effective only in newly created diagrams.
Controlling how ID is shown on an existing diagram
The previous section described how to set the appearance of ID in new diagrams. Here, you can see how to change the ID appearance of an existing
diagram.
To do this, right click on the BPD you want to edit and select Presentation Options >Configure Show ID Options... from the pop-up menu.
In the Configure Show ID Options window, click on the drop down menu Show ID Option and select if you want to show IDs. If yes, select where to
show, such as below caption or as a label.
P. 187
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 popup menu)
Nested ID
When you draw something in a lane/pool or to drill down a sub-process into another level and draw something, this forms a nested element hierarchy
like a task is contained by its parent pool. ID is formed nested according to the hierarchy. For instance, while a pool has '3' as ID, its children have 3.1,
3.2... as IDs. You can turn this function on and off.
To turn on or off, right click on a BPD and select Diagram Content > Edit IDs... from the popup menu. At the bottom of the dialog box, check or
uncheck the option Sub-Level ID.
Showing process statistic
Process statistic refers to the results of the statistical analysis that can be conducted upon your process. There are three types of figures: number of
message flows, total process-costs and the total processing hours.
To show process statistic:
1.
2.
Select Utilities > Show Statistic... from the popup menu. This opens the Statistic window like this:
Process statistic
Below is a description of figures.
Figure
Description
Total process-costs
A summation of costs specified for tasks and sub-processes in the current diagram.
A summation of duration specified for tasks and sub-processes in the current diagram.
Description of figures in process statistic
P. 188
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 189
Orientation of pool
In a business process diagram, pool and lane can be shown either vertically or horizontally. To change the orientation of pool and contained lane,
right click on the pool header and select Orientation > Vertical/Horizontal from the popup menu. Note that this function is available when the pool is
empty.
NOTE:
You can only change the orientation of pool/lane when it contains no flow object
P. 190
NOTE:
You can only create a black box for an empty pool that has neither flow objects nor lanes in it.
You can create message flows between black boxes to represent the collaboration between participants or create message flows between flow objects
in another pool/lane with a black box.
Stretching of pool
When you create a pool, it is automatically expanded to fit the width or length of diagram. We call this behavior stretched. When a pool is stretched,
the pool and the contained lane(s) will expand or collapse by following the size of diagram and you cannot resize it manually. If you want to make a
pool freely resize-able, you need to turn the stretch behavior off. To change the stretch option, right click on the pool involved and select Presentation
Options, then select Auto Stretch > Off from the popup menu.
P. 191
Nested lanes
Reordering lane
You can change the position of lanes within a pool by moving them up and down. To reorder a lane, right click on the lane you want to reorder and
select Selection > Move Down from the popup menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 192
Task markers
You can assign markers to task. There are three markers: Loop, Multi-Instance, Compensation. A task can have one or two of these markers.
Assignment of markers is done through the specification dialog box of task.
Name
Representation
Description
Loop
This marker indicates that the task will loop as long as the condition that
defined in the loop is true. The condition is evaluated in each iteration, at
either the beginning or the end of iteration. This marker can be used in
combination with the compensation marker.
Multi-instance
(parallel instances)
Compensation
To undo (cancel) the result of another activity that have already been
successfully completed. The execution of compensation task is due to the
undesired results and possibily side effects produced by antoher activity that
need to be reversed.
A compensation task is performed by a compensation handler, which
performs the steps necessary to reverse the effects of an activity.
Different markers of task
1.
Right click on a task and select Open Specification... from the popup menu.
2.
Select Standard Loop for Loop type. Click OK to confirm the changes.
NOTE:
You can click on the ... button next to Loop type to set the loop condition, counter and the maximum number of iteration.
1.
Right click on a task and select Open Specification... from the popup menu.
2.
Select Multi-Instance Loop for Loop type. Click OK to confirm the changes.
NOTE:
You can click on the ... button next to Loop type to set the ordering of loop, either parallel or sequential.
1.
Right click on a task and select Open Specification... from the popup menu.
2.
Check Compensation at the bottom of specification and click OK to confirm the changes.
Task types
There are several types of task for you to separate the behavior of different tasks. You can set a type by right clicking on a task and selecting Type,
then the type from the popup menu.
Name
Representation
Description
Service
A service task is a task that uses some sorts of service, e.g. a Web service.
Send
A send task is a task that sends a message to an external participate. The task is said to be completed once
the message has been sent.
P. 193
Receive
A receive task is a task that waits for a message to arrive from an external participant. The task is said to be
completed once the message has been received.
User
A user task is a task performed by a human with the assistance of a software application.
Manual
A manual task is a task that is performed without the aid of any business process execution engine.
Business Rule
A business rule task allows the process to provide input to a business rules engine and to get the output from
engine.
Script
A script task involves a script defined by modeler or implementer in a language that a business process engine
can understand and is executed by a business process engine.
Reference
Types of tasks
Sub-process markers
You can assign markers to sub-process. There are four markers: Loop, Multi-Instance, Ad-hoc and Compensation. A sub-process can have up to three
markers, excluding the marker for collapsed: A loop/multi-instance marker, an Ad-hoc marker, and a Compensation marker. Assignment of markers is
done through the specification dialog box of sub-process.
Name
Representation
Description
Loop
This marker indicates that the sub-process will loop as long as the condition
that defined in the loop is true. The condition is evaluated in each iteration,
at either the beginning or the end of iteration. This marker can be used in
combination with the ad-hoc and/or compensation marker.
Multi-instance
(parallel instances)
Ad-hoc
Compensation
To undo (cancel) the result of another activity that have already successfully
completed. The execution of compensation sub-process is due to the
undesired results and possibly side effects produced by another activity that
need to be reversed.
A compensation sub-process is performed by a compensation handler,
which performs the steps necessary to reverse the effects of an activity.
Different markers of sub-process
1.
Right click on a sub-process and select Open Specification... from the popup menu.
2.
Select Standard Loop for Loop type. Click OK to confirm the changes.
NOTE:
You can click on the ... button next to Loop type to set the loop condition, counter and the maximum number of iteration.
1.
Right click on a sub-process and select Open Specification... from the popup menu.
2.
Select Multi-Instance Loop for Loop type. Click OK to confirm the changes.
NOTE:
You can click on the ... button next to Loop type to set the ordering of loop, either parallel or sequential.
P. 194
1.
Right click on a sub-process and select Open Specification... from the popup menu.
2.
Make sure the type of sub-process is set to be Embedded Sub-Process. Check Ad-hoc in the Details section and click OK to confirm the
changes.
1.
Right click on a sub-process and select Open Specification... from the popup menu.
2.
Check Compensation at the bottom of specification and click OK to confirm the changes.
Sub-process types
There are several types of sub-process for you to separate the behavior of different sub-processes. You can set a type by right clicking on a subprocess and selecting Type, then the type from the popup menu.
Name
Representation
Description
Embedded
An embedded sub-process is a sub-process that models its internal details in another process.
Reusable
Reference
Types of tasks
NOTE:
Once a sub-process diagram is created, its detail will be shown as the sub-process shape as a thumbnail of the diagram. To hide the
thumbnail, click on the minus marker at the bottom of sub-process to turn it off.
In the sub-process diagram, you can re-use pools, lanes and flow objects that appear in the parent diagram. To do this, right click on the sub-process
diagram and select Add Pools/Lanes/Sub-Processes/Gateways from Parent Diagram... from the popup menu, and choose the element to reuse.
Elements being re-used will have dog ear appeared at their corners.
P. 195
Procedure of a task
An overview of procedure editor
Name
Description
Collapse/Expand
Click on the triangle on the left hand side to maximize the editor. On the contrary, click on the
inverted triangle to minimize the editor.
Procedure selector
You can define multiple set of procedure per activity. Click on this drop down menu to select the
one you want to read/edit.
Step
Click on this button to create a step under the step selected in editor.
Hyperlink...
There are three buttons. While the first one increases the font size for one level, the second one
decreases the font size for one level and the third button resets the font size setting to default.
Click on this drop-down menu to select the sizes of highlighted text. Press Grow Font button to
increase the font size for one level, press Shrink Font button to decrease the font size for one level
and press Default Font button reset the font size setting to default. Moreover, you can adjust the
font size for the highlighted text manually by slider.
Reorder step
Click on Move Up button to move the selected step upwards or Move Down button to move the
selected step downwards.
Click on Decrease Indent button to reduce the indentation of the selected step or click on Increase
Indent button to indent the selected step.
Undo/ Redo
Click on Undo button to revert change or click on Redo button to redo reverted change.
10 Close editor
P. 196
11 Steps editor
The procedure editor is opened in business process diagram by default. To hide it, right click on the background of business process diagram and
deselect Show Procedure Editor from the popup menu. You can select the same menu to show it when hidden.
NOTE:
Alternatively, you can close the editor by clicking on the cross button at the top right corner of editor panel.
1.
Select the task or sub-process that you want to document its procedure.
2.
Click on the first row labelled 1 and enter the first step.
3.
Press Enter to go to the next step. You can create a sub-step by pressing Tab on a step. Pressing Shift-Tab decreases the indentation of a
sub-step. Repeat step 2 and 3 to enter the remaining steps the activities involve.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 197
Event
An event in a business process refers to something that happens and affects the flow of process. There are three types of events: Start, intermediate
and end.
Start, intermediate and end events with different kinds of triggers and results
Start event
A start event indicates the place where and possibly why a process start. Since start event is used for initiating a process, it does not have any
incoming sequence flow.
You can define a trigger for start event, to show the condition(s) that will cause a process to initiate.
Trigger name
Representation
Description
None
Message
Timer
This trigger starts the process in a specific time-date or a specific cycle (e.g. every Friday).
Error
This trigger starts an in-line event sub-process when an error occurs. Note that this trigger can only be
used with an event-sub-process.
Escalation
This trigger starts or not to start an in-line event sub-process when the constraint specified is not
satisfied. Note that this trigger can only be used with an event-sub-process.
Compensation
This trigger starts an in-line event sub-process when an compensation occurs, which requires undoing
some steps. Note that this trigger can only be used with an event-sub-process.
Conditional
This trigger starts the process when a specific condition becomes true.
Signal
This trigger starts the process when a signal broadcasted from another process has arrived. Note that
signal is different from message in the sense that it has a specific target for message.
Multiple
This means that there are multiple triggers of the process. Any one of them can cause the process to
start.
Parallel Multiple
This means that there are multiple triggers of the process. All of the triggers must be triggered in order to
start the process.
Link
This trigger provides a means to connect the end result of one process to the start of another.
Different types of start event trigger
Defining a trigger
To define a trigger on an event, right click on the event and select Trigger, then click on the type of trigger from the popup menu.
Event
P. 198
Start event can be attached to the border of an event sub-process to initiate the sub-process inline. You can define this kind of trigger as either
interrupting or non-interrupting, which means to interrupt its containing process or not to interrupt its containing process respectively. To set a trigger to
be Interrupting or Non-Interrupting, right click on the event and select/de-select Triggers > Interrupting from the popup menu.
NOTE:
Only triggers that can be attached to event sub-process can set as interrupting/non-interrupting. The supported trigger types include:
Message, Timer, Escalation, Error, Cancel, Compensation, Conditional, Signal, Multiple, and Parallel Multiple.
Intermediate event
An intermediate event indicates where something happens in between the start and end event of a process. You can use an intermediate event to
show where messages are received or sent, show the necessary delay, perform exception handling and show the need of compensation. You can
place an intermediate even in two places: Attaching the boundary of task/sub-process, Normal flow (i.e. connected from a flow without attaching to an
activity).
Trigger name
Representation
Description
None
The none intermediate event does not have a defined trigger. It is used to indicate change of state in the
process. You can only use a none intermediate event in a normal flow.
Message
Timer
This trigger acts as a delay mechanism on a specific date-time or cycle (e.g. every Friday). You can only
use a timer intermediate event in a normal flow.
Error
Escalation
The trigger indicates where an escalation is raised. You can only use an escalation intermediate event in
a normal flow.
Cancel
This trigger will be fired when a cancel end event is reached within the transaction sub-process. It also
shall be triggered if a Transaction Protocol "Cancel" message has been received while the Transaction is
being performed.
Compensation
Conditional
The event will be triggered when the condition specified become true.
Event
P. 199
Link
This trigger is used for linking two sections of a process. You can use it to mode a looping of flow or to
avoid having long sequence flow connectors appear on diagram. You can only use a link intermediate
event in a normal flow.
Signal
This trigger indicates the sending or receiving of signals, which is for general communication within and
across process levels, across pools, and between business process diagrams.
Multiple
This means that there are multiple triggers defined. Any one of them can cause the event to be triggered.
Parallel Multiple
This means that there are multiple triggers defined. All of the triggers must be triggered in order to trigger
the multiple event.
Different types of start event trigger
Defining a trigger
To define a trigger on an event, right click on the event and select Trigger, then the type of trigger from the popup menu.
You can set an event to be catch or throw. Catch means to react to a trigger, while throw means to create a trigger. To set, right click on an event and
select Trigger, then either Catching or Throwing from the popup menu.
NOTE:
The trigger types that can set as throw/catch include: Message, Escalation, Compensation, Link, Signal, and Multiple.
Intermediate event can be attached to the border of an activity. You can set an event to interrupt or not to interrupt the activity to which it is attached.
To set a trigger to be Interrupting or Non-Interrupting, right click on the event and select/de-select Triggers > Interrupting from the popup menu.
NOTE:
Only triggers that can be attached to event sub-process can set as interrupting/non-interrupting. The supported trigger types include:
Message, Timer, Escalation, Conditional, Signal, Multiple, and Parallel Multiple.
Event
P. 200
End event
As an opposite of start event, end event indicates where a process will end. Since end event is used for terminating a process, it does not have any
outgoing sequence flow.
You can define a result for end event, to show what will happen when reaching the end.
Trigger name
Representation
Description
None
Message
Error
This result indicates the generation of a named error when the process ends.
Escalation
This result indicates the trigger of escalation when the process ends.
Cancel
Compensation
This result indicates the need of compensation, which require undoing some steps.
Signal
This result indicates that a signal will be broadcasted when the process ends. Note that signal is different from
message, which has a specific target for message.
Terminal
This result indicates that all activities in the process should be immediately ended.
Multiple
This result indicates that there are multiple consequences of ending the process.
Link
This result provide a means to connect the end result of one process to the start of another.
Different types of end event result
Defining a result
To define a result on an event, right click on the event and select Result, then the type of result from the popup menu.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Event
P. 201
Event
P. 202
Gateway
Gateway is a kind of flow objects which is used to direct sequence flows within a process, based on certain condition(s). It acts like a gate that either
allows or disallows passage, and possibly control the selection of outgoing flow that pass through the gateway.
Gateway types
There are several kinds of gateway for different kinds of control behavior, such as making decision, branching, merging, forking and joining.
Gateway type
Representation
Exclusive
Description
An exclusive gateway can be used to model alternative paths within a flow. It is where
the diversion takes place.
or
Event-based
An event-based gateway can be used to model the alternative paths that follow the
gateway which are based on events that occur instead of the expression of flow.
Inclusive
An inclusive gateway can be used to model alternative and parallel paths within a
process. Unlike exclusive gateway, all condition expressions are evaluated. All the
outgoing paths that give a positive result of evaluation will be taken.
Complex
Parallel
A parallel gateway can be used to create and join parallel flows. It creates the paths
without checking any conditions.
Different types of gateway
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Gateway
P. 203
P. 204
Right click on the message flow that you want to model its message and select Open Specification... from the pop-up menu.
2.
Click on the drop down menu of Message and select Create Message (Business Process) from the pop-up menu.
Create a message
3.
4.
You should see the message added appear in the drop-down menu of Mesasge. Click OK to confirm the change and go back to diagram.
5.
Although the message is defined, you still need to visualize it. To visualize the message, right click on the diagram's background, click
Presentation Options, select Message Flow Display Option > Show Message of Message Flow from the pop-up menu, then select the way
of visualizing the message.
Ways of showing message (from left to right) - Do Not Show, Associated with Message Flow, Overlapping Message Flow
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 205
1.
Right click on the choreography task and select Open Specification... from the popup menu.
2.
In the specification dialog box, choose the pools for participant 1 and 2.
3.
Select the pool which starts the interaction from the drop down menu of Initiating participant.
Choreography task
Choreography sub-process
A choreography sub-process is a compound activity in which it has detail that is defined as a flow of other activities.
Setting participants and initiating participant
1.
Right click on the choreography sub-process and select Open Specification... from the popup menu.
2.
3.
Select the pools the choreography sub-process involve and click > to assign them.
4.
P. 206
Choreography sub-process
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 207
Right click on data object and select State > Create... from the popup menu.
To create a state
2.
In the Create State dialog box, enter the name of state and click OK to confirm.
NOTE:
State is a view based option. You may copy a data object, paste as a new view and set the state to the new view. This enables you to
show the change of state of a data throughout a process flow.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Data object
P. 208
Conversation diagram
Conversation diagram gives you a high level of understanding to the relationships between pools under the domain being modeled. This chapter
teaches you how to create a conversation diagram.
Conversation diagram
P. 209
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 210
Editing diagrams
In this chapter, you will learn not only how to create and edit diagrams, but also some of the frequently used functions that aid in diagramming,
including resource-centric interface, using tagged values to add custom properties and spell checking.
Creating diagrams
You will see how to create a diagram, how to create shapes and draw freehand shapes.
Tagged values
Tagged values can be used to add domain specific properties to shapes. There are several types of tag, such as text, integer, floating point number,
etc. You will see how to create tagged values.
Spell checking
Spell checking is an automatically enabled feature for ensuring the accuracy of written content such as shape name and documentation. You will see
how to configure spell checking.
Editing diagrams
P. 211
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.
Creating a diagram
Through the toolbar
1.
3.
Click Next.
4.
5.
You can set the Location, which is the model for storing the diagram. Note that if a diagram is opened in background and if that diagram is
being stored in a model, we will automatically select that model as Location.
6.
Click OK.
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
with the default size.
For defining a specific shape size, drag a specific boundary with the mouse after clicking a diagram element from the diagram toolbar.
Creating diagrams
P. 212
Alternatively, a diagram element can be created by dragging the diagram element and then dropping it on the diagram pane.
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.
To create a connector, select the desired connector from the diagram toolbar, drag the connector from the source shape to the destination shape.
Since Visual Paradigm provides a continuous UML syntax checking, if you create an invalid connection, a stop sign will pop-out. For instance, you are
not allowed to connect an actor and a use case with a generalization relationship.
Creating diagrams
P. 213
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 takes place. To create a turning point on an existing connector, press on the connector and
drag to bend the connector.
Name completion
The model name completion feature enables quick creation of multiple views for the same model element. When you create a model element, press
Ctrl-Space to reveal the name completion list.
Creating diagrams
P. 214
Connection Resource
Manipulation Resource
Branching Resource
Connection 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.
Creating diagrams
P. 215
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.
Creating diagrams
P. 216
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.
Open Specification
You can rename the parent package of the diagram by double clicking on it.
Creating diagrams
P. 217
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.
As a result, all shapes' name in the whole diagram will turn into the alignment option you set previously.
Creating diagrams
P. 218
Right click on a shape, select Presentation Options > Model Element Name Alignment and then select a specific alignment option from the
pop-up menu.
As a result, the specific shape will turn into the alignment option you set previously.
2.
In the Options dialog box, select the Diagramming category, check an option out of Model Element Name Alignment section under the
Appearance tab.
Exceptions
Although most shapes' name can be justified, some are exceptional. Two main kinds of shapes that their names cannot be justified are introduced as
follows:
On one hand, shapes neither with floating name label (freely movable) nor with a label outside the shapes can be justified. Actor, Initial Pseudo Node
and BP Start Events are examples of this kind of shape.
Creating diagrams
P. 219
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
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 Windows > Project Options... from the toolbar.
2.
In the Project Options dialog box, select the Diagramming category and uncheck Enable minimum shape size when resizing shape under
Appearance tab. Click OK to confirm.
3.
After that, you can resize a shape to the size as small as you want.
4.
Furthermore, select other shapes and select an option from the drop-down menu of resource icon Same Width.
As a result, other shapes will turn into the same size as the shape you have done previously.
Creating diagrams
P. 220
You can roll back undesirable changes by performing Undo. Undo function can be executed in the following three ways:
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:
Press Ctrl-Y.
It's hard for us to remember all actions we have done previously. By Visual Paradigm, we can recall the actions we have done before.
You can find an 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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Creating diagrams
P. 221
Hotkey
Windows
Ctrl-F4
Linux
Ctrl-W
Mac OS X
Command
+W
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Closing diagram
P. 222
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 223
Opening diagram
This article shows you how to open a diagram in Visual Paradigm. You can switch to a recently opened diagram, or open one from the Project
Browser.
Switching to another diagram
The diagram switch provides you quick access to diagrams opened within the active session. To switch to another diagram, click the Switch Diagram
button on the right hand side of the navigation bar. Then, double click on the thumbnail of the desired diagram to open it.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Opening diagram
P. 224
Open the Show Views window first. In Model Structure View, you can open it by right clicking on the target model element and selecting Show
View... from the popup menu. In diagram, you can open it by right clicking on the target view and selecting Related Elements > Show Other
Views... from the popup menu.
2.
In the window you can see a list of views of the selected model element/view. Click Set Master View...at bottom left corner.
3.
This shows the Set Master View window. You can select on the left hand side the Model Explorer or a specific diagram to be the master view
of selected element. To select Model Explorer means that any re-positioning made in views in any diagram will not affect the model hierarchy.
Click OK to confirm your selection.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 225
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 toolbar.
Move the mouse on a shape and select a resource icon out of resource centric interface.
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.
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.
Drag the resource icon and release it until reaching to another shape.
3.
Release the mouse to create Association connecting with the Use Case
P. 226
1.
After creating some shapes on diagram, move the mouse on a shape and double click on a resource icon. The Quick Connect dialog box will
be shown subsequently.
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 be displayed.
3.
After you click a shape's name on the drop-down list, the shape will be spotlighted on the diagram immediately.
Confirm the selection, press Enter. The two shapes will be linked automatically.
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.
P. 227
NOTE:
Transition does not only apply on two shapes on the same diagram, but also two shapes in different diagrams.
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.
Insert the corresponding resource in References tab of your shape's specification window.
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.
P. 228
Move the mouse on the connector between two shapes and select a split resource icon out of resource centric interface.
NOTE:
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 tro 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.
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.
P. 229
NOTE:
2.
Move the mouse on the last selected shapes and group selection resources will be shown instantly.
Press the reversed triangle of Align Top and select an alignment option from the drop-down menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 230
Tagged values
Sometimes, you may find the standard modeling notations are not enough in supporting your domain specific needs. For example, if you are working
on a project that relies heavily on the use of third-party libraries, you might want to specify the API source of those components modeled in UML
component diagram. And in business process modeling, you might want to record the locations where the tasks are performed. Usually, these kind of
specific needs cannot be directly supported by the standard notations.
Fortunately, OMG Unified Modeling Language (UML) introduces stereotype and tagged values, which provide designers with ideal solutions to these
situations. Stereotype and tagged values are kind of extensibility mechanisms that allow designers to extend the vocabulary of UML in order to create
new model elements. With the use of stereotype and tagged values, designers can introduce model elements with domain/problem specific properties.
Starting from UML 2.0, tagged values are considered to be attributes of stereotype. Yet, Visual Paradigm supports to use tagged values independently,
that is, to add tagged values directly to model elements as custom properties instead of prior attachment to any stereotype. Besides, Visual Paradigm
allows you to take the advantage of stereotypes and tagged values in not just UML but all the modeling notations like BPMN and even in ERD, DFD,
etc. Simply put with Visual Paradigm, you can add custom properties to any model elements by creating tagged values.
Adding user-defined tags
1.
Right click on the selected shape and select Open Specification... from the pop-up menu.
In Specification dialog box, select Tagged Values tab and click Add button to select the tag type.
Description
Text
String-based value. To edit, double click on the Value cell and enter the value.
Multi-line Text
String-based value, in multiple lines. To edit, click on ... in the Value cell, and then enter the value in the popup
window.
Model Element
Integer
Numerical value. To edit, double click on the Value cell and enter the value.
Value with decimal places. To edit, double click on the Value cell and enter the value.
HTML
Value in rich-text. HTML is a hidden tagged value. To reveal this option, select Windows > Project Options from
the toolbar. When the Project Options window, select Diagramming > Environment tab and check Support HTML
tagged value.
To edit an HTML value, click on ... in the Value cell, and then enter the value in the popup window.
Boolean
Either true or false. To edit, click on the Value cell, and then select True/ False.
Different types of tagged value
NOTE:
The value of stereotype can be edited, however, its name and its type cannot be edited as they are defined in stereotype.
Tagged Values
P. 231
Select Configuration > Configure Default Tagged Values under the Windows tab of the toolbar.
2.
Select the type of model element to be configureon on the left hand side.
3.
Click Add on the right hand side to select the tag type.
4.
5.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Tagged Values
P. 232
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Tagged Values
P. 233
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 as 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:
Right click on the wrong word and then select one out of the suggest words.
Select Windows > Application Options from the toolbar. In the Application Options window, click Spell Checking.
2.
NOTE:
There are a few more languages in dictionary that can be used, such as French and German.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Spell Checking
P. 234
Diagram specification
A diagram specification window consists of 5 tabs: General, Grid Setting, References, Project Management and Comments respectively. You may
notice that an icon named Maximum located at the right hand side of window. We'll introduce it after giving you a brief on 5 tabs.
General tab
You can specify diagram name, select zoom ratio and diagram background color and enter description for the diagram. Furthermore, you can record
voice description for the diagram. You can set all shapes including existing and future shapes to fit the size automatically.
Grid Setting tab
You can visualize the grid of diagram background by checking Grid visible. Moreover, you can set the size and select the color for the grid of diagram
background.
References tab
You can add/ remove internal and external references for the diagram. Those references refer to file(s), folder(s), URL, diagram(s), shape(s), model
element(s) and A³ resource(s).
Project Management tab
You can specify diagram process, priority, status, etc for project details.
Comments tab
Click
to enlarge the specification window to the maximum screen size. Click it again to reduce it to the default size.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 235
NOTE:
This button works in combination with Auto open specification when select.
After you've pinned the specification window, press this button. After all, you don't have to close the current window in order to open another model
element specification box.
1.
P. 236
Select another model to view its specification window by clicking on the target model.
Selecting Sequence
Maximum
Press this button to enlarge the specification window to the maximum screen size.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 237
P. 238
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 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
Status
The status of editing element. It is particularly useful for use case and BPMN activity shapes for setting their status such as
Proposed, Planned, Tested, etc.
Difficulty
Author
The person who created the editing element. This is particularly 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.
The date and time when the editing element was created. This property is a read-only property that is filled automatically to all
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 document, 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.
P. 239
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 240
Right click on a diagram and select Open Specification... from the popup menu
2.
3.
In the Project Management Look-ups dialog box, open the tab of the property that you want to edit its look-ups.
4.
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
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 241
Format copier
Shows you how to copy the formatting properties of a shape and copy to another.
P. 242
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.
Field
Font Name
Description
Select different types of font. The number of fonts depends on the fonts available in your computer.
P. 243
Font Style
Select the style of font. You can select one of the 4 styles, a preview will be shown for each of the style items.
Font Size
Select the size of font. You may either click on the default sizes or enter the font size in the text fields.
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
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 Default
Save the current fill color as the default fill color for new shapes, click the Set as Default button.
Reset to Default
Reset the current fill color to the default fill color, click the Reset to Default button.
Upon selecting Gradient from the Fill style field, you will see the detail pane for formatting a gradient fill color.
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 doubleclick on the color editor. A color chooser will appear for you to select a color.
P. 244
The Gradient Color Themes pane displays a list of pre-defined gradient color 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.
Changing connector line style
To change a connector line's style, open the Formats window first. Right click on the connector and select Styles and Formatting > Formats... from
the pop-up menu. Then, you can format the line style in the Line tab. 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:
Transparency
Only integer values can be used for line weight. If you type 2.8 in the text field, 2 will be applied instead.
Specify 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
Preview
The Preview pane displays a rectangle surrounded by the line with the selected line format applied.
2.
P. 245
In the Configure Member Format window, select the property or properties that you want to edit - foreground, background and/or font, and then
make the changes you want. If you want to apply changes to multiple members, you can perform a multiple selection in the list on the left hand
side. Press Shift/ Ctrl for a multiple selection.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 246
Open the styles window by selecting View > Styles from the toolbar.
2.
In the Styles window, click Add... to create and edit a new style.
3.
In the Edit Style window, set the name, foreground line style, font style, background style and arrow style.
4.
Applying styles
Upon keeping the Styles dialog box open, select a target shape on the diagram and click Apply in the Styles dialog box.
As a result, the shape is changed into the newly created style.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 247
Sample
Rectilinear
Oblique
P. 248
Curve
Round Oblique
Round Rectilinear
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 249
Set Arc
Arc sample
NOTE:
The line jumps options are available only when two connectors are overlapped.
Sample
Off
Arc
Gap
P. 250
Square
In the Project Options window, 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.
1.
Right click on the diagram's background, select Connectors and then a size option from the pop-up menu.
P. 251
Set Large
2.
The line jump(s) on the current diagram will turn into the size you selected.
1.
Select Windows > Project Options from the toolbar to open the Project Options window.
2.
In the Project Options window, 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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 252
Sample
Description
Horizontal Only
P. 253
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 Windows > Project Options from the toolbar.
In the Project Options window, 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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 254
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.
2.
Click Copier
3.
NOTE:
2.
Select Diagram and double click on the Format Copier button on toolbar.
Format copier
P. 255
NOTE:
If you don't want the format properties to be cloned to other shapes any more, you should cancel cloning by clicking Copier once again.
NOTE:
You can only copy format to shapes within the same diagram.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Format copier
P. 256
You can compare the differences of two kinds of connection point style shown as follows:
Right click on shape and select Styles and Formatting > Connection Point... from the pop-up menu.
In the Select Connection Point Style dialog box, choose a connection point style option. Click OK button.
P. 257
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 258
Right click on the shape and select Presentation Options > Primitive Shape... from the popup menu.
2.
3.
Adjust the content of shape by setting Text. The Name option makes the name of shape presented. The Tagged value option enables you to
display the value of a specific tag. You need to enter the tag name in the drop down menu, or select from the list of existing tags. The Custom
option enables you to display whatever text you want.
4.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 259
Alignment guide
Helps to make sure shapes are aligned well through the visible guide line.
Adding comments
Shows how to add comments to shapes or diagrams.
Zooming diagram
Magnify or diminish diagram content by zooming in and out.
Diagram grids
Learn how to improve shapes' alignment and positioning with the help of diagram grids.
P. 260
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.
P. 261
P. 262
P. 263
P. 264
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 Visual Paradigm, 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.
P. 265
Orthogonal Layout
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.
P. 266
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.
P. 267
Hierarchic Layout
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.
P. 268
Directed Tree Layout is one of the tree layouts in Visual Paradigm which 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.
P. 269
Balloon Tree Layout, which is one of the tree layouts in Visual Paradigm, arranges shapes in a tree structure in a radial fashion. It is the best way for
users to arrange large trees.
P. 270
P. 271
Compact Tree Layout is one of the tree layouts in Visual Paradigm which arranges shapes in a tree structure. The aspect ratio (relation of tree width to
tree height) of the resultant tree can be set.
P. 272
P. 273
Horizontal-Vertical Tree Layout is one of the tree layouts in Visual Paradigm which arranges shapes in a tree structure horizontally and vertically.
P. 274
BBC Compact Circular Layout is one of the circular layouts in Visual Paradigm which 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.
P. 275
BBC Isolated Circular Layout is one of the circular layouts in Visual Paradigm which 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.
P. 276
P. 277
Single Cycle Layout is one of the circular layouts in Visual Paradigm which arranges shapes in circular structure in single circle.
P. 278
Organic layout
Organic Layout is one of the organic layouts in Visual Paradigm which 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
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.
P. 279
Smart Organic Layout is one of the organic layouts in Visual Paradigm which 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.
P. 280
P. 281
P. 282
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).
Organic Edge Route Layout is one of the edge route layouts in Visual Paradigm which arranges the connectors without affecting the location of shapes.
It can ensure that the shapes will not overlap and keep a specific minimal distance.
P. 283
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.
P. 284
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
P. 285
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 286
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.
P. 287
Select Windows > Project Options... from the toolbar to open the Project Options window.
2.
In the Project Options window, choose the Diagramming category, select the Shape tab and check Auto fit size (diagram-based).
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 288
1.
For selecting multiple shapes, drag them from corner to corner diagonally with the mouse.
Click a shape in advance and then click other shapes with pressing Ctrl or Shift key. As a result, those shapes will be selected.
P. 289
Handi-Selection
In some cases, the shapes are too complicated and in more serious occasion, 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.
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.
P. 290
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.
P. 291
Selection is inversed
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 292
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.
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.
You should select a destination document (e.g. MS Word) for pasting the copied shape(s) to do further description. After you switch to the
destination document, right click on the desired place and select Paste from the pop-up menu.
4.
P. 293
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 description. After you switch to the destination document, right
click on a desired place and select Paste from the pop-up menu.
4.
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.
Copying to Diagram
You can also copy the selected shape(s) to either a new diagram or an existing diagram. To copy to a diagram:
1.
Right-click on the selected shapes, select Copy > Copy to Diagram... from the pop-up menu.
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.
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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 294
Alignment guide
Alignment guide acts as a guide to help aligning shapes perfectly in the shortest period of time.
It is a dotted line that appears when you are moving the shape or resizing the shape within more than one shapes.
With the use of alignment guide, you can organize the diagram neatly with only little effort.
Arrange shapes in orderly arrangement
After dragging one shape from another shape, you will see a dotted line (the alignment guide) between the two shapes when you move either shape.
The Alignment Guide is here to help you to align the two shapes.
Take the following diagram as an example. If you move shape B vertically, you can see horizontal alignment guides appears on top, in the middle or at
the bottom. You can choose to follow one of them depends on where you want to position shape B.
Alignment guide
P. 295
2.
Enter guide in the search field of the Application Options window to locate the option.
In the Appearance tab of the Diagramming page, uncheck Enable diagram alignment guide.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Alignment guide
P. 296
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Alignment guide
P. 297
Connector is reversed
NOTE:
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 298
Right click on a model element and select Related Elements > Visualize Related Model Element... from the pop-up menu.
In the Visualize Related Model Element window, check the related element(s) you want to be shown with the corresponding relationship on the
diagram in Visualize. Click Visualize to proceed with.
P. 299
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 300
Adding comments
Visual Paradigm 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.
2.
4.
In Comment Specification window, enter summary, author, date time and content. Click OK to confirm editing.
Entering a comment
As a result, the comment you entered previously is shown on Specification window.
Comments added
3.
4.
In the Comment Specification window, edit the comment and click OK to confirm changing.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Adding comments
P. 301
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.
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
Drag one end of connector to point out a specific position. Note that no dialog box of temporary pin will be shown this time.
P. 302
Moving either from shape or to shape will not unpin the connector.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 303
Selected shapes
Through Toolbar
1.
Select Diagram > Alignment and then an alignment option from the toolbar.
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.
For turning the non-selected shape into the last selected shape, click a shape with pressing Ctrl key.
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.
P. 304
As a result, all selected shapes are aligned in accordance with the last selected shape.
Select Diagram > Alignment and an alignment option from the toolbar.
As a result, the shapes are resized.
Select an option from the drop-down menu of the Same Width on grouping resource icons after select a few shapes on the diagram pane.
P. 305
After select a few shapes on the diagram pane, select Diagram > Alignment > Align Shapes... from the toolbar to unfold Align Shapes Dialog. You
can select an option by clicking the option button directly.
After select a few shapes on the diagram pane, select Diagram > Distribution > Distribute Shapes... from the toolbar to unfold Distribute Shapes
Dialog. You can select an option by clicking the option button directly.
P. 306
Through toolbar
Select Diagram > Distribution and then select an distribution option from the toolbar after select a few shapes on the diagram pane.
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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 307
Right click on the start, intermediate or end event, or gateway shape and select Presentation Options > Caption Placement... from the popup
menu.
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.
Click OK to confirm.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 308
Zooming Diagram
If the diagram on diagram pane isn't clear enough, you can zoom in the diagram with your desired size through the Zoom in and Zoom out buttons.
To zoom in or zoom out a diagram, select View> Zoom in or View > Zoom out in the toolbar.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Zooming Diagram
P. 309
Diagram grids
Diagram grids provide you with a precise visual cue to identify the position and boundary of shapes in diagram editors. You can make use of diagram
grid to improve the positioning and alignment of shapes, which makes the diagram looks more neat, tidy and impressive. By default, the grid lines
are not visible. In this article, we will see how to show them and how to configure the various grid settings. We will use UML component diagram to
explain the ideas but in practice, you can apply diagram grids on any diagram types - UML diagrams, BPMN diagrams, DFD, ERD etc.
Visibility of grid lines
Grid lines are not visible on diagrams by default. You can optionally show them by updating the grid settings. Here are the steps:
1.
Right click on the diagram where you want to show/hide grid lines.
2.
3.
4.
Snap to grid
2.
3.
4.
Grid size
Right click on the diagram where you want to change the grid size.
2.
3.
4.
Edit the Width and Height of Grid size and click OK.
Grid color
Diagram grids
P. 310
1.
Right click on the diagram where you want to change the grid size.
2.
3.
4.
Related Articles
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Diagram grids
P. 311
Mouse gestures
You can create shapes, connect shapes, or perform certain operations through pressing and dragging your right mouse button. You can gain more
information in the Mouse gestures page.
Jumping to shape
When you are looking for a shape, a diagram or a model element, you can make use of the jump to feature to enter its name and jump to it
immediately. It's like a commonly-known search function, but a faster approach.
Layer
Layer provides a logical shape division in diagram. For example, a comment layer for annotation shapes. You can hide, lock and set active to a layer.
P. 312
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.
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:
1.
Click Magnet
2.
Move the mouse on the diagram pane where you would like to move diagram elements.
P. 313
3.
Hold onto your mouse and move the line horizontally or vertically.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 314
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 finished drawing a shape.
When the shape is done, release the mouse. After the shape is created, the action description will be shown on the top right corner of the
diagram.
Class created
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
2.
If draw the line until outside the class, a public operation will be created.
Mouse gestures
P. 315
Connecting shapes
1.
Draw a line from one shape to another.
Association created
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.
Mouse gestures
P. 316
Description
Layout diagram
Close Diagram
Thumbnail view
Mouse gestures
P. 317
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.)
Description
Action State
Sub-Activity
Swimlane
Initial State/Final State (If there is no Initial State, an Initial State will be created. If there is no Final State, a Final State will be created.)
Description
Sub-Process
Pool/Task
Mouse gestures
P. 318
Horizontal Lane
Vertical Lane
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.)
Description
Lifeline
Actor
Package
Description
Mouse gestures
P. 319
Component
Instance Specification
Package
Description
Class
Interface
Collaboration
Collaboration Use
Description
Process
External Entity
Data Store
Description
Node
Component
Mouse gestures
P. 320
Instance Specification
Package
Description
Entity Bean
Message-Driven Bean
Session Bean
Package
Description
Entity
Add column
Description
Interaction
Decision Node
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.)
Mouse gestures
P. 321
Description
Node
Description
Instance Specification
Class
Package
ORM diagram
Icon
Description
Class
Entity
Package
Description
Diagram Overview
Mouse gestures
P. 322
Icon
Description
Package
Sequence diagram
Icon
Description
Lifeline
Actor
Alt
Loop
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.)
Description
State
Concurrent State
Mouse gestures
P. 323
Submachine State
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
Description
Use Case
Actor
Package
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Mouse gestures
P. 324
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 Diagram > Jump > to Element in Active Diagram... from the toolbar or press Ctrl+J to unfold Jump to dialog box.
2.
Apart from jumping to element in active diagram, you can also jump to any element within the project. You may select Diagram > Jump > to
Element... from the toolbar 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.
Enter a word in the text field, a list of model element's name that starts with the word you typed will be shown .
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 spotlighted on the active diagram.
Jumping to shape
P. 325
Shape is spot-lighted
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.
Jumping to shape
P. 326
Jumping to diagram
1.
To do so, select Diagram > Jump > to Diagram... from the toolbar or press Ctrl+Shift+D to show Jump to dialog box.
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.
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.
Jumping to shape
P. 327
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.)
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Jumping to shape
P. 328
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Jumping to shape
P. 329
When you move a shape, other shapes within the same group will also be moved.
P. 330
Click Ungroup
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 331
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.
P. 332
Right click on the diagram's background, select Diagram Content > Show/Hide > Show/Hide Diagram Elements... from the pop-up menu.
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.
NOTE:
If a shape is selected from Show list, the related shape(s) of the selected shape will be also removed to Hide list.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 333
Layer
If you have ever experienced how hard it is to deal with a number of shapes, try the application of multi-layers. Visual Paradigm 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.
Click on View > Layers from the toolbar.
2.
In the Diagram Layers window, click Create new layer button to create a new layer.
Layer
P. 334
Layer
P. 335
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Layer
P. 336
After the shape is non-selectable, click the shape cannot make it to be selected. Neither will the shape to be selected by mouse dragging on
diagram.
3.
Therefore, the non-selectable shape(s) will not be moved when other shapes are moved.
Select Selectable
P. 337
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 338
P. 339
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 a view and
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
confirm.
P. 340
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 341
P. 342
Right click on the diagram overview and select Associate to Diagram... from the pop-up menu.
3.
Select a diagram that you want to be shown on diagram overview and select OK button.
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.
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.
P. 343
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 344
Take BPMN as an example. Task and sub-process are two notations introduced by BPMN. They both model activities to do within a business process.
If you need to model an order processing system with BPMN, you may initially use a BPMN task to model the Ship Order activity. As the design
evolves, let's just say that shipping order turns out to be much more complex than what vyou thought and involves several sub-activities like arranging
shipment, delivering goods, collecting payment, etc. To depict that, you need to convert the atomic task to a sub-process, not only for representing its
complex nature but also for making it possible to drill down the process and model its details.
Correcting Mistakes
Things are never perfect and so are our work. Sometimes your knowledge in modeling language falls short. You may mistakenly apply a wrong type of
model element in your design. For example, you could have incorrectly treated UML activity as UML action. When you realize it is a mistake, you want
to correct it.
Describe More Precisely What You Want to Express
Some notations are sub-types of a more general one. For example, send-signal-action is a kind of UML action that creates a signal from its input and
transmits it to the next object. While using UML action in a broad manner is not exactly wrong, using send-signal-action would reflect the truth more
precisely.
Changing Model Element Type
1.
Right click on the desired shape and select Related Elements > Change Type... from the popup menu.
2.
In the Change Model Element Type window, enter the type to convert to.
4.
Due to the difference in the element type, some properties, relationships and tagged values may no longer be compatible after the conversion
and are forced to be discarded. In the Change Model Element Type window, you will find the properties, relationships and tagged values that will
be kept and discarded after the conversion. The data that will be discarded is put on the left hand side while the resolvable data is on the right.
Click OK at bottom right.
P. 345
Note that the undo history will be cleared after the conversion, meaning that you cannot perform any undo action after it. Click Yes to confirm the
change and to return to the diagram.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 346
Move your mouse pointer over the container shape that you want to freeze.
2.
Press twice. Note that it is NOT a double click. Instead, it is two separate presses, with a delay in between. When success, you can see the
container shape painted with a grid background.
Using InstantFreeze
3.
Now, you can select shapes freely inside the container shape without worrying about moving the container shape in background.
Selecting shapes
4.
When you finish, unfreeze the container shape either by pressing the Esc key or by clicking once outside the container shape.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 347
Callout shape
A speech-bubble like shape made for annotation purpose. It's pointer can be adjusted to point to specific position.
Freehand shape
A set of shapes that can be bended to different styles to fit in different ways of annotation.
P. 348
UML note
In Visual Paradigm, UML notes can be created and attached to a shape via an anchor connector. The premier advantage of using UML notes is to
annotate 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.
Release the mouse. The shape is connected with the newly created note.
Note created
Start editing
2.
Resizing
3.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
UML note
P. 349
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.
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.
NOTE:
You can adjust not only the pointer's direction, but also its length.
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.
Callout shape
P. 350
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Callout shape
P. 351
Freehand shapes
Freehand shapes are multi-functional features in Visual Paradigm. 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 but 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.
Sample
Pencil
Pen
Calligraphic Tool
Connector
Line
Label Line
Path Rectangle
Rectangle
Round Rectangle
Freehand shapes
P. 352
Round Rectangle 2
Diamond
Parallelogram
Trapezoid
Isosceles Trapezoid
Path Ellipse
Ellipse
Arc
Chord
Pie
Regular Polygon
Isosceles Triangle
Freehand shapes
P. 353
Hexagon
Arrow
Spiral
Text
Word Art
Release the mouse and new freehand shape will then be created.
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.
Freehand shapes
P. 354
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
By combining several other calligraphic shapes, you can create a complete diagram.
Calligraphy example
Connecting shapes
2.
Release the mouse and a new connector will be created between them.
Freehand shapes
P. 355
A line is created
1.
A curve connector
1.
2.
Click on the specified location to split. A new point at where you have clicked will turn into orange.
Splitting line
3.
Freehand shapes
P. 356
Line created
1.
Select a straight line for a second to wait for the fine editing selectors popping out.
Press on the straight line. Drag it to bend into your preferred direction.
1.
2.
Click on the specified location to split. A new point at where you have clicked will turn into orange.
Splitting line
3.
Freehand shapes
P. 357
Double click on the line. Enter the name for the line.
4.
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.
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 shapes
P. 358
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.
Drawing parallelogram
Click on the diagram to create a parallelogram shape.
Drawing trapezoid
1.
Click on the diagram to create a trapezoid shape.
2.
You can adjust the slope by dragging the fine editing selectors in yellow.
You can reshape the Isosceles Trapezoid by dragging the fine editing selectors in yellow.
Freehand shapes
P. 359
Drawing ellipse
Click on the diagram to create an ellipse shape.
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.
2.
You can extend the line by dragging on the fine editing selectors in yellow.
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.
Freehand shapes
P. 360
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.
Drawing hexagon
Click on the diagram to create a hexagon shape.
You can modify the outline of shape by dragging the fine editor selectors in yellow.
Freehand shapes
P. 361
2.
Drawing spiral
1.
Click on the diagram to create a spiral shape.
2.
Inserting text
1.
Click on the diagram to create a text shape, and input the text. You can press Enter to insert line break.
Freehand shapes
P. 362
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Freehand shapes
P. 363
Resource referencing
To include more information you can link to both internal and external material as reference. In this chapter, you will see how to refernece to shape,
diagram, external file, folder and URL, as well as how to add sub-diagram.
Resource referencing
P. 364
1.
Move the mouse over a shape to add reference, click the resource icon References and select Add File... from the pop-up menu.
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.
1.
Move the mouse over a shape to add reference, click the resource icon References and select Add Folder... from the pop-up menu.
When the specification dialog box pops out, click the ... button in Path to select a folder path.
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.
1.
Move the mouse over a shape to add reference, click the resource icon References and select Add URL... from the pop-up menu.
When the specification dialog box pops out, enter the URL path. You may also enter the URL name and the description for the URL.
P. 365
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.
4.
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.
3.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 366
In Select Diagram window, either select the existing diagram(s) to reference to or click on the New Diagram and Select It button (at the bottom
part of the window) to create one and reference to it.
You may enter the description for the diagram in the specification window. Finally, click OK to confirm the reference creation.
P. 367
Enter description
Reference to shapes
1.
Move the mouse over a shape, press its resource icon References and select Add Shape... from the pop-up menu.
2.
In Select Shape window, expand the diagram node(s) and then select the shape(s) to reference to. Click OK.
3.
You may enter the description for the reference in the specification window.
4.
In Select Model window, expand the tree node(s) and then select the model element(s) to reference to. Click OK.
3.
You may enter the description for the reference in the specification window.
4.
Opening a reference
Move the mouse over a shape. Click its resource icon References and select a reference to open it. 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. If you select a model element to open, it will open the specification of that model element.
Open a 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 window pops out, double click on the row of reference you want to enter its description or modify it.
3.
4.
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 window pops out, select a reference to be removed on the list and press Remove button to delete the selected
reference.
3.
P. 368
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 369
Model Data - The diagram from which you open the Reference Mapping Editor as well as its containing diagram elements are listed on the left
hand side.
References - The file, folder, URL, diagram, shape and model element being added to any model data as references are listed on the right hand
side. You can add extra reference material manually if you want to add references. For details, read the next section.
Reference Mapping - References between model data and reference material are represented by mapping connectors that appear on the middle
of the editor.
If you want to know the reference material added to a model element, click on the model element on the left hand side. Its references will be highlighted
in green.
If you want to know the utilization of a piece of reference material, click on the reference material on the right hand side. The elements that reference
the selected reference material will be highlighted in green.
P. 370
Adding a Reference
To add a reference to model data:
1.
Select the model data on the left hand side. If you want to add reference to multiple items, press Ctrl or Shift for a multiple selection.
Hold your mouse button and drag to the target reference material for creating a reference.
Adding a reference
3.
Release the mouse button to create the reference. You will see a connector added between the selected model data and reference material.
Reference added
You may want to add reference to a material that is not currently listed on the right hand side. In such case, you have to add the material manually first,
and then add reference. To add a reference material:
1.
Click the add button at the top of the reference material list on the right hand side.
P. 371
3.
Select the model data or reference material. You can press Ctrl or Shift for a multiple selection.
Re-order an actor
3.
Deleting References
To delete a reference, select it and press the Delete key to delete it. Again, you can delete multiple references at a time by pressing Ctrl or Shift key to
select multiple references.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 372
Add a sub-diagram
2.
3.
4.
Click OK.
NOTE:
Inserting a sub diagram on a model element, all child model elements of the sub diagram will also be attached.
In the Add Sub Diagrams window, select the diagram(s) to add as the sub-digram of the selected shape.
3.
Click OK.
In the specification window, select a sub diagram that you want it to be removed from the list and click Remove. When the Confirm Remove
dialog box pops out, click Yes button to confirm the deletion.
3.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 373
As a result, references resource icon and sub-diagrams resource icon are shown.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 374
State Machine Diagram - Creating a sub state machine (diagram) from an Submachine state
By performing any of these steps, you will see the in/out flow objects in the sub-diagarm, provided that a flow exist.
Reading In/Out Flows
An in flow
No.
Description
The initial node of the sub-diagram, which is conceptually connected from the parent diagarm.
The model element that connects to the parent element of the sub-diagarm.
P. 375
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 376
P. 377
To launch Shape Editor, select Windows > Integration > Shape Editor... from the toolbar.
2.
When shape editor unfolds, you can create a shape by creating a gallery in advance. It is because a shape needs to be created under a stencil,
while a stencil is put under a category of a gallery.
Shape Editor
3.
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 po-pup menu.
Add a gallery
4.
To create a stencil, right click on a category and select Add Stencil from the pop-up menu. The newly created gallery is named as Gallery1 by
default. If you want to rename it, right click on it and select Rename from the pop-up menu. Enter your preferred gallery name in the pop-up
Input dialog box and press OK button to confirm.
Naming a gallery
5.
To create a category, right click on a gallery and select Add Category in the pop-up menu. Enter the category name in the pop-up Input dialog
box and click OK button to confirm.
P. 378
Add a category
6.
To create a stencil, right-click on a category and select Add Stencil from the pop-up menu. The newly created stencil is named as Stencil 1
by default. If you want to rename it, right click on it and select Rename from the pop-up menu. Enter your preferred stencil name in the pop-up
Input dialog box and press OK button to confirm.
Add a stencil
7.
( New Shape) button in the bottom part of the Stencil pane to create a blank drawing for drawing the shape.
Add a shape
8.
Create your preferred shape on the pane and you can also format its color in Fill tab of Format pane.
P. 379
To save the drawing by selecting File > Save from the main menu.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 380
Open the Stencil pane by selecting View > Panes > Stencil from the toolbar.
Click on the
(Add Stencil) button in the top of Stencil pane. Select a category from the pop-up list of gallery. Select the stencil to add. The
stencil is then added to the Stencil pane.
Add a stencil
NOTE:
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.
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.
Press on the source shape, hold the mouse button, move the mouse cursor to the target shape and release the mouse button.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 381
P. 382
2.
In the Customize UI window, select the menu(s)/toolbar button(s)/pop-up menu(s) to hide and click on the > button to hide them.
Click OK button to confirm. By restarting the application, the selected user interface componenets will be hidden.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 383
2.
3.
4.
Check Change application font in the Font section. Adjust the font type and size.
5.
Click OK.
6.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 384
Using model
Concepts about model will be discussed in this page.
P. 385
Using Model
A model is a component that you can create in your project to organize shapes and diagrams which acts like a folder. Modelers generally use models
to differentiate stages or nature within project such as an "as-is" model for storing diagrams and model elements about the current system and a "to-be"
model for recording blueprints of the system to be implemented. The use of model improves not only the structuring of work but also the performance
by reducing the number of root model elements to load. As a result, you can look up diagram or model element you need more easily.
To create a model:
1.
Open the Project Browser by selecting View > Project Browser from the toolbar.
2.
3.
In the list of model and package, select the parent of the model to be created.
New model
5.
Specify the model's details in the Model Specification window and click OK to confirm.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Using model
P. 386
Select View > Project Browser from the toolbar to open the Project Browser.
2.
When the New Diagram window pops out, select a specific category and the target diagram under the selected category. The new diagram name is
[Diagram Type]1 by default, you can rename it by entering in Diagram name text field. Click OK button to confirm and close the window.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 387
Select View > Project Browser from the toolbar to open the Project Browser.
2.
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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 388
Using stereotypes
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 this chapter, you will learn things about stereotypes and see how to apply stereotypes in
your model.
Configure stereotypes
Shows you how to configure a stereotype like to define its color and add tagged values.
Using stereotypes
P. 389
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.
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.
NOTE:
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.
P. 390
2.
Depending on the type of robustness analysis symbol you want to create, apply either boundary, control and entity stereotype to the 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.
Different presentations of a model element with a stereotype that has icon defined
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 391
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 Windows > Configuration > Configure Stereotypes... from the toolbar.
2.
Click on the drop down menu Scope at the top left corner of the Configure Stereotypes window, select whether to configure stereotypes in
workspace or in the opening project.
NOTE:
3.
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.
To configure stereotype only in current project, you must select Project as scope.
Alternatively, select Workspace but let the option Apply changes to stereotypes in current project on.
Select the type of model element that you want to add stereotype or edit its existing stereotypes.
If you want to edit an existing stereotype, select the stereotype and click Edit....
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.
Configure stereotypes
P. 392
Name
Description
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.
A list of categorized model element types. You can select a type to configure
its stereotypes.
Stereotypes
Available only when scope is Workspace, this option cause the stereotype
configuration applies to both stereotypes in workspace and project, when
pressing OK .
Duplicate
Import
Export
Add
Click this to add a stereotype for the selected type of model element.
Edit
10 Remove
11 OK
12 Cancel
Click to discard the changes (if any) and close the dialog box.
13 Help
Configure stereotypes
P. 393
You can assign stereotype to a shape easily by right clicking on that shape
and selecting Stereotypes > %STEREOTYPE% from the popup menu. This
option is to control the number of stereotype to be listed for selection. The
larger the number, the longer the popup menu, the easier you can find the
desired stereotype.
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 shown 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 Windows > Configuration > Configure Stereotypes... from the toolbar.
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
Model element
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
Configure stereotypes
P. 394
The value of tag must be a number that consists of one or more digits.
Boolean
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
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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Configure stereotypes
P. 395
In any diagram, right click on the Selector from the diagram toolbar and 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.
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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 396
Getting started
P. 397
Edit project
P. 398
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 399
Select Team > Login from the toolbar of Visual Paradigm. If you have no prior connection to any server, you are then prompted to enter the
login details of VPository. If your team have already subscribed to VPository, enter your login details. If you want to subscribe to VPository, click
here for details . If you want to use Teamwork Server, click Other Repositories and enter the login details.
Login window
2.
Click Login.
3.
Since this is the first time you login to the server, you are prompted the Open Project window with available projects listed. Click Cancel.
4.
Now, you are connected to the server. When you select Team > Login again, you can then open Teamwork Client.
Name
Main menu
Description
P. 400
Logout: Logout the server. After you choose it, you will not be able to execute any actions.
Project: Provides an access to main functions, such as commit and update.
Manage Project: Select a project that you get involved in.
Import Project to Repository: Import a new project to the server.
Commit: Commit your current modified project to the server.
Update: Update the latest copy of project from the server to your computer.
Checkout: Click it to checkout the project selected in Projects list. It will be disabled when the selected
project has already been checked out.
Open: Click it to open the checkout project on your computer.
Tag: Create a new tag for your current project. It allows you to produce a static release version of
project.
Branch: Create a new branch for your current project. It becomes a duplication of project to perform
isolated changes.
Merge: Combine the selected branch(es) with the trunk (main project). When some changes made in
branch, it will be made in trunk as well.
Switch: Switch from a branch/ tag to another branch/ tag or from the trunk (main project) to a branch/
tag and vice versa.
Delete Branch: Select a branch to delete, for preventing accidental modifications in branch.
Reset Password: Reset your account's password.
Revert Local: Click it to undo un-committed changes made on the local project copy.
Repository:
Synchronize Design Pattern to Server: Synchronize the template files stored in workspace with those
stored in repository. When a conflict occurs, you will be asked which design template files to keep.
Maintenance: All the functions under the Maintenance menu are prepared for diagnosis purposes. You should
not run them unless you are requested by Visual Paradigm support team. And when you are requested to
execute any maintenance function, you will be briefed.
2
Toolbar
Login: Log into the server. After you choose it, you will be able to execute all actions.
Logout: Log out the server. After you choose it, you will not be able to execute any actions.
Manage Project: Select a project that you get involved in.
Import Project to Repository: Import a new project to the server on the list.
Update: Update the latest copy of project from the server to your computer.
Commit: Commit your current modified project to the server.
Checkout: Click it to checkout the project selected in Projects list. It will be disabled when the selected project
has already been checked out.
Open: Click it to open the checkout project on your computer.
Revert Local: Click it to undo un-committed changes made on the local project copy.
Check for Update: Click it to check whether the project is up-to-date or not.
Tag: Create a new tag for your current project. It allows you to produce a static release version of project.
Branch: Create a new branch for your current project. It becomes a duplication of project to perform isolated
changes.
Merge: Combine the selected branch(es) with the trunk (main project). When some changes are made in
branch, it will be made in trunk as well.
Switch: Switch from a branch/ tag to another branch/ tag or from the trunk (main project) to a branch/ tag and
vice versa.
Delete Branch: Select a branch to delete, for preventing accidental modifications in branch.
By checking it, projects that have been checked out before will all be displayed. By unchecking it, only projects
checked out by the current member will be displayed.
Repository
It refers to the list of available project(s). Select All from the drop-down menu means all projects managed by all eligible members who have logged
into server in this workspace will be listed. On the other hand, the project(s) managed by a specific member can be selected from the drop-down
menu. If you uncheck Show all login projects and do not select the current member in Repository, no project will be listed.
Projects
Project name
File path
The path of the selected project file. It is shown only when project is checked out from the server.
Checkout time
It displays the date and time of your first checkout for the project.
P. 401
Revision
It displays the revision of your local project copy. Note that the revision here does not always mean the latest
revision on the server.
10 Status
It displays the status of selected project, such as "Not Checked Out" will be shown when the project has not
been checked out yet.
11 Comment
It shows the textual description of selected project written by administrator when creating project.
12 Update
13 Commit
14 Checkout
15 Open Project
Click it to open the checkout project on your computer. If the project has not checked out yet, it will perform a
checkout prior to opening project.
16 Close
17 Help
Name
Description
Select the number of latest project revision to view from the drop-down menu.
19 Project revisions
It lists all the latest project revisions. The number of revisions is in accordance with the show drop-down
menu.
20 Open
21 Export
22 Revert Selected
23 Commit Comment
25 Modified diagrams
27 Modified files
P. 402
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 403
Checkout project
Checkout project is a process that you download a managed project from repository to your computer and start working with.
Commit
Commit refers to the process of uploading local modifications to the server.
Update
Update is the process of refreshing your current copy by merging changes that others have made and committed previously to server.
Import project
Import project refers to the process of adding project file in server so that team members can check that out and start working on it.
Basic features
P. 404
2.
Enter the cloud entry point of VPository, login email and password, and then click Login. If you are using Teamwork Server, click Other
Repositories, select VP Teamwork Server as Server, enter host, email, password and then click Login.
3.
Since this is the first time you login to the server, you are prompted the Open Project window with available projects listed. You have either
or both read and update right to these projects. You can start working on a project by selecting it and click Open at bottom right, or simply by
double clicking on the project thumbnail.
Checkout project
2.
From the list on the left hand side, select the projects to checkout. You can perform a multiple selection by first pressing the Ctrl key.
3.
Right click on the selection and select Checkout from the popup menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 405
Commit
Commit refers to the process of uploading local modifications to the server. As team members make changes in a project, they can share their works
by committing those changes to the server. By committing, changes are merged from working copy to server copy. During merging, a conflict may be
caused when there is a contradiction between team members. Decision have to be made whether to keep the current modified copy (i.e. overwrite) or
to accept others' copy (i.e. revert). All conflicts have to be solved before proceeding to commit. To commit changes:
1.
2.
If the change you made contradicts the change made by another team member, this will result in a conflict. You must resolve all the conflicts in
order to continue. For details, read the Resolving conflicts section below. Clear the conflicts, if any, and continue.
3.
The Commit window displays the changes to be committed to the server. Click Commit to proceed.
P. 406
No.
Name
Description
Diagrams tab
The model element level changes to be performed when you execute commit.
Nicknames tab
Files tab
Changes tab
Filter
When you commit, local changes will be merged to the server copy and meanwhile, changes in server copy will
be merged to the local copy, too. The filter allows you to filter the tree on the left hand side to list the commit
changes, which are changes to perform on server copy, and/or update changes, which are changes to perform on
local copy.
Expand All
Collapse All
Tree
10 Compare
Click this button to compare local and server copy side by side.
11 Preview
The preview of the element as selected in the tree on the left hand side.
12 Project name
13 Checkout revision
14 Checkout time
16 Commit comment
You can give a comment for your current commit by typing here.
17 Commit
Proceed committed
18 Cancel
Select Team > Utilities > Open Teamwork Client... from the toolbar.
2.
From the list on the left hand side, select the projects to commit.
3.
Right click on the selection and select Commit... from the popup menu.
Resolving conflict
If the change you made contradicts with the change made by another team member, this will result in a conflict. For example, your colleague has
renamed a class from School to University and performed a commit, and then you rename the same class to College and perform a commit. This
produces a conflict.
When a conflict occur, you must resolve it in order to continue committing. You have to resolve conflict either by overwriting or reverting the change.
Overwrite means to adopt the server copy's change, while Revert means to adopt the local's change.
P. 407
Name
Description
List of changes to be performed. Initially only conflicted changes are listed. You can uncheck Show conflicts
only to list all changes.
Preview
The preview of the element as selected in the tree on the left hand side.
Conflicted properties
Open Specification
Click on this button to open the specification of element selected in the tree on the left hand side.
Property name
Local change
Original value
The value of property before changed. In other words, it is the value in checkout copy.
Server value
Check it to list only conflicted changes in the tree on the left hand side. Uncheck it to list all changes.
10 Overwrite by local
11 Revert to server
12 Preview
13 Cancel
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 408
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 409
Update
Update is the process of refreshing your current copy by merging changes that others have made and committed previously to server. Similar to
commit, update is a process of merging differences instead of overwriting. When any of your changes contradicts the changes others have made, you
will be asked to resolve conflict. All conflicts have to be resolved before proceeding with updating. To update:
1.
Select Team > Utilities > Open Teamwork Client... from the toolbar.
2.
If the change you made contradicts the change made by another team member, this will result in a conflict. You must resolve all the conflicts in
order to continue. For details, read the Resolving conflicts section below. Clear the conflicts, if any, and continue.
3.
The Update window displays the changes to be made upon updating. Click Update to proceed.
Name
Description
Diagrams tab
The model element level changes to be performed when you execute update.
Nicknames tab
Files tab
P. 410
Changes tab
Expand All
Collapse All
Tree
Preview
The preview of the element as selected in the tree on the left hand side.
10 Open Specification
Click on this button to open the specification of element selected in the tree on the left hand side.
11 Property name
12 Server update
13 Original value
14 Update
Proceed updating
15 Cancel
Select Team > Utilities > Open Teamwork Client... from the toolbar.
2.
From the project list on the left hand side, select the projects to update.
3.
Right click on the selection and select Update... from the popup menu.
Resolving conflict
If the change you made contradicts the change made by another team member, this will result in a conflict. For example, your colleague has renamed
a class from School to University and performed a commit and then you rename the same class to College and perform an update. This produces a
conflict.
When a conflict occurs, you must resolve it in order to continue updating . You have to resolve conflict by overwriting or reverting the conflicted change.
Overwrite means to adopt the server copy's change, while Revert means to adopt the local's change.
Name
Description
List of changes to be performed. Initially only conflicted changes are listed. You can uncheck Show conflicts
only to list all changes.
Preview
The preview of the element as selected in the tree on the left hand side.
Conflicted properties
P. 411
Open Specification
Click on this button to open the specification of element selected in the tree on the left hand side.
Property name
Local change
Original value
The value of property before changed. In other words, it is the value in checkout copy.
Server value
Check it to list only conflicted changes in the tree on the left hand side. Uncheck it to list all changes.
10 Overwrite by local
11 Revert to server
12 Next
13 Cancel
Reminder of updating
When your teammates have committed their work to server, you will see a notification appear at the bottom right of Visual Paradigm window, reminding
you to perform an update to obtain the changes. By clicking Update, the latest changes will be updated from server to your project. The effect is like
performing a manual update but without the need to go through the menus/toolbars.
Update notification
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 412
Select Team > Utilities > Revert Local from the toolbar.
2.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 413
2.
In the Save Project window, keep VPository/ VP Teamwork Server selected at the top of the window. If necessary, change the project name.
3.
The Enable PostMania option allows you to enable the social networking platform bundled by VPository/VP Teamwork Server. If you want to
allow you and your teammates view and comment on your design via PostMania, keep the option enabled.
4.
Click Import to immediately create the opening project in server. By doing so, you will be the only one who can access the project. But of
course, you or the manager can add other members to the project later on via the web interface.
5.
If you want to assign members to your project now, click Add Project Member>. In the Project Members screen, grant either or both the read
and update rights to the other members/groups. The Read permission means that member can only checkout the project and read its content.
The Update permission means that member can both read the project content and commit changes to server. When ready, click Import to
continue.
In the Teamwork Client window, select Project > Import Project to Repository from the main menu.
3.
Import project
4.
P. 414
5.
Click Import to immediately create the opening project in server. By doing so, you will be the only one who can access the project. But of
course, you or the manager can add other members to the project later on, via the web interface.
6.
If you want to assign members to your project now, click Add Project Member>. In the Project Members screen, grant either or both the read
and update rights to the other members/groups. The Read permission means that member can only checkout the project and read its content.
The Update permission means that member can both read the project content and commit changes to server. When ready, click Import to
continue.
In the Teamwork Client window, select Project > Import Project to Repository from the main menu.
3.
4.
Next to the name field you can see the option Create folder for project. When checked, a folder with same name as project will be created to
contain the project.
5.
Project sources
6.
In the Repository pane, select the folder where the project file will be stored.
7.
You can optionally describe the import action by entering your comment in the Comment field.
8.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 415
Tagging
Tag refers to a named version of your work at a point of time on the trunk.
Export revision
Export revisions to project files.
Diagram protection
You can prevent a diagram from being edited by another team member by locking it. In this chapter, you will see how to protect diagram by locking.
Advanced features
P. 416
Branching
In terms of team collaboration, a trunk refers to the main stream of development. If you create a new project, you will spend the majority of your time
making changes and committing them to the trunk of your repository.
Branch is defined as a copy of work derived from a certain point in the trunk. It sets up an extra space for users to work on and make modifications
without disturbing the trunk. As soon as the modifications in branch are done, you can merge it back to the trunk.
Creating a branch
1.
Select Team > Utilities > Branch... from the toolbar.
2.
When the Create Branch window appears , enter its name in the Branch Name field for your new branch and select whether to start working on
the branch or to stay in trunk. Click OK to confirm.
For Teamwork Server, you can create branch from a specific revision of trunk by selecting Specific
revision in the repository and entering the revision number. On the other hand, select HEAD revision in the repository
if you want to create a branch from the latest revision in trunk. Finally, click OK button to confirm.
Merging a branch
When the development activity of branch has been completed, you can optionally merge the branch back to trunk. To merge:
1.
Work in trunk. Select Team > Utilities > Merge... from the toolbar.
2.
When the Merge window appears, select the branch you want to merge to the working trunk. A specified revision of project can be merged both
from/to by selecting From Revision and entering the revision number of from and/or to revision. You can also click on the Show Log... button to
popup a window with revisions listed and then select the revision from the list. Click OK to continue.
Branching in server
P. 417
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Branching in server
P. 418
Tagging
Tag refers to a named version of your work at a point of time on the trunk. The best application of a tag is to create it for every major release or
milestone. Note that you cannot merge a tag to the trunk nor commit it to the server.
To create a tag:
1.
2.
In the Create Tag window, enter the name of the new tag in the Tag Name field. Click OK to confirm.
NOTE:
For Teamwork Server user, check HEAD revision in the repository if you want to create a tag from the latest revision of trunk while
check Specific revision in the repository if you want to create a tag from a specific revision.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Tagging in Server
P. 419
Revert a revision
A new revision will be created for the result of reverting. Therefore, you are asked to commit here. Sometimes, the undo action may cause a conflict
with a more recent revision or revisions. Just like the normal commit process, you must resolve all the conflicts in order to continue committing. You
have to resolve conflict either by overwriting or reverting the change. Overwrite means to adopt the server copy's change, while Revert means to adopt
the local's change.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 420
Export revision
You can export revision(s) from server to your machine for checking the project content of certain phase of development. You can export specific
revision, or all revisions.
Export the selected revision
1.
Select Team > Utilities > Open Teamwork Client... from the toolbar.
2.
3.
Select the revisions(s) you want to export under Project revisions. Click Export and choose Export selected revisions... from the pop-up
menu.
In Select Directory window, select an existing folder or make a new folder for storing the selected revision(s). Click OK to proceed.
3.
Click Export and choose Export all revisions from repository... from the pop-up menu.
4.
In Select Directory window, select an existing folder or make a new folder for storing all revisions. Click OK to proceed.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 421
NOTE:
Select the node in Teamwork Files pane for creating file/folder. You may select the project root node or a folder node.
2.
Click on the plus button in Teamwork Files pane and select Add Files/Folder... from the popup menu.
Add file/folder
3.
In the Add window, select the file or folder to add and click Open.
4.
You are prompted to confirm copying the file or folder to workspace. Click OK.
P. 422
Select the node in Teamwork Files pane for creating folder. You may select the project root node or a folder node.
2.
Click on the plus button in Teamwork Files pane and select New Folder... from the popup menu.
Create a folder
3.
Enter the name of folder in the popup dialog box. Click OK. Once a folder is created, you may add files/folder in it or drag existing teamwork
files/folders into it.
Folder added
P. 423
Select Windows > Application Options from the toolbar to open the Options window.
2.
In the Options window, select User Path on the left hand side.
3.
On the right hand side, click Add... and select Project Files Path from the popup menu.
4.
5.
From now on, when you try to add file reference to model elements, you can select the shortcut Project Files Folder in file chooser to jump to the
folder where the teamwork files are listed.
P. 424
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 425
Diagram protection
When you are working on a project with your team members, you probably don't want your work to be modified by others by mistake. To protect your
work, you can lock your current diagram with password to make it uneditable by others.
Locking diagram
1.
To lock a diagram which you don't want it to be modified by others, right click on the diagram's background and select Diagram Content >
Lock ... from the pop-up menu.
2.
Enter your password in the pop-up Lock window and then click OK button. For your safety, always keep your password secret.
Enter password
Your diagram is then locked. Here is a detailed description of the options in the Lock window:
Lock by password: If you check this option, you need to set password for locking diagram. If you uncheck it, you don't have to enter password
but you can still lock the diagram.
Save password: You can save your password in the project under your user account by checking this option. Thereafter, you don't have to
enter password when you edit the diagram. Otherwise, you need to enter password to edit the diagram after you uncheck it.
Show password: Check this option to reveal the password. The password will be hidden by asteriks when you keep it unchecked.
Trying to edit a locked diagram
If your team members want to modify any model elements of the locked diagram, they need to provide the password set by you in the pop-up
Authorization Required window in order to proceed modification.
If you try to modify any model elements of the diagram locked by you, an Authorization Required window will prompt out. Click Remove Lock button
if you want to unlock the diagram permanently. Click Unlock button if you want to unlock it temporarily.
NOTE:
If you uncheck Save password when you lock the diagram, you will be asked to enter password to edit the locked diagram.
Moreover, you can also unlock the diagram permanently in Configure Lock window. Right click on the diagram's background and select Diagram
Content > Configure Lock... from the pop-up menu. Choose Remove lock and enter password.
Diagram protection
P. 426
Removing lock
You can remove the lock or change the password after you lock the diagram.
1.
Right click on the diagram's background and select Diagram Content > Configure Lock... from the pop-up menu.
NOTE:
2.
Configure Lock... option is available on the pop-up menu only after you have locked the diagram.
In Configure Lock window, choose Change password if you want to change the current password and set a new password; otherwise,
choose Remove lock if you want to remove the lock permanently. Click OK button to confirm.
Remove lock
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Diagram protection
P. 427
Right click on the background of a opening diagram and select Visual History... from the popup menu.
2.
This opens the Visual History window. At the top of the window you can see the diagram name as well as the drop down menu Show, which
controls the kind of difference you want to focus on when comparing revisions. We will talk about it in the coming sections. In the middle,
you see two diagram viewers. The left hand side is the diagram in the latest revision, while the right hand side is the same diagram in an old
revision. You can drag the viewers to pan the diagrams. If you are comparing a model element or a shape instead of a diagram, you will see the
properties of that element/shape listed here.
Under the diagrm viewer on the right, you see the time line. Press on the revision number and drag right or left to move to older or more recent
revisions. The diagram viewer will be updated to show the diagram in the chosen revision. Note that only the revisions that reflect a change in
diagram are listed on the time line. You can slide between revisions to see the evolution of diagram and to stop at certain revision to analyse
and compare that revision with the latest revision, as shown in the viewer on left hand side.
P. 428
A modified class
By clicking on an indicator, you can see a list of modified properties, categorized by diagram level property (e.g. shape position, color, etc) and model
level property (e.g. name, documentation of model element, etc).
The 'Guest' class was named 'Customer' before, and owned an attribute nationality
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 429
To review modifications
2.
Review modifications
3.
If you want to revert ALL the modifications listed in the modification summary, click the Revert button at the bottom of the summary popup.
Revert modifications
4.
If you want to revert a specific modification, move the mouse point below the last modification to show the Details... button. Click on it.
P. 430
The modifications are listed in in a table. You can click on individual modification and then click the Revert button to revert it.
Revert a modification
Click the Restore button in the Delete Details popup to get the shape back.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 431
Using PostMania
PostMania Overview
Learn what PostMania is.
Replying in PostMania
Learn how to reply a post.
Watching Diagram
Learn how to get notified by changes.
PostMania
P. 432
What is PostMania?
PostMania is a tool bundled with VPository that lets you share the diagrams that you’ve created in Visual Paradigm with others, and to collect
their feedback after they have view your diagrams. Very often, you share diagrams with your partners, clients or colleagues to let them confirm
your design or clarify design issues. They can view your diagrams on the web, without any rights to edit them. Here are some of the use cases of
PostMania:
Business user reads the latest business process design for working guidelines
Developer views the latest class diagram to gain get up-to-date system specification and design guideline
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
What is PostMania?
P. 433
Sharing siagram
To share a diagram with teammate means to let him or her view the shared diagram, either through a web browser or through mobile device, and to
allow him or her to give comments on the diagram, or shapes in the diagram.
Sharing works in diagram based, meaning that when you share a diagram with someone, he/she can only view that diagram, but not the other
diagrams, unless the other diagrams have also been shared.
To share a diagram:
1.
2.
Make sure the diagram have been committed to the server. You can only share a diagram that has been committed to server before.
3.
Open the action bar by clicking on the tiny button on the right hand side of the diagram, near the scrollbar, if exist.
Open the PostMania Topic Pane button by clicking on its button in the action bar.
Enter the name and the Email address of the people to share with. PostMania will send invitation Emails to these people, to invite them to join
PostMania for viewing and commenting on the diagram to be shared.
Sharing Diagram
P. 434
NOTE:
7.
You are unable to invite someone who are already a member of the project. If you want to let him/her view the design, ask him open the
project directly from server. If you want to send him a message, just create a post in the PostMania Topic Pane and set him/her to be
the person to notify.
Click Send Invitation Email. PostMania will send the invitees invitation Emails in three minutes.
NOTE:
If the invitee is an existing viewer, and has opened the notification page/view of PostMania, either in a web browser or in Android apps,
he/she will not receive the email notification.
In three minutes, invitees will receive an Email, with subject " %NAME% has shared a diagram with you" where %NAME% is the person who shared
the diagram. He/she has to:
1.
Click on Accept Invitation in the Email to open the New Viewer Form in web browser.
2.
Enter the password and click Accept Invitation in the form. Then, he/she will be redirected to the diagram shared.
Share by link
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Sharing Diagram
P. 435
Notification received
The number indicates the number of unread notifications. The number will be decreased once you have checked a notification. To check a notification,
click on the Message icon in the status bar to open PostMania.
The left hand side of PostMania lists the notifications you received, ordered by the receive date and time, with the latest notification appears at the top
and the earliest one comes last. You can click on a notification to have an overview of that notification.
PostMania
The overview is displayed on the right hand side of PostMania. It consists of a thumbnail of diagram, and a chunk of unread conversation. Note that
the content of a notification consists of only the unread portion of the entire conversation. If you want to view the full conversation, click Open at the top
right corner of the PostMania. By opening a post, the related diagram will be opened, with the post opened in the PostMania Topic Pane, on the right
of the diagram. If the post was created around a shape, that shape will be selected.
You can also reply to a post by entering your message below the conversation and then click Post.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 436
Click on the diagram background to make sure no shape has been selected.
3.
4.
You see a purple mark symbol appear on the diagram. You can add marks to different parts of the diagram for the different areas of concern. To
position a mark, simply drag it to the desired position.
Repositioning a mark
To add a new mark, drag the mark symbol at the bottom right of the diagram, and release it at the desired position.
Create a mark
5.
6.
Entering comments
You can optionally attach file reference to each of your post content. To attach file(s), click on the attachment button at the bottom of the post
box.
P. 437
Specify the member to notify in the To field. Selected members will receive Email notification about your post.
Click Post. Members selected to notify and members who followed the diagram will receive Email notification about your post.
Posting to shape
1.
Open the diagram that contains the desired shape.
2.
3.
4.
5.
Specify the member to notify in the To field. Selected members will receive Email notification about your post.
P. 438
Click Post. Members selected to notify and members who followed the diagram will receive Email notification about your post.
Open the specification window of shape by right clicking on the shape and selecting Open Specification... from the popup menu.
2.
3.
Create post in the PostManic Topic Pane on the right hand side of the specification window.
Open the flow of events editor of use case by right clicking on the use case and selecting Open Use Case Details... from the popup menu.
2.
3.
Create post in the PostManic Topic Pane on the right hand side of the procedure editor. You can select the step to comment, on the left hand
side of the working procedure editor.
P. 439
Open the working procedure editor by right clicking on the background of business process diagram and selecting Show Procedure Editor from
the popup menu.
2.
3.
Create post in the PostManic Topic Pane on the right hand side of the procedure editor. You can select the step to comment, on the left hand
side of the working procedure editor.
Replying a post
To reply a post:
1.
Open the post to reply. You can open it from the PostMania Topic Pane or from the notification page.
Opening a post
2.
P. 440
You may specify the member to notify in the To field. Selected members will receive Email notification about your post.
4.
Click Post.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 441
Following Post
If you want PostMania to inform you when certain post has been replied, you can follow that post. By following a post, you will receive a notification
when reply has been made to that post, like this:
Notification received
The number indicates the number of unread notifications. The number will be decreased once you have checked a notification. To check a notification,
click on the Message icon in the status bar to open PostMania.
To follow a post:
1.
Open the post to reply. You can open it from the PostMania Topic Pane or from the notification page.
Opening a post
2.
Follow diagram
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Following Diagram
P. 442
Instant Reverse
Instant reverse is a process to produce UML class model from a given input of source code. In this chapter, you will learn how to make use of Instant
Reverse to reverse engineer UML class model from source code in specific language.
Instant reverse Java sources and classes
Reverse engineer class model from Java (.java, .class, .jar, zip)
Instant reverse C++ header files
Reverse engineer class model from C++ header files.
Instant reverse .NET dll and exe files
Reverse engineer class model from .NET dll/exe.
Instant reverse CORBA IDL Source files
Reverse engineer class model from CORBA IDL.
Instant reverse Ada 9X Source files
Reverse engineer class model from Ada 9x source files.
Instant reverse XML
Reverse engineer class model from XML files.
Instant reverse XML Schema
Reverse engineer class model from XML schema files (.xsd).
Instant reverse hibernate mapping files
Reverse engineer class model from Hibernate mapping files.
Instant reverse PHP 5.0 Source files
Reverse engineer class model from PHP 5.0.
Instant reverse Python
Reverse engineer class model from Python.
Instant reverse Objective-C
Reverse engineer class model from Objective-C.
Instant reverse Java sources to sequence diagram
Reverse engineer sequence diagram from Java source files.
Instant Reverse
P. 443
3.
Add the file or folder path of source by clicking on the appropriate Add button at the right hand side of the window. There are four kinds of
supported sources: Jar file, class folder, a zip of source or a folder of source files.
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.
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.
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.
P. 444
Name
Description
Language
Source paths
Add Jars
Add zips
Set model
Set the model for placing the reversed UML classes into.
Remove
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.
By checking, this means to form indexes to the source path(s) instead of actually reversing them. For details
about on demand reverse engineering, refer to the section below.
12 Reverse to diagram
Analyze the sources and form class diagram/package diagram when reverse.
13 OK
14 Cancel
15 Help
P. 445
NOTE:
NOTE:
If you do not want Visual Paradigm to ask you for forming diagram next time you perform instant reverse, uncheck Show this window
after instant reverse.
NOTE:
The Form Diagram window will only pop up when you were reversing source with on-demand turned off. If you have performed an ondemand reverse engineering, you need to form diagram manually. For details, read the previous section.
P. 446
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 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 the association relationships between the selected elements and their navigable classes
(targets) in new diagram.
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).
Presentation Options
Option
Attribute options
Description
Operation options
Type options
Select Tools > Code > Instant Reverse... from the toolbar.
2.
3.
Specify the path of the source file or the folder that contains those files.
P. 447
5.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 448
3.
Specify the path of the source file or the folder that contains those files.
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 window, either select an existing model, or create one by clicking New Model.
3.
Click OK to confirm.
5.
6.
Upon finishing, you will see the Instant Reverse Form Diagram window 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.
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.
P. 449
Name
Description
Language
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.
Path
Exclude
Encoding
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.
Advanced Options
Reverse to diagram
Whether or not to reverse engineering class diagram/package diagram from source files. UML packages and the
relationships in between will be produced.
OK
10 Cancel
11 Help
P. 450
NOTE:
If you do not want Visual Paradigm to ask you for forming diagram next time you perform instant reverse, uncheck Show this window
after instant reverse.
The classes that are 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 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 the association relationships between the selected elements and their navigable classes
(targets) in new diagram.
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).
Presentation Options
Option
Description
P. 451
Attribute options
Operation options
Type options
Select Tools > Code > Instant Reverse... from the toolbar.
2.
3.
Specify the path of the source file, or the folder that contains those files.
5.
6.
2.
In the Select Parent Model window, either select an existing model, or create one by clicking New Model.
3.
Click OK to confirm.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
P. 452
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 453
In the Instant Reverse window, select .NET dll or exe files... as the Language.
3.
Specify the path of the source file or the folder that contains those files.
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 window, either select an existing model, or create one by clicking New Model.
3.
Click OK to confirm.
5.
6.
Upon finishing, you will see the Instant Reverse Form Diagram window 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.
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.
Name
Description
Language
Update type
Determine how to handle duplicated classes by selecting the Update Type. Below is a description of the update types:
P. 454
Path
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.
Reverse to diagram
Whether or not to reverse engineering class diagram/package diagram from source files. UML packages and the
relationships in between will be produced.
OK
Cancel
Help
NOTE:
If you do not want Visual Paradigm to ask you for forming diagram next time you perform instant reverse, uncheck Show this window
after instant reverse.
The classes that are 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 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 the association relationships between the selected elements and their navigable classes
(targets) in new diagram.
P. 455
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).
Presentation Options
Option
Attribute options
Description
Operation options
Type options
Select Tools > Code > Instant Reverse... from the toolbar.
2.
In the Instant Reverse window, select .NET dll or exe files... as the Language.
3.
Specify the path of the source file or the folder that contains those files.
5.
In the Select Parent Model window, either select an existing model, or create one by clicking New Model.
P. 456
3.
6.
Click OK to confirm.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 457
In the Instant Reverse window, select CORBA IDL source files as the Language.
3.
Specify the path of the source file or the folder that contains those files.
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 window, either select an existing model or create one by clicking New Model.
3.
Click OK to confirm.
5.
6.
Upon finishing, you will see the Instant Reverse Form Diagram window 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.
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.
P. 458
Name
Description
Language
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.
Path
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.
Reverse to diagram
Whether or not to reverse engineering class diagram/package diagram from source files. UML packages and the
relationships in between will be produced.
OK
Cancel
Help
P. 459
NOTE:
If you do not want Visual Paradigm to ask you for forming diagram next time you perform instant reverse, uncheck Show this window
after instant reverse.
The classes that are 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 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 the association relationships between the selected elements and their navigable classes
(targets) in new diagram.
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).
Presentation Options
Option
Description
P. 460
Attribute options
Operation options
Type options
Select Tools > Code > Instant Reverse... from the toolbar.
2.
In the Instant Reverse window, select CORBA IDL source files as the Language.
3.
Specify the path of the source file or the folder that contains those files.
5.
6.
2.
In the Select Parent Model window, either select an existing model, or create one by clicking New Model.
3.
Click OK to confirm.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 461
In the Instant Reverse window, select Ada 9x source files as the Language.
3.
Specify the path of the source file or the folder that contains those files.
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 window, either select an existing model, or create one by clicking New Model.
3.
Click OK to confirm.
5.
6.
Upon finishing, you will see the Instant Reverse Form Diagram window 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.
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.
Name
Description
Language
Update type
Determine how to handle duplicated classes by selecting the Update Type. Below is a description of the update types:
P. 462
Path
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.
Reverse to diagram
Whether or not to reverse engineering class diagram/package diagram from source files. UML packages and the
relationships in between will be produced.
OK
Cancel
Help
NOTE:
If you do not want Visual Paradigm to ask you for forming diagram next time you perform instant reverse, uncheck Show this window
after instant reverse.
The classes that are 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 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 the association relationships between the selected elements and their navigable classes
(targets) in new diagram.
P. 463
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).
Presentation Options
Option
Attribute options
Description
Operation options
Type options
Select Tools > Code > Instant Reverse... from the toolbar.
2.
In the Instant Reverse window, select Ada 9x source files as the Language.
3.
Specify the path of the source file, or the folder that contains those files.
5.
In the Select Parent Model window, either select an existing model, or create one by clicking New Model.
P. 464
3.
6.
Click OK to confirm.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 465
3.
Specify the path of the source file or the folder that contains those files.
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 window, either select an existing model or create one by clicking New Model.
3.
Click OK to confirm.
5.
6.
Upon finishing, you will see the Instant Reverse Form Diagram window 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.
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.
Name
Description
Language
Update type
Determine how to handle duplicated classes by selecting the Update Type. Below is a description of the update types:
P. 466
Path
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.
OK
Cancel
Help
NOTE:
If you do not want Visual Paradigm to ask you for forming diagram next time you perform instant reverse, uncheck Show this window
after instant reverse.
The classes that are 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 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 the association relationships between the selected elements and their navigable classes
(targets) in new diagram.
Show the association relationships between the selected elements and their non-navigable classes
(sources) in the new diagram.
P. 467
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).
Presentation Options
Option
Attribute options
Description
Operation options
Type options
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 468
3.
Specify the path of the source file or the folder that contains those files.
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 window, either select an existing model or create one by clicking New Model.
3.
Click OK to confirm.
5.
6.
Upon finishing, you will see the Instant Reverse Form Diagram window 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.
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.
Name
Description
P. 469
Language
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.
Path
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.
Reverse to diagram
Whether or not to reverse engineering class diagram/package diagram from source files.
UML packages and the relationships in between will be produced.
OK
Cancel
10 Help
NOTE:
If you do not want Visual Paradigm to ask you for forming diagram next time you perform instant reverse, uncheck Show this window
after instant reverse.
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.
P. 470
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 the association relationships between the selected elements and their navigable classes
(targets) in new diagram.
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).
Presentation Options
Option
Attribute options
Description
Operation options
Type options
Select Tools > Code > Instant Reverse... from the toolbar.
2.
3.
Specify the path of the source file, or the folder that contains those files.
P. 471
5.
6.
2.
In the Select Parent Model window, either select an existing model or create one by clicking New Model.
3.
Click OK to confirm.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 472
3.
Specify the path of the source file or the folder that contains those files.
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 window, either select an existing model, or create one by clicking New Model.
3.
Click OK to confirm.
5.
6.
Upon finishing, you will see the Instant Reverse Form Diagram window 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.
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.
Name
Description
Language
Update type
Determine how to handle duplicated classes by selecting the Update Type. Below is a description of the update types:
P. 473
Path
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.
Reverse to diagram
Whether or not to reverse engineering class diagram/package diagram from source files. UML packages and the
relationships in between will be produced.
OK
Cancel
Help
NOTE:
If you do not want Visual Paradigm to ask you for forming diagram next time you perform instant reverse, uncheck Show this window
after instant reverse.
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 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 the association relationships between the selected elements and their navigable classes
(targets) in new diagram.
P. 474
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).
Presentation Options
Option
Attribute options
Description
Operation options
Type options
Select Tools > Code > Instant Reverse... from the toolbar.
2.
3.
Specify the path of the source file or the folder that contains those files.
5.
In the Select Parent Model window, either select an existing model, or create one by clicking New Model.
P. 475
3.
6.
Click OK to confirm.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 476
In the Instant Reverse window, select PHP 5.0 source files as the Language.
3.
Specify the path of the source file or the folder that contains those files.
4.
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 window, either select an existing model, or create one by clicking New Model.
3.
Click OK to confirm.
5.
6.
Upon finishing, you will see the Instant Reverse Form Diagram window 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.
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.
P. 477
Name
Description
Language
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.
Path
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.
Reverse to diagram
Whether or not to reverse engineering class diagram/package diagram from source files. UML packages
and the relationships in between will be produced.
OK
Cancel
10 Help
P. 478
NOTE:
If you do not want Visual Paradigm to ask you for forming diagram next time you perform instant reverse, uncheck Show this window
after instant reverse.
The classes that are 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 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 the association relationships between the selected elements and their navigable classes
(targets) in new diagram.
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).
Presentation Options
Option
Description
P. 479
Attribute options
Operation options
Type options
Select Tools > Code > Instant Reverse... from the toolbar.
2.
In the Instant Reverse window, select PHP 5.0 source files as the Language.
3.
Specify the path of the source file or the folder that contains those files.
5.
6.
2.
In the Select Parent Model window, either select an existing model, or create one by clicking New Model.
3.
Click OK to confirm.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 480
3.
Specify the path of the source file or the folder that contains those files.
4.
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 window, either select an existing model, or create one by clicking New Model.
3.
Click OK to confirm.
5.
6.
Upon finishing, you will see the Instant Reverse Form Diagram window 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.
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.
P. 481
Name
Description
Language
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.
Select Files
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.
Reverse to diagram
Whether or not to reverse engineering class diagram/package diagram from source files.
UML packages and the relationships in between will be produced.
OK
Cancel
Help
P. 482
NOTE:
If you do not want Visual Paradigm to ask you for forming diagram next time you perform instant reverse, uncheck Show this window
after instant reverse.
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 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 the association relationships between the selected elements and their navigable classes
(targets) in new diagram.
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).
NOTE:
P. 483
Presentation Options
Option
Attribute options
Description
Operation options
Type options
Select Tools > Code > Instant Reverse... from the toolbar.
2.
3.
Specify the path of the source file, or the folder that contains those files.
5.
6.
2.
In the Select Parent Model window, either select an existing model, or create one by clicking New Model.
3.
Click OK to confirm.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 484
3.
Specify the path of the source file or the folder that contains those files.
4.
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 window, either select an existing model, or create one by clicking New Model.
3.
Click OK to confirm.
5.
6.
Upon finishing, you will see the Instant Reverse Form Diagram window 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.
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.
P. 485
Name
Description
Language
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.
Path
Exclude
Encoding
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.
OK
Cancel
Advanced Options
Help
P. 486
NOTE:
If you do not want Visual Paradigm to ask you for forming diagram next time you perform instant reverse, uncheck Show this window
after instant reverse.
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 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 the association relationships between the selected elements and their navigable classes
(targets) in new diagram.
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).
Presentation Options
Option
Description
P. 487
Attribute options
Operation options
Type options
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 488
In the Instant Reverse window, add the zip file of source or folder path of source by clicking on the appropriate Add button at the right hand
side of the window. Make sure the source folders include all the source files of all classes necessary for analyzing the traces of calls.
NOTE:
You can reverse multiple source paths by adding them one after the other.
3.
Click Next.
4.
Select the operation you want to analyze its content and form sequence diagram.
P. 489
5.
Click Next.
6.
In the Choose Diagram page, select the diagram to visualize the result. You can either form a new sequence diagram by selecting Create new
sequence diagram and entering the diagram name or select Select an existing sequence diagram and choose an existing sequence diagram
to visualize the result.
Click Finish. When the process is completed, you can obtain the result in sequence diagram.
P. 490
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 491
Instant Generation
Instant generator is the process of producing source code from class model. In this chapter, you will learn how to make use of Instant Generator to
generate source code from UML classes.
Instant Generator for Java
Generate Java source file from UML classes.
Instant Generator C# source code
Generate C# source file from UML classes.
Instant Generator for VB.NET source code
Generate VB.NET source file from UML classes.
Instant Generator for PHP source code
Generate PHP source file from UML classes.
Instant Generator for ODL source code
Generate ODL source file from UML classes.
Instant Generator for ActionScript source code
Generate ActionScript source file from UML classes.
Instant Generator for IDL source code
Generate IDL source file from UML classes.
Instant Generator for C++ source code
Generate C++ source file from UML classes.
Instant Generator for Delphi source code
Generate Delphi source file from UML classes.
Instant Generator for Perl source code
Generate Perl source file from UML classes.
Instant Generator for XML Schema file
Generate XML Schema source file from UML classes.
Instant Generator for Python source code
Generate Python source file from UML classes.
Instant Generator for Objective-C source code
Generate Objective-C source file from UML classes.
Instant Generator for Objective-C 2.0 source code
Generate Objective-C 2.0 source file from UML classes.
Instant Generator for Ada95
Generate Ada95 source file from UML classes.
Instant Generator for Ruby
Generate Ruby source file from UML classes.
Customizing code generation
Customize the code generation template to control the output of instant generator.
Instant Generation
P. 492
Select Tools > Code > Instant Generator from the toolbar.
2.
3.
Fill in the Output Path, which is the directory where you want the code to generate to.
4.
Select the classes to generate code. In the Diagrams tab, you can select the diagrams to generate code for classes in the selected diagrams.
Alternatively, open the Model Elements tab and select the classes to generate code.
Optionally configure the generator options. Read the section below for a description of options.
6.
Name
Description
P. 493
Language
A list of packages and classes that can be selected for code generation. You must select classes
for code generation.
General options
Some of the common configurable options are shown here. You can configure them in advanced
options.
Output path
Template directory
Template governs how code will be generated from model to code. You can customize the template
to suit your needs, such as to print company specific headers to each code file. If you want to
use your own template, provide the template directory here. If you want to keep using the build in
template, leave this option unchanged to let Visual Paradigm generate with build in template. To
learn more about customization, read the final chapter of this part.
Advanced options
Click this button to configure any options related to code generation in a new window.
If a code file instant generator going to generate is already exist, by checking this option you will be
asked whether to overwrite that file or not. If you uncheck this option, it will help you to overwrite the
existing file automatically.
Output pane
10 Preview
Click to preview the code content. It is just a preview and code will not be generated to the output
path by previewing.
11 Generate
12 Close
Generator options
On the Instant Generator window you can configure some of the common code options at the right of window. You can also configure the advanced
options for more detailed settings by clicking the Advanced Options... button.
P. 494
Description
Encoding
Follow Convention
Attribute prefix
Parameter prefix
Indentation
When two classes are associated, checking this option will generate attributes in both
classes with each other as type. When unchecked, attributes will not be generated to both
of them.
Unnamed attribute
Pattern will be applied when generating name for those attribute without name.
Invalid char refers to characters that will result in a compile error when compiling code.
This option is for replacing those invalid characters by given one.
Attribute type that will be used when attribute has no type specified.
Parameter type that will be used when parameter has no type specified.
Operation return type that will be used when operation has no return type specified.
Whether to state in import statement the class to import, or use asterisk to present an
import on all classes in a package.
If you check this box, when a role is selected to provide setter/getter, the corresponding
operation(s) will be generated for the role's attribute.
Whether or not to generate setter and getter for accessing attribute of associated class,
when getter and setter are checked.
Whether or not to generate add, remove and to methods for accessing attribute of
associated class, when getter and setter are checked.
Association implementation
JDK Version
You can defined pre and post conditions in class, attribute and operation specification.
Check this option to generate them as comment in code.
Generics (Template)
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 495
Select Tools > Code > Instant Generator from the toolbar.
2.
3.
Fill in the Output Path, which is the directory where you want the code to generate to.
4.
Select the classes to generate code. In the Diagrams tab, you can select the diagrams to generate code for classes in the selected diagrams.
Alternatively, open the Model Elements tab and select the classes to generate code.
Optionally configure the generator options. Read the section below for a description of options.
6.
Name
Description
P. 496
Language
A list of packages and classes that can be selected for code generation. You must select classes
for code generation.
General options
Some of the common configurable options are shown here. You can configure them in advanced
options.
Output path
Template directory
Template governs how code will be generated from model to code. You can customize the template
to suit your needs, such as to print company specific headers to each code file. If you want to
use your own template, provide the template directory here. If you want to keep using the build in
template, leave this option unchanged to let Visual Paradigm generate with build in template. To
learn more about customization, read the final chapter of this part.
Advanced options
Click this button to configure any options related to code generation in a new window.
If a code file instant generator going to generate is already exist, by checking this option you will be
asked whether to overwrite that file or not. If you uncheck this option, it will help you to overwrite the
existing file automatically.
Output pane
10 Preview
Click to preview the code content. It is just a preview and code will not be generated to the output
path by previewing.
11 Generate
12 Close
Generator options
On the Instant Generator window you can configure some of the common code options at the right of window. You can also configure the advanced
options for more detailed settings by clicking the Advanced Options... button.
Description
Encoding
Attribute type that will be used when attribute has no type specified.
Parameter type that will be used when parameter has no type specified.
Operation return type that will be used when operation has no return type specified.
P. 497
Association implementation
Attribute prefix
Parameter prefix
Related Resources
The following resources may help to you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 498
Select Tools > Code > Instant Generator from the toolbar.
2.
3.
Fill in the Output Path, which is the directory where you want the code to generate to.
4.
Select the classes to generate code. In the Diagrams tab, you can select the diagrams to generate code for classes in the selected diagrams.
Alternatively, open the Model Elements tab and select the classes to generate code.
Optionally configure the generator options. Read the section below for a description of options.
6.
Name
Description
P. 499
Language
A list of packages and classes that can be selected for code generation. You must select classes
for code generation.
General options
Some of the common configurable options are shown here. You can configure them in advanced
options.
Output path
Template directory
Template governs how code will be generated from model to code. You can customize the template
to suit your needs, such as to print company specific headers to each code file. If you want to
use your own template, provide the template directory here. If you want to keep using the build in
template, leave this option unchanged to let Visual Paradigm generate with build in template. To
learn more about customization, read the final chapter of this part.
Advanced options
Click this button to configure any options related to code generation in a new window.
If a code file instant generator going to generate is already exist, by checking this option you will be
asked whether to overwrite that file or not. If you uncheck this option, it will help you to overwrite the
existing file automatically.
Output pane
10 Preview
Click to preview the code content. It is just a preview and code will not be generated to the output
path by previewing.
11 Generate
12 Close
Generator options
On the Instant Generator window you can configure some of the common code options at the right of window. You can also configure the advanced
options for more detailed settings by clicking the Advanced Options... button.
Description
Encoding
Attribute type that will be used when attribute has no type specified.
Parameter type that will be used when parameter has no type specified.
Association implementation
P. 500
Attribute prefix
Parameter prefix
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 501
Select Tools > Code > Instant Generator from the toolbar.
2.
3.
Fill in the Output Path, which is the directory where you want the code to generate to.
4.
Select the classes to generate code. In the Diagrams tab, you can select the diagrams to generate code for classes in the selected diagrams.
Alternatively, open the Model Elements tab and select the classes to generate code.
Optionally configure the generator options. Read the section below for a description of options.
6.
Name
Description
P. 502
Language
A list of packages and classes that can be selected for code generation. You must select classes
for code generation.
General options
Some of the common configurable options are shown here. You can configure them in advanced
options.
Output path
Template directory
Template governs how code will be generated from model to code. You can customize the template
to suit your needs, such as to print company specific headers to each code file. If you want to
use your own template, provide the template directory here. If you want to keep using the build in
template, leave this option unchanged to let Visual Paradigm generate with build in template. To
learn more about customization, read the final chapter of this part.
Advanced options
Click this button to configure any options related to code generation in a new window.
If a code file instant generator going to generate is already exist, by checking this option you will be
asked whether to overwrite that file or not. If you uncheck this option, it will help you to overwrite the
existing file automatically.
Output pane
10 Preview
Click to preview the code content. It is just a preview and code will not be generated to the output
path by previewing.
11 Generate
12 Close
Generator options
On the Instant Generator window you can configure some of the common code options at the right of window. You can also configure the advanced
options for more detailed settings by clicking the Advanced Options... button.
Description
Encoding
Attribute prefix
Parameter prefix
P. 503
Indentation
Unnamed attribute
Invalid char refers to characters that will result in a compile error when compiling code.
This option is for replacing thsoe invalid characters by given character.
If you check this box, when a role is selected to provide setter/getter, the corresponding
operation(s) will be generated for the role's attribute.
Whether or not to generate setter and getter for accessing attribute of associated class,
when getter and setter are checked.
Whether or not to generate add, remove and to methods for accessing attribute of
associated class, when getter and setter are checked.
Directory
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 504
Select Tools > Code > Instant Generator from the toolbar.
2.
3.
Fill in the Output Path, which is the directory where you want the code to generate to.
4.
Select the classes to generate code. In the Diagrams tab, you can select the diagrams to generate code for classes in the selected diagrams.
Alternatively, open the Model Elements tab and select the classes to generate code.
Optionally configure the generator options. Read the section below for a description of options.
6.
Name
Description
P. 505
Language
A list of packages and classes that can be selected for code generation. You must select classes
for code generation.
General options
Some of the common configurable options are shown here. You can configure them in advanced
options.
Output path
Template directory
Template governs how code will be generated from model to code. You can customize the template
to suit your needs, such as to print company specific headers to each code file. If you want to
use your own template, provide the template directory here. If you want to keep using the build in
template, leave this option unchanged to let Visual Paradigm generate with build in template. To
learn more about customization, read the final chapter of this part.
Advanced options
Click this button to configure any options related to code generation in a new window.
If a code file instant generator going to generate is already exist, by checking this option you will be
asked whether to overwrite that file or not. If you uncheck this option, it will help you to overwrite the
existing file automatically.
Output pane
10 Preview
Click to preview the code content. It is just a preview and code will not be generated to the output
path by previewing.
11 Generate
12 Close
Generator options
On the Instant Generator window you can configure some of the common code options at the right of window. You can also configure the advanced
options for more detailed settings by clicking the Advanced Options... button.
Description
Encoding
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 506
Select Tools > Code > Instant Generator from the toolbar.
2.
3.
Fill in the Output Path, which is the directory where you want the code to generate to.
4.
Select the classes to generate code. In the Diagrams tab, you can select the diagrams to generate code for classes in the selected diagrams.
Alternatively, open the Model Elements tab and select the classes to generate code.
Optionally configure the generator options. Read the section below for a description of options.
6.
Name
Description
P. 507
Language
A list of packages and classes that can be selected for code generation. You must select classes
for code generation.
General options
Some of the common configurable options are shown here. You can configure them in advanced
options.
Output path
Template directory
Template governs how code will be generated from model to code. You can customize the template
to suit your needs, such as to print company specific headers to each code file. If you want to
use your own template, provide the template directory here. If you want to keep using the build in
template, leave this option unchanged to let Visual Paradigm generate with build in template. To
learn more about customization, read the final chapter of this part.
Advanced options
Click this button to configure any options related to code generation in a new window.
If a code file instant generator going to generate is already exist, by checking this option you will be
asked whether to overwrite that file or not. If you uncheck this option, it will help you to overwrite the
existing file automatically.
Output pane
10 Preview
Click to preview the code content. It is just a preview and code will not be generated to the output
path by previewing.
11 Generate
12 Close
Generator options
On the Instant Generator window you can configure some of the common code options at the right of window. You can also configure the advanced
options for more detailed settings by clicking the Advanced Options... button.
Description
Encoding
Attribute prefix
P. 508
Parameter prefix
Indentation
When two classes are associated, checking this option will generate attributes in both
classes with each other as type. When unchecked, attributes will not be generated to both
of them.
Unnamed attribute
Pattern will be applied when generating name for those attribute without name.
Invalid char refers to characters that will result in a compile error when compiling code.
This option is for replacing those invalid characters by given one.
Attribute type that will be used when attribute has no type specified.
Parameter type that will be used when parameter has no type specified.
Operation return type that will be used when operation has no return type specified.
If you check this box, when a role is selected to provide setter/getter, the corresponding
operation(s) will be generated for the role's attribute.
Whether or not to generate setter and getter for accessing attribute of associated class,
when getter and setter are checked.
Whether or not to generate add, remove and to methods for accessing attribute of
associated class, when getter and setter are checked.
ActionScript Version
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 509
Select Tools > Code > Instant Generator from the toolbar.
2.
3.
Fill in the Output Path, which is the directory where you want the code to generate to.
4.
Select the classes to generate code. In the Diagrams tab, you can select the diagrams to generate code for classes in the selected diagrams.
Alternatively, open the Model Elements tab and select the classes to generate code.
Optionally configure the generator options. Read the section below for a description of options.
6.
Name
Description
P. 510
Language
A list of packages and classes that can be selected for code generation. You must select classes
for code generation.
General options
Some of the common configurable options are shown here. You can configure them in advanced
options.
Output path
Template directory
Template governs how code will be generated from model to code. You can customize the template
to suit your needs, such as to print company specific headers to each code file. If you want to
use your own template, provide the template directory here. If you want to keep using the build in
template, leave this option unchanged to let Visual Paradigm generate with build in template. To
learn more about customization, read the final chapter of this part.
Advanced options
Click this button to configure any options related to code generation in a new window.
If a code file instant generator going to generate is already exist, by checking this option you will be
asked whether to overwrite that file or not. If you uncheck this option, it will help you to overwrite the
existing file automatically.
Output pane
10 Preview
Click to preview the code content. It is just a preview and code will not be generated to the output
path by previewing.
11 Generate
12 Close
Generator options
On the Instant Generator window you can configure some of the common code options at the right of window. You can also configure the advanced
options for more detailed settings by clicking the Advanced Options... button.
Description
Encoding
Attribute prefix
Parameter prefix
P. 511
Indentation
When two classes are associated, checking this option will generate attributes in both
classes with each other as type. When unchecked, attributes will not be generated to both
of them.
Unnamed attribute
Pattern will be applied when generating name for those attribute without name.
Attribute type that will be used when attribute has no type specified.
Parameter type that will be used when parameter has no type specified.
Operation return type that will be used when operation has no return type specified.
If you check this box, when a role is selected to provide setter/getter, the corresponding
operation(s) will be generated for the role's attribute.
Whether or not to generate setter and getter for accessing attribute of associated class,
when getter and setter are checked.
Whether or not to generate add, remove and to methods for accessing attribute of
associated class, when getter and setter are checked.
A description of advanced options
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 512
Select Tools > Code > Instant Generator from the toolbar.
2.
3.
Fill in the Output Path, which is the directory where you want the code to generate to.
4.
Select the classes to generate code. In the Diagrams tab, you can select the diagrams to generate code for classes in the selected diagrams.
Alternatively, open the Model Elements tab and select the classes to generate code.
Optionally configure the generator options. Read the section below for a description of options.
6.
Name
Description
P. 513
Language
A list of packages and classes that can be selected for code generation. You must select classes
for code generation.
General options
Some of the common configurable options are shown here. You can configure them in advanced
options.
Output path
Template directory
Template governs how code will be generated from model to code. You can customize the template
to suit your needs, such as to print company specific headers to each code file. If you want to
use your own template, provide the template directory here. If you want to keep using the build in
template, leave this option unchanged to let Visual Paradigm generate with build in template. To
learn more about customization, read the final chapter of this part.
Advanced options
Click this button to configure any options related to code generation in a new window.
If a code file instant generator going to generate is already exist, by checking this option you will be
asked whether to overwrite that file or not. If you uncheck this option, it will help you to overwrite the
existing file automatically.
Output pane
10 Preview
Click to preview the code content. It is just a preview and code will not be generated to the output
path by previewing.
11 Generate
12 Close
Generator options
On the Instant Generator window you can configure some of the common code options at the right of window. You can also configure the advanced
options for more detailed settings by clicking the Advanced Options... button.
P. 514
Description
Encoding
Attribute prefix
Parameter prefix
Indentation
When two classes are associated, checking this option will generate attributes in both
classes with each other as type. When unchecked, attributes will not be generated to
both of them.
Unnamed attribute
Pattern will be applied when generating name for those attribute without name.
Invalid char refers to characters that will result in a compile error when compiling
code. This option is for replacing those invalid characters by given one.
Attribute type that will be used when attribute has no type specified.
Parameter type that will be used when parameter has no type specified.
Operation return type that will be used when operation has no return type specified.
When checked, generate attribute for linking composited class using pointer (by
reference).
P. 515
If you check this box, when a role is selected to provide setter/getter, the
corresponding operation(s) will be generated for the role's attribute.
Whether or not to generate setter and getter for accessing attribute of associated
class, when getter and setter are checked.
Whether or not to generate add, remove and to methods for accessing attribute of
associated class, when getter and setter are checked.
Association implementation
Standard
Using Template
Group By Visibility
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 516
Select Tools > Code > Instant Generator from the toolbar.
2.
3.
Fill in the Output Path, which is the directory where you want the code to generate to.
4.
Select the classes to generate code. In the Diagrams tab, you can select the diagrams to generate code for classes in the selected diagrams.
Alternatively, open the Model Elements tab and select the classes to generate code.
Optionally configure the generator options. Read the section below for a description of options.
6.
Name
Description
P. 517
Language
A list of packages and classes that can be selected for code generation. You must select classes
for code generation.
General options
Some of the common configurable options are shown here. You can configure them in advanced
options.
Output path
Template directory
Template governs how code will be generated from model to code. You can customize the template
to suit your needs, such as to print company specific headers to each code file. If you want to
use your own template, provide the template directory here. If you want to keep using the build in
template, leave this option unchanged to let Visual Paradigm generate with build in template. To
learn more about customization, read the final chapter of this part.
Advanced options
Click this button to configure any options related to code generation in a new window.
If a code file instant generator going to generate is already exist, by checking this option you will be
asked whether to overwrite that file or not. If you uncheck this option, it will help you to overwrite the
existing file automatically.
Output pane
10 Preview
Click to preview the code content. It is just a preview and code will not be generated to the output
path by previewing.
11 Generate
12 Close
Generator options
On the Instant Generator window you can configure some of the common code options at the right of window. You can also configure the advanced
options for more detailed settings by clicking the Advanced Options... button.
Description
Encoding
Attribute prefix
Parameter prefix
P. 518
Indentation
When two classes are associated, checking this option will generate attributes in both
classes with each other as type. When unchecked, attributes will not be generated to both
of them.
Unnamed attribute
Pattern will be applied when generating name for those attribute without name.
Attribute type that will be used when attribute has no type specified.
Parameter type that will be used when parameter has no type specified.
Operation return type that will be used when operation has no return type specified.
If you check this box, when a role is selected to provide setter/getter, the corresponding
operation(s) will be generated for the role's attribute.
Whether or not to generate setter and getter for accessing attribute of associated class,
when getter and setter are checked.
Whether or not to generate add, remove and to methods for accessing attribute of
associated class, when getter and setter are checked.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 519
Select Tools > Code > Instant Generator from the toolbar.
2.
3.
Fill in the Output Path, which is the directory where you want the code to generate to.
4.
Select the classes to generate code. In the Diagrams tab, you can select the diagrams to generate code for classes in the selected diagrams.
Alternatively, open the Model Elements tab and select the classes to generate code.
Optionally configure the generator options. Read the section below for a description of options.
6.
Name
Description
P. 520
Language
A list of packages and classes that can be selected for code generation. You must select classes
for code generation.
General options
Some of the common configurable options are shown here. You can configure them in advanced
options.
Output path
Template directory
Template governs how code will be generated from model to code. You can customize the template
to suit your needs, such as to print company specific headers to each code file. If you want to
use your own template, provide the template directory here. If you want to keep using the build in
template, leave this option unchanged to let Visual Paradigm generate with build in template. To
learn more about customization, read the final chapter of this part.
Advanced options
Click this button to configure any options related to code generation in a new window.
If a code file instant generator going to generate is already exist, by checking this option you will be
asked whether to overwrite that file or not. If you uncheck this option, it will help you to overwrite the
existing file automatically.
Output pane
10 Preview
Click to preview the code content. It is just a preview and code will not be generated to the output
path by previewing.
11 Generate
12 Close
Generator options
On the Instant Generator window you can configure some of the common code options at the right of window. You can also configure the advanced
options for more detailed settings by clicking the Advanced Options... button.
Description
Encoding
Installation path
Attribute prefix
Parameter prefix
P. 521
Indentation
When two classes are associated, checking this option will generate attributes in both
classes with each other as type. When unchecked, attributes will not be generated to both
of them.
Unnamed attribute
Pattern will be applied when generating name for those attribute without name.
Invalid char refers to characters that will result in a compile error when compiling code.
This option is for replacing those invalid characters by given one.
If you check this box, when a role is selected to provide setter/getter, the corresponding
operation(s) will be generated for the role's attribute.
Whether or not to generate setter and getter for accessing attribute of associated class,
when getter and setter are checked.
Whether or not to generate add, remove and to methods for accessing attribute of
associated class, when getter and setter are checked.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 522
Select Tools > Code > Instant Generator from the toolbar.
2.
3.
Fill in the Output Path, which is the directory where you want the code to generate to.
4.
Select the classes to generate code. In the Diagrams tab, you can select the diagrams to generate code for classes in the selected diagrams.
Alternatively, open the Model Elements tab and select the classes to generate code.
Optionally configure the generator options. Read the section below for a description of options.
6.
Name
Description
P. 523
Language
A list of packages and classes that can be selected for code generation. You must select classes
for code generation.
General options
Some of the common configurable options are shown here. You can configure them in advanced
options.
Output path
Template directory
Template governs how code will be generated from model to code. You can customize the template
to suit your needs, such as to print company specific headers to each code file. If you want to
use your own template, provide the template directory here. If you want to keep using the build in
template, leave this option unchanged to let Visual Paradigm generate with build in template. To
learn more about customization, read the final chapter of this part.
Advanced options
Click this button to configure any options related to code generation in a new window.
If a code file instant generator going to generate is already exist, by checking this option you will be
asked whether to overwrite that file or not. If you uncheck this option, it will help you to overwrite the
existing file automatically.
Output pane
10 Preview
Click to preview the code content. It is just a preview and code will not be generated to the output
path by previewing.
11 Generate
12 Close
Generator options
On the Instant Generator window you can configure some of the common code options at the right of window. You can also configure the advanced
options for more detailed settings by clicking the Advanced Options... button.
Description
Encoding
Indentation
When two classes are associated, checking this option will generate attributes in both classes with each other
as type. When unchecked, attributes will not be generated to both of them.
Unnamed attribute
Pattern will be applied when generating name for those attribute without name.
P. 524
Invalid char refers to characters that will result in a compile error when compiling code. This option is for
replacing those invalid characters by given one.
Attribute type that will be used when attribute has no type specified.
Namespace
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 525
Select Tools > Code > Instant Generator from the toolbar.
2.
3.
Fill in the Output Path, which is the directory where you want the code to generate to.
4.
Select the classes to generate code. In the Diagrams tab, you can select the diagrams to generate code for classes in the selected diagrams.
Alternatively, open the Model Elements tab and select the classes to generate code.
Optionally configure the generator options. Read the section below for a description of options.
6.
Name
Description
P. 526
Language
A list of packages and classes that can be selected for code generation. You must select classes
for code generation.
General options
Some of the common configurable options are shown here. You can configure them in advanced
options.
Output path
Template directory
Template governs how code will be generated from model to code. You can customize the template
to suit your needs, such as to print company specific headers to each code file. If you want to
use your own template, provide the template directory here. If you want to keep using the build in
template, leave this option unchanged to let Visual Paradigm generate with build in template. To
learn more about customization, read the final chapter of this part.
Advanced options
Click this button to configure any options related to code generation in a new window.
If a code file instant generator going to generate is already exist, by checking this option you will be
asked whether to overwrite that file or not. If you uncheck this option, it will help you to overwrite the
existing file automatically.
Output pane
10 Preview
Click to preview the code content. It is just a preview and code will not be generated to the output
path by previewing.
11 Generate
12 Close
Generator options
On the Instant Generator window you can configure some of the common code options at the right of window. You can also configure the advanced
options for more detailed settings by clicking the Advanced Options... button.
Description
Encoding
Installation path
Attribute prefix
Parameter prefix
P. 527
Indentation
When two classes are associated, checking this option will generate attributes in both
classes with each other as type. When unchecked, attributes will not be generated to both
of them.
Unnamed attribute
Pattern will be applied when generating name for those attribute without name.
Invalid char refers to characters that will result in a compile error when compiling code.
This option is for replacing those invalid characters by given one.
If you check this box, when a role is selected to provide setter/getter, the corresponding
operation(s) will be generated for the role's attribute.
Whether or not to generate setter and getter for accessing attribute of associated class,
when getter and setter are checked.
Whether or not to generate add, remove and to methods for accessing attribute of
associated class, when getter and setter are checked.
Constructor
Python Version
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 528
Select Tools > Code > Instant Generator from the toolbar.
2.
3.
Fill in the Output Path, which is the directory where you want the code to generate to.
4.
Select the classes to generate code. In the Diagrams tab, you can select the diagrams to generate code for classes in the selected diagrams.
Alternatively, open the Model Elements tab and select the classes to generate code.
Optionally configure the generator options. Read the section below for a description of options.
6.
Name
Description
P. 529
Language
A list of packages and classes that can be selected for code generation. You must select classes
for code generation.
General options
Some of the common configurable options are shown here. You can configure them in advanced
options.
Output path
Template directory
Template governs how code will be generated from model to code. You can customize the template
to suit your needs, such as to print company specific headers to each code file. If you want to
use your own template, provide the template directory here. If you want to keep using the build in
template, leave this option unchanged to let Visual Paradigm generate with build in template. To
learn more about customization, read the final chapter of this part.
Advanced options
Click this button to configure any options related to code generation in a new window.
If a code file instant generator going to generate is already exist, by checking this option you will be
asked whether to overwrite that file or not. If you uncheck this option, it will help you to overwrite the
existing file automatically.
Output pane
10 Preview
Click to preview the code content. It is just a preview and code will not be generated to the output
path by previewing.
11 Generate
12 Close
Generator options
On the Instant Generator window you can configure some of the common code options at the right of window. You can also configure the advanced
options for more detailed settings by clicking the Advanced Options... button.
Encoding
Description
P. 530
hen checked, will generate attribute/parameter type with specified type or just id.
Attribute prefix
Parameter prefix
Indentation
When two classes are associated, checking this option will generate attributes in both
classes with each other as type. When unchecked, attributes will not be generated to both
of them.
Unnamed attribute
Pattern will be applied when generating name for those attribute without name.
Invalid char refers to characters that will result in a compile error when compiling code.
This option is for replacing those invalid characters by given one.
Attribute type that will be used when attribute has no type specified.
Parameter type that will be used when parameter has no type specified.
Operation return type that will be used when operation has no return type specified.
If you check this box, when a role is selected to provide setter/getter, the corresponding
operation(s) will be generated for the role's attribute.
Whether or not to generate setter and getter for accessing attribute of associated class,
when getter and setter are checked.
Whether or not to generate add, remove and to methods for accessing attribute of
associated class, when getter and setter are checked.
Association implementation
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 531
Select Tools > Code > Instant Generator from the toolbar.
2.
3.
Fill in the Output Path, which is the directory where you want the code to generate to.
4.
Select the classes to generate code. In the Diagrams tab, you can select the diagrams to generate code for classes in the selected diagrams.
Alternatively, open the Model Elements tab and select the classes to generate code.
Optionally configure the generator options. Read the section below for a description of options.
6.
Name
Description
P. 532
Language
A list of packages and classes that can be selected for code generation. You must select classes
for code generation.
General options
Some of the common configurable options are shown here. You can configure them in advanced
options.
Output path
Template directory
Template governs how code will be generated from model to code. You can customize the template
to suit your needs, such as to print company specific headers to each code file. If you want to
use your own template, provide the template directory here. If you want to keep using the build in
template, leave this option unchanged to let Visual Paradigm generate with build in template. To
learn more about customization, read the final chapter of this part.
Advanced options
Click this button to configure any options related to code generation in a new window.
If a code file instant generator going to generate is already exist, by checking this option you will be
asked whether to overwrite that file or not. If you uncheck this option, it will help you to overwrite the
existing file automatically.
Output pane
10 Preview
Click to preview the code content. It is just a preview and code will not be generated to the output
path by previewing.
11 Generate
12 Close
Generator options
On the Instant Generator window you can configure some of the common code options at the right of window. You can also configure the advanced
options for more detailed settings by clicking the Advanced Options... button.
Description
Encoding
Attribute prefix
Parameter prefix
P. 533
Indentation
When two classes are associated, checking this option will generate attributes in both classes with each
other as type. When unchecked, attributes will not be generated to both of them.
Unnamed attribute
Pattern will be applied when generating name for those attribute without name.
Invalid char refers to characters that will result in a compile error when compiling code. This option is for
replacing those invalid characters by given one.
Attribute type that will be used when attribute has no type specified.
Parameter type that will be used when parameter has no type specified.
Operation return type that will be used when operation has no return type specified.
Whether or not to generate operations for implementing abstract operations defined in super class.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 534
Select Tools > Code > Instant Generator from the toolbar.
2.
3.
Fill in the Output Path, which is the directory where you want the code to generate to.
4.
Select the classes to generate code. In the Diagrams tab, you can select the diagrams to generate code for classes in the selected diagrams.
Alternatively, open the Model Elements tab and select the classes to generate code.
Optionally configure the generator options. Read the section below for a description of options.
6.
Name
Description
P. 535
Language
A list of packages and classes that can be selected for code generation. You must select classes
for code generation.
General options
Some of the common configurable options are shown here. You can configure them in advanced
options.
Output path
Template directory
Template governs how code will be generated from model to code. You can customize the template
to suit your needs, such as to print company specific headers to each code file. If you want to
use your own template, provide the template directory here. If you want to keep using the build in
template, leave this option unchanged to let Visual Paradigm generate with build in template. To
learn more about customization, read the final chapter of this part.
Advanced options
Click this button to configure any options related to code generation in a new window.
If a code file instant generator going to generate is already exist, by checking this option you will be
asked whether to overwrite that file or not. If you uncheck this option, it will help you to overwrite the
existing file automatically.
Output pane
10 Preview
Click to preview the code content. It is just a preview and code will not be generated to the output
path by previewing.
11 Generate
12 Close
Generator options
On the Instant Generator window you can configure some of the common code options at the right of window. You can also configure the advanced
options for more detailed settings by clicking the Advanced Options... button.
Description
Encoding
Attribute prefix
Parameter prefix
Attribute type that will be used when attribute has no type specified.
Parameter type that will be used when parameter has no type specified.
P. 536
The name of the type which is used for containing the private member.
A description of advanced options
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 537
Select Tools > Code > Instant Generator from the toolbar.
2.
3.
Fill in the Output Path, which is the directory where you want the code to generate to.
4.
Select the classes to generate code. In the Diagrams tab, you can select the diagrams to generate code for classes in the selected diagrams.
Alternatively, open the Model Elements tab and select the classes to generate code.
Optionally configure the generator options. Read the section below for a description of options.
6.
Name
Description
P. 538
Language
A list of packages and classes that can be selected for code generation. You must select classes
for code generation.
General options
Some of the common configurable options are shown here. You can configure them in advanced
options.
Output path
Template directory
Template governs how code will be generated from model to code. You can customize the template
to suit your needs, such as to print company specific headers to each code file. If you want to
use your own template, provide the template directory here. If you want to keep using the build in
template, leave this option unchanged to let Visual Paradigm generate with build in template. To
learn more about customization, read the final chapter of this part.
Advanced options
Click this button to configure any options related to code generation in a new dialog box.
If a code file instant generator going to generate is already exist, by checking this option you will be
asked whether to overwrite that file or not. If you uncheck this option, it will help you to overwrite the
existing file automatically.
Output pane
10 Preview
Click to preview the code content. It is just a preview and code will not be generated to the output
path by previewing.
11 Generate
12 Close
Generator options
On the Instant Generator dialog box you can configure some of the common code options at the right of dialog box. You can also configure the
advanced options for more detailed settings by clicking the Advanced Options... button.
Description
Encoding
Attribute prefix
Parameter prefix
Indentation
P. 539
When two classes are associated, checking this option will generate attributes in both
classes with each other as type. When unchecked, attributes will not be generated to both
of them.
Unnamed attribute
Pattern will be applied when generating name for those attribute without name.
Invalid char refers to characters that will result in a compile error when compiling code.
This option is for replacing those invalid characters by given one.
If you check this box, when a role is selected to provide setter/getter, the corresponding
operation(s) will be generated for the role's attribute.
Whether or not to generate setter and getter for accessing attribute of associated class,
when getter and setter are checked.
Whether or not to generate add, remove and to methods for accessing attribute of
associated class, when getter and setter are checked.
A description of advanced options
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 540
2.
Explore %Visual-Paradigm-Installation-Directory%/resources/instantgenerator.
3.
You will see a number of sub-folders that have the programming language as their names. Each of them contains the templates files for a
specific programming language. Copy the folder(s) of the language(s) you need to customize and paste to the working directory.
Customizing template
By having the text editor and the development environment ready, it's time to get your hand dirty with editing the template. As mentioned before, Instant
generator adopted the Apache Velocity engine in generating source code. For those who are interested in knowing how to write templates, please
read Velocity's Users' guide at:
http://velocity.apache.org/engine/releases/velocity-1.5/user-guide.html .
The following example demonstrates how to edit the PHP code generation template to reposition the brace of operation blocks to a new line.
P. 541
Make change.
Add a variable $indentation to indicate the need of printing indentation before the open brace.
P. 542
Add variable
5.
In Visual Paradigm, select Tools > Code > Instant Generator from the toolbar, then the programming language that have the template
customized.
2.
Specify the Template directory where the customized templates are stored.
Select the classes to generate. Specify the output path. Click Generate to generate code. You may refer to previous chapters for details about
instant generator.
Annotation
API
Return Value
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getDocumentation()
String
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
P. 543
AnnotationProperty
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
propertyArray()
Object[]
propertyAt(int)
AnnotationProperty
propertyCount()
int
propertyIterator()
Iterator
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getDocumentation()
String
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
getValue()
String
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
P. 544
Association
taggedValueIterator()
Iterator
associationClassArray()
AssociationClass[]
associationClassAt(int)
AssociationClass
associationClassCount()
int
associationClassIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
fromAssociationClassArray()
Object[]
fromAssociationClassAt(int)
AssociationClass
fromAssociationClassCount()
int
fromAssociationClassIterator()
Iterator
getDocumentation()
String
getFromElement()
Object
getFromEnd()
AssociationEnd
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
getToElement()
Object
getToEnd()
AssociationEnd
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isAbstract()
boolean
isDerived()
boolean
isFromLinkedProject()
boolean
isLeaf()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
toAssociationClassArray()
Object[]
P. 545
AssociationClass
AssociationEnd
toAssociationClassAt(int)
AssociationClass
toAssociationClassCount()
int
toAssociationClassIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getDocumentation()
String
getFromElement()
Object
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
getToElement()
Object
getVisibility()
String
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getAggregationKind()
String
getDocumentation()
String
getMultiplicity()
String
getName()
String
getNavigable()
int
getReferencedAttribute()
Attribute
getStereotype(String)
Stereotype
P. 546
Attribute
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
getTypeModifier()
String
getVisibility()
String
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
isOrdered()
boolean
isProvideGetterMethod()
boolean
isProvideSetterMethod()
boolean
isUnique()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
annotationArray()
Object[]
annotationAt(int)
Annotation
annotationCount()
int
annotationIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getDeclarativeAttribute()
String
getDocumentation()
String
getFieldType()
Object
getInitialValue()
String
getMetadataTag()
String
getMultiplicity()
String
getName()
String
getScope()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
P. 547
getStorage()
int
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
getTemplateTypeBindInfo()
TemplateTypeBindInfo
getType()
getTypeModifier()
String
getVisibility()
String
getXmlSchemaFieldType()
Object
hasGetter()
boolean
hasSetter()
boolean
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
hasXmlSchema()
boolean
isAbstract()
boolean
isConst()
boolean
isDefault()
boolean
isExtern()
boolean
isFinal()
boolean
isFromLinkedProject()
boolean
isHasGetter()
boolean
isHasSetter()
boolean
isIndexer()
boolean
isNew()
boolean
isOrdered()
boolean
isOverload()
boolean
isOverride()
boolean
isReadonly()
boolean
isShadow()
boolean
isTransient()
boolean
isUnique()
boolean
isUnsafe()
boolean
isVirtual()
boolean
isVisible()
boolean
isVolatile()
boolean
isWithEvent()
boolean
propertyParameterArray()
Object[]
propertyParameterAt(int)
Parameter
propertyParameterCount()
int
P. 548
AttributeType
Class
propertyParameterIterator()
Iterator
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getDocumentation()
String
getFixed()
String
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
getUse()
String
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
annotationArray()
Object[]
annotationAt(int)
Annotation
annotationCount()
int
annotationIterator()
Iterator
associationArray()
Association[]
associationAt(int)
Association
P. 549
associationClassArray()
AssociationClass[]
associationClassAt(int)
AssociationClass
associationClassCount()
int
associationClassIterator()
Iterator
associationCount()
int
associationIterator()
Iterator
attributeArray()
Attribute[]
attributeAt(int)
Attribute
attributeCount()
int
attributeIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
containmentClassArray()
Class[]
containmentClassAt(int)
Class
containmentClassCount()
int
containmentClassIterator()
Iterator
fromAssociationArray()
Object[]
fromAssociationAt(int)
Association
fromAssociationClassArray()
Object[]
fromAssociationClassAt(int)
AssociationClass
fromAssociationClassCount()
int
fromAssociationClassIterator()
Iterator
fromAssociationCount()
int
fromAssociationIterator()
Iterator
generalizationArray()
Generalization[]
generalizationAt(int)
Generalization
generalizationCount()
int
generalizationIterator()
Iterator
getDeclarativeAttribute()
String
getDocumentation()
String
getManageType()
int
getMetadataTag()
String
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
getTemplateTypeBindInfo()
TemplateTypeBindInfo
P. 550
getType()
Object
getTypeModifier()
String
getVisibility()
String
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isAbstract()
boolean
isActive()
boolean
isFinal()
boolean
isFromLinkedProject()
boolean
isInterface()
boolean
isLeaf()
boolean
isNew()
boolean
isNotInheritable()
boolean
isRoot()
boolean
isSealed()
boolean
isShadow()
boolean
isStatic()
boolean
isStereotypeInterface()
boolean
isStereotypeTypedef()
boolean
isTypedef()
boolean
operationArray()
Operation[]
operationAt(int)
Operation
operationCount()
int
operationIterator()
Iterator
realizationArray()
Realization[]
realizationAt(int)
Realization
realizationClassArray()
Object[]
realizationClassAt(int)
Class
realizationClassCount()
int
realizationClassIterator()
Iterator
realizationCount()
int
realizationIterator()
Iterator
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
P. 551
Comment
taggedValueCount()
int
taggedValueIterator()
Iterator
templateParameterArray()
TemplateParameter[]
templateParameterAt(int)
TemplateParameter
templateParameterCount()
int
templateParameterIterator()
Iterator
toAssociationArray()
Object[]
toAssociationAt(int)
Association
toAssociationClassArray()
Object[]
toAssociationClassAt(int)
AssociationClass
toAssociationClassCount()
int
toAssociationClassIterator()
Iterator
toAssociationCount()
int
toAssociationIterator()
Iterator
commentCount()
int
commentArray()
Comment[]
commentAt(int)
Comment
commentIterator()
Iterator
getAuthor()
String
getContent()
String
getDateTime()
String
getDocumentation()
String
getName()
String
getSummary()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
stereotypeCount()
int
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeIterator()
Iterator
taggedValueCount()
int
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
P. 552
DataType
ElementType
taggedValueIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getDocumentation()
String
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
templateParameterArray()
Object[]
templateParameterAt(int)
TemplateParameter
templateParameterCount()
int
templateParameterIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getBlock()
String
getDocumentation()
String
getForm()
String
getName()
String
getNillable()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
P. 553
Generalization
getTaggedValueIgnoreCase(String)
TaggedValue
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getDocumentation()
String
getFromElement()
Object
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
getTemplateTypeBindInfo()
TemplateTypeBindInfo
getToElement()
Object
getVisibility()
String
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
isSubstitutable()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
P. 554
ImplModel
Object
taggedValueCount()
int
taggedValueIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getCode()
String
getDocumentation()
String
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getDocumentation()
String
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
P. 555
Operation
isFromLinkedProject()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
annotationArray()
Object[]
annotationAt(int)
Annotation
annotationCount()
int
annotationIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getAlias()
String
getCharset()
int
getDeclarativeAttribute()
String
getDllName()
String
getDocumentation()
String
getImplModel()
ImplModel
getMetadataTag()
String
getMethodKind()
int
getName()
String
getOperatorType()
int
getProcedureName()
String
getReturnType()
Object
getReturnTypeDocumentation()
String
getReturnTypeModifier()
String
getScope()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
getTemplateTypeBindInfo()
TemplateTypeBindInfo
getVisibility()
String
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
P. 556
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isAbstract()
boolean
isConst()
boolean
isDeclare()
boolean
isDelegate()
boolean
isExtern()
boolean
isFinal()
boolean
isFriend()
boolean
isFromLinkedProject()
boolean
isInline()
boolean
isNative()
boolean
isNew()
boolean
isNotOverridable()
boolean
isOverload()
boolean
isOverridable()
boolean
isOverride()
boolean
isQuery()
boolean
isReturnTypeConst()
boolean
isSealed()
boolean
isShadow()
boolean
isSynchronized()
boolean
isUnsafe()
boolean
isVirtual()
boolean
isVisible()
boolean
parameterArray()
Object[]
parameterAt(int)
Parameter
parameterCount()
int
parameterIterator()
Iterator
postConditionArray()
Object[]
postConditionAt(int)
Text
postConditionCount()
int
postConditionIterator()
Iterator
preConditionArray()
Object[]
preConditionAt(int)
Text
preConditionCount()
int
preConditionIterator()
Iterator
raisedExceptionArray()
Object[]
raisedExceptionAt(int)
Object
raisedExceptionCount()
int
P. 557
Package
raisedExceptionIterator()
Iterator
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
templateParameterArray()
Object[]
templateParameterAt(int)
TemplateParameter
templateParameterCount()
int
templateParameterIterator()
Iterator
classArray()
Class[]
classAt(int)
Class
classCount()
int
classIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getDocumentation()
String
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
packageArray()
Object[]
packageAt(int)
Package
packageCount()
int
packageIterator()
Iterator
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
P. 558
Parameter
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
templateParameterArray()
Object[]
templateParameterAt(int)
TemplateParameter
templateParameterCount()
int
templateParameterIterator()
Iterator
annotationArray()
Object[]
annotationAt(int)
Annotation
annotationCount()
int
annotationIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getDeclarativeAttribute()
String
getDefaultValue()
String
getDirection()
String
getDocumentation()
String
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
getTemplateTypeBindInfo()
TemplateTypeBindInfo
getType()
Object
getTypeModifier()
String
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isConst()
boolean
isFinal()
boolean
isFromLinkedProject()
boolean
isOptional()
boolean
isParamArray()
boolean
isParams()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
P. 559
Realization
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getDocumentation()
String
getFromElement()
Object
getMapping()
String
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
getTemplateTypeBindInfo()
TemplateTypeBindInfo
getToElement()
Object
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getDocumentation()
String
getName()
String
getStereotype(String)
Stereotype
P. 560
TaggedValue
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getDocumentation()
String
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
getType()
int
getValue()
Object
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
P. 561
TemplateParameter
TemplateTypeBindDetails
taggedValueIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getDefaultValue()
String
getDocumentation()
String
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
templateTypeBindInfoArray()
Object[]
templateTypeBindInfoAt(int)
TemplateTypeBindInfo
templateTypeBindInfoCount()
int
templateTypeBindInfoIterator()
Iterator
typeArray()
Object[]
typeAt(int)
Object
typeCount()
int
typeIterator()
Iterator
typeModifierArray()
Object[]
typeModifierAt(int)
String
typeModifierCount()
int
typeModifierIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
P. 562
TemplateTypeBindInfo
commentIterator()
Iterator
getArguments()
TemplateTypeBindInfo
getDocumentation()
String
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
getWildcard()
int
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
detailsArray()
Object[]
detailsAt(int)
TemplateTypeBindDetails
detailsCount()
int
detailsIterator()
Iterator
getBindedType()
Object
getDocumentation()
String
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
getTypeModifier()
String
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
P. 563
Text
TextType
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getDocumentation()
String
getName()
String
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
commentArray()
Comment[]
commentAt(int)
Comment
commentCount()
int
commentIterator()
Iterator
getDocumentation()
String
getName()
String
P. 564
getStereotype(String)
Stereotype
getStereotypeIgnoreCase(String)
Stereotype
getTaggedValue(String)
TaggedValue
getTaggedValueIgnoreCase(String)
TaggedValue
hasStereotype(String)
boolean
hasStereotypeIgnoreCase(String)
boolean
hasTaggedValue(String)
boolean
hasTaggedValueIgnoreCase(String)
boolean
isFromLinkedProject()
boolean
stereotypeArray()
Stereotype[]
stereotypeAt(int)
Stereotype
stereotypeCount()
int
stereotypeIterator()
Iterator
taggedValueArray()
TaggedValue[]
taggedValueAt(int)
TaggedValue
taggedValueCount()
int
taggedValueIterator()
Iterator
templateParameterArray()
Object[]
templateParameterAt(int)
TemplateParameter
templateParameterCount()
int
templateParameterIterator()
Iterator
Velocity syntax
The following lists the syntax that of statements that can be used in the template.
## ===== If =====
#if(...)
...
#end
## ===== If-then-Else =====
#if(...)
...
#else
...
#end
## ===== For-each =====
#foreach
...
#end
## ===== Continue with the template defined in (...) at the point where the call is made =====
#parse(...)
#set(...)
## ===== Comment =====
## ...
## ===== Comment =====
#* ... *#
## ===== Variable=====
${...}
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 565
P. 566
Java Round-Trip
Round-trip engineering refers to the synchronization between source code in Java project and UML class model in VP-UML's modeling environment. In
this chapter, you will learn how to perform round-trip engineering in Visual Paradigm.
Generate/Update Java code
To produce or update source files from UML class model.
Generate/Update UML classes from Java code
To produce or update UML class model from source files.
Java Round-Trip
P. 567
Select Tools > Code > Generate Java Code... from the toolbar.
2.
In the Generate Code dialog box, specify the mapping between model and source path. Model is a UML element that acts as a container of
other elements. Classes and packages under a model will be generated to the mapped source path. You can add multiple model-to-sourcepath mapping by pressing the + button. If you are not using model to structure your project, or if you want to generate all classes in project to the
same folder, regardless of their parent model, keep model to be <root>.
Optionally, configure the advanced code generation options by clicking Advanced Options.... Read the section Advanced Options in this
chapter for details about the options.
4.
NOTE:
Right click on the class diagram background and select Utilities > Java Round-trip > Generate Code from the popup menu.
2.
In the Generate Code dialog box, specify the source path where you want the code to be generated. Model is a UML element that acts as a
container of other elements. Notice that source path is set for model, not for diagram. Classes and packages under a model will be generated to
the mapped source path. You can add multiple model-to-source-path mapping by pressing the + button. If you are not using model to structure
your project, or if you want to generate all classes in project to the same folder, regardless of their parent model, keep model to be <root>.
P. 568
NOTE:
If you have generated code for once, the Generate Code dialog box will not appear next time when you generate/update code,
for any diagram. If you want to configure the model-to-source-path mapping or to configure options, you can run a code
generation for project (refer to the previous section for detail).
3.
Optionally configure the advanced code generation options by clicking Advanced Options.... Read the section Advanced Options in this
chapter for details about the options.
4.
NOTE:
Select the class(es) and right click on them, then select Java Round-trip > Generate Code from the popup menu.
2.
In the Generate Code dialog box, specify the source path where you want the code to be generated. Model is a UML element that acts as a
container of other elements. Notice that source path is set for model, not for diagram. Classes and packages under a model will be generated to
the mapped source path. You can add multiple model-to-source-path mapping by pressing the + button. If you are not using model to structure
your project, or if you want to generate all classes in project to the same folder, regardless of their parent model, keep model to be <root>.
NOTE:
If you have generated code for once, the Generate Code dialog box will not appear next time when you generate/update code,
for any class selection. If you want to configure the model-to-source-path mapping or to configure options,
you can run a code generation for project (refer to the previous section for detail).
3.
Optionally configure the advanced code generation options by clicking Advanced Options.... Read the section Advanced Options in this
chapter for details about the options.
4.
NOTE:
P. 569
Name
Description
Language
Click to add a new mapping between UML model and the source path where code will be
generated to.
Model-to-source-path mapping
Advanced options
Click to configure advanced code generation options. For details, read the section
Advanced Options in this chapter.
Ignore classes
Click to organize the ignore list of classes to ignore in code generation. For details, read
the section To ignore classes in generation in this chapter.
OK
10 Cancel
Advanced options
You can configure the advanced options for more control of the code by clicking the Advanced Options... button in Generate Code dialog box. In the
Code Synchronization dialog box popped up, there are four categories (tabs) of settings you can configure. Below is a description.
Code
P. 570
Code configuration
Option
Description
Java Collection
Generate annotation on
P. 571
Class declaration
Constructor declaration
Method declaration
Enum declaration
Indentation policy
Indentation size
Description
Same line - (default) Brace for class declaration appear at the same line as the declaration
Next line - Brace for class declaration appear at the line after the declaration
Same line - (default) Brace for constructor appear at the same line as the declaration
Next line - Brace for constructor appear at the line after the declaration
Same line - (default) Brace for method appear at the same line as the declaration
Next line - Brace for method appear at the line after the declaration
Same line - (default) Brace for enumeration appear at the same line as the declaration
Next line - Brace for enumeration tor appear at the line after the declaration
Same line - (default) Brace for annotation type appear at the same line as the declaration
Next line - Brace for annotation type appear at the line after the declaration
Spaces - Use spaces as indentation. The number of spaces can be defined below
P. 572
New Lines
Description
Number of blank lines to appear before the first declaration within Class declarations
Template
P. 573
Template configuration
Option
Description
Operation Template
Defines a template of method body that will be applied when generating operations.
Getter Template
Defines a template of getter that will be applied when generating getter methods. Getter will be generated to attribute
stereotyped as Property, or with property getter selected.
Setter Template
Defines a template of setter that will be applied when generating setter methods. Setter will be generated to attribute
stereotyped as Property, or with property setter selected.
A description of template configuration
P. 574
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 575
Select Tools > Code > Reverse Java Code... from the toolbar.
2.
In the Reverse Code dialog box, specify the mapping between source path and model. Model is a UML element that acts as a container of other
elements. You can place the UML classes to be produced to specific model for better categorization. For example, you may create a Prototype
model and an Implementation model for storing classes developed in prototype and implementation phrases respectively. Once a mapping is
defined, round-trip engineering will be performed between the model and path as defined. You can add multiple Source-path-to-model mapping
by pressing the + button. If you do not use model to structure your project, keep model to be <root>.
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.
4.
NOTE:
In order to trigger this function, make sure you have performed round-trip engineering at least for once and the diagram has at least one
class.
P. 576
Name
Description
Language
Click to add a new mapping between source path where code will be reversed from and
UML model.
Model-to-source-path mapping
By checking, this means to form indexes to the source path(s) instead of actually reversing
them. For details about on demand reverse engineering, refer to the section below.
OK
Cancel
The option Reverse source on demand that appear in reverse dialog box
When finished 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.
P. 577
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 578
C++ Round-Trip
Round-trip engineering refers to the synchronization between source code in Java project and UML class model in Visual Paradigm's modeling
environment. In this chapter, you will learn how to perform round-trip engineering in Visual Paradigm.
Generate/Update C++ code
To produce or update source files from UML class model.
Generate/Update UML classes from C++ code
To produce or update UML class model from source files.
C++ Round-Trip
P. 579
Select Tools > Code > Generate Java Code... from the toolbar. .
2.
3.
In the Generate Code dialog box, specify the mapping between model and source path. Model is a UML element that acts as a container of
other elements. Classes and packages under a model will be generated to the mapped source path. You can add multiple model-to-sourcepath mapping by pressing the + button. If you are not using model to structure your project or if you want to generate all classes in project to the
same folder, regardless of their parent model, keep model to be <root>.
Optionally configure the advanced code generation options by clicking Advanced Options.... Read the section Advanced Options in this
chapter for details about the options.
5.
NOTE:
Right click on the class diagram background and select Utilities > C++ Round-trip > Generate Code from the popup menu.
2.
In the Generate Code dialog box, specify the source path where you want the code to be generated. Model is a UML element that acts as a
container of other elements. Notice that source path is set for model, not for diagram. Classes and packages under a model will be generated to
the mapped source path. You can add multiple model-to-source-path mapping by pressing the + button. If you are not using model to structure
your project, or if you want to generate all classes in project to the same folder, regardless of their parent model, keep model to be <root>.
P. 580
NOTE:
If you have generated code for once, the Generate Code dialog box will not appear next time when you generate/update code,
for any diagram. If you want to configure the model-to-source-path mapping or to configure options,
you can run a code generation for project (refer to the previous section for detail).
3.
Optionally configure the advanced code generation options by clicking Advanced Options.... Read the section Advanced Options in this
chapter for details about the options.
4.
NOTE:
Select the class(es) and right click on them, then select C++ Round-trip > Generate Code from the popup menu.
2.
In the Generate Code dialog box, specify the source path where you want the code to be generated. Model is a UML element that acts as a
container of other elements. Notice that source path is set for model, not for diagram. Classes and packages under a model will be generated to
the mapped source path. You can add multiple model-to-source-path mapping by pressing the + button. If you are not using model to structure
your project, or if you want to generate all classes in project to the same folder, regardless of their parent model, keep model to be <root>.
NOTE:
If you have generated code for once, the Generate Code dialog box will not appear next time when you generate/update code,
for any class selection. If you want to configure the model-to-source-path mapping or to configure options,
you can run a code generation for project (refer to the previous section for detail).
P. 581
3.
Optionally configure the advanced code generation options by clicking Advanced Options.... Read the section Advanced Options in this
chapter for details about the options.
4.
NOTE:
Name
Description
Language
Click to add a new mapping between UML model and the source path where code will be
generated to.
Model-to-source-path mapping
Advanced options
Click to configure advanced code generation options. For details, read the section
Advanced Options in this chapter.
Ignore classes
Click to organize the ignore list of classes to ignore in code generation. For details, read
the section To ignore classes in generation in this chapter.
OK
10 Cancel
Advanced options
You can configure the advanced options for more control of the code by clicking the Advanced Options... button in Generate Code dialog box. In the
Code Synchronization dialog box popped up, there are four categories (tabs) of settings you can configure. Below is a description.
Code
P. 582
Code configuration
Option
Description
(default int) Type that will be assigned to Attribute upon code generation when type is unspecified
(default void) Return Type that will be assigned to operation upon code generation when return type is
unspecified
(default int) Type that will be assigned to Parameter upon code generation when type is unspecified
System default - (default) The default system encoding will be selected as encoding for source files
P. 583
Class declaration
Constructor declaration
Method declaration
Enum declaration
Indentation policy
Indentation size
Description
Same line - (default) Brace for class declaration appear at the same line as the declaration
Next line - Brace for class declaration appear at the line after the declaration
Same line - (default) Brace for constructor appear at the same line as the declaration
Next line - Brace for constructor appear at the line after the declaration
Same line - (default) Brace for method appear at the same line as the declaration
Next line - Brace for method appear at the line after the declaration
Same line - (default) Brace for enumeration appear at the same line as the declaration
Next line - Brace for enumeration tor appear at the line after the declaration
Spaces - Use spaces as indentation. The number of spaces can be defined below
New Lines
P. 584
Description
Number of blank lines to appear before the first declaration within Class declarations
Template
P. 585
Template configuration
Option
Description
Operation Template
Defines a template of method body that will be applied when generating operations.
Getter Template
Defines a template of getter that will be applied when generating getter methods. Getter will be generated to attribute
stereotyped as Property, or with property getter selected.
Setter Template
Defines a template of setter that will be applied when generating setter methods. Setter will be generated to attribute
stereotyped as Property, or with property setter selected.
A description of template configuration
P. 586
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 587
Select Tools > Code > Reverse Java Code... from the toolbar.
2.
3.
In the Reverse Code dialog box, specify the mapping between source path and model. Model is a UML element that acts as a container of other
elements. You can place the UML classes to be produced to specific model for better categorization. For example, you may create a Prototype
model and an Implementation model for storing classes developed in prototype and implementation phrases respectively. Once a mapping is
defined, round-trip engineering will be performed between the model and path as defined. You can add multiple Source-path-to-model mapping
by pressing the + button. If you do not use model to structure your project, keep model to be <root>.
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.
NOTE:
In order to trigger this function, make sure you have performed round-trip engineering at least for once and the diagram has at least one
class.
P. 588
Name
Description
Language
Click to add a new mapping between source path where code will be reversed from and
UML model.
Model-to-source-path mapping
By checking, this means to form indexes to the source path(s) instead of actually reversing
them. For details about on demand reverse engineering, refer to the section below.
OK
Cancel
The option Reverse source on demand that appear in reverse dialog box
When finished 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.
P. 589
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 590
P. 591
Select Tools > Hibernate > Reverse Java Classes... from the toolbar.
2.
In the Reverse Java Classes dialog box, click Add to add the classpaths where the ORM classes exist.
3.
From the Available Classes pane, select the classes you want to reverse and click >.
4.
Click OK. You can find the reversed classes in the Model Explorer.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Reversing POJO
P. 592
P. 593
Select Tools > Hibernate > Generate Code... from the toolbar.
2.
Framework
Description
Determines how the mapping between class model and ER model is to be recorded.
Hibernate XML - Hibernate mapping file (.hbm.xml) will be generated. It contains the mapping between class model and ER model
in XML format.
JPA - Not to generate the Hibernate mapping file but to store the mapping information directly in the generated Java source file as
annotations.
Error Handling
For Error Handling, select the way to handle errors. The possible errors include PersistentException, GenericJDBCException, and
SQLException.
Return false/null - It returns false/null in the method to terminate its execution.
Throw PersistentException - It throws a PersistentException which will be handled by the caller. A try/catch block has to be
implemented to handle the exception.
Throw RuntimeException - It throws a RuntimeException which will be handled by the caller. A try/catch block has not been
implemented to handle the exception. The exception will be caught at runtime.
Throw User Defined Exception - It throws an exception that is defined by user. Select this to input the fully qualified name of the
Exception class.
Exception
Handling
Default Lazy
Collection
Initialization
Lazy collection initialization avoids the associated objects from being loaded when the main object is loaded. With lazy collection
initialization, all associated object (1 to many) will not be loaded until you access it (e.g. getFlight(0)). Enabling this option can
usually reduce more than 80% of the database loading.
Lazy - You must update both ends of a bi-directional association manually to maintain the consistency of the association. Besides,
casting of object(s) to its corresponding persistence class is required when retrieving object(s) from the collection.
P. 594
Extra - When you update one end of a bi-directional association, the generated persistent code is able to update the other end
automatically. Besides, you do not need to cast the retrieved object(s) into its corresponding persistence class when retrieving
object(s) from the collection.
Non-lazy - Load the associated objects when the main object is loaded.
Default Lazy
Association
Initialization
Each association can set lazy. This setting is for those associations that has lazy set as Unspecified.
Proxy fetching - A single-valued association is fetched when a method other than the identifier getter is invoked upon the
associated object.
"No-proxy" fetching - A single-valued association is fetched when the instance variable is accessed. Compared to proxy fetching,
this approach is less lazy; the association is fetched even when only the identifier is accessed. It is also more transparent, since no
proxy is visible to the application. This approach requires buildtime bytecode instrumentation and is rarely necessary.
False - Not to set lazy.
Association
Handling
Smart association handling, updating either side of a bi-directional association will automatically trigger an update on the other
side. For example:
many.setOne(one);
or
one.many.add(many);
It also provides static type checking by using strong type collection.
With Standard association handling, you will need to update both sides of a bi-directional association to maintain consistency. For
example:
many.setOne(one);
one.getMany().add(many);
With Generics association handling, you will need to update both sides of a bi-directional association to maintain consistency,
which is the same as the Standard association handling as described above, except that for Generics association handling,
generics (e.g. Set<Account>) has been used for type specialization.
Persistent API
For Persistent API, select the type of persistent code to be generated, either Static Methods, Factory Class, DAO or POJO. The
decision to which API to select depends on the practice of coding.
Static Methods - Client can create, retrieve and persist with the PersistentObject directly.
Factory Class - FactoryObject class will be generated for client to create and retrieve the PersistentObject. Client can directly
persist with the PersistentObject.
DAO - The PersistentObjectDAO class helps client to create, retrieve and persists to PersistentObject.
DAO (with Interface) - A variation of DAO. In DAO (with Interface), the DAO class become an interface, and the implementation is
moved to the DAOImpl class. Instance methods are used instead of Static methods. With these changes, you can define your own
DAO objects and swap between DAO implementations easily.
POJO - The PersistentManager helps client to retrieve and persist with PersistentObject.
Mapping only - Just to generate the mapping without generating any code file.
Generate
Criteria
Check the option to generate the criteria class for each ORM Persistable class. The criteria class is used for querying the database
in object-oriented way.
Serializable
Cache
Options
Selected
Optional Jar
Select the libraries and JDBC driver to be included in the generation of the orm.jar file (Persistent Library).
Advanced
Settings
All Properties - the toString method returns a string with the pattern
ID Only - the toString method returns the value of the primary key of the object as string.
"Entity[<column1_name>=<column1_value><column2_name>=(column2_value>...]"
Business Key - You can specify business key per class, inside the Business Key tab of class specification. Business keys
comprise of attributes. The toString method will return a string of business keys.
Flush Mode - Select the Flush Mode to be used in flushing strategy. User can select Auto, Commit, Always and Never.
P. 595
Never - The Session is never flushed unless the flush method is called.
Sample files, including Java application sample, Servlet sample and Java Server Page (JSP) sample are available for guiding you
through the usage of the Java persistence class. You can check the option(s) to generate the type of sample files you need.
Scripts
Check the option(s) to generate Ant File/Batch/Shell scripts, for the direct execution of generated code.
Generate
Filter
and Web
Application
Descriptor
(web.xml)
Determines whether to generate the file web.xml essential in Web application development.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 596
Switch to ORM Association Detail tab, select Lazy or Extra for From lazy initialization or To lazy initialization, depending on which side
multiplicity is *. Lazy collection is fetched when the application invokes an operation upon that collection. Extra lazy supports individual elements
of the collection are accessed from the database as needed, rather than fetch the whole collection. If the value is Unspecified, it will follow the
default lazy collection setting described below.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 597
Persistent API
The persistent API setting supports various styles for generated code. It can be configurated in Database Code Generation dialog box.
Static methods
Static methods generate all persistent methods in the persistent class, client can access the methods in the same persistent object.
Static methods
Factory class
Factory class generates save/delete/refresh methods in persistent class, other persistent methods that return persistent object are generated in factory
class.
Persistent API
P. 598
Factory class
DAO
DAO generates all persistent methods in DAO class, a DAO class is generate for each persistent class.
DAO
POJO
POJO generate persistent object in Plain Old Java Object style, without generating any persistent methods. Client can access persistent methods in
PersistentManager object.
Persistent API
P. 599
POJO
Mapping only
Mapping only does not generate any code, it only generates the XML mapping file required for ORM.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Persistent API
P. 600
1);
Updating records
1.
Select a persistent object from database.
2.
3.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 601
A part of the generated code, showing the getters and setters generated from attributes of an ORM Persistable class
To customize getter/setter of attribute:
1.
Right click on the attribute that you want to customize its getter or setting and select Open Specification... from the popup menu.
Open the ORM Attribute Detail tab and enter the code body in Getter/Setter code sections.
P. 602
Customized setter
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 603
P. 604
Modeling guidelines
A state machine involves a number of states as well as the transition of states. You can generate source code for a state machine by first creating a
controller class, then create sub-state machine diagram from the controller class, model the state machine. In this chapter, you will see how to model a
state machine readily for code generation. For the steps of code generation, read the next chapter.
Step 1 - Modeling controller class
A controller class is a class that is used for controlling and managing the activities within a use case. It also manage the states within the use case or
the system.
A controller class
You can create a controller class by selecting Class from diagram toolbar and click on the diagram. Name the class properly to represent the nature
of controller class. Very often, people name controller class as SomethingController where the Something refers to a use case or the model that the
controller need to manage. For example, a PhoneController is for controlling operations of a telephone and managing its states like waiting, dialing, etc.
You can add attributes to the class by right clicking on it and selecting Add > Attribute from the popup menu. Attributes defined will be generated to
code. However, you do NOT need to add attributes for states nor attributes for remembering states. Everything about states will be managed by the
state machine in state machine diagram.
Add operations to the class by right clicking on it and selecting Add > Operation from the popup menu. There should be operations that may update
the state.
Step 2 - Modeling state machine
You need to create a sub state machine diagram from the controller and model the state machine there. To create a sub state machine diagram, move
the mouse pointer over the controller class, click on the resource icon at bottom right corner and select New Diagram... from the popup menu. In the
New Diagram window, select UML Digrams> State Macheine. Click OK to confirm.
A state machine
You do not need to name the transitions as we will assign operations to them. But if you want you can do this. It will not affect the code that will be
generated.
Step 3 - Assigning operations to transitions
A transition is a relationship between two states, representing the update of states. Previously you have defined operations in controller class. Now,
you need to assign those operations to the transitions to indicate the cause of state change. To assign an operation to transition:
1.
Right click on a transition and select Open Specification... from the popup menu.
Modeling guidelines
P. 605
Click Add and select Call Trigger from the popup menu.
In the General tab, specify the operation from the Operation drop down menu.
Select operation
Repeat the steps to assign operations to all transitions.
Step 4 - Specifying method body for the entry/exit of state
You can specify the invokcation of method call when entering and exiting a state by updating the Entry properties of state. To do this:
1.
Right click on the state and select Open Specification... from the popup menu.
2.
Click on the drop down menu next to the Entry field, then select Create Activity....
3.
In the specification, fill in the Body field by entering the methods to invoke. Click OK to confirm.
Modeling guidelines
P. 606
2.
Click on the drop down menu next to the Exit field, then select Create Activity....
3.
4.
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Modeling guidelines
P. 607
Select Tools > Code > Generate State Machine Code... frrom the toolbar.
2.
In the Generate State Machine dialog box, select the controller class for generating state machine.
3.
Select the state machine in the drop down menu State Diagram for generating code.
4.
5.
6.
7.
Click OK to generate.
NOTE:
There must be at least one class that contain sub state machine diagram in order to open the Generate State Machine Code dialog box.
Name
Description
Class
State Diagram
The state machine (in the form of state machine diagram) to generate. It must be a sub-class of the chosen controller class.
Language
Output Path
Options
VB.net: encapsulate the transition method's body in a SyncLock Me, End SyncLock block.
Generate try/catch - Uncheck to not generate try/catch code. You are recommended to keep this checked. Uncheck only in C
++ applications where exceptions are not used.
Generate debug message - Adds debug output messages to the generated code.
Re-generate transition methods - Check to overwrite the transition methods in code, including the implementation.
Browse output directory after generate - Open the output path.
Auto create transition operations - If a transition is named, but does not have Operation assigned. By checking this option
operation will be created to the parent class, named as the transition name.
Generate sample - Generate sample files to guide you how to work with the generated file.
P. 608
Generate diagram image - Generate PNG image for chosen state machine diagram.
6
OK
Cancel
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 609
Select Tools > Code > Reverse State Machine Code... from the toolbar.
2.
Specify the class, state diagram and the .sm file in the input field. Click OK to continue.
Description
Class
The controller class for managing the state. Only classes that have a state machine diagrams as sub-diagrams would
be listed in the drop down menu. You can select an existing class for managing the state machine. If such a class is not
available, leave the option Auto create class model selected.
State Diagram
The diagram where the state machine definition to be reversed will be visually presented at. State machine diagrams
that are sub-diagram of classes are listed in the drop down menu. You can select the one for visualizing the state
machine definition or create a new one by selecting Auto create state diagram.
Input File
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 610
P. 611
Activity Diagram - How can a provider design and produce the REST API?
The following Activity Diagram shows you the steps that a consumer will take in order to use the service. Consumer of service can visit the API
documentation page, download an XML file and then import the XML file into Visual Paradigm. By doing so, they can then generate the source code
and the API required in accessing the service. The final step would be to program the application that uses the service with the generated source code.
Activity Diagram - How can a client access a service with REST API?
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 612
Select Diagram > New from the toolbar. In the New Diagram Window, select Class Diagram and the click Next. Enter the diagram name and
description and then click OK.
2.
Click on the diagram to create a REST Resource. Name the resource by giving it a short and meaningful name.
Right click on the REST Resource and select Open Specification... from the popup menu.
Description
URI
Each REST Resource has its own URI. Consumers access to URL to access for the REST Resource.
Typically, a RESTful URI should refer to a resource that is a thing instead of referring to an action. Therefore, when you
are deciding the URI, try to use a noun instead of a verb.
Method
Specifies the action to act on the resource. For details, please read the section Methods (HTTP methods) below.
Description
Description of resource that will appear in generated API documentation. It is recommended to provide clear description of
the service, so that the consumer know what the service is and how to operate with it.
General properties of a REST Resource
P. 613
7.
If the REST Resource uses a POST, PUT or DELETE method and if parameter is required in using the REST Resource, model the parameters
by drawing class(es). Move your mouse pointer over the REST Request Body icon. Drag out the resource icon Association -> One Class.
Release the mouse button to create the Request class. The class is named based on the REST Resource by default. You can rename it if you
like. For instance, if you are going to create a member via the /members REST Resource, you probably need to send the member's details to
the server for creating a member record. Therefore, name the class Member for storing member's details.
Add the attributes into the classes. These attributes will hold the data that sends to the server.
Attributes added
Here is a comparison between the class model and the representation of request body in JSON.
P. 614
Now, you can move on to designing the response part of the REST Resource. Move your mouse pointer over the REST Request Body icon. If
the service will return a simple data value or object, drag out the resource icon Association -> One Class. If the service will return an array of
object, drag out the resource icon Association -> Many Class.
Name the class and add the attribute into the class.
P. 615
Parameters are referring to query parameters used for passing data to a service. For example, when you use a 'currency converter' service, you
probably need to pass the amount to convert, the current currency and the target currency to the service, in return for the converted amount. The
amount to convert, the current and target currency are therefore the parameters of service.
A feature of parameters is that they are optional. Another character of parameters is that they are non-unique, which means that you can add the same
parameter multiple times.
Parameters are appended to the path of a URL when submitting a HTTP request. A URL with parameters could look like this:
http://www.example.com?age-limit=18
To add parameters to a REST Resource:
1.
Right click on the REST Resource and select New Parameter from the popup menu.
New parameter
2.
Enter the name of the parameter. If you like, you can specify the type as well. Note that the specification of type is just for documentation
purpose. While it helps the consumer to understand what kind of data is expected, it won't have any effect in code level. In coding, parameters
are always put into a Map that takes string as both key and value.
Parameter created
3.
Press Enter.
4.
Repeat step 2 and 3 to create all parameters. Press Esc when finished creating all parameters.
Parameters created
Right click on the REST Resource and select Open Specification... from the popup menu.
2.
3.
Enter the Header. As we said in the Overview of REST API page that REST is not a standard but architectural style. REST makes use of HTTP
standard, so, any REST call header is in fact HTTP header. For more details about headers, read the Headers (HTTP headers) section below.
4.
P. 616
Right click on the REST Resource and select Open Specification... from the popup menu.
2.
3.
Enter the Header. As we said in the Overview of REST API page that REST is not a standard but architectural style. REST makes use of HTTP
standard, so any REST call header is in fact HTTP header. For more details about headers, read the Headers (HTTP headers) section below.
4.
P. 617
GET / HTTP/1.1 Host: www.visual-paradigm.com User-Agent: Mozilla/5.0 (Windows NT 6.3; WOW64; rv:33.0)
Gecko/20100101 Firefox/33.0 Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 AcceptLanguage: en-US,en;q=0.5 Accept-Encoding: gzip, deflate Cookie: landing=b7b93a316f374b13af4d5904c9797dcc;
__utma=... Connection: keep-alive Pragma: no-cache Cache-Control: no-cache
After the request, your web browser receives an HTTP response and the HTML content to be displayed.
As we said in the Overview of REST API page that REST is not a standard but architectural style. REST makes use of HTTP standard. Therefore, any
REST call headers are in fact HTTP headers.
Methods (HTTP methods)
HTTP methods, or sometimes known as HTTP verbs, specify the action to act on a resource. The most commonly used HTTP methods are GET, PUT,
POST and DELETE, which correspond to read, update, create and delete operations, respectively.
Method
Description
GET
A GET method (or GET request) is used to retrieve a representation of a resource. It should be used SOLELY for retrieving data and should
not alter.
PUT
A PUT method (or PUT request) is used to update a resource. For instance, if you know that a blog post resides at http://www.example.com/
blogs/123, you can update this specific post by using the PUT method to put a new resource representation of the post.
POST
A POST method (or POST request) is used to create a resource. For instance, when you want to add a new blog post but have no idea
where to store it, you can use the POST method to post it to a URL and let the server decide the URL.
DELETEA DELETE method (or DELETE request) is used to delete a resource identified by a URI.
Description of different HTTP methods
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 618
Select Tools > Code > Generate REST API... from the toolbar.
2.
In the REST API window, keep Provider selected for API Type. By doing so, you will be able to generate API documentation as well as the
server sample code that guides you in programming your service (logic).
3.
Check Generate API Documentation to generate the HTML files that shows how to use the selected REST Resource(s). Supposedly, you will
publish the generated API documentation in your website so that the consumers of your service can read through it to know how to access for
your service.
5.
Enter your company name, which will be presented in the API documentation.
6.
7.
Check Generate Sample to generate the source code that teaches you how to program your service. The sample code is rich and informative.
Therefore, instead of programming from scratch, we strongly recommend you to generate the sample code and modify its content to fit your
needs.
8.
Click Generate. Depending on the option checked/unchecked, you may see the following folders in the output directory.
Folder
Description
doc
The API documentation. You should publish the API documentation in your website, so that the consumers of your service
can check the documentation to learn the API.
lib
In order for the generated code to work, the Google Gson library must be presented in your class path. To avoid any
compatibility issues, please download library manually:
https://code.google.com/p/google-gson/
and then place the file in the lib folder.
P. 619
sample_src
The sample code of client and servlet. It shows you how to access as client and how to react to a request as provider. We
strongly recommend you to copy the code and modify it by filling in your own service logic.
src
The source code of the communication model. Do not modify the file content or else the code may not be able to function
properly.
Description of generated files
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 620
Visit the API documentation of the service published by service provider. The API documentation should look like this:
You can learn the usage of the REST resource by reading through the API documentation. To obtain the API code, scroll down to the bottom of
the API documentation. Click on the download link of the REST API model XML file at the bottom of the page.
4.
5.
Import the REST API model XML file into Visual Paradigm by selecting Project > Import > XML... from the toolbar.
6.
In the Import XML window, enter the file path of the XML file and click Import.
In the Diagrams tab of the Project Browser, double click on the class diagram created by importing the XML file.
P. 621
You can now see the communication model of the REST Resoure which looks like this:
Now, you can generate the API code. Select Tools > Code > Generate REST API... from the toolbar.
10.
13.
14.
Check Generate Sample to generate the source code that teaches you how to access the service. The sample code is rich and informative.
Therefore, instead of programming from scratch, we strongly recommend you to generate the sample code and modify its content to fit your
needs.
15.
P. 622
Click Generate. Depending on the option checked/unchecked, you may see the following folders in the output directory.
Folder
Description
lib
In order for the generated code to work, the Google Gson library must be presented in your class path. To avoid any
compatibility issues, please download library manually:
https://code.google.com/p/google-gson/
and then place the file in the lib folder.
sample_src
The sample code that shows you how to access the service. We strongly recommend you copy the code and modify it by
filling in your own application logic.
src
The source code of the communication model. Do not modify the file content or else the code may not function properly.
Description of generated files
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 623
Database Modeling
Model your database entity relationship diagram. You will learn how to draw entity relationship diagram as well as the supported notations such as
entity, sequence, stored procedure and trigger.
Drawing sequence
Learn what is database sequence.
Drawing triggers
Learn how to model and document database triggers.
Customizing ID generator
Customize the ID generator for us in generating ID.
Database Modeling
P. 624
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
6.
This creates an Entity Relationship Diagram. At the top right corner of the diagram, select the Data Model. All entities created in this diagram
will be set to the chosen data model. And note that only entities in physical model will be included in generating database/DDL.
Drawing entity
Click Entity from diagram toolbar and drag it on the diagram pane.
Create entity
Click on diagram and specify the entity's name.
Rename an entity
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.
P. 625
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
P. 626
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.
A conceptual model
Logical model is more complex than conceptual model. You can include more details for columns by specifying their types (e.g. text, integer, date).
P. 627
A logical model
Physical model is the most complex one. Database designers add primary or foreign keys to entities and rename entities and columns to satisfy the
table or column naming convention. The physical model represents how to implement your data model in database.
A physical model
To split a table, move the mouse pointer over the entity you want to split and drag out the One-to-One Relationship -> Partial Table.
3.
In the Split Table dialog box, select the columns you want to move to the split table and click >.
P. 628
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 629
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.
NOTE:
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Drawing sequence
P. 630
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.
P. 631
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.
P. 632
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 633
Drawing triggers
Trigger is procedure that is stored in a relational database. It will be executed when a table is modified. A typical use of database trigger is for
restricting access to specific data.
Create a triggers shape
Click Triggers from diagram toolbar and drag it on the diagram pane.
Drawing triggers
P. 634
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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Drawing triggers
P. 635
Right click the primary key column that you want to select an ID generator for and select Open Specification... from the pop-up menu.
In Column Specification dialog box, select the ID Generator and then click OK to confirm.
Description
assigned
allows the application to assign an identifier to the object before save() is called.
guid
hilo
uses a hi/lo algorithm to efficiently generate identifiers of type long, short or int, 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 long, short or int.
increment
generates identifiers of type long, short or int that are unique only when no other process is inserting data into the
same table. Do not use in a cluster.
native
(default) picks identity, sequence or hilo depending upon the capabilities of the underlying database.
seqhilo
uses a hi/lo algorithm to efficiently generate identifiers of type long, short or int, given a named database sequence.
sequence
uses a sequence in DB2, PostgreSQL, Oracle. The returned identifier is of type long, short or int
The description of available ID Generator
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 636
Customizing ID generator
Besides the built-in strategies for generating ID, users 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.
Right click on the primary key column that you want to select an ID generator for and select Open Specification... from the pop-up menu.
In the Column Specification dialog box, select the class in the ID Generator.
Click OK to confirm.
5.
After generated the ORM code, look for the ID generator class and implement the generate method by returning 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
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Customizing ID generator
P. 637
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Customizing ID generator
P. 638
You can create a database view and then edit it by specifying the entities involved. To create a database view:
1.
3.
On the right hand side of the View Editor. Click on the add button. Then, select the entities that are involved in the view and click Apply.
From entities
Instead of creating a blank view and adding entities into the view, you can create a view directly from entities that are involved in the view. To create a
database view from entities involved:
1.
P. 639
Click Create View in the View Editor. The View Editor is placed under the ERD. If you do not see it, right click on the background of ERD and
select Show Table Record Editor or View Editor from the popup menu.
To create view
Now, you can specify the view. For details, read the following sections.
Column selection
A database view contains rows (i.e. the results) and columns, just like a database table. To select columns, simply click on the checkbox of the desired
column. Alternatively, select the column in the Column column in the View Editor.
Selecting column
Joining columns
Joining of columns between entities can be done by the resource-centric interface. To do this:
1.
2.
P. 640
To join columns
3.
Description
Column
Alias
Entity
Output
Sort
Sort Order
Specify the sort column. Records are sort following the order, with smaller number sort first.
Group By
Function
Filter
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 641
2.
In the Application Options window, open Diagramming > ERD & ORM.
3.
Click Add....
Define the auto column by entering its name, type, nullable and default value. When you create columns by using the name specified, the type,
nullable and default value will follow the definition here. Note that you can specify the length of datatype when specifying Type.
Click OK to confirm.
6.
Sometimes, columns are named based on the entities they are in. For example, for entity, Teacher, there may be a column named TeacherID and for
entity, Student, there may be another column named StudentID. Although these columns are named differently, they may share the same type, nullable
and default values. In such case, you can make use of pattern matching in defining an auto column.
When naming an auto column, you can use the ' %' character to indicate the occurrence of ANY character. For example, naming an auto column
%Name will result in causing TeacherName and StudentName apply the definition specified.
P. 642
Naming a column
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 643
Right click on the entity and select Open Specification... from the popup menu.
2.
3.
At the bottom right of the specification window, click Add > Unique Constraint....
In the Unique Constraint Specification window, enter the name of the constraint.
7.
Click OK to return to the diagram. You can see the selected column(s) is marked unique.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
P. 644
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 645
Right click on any entity and select Open Specification... from the popup menu.
2.
Click on the drop down menu of the Domain row and select Configure Domains... from the drop-down menu.
Configure domains
3.
4.
Specify the properties. The properties you specified will be re-used by entities that use this domain.
Click OK to confirm.
Open the specification of the entity to which you want use a domain. You can open entity specification by right clicking on that entity and
selecting Open Specification... from the popup menu.
2.
3.
P. 646
Click OK to confirm. By doing so the entity will be updated to apply the property values specified in the domain.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 647
P. 648
2.
Right click on the diagram's background and select Synchronize to Class Diagram from the pop-up menu.
3.
In the Synchronize from Entity Relationship Diagram to Class Diagram dialog box, edit the name of the class diagram to be created and
then click OK button.
4.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 649
Open the desired class diagram. Make sure the diagram contains at least one <<ORM Persistable>> class.
2.
Right click on the diagram's background and select Synchronize to Entity Relationship Diagram from the pop-up menu.
3.
In the Synchronize from Class Diagram to Entity Relationship Diagram dialog box, edit the name of the ERD to be created and then click
OK button.
4.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 650
2.
Select Diagramming from the list on the left and open the ERD & ORM tab.
3.
5.
In the Synchronize to Entity Relationship Diagram dialog box, the primary key column name is newly generated.
Create a relationship from the target entity to the newly created entity. As you can see, a foreign key column named is created automatically.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 651
Generating Database
You can design entity relationship diagram (ERD) in Visual Paradigm, and export the design to database for constructing tables. In this chapter, you
will see how to generate database as well as to learn some of the configuration settings.
Database configuration
Select the database you use. This affects the use of data type in ERD as well as the target of database generation.
Generating SQL for selected entities
Select some of entities in ERD and check the corresponding create/drop/alter statements.
Generating SQL for project
Produce SQL statements for all the entities created in project.
Generating alter statements
Produce update SQL statements from entities.
Export and import database configuration between projects
Export database configuration settings from one workspace to another.
Entering and generating default data
Provide default data to entities created in project.
Generating Database
P. 652
Database configuration
Opening database configuration window
Select Tools > DB > Database Configuration... from the toolbar.
Selecting database
In the Database Configuration window, check the target database.
Select database
You can select multiple databases and set one of them as default database. The default database is used for rendering the column type and
generating SQL. To set a database as default, right click on the database and select Set as default from the pop-up menu.
Database Configuration
P. 653
Testing connection
After configure the database setting, click the Test Connection button to confirm the setting is valid.
If it's successful, a dialog will show connection successful.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Database Configuration
P. 654
Generate SQL
The Generate SQL window shows the DDL and DML for the selected entities.
P. 655
Database configuration
If you have selected multiple database, you can select one of the database from the database combo box.
After changing the database, the SQL will re-generate for the selected database.
Generate SQL options
At the top of the Generate SQL window, there are several options.
Delimiter - append to end of each statement, used for separate two statement. If you change it to \\, the SQL will become:
Delimiter
Case - the case for the keyword. If you change it to Upper, the SQL will become:
Formatted SQL - formatted sql generate high readability SQL statements. If you check it, the SQL will become:
Formatted SQL
Using toolbar
There is a toolbar above each group of statements.
Revert - The textbox of SQL is editable, you can modify before execute. The Revert button allows you to undo the user modification.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 656
Generate Database:
Update Database - query existing object in database, generate create and alter statement depends on object not exists or outdated in
database, or do nothing if database is up-to-date.
Drop and Create Database - generate drop statements first, then generate create statements.
Generate Comment - generate comment of tables/columns to database/DDL (only available to My SQL, DB2, Oracle, Postgre SQL)
Upper Case SQL - generate upper case for keyword (e.g. select, from, update, insert...etc).
Generate sample data - generate sample table records added in Table Record Editor in ERDs.
Generate Individual DDL - split the DDL files into separate files. Available only when Generate DDL is on.
Separate Create/Drop DDL - split the create and drop statements into two files. This option is only available when Drop and Create Database is
chosen for the Generate Database option.
Quote SQL Identifier - if database object name is reserved word, it must be quoted; otherwise, it cannot be used as the object name:
Auto - auto detect and quote the name only if it is reserved word.
Table Charset (Only available for MySQL) - the charset used for database connection.
Connection Provider Class - Provide class name for obtaining JDBC connection, default is C3P0 which is a connection pool
Connection:
P. 657
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 658
Select Tools > DB > Generate Database... from the toolbar to open Database Code Generation window.
2.
In the Database Code Generation window, select Database only in Generate, Update Database in Generate Database, uncheck Export to
database, check Generate DDL, Upper Case SQL, Formatted SQL and select JDBC in Connection.
4.
Database options
5.
Click OK button to generate. Assume some tables and columns were created in database already. The following is the example of generated
statements:
P. 659
Alter statements
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 660
Select Tools > DB > Database Conguration... from the toolbar to open Database Configuration window.
2.
In the Database Configuration window, select database(s) and define their settings.
Click the Export... button and specify the file name to save the setting.
5.
6.
Click the Import... button and select the previously saved file.
7.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 661
Selecting entity
Enter the data in the editor. Double click on a cell to start editing. Click Enter to end editing.
P. 662
Selecting FK value
Sometimes, you may be uncertain to what the foreign values represent. You can click on the ... button to show the additional pane and select the
proper record from the pane.
Selecting record
Removing a record
To remove a record, select the record you want to remove and click on the Delete record button.
Removing record
Validating records
Record validation helps to verify the correctness of entered data. To validate, click on the Validate records button.
P. 663
Validating records
If anything wrong is detected, the Message pane will popup and a message will appear in it.
2.
Check Export to database and Generate sample data. If you are creating the database the first time, select Create Database for the drop
down menu of Generate Database. If you just want to generate data to a previously created database, select Update Database.
Click OK to continue. Please note that database generation is not available for entities in logical and conceptual data model.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 664
Reversing Database
You can reverse engineering ERD from database. In this chapter, you will see how to reverse database.
Reversing database
Reverse engineer ERD from database
Reversing DDL
Reverse engineer ERD from DDL file
Reversing Database
P. 665
Reversing database
You can reverse engineering an ERD from database. To reverse database:
1.
2.
In the Database to Data Model window, keep Reverse Table selected and click Next > button to continue.
3.
Database setting
4.
Select the tables you want to reverse and click the Next button to start reverse.
Select tables
5.
After reverse, a new Entity Relationship Diagram is created automatically with a Reversed Entities window. Select the tables and drag on the
diagram.
Reversing database
P. 666
The tables were created on the diagram, click Close button to finish reversing database.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Reversing database
P. 667
Reversing DDL
1.
2.
3.
Fill in the filename of DDL and select database in Reverse DDL dialog box. Click OK button to continue.
An Entity Relationship Diagram is created with the reversed entities.
Reversed ERD
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Reversing DDL
P. 668
P. 669
2.
3.
In the Open window, choose the Visual Paradigm project file (*.vpp) to reference to and click Open.
4.
When you return the Manage Referenced Projects dialog box, click Close.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 670
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.
If the Model Explorer is hidden, open the View tab of the toolbar and select Panes > Model Explorer to show it.
NOTE:
2.
By selecting the first selection (Current), model elements in the current project will be listed.
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 referenced project are read-only (i.e. non edit-able).
NOTE:
Alternatively, you can right click on the model elements and select Create View in Active Diagram from the pop-up menu.
2.
From the drop down menu at the top of the Model Explorer, select List Referenced Model Element/Shape.
P. 671
A tree of model elements are listed. Those are came from the referenced project(s) and are used by the currently opening project. The first level
of the tree lists the model elements in used, while the second level represent the usage. For example, View ([DIAGRAM NAME]) means that
the model element has been visualized in the diagram specified. [MODEL ELEMENT NAME] (Documentation) means that the model element
has been added as a link in the model element specified.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 672
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 673
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 674
Open the Model Explorer by opening the View tab of the toolbar and selecting Panes > Model Explorer to show it.
2.
Right click on the element you want to duplicate and select Duplicate to Current Project from the popup menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 675
Refactoring
Refactoring refers to the action to move project data like diagrams and/or model elements between projects that have a reference relationship in
between.
Refactoring diagrams and/or model elements to another project helps in the re-structuring of project and re-organizing project data. Through
refactoring, generic project data is moved to a project file, generally known as a library project, readily for other project files to access through
project referencing, such that they can get the common project data included without the need of re-definition. Another benefit of refactoring is that
it guarantees the correctness of model definition by enforcing common project data to be defined just once. This is also, in fact, the benefit of using
project reference.
Let's say, for example, you are modeling a vehicle maintenance company. You have created two projects for the distinct parts of the business - Car
washing and car repair. When modeling car washing with class diagram, you have found that classes like Car and Manufacturer are also needed by
the car repair model. You then refactor them to a referenced project so that the car repair model can link with it and have the classes included.
What is refactoring?
Refactoring also works in the opposite way, that is, to move diagram/model elements from the generic library project back to the 'consumer' project that
use the data. While it is not so common, you may need it when you discover that certain diagram or model element in the generic project is not really
that general, and you want to move the diagram/model element back to the only, specific project that use it.
How to refactor?
Keep in mind that refactoring only works with projects that have a reference in between. If you want to refactor diagram or model element to a library
project but such project is either not existing or not a referenced project of your source project, get ready for the project and the source project
reference to it. If you are unclear about project referencing, please read the previous chapters.
Refactor model elements to reference project
1.
Open the Model Explorer by opening the View tab of the toolbar and selecting Panes > Model Explorer to show it.
Model Explorer
2.
Select and right click on the model elements you want to refactor to referenced project. Select Refactor to Referenced Project... from the
popup menu.
Refactoring
P. 676
Refactor classes
3.
You are prompted for saving project. Click Yes. If you click No, refactor will stop.
4.
If the Include Related Diagrams window appears, this means that one or more of the selected elements has been visualized in at least one
diagram (as listed on the left of window) with master view created.
Here you may take any of the following actions to continue.
Include the diagrams - Click Include Diagram(s) at the bottom right corner. This will move not only the model elements but also
the diagrams listed on the left hand side of window to the referenced project. Since the action is not undoable, think carefully before
continuing.
Remove the master views - Click Stop Refactor at the bottom left corner. Open the diagrams where the master views of the selected
model elements exist. Delete them. When delete, make sure you are deleting the VIEW instead of model element. Once all master views
are removed, re-run step 1.
5.
Refactor not only moves the selected elements to referenced project, but also those related elements. Here are two examples:
If such related elements exist, you will be listed with those elements. Check them. If you accept moving them to referenced project, click
Continue at the bottom right corner to continue. Otherwise, click Stop Refactor at the bottom left corner to terminate the refactoring.
Refactoring
P. 677
Once the refactoring is completed, the project will reopen itself. From now on, you can access and use the refactored elements through the
Model Explorer. Select the referenced project under the drop down menu. Drag to diagram the element(s) to use.
To refactor diagram means to refactor the diagram as well as the elements on the diagram. As the steps are pretty close to refactoring model element,
as described above, please read refactor model elements before reading this section.
1.
Right click on the diagram that you want to refactor and select Utilities > Refactor to Referenced Project... from the popup menu.
You are prompted for saving project. Click Yes. If you click No, refactor will stop.
3.
If the Include Related Diagrams window appears, this means that one or more of the elements in the selected diagram has been visualized
in another diagram (as listed on the left of window) with master view created. Read step 4 in the previous section to learn how to resolve the
relationships.
Refactoring
P. 678
4.
Refactor not only moves the selected elements to referenced project but also those related elements. Read step 5 in the previous section to
learn how to carry on.
5.
Once the refactoring is completed, the project will reopen itself. From now on, you can access and use the refactored elements through the
Model Explorer. Select the referenced project under the drop down menu. Drag to diagram the element(s) to use. Note that auxiliary views of
refactored elements are now referencing the elements in referenced project.
1.
Open the Model Explorer by opening the View tab of the toolbar and selecting Panes > Model Explorer to show it.
2.
Click on the drop down menu at the top of the Model Explorer and choose the reference project that contains the model element(s) you want to
get.
Select and right click on the model elements you want to get from the reference project. Select Refactor to Current Project... from the popup
menu.
Refactoring a class
4.
You are prompted to a note with some points you should pay attention to before continue. Let's revise them in brief here:
Make sure all the 'related project files' are in your workspace folder, or any sub-directory under the workspace folder. 'Related projects'
means the project files that are referencing the current or reference project, either with a direct reference (project A references B) or
a transitive reference (project A references A1, A1 references B). Refactoring will scan through the project files in (and only in) your
workspace. The reason is that the model element(s) you attempt to refactor might be in-used by another project file. Refactoring may
need to modify such project by adding/updating the project and element reference, or to stop you from continuing if a potential error may
occur.
If you work as a team, and are using a version control system (VPository/Teamwork Server/Other repository types), make sure the
'related projects' are all checked out. Refactoring will not and cannot detect the project files in your server.
5.
6.
You are prompted to preview the changes. Click Yes if you want to preview changes. If you click No, refactoring will continue. If you click
Cancel, refactoring will be cancelled.
7.
If you clicked Yes, you see the window below, listing out the items to be refactored and the actions that will be performed after the refactoring.
Refactoring
P. 679
Previewing changes
Refactor not only moves the selected elements to referenced project but also those related elements. Here are several typical cases:
Model elements that takes the selected element as type (e.g. If class 'X' has an attribute 'Xa', which has the selected element as type,
class 'X' will be refactored).
Member-typed elements (e.g. Refactoring a class will cause its attributes and operations to be refactored. Refactoring an entity will cause
its columns to be refactored).
Notice that the searching of relevant project data is done recursively, meaning that whenever a model element is found relevant to any element
selected to be refactored, that element will undergo the same checking performed to look for the other relevant elements, until the end. If you
accept the changes, click Continue at the bottom right corner to continue. Otherwise, click Cancel at bottom right to terminate the refactoring.
8.
Once the refactoring is complete, the project will reopen itself. The refactored element is now in your project. You can find them in the Model
Explorer.
To refactor diagram means to refactor the diagram as well as the shapes on the diagram. As the steps are pretty close to refactoring model element, as
described above, please read refactor model elements before reading this section.
1.
In Diagram Navigator or Model Explorer, locate the diagram you want to get from reference project. If either the Diagram Navigator or the
Model Explorer is hidden, show it by opening the View tab of the toolbar and select Panes > Diagram Navigator or Panes > Model Explorer
to show it.
2.
Right click on the diagram node and select Refactor to Current Project... from the popup menu.
4.
You are prompted to preview the changes. Click Yes if you want to preview changes. If you click No, refactoring will continue. If you click
Cancel, refactoring will be cancelled.
5.
Refactor not only moves the selected elements to referenced project but also those related elements. If you clicked Yes, read step 6 in the
previous section to learn how to carry on.
6.
Once the refactoring is completed, the project will reopen itself. The refactored diagram is now in your project. Notice that the shapes in diagram
should be referencing the model elements in reference project.
Refactoring
P. 680
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Refactoring
P. 681
What is nickname?
Introduce element nickname support.
Configure nickname
Shows you how to create a nickname or a language.
Using nickname
Shows you how to work with a new nickname and how to switch between nicknames.
Translation
Shows you how to make use of the translation feature to maintain model with multiple language.
P. 682
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 Visual Paradigm
project content. While we have applied certain language in naming and describing 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 description. 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.
Multi-national team
If you are working in a team and your members are using different languages, you can define model elements name and description 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 Traditional Chinese respectively:
What is nickname?
P. 683
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
What is nickname?
P. 684
Configure nickname
You can add a nickname under Modeling in the toolbar. By adding a nickname, you can start editing the names and descriptions of model elements
under the new nickname.
Overview of Configure Nickname window
Name
Description
The language (e.g. English) of the Original nickname The selection only affects the outcome of translation.
Nickname list
Add
Rename
Remove
Export
Click to export an XML file that contains information about the original name and nickname of the name and
description of model elements that are named differently in nickname.
Import
OK
10 Cancel
Adding nickname
1.
Select Modeling > Nickname > Configure Nicknames... from the toolbar.
2.
The current working copy is by default in Original nickname, with English as user language. Click Add in the Configure Nickname window.
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 window.
Configure nickname
P. 685
Renaming nickname
1.
Select Modeling > Nickname > Configure Nicknames... from the toolbar.
2.
In the Configure Nickname window, select the nickname to rename. Click Rename.
NOTE:
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 window.
Removing nickname
1.
Select Modeling > Nickname > Configure Nicknames... from the toolbar.
2.
In the Configure Nickname window, select the nickname to remove. Click Remove. Click Yes when you are asked for confirmation
NOTE:
Configure nickname
P. 686
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Configure nickname
P. 687
Using nickname
Once you have defined a nickname, you can start updating your model by entering the new names and description of model elements.
Start updating elements' nickname
1.
Select Modeling > Nickname and then select a nickname to work with from the toolbar.
Start renaming model elements and updating their description. The changes you make will only be applied to the selected nickname.
Switch nickname
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Using nickname
P. 688
Select Modeling > Nickname > Configure Nicknames... from the toolbar.
2.
3.
Click Export....
4.
In Save dialog box, select a directory for saving it as word document in your computer. Click Save after you've named the file.
Now, you send the word file to your team member (or your translator). To import the translated word document back to Visual Paradigm:
1.
Select Modeling > Nickname > Configure Nicknames... from the toolbar.
2.
3.
In Open dialog box, select the directory where you save your translated word document and click Open button.
As a result, you can see your project is updated.
The name of your project's model elements has been updated to show the selected nickname
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 689
Visual diff
You can use visual diff for comparing two diagrams, and to show their differences. The comparison can be made between diagrams in the same or
different. In this chapter, you will see how to compare as-is and to-be BPD, logical and physical ERD with visual diff.
Visual Diff
P. 690
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
P. 691
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 692
In As-Is Process diagram, select Modeling > Visual Diff from the toolbar.
NOTE:
Alternatively, you may right click on diagram background and select Utilities > Visual Diff... from the pop-up menu:
Name
Description
Strategy
It determines how two diagrams will be compared. Select the appropriate strategy that suits your
application most.
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.
Compare
Base
Filter
It determines what kind of comparing data will be displayed on the result pane.
All: Display all kinds of differences including the addition, modification and removal of shapes.
New: Display only results about the addition of shape and then hide the rest.
Modified: Display only results about the modification of shapes and then hide the rest.
Deleted: Display only results about the removal of shapes and then hide the rest.
It determines what type of model elements will be shown on the result pane. When Filter Model Type
window pops out, uncheck the type of model elements you don't want to be shown; otherwise, check the
type of model elements you want it to be shown.
Sort
It determines how the result of comparison be displayed on Result pane. You can select sort by Type, by
Name or by Change Type.
Name: All model elements are sorted by their name.
Change Type: All model elements are changed their type.
Type: All model elements are sorted by their type.
Maximum
Press this button to enlarge the Visual Diff window to the maximum screen size. Press it again to reduce
the window to the default size.
P. 693
Diagram list
It lists all diagrams on projects selected in the left hand side and the right hand side respectively.
Check it if you want to select a diagram for comparison within the current working project.
10 Project
11 Diagram
Select and open a specific diagram for comparison after selecting a project.
12 Display pane
A pane that has two sides. Each side displays a diagram out of a project.
13 Result pane
The differences of the two projects are shown here. When the word New is shown behind a task that
means it is newly added, the word Deleted is shown behind a task that means it is deleted.
14 Export PDF...
Click it to save a document of the two compared diagrams in your computer as PDF.
15 Launch viewer
Open the exported file after you have export a PDF file. Check it to open the PDF file. If you uncheck it,
nothing will happen even after you have exported a PDF file.
16 Compare
17 Close
2.
In Visual Diff window, 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.
Select the To-be Process diagram to compare with from the drop-down menu of Diagram.
P. 694
At the top of the Visual Diff window, adjust the Strategy, Compare, Base and Filter.
5.
Once everything is set, the differences of the two diagrams will be shown on the result pane.
6.
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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 695
In Logical ERD diagram, select Modeling > Visual Diff from the toolbar.
NOTE:
Alternatively, you can right click on diagram background and select Utilities > Visual Diff... from the pop-up menu.
Name
Description
Strategy
It determines how two diagrams will be compared. Select the appropriate strategy that suits your
application most.
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.
Compare
Base
Filter
It determines what kind of comparing data will be displayed on the result pane.
All: Display all kinds of differences including the addition, modification and removal of shapes.
New: Display only results about the addition of shape and then hide the rest.
Modified: Display only results about the modification of shapes and then hide the rest.
Deleted: Display only results about the removal of shapes and then hide the rest.
P. 696
It determines what type of model elements will be shown on the result pane. When Filter Model Type
window pops out, uncheck the type of model elements you don't want to be shown; otherwise, check the
type of model elements you want it to be shown.
Sort
It determines how the result of comparison be displayed on Result pane. You can select sort by Type, by
Name or by Change Type.
Name: All model elements are sorted by their name.
Change Type: All model elements are changed their type.
Type: All model elements are sorted by their type.
Maximum
Press this button to enlarge the Visual Diff window to the maximum screen size. Press it again to reduce
the window to the default size.
Diagram list
It lists all diagrams on projects selected in the left hand side and the right hand side respectively.
Check it if you want to select a diagram for comparison within the current working project.
10 Project
11 Diagram
Select and open a specific diagram for comparison after selecting a project.
12 Display pane
A pane that has two sides. Each side displays a diagram out of a project.
13 Result pane
The differences of the two projects are shown here. When the word New is shown behind a task that
means it is newly added, the word Deleted is shown behind a task that means it is deleted.
14 Export PDF...
Click it to save a document of the two compared diagrams in your computer as PDF.
15 Launch viewer
Open the exported file after you have export a PDF file. Check it to open the PDF file. If you uncheck it,
nothing will happen even after you have exported a PDF file.
16 Compare
17 Close
2.
In Visual Diff window, 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.
Select the Physical ERD to compare with from the drop-down menu of Diagram.
Select a diagram
P. 697
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.
At the top of the Visual Diff window, adjust the Strategy, Compare, Base and Filter.
5.
Once everything is set, the differences of the two diagrams will be shown on the result pane.
6.
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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 698
P. 699
Right click on any selected shapes, select Define Design Pattern... from the popup menu.
A design pattern is needed to save as a file. In the Define Design Pattern window, 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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 700
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.
3.
In Design Pattern window, you can see a list of defined patterns, select the desired pattern from the list.
Select pattern
If you have a .pat file, click Add button to import into the list.
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.
Searching an element
You can also click on the shape or select a diagram element from the Diagram Element combo box to filter the list.
5.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 701
Select Team > Utilities > Open Teamwork Client... from the main menu.
2.
In the Teamwork Client window, select Repository > Synchronize Design Pattern with Server from the menu.
NOTE:
3.
Only members who are permitted to configure design pattern can synchronize design patterns. Click here for details about configuring
members' permissions .
Pattern Synchronization
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 702
Model transitor
Model transitor helps define the transition of phrasees of work and maintain the traceability in between. Both the use of model transitor for shape and
diagram will be covered in this chapter.
Model transitor
P. 703
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.
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.
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.
P. 704
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 705
The Select Parent Model of New Diagram window 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.
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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 706
Creating a profile
You will see how to create a profile in Model Explorer.
P. 707
Select Modeling > Profile > New Profile from the toolbar
2.
Drawing a stereotype
To draw a stereotype in profile diagram:
1.
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.
NOTE:
You can check Display model element types in-use to list only the 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)
P. 708
4.
Click OK. Name the stereotype and press Enter to confirm creation.
Right click on a stereotype shape and select Open Specification... from the popup menu.
2.
In the Stereotype Specification dialog box, open the Tagged Value Definitions tab.
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.
Add tag
Tag type
Description
Text
The most common and general type of tagged value that consists of words.
Multi-line Text
Model element
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 number that consists of one or more digits.
Boolean
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.
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.
P. 709
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.
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.
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
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.
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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
P. 710
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 711
P. 712
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
6.
This create a mind mapping diagram with a central idea node appears 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.
Move the mouse pointer over a node. Press on the resource icon Branch -> Node.
To create a node
2.
A node is created
3.
Name the node and press Enter to confirm. Create the other nodes by repeating the same steps.
Collapsing/Expanding a branch
When reading a mind map, you may want to collapse some branches to make a diagram cleaner and easier to read. To collapse a branch:
1.
2.
To locate the collapsed nodes on a mind map, simply turn on the Model Indicator by selecting View > Model Indicator from the toolbar. By doing so,
those collapsed nodes will have the Expand resource appear above them.
P. 713
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 714
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 of 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.
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.
Fill settings control the background color of node(s). You can apply solid and gradient colors as well as to control the transparency.
Font settings control the font style, size, type and color of text appear on a node.
Formatting nodes
P. 715
1.
Select the node(s) that you want to set icon. Multiple node selection can be made by a range of 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.
In the Select Icons dialog box, select the icon to set and click > to assign it to the node(s). Click OK
to confirm.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Formatting nodes
P. 716
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, the relationship is meaningful and 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.
3.
Unlike traditional resource icons, the Link resources must be released on an existing node.
Releasing on diagram will not result in creating a new node.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Linking nodes
P. 717
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.
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 pop-up
menu.
Add a reference
Type of reference
Description
File
An external file.
Folder
An external folder.
URL
Diagram
Shape
A shape in the opening project, such as a use case shape on a use case diagram.
Model element
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.
Reference to resources
P. 718
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Reference to resources
P. 719
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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Relocating a branch
P. 720
Layout diagram
In a mind mapping diagram, ideas are stretching out across, which leads to 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 drawn. 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.
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.
P. 721
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.
P. 722
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 723
Brainstorm
VP-UML enables you to record important ideas during a meeting through a note-taking feature called "Brainstorm". During the meeting, you create note
(shapes) in a corkboard -like diagram. When the meeting ends, you may organize the notes, and derive a diagram from them.
Using Brainstorm
Introduce to Brainstorm and shows you how to create a Brainstorm diagram.
Brainstorm
P. 724
Using Brainstorm
Very often, you model a system not just by imagination but with facts, knowledges and customers' ideas. You may meet with users, understand how
they work, identify their requirements and proceed to visualize their needs with models.
Visual Paradigm enables you to record important ideas during a meeting through a note-taking feature called "Brainstorm". During the meeting, you
create note (shapes) in a corkboard -like diagram. When the meeting ends, you may organize the notes, and derive a diagram from them. This helps to
ensure all important thoughts from users are well recorded and won't be lost when constructing a model.
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Creating a note
Brainstorm diagram applies a corkboard theme. You may add notes to it to record ideas and thoughts collected. To create a note:
1.
Press and drag in diagram toolbar a note with the desired color.
Creating a note
2.
3.
A note is created
Imagine when you are having a meeting with user and taking notes with Brainstorm, you may not be perfectly sure whether the notes you
create are utlimately important or not. As long as you think that the information may help you model, it is worthwhile to note it down for now. The
key idea is to add notes in a casual manner. Do not spend too much time on judging the importance of the content. Otherwise, you may miss out
information that is really important during the process of strenuous sorting.
Deleting a note
If a note has been created by mistake or the note text is no longer correct/meaningful, you may want to delete the note. To delete a note, you may
select it and press the Delete key. Alternatively, press on the cross button at top left of note shape to perform a deletion.
Using Brainstorm
P. 725
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Using Brainstorm
P. 726
Look for the note that can help you to construct a model element. For example, when you see a note with text "ship goods", you may want to
create a task Ship Goods from it.
2.
Click on Tag at bottom left of note body. Select the type of element from the popup menu, such as Task.
Click the tag at the bottom left and select Realize... from the popup menu.
4.
In the Transit Model Element window, enter the properties of the model element you are going to produce. Click OK at bottom right to continue.
5.
The Visualize Model Element window enables you to show the model element on a diagram. You may show it on a new diagram by selecting
Create new diagram and entering the diagram name. Or, show it in an existing diagram by selecting Show in existing diagram and selecting the
diagram to show. Or, not to show it on any diagram by selecting Do note visualize. Click Create/ Show/ Close at bottom right.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 727
Generating report
Shows you the basic steps in generating a HTML, PDF or MS Word report.
Configuring report
Gives you a description of all the report generation options.
P. 728
Generating document
Document generation is the process of producing a document for sharing your design work and model specification with teammates and clients. You
can generate documents in different formats such as HTML, PDF or MS Word for reading or publishing in different environments. They differ in file
format but have the same layout. In this chapter, we will go through the core steps in document generation.
To generate a document:
1.
2.
In the Generate HTML/PDF/Word window, fill in the output path where the document should be generated to.
NOTE:
3.
Generate HTML Doc..., Generate PDF Doc... or Generate Word Doc... depending on the
For HTML document, specify the folder of the HTML files to be generated.
For PDF document, specify the file path of PDF file (*.pdf) to be generated.
For MS Word document, specify the file path of the document file (*.docx) to be generated.
Make any necessary configuration such as the page layout, cover page, etc. For details about configuration, refer to the next chapter.
5.
Generating document
P. 729
No.
Name
Description
Content
The main page of document generation that allows you to select the diagram(s) to generate document.
Options
Page Setup
Cover page
Header/Footer
Document info
Watermark
Template
You can define a template for document generation by clicking on the drop down menu next to Template and
selecting <New>. Once a template is defined, you can select it from the same drop down menu and proceed to
generation with the template. For details about document customization, please read the next chapter.
10 Edit template
Click to edit the template selected in the drop down menu of Template.
11 Delete template
Click to delete the template selected in the drop down menu of Template.
12 Import template
13 Output path
14 Launch viewer
17 Preview
Preview of diagram which have been selected in the list of selected diagram
18 Reset
19 Reset to default
20 Set as default
21 Generate
22 Cancel
23 Apply
Click to apply the changes made in document, causing the reopening of this window to restore the applied
settings.
24 Help
Available only to MS Word document generation, this option enables you to specify the path of MS Word
document file that you want the generator to use as template. Document generator will append the template
file content in front of generated document. In other words, you can prepare a file for cover page. Apart from
this, style will also follow the definition in template file. For details, please read the section Generating MS Word
document with template (MS Word document only).
Description of document generation window
Generating document
P. 730
Reorder diagram
1.
2.
3.
Click
or
to expand it.
to sort.
Generating document
P. 731
Sort shapes
Automatic sorting
1.
2.
Select from the drop down menu Sort element a way to sort.
to expand it.
Description
Automatic
The way of sorting elements is automatically managed. The order is often based on the flow and/or position of
elements, which is the most logical order, following most users' understanding of that kind of diagram.
Sort by Tree
Sort by Name
Custom
The way of sorting elements is controlled by user, through selecting elements and pressing
or
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Generating document
P. 732
Configuring document
Document generation can be configured to make the output closer to your expectation. Common configuration options include whether to generate
table of contents/figure or not, whether to generate shape/diagram type as icon or text and whether to generate a particular type of detail such as
children. Besides configuration options, you can also adjust the page setup, design the cover page and define header/footer. In this chapter, we will go
through all the options one by one.
Options
Options
Option
Description
Generate diagrams
If this option is sleected, resource indicators like references, subdiagram will be shown in shape bodies.
Configuring document
P. 733
If this option is selected, heading for empty model element section will
be skipped.
Wrap
Details
Configuring document
P. 734
Font
Encoding
Page Setup
Page setup controls the layout of document. You can adjust a document size, page orientation and margin.
Page setup
Option
Description
Page size
Page orientation
This option is used to select the orientation of the document (portrait/landscape). This option is only available to PDF and MS
Word document.
Page margin
To specify the page margins of the document. This option is only available to PDF and MS Word document.
A description of options of page setup
Configuring document
P. 735
Cover page
Option
Description
If this option is selected, there will be a cover page generated to the d9ocument.
An image that appear at the document. You are expected to supply the file path of the image file.
The drop down menu at the right hand side is for controlling the position of image.
Logo scale
Control the scale of logo image. This option is only available to PDF and MS Word document.
Title
Organization name
Author name
Header/Footer
Header and footer refers to the content that appears in the top and bottom of every page in document. For MS Word document, there are two text
boxes for you to edit the header and footer. For PDF document, there are six boxes, three for each of the header and footer. Each of the text box
represents a region in header/footer, such as the top left text box refers to the left region of header, while the bottom right text box refers to the right
region of footer.
Instead of typing in the content of header/footer, there are a set of variables for you to apply with. The following table provides you with description with
each of the variable.
Header/Footer
Variable
Name
Selection font
Description
Configuring document
P. 736
Align to left
Align content to the left of header/footer. This option is available only to MS Word document.
Align to center
Align content to the center of header/footer. This option is available only to MS Word document.
Align to right
Align content to the right of header/footer. This option is available only to MS Word document.
Add image
Insert page number to the position where the text cursor is placing.
Insert page count to the position where the text cursor is placing.
Insert date
Insert the date of when the document is generated to the position where the text cursor is placing.
Insert time
Insert the time of when the document is generated to the position where the text cursor is placing.
Insert the project name to the position where the text cursor is placing.
Insert the name of document file to the position where the text cursor is placing.
Insert the name of the user logging into the system to the position where the text cursor is placing.
A description of variables that can be used in header and footer
Document Info
For HTML document, document info refers to the meta information of HTML document. For PDF and MS Word document, document info refers to the
possible document properties that can be defined.
Document info
Option
Description
Title
Author
The author of the document. This option is only available to PDF document.
Subject
Keywords
Info header
The info header of the document. This option is only available to PDF document.
The info header content of the document. This option is only available to PDF document.
Allow modify
Select to allow modification on the document. This option is only available to PDF document.
A description of document info
Watermark
Print watermark to images in document. This is particularly useful when you want to specify the state of design. E.g. "Reviewed"
Configuring document
P. 737
Watermark
Option
Description
Generate Watermark
Text
Color
Transparency
Font name
Font style
Font size
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Configuring document
P. 738
Customizing report
Instead of generating a report in a way that VP-UML defined for you, you can develop report templates to customize the report content, to make output
match your needs. In this chapter, you will see how to make use of the template editor to customize a report template.
Customizing report
Shows you how to launch the template editor to perform basic editing. It also describes the editor window in brief.
Diagram loop
Define diagram loop and show you how to use a diagram loop in practice.
Diagram summary
Define diagram summary and show you how to use a diagram summary in practice.
Diagram paragraph
Define diagram paragraph and show you how to use a diagram paragraph in practice.
Element loop
Define element loop and show you how to use a element loop in practice.
Element summary
Define element summary and show you how to use a element summary in practice.
Element paragraph
Define element paragraph and show you how to use a element paragraph in practice.
Custom content
Define custom content and show you how to make use of it to enter formatted free text.
Diagram image
Define diagram image and show you how to make use of it to add an image of diagrams.
Property value
Define property value and show you how to make use it to extract a property from a parent model element.
Page break
Shows you how to insert a page break.
Customizing report
P. 739
Customizing document
Instead of generating a document in a way that Visual Paradigm defined for you, you can develop document templates to customize the document
content to make the output matches with your needs. With document customization, you can select model elements and properties to generate to
document. You also can add custom text content. To customize document:
1.
Select Tools > Doc from the toolbar. Then select Generate HTML Doc..., Generate PDF Doc... or Generate Word Doc... depending on the
type of document you want to generate.
NOTE:
2.
document templates are shared among HTML, PDF and Word documents. If you just want to design template but have no preference on
the type of document to generate yet, just select either HTML, PDF or Word.
Press on the Template drop down menu and select <New> from the popup menu to open the document template editor and start editing
template.
To create a template
3.
In the document Template window, enter the template name at the top of window.
4.
Construct the document template. A document template is formed by different kinds of components that put together in a hierarchical structure.
A common way of building a template is to start with a diagram loop, which can be created from the editor toolbar. Then, select the diagram loop
and create children components through its toolbar, such as to create an image component or a element loop for accessing diagram elements
on diagrams being looped. To learn how to use the tools in detail, refer to the coming chapters.
A sample template showing the use of diagram loop, element loop, property and custom text components
5.
6.
Click Close.
Name
Description
Save
Save as
Export
To export the opening template to a document template file (.vpr). You can import the file to other
machines for reusing it.
To add a component to template editor, indicating the need of looping specific type(s) of diagram.
To add a component to template editor, indicating the need of looping specific type(s) of diagram for
constructing a tabular diagram summary.
To add a component to template editor, indicating the need of looping specific type(s) of diagram for
printing its properties in paragraph form.
Customizing document
P. 740
To add a component to template editor, indicating the need of looping specific type(s) of model element
that are at project root (i.e. not being contained).
To add a component to template editor, indicating the need of looping specific type(s) of model element
for constructing a tabular element summary.
To add a component to template editor, indicating the need of looping specific type(s) of model element
for printing its properties in paragraph form.
To add a component to template editor, indicating the need of looping model elements of specific type(s)
in whole project.
To add a component to template editor, indicating the placement of text written by user.
Preview the template against the project content for document content. Rendering of document is costly
especially when the project is large. If your project is large, be patient when waiting for outcome.
Preview the template against the project content for document structure.
Options
2.
Preview the document by pressing
or
3.
In the document structure tree, select the diagrams or shapes that you want to ignore in generated document.
4.
Right click on your selection and de-select Generate from the popup menu.
Customizing document
P. 741
To edit a template
To delete a template
To delete an existing document template, select it in the generate window such as Generate PDF, then click on the delete button.
To delete a template
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Customizing document
P. 742
3.
In the Export dialog box, enter the file name and click Save.
4.
Open the project that you want the template to import to. Open the document dialog box by selecting Tools > Doc > Generate HTML Doc../
Generate PDF Doc.../ Generate Word Doc... from the toolbar.
5.
Click on the
6.
button.
In the Import dialog box, select the document template file and click Open.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 743
Diagram loop
A diagram loop is a component in a document template, indicating the need of looping (i.e. walking through) specific type(s) of diagram. For example,
to loop all use case diagrams and class diagrams in a project. Diagram loop means nothing more than just to loop diagram. The content to print for
each diagram being looped is determined by the children components of loop.
Looping diagrams in project
To loop specific type(s) of diagrams in project, create diagram loop at template root. To create diagram loop at template root:
1.
In the template editor, click on the
2.
on toolbar.
On the right hand side of the template editor, select the type of diagram(s) to be looped and click
Select the element loop that you want to loop for its sub-diagrams.
Click on the Add Diagram Loop button from the toolbar of element loop.
Diagram loop
P. 744
NOTE:
3.
Make sure you are clicking on the button from the toolbar of element loop. If you are clicking on the button at editor toolbar, you will
create a loop at template root.
On the right hand side of the template editor, select the type of sub-diagram(s) to loop and click
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Diagram loop
P. 745
Diagram summary
A diagram summary is a component in a document template, indicating the need of looping (i.e. walking through) specific type(s) of diagram, and
presenting their properties in tabular form. For example, to loop all use case diagrams in a project and form a table consisting of diagram names and
description. By default, a table of diagram names will be printed. You are expected to add property column(s) under a diagram summary to indicate the
diagram properties to print in the table.
Showing a property table for diagrams in project
To loop specific type(s) of diagrams in project for listing their properties in a table, create diagram summary at template root. To create diagram
summary at template root:
1.
In the template editor, click on the
2.
on toolbar.
On the right hand side of the template editor, select the type of diagram(s) to be looped and click
If you generate document with a template like this, you will obtain a table of diagram names, provided that the diagram(s) of the chosen type(s)
exists. If you need to print specific diagram properties in table other than just name, click on the Add Property Column button in the toolbar of
diagram summary, then select the property(ies) to be added into the table as column(s). For more details about the use of property, read the
chapter Property.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Diagram summary
P. 746
Diagram paragraph
A diagram paragraph is a component in a document template, indicating the need of looping (i.e. walking through) specific type(s) of diagram and
presenting their properties in paragraph form. For example, to loop all use case diagrams in a project and print out their description and last modified
data in a paragraph, one paragraph per diagram. You are expected to add property value(s) under a diagram paragraph to indicate the diagram
properties to print out.
Showing a property paragraph for diagrams in project
To loop specific type(s) of diagrams in project for listing their properties in paragraph form, create diagram paragraph at template root. To create
diagram paragraph at template root:
1.
In the template editor, click on the
2.
on toolbar.
On the right hand side of the template editor, select the type of diagram(s) to be looped and click
If you generate document with a template like this, you will obtain a list of diagram types and names, provided that there exists diagram(s) of the
chosen type(s). If you need to print specific diagram properties other than just name, click on the Add Property Value button in the toolbar of
diagram paragraph, then select the property(ies) to show. For more details about the use of property, read the chapter Property.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Diagram paragraph
P. 747
Element loop
An element loop is a component in a document template, indicating the need of looping (i.e. walking through) specific type(s) of diagram/model
elements. For example, to loop all use case and class in a project. Element loop means nothing more than just to loop diagram/model element. The
content to print for each diagram/model element being looped is to be determined by the children components of loop.
Looping model elements in project
To loop specific type(s) of model elements in project, create element loop at template root. To create element loop at template root:
1.
In the template editor, click on any of the buttons in the toolbar depending on your need.
Button
Name
Description
To loop through all models in the project root. In other words, model being contained
by other model element will not be accessed. This is a shortcut for creating a root level
element loop whose chosen element type is model.
To loop through all packages in the project root. In other words, package being contained
by other model element will not be accessed. This is a shortcut for creating a root level
element loop whose chosen element type is package.
To loop through any kind of model element in project root. By selecting this option, you can
choose the type of model element to be looped.
To loop through any kind of model element within the project, regardless of their leveling.
By selecting this option, you can choose the type of model element to be looped.
Description of available type of element loop
2.
If you have chosen to add a model or a package loop, you do not need to perform any actions in further.
If you have chosen to add either root level or all level element loop, select the type of element(s) to be looped on the right hand side of the
template editor and click
NOTE:
You can switch between a root level and a all-level loop by changing the option Root Level above the element list.
Notice that changing the value of Root Level is not about changing available element selection, but also the end result,
whether to access only root level elements or not.
Select the element loop that you want to loop for its sub-diagrams.
Click on the Add Element Loop button from the toolbar of element loop.
NOTE:
3.
Make sure you are clicking on the button from the toolbar of diagram loop. If you are clicking on the button at editor toolbar, you will
create a loop at template root.
On the right hand side of the template editor, select the type of diagram element to be looped and click
Element loop
P. 748
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Element loop
P. 749
Element summary
An element summary is a component in a document template, indicating the need of looping (i.e. walking through) specific type(s) of diagram/model
element and presenting their properties in tabular form. For example, to loop all use cases in a project and form a table consisting of use case IDs
and documentation. By default, a table of element names will be printed. You are expected to add property column(s) under an element summary to
indicate the element properties to print in the table.
Showing a property table for elements in project
To loop specific type(s) of model elements in project for listing their properties in a table, create an element summary at template root. To create an
element summary at template root:
1.
In the template editor, click on the
2.
on toolbar.
On the right hand side of the template editor, select the type of model element(s) to loop and click
NOTE:
3.
By default, element summary added to project root enables the looping of root level elements.
If you want to change to access elements in all levels, change the option Root Level above the element list.
Notice that changing the value of Root Level is not about changing available element selection but also the end result,
whether to access only root level elements or not.
If you generate document with a template like this, you will obtain a table of element names, provided that the element(s) of the chosen type(s)
exit(s). If you need to print specific element properties in table other than just name, click on the Add Property Column button in the toolbar
of element summary, then select the property(ies) to be added into the table as column(s). For more details about the use of property, read the
chapter Property.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Element summary
P. 750
Element paragraph
An element paragraph is a component in a document template, indicating the need of looping (i.e. walking through) specific type(s) of diagram/model
element and presenting their properties in paragraph form. For example, to loop all use cases in a project and form paragraphs consisting of use case
IDs and description. By default, a list of element names will be printed. You are expected to add property value(s) under an element paragraph to
indicate the element properties to print out.
Showing a property paragraph for elements in project
To loop specific type(s) of model elements in project for listing their properties in paragraph form, create element paragraph at template root. To create
element paragraph at template root:
1.
In the template editor, click on the
2.
on toolbar.
On the right hand side of the template editor, select the type of model element(s) to loop and click
NOTE:
3.
By default, element paragraph added to project root enables the looping of root level elements.
If you want to change to access elements in all levels, change the option Root Level above the element list.
Notice that changing the value of Root Level is not about changing available element selection but also the end result,
whether to access only root level elements or not.
If you generate document with a template like this, you will obtain a list of element names, provided that there exists element(s) of the chosen
type(s). If you need to print specific element properties other than just name, click on the Add Property Column button in the toolbar of element
paragraph, then select the property(ies) to show. For more details about the use of property, read the chapter Property.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Element paragraph
P. 751
Custom content
Custom content is a component in a document templat which acts as a placeholder of user written text. For example, to add a section of
acknowledgment at the beginning of document with custom text. You can write custom content in rich text and you can add custom content to template
root or under a diagram/element loop.
Adding custom content at template root
To add custom content at template root:
1.
In the template editor, click on
2.
on toolbar.
On the right hand side of the template editor, enter the custom content. You can format your content through the buttons in the content pane.
For details, read the section below about editing custom content.
Select the loop that you want to add custom content under it.
Click on the Add Custom Content button from the toolbar of loop.
NOTE:
3.
Make sure you are clicking on the button from the toolbar of element loop. If you are clicking on the button at editor toolbar, you will
create a loop at template root.
On the right hand side of the template editor, enter the custom content. You can format your content through the buttons in the content pane.
For details, please read the section below about editing custom content.
Name
Description
Editor pane
The editor where you can enter and edit custom content.
Bold
Italic
Underline
Alignments
Ordered list
Custom content
P. 752
Un-ordered list
Font
Font size
Font color
Table
Add a table.
Background color
Clear formats
Add Link
Add a hyperlink.
Add Image
Add an image.
Add Diagram...
Add a Diagram
10 Save as template...
Manage template...
11 Find
A description of custom content editor
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Custom content
P. 753
Diagram image
Diagram image is a component in a document template which represents a placeholder of the image of a diagram under a diagram loop. You must
place a diagram image under diagram loop. To add a diagram image:
1.
Select the diagram loop that you want the images of diagrams to be printed.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Diagram Image
P. 754
Property value
Property value is an element component in a document template, which represents the access of certain property of a diagram, model element or
diagram element. For example, to print out the ID (property) of a use case. You can add property value into a diagram loop, a diagram summary, an
element loop, an element summary. Property value added to a summary component will become a property column in summary table.
Adding property value into a loop or summary
To add property value into a loop or summary:
1.
Select the loop or summary that you want to add property value under it.
Click on the Add Property Value button from the toolbar of loop.
On the right hand side of the template editor, select the property to access.
Click on the Add Property Value Below or Add Property Value Above button.
On the right hand side of the template editor, select the property to access.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Property value
P. 755
Page break
Page Break is where the document should start the contents which follows in a new page. It can be placed within a loop, either a diagram or element
loop. To create a Page Break:
1.
Click on the Add Page Break button from the toolbar of loop.
Reposition the page break by pressing Move Up or Move Down from the toolbar of page break.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Page break
P. 756
P. 757
2.
In the Project Publisher dialog box, specify the output directory where you want to save the published content.
3.
You can optionally configure the publisher by adjusting the options or options. For details, refer to the sections below.
4.
Name
Description
Output directory
Base path
If a base path is specified and then published files are moved to the base path, diagram and model element can be
accessed directly with a dedicated link.
When checked, published content will show images in exact width and height.
You can add file references to model elements. When this option is checked, referenced files will be copied to
the output directory, so that you can access for any referenced file when browsing the published content in other
machine easily.
Publish voices
When checked, audio clips added to the description will be published and can be opened when browsing the
published outcome.
Launch viewer
When checked, the system will launch the web browser and open the published Web contents.
Advanced options
Click to configure advanced publisher options. For details about the options, read the next section.
OK
Click to publish.
Cancel
10 Apply
11 Help
Advanced options
On the Project Publisher dialog box, you can configure some of the common options. You can also configure the advanced options for more detailed
settings by clicking the Advanced Options... button.
Option
Description
P. 758
By default, top and bottom margins are added above and below
RTF description text, due to the default style applied to the RTF
description. If you want to remove the margins, you can override
the setting by unchecking this option.
Generate menu
Publisher engine
Choose the engine for publishing. You are advised to use the
new engine.
P. 759
Default diagram
Choose the diagram that first appear when the published content
is opened. If unspecified, a default page with project information
will be presented.
Filtered content
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 760
Published project
No.
Name
Description
Navigator pane
Menu pane
It shows the sub-menus of the Navigator pane. The contents shown in this pane varies with the link you clicked in the
Navigator Pane.
Content pane
It shows the details of the item (diagram, model or package/class) you clicked in the Menu Pane or Content Pane.
Description of the interface of published Web content
Navigator pane
There are four tabs within the navigator pane - Diagram Navigator, Model Explorer, Class Navigator and Logical View. They are responsible for
reading the project from different angles.
Diagram Navigator
Diagram Navigator shows the categories of diagrams in the project. You can click on a category to view its diagrams in the Menu Pane, or click Show
All Diagrams to view all diagrams.
Diagram navigator
Model Explorer
Shows the package models in the project. You can click on a package to view its child models in the Menu Pane, or click Show All Models to view all
model elements.
Model Navigator
Class Navigator
Shows the Package models in the project. You can click on a package to view its child packages/classes in the Menu Pane, or click Show All Models
to view all packages/classes.
P. 761
Class navigator
Logical view
Echos the logical view defined in project. You can click on a diagram to open it.
Logical view
To view the details of an item (diagram, model or package/class), click on its link in the Menu Pane and its details will be shown in the Content Pane.
Menu navigator
Diagram Content
Diagram content
The diagram type, name, description, together with a full size image of the diagram are shown in the Content Pane. The image is mapped to different
clickable regions for each shape, so, you can click on a shape in the image to view its details.
P. 762
Using jump to
The Jump to drop down menu in the diagram content page lists all shapes in the diagram. You can select a shape to jump to. The content page will
scroll to the selected shape and the shape will be highlighted by a red border.
Jump to
Besides, there will be two shortcut buttons above the selected shape.
The Back to top button brings you to the top of the page.
Back to top
The Open specification button brings you to the details page of the shape.
P. 763
Open specification
Model elements
The Model Elements section of the diagram content page shows the name, type and description of the models of all shapes in the diagram. You can
click on the link of a model to view its details.
Model elements
Parent hierarchy
The parent hierarchy is shown as a list of models on top of the page. You can click on a parent in the hierarchy to view its details.
P. 764
Parent hierarchy
Relationships
The summary of the relationships of the model is shown in the Relationships Summary section. Click on a relationship and it will take you to the
Relationships Detail section.
Relationships summary
Relationships detail
Relationships detail
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 765
P. 766
To build a document with the Build from Scratch mode is to being from a blank document, and then make use of the tools and element templates to
write and complete the document.
Fill-in Doc
Typically, a project documentation or report is a combination of background information like project goal, scope and constraints, and design details like
use case details, database design, process design, etc. The Fill-in Doc mode of Doc. Composer is designed to help you "fill-in" the design details of
your documentation.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 767
Creating a Document
Create a document in Doc. Composer, under Build from Scratch mode.
Overview of Doc. Composer
Quick look of the various part of Doc. Composer in Visual Paradigm.
Using Loop
Query children element of element selected in Diagram Navigator / Model Explorer with the help of the Loop tool.
Adding Image
Insert pictures, logo images or whatever images into Doc. Composer. You will learn how to add image in this article.
Add Table
Structure data with table. In this article you will learn how to insert a table into Doc. Composer.
Using Section
You will learn how to add and configure sections in Doc. Composer in this article.
P. 768
Instead of creating a document with built-in element templates, you can write your own. You will learn how to do this in this article.
Exporting a Document
In Visual Paradigm, there are three types of document available for exporting: HTML, PDF and Word. This article will demonstrate how to export a
document.
P. 769
2.
Form the content by dragging and dropping element templates from the Templates pane onto the document.
3.
Touch-up the document by adding TOC, defining headers & footers, configuring styles, etc.
4.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 770
Creating a Document
To create a document:
1.
Under the Tools tab, click on the Doc button and then select Doc. Composer from the drop down menu.
2.
Name the document by double clicking on Document1 in the breadcrumb and then typing in a new name.
Press the Enter key to confirm the naming. Your screen should look like this:
To have more editing space, we recommend you to collapse the toolbar temporarily by double clicking on the Tools tab.
Collapsed toolbar
NOTE:
If you don’t see the Doc. Composer button, make sure you are running the Standard Edition (or higher) of Visual Paradigm, and
have Sleek chosen as the UI style.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Creating a Document
P. 771
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
Creating a Document
P. 772
Name
Description
Diagram Navigator/
Model Explorer
The Diagram Navigator and Model Explorer (behind Diagram Navigator) provides you with access to different
parts of your project– the project, diagram, diagram elements and model elements. If you want to output
content for say a use case diagram named "My Diagram", select "My Diagram" in Diagram Navigator (or Model
Explorer) first.
A list of element templates available for the project data selected in Diagram Navigator or Model Explorer.
As said earlier, each type of project data has its own set of element templates. Take the image above as
an example, by selecting a use case diagram in Diagram Navigator, the templates Basic, Details, Project
Management, etc. are listed. If you select other project data in Diagram Navigator or Model Explorer, a
different list of element templates will be presented.
Document creation is the process of dragging and dropping a suitable template from the Element Template List
onto the document.
Documnet
Content of document. What you can see here will be what you will get when you export the document as
HTML/PDF/Word. On top of the document there is a toolbar that provides you will access to tools like format
configuration, report configuration, page break insertion, etc. We will talk about the tools later on in this chapter.
Description of Doc. Composer
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 773
Select project / diagram / diagram element / model element on Diagram Navigator / Model Explorer.
Selecting a diagram
2.
Select the desired element template from the Element Template Pane and drop it/ them on the document.
Instead of adding content element by element, you can select multiple elements at the same time to speed up the document creation
process.
Editing Image
You can add diagram images into a document with the use of element template. For diagrams presented on a document, instead of showing the entire
diagram you may want to have it focused on a specific part of a diagram. In order to achieve this, edit the image by taking the steps below.
1.
Click each image so that a bar will appear at the bottom of the image. You can edit the image through the bar. Initially, the whole diagram is
displayed to fit the placeholder.
P. 774
Selected an image
To zoom in the particular part of diagram, drag the slider to Zoom 100% (Actual Size).
Resizing an image
P. 775
NOTE:
You can only edit the images produced by templates you dropped onto the document but not inserted images.
NOTE:
The default setting of image on document is Disable Auto Fit Placeholder. Nevertheless, once you zoom or resize, it will turn to be
Enable Auto Fit Placeholder automatically.
By default, the Basic template is chosen to be the default template. You can, however, set a user created template to be the default. Note that you can
select either the Basic template, or any of the user created templates as default. You cannot select a built-in template as the default, except the Basic
template.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 776
Press to select the blocks to move up or down. You can perform a multiple selection by pressing the Shift or Ctrl key.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 777
Using Loop
Besides element template, there is another tool to query project data and place it onto a document, called the Loop tool. You can access the Loop tool
under the Element Template Pane.
Configure loop
Items listed under the Elements tab are children elements of the element selected in Diagram Navigator / Model Explorer. For example, if you have
selected a diagram, you can expect the diagram elements being listed here.
Content will be added to document for each of the elements listed. The content to produce is determined by an element template. You can select the
template under the Element Types tab.
Using Loop
P. 778
Using Loop
P. 779
If you want to remove an element or element type from the exclude list, open the Excluded tab, move your mouse pointer over the item to be removed
and then click on the Include button on the right hand side of the hovering row.
Sorting
To re-order elements, click on the Sorting drop down menu at the top of the New Loop window and select the way to sort.
Description
System
Name
Model Type
Sort by element type. You can customize the sort order in the Element Types tab.
Manual
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
Using Loop
P. 780
2.
Enter text in the text box. You can use the pop-up formatting toolbar to convert your plain text into RTF when you want to emphasize some
terms/ phrases.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 781
Adding Image
Document supports inserting images. An image can be a logo or picture that is placed on the document. Not only you can place pictures on the empty
space of document but also fit them inside table cells. In this sense, you can insert your company logo into any preferred place within the document
when you are doing a company document. The advantage is you can spare no effort in arranging a series of images in document and then resize them.
To add an image:
1.
Select the content block where you want to insert an image beforehand.
2.
To add an image
3.
Select the directory of your target image and then click Open button in Choose image(s) dialog box. As a result, the selected image is inserted.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
Adding Image
P. 782
Adding Table
Table is one of the popular elements in structuring data. To create a table:
1.
2.
3.
Select the content block where you want to insert a table beforehand.
Click on the
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
Adding Table
P. 783
Select the content block where you want to insert a page break beforehand.
2.
Click on the
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 784
Using Section
A section is a number of continued pages that apply the same set of page properties. These properties include page size, page orientation, page
margin, visibility of header/footer, content of header/footer, etc.
Because section allows you to define different layouts for different pages, you can make pages that consist of wide tables show in landscape, with the
other pages remain in portrait. You can also add content-specific header and footer.
By inserting a section break, pages that appear after the break will apply the same set of page properties as defined in the break. To insert a section
break:
1.
Select the content block where you want to insert a section break beforehand.
2.
Click on the
button on the document's toolbar. A section page is inserted which moves the chosen content to a new page.
The layout of pages within a section are controlled by the setting configured in the section break. To configure a section break:
1.
2.
Select Edit... from the popup menu. This shows the Section Properties window.
3.
Name
Description
When checked, section properties will follow that defined in previous section. For the first section, it follows the
properties set to the whole document.
Page size
Page Orientation
Measurement unit
Unit of margin.
Top margin
Determine the empty space at the top of a page. You can edit the margins size by entering the sizes into the
text fields. Alternatively, click the spinner buttons to increase/ decrease the margin sizes.
Right margin
Determine the empty space on the right hand side of a page. You can edit the margins size by entering the
sizes into the text fields. Alternatively, click the spinner buttons to increase/ decrease the margin sizes.
Bottom margin
Determine the empty space at the bottom of a page. You can edit the margins size by entering the sizes into
the text fields. Alternatively, click the spinner buttons to increase/ decrease the margin sizes.
Left margin
Determine the empty space on the left hand side of a page. You can edit the margins size by entering the
sizes into the text fields. Alternatively, click the spinner buttons to increase/ decrease the margin sizes.
Previous of page
10
Header/Footer
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
Using Section
P. 785
Select the content block where you want to insert a table of contents beforehand.
2.
Click on the
button on the document's toolbar and then select Table of Contents from the drop down menu.
To change the title, maximum number of level, level detection or styles of a table of contents, to configure it. To configure a table of contents, right click
on the table of contents and select Configure Table of Contents... from the popup menu.
Here is a description of different parts of the Configure Table of Contents window.
Description
The title of the table of contents. This is the text that appear above the table of contents in document.
Specify the style to check for each level. If you want level 1 shows all content with Heading 1 as style, select Level 1 on the left hand side,
Heading 1 on right hand side, and click < to match them up.
Specify the appearance of text in table of contents. You can apply different styles for different rows (levels).
Overview of Configure Table of Contents window
To update a table of contents to make it reflect the structure of the latest document content, right click on the table of contents and select Update Table
of Contents from the popup menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 786
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 787
Select the content block where you want to insert a revision log beforehand.
2.
Click on the
3.
button on the document's toolbar and then select Revision Log from the drop down menu.
To enter a revision, double click on the cells and enter the values one by one.
If you want to insert more rows or columns, right click on the revision log and select Insert Row or Insert Column from the popup menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 788
2.
3.
Configure the cover page by specifying the file path of logo image, title, organization name, author name. You can preview the page at the right
hand side of the Document Properties window.
4.
Click OK.
NOTE:
Built-in cover page is only visible in exported document, not in Doc. Composer
button on the document's toolbar and then select Cover Page from the drop down menu.
2.
When you insert a free style page the first time, you are prompted to override the generate cover page option. By default, the built-in cover page
would be chosen as cover page. When you try to insert a free style cover page, the built-in cover page would be ignored. This option is to ask for
your confirmation for ignoring the built-in cover page. Click OK to confirm.
3.
You will see an empty cover page added to the beginning of the document. Note that the page MUST be added to the beginning of document
and you cannot control its location. If you want to add a page of custom content in the middle of the document, insert a Free Style Page instead.
4.
Start editing the page by inserting text and image. To insert text or image into the page, right click on the background of cover page and select
Insert Free Style Text or Insert Free Style Image from the popup menu.
5.
Fill in the text or select the image file to insert to the page. Repeat step 3 and 4 to complete the page.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 789
Description
Single Page
Two-Up
Two-Up Continuous
Click the Page Display Option button to select a page display option from the drop-down menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 790
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 791
2.
Select the type of element to create template. For example, select ANY use case diagram in Diagram Navigator if you want to create a
template to list specific shapes in use case diagram. You can select project / diagram / model element / diagram element in Diagram Navigator
and Model Explorer.
Selecting a diagram
3.
The Element Template Pane lists the templates available for the selected element type. If your Template pane is hidden, select View > Panes
> Property in the toolbar (or press Ctrl+Shift+P) to show it.
4.
To simplify the programming of template, you are suggested to duplicate an existing template and start editing it, rather than do everything
from scratch. Target on a template that gives the closest outcome to what you want to show in document. If you want to start from an empty
document, select any templates. Right click on your selection and select Duplicate... from the popup menu.
In the Edit Template window, specify the following information and click OK to continue.
Name: The name of the element template, which is the name that shown under the Element Template Pane.
Icon: An icon that best represent the layout of content that will be produced by using this template.
Set as Default Template: Check this option if you want Doc. Composer to apply this template automatically when dragging elements directly
from Diagram Navigator / Model Explorer onto document.
Template content: Editor for programming the template.
P. 792
Customize your template and click OK to apply the changes. To learn how to write a template, click here.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 793
Exporting a Document
After you have customized your document template on document, you can export it into document. There are three types of document available for
exporting: HTML, PDF and Word.
In document, click the Export button at the top right corner and select a type of document for exporting.
Name
Description
Exporting a document
P. 794
Output path
Launch viewer
Document info
Options
To determine how data is to be printed in document by setting some of the configurable options.
Page Setup
Cover Page
Watermark
Export
10 Cancel
NOTE:
Option
Description
Title
The title of document. This option is only available for exporting PDF document.
Author
Subject
The subject of the document. This option is only available for exporting PDF and Word document.
Keywords
Info header
The info header of the document. This option is only available for exporting PDF document.
The info header content of the document. This option is only available for exporting PDF document.
Allow modify
Select to allow modification on the document. This option is only available for exporting PDF document.
Description of Document Info tab
Exporting a document
P. 795
Option
Description
Select the type of image format for image that appear in the exported document.
Font
By default, document content will be printed in English. By checking this option, it will follow the language setting
chosen in global options.
By checking this option, table header would be repeatedly printed when the table span multiple pages.
Description of Page Setup tab
Option
Description
Page size
Page Orientation
This option is used to select the orientation of the document (portrait/ landscape). This option is
only available to PDF and Word document.
Header
Check this option to insert header to the exported document. This option is only available to PDF
and Word document.
Header Separator
Check this option to insert header separator to the exported document. This option is only
available to PDF and Word document.
Footer Separator
Check this option to insert footer separator to the exported document. This option is only available
to PDF and Word document.
Footer
Check this option to insert footer to the exported document. This option is only available to PDF
and Word document.
Page Margin
To specify the page margins of the document: top, left, right and bottom. This option is only
available to PDF and Word document.
Measurement Unit
To choose the measurement unit of page margin of the document: inch and cm. This option is
only available to PDF and Word document.
Specify the width of spaces between the content and the page border.
Exporting a document
P. 796
Option
Description
Insert an image to the cover page. You can specify the image's directory or select the directory by clicking the ...
button.
Logo scale
Title
Organization name
Author name
Alignment
Control the position of content, whether to appear on the left, center or right hand side of the page.
Option
Description
Generate Watermark
Text
Color
Specify the color of text will be used for watermark by clicking the ... button.
Transparency
To change the background transparency for watermark, move the Transparency slider or specify the
percentage of transparency directly.
Font Name
Font Style
Exporting a document
P. 797
Font Size
Sample
Option
Description
Word Template
Path
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
Exporting a document
P. 798
Touching-Up a Document
Open a Doc Base, and then touch-up the document in Doc. Composer before exporting. You will learn how it works in this article.
Previewing a Document
Take a quick look at the document file that will be generated with the applied Doc Base.
Generating a Document
Generate your project documentation from Doc. Composer in Visual Paradigm.
Querying Diagrams
Read this section to learn how to retrieve a diagram or diagrams, and to output content like the diagram’s image, name or a list of containing
diagram elements, etc.
P. 799
2.
Place some special fields to the parts that requires the insertion of design details.
3.
4.
Export a document. Doc. Composer analyze the special fields in your document and replace them with actual project content.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 800
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 801
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 802
Under the Tools tab, click on the Doc button and then select Doc. Composer from the drop down menu.
2.
Name the document by double clicking on Document1 in the breadcrumb and then typing in a new name.
5.
Click on ... next to the Doc base field to open a document file as Doc base. Doc base is a Word document file that contains both manually
written content (e.g. Introduction, project scope, etc) and Doc Fields. If you are unclear about Doc Base and Doc Field, read the previous
sections.
6.
Doc. Composer analyzes your Doc Base and presents the Doc Fields that exist in your document. Your screen should look like this:
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 803
Touching-Up a Document
If your Doc Base contains any of the following kinds of Doc Fields, you have to touch-up the document in order to export a document file from Doc.
Composer.
${TEXT} field
To "touch-up" a document means to select diagram(s) or model element(s), or to enter the content required by Doc Fields in a document. For example,
if in a Doc Base there exist a ${TEXT} like this:
<${TEXT, "Project Name"}>
You'll have to provide the project name in Doc. Composer. Here is what you will see in Doc. Composer:
Touching-Up a Document
P. 804
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
Touching-Up a Document
P. 805
Previewing a Document
If you want to take a quick look at the document file that will be generated with the applied Doc Base, click Preview at the bottom right corner of the
document preview. A temporary document file will be opened for you to preview the outcome.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
Previewing a Document
P. 806
Generating a Document
When you are ready for producing the final document, click Generate at the bottom right corner of the document preview. Enter the filename of the
document and confirm. A complete document file will then be generated.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
Generating a Document
P. 807
field_name is a short description of the field (e.g. "List of Use Case Diagrams"). In Doc. Composer, you can see the fields placed in an
imported Doc Base. The fields are represented by the field_name typed here. field_name must be unique within a Doc Base. If there are two
or more fields having the same field name, content may be produced wrongly.
diagram_type indicates the type(s) of diagram that you want to query (e.g. "UseCaseDiagram"). If you want to query all types of diagram
in a project, skip this parameter. If you want to query multiple types of diagram, enter their types respectively, separated by comma (e.g.
"ClassDiagram,UseCaseDiagram"). Click here for the proper diagram types to use.
One | Any | LoopInProject | LoopInElement indicates the source from which to query diagrams.
One – Query a specific diagram in project. This option is often used when your document, or part of the document is written
around a specific diagram. If you choose One here, you will have to select in Doc. Composer the diagram to query.
Any – Query a number of diagrams in project. If you choose Any here, you will have to select in Doc. Composer the diagram to
query.
LoopInElement – Query the sub-diagram(s) of a specific model element. If you choose LoopInElement here, you will have to select
in Doc. Composer the model element from which to query sub-diagrams.
template_name | PROPERTY= property_name | ICON | IMAGE – The type of content to be extracted from the querying diagrams and
printed on the document.
template_name – Output content from each of the querying diagrams, based on the template template_name written for the
type of the querying diagram. For example, if you have a template AllUseCases written for Use Case Diagram, by specifying AllUseCases
as template_name , Doc. Composer will output content for each of the Use Case Diagrams by following AllUseCases.
PROPERTY= property_name – Output a specific property (e.g. description) for each of the querying diagrams. If you want to
output multiple properties, try write a template and make reference to it by providing its name here.
ICON – Output the icon for each of the querying diagrams.
IMAGE – Output the diagram image for each of the querying diagrams.
${ELEMENT}
The ${ELEMENT} field is used to query model element(s) or diagram element(s) from a project (or a specific place in a project), and to output content
from the elements querying.
Here is an example of ${ELEMENT}:
${ELEMENT, "List of Use Cases", UseCase, LoopInProject, PROPERTY=name}
Here is the sample output:
Use Case1, Use Case2
This is the syntax of a ${ELEMENT} field:
${ELEMENT,
field_name ,
[" element_type {, element_type ...}", ]
One | Any | LoopInProject | LoopInElement | LoopInDiagram,
template_name | PROPERTY= property_name | ICON
}
This is a description of the various parts of a ${ELEMENT} field:
P. 808
field_name is a short description of the field (e.g. "List of Use Cases"). In Doc. Composer, you can see the fields placed in an imported Doc
Base. The fields are represented by the field_name typed here. field_name must be unique within a Doc Base. If there are two or more fields
having the same field name, content may be produced wrongly.
element_type indicates the type(s) of model/diagram element that you want to query (e.g. "UseCase"). If you want to query all types of model
element in a project, skip this parameter. If you want to query multiple types of model element, enter their types respectively, separated by
comma (e.g. "Actor,UseCase").
One | Any | LoopInProject | LoopInElement | LoopInDiagram indicates the source from which to query elements.
One – Query a specific model element in project. This option is often used when your document, or part of the document is
written around a specific model element. If you choose One here, you will have to select in Doc. Composer the model element to query.
Any – Query a number of model elements in project. If you choose Any here, you will have to select in Doc. Composer the model
element to query.
LoopInElement – Query the child elements of a specific model element. If you choose LoopInElement here, you will have to select
in Doc. Composer the model element from which to query child elements.
LoopInDiagram – Query the diagram elements from a specific diagram. If you choose LoopInDiagram here, you will have to select
in Doc. Composer the diagram from which to query diagram elements.
template_name | PROPERTY= property_name | ICON | IMAGE – The type of content to be extracted from the querying elements and
printed on the document.
template_name – Output content from each of the querying elements, based on the template template_name written for the
type of the querying element. For example, if you have a template UseCaseInfo written for Use Case, by specifying UseCaseInfo as
template_name , Doc. Composer will output content for each of the Use Cases by following UseCaseInfo.
PROPERTY= property_name – Output a specific property (e.g. description) for each of the querying elements. If you want to
output multiple properties, try write a template and make reference to it by providing its name here.
ICON – Output the icon for each of the querying elements.
${ICON}
When you are working with a table, you can place the ${ICON} field in a table cell to let Doc. Composer replace it with the icon image of the querying
diagram or element.
Note that ${ICON} can only be used in a table cell.
Here is an example of ${ICON}:
${ICON}
Here is the sample output:
P. 809
field_name is a short description of the field (e.g. "Project name"). It can also be used as a reminder to provide certain kind of information (e.g.
"Please enter the project name."). field_name must be unique within a Doc Base. If there are two or more fields having the same field name,
content may be produced wrongly.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
P. 810
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 811
Querying Diagrams
If you want to retrieve a diagram or diagrams, and to output content like the diagram's image, name or a list of containing diagram elements, etc., read
this section to learn the ways to retrieve diagrams.
Querying Diagrams in Project
If you want to output the image or any detail of all the diagrams in project, write a ${DIAGRAM} field in your Word document with LoopInProject
specified as diagram source. Here are several examples of such a ${DIAGRAM} field:
${DIAGRAM, "Name of ALL Use Case Diagrams", "UseCaseDiagram", LoopInProject, PROPERTY=name}
${DIAGRAM, "Description of ALL diagrams", , LoopInProject, PROPERTY=description}
${DIAGRAM, "Details of ALL Use Case Diagram and class diagram", "UseCaseDiagram,ClassDiagram", LoopInProject, MyTemplate}
In the first example, the name of all Use Case Diagrams in the project will be output. Note that "Name of ALL Use Case Diagrams" is the field name,
which is a required and unique value for identifying this field.
In the second example, the description of all the diagrams in the project will be output.
In the third example, content will be output for each of the Use Case Diagrams and Class Diagrams in the project, based on the template MyTemplate.
Querying Selected Diagrams in Project
The diagrams in your project may be created for different contexts or about different problem domains. When you write a documentation, you may want
to focus on a specific context at a time, which requires the insertion of design specification for that specific context. In that case, you will want to query
a selected set of diagrams in your project, instead of querying all diagrams.
If you want to output the image or any detail of selected diagrams in project, write a ${DIAGRAM} field in your Word document with Any specified as
diagram source. Here are several examples of such a ${DIAGRAM} field:
${DIAGRAM, "Use Case Diagrams (Admin)", "UseCaseDiagram", Any, PROPERTY=name}
${DIAGRAM, "Diagram Images", , Any, IMAGE}
${DIAGRAM, "Diagram Images", , Any, MyTemplate}
In the first example, the name of selected Use Case Diagrams in the project will be output. Note that "Use Case Diagrams (Admin)" is the field name,
which is a required and unique value for identifying this field.
In the second example, the image of selected diagrams in the project will be output.
In the third example, content will be output for each of the selected diagrams in the project, based on the template MyTemplate.
When you pick-up a Doc Base with such a ${DIAGRAM} field in it, you can select the diagrams to query in Doc. Composer.
Querying Specific Diagram in Project
Let's say you have created multiple Use Case Diagrams for multiple sub-systems. When you write a documentation for a specific sub-system, you
may want to insert the design specification related to that specific sub-system. In that case, you will want to query a specific Use Case Diagram in your
project.
If you want to output the image or any detail of a specific diagram in project, write a ${DIAGRAM} field in your Word document with One specified as
diagram source. Here are several examples of such a ${DIAGRAM} field:
${DIAGRAM, "ATM Overview", "UseCaseDiagram", One, PROPERTY=description}
${DIAGRAM, "Online Photo Album", , One, IMAGE}
${DIAGRAM, "CS System – Use Cases", , One, Children}
In the first example, the description of selected Use Case Diagram in the project will be output. Note that "ATM Overview" is the field name, which is a
required and unique value for identifying this field.
In the second example, the image of selected diagram in the project will be output.
In the third example, content will be output for the selected diagram in the project, based on the template Children.
When you pick-up a Doc Base with such a ${DIAGRAM} field in it, you can select the diagram to query in Doc. Composer.
Querying Sub-Diagrams from Specific Model Element
Let's say you have created several use cases and, for each use case, there are multiple sub-Business Process Diagrams that describe the business
workflow in which the use case might happen. When you write a use case report, you may want to present the details of the Business Process
Diagrams of a chosen use case. In that case, you will want to query the sub-diagrams of a selected use case.
If you want to output the image or any detail of sub-diagrams from a specific model element, write a ${DIAGRAM} field in your Word document with
LoopInElement specified as diagram source. Here are several examples of such a ${DIAGRAM} field:
${DIAGRAM, "Related Business Workflow", "BusinessProcessDIagram", LoopInElement, PROPERTY=name}
${DIAGRAM, "Images of Sub-Diagrams", , LoopInElement, IMAGE}
${DIAGRAM, "Sub Diagram Details", , LoopInElement, MySubDiagrams}
In the first example, the name of sub-Business Process Diagrams of the selected model element will be output. Note that "Related Business Workflow"
is the field name, which is a required and unique value for identifying this field.
In the second example, the image of sub-diagrams of a selected model element will be output.
In the third example, content will be output for each of the sub-diagrams of a selected model element, based on the template MySubDiagrams.
When you pick-up a Doc Base with such a ${DIAGRAM} field in it, you can select the model element to query in Doc. Composer.
Querying Diagrams
P. 812
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
Querying Diagrams
P. 813
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
P. 814
Standard Edition
Professional Edition
Enterprise Edition
P. 815
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 816
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 817
The row that contains the Doc Field replicate itself to list out all the elements queried.
In each row, the name of use case is output, which is the result of using PROPERTY=name in the Doc Field.
While this example output the name of use case, you can output complex content with the use of an element template. You just need to replace
PROPERTY=name with the name of that template.
The example above is perhaps a bit simple. Let's extend it to make it a bit more complicated and closer to practical usage. Let's study this table:
Use Cases in Project
${ELEMENT, "List of Use Cases", UseCase, LoopInProject, PROPERTY=name}
ID
${PROPERTY, "userID"}
Description
${PROPERTY,
"description"}
(to be confirmed)
We have added two more columns into the table, one for displaying the ID of use cases and another for displaying the description of use cases. Again,
if we apply the Doc Base on an ATM project, here is the sample outcome:
Use Cases in Project
Withdraw Cash
ID
Description
UC01Get cash from the ATM.
(to be confirmed)
Transfer Cash
UC02Transfer cash from one account to another.
(to be confirmed)
Donate Money
UC03Donate money to a chosen charity
(to be confirmed)
Pay Bills
UC04Settle bills
(to be confirmed)
Based on the outcome, you can see:
In order to output multiple properties of an element, add extra columns into the table and use ${PROPERTY} to output those properties.
You can format table content, like the green text you see above.
You may also want to present the icons of querying element. The following example gives you some ideas how to achieve it.
Model Elements in a Class Diagram
Or if you want a column of icons
${ELEMENT, "List of Model Elements", , LoopInDiagram, ICON} ${PROPERTY, "name"}
${ICON}
Here is the sample output when applying the above Doc Base on an ATM project, with a class diagram chosen to be the source of elements to query.
Model Elements in a Class Diagram
Account
atm
Transaction
User
You may also output diagram images using ${IMAGE}. Here is an example:
All Diagrams in Project
Diagram Image
${DIAGRAM, "All Diagrams", , LoopInProject, PROPERTY=name}
${IMAGE}
Here is the sample output when applying the above Doc Base on an ATM project.
All Diagrams in Project
Diagram Image
P. 818
NOTE:
${PROPERTY}, ${ICON} and ${IMAGE} can only be used inside a table cell.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 819
Template Root
Learn how to start off an element template by using an appropriate initiation block.
Looping (Connector)
When you want to retrieve connectors from a querying model element / diagram, write a loop element. You will learn how it works in this article.
Sorting in Loop
Add <Sortings> under a loop element (e.g. <IterationBlock>, <ForEach>) to sort retrieved elements. In this article you will learn how it works.
Conditional Expression
Write conditional expression to control the content to be presented. You will learn how to write conditional expression in this article.
DCTL Examples
Learn how to write Doc. Composer Template Language by reading a series of examples.
P. 820
Data retrieval - To query the use cases from a diagram, and then get the name of each use case.
That's what you can do with a DCTL - You compose an element template with DCTL, drag the template into your document in Doc. Composer, let Doc.
Composer interpret your template and output content accordingly.
In the coming sections you will see how to retrieve project data as well as to layout the content with the use of DCTL.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 821
Beginning of template
Every element template mush has <ElementBaseInitiationBlock>, <DiagramBaseInitiationBlock> or <ProjectBaseInitiationBlock> as root element.
The use of <ElementBaseInitiationBlock> is to tell the template engine that the template will be applied to a model element. If you are writing a
template for a model element (e.g. use case, package...), use <ElementBaseInitiationBlock> as template root.
The use of <DiagramBaseInitiationBlock> is to tell the template engine that the template will be applied to a diagram. If you are writing a template for a
diagram (e.g. Class Diagram...), use <DiagramBaseInitiationBlock> as template root.
The use of <ProjectBaseInitiationBlock> is to tell the template engine that the template will be applied to a project. If you are writing a template for a
project, use <ProjectBaseInitiationBlock> as template root.
If you check back the example used in the previous section, you will find that the template was written to query the use cases from a diagram. The
template will be applied on a diagram so <DiagramBaseInitiationBlock> was used as root element.
The following examples show the use of <ElementBaseInitiationBlock> and <ProjectBaseInitiationBlock> in templates.
<ElementBaseInitiationBlock>
<!—Output the name of selected class-->
<Property property="name"/>
</ElementBaseInitiationBlock>
<ProjectBaseInitiationBlock>
<!—Output the name of all use cases in the project-->
<IterationBlock allLevel="true" modelType="UseCase">
<Property property="name"/>
</IterationBlock>
</ProjectBaseInitiationBlock>
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
Template Root
P. 822
Description
Required?
isBold : boolean
Optiona
isItalic : boolean
Optiona
isUnderline : boolean
Underline text.
Optiona
isSuperscript : boolean
Optiona
fontFamily : string
Optiona
fontSize : integer
Optiona
foreColor : color
Optiona
alignment : string
{left | center | right}
Optiona
style : string
Set the name of style. You can add and edit style in Doc. Composer.
Optiona
numberingLevel : short
Determine the Numbering Level if the text is showing as a number or bullet list.
Optiona
indentation : double
Optiona
hyperlink : boolean
Specify whether the text is a hyperlink or not. If true, the text will be linkable.
Optiona
keepWithNextInWord : boolean
Make sure the text will be shown in same page with next item. (Used for WORD document only)
Optiona
keepWithNextInPreview : boolean
Optiona
Attributes of <Text>
You may have noticed the use of <Property> in the example above. <Property> is another way to output text. You use <Property> when you want to
output text by extracting the data from a property of querying diagram or element. The following example show the use of <Property> in a template.
<IterationBlock allLevel="true" >
<Text>Name: </Text>
<Property property="name"/>
<ParagraphBreak/>
<Property property="description"/>
<ParagraphBreak/>
<ParagraphBreak/>
</IterationBlock>
The first <Property> outputs the name of the querying element, while the second <Property> outputs the description.
Here is the outcome of the example above.
Name: Place Order
The process to check out a shopping cart and finish the payment.
Name: PaymentController
P. 823
Description
Required?
property : string
Optiona
isIgnoreHTMLFontSize : boolean
Optiona
isIgnoreHTMLFontFamiliy : boolean
Optiona
forcePlainText : boolean
Optiona
default : string
The text to show when the value of property has not ever been specified.
Optiona
isBold : boolean
Optiona
isItalic : boolean
Optiona
fontFamily : string
Optiona
fontSize : integer
Optiona
foreColor : color
Optiona
alignment : string
{left | center | right}
Optiona
style : string
Set the name of style. You can add and edit style in Doc. Composer.
Optiona
numberingLevel : short
Determine the Numbering Level if the text is showing as a number or bullet list.
Optiona
indentation : double
Optiona
hyperlink : boolean
Specify whether the text is a hyperlink or not. If true, the text will be linkable.
Optiona
keepWithNextInWord : boolean
Make sure the text will be shown in same page with next item. (Used for WORD document only)
Optiona
keepWithNextInPreview : boolean
Optiona
Attributes of <Property>
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 824
Description
Required?
modelType : string
Optional
modelTypes : string
Filter the children by a number of model element types. (e.g. actor, usecase)
Optional
stereotypes : string
Optional
name : string
Optional
filterhidden : boolean
Filter hidden children diagram element. This is for retrieving from diagram/
diagram element only.
Optional
includeConnectors : boolean
Optional
byBounds : boolean
Determines whether to retrieve shape by their bounds. This is for retriever from
diagram or diagram element only.
Optional
byBoundsInAllLevel : boolean
Optional
allLevel : boolean
Determines whether to retrieve all model elements from project. When false,
only the root level elements will be retrieved. This attribute is only useful when
retrieving elements from project.
Optional
ignoreLastSeparator : boolean
Ignore the break for the last element of current for-each loop.
Optional
Optional
identifier : string
Optional
Attributes of <IterationBlock>
<ForEach>
Retrieve model elements from a model element's property. The following example show the use of <ForEach> in a template.
property : string
Description
Required?
Optional
P. 825
ignoreLastSeparator : boolean
Ignore the break for the last element of current for-each loop.
Optional
breakString : string
Optional
Attributes of <ForEach>
<ForEachSubDiagram>
Retrieve sub-diagram(s) from a model element. For example, retrieve sub-sequence-diagrams from a controller class. Note that you can only use
<ForEachSubDiagram> to retrieve sub-diagram(s) of model element. If you want to retrieve diagrams from project, use <ForEachDiagram> instead.
The following table lists the available attributes of <ForEachSubDiagram>.
Name
Description
Required?
diagramType : string
Optional
ignoreLastSeparator : boolean
Ignore the break for the last element of current for-each loop.
Optional
Attributes of <ForEachSubDiagram>
<ForEachDiagram>
Retrieve diagram(s) from project. Like other for-each elements, you can specify the type of diagram to retrieve. For example, retrieve all class diagrams
from project. Note that you can only use <ForEachDiagram> to retrieve diagram from project. If you want to retrieve sub-diagrams from model element,
use <ForEachSubDiagram> instead.
The following table lists the available attributes of <ForEachDiagram>.
Name
Description
Required?
diagramType : string
Optional
property : string
Optional
ignoreLastSeparator : boolean
Ignore the break for the last element of current for-each loop.
Optional
Attributes of <ForEachDiagram>
<ForEachOwnerDiagram>
Retrieve the diagram(s) that owns a specific model element. For example, class diagram "Domain Diagram" and "Security" both contain class
"Login" (same model element), by applying <ForEachOwnerDiagram> on the "Login" class, diagram "Domain Diagram" and "Security" will be returned.
The following table lists the available attributes of <ForEachOwnerDiagram>.
Name
Description
Required?
diagramType : string
Optional
ignoreLastSeparator : boolean
Ignore the break for the last element of current for-each loop.
Optional
Attributes of <ForEachOwnerDiagram>
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 826
Looping (Connector)
<ForEachSimpleRelationship>
Retrieve SimpleRelationship elements from model element or connector from diagram element.
The following table lists the available attributes of <ForEachSimpleRelationship>.
Name
Description/Usage
Required?
modelType : string
Optional
modelTypes : string
Optional
direction
{all | from | to}
Optional
Ignore the break for the last element of current for-each loop.
Optional
Optional
Attributes of <ForEachSimpleRelationship>
<ForEachRelationshipEnd>
Retrieve the from or to end of an association.
The following table lists the available attributes of <ForEachRelationshipEnd>.
Name
Description/Usage
Required?
modelType : string
Optional
modelTypes : string
Optional
endPointer
{all | from | to | both | self | other}
Filter relationship ends based on the way they are attached to the querying
element. For example, if 'from' is specified, only relationships that take the
querying element as the source (i.e. from end) will be chosen.
Optional
ignoreLastSeparator : boolean
Ignore the break for the last element of current for-each loop.
Optional
breakString : string
Optional
Attributes of <ForEachRelationshipEnd>
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Looping (Connector)
P. 827
Professional Edition
Enterprise Edition
Looping (Connector)
P. 828
Sorting in Loop
Add <Sortings> under a loop element (e.g. <IterationBlock>, <ForEach>) to sort retrieved elements. <Sortings> contains one or more <Sorting>. Each
<Sorting> defines a way to sort the elements retrieved. The following example show the use of <Sorting> in a template.
<IterationBlock modelType="class">
<Sortings>
<Sorting by="name"/>
</Sortings>
</IterationBlock>
Here is the outcome of the example above.
Account
AccountController
AccountManager
Transaction
User
The following table lists the available attributes of <Sorting>.
Name
Description/Usage
Required?
by : string
{name | type | modelType | diagramType
| property | followTree | level |
businessProcessFlow}
Required
property : string
Optional
sortValues : string
Optional
defaultPropertyValue : string
Optional
descending : boolean
Optional
Attributes of <Sorting>
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
Sorting in Loop
P. 829
Conditional Expression
<DefaultValueChecker>
The following table lists the available attributes of <DefaultValueChecker>.
Name
Description/Usage
Required?
property : string
Required
Determines whether you expect the value to be the same as the default or not.
Optional
Attributes of <DefaultConditionChecker>
<ValueChecker>
The following table lists the available attributes of <ValueChecker>.
Name
Description/Usage
Required?
property : string
Optional
operator : string
{equals | not equals | less than | equals or
less than | greater than | equals or greater
than | like | not like | equal | not equal}
Specify the way to compare the property value of model against your
expectation.
equals - The value of property must be the same as the expected value
not equals - The value of property must be different from the expected value
less than - The value of property must be smaller than the expected value.
equals or less than - The value of property must be the same or smaller than the
expected value.
greater than - The value of property must be larger than the expected value.
equals or greater than - The value of property must be the same or larger than
the expected value.
like – The value of property must contain the expected value
not like - The value of property must not contain the expected value
equal – Deprecated. Replaced by "equals ".
not equal - Deprecated. Replaced by "not equals ".
Required
value : string
The value expected for the property. If @regularExpression is set to true, you
can make use of '?' and '*' in the value field for representing wildcard characters.
For example, use "*UI" as @value to find out all model elements with names end
with "UI".
Optional
length : int
Optional
caseSensitive : boolean
Determine whether the checking of string property need to take care of the use of
upper and lower case.
Optional
regularExpression : boolean
When true, you can make use of '?' and '*' in the value field for representing
wildcard characters. For example, use "*UI" as @value to find out all model
elements with names end with "UI".
Optional
id : string
Optional
Attributes of <ValueChecker>
<HasChildElementChecker>
The following table lists the available attributes of <HasChildElementChecker>.
Name
Description/Usage
Required?
Optional
modelType : string
The type of model element you want the parent to contain or not contain.
Optional
modelTypes : string
The types of model element you want the parent to contain or not contain.
Optional
stereotypes : strings
Optional
includeConnectors : boolean
Optional
filterHidden : boolean
allLevel : boolean
Determine whether to retrieve all model elements from project. When false,
only the root level elements will be retrieved. This attribute is only useful when
retrieving elements from project.
valueConditionCheckId : string
Conditional Expression
P. 830
Attributes of <HasChildElementChecker>
<HasRelationshipChecker>
The following table lists the available attributes of <HasRelationshipChecker>.
Name
Description/Usage
Required?
Optional
modelType : string
The type of relationship you want the querying model element to contain.
Optional
modelTypes : string
The types of relationship you want the querying model element to contain. If
@modelType is specified, @modelTypes will be ignored.
Optional
direction
{all | from | to}
Optional
Attributes of <HasRelationshipChecker>
<HasDiagramChecker>
The following table lists the available attributes of <HasDiagramChecker>.
Name
Description/Usage
Required?
flag : boolean
Optional
property : string
Optional
diagram : string
The type of diagram you want the project to contain or not contain.
Optional
Attributes of <HasDiagramChecker>
<HasValueChecker>
The following table lists the available attributes of <HasValueChecker>.
Name
Description/Usage
Required?
flag : boolean
Optional
property : string
Optional
modelType : string
Optional
name : string
Optional
stereotypes : string
Optional
Attributes of <HasValueChecker>
<HasParentModelChecker>
The following table lists the available attributes of <HasParentModelChecker>.
Name
Description/Usage
Required?
flag : boolean
Optional
modelType : string
The type of parent model element you want the model element to be/not to be
contained by.
Optional
Attributes of <HasParentModelChecker>
<HasSubDiagramChecker>
The following table lists the available attributes of <HasSubDiagramChecker>.
Name
Description/Usage
Required?
flag : boolean
Optional
diagramType: string
Optional
Attributes of <HasSubDiagramChecker>
Conditional Expression
P. 831
<HasOwnerDiagramsChecker>
The following table lists the available attributes of <HasOwnerDiagramsChecker>.
Name
Description/Usage
Required?
flag : boolean
Check whether you want the querying element has been visualized in any
diagram or not.
Optional
diagramType: string
Optional
Attributes of <HasOwnerDiagramsChecker>
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
Conditional Expression
P. 832
Description/Usage
Required?
tableStyle : string
tableWidth : integer
The width of table, in percentage. For example: 50% means to occupy 50% of page width.
Optional
colWidths : integers
Specify the widths of table columns in ratio, separate by comma. Note that the number of columns
specify in @colWidths must match the number of <TableCell> to add under <TableRow>, under this
table.
For example, specify "1, 1, 2" for a table with 20000 as width will result in creating a table with three
columns, and have widths 5000, 5000, 10000.
Optional
alignment = center
{left | center | right}
Alignment of table.
Optional
rowBackgroundColors Background
:
color of rows in table.
colors
Optional
Attributes of <TableBlock>
<TableRow>
Enables you to add cells to a <TableRow>.
Name
Description/Usage
Required?
height : integer
Optional
backgroundColor : color
Optional
Attributes of <TableRow>
<TableCell>
Enables you to add cells to a <TableRow>.
Name
Description/Usage
Required?
Optional
Optional
Optional
Optional
color : color
Optional
Optional
colspan : integer
Specify the number of cell this cell consumes horizontally. For example, a
colspan of 2 means to consume this and the cell on the right. This is equivalent
to HTML’s colspan.
Optional
verticalAlignment
{top | center | bottom}
Attributes of <TableCell>
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
P. 833
Standard Edition
Professional Edition
Enterprise Edition
P. 834
Description/Usage
Required?
alignment = left
{left | center | right}
Optional
width : string
Set the width of image. It can be an absolute value (e.g. "15500") or a scale to
the original image width (e.g. "80%")
Optional
height : string
Set the height of image. It can be an absolute value (e.g. "15500") or a scale to
the original image height (e.g. "80%")
Optional
maxWidth : integer
Optional
maxHeight : integer
Optional
rotate : string
Optional
keepWithPreviousInPDF : boolean
Make sure the previous item will be shown in same page with this item. (Used for
PDF document only)
Optional
keepWithNextInWord : boolean
Make sure the this item will be shown in same page with next item. (Used for
WORD document only)
Optional
keepWithNextInPreview : boolean
Make sure this item will be shown in same page with next item. (Used for
previewing in Doc. Composer only)
Optional
Attributes of <Image>
<Icon>
Icon of a model element type.
Name
Description/Usage
Required?
alignment = left
{left | center | right}
Optional
rotate : string
Optional
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 835
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 836
DCTL Examples
Working with Use Case Scenario
<Template>
<TemplateInformationHeader name = "Use Case Scenario" description = "/" type = "table" default = "false"/>
<ElementBaseInitiationBlock>
<StaticText content="Scenario of Selected Use Case"/>
<ParagraphBreak/>
<ForEach property="stepContainers">
<StringPropertyText property="name" style="Table Contents"/> <!-- Name of the scenario. You can add multiple scenarios to a use case -->
<TableBlock>
<FlowOfEventIterationBlock> <!-- Walk through each step (row) in a scenario -->
<TableRow>
<TableCell>
<FlowOfEventIndent/> <-- Apply proper indentation to the current step. You don't have to specify the level of indentation. It's
automatically done for you -->
<StringPropertyText property="index" foreColor="#848284" style="Table Contents"/> <!-- The step number. We set its foreColor to
a lighter one to make it looks like how it looks in Visual Paradigm -->
<StaticText content=" " style="Table Contents"/>
<ValueConditionChecker property="type" operator="not equals" value="">
<ValueConditionChecker property="type" operator="not equals" value="system">
<StringPropertyText property="type" foreColor="#00B200" style="Table Contents"/> <!-- @type here refers to 'control labels'
like if, then, elseif -->
</ValueConditionChecker>
<ValueConditionChecker property="type" operator="equals" value="system">
<StringPropertyText property="type" foreColor="#CA6400" style="Table Contents"/> <!-- @type here refers to SYSTEM -->
</ValueConditionChecker>
</ValueConditionChecker>
<StringPropertyText property="name" style="Table Contents"/> <!-- The content of step -->
</TableCell>
</TableRow>
</FlowOfEventIterationBlock>
</TableBlock>
</ForEach>
<StaticText content="" style="Default"/>
</ElementBaseInitiationBlock>
</Template>
Working with Sub-Diagrams
<HasSubDiagramChecker>
<!— Name of all sub-diagrams -->
<ForEachSubDiagram>
<Property property="name" />
<ParagraphBreak>
</ForEachSubDiagram >
<!— Name of all sub-BPD -->
<ForEachSubDiagram diagramType="BusinessProcessDiagram">
<Property property="name" />
<ParagraphBreak>
</ForEachSubDiagram >
</HasSubDiagramChecker>
Working with References
<!— Output the name of all Use Case reference -->
<HasValueChecker property="references">
<ForEach property="references">
<ValueConditionChecker property="type" operator="equals" value="Model Element">
<MetaModelElement property="url">
<ValueConditionChecker property="modelType" operator="equals" value="UseCase">
<Property property="name" />
</ValueConditionChecker>
</MetaModelElement>
</ValueConditionChecker>
</ForEach>
</HasValueChecker>
Working with Stereotypes and Tagged Values
<!— Output the name of all assigned stereotypes -->
<HasValueChecker property="stereotypes">
<ForEach property="stereotypes" ignoreLastSeparator="true">
<Text><<</Text>
<Property property="name" />
<Text>>></Text>
</ForEach>
DCTL Examples
P. 837
</HasValueChecker>
<!— Output the name of tagged values added -->
<HasValueChecker property="taggedValues">
<ModelElementProperty property="taggedValues">
<HasChildElementChecker modelType="TaggedValue">
<Property property="name" />
<Text> - </Text>
<Property property="value" />
</HasChildElementChecker>
</ModelElementProperty>
</HasValueChecker>
Working with Table Records of Entity
<!-— Check if an entity (i.e. DBTable) has record specified -->
<HasChildElementChecker modelType="EntityRecord">
<TableBlock>
<!— Create a header row that shows the columns' name in each cell -->
<TableRow>
<IterationBlock elementType = "DBColumn">
<TableCell>
<Property property="name" />
</TableCell>
</IterationBlock>
</TableRow>
<!—- Create one row for each record -->
<MetaModelElement property="records">
<IterationBlock elementType = "EntityRecord">
<TableRow>
<IterationBlock elementType = "EntityRecordCell">
<TableCell>
<!—- Output the value directly if it's a general column -->
<Property property="value" />
<!—- Use the following method to output the value if it's a FK -->
<HasValueChecker property="value" flag="true">
<MetaModelElement property="value">
<Property property="value" />
</MetaModelElement>
</HasValueChecker>
</TableCell>
</IterationBlock>
</TableRow>
</IterationBlock>
</MetaModelElement>
</TableBlock>
</HasChildElementChecker>
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
DCTL Examples
P. 838
UseCaseDiagram
Class Diagram
ClassDiagram
Sequence Diagram
InteractionDaigram
Communication Diagram
CommunicationDiagram
StateDiagram
Activity Diagram
ActivityDiagram
Component Diagram
ComponentDiagram
Deployment Diagram
DeploymentDiagram
Package Diagram
PackageDiagram
Object Diagram
ObjectDiagram
CompositeStructureDiagram
Timing Diagram
TimingDiagram
InteractionOverviewDiagram
Textual Analysis
TextualAnalysis
Requirement Diagram
RequirementDiagram
Basic Diagram
FreehandDiagram
CRCCardDiagram
WFAndroidTabletDiagram
WFAndroidPhoneDiagram
Desktop Wireframe
WFDesktopDiagram
iPad Wireframe
WFIPadDiagram
iPhone Wireframe
WFIPhoneDiagram
Web Wireframe
WFWebDiagram
ERDiagram
ORM Diagram
ORMDiagram
BusinessProcessDiagram
Conversation Diagram
ConversationDiagram
DataFlowDiagram
EPC Diagram
EPCDiagram
ProcessMapDiagram
Organization Chart
OrganizationChart
Fact Diagarm
FactDiagram
Decision Table
DTBDecisionTableEditorDiagram
BlockDefinitionDiagram
InternalBlockDiagram
Parametric Diagram
ParametricDiagram
Zachman Framework
ZachmanDiagram
P. 839
BusinessMotivationModelDiagram
ArchiMate Diagram
ArchiMateDiagram
SoaMLServiceInterfaceDiagram
SoaMLServiceParticipantDiagram
SoaMLServiceContractDiagram
SoaMLServicesArchitectureDiagram
ServiceCategorizationDiagram
Matrix Diagram
MatrixDiagram
Analaysis Diagram
AnalysisDiagram
Chart Diagram
ChartDiagram
Overview Diagram
OverviewDiagram
MindMapDiagram
Grid
GridDiagram
Brainstorm
Brainstorm
Profile Diagram
ProfileDiagram
Diagram types and their real type names
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Standard Edition
Professional Edition
Enterprise Edition
P. 840
P. 841
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Notations
Name
Representation
Description
Process
A process takes data as input, execute some steps and produce data as output.
External Entity
Objects outside the system being modeled and interacted with processes in a system.
Data Store
Files or storage of data that store(s) data input and output from process.
Data Flow
Decomposing a process
You can create multiple data flow diagrams for different levels of detail. A new level can be decomposed from a process in diagram. To decompose
a process, right click on the process and select Decompose from the popup menu. In the sub-diagram you will see the in/out flows that allow you to
connect the data flow from parent to sub-diagram. Click here you if you want to learn more about in/out flows.
P. 842
Decompose process
The Decompose Process dialog box will be prompted to ask you whether to add related data stores and external entities to the new data flow
diagram. If you choose Yes, those connected data stores and external entities will be copied to the new diagram.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 843
P. 844
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Notations
Name
Representation
Description
Event
Function
Operator
or
And - An and operation corresponds to activate all paths in the control flow
concurrently.
Or - An or operator corresponds to activate one or more paths among control flows.
or
XOR - An XOR operator corresponds to make decision of which path to choose among
several control flows.
Organization unit
Control flow
A control flow connects events with function, process paths or operators that create
chronological sequence and logical interdependencies between them.
Process path
Information resource
An information resource portrays objects in the real world that can input data serving as
the basic of a function or output data produced by a function.
Role
System
Information flow
Information flow shows the connection between functions and input or output data, upon
which the function reads changes or writes.
P. 845
Right click on the model element or the view of the model element that you want to apply stereotype to. Select Stereotypes > Stereotypes...
from the pop-up menu. As a side note for you, once you have ever applied a stereotype on the selected kind of element, you can re-select the
same stereotype in this popup menu.
In the model element specification, open the Stereotypes tab and then click on Edit Stereotypes....
3.
4.
In the Stereotype specification dialog box, enter the name of stereotype and click OK.
Naming stereotype
5.
This goes back to the specification dialog box. Select the stereotype you want to apply, then click > to assign it to the Selected list.
P. 846
Selecting stereotype
NOTE:
NOTE:
While clicking on > applies the selected stereotype to model element, clicking on < removes a stereotype selected in Selected list.
To apply all available stereotypes to model element, click on >> and likewise, clicking on << to remove all the applied stereotypes.
6.
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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 847
P. 848
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Notations
Name
Representation
Description
Process
Send
Receive
Process Link
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 849
Organization chart
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.
This chapter teaches you how to create an organization chart.
Organization chart
P. 850
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Creating a subordinate
Subordinate, which is subjected 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:
1.
Move the mouse pointer a unit and click its resource icon New Coworker, either on its left or right hand side. While clicking left resource icon
will create coworker on the left of the unit, clicking right resource icon will create coworker on its right.
Create coworker
2.
Name the newly created coworker unit and press Enter to confirm editing.
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.
P. 851
Moving a unit
2.
NOTE:
If you are not satisfied with the relocation, press Esc to cancel
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 852
RACI chart
A RACI chart is a matrix capable of showing how people or roles are related to business activities in a business process. You may form a RACI chart
from a BPD to record the responsibility roles among swimlanes (i.e. Pool and lane) and activities (i.e. Task and sub-process).
RACI Chart
P. 853
Informed - The participant who need to be informed for any update about the activity.
Right click on the background of a BPD and select Utilities > Generate RACI Diagram from the popup menu.
The role R, abbreviation for responsible, is automatically assigned to the intersection of participant and activitiy whenever the activity is put
inside an participant. You may add or remove roles by clicking on a cell in the chart and update the role selection.
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 854
P. 855
UeXceler
What is UeXceler?
Learn what UeXceler is.
Why UeXceler?
Know the benefits of following UeXceler in requirements gathering.
UeXceler
P. 856
What is UeXceler?
One of the keys to a successful software project is to build the system according to users' needs, but unfortunately, many software companies fail to
gather the right requirements from stakeholders, mostly due to stakeholders fail to express their needs and concerns clearly and thoroughly.
While it is easier for stakeholders to tell you what they need when they can experience a fully functional system or at least, prototypes, it is still time
consuming in developing any product or semi-product. Consequently, most of the development teams end up with two extremes: gain real customer
feedback at the end of project, or spent a lot of time and effort at the beginning of project until any real feedback is gathered. UeXceler strikes a
balance between the two extremes by letting user to see and feel the final product early in requirements gathering phases, but without spending too
much resources of the development team.
UeXceler is a guideline for software development teams to identify real system requirements at the very beginning of development projects. UeXceler
emphasizes the involvement and contribution of stakeholders. Throughout the requirement gathering process, stakeholders are encouraged to express
their concerns and needs, which are then converted into use cases, user scenarios and requirements of the solution. Wireframes are created for the
illustration of the end product in quick and cost-effective manner. At the end of the requirements gathering process, not only stakeholders see a list of
requirements but a set of business stories (scenarios) and a visualized system through wireframes. Both stakeholders and development teams can
comfortably consent to the planned requirements specification.
UeXceler stresses the importance of collaboration with customer rather than any kind of negotiation. By adopting UeXceler in requirements gathering,
stakeholders can easily preview what the system will look like without any functional features or prototype developed. Software development lifecycle
is highly optimized by having clear direction, resulted by clear requirements. Solid partnership can be built between business stakeholders and
technology team, which facilitates the accurate identification of system requirements and results in building software system that meets or even excels
customer's expectation.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
What is UeXceler?
P. 857
Why UeXceler?
As a contemporary way for requirement gathering, UeXceler addresses key challenges of historical ways for identifying system requirements. UeXceler
focuses on identifying stakeholders and users' real needs and the result is both a better software product and a higher customer satisfaction. The
following lists out the benefits that different roles of people, both in the stakeholders and people in project team can gain by adapting UeXceler.
To Stakeholder and User
UeXceler values the expertise and opinions contributed by stakeholders. Instead of guessing what the stakeholders needs, stakeholders are
encouraged to share their knowledge, concerns and suggestions, which are then converted into requirements of system. Because stakeholders
do have say in the project, they feel empowered, respected and trusted. Customer satisfaction is, as a result, significantly increased.
Because the solution is mostly made from stakeholders' input, it is more likely for them to buy into the final solution.
Stakeholders are presented both the system interactions and wireframe early in the requirement gathering phases. They know how the end
product will look like in early stage and feel more comfortable.
With the early inspection of product design, modification and new ideas can be added into the project without significant cost.
Because the project team develops feature according to the priority agreed with stakeholders, stakeholders can be more confident that the
business values and business priorities are aligned with development activities. Critical features can therefore be done, tested and even used in
early iterations.
To Project Team
UeXceler values the participation of stakeholders in developing a good piece of system. The active involvement of stakeholders allows clear
project direction throughout the product development, and avoids spending valuable time on re-work due to any late feedback.
Development activities are determined based on the use cases identified. By evaluating the nature of use cases, parallel development can be
planned and conducted. This saves a great deal of time on unnecessary waiting.
The ability to prioritize use case and requirements allows for delivering highest priority features earlier, avoiding risk resulted by late change.
The seamless connection between flow of events and wireframe provides an effective way for stakeholder to feel the user experience without
any real product get done - not even any prototype.
Save time by avoiding all sorts of non-productive work - no unnecessary documentation, no ineffective meetings, no complex screen design and
no prototyping.
Use case based stakeholders meeting makes the meeting fewer, shorter and more focused.
Definition of success is very clear at the beginning of development – you have the flow of events, requirements, wireframes as targets.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Why UeXceler
P. 858
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 859
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 860
P. 861
If you see the panes like Diagram Navigator and Property Pane minimized, with help contents showing in the middle of screen, this means that this
is the first time you open the Use Case Note. The panes are minimized to maximize the viewable list area. Click Keep Change if you want to keep the
panes minimized. If you want to roll back to the original screen layout, click Revert. And if you keep the change now, you can still customize the screen
layout by applying a perspective later on ( View > Open Perspective).
Entering use case notes
Once you have opened the Use Case Notes of a use case, you can start entering notes. There is a pre-defined template, with four points in it Workflow, Businses Logic, Decisions and Follow-up. You can follow these points in note taking. All you need to do is to click on the green text and
replace it by entering your note content.
P. 862
Nested notes
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 863
2.
Move the mouse pointer over the parent note item where the suggested system behaviors are recorded.
Move the mouse pointer to the beginning of the note item. Click on the down arrow next to the bullet point and select Flow of Events > To New
Scenario from the popup menu.
Scenario produced
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 864
Wireframe playback
Learn how to play your wireframes, which is important in a presentation.
P. 865
Name
Description
Add Step
P. 866
Font
Select font effect for the highlighted text: Bold, Italic and Font Color.
Font size
Move Up
Move Down
Decrease Indent
Increase Indent
Delete Step
10 Undo
Undo the last editing action made in the Flow of Events editor.
11 Redo
12 Synchronize to diagram
To select the presentation for use case link/actor link/requirement link/business rule 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.
14 Show Wireframe
Click to hide/show the wireframe pane that displays the wireframe(s) associated with the
selected step in the scenario.
15 Testing Procedure
In order to ensure that a use case is able to achieve as your expectation, you can test
each step of procedure defined in flow of events to view whether they will produce
prospective result or not.
16 Scenario
17 Define wireframe
18 Scenario list
19 Add Scenario
Click to create a new scenario. Mutliple scenarios can be created for describing the
different ways of achieving the use case.
20 Edit Scenario
21 Move Up
22 Move Down
23 Delete Scenario
24 Extension
Use case extension pane that list the steps extended from the main flow.
Description of Flow of Events editor
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
YouTube Video - How to Manage Use Case Scenario with Flow of Events?
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 867
2.
Add a scenario
3.
Start entering the steps of the new scenario in the Flow of Events editor.
Rename the scenarios. You can rename scenario by clicking Edit Scenario at the bottom left.
Edit Scenario
5.
You are prompted for a new name. Enter the name and confirm editing.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
YouTube Video - How to Manage Use Case Scenario with Flow of Events?
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 868
2.
Move the mouse pointer over the Define Wireframe button (i.e. the green button) on the bottom-right of the step. Click on it.
This shows a gray pane on the right hand side. Click on it to select a kind of wireframe to create.
Select a wireframe
5.
In the popup window, select the suitable type of device/platform for your application/system. If your system will run on multiple devices/platforms,
please consider creating multiple scenarions.
P. 869
Click New %TYPE% Wireframe where %TYPE% is the type of device/platform you selected.
7.
A blank, new wireframe appears and you can now begin editing.
When you have finished editing, you can go back to the scenario by clicking on the back button on top of the wireframe.
P. 870
State overview
If you want to create an entirely new wirefram:
1.
The remaining steps are same as those mentioned above, starting from step 5.
If you want to re-use an existing wireframe but make a bit of change, you should create a child state instead:
1.
Click Create Child State below the thumbnail of wireframe to create a child state under it.
Once clicked, a new wireframe state will be created. You can start editing it.
P. 871
2.
Click on the step that you want to associate a wireframe with it.
Move the mouse pointer over the Define Wireframe button (i.e. the green button) on the right hand side of the step. Click on it.
4.
This shows a gray pane on the right hand side. Click on it.
Clicking on Unspecified
6.
Choosing a wireframe
7.
This shows the available states of the wireframe. Select the right one by checking the checkbox at bottom left corner. Make sure you did
selected a state in this step. Without doing so, the wireframe won't be associated with the scenario step.
P. 872
Go back to the scenario by clicking on the back button on top of the state selection page.
2.
Click on the step that you want to add an extra wireframe to it.
3.
Move the mouse pointer over the Show Wireframe button (i.e. the green button) on the right hand side of the step. Click on it.
4.
There is a button under the thumbnail of the existing wireframe. Click on it and select Add... from the popup menu.
If you want to select another state of the selected wireframe, just check the checkbox of the wireframe state:
P. 873
Select a wireframe
Then, select the wireframe or click New Wireframe... to create a new one.
Select a wireframe
2.
3.
Move the mouse pointer over the Show Wireframe button (i.e. the green button) on the right hand side of the step. Click on it.
4.
There is a button under the thumbnail of the existing wireframe. Click on it and select Pointer/Drag/Finger Gesture from the popup menu. Note
that Pointer and Drag are available for Desktop and Web wireframe, while Finger Gesture is available for Android phone, Android tablet, iPad
and iPhone wireframes.
P. 874
Repositioning a pointer
2.
Click on the step that you want to remove a wireframe from it.
3.
Move the mouse pointer over the Show Wireframe button (i.e. the green button) on the right hand side of the step. Click on it.
4.
There is a button under the thumbnail of the existing wireframe. Click on it and select Remove from the popup menu..
P. 875
Remove a wireframe
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 876
Wireframe playback
Showing a screen flow of the system to your customer guarantees your customer to know what will be delivered by the end of the project. Visual
Paradigm not only allows you to associate use case scenario with wireframes in illustrating system interations but also supports playing the wireframes
associated with use case scenario. This can be very useful when you need to present the system design ideas to your customers and to look for their
consent.
Playing wireframes
1.
Open the Flow of Events of the desired use case.
2.
Move the mouse pointer over the Show Wireframe button (i.e. the green button) on the right hand side of the step. Click on it.
The preview of wireframe is now shown on the right hand side. On top of it there is a play button. Click on it.
Play wireframes
5.
This opens the wireframe player. The wireframe of the first step is shown in the player.
Wireframe playback
P. 877
Playing a wireframe
You can move on to the next wireframe by pressing the Right key or clicking on the arrow button at the bottom left of the player. Similarly, you
can press the Left key or click on the back button at the bottom left of the player to move to the previous wireframe. Note that when the flow
comes to a condition (e.g. if-then-else) or looping (e.g. while) control, you have to decide the next step by selecting the step to take on the right
hand side of the player.
Showing Annotations
To keep the wireframe clear and readable, annotations are hidden by default. You may click on the Show Annotations button t the bottom left of the
player to have them visible. Let’s show the annotations.
Show annotations
Exit playback
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Wireframe playback
P. 878
This opens the Use Case Details. On the right hand side of the screen, click on the gear button.
4.
This creates a requirement specification in the Doc. Composer. You can export the specification to Word/HTML/PDF by clicking on the Export
button at the top right of the Doc. Composer. You may also edit the content of the report before exporting. To learn more about the use of Doc.
Composer, click here.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 879
1.
Right click on the target use case and select Open Use Case Details... from the pop-up menu.
When the details dialog box pops out, select the Flow of Events tab.
Edit the steps in the flow of events editor. When finish editing, right click on the editor and select Synchronize to Sequence Diagram from the
pop-up menu.
When you have made some changes on flow of events, you can update the changes to sequence diagram accordingly. Right click on the flow of
events editor and select synchronize to the name of sequence diagram from the pop-up menu.
P. 880
1.
Right click on the target use case and select Open Use Case Details... from the pop-up menu.
When the details dialog box pops out, select the Flow of Events tab.
Edit the steps in the flow of events editor. When finish editing, right click on the editor and select Synchronize to Activity Diagram from the
pop-up menu.
P. 881
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.
When you have made some changes on flow of events, you can update the changes to activity diagram accordingly. Right click on the flow of events
editor and select synchronize to the name of activity diagram from the pop-up menu.
P. 882
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
YouTube Video - How to Manage Use Case Scenario with Flow of Events?
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 883
Requirement List
Record and document software requirements in Requirement List
Learn how to manage requirements in Requirement List
Requirement List
P. 884
Requirement List
No
Name
Description
1 New Requirement
2 Font Size
3 Open Specification...
Select a requirement in Requirement List and click this button to open its specification.
4 Show View...
Select a requirement in Requirement List and click this button to list the diagrams that contains the
view of the selected requirement.
5 Visualize
Select a requirement in Requirement List and click this button to show it in a new or existing diagram.
6 Search
7 List of requirements
8 Requirement name
9 Requirement ID
ID of selected requirement. ID are automatically generated when you create requirement. You
may customize the pattern of ID in the Project Options window ( Windows > Project Options >
Diagramming > Model Generation).
10 Source
11 Kind
12 Verify Method
13 Risk
14 Status
15 Use Cases
Use cases can be achieved by implementing requirements. If the selected requirement was created
from a use case, or added as a requirement of a use case, you can see the use cases here.
Description of selected requirement. The tools above the editor enables you to enter description in rich
text format.
P. 885
2.
4.
Related Resources
The following resources may help you learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 886
P. 887
<role> represents the person, system, subsystem or any entity else who will interact with the system to be implemented to achieve a goal. He/
she/it will receive values by interacting with the system. By creating a use case from a use case statement, an actor will be created from <role>.
<business objective> represents the business goal to be achieved throught the interaction with the system. By creating a use case from a use
case statement, a use case will be created from <business objective>.
<business value> represents the value behind the interaction with system.
In the Use Case Statement tab, fill in the role, business objective and business value of the last statement to complete it.
Click on the down arrow next to the green button near the end of the statement.
3.
Insert Statement
2.
Click on the down arrow next to the green button near the end of the statement.
3.
P. 888
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 889
2.
In the Use Case Statement tab, hover your mouse pointer over the desired use case statement.
Click on the Create Use Case button near the end of the statement.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 890
2.
In the Use Case Statement tab, hover your mouse pointer over the desired use case statement.
Click on the down arrow next to the green Create Use Case button, near the end of the statement.
4.
Select User Story > Create User Story from the popup menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 891
User Stories
Writing general user stories
Learn how to write user stories that do not belong to any use case.
User Stories
P. 892
2.
Under the General User Stories section, double click on the block labeled Add a feathre that can be finished in 10 days.
Write a short description of user requirement and press Enter to confirm editing. Note that user story is supposed to be short and unique, so do
not try to write a paragraph here.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 893
Click the Plus button next to the Use Case that you want to add the User Story under.
A story card appears. Enter the User Story. Press Enter to confirm editing.
Repeat step 2 and 3 to create other User Stories according to their Use Cases.
P. 894
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 895
1.
In the User Story tab of UeXceler, click to select the desired user story.
Enter the name of the new tag in the text field, and then select <Create New>.
Create a tag
The tag is created and is added to the user story.
Tag is created
1.
Select Windows > Configuration > Manage User Story Tags... in the toolbar.
2.
In the Manage Tags of User Story window, click Add to create a tag.
3.
Enter the name of the tag and then specify its foreground and background color. The color setting will affect the appearance of tag when show in
UeXceler.
P. 896
Click OK to confirm.
Click Apply.
P. 897
Tag added
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 898
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 899
2.
Click the All button near the top left corner of UeXceler.
Check the Use Case(s) that you are interested in. Select Apply from the drop down menu.
Apply selection
5.
As a result, only the checked Use Cases and their corresponding User Stories are shown.
P. 900
Click on the Filter by Tags button near the top right corner of UeXceler.
2.
Check the Tag(s) that you are interested in. Select Apply from the drop down menu.
Apply Selection
3.
As a result, only those User Stoies with checked Tag(s) are shown.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 901
Click on the down arrow at the top right of the user story.
3.
You can now copy the link by clicking Copy to clipboard or by pressing Ctrl-C. If you want to include the name of user story, check with name.
The URL will work perfectly both with and without name.
2.
Paste the link into the Link field and press Enter to visit it. Note that the link has to be a non-modified string copied with the Show Link feature.
Any modification made to the link may result in a broken link.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 902
Click on Add Sub Diagrams. You can add a new diagram as sub-diagram by selecting New Diagram... from the popup menu. Then, choose
the type of diagram to create in the New Diagram window and click OK to confirm. Alternatively, you can add an existing diagram as a subdiagram by selecting Existing Diagrams... from the popup menu.
In the User Story tab of UeXceler, double click on the desired user story to open it.
2.
Add reference
4.
Related Resources
The following resources may help you learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 903
Wireframe
What is wireframe?
Learn what wireframe is.
Duplicate wireframe
The duplicate function allows you to re-use an existing wireframe ito create a new one. This page describes the steps required to duplicate a
wireframe.
Wireframe
P. 904
What is wireframe?
A wireframe is a sketch of the system to be built. It’s simple, clear and allows everyone to read and understand easily. Wireframe shows "just
enough" information of the screen instead of the full details. The actual screen design will be produced at a later stage by referencing the wireframe.
You can show the scenario to your customer visually to obtain consent about the requirements.
Sample wireframe
Benefits of wireframing
Comparing to prototyping or any kind of detailed screen designs, wireframe features the following advantages:
Easy to draw: Wireframe has a simple and clean layout. It is formed by simple screen elements without any detailed styling and formattings.
Easy to understand: Wireframe is welcomed by both the development team and business people. It is so simple that everyone can understand
without learning.
Easy to modify: You don't need any programming to visualize new design ideas.
No coding required: No heavy prototyping and no coding. You just need to draw the wireframe as if you are using a drawing tool.
In-line annotations: Annotate design ideas in-place with the help of annotation shapes. These annotations can be shown in requirement
specification as well.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Professional Edition
Enterprise Edition
What is Wireframe?
P. 905
2.
This opens the state overview with states placed on a corkboard-like background. Click Create Child State below the Initial state to create a
child state under it.
Name the wireframe state meaningfully to reflect the change of the wireframe at this particular state.
P. 906
Naming state
5.
Press Enter. This opens the wireframe state for editing. You can check the editing state by referring to the diagram title.
Wireframe edited
P. 907
If I add a new button in parent state, the same button will appear in its child state.
Case 2
If I removed a button in parent state but that button has not been modified in its child state, the button will still be removed.
Case 3
If I renamed the caption of a button in parent state but the same button has not been renamed in child state, the caption of the button in child state will
be renamed. Note that if the button in child state was resized, the renaming will still take place.
Case 4
If I renamed the caption of a button in parent state and the same button has been renamed in child state, the caption of the button in child state will
remain unchanged.
Editing a child wireframe state
To edit a child wireframe state:
1.
2.
3.
Double click on the thumbnail of the state that you want to edit.
4.
2.
3.
Double click on the name under the thumbnail of the state that you want to rename.
P. 908
2.
3.
4.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Professional Edition
P. 909
Enterprise Edition
P. 910
NOTE:
You can only change orientation when there is no wireframe element created inside the phone body
Show/Hide keyboard
To show the keyboard, right click on the phone border and select Show Keyboard from the popup menu.
Show keyboard
This shows the keybaord at the bottom of the phone:
P. 911
Keyboard shown
1.
Select the desired wireframe element from the diagram toolbar (e.g. Label).
Click on the wireframe, at the position where you want the wireframe element to be created.
1.
2.
3.
Release the mouse button in the wireframe, at the position where you want the wireframe element to be created.
1.
Right click on the wireframe, at the position where you want the wireframe element to be created.
2.
Select Add Shape > %SHAPE_TYPE% from the popup menu, where %SHAPE_TYPE% is the kind of wireframe element you want to create.
P. 912
1.
Click directly on the wireframe, at the position where you want the wireframe element to be created. You should see a green icon appears,
known as the Smart Create resource.
Press on the Smart Create resource and hold the mouse button.
3.
Release the mouse button. In the popup menu, choose the type of wireframe element to be created.
To create a label, double-click on the wireframe and enter the label caption.
P. 913
Creating a label
To create an annotation, double-click outside the phone border and enter the annotation text.
Right click on the desired wireframe element and select Font... from the popup menu.
Set font
2.
Edit the font properties in the Font window and click OK to confirm.
Right click on the desired wireframe element and select Color... from the popup menu.
Set color
2.
Edit the color properties in the Color window and click OK to confirm. Note that different wireframe elements support different settings. For
example, while text field support editing font color, list view doesn't.
P. 914
Color applied
At the bottom of your selection, press on the Duplicate resource icon and hold the mouse button.
3.
Drag it.
Release the mouse button at the position where you want the wireframe element to be created.
Renamed a label
P. 915
NOTE:
Instead of dragging the Duplicate resource, you may also click on it..
Double click on the background (i.e. the blue region) of the wireframe.
2.
Label annotated
P. 916
You can also use an image component to show an Android icon for a tab bar. To show an Android icon, right click on the image component and select
Android... from the popup menu. In the popup window, choose the icon to show and click OK to confirm.
To specify the content of a label, double click on the label and enter the content. You can press Enter to create a new line or press Ctrl-Enter to
confirm editing. You may need to resize the label afterwards in order to see the content entered.
The label component is in fact a placeholder of label. You can show multiple labels in it by increasing the height of the label component.
P. 917
NOTE:
When a label has specified content, you cannot show multiple labels in it.
When the content is filled, the size of label(s) or text in label can be changed. To adjust the font, click on the label component. Then, click on the Font
Size button. After that, drag the slider or press + or - to adjust the font size.
When a label component has text content filled, you can set its color by clicking on the label component first. Then, click on the Font Color button.
After that, drag the slider or directly click on a suggested color to apply it.
To specify the content of text field, double click on the text field and enter the content. You may need to resize the text field afterwards in order to see
the content entered.
Search field is a kind of text field that allows user to specify a search string and trigger searching. To show a text field as a search field, right click on
the text field component and select Type > Search or Type > Search with Icon from the popup menu.
A search field
To edit the caption of button, double click on the button and enter the caption. You may need to resize the button afterwards in order to see the caption
entered.
To edit the caption of button, double click on the button and enter the caption. You may need to resize the button afterwards in order to see the caption
entered.
P. 918
To alter the state of a switch, select the switch first. Then, click the line at the bottom of the button to change its state.
To edit the caption of a switch, double click on the text in the switch and enter the caption. You may need to resize the switch afterwards in order to see
the caption entered.
To alter the state of a switch, select the switch first. Then, click on the inactive end of the switch to switch to that end.
The checkbox component is in fact a placeholder of checkboxes. You can show multiple checkboxes in it by increasing the height of the checkbox
component.
To specify the value of a checkbox, double click on the label attached with the checkbox and enter the value. You may need to resize the checkbox
afterwards in order to see the content entered.
To check a checkbox, simply click on the checkbox. You can uncheck it by clicking again.
P. 919
Checking checkboxes
The radio button component is in fact a radio button group. You can show multiple radio buttons in it by increasing the height of the radio button
component.
To specify the value of a radio button, double click on the label attached with the radio button and enter the value. You may need to resize the radio
button afterwards in order to see the content entered.
To select a radio button, simply click on the radio button. You can uncheck it by clicking again.
By default, a spinner has no items specified. You can add a list of items into a spinner by clicking on the down arrow on the right of the spinner and
then click on <Add Item> and start entering the item.
P. 920
To change the selected item of a spinner, click on the down arrow on the right of the spinner, then check the item to select it.
To remove an item from a spinner, click on the down arrow on the right of the spinner, then select the item to be removed and click on the cross button
on the right to remove it.
To adjust progress, select the progress bar first. Then drag the handler in the middle towards left or right to control the progress.
To adjust silder position, select the seek bar first. then drag the handler in the middle towards left or right to control the position.
P. 921
To add more stars to a ranking bar, select the ranking bar first. Then, extend the ranking bar to let more stars appear.
To adjust the number of filled stars, select the ranking bar first. Then, fill the stars by clicking on a star in the ranking bar.
Panel is a useful wireframe component that helps you to visualize the different areas of a screen design. You can put other wireframe components in a
panel and move the panel around to reposition the wireframe components at the same time.
To create a panel and make it contains existing components:
1.
2.
3.
Drag to form the size of the panel to be created. Wireframe components contained entirely in the drag range will be contained by the panel.
Creating a panel
4.
Panel created
To adjust the fill color of a panel, click on the panel first. Then, click on the Fill Color button. After that, drag the slider or directly click on a suggested
color to apply it.
To hide the border of panel, click on the panel first. Then, click on the Hide Border button. You can click again to show the border again.
P. 922
To make the corner of a panel rounded, click on the panel first. Then, drag on the handler on the top-left corner to adjust the size of the rounded
corner. The four corners will be updated accordingly.
To adjust the height of a row, drag directly on the row separator under the row. By doing so, the row will be expanded or contracted.
To adjust the height of all rows in a list view, drag on the handler attached to the row separator between the first and the second row to resize all rows
at the same time.
P. 923
To add more columns to a table, select the table first. Then, drag on the handler attached to the column separator between the first and the second
column to create more columns.
When you put a wireframe component (e.g. a label component) into a table component, a new row will be created automatically.
To edit the caption of a tab, double click on the tab and enter the title.
To add more tabs to a tab host, select the tab host first. Then, drag on the handler attached to the separator between tabs to create more segments.
P. 924
To change the active tab, select the tab host first. Then, click on the tab directly in the tab host.
To edit the content of labels and buttons in a dialog, double click on the label or button and enter the content. You may need to resize the label or the
dialog afterwards in order to see the content entered.
To adjust the height of a row, drag directly on the row separator under the row. By doing so, the row will be expanded or contracted.
To adjust the height of all rows in a menu, drag on the handler attached to the row separator between the first and the second row to resize all rows at
the same time.
To edit the message of a toasts, double click on the toasts and enter the message.
To adjust the fill color of a rectangle, click on the rectangle first. Then, click on the Fill Color button. After that, drag the slider or directly click on a
suggested color to apply it.
P. 925
To adjust the thickness of the border of a rectangle, click on the rectangle first. Then, click on the Line Width button. After that, drag the slider or press
+ or - to adjust the thickness.
To make the corner of a rectangle rounded, click on the rectangle first. Then, drag on the handler on top-left to adjust the size of the rounded corner.
The four corners will be updated accordingly.
To adjust the fill color of an oval, click on the oval first. Then, click on the Fill Color button. After that, drag the slider or directly click on a suggested
color to apply it.
To adjust the thickness of the border of an oval, click on the oval first. Then, click on the Line Width button. After that, drag the slider or press + or - to
adjust the thickness.
P. 926
To add a side, select the polygon first. Then, drag on the white handler attached to the border of the polygon to split a border into two.
Adding a side
Then adjust the position of the new point.
Polygon edited
Adjusting fill color
To adjust the fill color of a polygon, click on the polygon first. Then, click on the Fill Color button. After that, drag the slider or directly click on a
suggested color to apply it.
To adjust the thickness of the border of a polygon, click on the polygon first. Then, click on the Line Width button. After that, drag the slider or press +
or - to adjust the thickness.
To add a point, select the line first. Then, drag on the white handler on the line to create a new point.
Adding a point
Then adjust the position of the point.
P. 927
Line edited
Adjusting line color
To adjust the line color of a line, click on the line first. Then, click on the Line Color button. After that, drag the slider or directly click on a suggested
color to apply it.
To adjust the width of the border of an oval, click on the line first. Then, click on the Line Width button. After that, drag the slider or press + or - to
adjust the width.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Trademark Disclaimer
Android is a trademark of Google Inc.
Supported Editions
Professional Edition
Enterprise Edition
P. 928
NOTE:
You can only change orientation when there is no wireframe element created inside the tablet
Show/Hide keyboard
To show the keyboard, right click on the tablet border and select Show Keyboard from the popup menu.
Show keyboard
This shows the keybaord at the bottom of the phone:
Keyboard shown
1.
Select the desired wireframe element from the diagram toolbar (e.g. Label).
P. 929
Click on the wireframe, at the position where you want the wireframe element to be created.
1.
2.
3.
Release the mouse button in the wireframe, at the position where you want the wireframe element to be created.
1.
Right click on the wireframe, at the position where you want the wireframe element to be created.
2.
Select Add Shape > %SHAPE_TYPE% from the popup menu, where %SHAPE_TYPE% is the kind of wireframe element you want to create.
1.
Click directly on the wireframe, at the position where you want the wireframe element to be created. You should see a green icon appear, known
as the Smart Create resource.
Press on the Smart Create resource and hold the mouse button.
P. 930
3.
Release the mouse button. In the popup menu, choose the type of wireframe element to be created.
To create a label, double-click on the wireframe and enter the label caption.
Creating a label
To create an annotation, double-click outside the tablet and enter the annotation text.
Right click on the desired wireframe element and select Font... from the popup menu.
P. 931
Set font
2.
Edit the font properties in the Font window and click OK to confirm.
Right click on the desired wireframe element and select Color... from the popup menu.
Set color
2.
Edit the color properties in the Color window and click OK to confirm. Note that different wireframe elements support different settings. For
example, while text field support editing font color, list view doesn't.
Color applied
At the bottom of your selection, press on the Duplicate resource icon and hold the mouse button.
3.
Drag it.
P. 932
Release the mouse button at the position where you want the wireframe element to be created.
Renamed a label
NOTE:
Instead of dragging the Duplicate resource, you may also click on it..
Double click on the background (i.e. the blue region) of the wireframe.
2.
P. 933
Label annotated
You can also use an image component to show an Android icon for a tab bar. To show an Android icon, right click on the image component and select
Android... from the popup menu. In the popup window, choose the icon to show and click OK to confirm.
P. 934
To specify the content of a label, double click on the label and enter the content. You can press Enter to create a new line, or press Ctrl-Enter to
confirm editing. You may need to resize the label afterwards in order to see the content entered.
The label component is in fact a placeholder of label. You can show multiple labels in it by increasing the height of the label component.
NOTE:
When a label has content specified, you cannot show multiple labels in it.
When the content is filled, the size of label(s) or text in label can be changed. To adjust font, click on the label component. Then, click on the Font Size
button. After that, drag the slider or press + or - to adjust the font size.
When a label component has text content filled, you can set its color by clicking on the label component first. Then, click on the Font Color button.
After that, drag the slider or directly click on a suggested color to apply it.
P. 935
To specify the content of text field, double click on the text field and enter the content. You may need to resize the text field afterwards in order to see
the content entered.
Search field is a kind of text field that allows user to specify a search string and trigger searching. To show a text field as a search field, right click on
the text field component and select Type > Search or Type > Search with Icon from the popup menu.
A search field
To edit the caption of button, double click on the button and enter the caption. You may need to resize the button afterwards in order to see the caption
entered.
To edit the caption of button, double click on the button and enter the caption. You may need to resize the button afterwards in order to see the caption
entered.
To alter the state of a switch, select the switch first. Then, click the line at the bottom of the button to change its state.
To edit the caption of a switch, double click on the text in the switch and enter the caption. You may need to resize the switch afterwards in order to see
the caption entered.
To alter the state of a switch, select the switch first. Then, click on the inactive end of the switch to switch to that end.
The checkbox component is in fact a placeholder of checkboxes. You can show multiple checkboxes in it by increasing the height of the checkbox
component.
P. 936
To specify the value of a checkbox, double click on the label attached with the checkbox and enter the value. You may need to resize the checkbox
afterwards in order to see the content entered.
To check a checkbox, simply click on the checkbox. You can uncheck it by clicking again.
Checking checkboxes
The radio button component is in fact a radio button group. You can show multiple radio buttons in it by increasing the height of the radio button
component.
P. 937
To specify the value of a radio button, double click on the label attached with the radio button and enter the value. You may need to resize the radio
button afterwards in order to see the content entered.
To select a radio button, simply click on the radio button. You can uncheck it by clicking again.
By default, a spinner has no items specified. You can add a list of items into a spinner by clicking on the down arrow on the right of the spinner and
then click on <Add Item> and start entering the item.
To change the selected item of a spinner, click on the down arrow on the right of the spinner, then check the item to select it.
P. 938
To remove an item from a spinner, click on the down arrow on the right of the spinner, then select the item to remove and click on the cross button on
the right to remove it.
To adjust progress, select the progress bar first. Then drag the handler in the middle towards left or right to control the progress.
To adjust silder position, select the seek bar first. Then drag the handler in the middle towards left or right to control the position.
To add more stars tp a ranking bar, select the ranking bar first. Then, extend the ranking bar to let more stars appear.
To adjust the number of filled stars, select the ranking bar first. Then, fill the stars by clicking on a star in the ranking bar.
Panel is a useful wireframe component that helps you visualize the different areas of a screen design. You can put other wireframe components in a
panel and move the panel around to reposition the wireframe components at the same time.
To create a panel and make it contains existing components:
1.
2.
3.
Drag to form the size of the panel to be created. Wireframe components contained entirely in the drag range will be contained by the panel.
P. 939
Creating a panel
4.
Panel created
To adjust the fill color of a panel, click on the panel first. Then, click on the Fill Color button. After that, drag the slider or directly click on a suggested
color to apply it.
To hide the border of panel, click on the panel first. Then, click on the Hide Border button. You can click again to show the border again.
To make the corner of a panel rounded, click on the panel first. Then, drag on the handler on the top-left corner to adjust the size of the rounded
corner. The four corners will be updated accordingly.
To adjust the height of a row, drag directly on the row separator under the row. By doing so, the row will be expanded or contracted.
P. 940
To adjust the height of all rows in a list view, drag on the handler attached to the row separator between the first and the second row to resize all rows
at the same time.
To add more columns to a table, select the table first. Then, drag on the handler attached to the column separator between the first and the second
column to create more columns.
When you put a wireframe component (e.g. a label component) into a table component, a new row will be created automatically.
P. 941
To edit the caption of a tab, double click on the tab and enter the title.
To add more tabs to a tab host, select the tab host first. Then, drag on the handler attached to the separator between tabs to create more segments.
To change the active tab, select the tab host first. Then, click on the tab directly in the tab host.
To edit the content of labels and buttons in a dialog, double click on the label or button and enter the content. You may need to resize the label or the
dialog afterwards in order to see the content entered.
P. 942
To adjust the height of a row, drag directly on the row separator under the row. By doing so the row will be expanded or contracted.
To adjust the height of all rows in a menu, drag on the handler attached to the row separator between the first and the second row to resize all rows at
the same time.
To edit the message of a toasts, double click on the toasts and enter the message.
To adjust the fill color of a rectangle, click on the rectangle first. Then, click on the Fill Color button. After that, drag the slider or directly click on a
suggested color to apply it.
To adjust the thickness of the border of a rectangle, click on the rectangle first. Then, click on the Line Width button. After that, drag the slider or press
+ or - to adjust the thickness.
P. 943
To make the corner of a rectangle rounded, click on the rectangle first. Then, drag on the handler at top left to adjust the size of the rounded corner.
The four corners will be updated accordingly.
To adjust the fill color of an oval, click on the oval first. Then, click on the Fill Color button. After that, drag the slider or directly click on a suggested
color to apply it.
To adjust the thickness of the border of an oval, click on the oval first. Then, click on the Line Width button. After that, drag the slider or press + or - to
adjust the thickness.
To add a side, select the polygon first. Then, drag on the white handler attached to the border of the polygon to split a border into two.
Adding a side
Then adjust the position of the new point.
Polygon edited
Adjusting fill color
To adjust the fill color of a polygon, click on the polygon first. Then, click on the Fill Color button. After that, drag the slider or directly click on a
suggested color to apply it.
P. 944
To adjust the thickness of the border of a polygon, click on the polygon first. Then, click on the Line Width button. After that, drag the slider or press +
or - to adjust the thickness.
To add a point, select the line first. Then, drag on the white handler on the line to create a new point.
Adding a point
Then adjust the position of the point.
Line edited
Adjusting line color
To adjust the line color of a line, click on the line first. Then, click on the Line Color button. After that, drag the slider or directly click on a suggested
color to apply it.
To adjust the width of the border of an oval, click on the line first. Then, click on the Line Width button. After that, drag the slider or press + or - to
adjust the width.
P. 945
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Trademark Disclaimer
Android is a trademark of Google Inc.
Supported Editions
Professional Edition
Enterprise Edition
P. 946
This shows the resize handlers at the corners and edges of the frame. You can drag on them to resize the frame.
Resizing frame
Alternatively, you can right click on the frame's title bar and select Browser Size > %PREFERRED_SIZE% from the popup menu.
1.
Select the desired wireframe element from the diagram toolbar (e.g. Label).
Click on the wireframe, at the position where you want the wireframe element to be created.
1.
2.
3.
Release the mouse button in the wireframe, at the position where you want the wireframe element to be created.
P. 947
1.
Right click on the wireframe, at the position where you want the wireframe element to be created.
2.
Select Add Shape > %SHAPE_TYPE% from the popup menu, where %SHAPE_TYPE% is the kind of wireframe element you want to create.
1.
Click directly on the wireframe, at the position where you want the wireframe element to be created. You should see a green icon appear, known
as the Smart Create resource.
Press on the Smart Create resource and hold the mouse button.
3.
Release the mouse button. In the popup menu, choose the type of wireframe element to be created.
To create a label, double-click on the wireframe and enter the label caption.
P. 948
Creating a label
To create an annotation, double-click outside the frame and enter the annotation text.
Right click on the desired wireframe element and select Font... from the popup menu.
Set font
2.
Edit the font properties in the Font window and click OK to confirm.
Right click on the desired wireframe element and select Color... from the popup menu.
Set color
2.
Edit the color properties in the Color window and click OK to confirm. Note that different wireframe elements support different settings. For
example, while text field support editing font color, list view doesn't.
P. 949
Color applied
At the bottom of your selection, press on the Duplicate resource icon and hold the mouse button.
3.
Drag it.
Release the mouse button at the position where you want the wireframe element to be created.
Renamed a label
NOTE:
Instead of dragging the Duplicate resource, you may also click on it..
P. 950
Double click on the background (i.e. the blue region) of the wireframe.
2.
Label annotated
P. 951
To specify the content of label, double click on the label and enter the content. You can press Enter to create a new line or press Ctrl-Enter to confirm
editing. You may need to resize the label afterwards in order to see the content entered.
The label component is in fact a placeholder of label. You can show multiple labels in it by increasing the height of the label component.
NOTE:
When a label has specified, you cannot show multiple labels in it.
The size of label(s) or text in label, when content is filled, can be changed. To adjust font, click on the label component. Then, click on the Font Size
button. After that, drag the slider or press + or - to adjust the font size.
When a label component has text content filled, you can set its color by clicking on the label component first. Then, click on the Font Color button.
After that, drag the slider or directly click on a suggested color to apply it.
P. 952
To specify the content of text field, double click on the text field and enter the content. You may need to resize the text field afterwards in order to see
the content entered.
Search field is a kind of text field that allows user to specify a search string and trigger searching. To show a text field as a search field, right click on
the text field component and select Search Field from the popup menu.
A search field
Editing the placeholder text
Placeholder text is the text that appears in the background of a text field. Very often, placeholder text is used to provide hints for user. For example, a
text field of user name may have <please enter your name here> as placeholder text. Note that the placeholder text is only active when no content has
been specified for the text box. To edit placeholder text of a text field, right click on the text field component and select Edit Placeholder... from the
popup menu. Then, enter the placeholder text in the popup dialog box.
There are two kinds of button - general button and file chooser button. General button is what you commonly see in any user interface. You click on a
general button to do something as description by the button caption. File chooser button is a special kind of button that allows users to provide a file by
clicking on the button. A file chooser button is followed by the text "No file chosen".
When you create a button, it is a general button by default. To change make it a file chooser button, right click on the button and select File Chooser
Button from the popup menu.
To edit the caption of button, double click on the button and enter the caption. You may need to resize the button afterwards in order to see the caption
entered. Note that the caption of a file chooser button is not editable.
The checkbox component is in fact a placeholder of checkboxes. You can show multiple checkboxes in it by increasing the height of the checkbox
component.
P. 953
To specify the value of a checkbox, double click on the label attached with the checkbox and enter the value. You may need to resize the checkbox
afterwards in order to see the content entered.
To check a checkbox, simply click on the checkbox. You can uncheck it by clicking again.
Checking checkboxes
The radio button component is in fact a radio button group. You can show multiple radio buttons in it by increasing the height of the radio button
component.
P. 954
To specify the value of a radio button, double click on the label attached with the radio button and enter the value. You may need to resize the radio
button afterwards in order to see the content entered.
To select a radio button, simply click on the radio button. You can uncheck it by clicking again.
By default, a spinner has no items specified. You can add a list of items into a spinner by clicking on the down arrow on the right of the spinner and
then click on <Add Item> and start entering the item.
To change the selected item of a combo box, click on the down arrow on the right of the combo box, then check the item to select it.
P. 955
To remove an item from a combo box, click on the down arrow on the right of the combo box, then select the item to remove and click on the cross
button on the right to remove it.
To edit the value of a spinner, double click on the spinner and enter the value. You may need to resize the spinner afterwards in order to see the value
entered.
To adjust progress, select the progress bar first. Then drag the handler in the middle towards left or right to control the progress.
To adjust silder position, select the silder first. Then drag the handler in the middle towards left or right to control the position.
Panel is a useful wireframe component that helps you visualize the different areas of a screen design. You can put other wireframe components in a
panel and move the panel around to reposition the wireframe components at the same time.
To create a panel and make it contains existing components:
1.
2.
3.
Drag to form the size of the panel to be created. Wireframe components contained entirely in the drag range will be contained by the panel.
Creating a panel
P. 956
4.
Panel created
To adjust the fill color of a panel, click on the panel first. Then, click on the Fill Color button. After that, drag the slider or directly click on a suggested
color to apply it.
To hide the border of panel, click on the panel first. Then, click on the Hide Border button. You can click again to show the border again.
To make the corner of a panel rounded, click on the panel first. Then, drag on the handler at top left to adjust the size of the rounded corner. The four
corners will be updated accordingly.
A panel can be presented as a titled pane or tabbed pane. To do this, right click on the panel and select Type > Titled Pane or Type > Tabbed Pane
from the popup menu.
When presented as titled pane or tabbed pane, you can edit the caption of the pane or tabs by double clicking on captions.
Wireframing tips - Split Bar
Changing the orientation
To change the orientation of a split bar, right click on it and select either Horizontal or Vertical from the popup menu.
P. 957
To edit table header, double click on the table header and enter the content. You may need to resize the header in order to see the text entered.
To change the orientation of a scroll bar, right click on it and select either Horizontal or Vertical from the popup menu.
To change the length of the thumb, select the scrollbar first. Then, drag on the handler attached to the ends of the thumb to resize it.
P. 958
To adjust the position of thumb, select the scrollbar first. Then, drag on the thumb along the track to reposition it.
To adjust the height of a row, drag directly on the row separator under the row. By doing so, the row will be expanded or contracted.
To adjust the height of all rows in a list view, drag on the handler attached to the row separator between the first and the second row to resize all rows
at the same time.
To edit table header, double click on the table header and enter the content.
P. 959
To adjust column width, drag directly on the column separator nearby. By doing so, the adjacent columns will be updated in their width.
To add more columns to a table, select the table first. Then, drag on the handler attached to the column separator between the first and the second
column to create more columns.
When you put a wireframe component (e.g. a label component) into a table component, a new row will be created automatically.
P. 960
To hide away the table header, right click on the header and uncheck Show Header from the popup menu.
To edit the name of a tree node, double click on the tree node and enter the name.
To add a tree node next to an existing one, select the tree first. Then, move the mouse pointer over the existing tree node where the new node will be
created next to it. Click on the + button on the right of the tree node.
To add a tree node under an existing one as child node, select the tree first. Then, move the mouse pointer over the existing tree node where the new
node will be created under it. Click on the empty box on the right of the tree node. The box will then become a solid box with + in it. Click again, a child
node will be created under it.
P. 961
To adjust the level of indentation of a tree node, select the tree first. Then, move the mouse pointer over the existing tree node where you want to
adjust its level of indentation. Click on the < or > on the left of the tree node to make the node one level backward or forward.
You can optionally specify an image icon for all of your tree nodes. To specify an icon, de-select the tree first. Then, right click on the tree component
and select Icon > Select Image... from the popup menu. If you want to have no icons for all tree nodes, select No Icon. If you want an icon but do not
want to specify its content, choose Dummy Icon. Make sure you are not clicking on a specific tree node or else only that node will be updated.
You can optionally specify an image icon for a specific tree node. To specify an icon, select the tree first. Then, right click on the tree node to specify
icon and select Icon > Select Image... from the popup menu. If you want a node without icon, select No Icon. If you want an icon but do not want to
specify its content, choose Dummy Icon.
There are three selection modes for a menu item - Not Selectable, Chekcbox and Radio Button. To adjust the selection mode of all tree nodes, deselect the tree first. Then, right click on the tree component and select Selection Mode > [MODE] from the popup menu. Make sure you are not
clicking on a specific tree node or else only that node will be updated.
P. 962
There are three selection modes for a menu item - Not Selectable, Chekcbox and Radio Button. To adjust the selection mode of a tree node, select the
tree first. Then, right click on the tree node and select Selection Mode > [MODE] from the popup menu.
To expand or collapse a tree node, click on the + or - button on the left of a tree node.
To edit title of dialog, double click at the top of the dialog enter the content.
P. 963
By default, a toolbar is just an empty horizontal bar. To represent the buttons in toolbar, you can either create buttons in it or represent with an image
component, like this:
2.
Drag on the selection background to the suitable place to indicate the active selection of button.
Adding separator
To add a separator, click on the toolbar first. Then, click on the resource Add Separator. You can then drag the separator to reposition it.
To edit the name of a menu in menu bar, double click on the menu and enter the name.
P. 964
To add more menus to a menu bar, select the menu bar first. Then, click on click to add... and enter the name of the new menu.
To rearrange menus, select the menu bar first. Then, drag on a menu and move it along the menu bar to reposition it.
To represent that a menu has been selected, specify the selected menu by selecting the menu bar first. Then, click directly on the menu to make it
appear selected.
To edit the name of a menu item in menu, double click on the menu item and enter the name.
You can add more menu items to a menu by increasing the height of the menu component.
The size of label(s) or menu items, when name is specified, can be changed. To adjust font, drag the slider between the first and the second menu item
to adjust the font size.
P. 965
You can optionally specify an image icon for all of your menu items. To specify an icon, de-select the menu first. Then, right click on the menu
component and select Icon > Select Image... from the popup menu. If you want all menu items to have no icon, select No Icon. If you want an icon but
do not want to specify its content, choose Dummy Icon. Make sure you are not clicking on a specific menu item or else only that node will be updated.
You can optionally specify an image icon for a specific menu item. To specify an icon, select the menu first. Then, right click on the menu item to
specify icon and select Icon > Select Image... from the popup menu. If you want a menu item without icon, select No Icon. If you want an icon but do
not want to specify its content, choose Dummy Icon.
There are three selection modes for a menu item - Not Selectable, Chekcbox and Radio Button. To adjust the selection mode of all menu items, deselect the menu first. Then, right click on the menu component and select Selection Mode > [MODE] from the popup menu. Make sure you are not
clicking on a specific menu item or else only that node will be updated.
P. 966
There are three selection modes for a menu item - Not Selectable, Chekcbox and Radio Button. To adjust the selection mode of a menu item, select
the menu first. Then, right click on the menu item and select Selection Mode > [MODE] from the popup menu.
To represent that a menu item has been selected, specify the selected menu item by selecting the menu first. Then, click directly on the menu item to
make it appear selected.
To add a separator, select the menu first. You will see a number of short horizontal line on the right of the menu. You can then click on them to show
the separators.
P. 967
2.
Click on the triangle button on the right of the menu item where the sub-menu pops out.
To edit the title of a segment, double click on the segment and enter the title.
To add more segments to a segmented control, select the segmented control first. Then, drag on the handler attached to the segment separator
between segments to create more segments.
To change the selected segment, select the segmented control first. Then, click on the segment directly in the segmented control.
To adjust the fill color of a rectangle, click on the rectangle first. Then, click on the Fill Color button. After that, drag the slider or directly click on a
suggested color to apply it.
P. 968
To adjust the thickness of the border of a rectangle, click on the rectangle first. Then, click on the Line Width button. After that, drag the slider or press
+ or - to adjust the thickness.
To make the corner of a rectangle rounded, click on the rectangle first. Then, drag on the handler at top left to adjust the size of the rounded corner.
The four corners will be updated accordingly.
To adjust the fill color of an oval, click on the oval first. Then, click on the Fill Color button. After that, drag the slider or directly click on a suggested
color to apply it.
To adjust the thickness of the border of an oval, click on the oval first. Then, click on the Line Width button. After that, drag the slider or press + or - to
adjust the thickness.
P. 969
To add a side, select the polygon first. Then, drag on the white handler attached to the border of the polygon to split a border into two.
Adding a side
Then adjust the position of the new point.
Polygon edited
Adjusting fill color
To adjust the fill color of a polygon, click on the polygon first. Then, click on the Fill Color button. After that, drag the slider or directly click on a
suggested color to apply it.
To adjust the thickness of the border of a polygon, click on the polygon first. Then, click on the Line Width button. After that, drag the slider or press +
or - to adjust the thickness.
To add a point, select the line first. Then, drag on the white handler on the line to create a new point.
Adding a point
Then adjust the position of the point.
P. 970
Line edited
Adjusting line color
To adjust the line color of a line, click on the line first. Then, click on the Line Color button. After that, drag the slider or directly click on a suggested
color to apply it.
To adjust the width of the border of an oval, click on the line first. Then, click on the Line Width button. After that, drag the slider or press + or - to
adjust the width.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Professional Edition
Enterprise Edition
P. 971
NOTE:
You can only change orientation when there is no wireframe element created inside iPad
Show/Hide keyboard
To show the keyboard, right click on the iPad border and select Show Keyboard from the popup menu.
Show keyboard
This shows the keybaord at the bottom of iPad:
P. 972
Keyboard shown
1.
Select the desired wireframe element from the diagram toolbar (e.g. Label).
Click on the wireframe, at the position where you want the wireframe element to be created.
1.
2.
3.
Release the mouse button in the wireframe, at the position where you want the wireframe element to be created.
1.
Right click on the wireframe, at the position where you want the wireframe element to be created.
2.
Select Add Shape > %SHAPE_TYPE% from the popup menu, where %SHAPE_TYPE% is the kind of wireframe element you want to create.
P. 973
1.
Click directly on the wireframe, at the position where you want the wireframe element to be created. You should see a green icon appear, known
as the Smart Create resource.
Press on the Smart Create resource and hold the mouse button.
3.
Release the mouse button. In the popup menu, choose the type of wireframe element to create.
To create a label, double-click on the wireframe and enter the label caption.
P. 974
Creating a label
To create an annotation, double-click outside the iPad and enter the annotation text.
Right click on the desired wireframe element and select Font... from the popup menu.
Set font
2.
Edit the font properties in the Font window and click OK to confirm.
Right click on the desired wireframe element and select Color... from the popup menu.
Set color
2.
Edit the color properties in the Color window and click OK to confirm. Note that different wireframe elements support different settings. For
example, while text field support editing font color, collection view doesn't.
P. 975
Color applied
At the bottom of your selection, press on the Duplicate resource icon and hold the mouse button.
3.
Drag it.
Release the mouse button at the position where you want the wireframe element to be created.
Renamed a label
NOTE:
Instead of dragging the Duplicate resource, you may click on it, too..
P. 976
Double click on the background (i.e. the blue region) of the wireframe.
2.
Label annotated
P. 977
You can also use an image component to show an IOS icon for a tab bar. To show an IOS icon, right click on the image component and select IOS...
from the popup menu. In the popup window, choose the icon to show and click OK to confirm.
To specify the content of label, double click on the label and enter the content. You can press Enter to create a new line, or press Ctrl-Enter to confirm
editing. You may need to resize the label afterwards in order to see the content entered.
The label component is in fact a placeholder of label. You can show multiple labels in it by increasing the height of the label component.
NOTE:
When a label has content specified, you cannot show multiple labels in it.
P. 978
When the content is filled, the size of label(s) or text in label can be changed. To adjust the font, click on the label component. Then, click on the Font
Size button. After that, drag the slider or press + or - to adjust the font size.
When a label component has text content filled, you can set its color by clicking on the label component first. Then, click on the Font Color button.
After that, drag the slider or directly click on a suggested color to apply it.
To specify the content of text field, double click on the text field and enter the content. You may need to resize the text field afterwards in order to see
the content entered.
Search field is a kind of text field that allows user to specify a search string and trigger searching. To show a text field as a search field, right click on
the text field component and select Search Field from the popup menu.
A search field
Editing the placeholder text
Placeholder text is the text that appears in the background of a text field. Very often, placeholder text is used to provide hints for user. For example, a
text field of user name may have <please enter your name here> as placeholder text. Note that the placeholder text is only active when no content has
been specified for the text box. To edit placeholder text of a text field, right click on the text field component and select Edit Placeholder... from the
popup menu. Then, enter the placeholder text in the popup dialog box.
To edit the caption of button, double click on the button and enter the caption. You may need to resize the button afterwards in order to see the caption
entered.
To alter the state of a switch, select the switch first. Then, click on the inactive end of the switch to switch to that end.
P. 979
To adjust progress, select the progress view first. Then drag the handler in the middle towards left or right to control the progress.
To adjust silder position, select the silder first. Then drag the handler in the middle towards left or right to control the position.
Panel is a useful wireframe component that helps you to visualize the different areas of a screen design. You can put other wireframe components in a
panel and move the panel around to reposition the wireframe components at the same time.
To create a panel and make it contains existing components:
1.
2.
3.
Drag to form the size of the panel to be created. Wireframe components contained entirely in the drag range will be contained by the panel.
Creating a panel
4.
Panel created
To adjust the fill color of a panel, click on the panel first. Then, click on the Fill Color button. After that, drag the slider or directly click on a suggested
color to apply it.
To hide the border of panel, click on the panel first. Then, click on the Hide Border button. You can click again to show the border again.
P. 980
To make the corner of a panel rounded, click on the panel first. Then, drag on the handler at top left to adjust the size of the rounded corner. The four
corners will be updated accordingly.
To edit the table header, double click on the table header and enter the content.
To adjust the row height, drag on the handler between the first and the second row.
To edit table header/footer, double click on the table header/footer and enter the content.
P. 981
By default, table header and footer are visible in a grouped table view. To hide header/footer, right click on the grouped table view and de-select Show
Header/Footer from the popup menu.
To adjust row height, drag on the handler between the first and the second row.
To adjust the size of cells, drag on the handler between the first and the second row.
To edit the lable in a picker view, double click on the label and enter the content.
P. 982
There are four kinds of date picker - Date-and-Time, Date, Time, Count Down Timer. To change the picker type, right click on the date picker and
select Picker Type > [TYPE] from the popup menu.
To edit the values in a date picker, like to edit the date in a Date-and-Time picker, double click on the field to edit and enter the new value.
Changing PM to AM
P. 983
To specify the content of the search field, double click on the text field and enter the content. You may need to resize the search bar afterwards in order
to see the content entered.
If you have specified the content of search field, the Cancel button will appear. To rename the Cancel button, double click on it and enter the new
caption.
When a label component has text content filled, you can set its color by clicking on the label component first. Then, click on the Font Color button.
After that, drag the slider or directly click on a suggested color to apply it.
To edit the title of a segment, double click on the segment and enter the title.
To add more segments to a segmented control, select the segmented control first. Then, drag on the handler attached to the segment separator
between segments to create more segments.
To change the selected segment, select the segmented control first. Then, click on the segment directly in a segmented control.
To add more page indicators to a page control, select the page control first. Then, extend the page control to let more indicators appear.
To set the active page indicator, select the page control first. Then, click on the page indicator directly in the page control.
P. 984
To edit action description or action, double click on the corresponding label and enter the content.
By default, the action description field is visible in an action sheet. To hide an action description, right click on the action sheet and de-select Show
Description from the popup menu.
To adjust the position of pointer, select the action sheet first. Then, drag on the pointer to adjust its position. You can drag to all the four sides of the
action sheet.
P. 985
To adjust the position of pointer, select the popover first. Then, drag on the pointer to adjust its position. You can drag to all the four sides of the
popover.
To edit the content of labels and buttons in an alert view, double click on the label or button and enter the content. You may need to resize the label or
the alert view afterwards in order to see the content entered.
To adjust the fill color of a rectangle, click on the rectangle first. Then, click on the Fill Color button. After that, drag the slider or directly click on a
suggested color to apply it.
To adjust the thickness of the border of a rectangle, click on the rectangle first. Then, click on the Line Width button. After that, drag the slider or press
+ or - to adjust the thickness.
To make the corner of a rectangle rounded, click on the rectangle first. Then, drag on the handler on top-left to adjust the size of the rounded corner.
The four corners will be updated accordingly.
P. 986
To adjust the fill color of an oval, click on the oval first. Then, click on the Fill Color button. After that, drag the slider or directly click on a suggested
color to apply it.
To adjust the thickness of the border of an oval, click on the oval first. Then, click on the Line Width button. After that, drag the slider or press + or - to
adjust the thickness.
To add a side, select the polygon first. Then, drag on the white handler attached to the border of the polygon to split a border into two.
Adding a side
Then adjust the position of the new point.
Polygon edited
Adjusting fill color
To adjust the fill color of a polygon, click on the polygon first. Then, click on the Fill Color button. After that, drag the slider or directly click on a
suggested color to apply it.
P. 987
To adjust the thickness of the border of a polygon, click on the polygon first. Then, click on the Line Width button. After that, drag the slider or press +
or - to adjust the thickness.
To add a point, select the line first. Then, drag on the white handler on the line to create a new point.
Adding a point
Then adjust the position of the point.
Line edited
Adjusting line color
To adjust the line color of a line, click on the line first. Then, click on the Line Color button. After that, drag the slider or directly click on a suggested
color to apply it.
To adjust the width of the border of an oval, click on the line first. Then, click on the Line Width button. After that, drag the slider or press + or - to
adjust the width.
P. 988
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Trademark Disclaimer
iPad is a trademark of Apple Inc.
Supported Editions
Professional Edition
Enterprise Edition
P. 989
NOTE:
You can only change orientation when there is no wireframe element created inside the phone body
Show/Hide keyboard
To show the keyboard, right click on the phone border and select Show Keyboard from the popup menu.
P. 990
Show keyboard
This shows the keybaord at the bottom of the phone:
Keyboard shown
1.
Select the desired wireframe element from the diagram toolbar (e.g. Label).
Click on the wireframe, at the position where you want the wireframe element to be created.
1.
2.
3.
P. 991
Release the mouse button in the wireframe, at the position where you want the wireframe element to be created.
1.
Right click on the wireframe, at the position where you want the wireframe element to be created.
2.
Select Add Shape > %SHAPE_TYPE% from the popup menu, where %SHAPE_TYPE% is the kind of wireframe element you want to create.
1.
Click directly on the wireframe, at the position where you want the wireframe element to be created. You should see a green icon appears,
known as the Smart Create resource.
Press on the Smart Create resource and hold the mouse button.
3.
Release the mouse button. In the popup menu, choose the type of wireframe element to create.
P. 992
To create a label, double-click on the wireframe and enter the label caption.
Creating a label
To create an annotation, double-click outside the phone border and enter the annotation text.
Right click on the desired wireframe element and select Font... from the popup menu.
Set font
2.
Edit the font properties in the Font window and click OK to confirm.
P. 993
Right click on the desired wireframe element and select Color... from the popup menu.
Set color
2.
Edit the color properties in the Color window and click OK to confirm. Note that different wireframe elements support different settings. For
example, while text field support editing font color, collection view doesn't.
Color applied
At the bottom of your selection, press on the Duplicate resource icon and hold the mouse button.
3.
Drag it.
P. 994
Release the mouse button at the position where you want the wireframe element to be created.
Renamed a label
NOTE:
Instead of dragging the Duplicate resource, you may click on it, too..
Double click on the background (i.e. the blue region) of the wireframe.
2.
P. 995
4.
Label annotated
You can also use an image component to show an IOS icon for a tab bar. To show an IOS icon, right click on the image component and select IOS...
from the popup menu. In the popup window, choose the icon to show and click OK to confirm.
To specify the content of label, double click on the label and enter the content. You can press Enter to create a new line or press Ctrl-Enter to confirm
editing. You may need to resize the label afterwards in order to see the content entered.
P. 996
The label component is in fact a placeholder of label. You can show multiple labels in it by increasing the height of the label component.
NOTE:
When a label has specified content, you cannot show multiple labels in it.
When the content is filled, the size of label(s) or text in label can be changed. To adjust the font, click on the label component. Then, click on the Font
Size button. After that, drag the slider or press + or - to adjust the font size.
When a label component has text content filled, you can set its color by clicking on the label component first. Then, click on the Font Color button.
After that, drag the slider or directly click on a suggested color to apply it.
To specify the content of text field, double click on the text field and enter the content. You may need to resize the text field afterwards in order to see
the content entered.
P. 997
Search field is a kind of text field that allows user to specify a search string and trigger searching. To show a text field as a search field, right click on
the text field component and select Search Field from the popup menu.
A search field
Editing the placeholder text
Placeholder text is the text that appears in the background of a text field. Very often, placeholder text is used to provide hints for user. For example, a
text field of user name may have <please enter your name here> as placeholder text. Note that the placeholder text is only active when no content has
been specified for the text box. To edit placeholder text of a text field, right click on the text field component and select Edit Placeholder... from the
popup menu. Then, enter the placeholder text in the popup dialog box.
To edit the caption of button, double click on the button and enter the caption. You may need to resize the button afterwards in order to see the caption
entered.
To alter the state of a switch, select the switch first. Then, click on the inactive end of the switch to switch to that end.
To adjust the progress, select the progress view first. Then drag the handler in the middle towards left or right to control the progress.
To adjust the silder position, select the silder first. Then drag the handler in the middle towards left or right to control the position.
Panel is a useful wireframe component that helps you to visualize the different areas of a screen design. You can put other wireframe components in a
panel and move the panel around to reposition the wireframe components at the same time.
To create a panel and make it contains existing components:
1.
2.
3.
Drag to form the size of the panel to be created. Wireframe components contained entirely in the drag range will be contained by the panel.
P. 998
Creating a panel
4.
Panel created
To adjust the fill color of a panel, click on the panel first. Then, click on the Fill Color button. After that, drag the slider or directly click on a suggested
color to apply it.
To hide the border of panel, click on the panel first. Then, click on the Hide Border button. You can click again to show the border again.
To make the corner of a panel rounded, click on the panel first. Then, drag on the handler at top left to adjust the size of the rounded corner. The four
corners will be updated accordingly.
To edit the table header, double click on the table header and enter the content.
P. 999
To adjust the row height, drag on the handler between the first and the second row.
To edit the table header/footer, double click on the table header/footer and enter the content.
By default, table header and footer are visible in a grouped table view. To hide header/footer, right click on the grouped table view and de-select Show
Header/Footer from the popup menu.
To adjust row height, drag on the handler between the first and the second row.
P. 1000
To adjust the size of cells, drag on the handler between the first and the second row.
To edit the lable in a picker view, double click on the label and enter the content.
There are four kinds of date picker - Date-and-Time, Date, Time, Count Down Timer. To change the picker type, right click on the date picker and
select Picker Type > [TYPE] from the popup menu.
P. 1001
To edit the values in a date picker, like to edit the date in a Date-and-Time picker, double click on the field to edit and enter the new value.
Changing PM to AM
To specify the content of the search field, double click on the text field and enter the content. You may need to resize the search bar afterwards in order
to see the content entered.
If you have specified the content of search field, the Cancel button will appear. To rename the Cancel button, double click on the it and enter the new
caption.
P. 1002
When a label component has text content filled, you can set its color by clicking on the label component first. Then, click on the Font Color button.
After that, drag the slider or directly click on a suggested color to apply it.
To edit the title of a segment, double click on the segment and enter the title.
To add more segments to a segmented control, select the segmented control first. Then, drag on the handler attached to the segment separator
between segments to create more segments.
To change the selected segment, select the segmented control first. Then, click on the segment directly in a segmented control.
To add more page indicators to a page control, select the page control first. Then, extend the page control to let more indicators appear.
To set the active page indicator, select the page control first. Then, click on the page indicator directly in the page control.
To edit action description or action, double click on the corresponding label and enter the content.
P. 1003
By default, the action description field is visible in an action sheet. To hide an action description, right click on the action sheet and de-select Show
Description from the popup menu.
To adjust the position of pointer, select the action sheet first. Then, drag on the pointer to adjust its position. You can drag to all the four sides of the
action sheet.
To adjust the position of pointer, select the popover first. Then, drag on the pointer to adjust its position. You can drag to all the four sides of the
popover.
P. 1004
To edit the content of labels and buttons in an alert view, double click on the label or button and enter the content. You may need to resize the label or
the alert view afterwards in order to see the content entered.
To adjust the fill color of a rectangle, click on the rectangle first. Then, click on the Fill Color button. After that, drag the slider or directly click on a
suggested color to apply it.
To adjust the thickness of the border of a rectangle, click on the rectangle first. Then, click on the Line Width button. After that, drag the slider or press
+ or - to adjust the thickness.
To make the corner of a rectangle rounded, click on the rectangle first. Then, drag on the handler at top left to adjust the size of the rounded corner.
The four corners will be updated accordingly.
To adjust the fill color of an oval, click on the oval first. Then, click on the Fill Color button. After that, drag the slider or directly click on a suggested
color to apply it.
P. 1005
To adjust the thickness of the border of an oval, click on the oval first. Then, click on the Line Width button. After that, drag the slider or press + or - to
adjust the thickness.
To add a side, select the polygon first. Then, drag on the white handler attached to the border of the polygon to split a border into two.
Adding a side
Then adjust the position of the new point.
Polygon edited
Adjusting fill color
To adjust the fill color of a polygon, click on the polygon first. Then, click on the Fill Color button. After that, drag the slider or directly click on a
suggested color to apply it.
To adjust the thickness of the border of a polygon, click on the polygon first. Then, click on the Line Width button. After that, drag the slider or press +
or - to adjust the thickness.
P. 1006
To add a point, select the line first. Then, drag on the white handler on the line to create a new point.
Adding a point
Then adjust the position of the point.
Line edited
Adjusting line color
To adjust the line color of a line, click on the line first. Then, click on the Line Color button. After that, drag the slider or directly click on a suggested
color to apply it.
To adjust the width of the border of an oval, click on the line first. Then, click on the Line Width button. After that, drag the slider or press + or - to
adjust the width.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1007
Trademark Disclaimer
iPhone is a trademark of Apple Inc.
Supported Editions
Professional Edition
Enterprise Edition
P. 1008
This shows the resize handlers at the corners and edges of the browser window. You can drag on them to resize the browser window.
1.
Select the desired wireframe element from the diagram toolbar (e.g. Label).
P. 1009
Click on the wireframe, at the position where you want the wireframe element to be created.
1.
2.
3.
Release the mouse button in the wireframe, at the position where you want the wireframe element to be created.
1.
Right click on the wireframe, at the position where you want the wireframe element to be created.
2.
Select Add Shape > %SHAPE_TYPE% from the popup menu, where %SHAPE_TYPE% is the kind of wireframe element you want to create.
1.
Click directly on the wireframe, at the position where you want the wireframe element to be created. You should see a green icon appears,
known as the Smart Create resource.
Press on the Smart Create resource and hold the mouse button.
P. 1010
3.
Release the mouse button. In the popup menu, choose the type of wireframe element to be created.
To create a label, double-click on the wireframe and enter the label caption.
Creating a label
To create an annotation, double-click outside the browser window and enter the annotation text.
Right click on the desired wireframe element and select Font... from the popup menu.
Set font
2.
Edit the font properties in the Font window and click OK to confirm.
P. 1011
Right click on the desired wireframe element and select Color... from the popup menu.
Set color
2.
Edit the color properties in the Color window and click OK to confirm. Note that different wireframe elements support different settings. For
example, while text field support editing font color, panel doesn't.
Color applied
At the bottom of your selection, press on the Duplicate resource icon and hold the mouse button.
3.
Drag it.
P. 1012
Release the mouse button at the position where you want the wireframe element to be created.
Renamed a label
NOTE:
Instead of dragging the Duplicate resource, you may click on it, too..
Double click on the background (i.e. the blue region) of the wireframe.
2.
P. 1013
Label annotated
To specify the content of label, double click on the label and enter the content. You can press Enter to create a new line, or press Ctrl-Enter to confirm
editing. You may need to resize the label afterwards in order to see the content entered.
The label component is in fact a placeholder of label. You can show multiple labels in it by increasing the height of the label component.
P. 1014
NOTE:
When a label has specified content, you cannot show multiple labels in it.
When the content is filled, the size of label(s) or text in label can be changed. To adjust the font, click on the label component. Then, click on the Font
Size button. After that, drag the slider or press + or - to adjust the font size.
When a label component has text content filled, you can set its color by clicking on the label component first. Then, click on the Font Color button.
After that, drag the slider or directly click on a suggested color to apply it.
To specify the content of text field, double click on the text field and enter the content. You may need to resize the text field afterwards in order to see
the content entered.
Search field is a kind of text field that allows user to specify a search string and trigger searching. To show a text field as a search field, right click on
the text field component and select Search Field from the popup menu.
A search field
Editing the placeholder text
Placeholder text is the text that appears in the background of a text field. Very often, placeholder text is used to provide hints for user. For example, a
text field of user name may have <please enter your name here> as placeholder text. Note that the placeholder text is only active when no content has
been specified for the text box. To edit placeholder text of a text field, right click on the text field component and select Edit Placeholder... from the
popup menu. Then, enter the placeholder text in the popup dialog box.
P. 1015
There are two kinds of button - general button and file chooser button. General button is what you commonly see in any user interface. You click on a
general button to do something as description by the button caption. File chooser button is a special kind of button that allows users to provide a file by
clicking on the button. A file chooser button is followed by the text "No file chosen".
When you create a button, it is a general button by default. To change make it a file chooser button, right click on the button and select File Chooser
Button from the popup menu.
To edit the caption of button, double click on the button and enter the caption. You may need to resize the button afterwards in order to see the caption
entered. Note that the caption of a file chooser button is not editable.
The checkbox component is in fact a placeholder of checkboxes. You can show multiple checkboxes in it by increasing the height of the checkbox
component.
To specify the value of a checkbox, double click on the label attached with the checkbox and enter the value. You may need to resize the checkbox
afterwards in order to see the content entered.
To check a checkbox, simply click on the checkbox. You can uncheck it by clicking again.
P. 1016
Checking checkboxes
The radio button component is in fact a radio button group. You can show multiple radio buttons in it by increasing the height of the radio button
component.
To specify the value of a radio button, double click on the label attached with the radio button and enter the value. You may need to resize the radio
button afterwards in order to see the content entered.
To select a radio button, simply click on the radio button. You can uncheck it by clicking again.
By default, a combo box has no items specified. You can add into a combo box a list of items by clicking on the down arrow on the right of the combo
box, and then click on <Add Item> and start entering the item.
P. 1017
To change the selected item of a combo box, click on the down arrow on the right of the combo box, then check the item to select it.
To remove an item from a combo box, click on the down arrow on the right of the combo box, then select the item to remove and click on the cross
button on the right to remove it.
By default, a date picker highlights the date on which the widget was created. If you want to 'pick' another date, simply click on the desired date on the
date picker. If you want to change the active month, click on the forward and previous button at top right. If you want to change the active year, double
click on the text of month and year at top left and edit it.
P. 1018
To adjust progress, select the progress bar first. Then drag the handler in the middle towards left or right to control the progress.
Panel is a useful wireframe component that helps you visualize the different areas of a screen design. You can put other wireframe components in a
panel and move the panel around to reposition the wireframe components at the same time.
To create a panel and make it contains existing components:
1.
2.
3.
Drag to form the size of the panel to be created. Wireframe components contained entirely in the drag range will be contained by the panel.
Creating a panel
4.
Panel created
To adjust the fill color of a panel, click on the panel first. Then, click on the Fill Color button. After that, drag the slider or directly click on a suggested
color to apply it.
P. 1019
To hide the border of panel, click on the panel first. Then, click on the Hide Border button. You can click again to show the border again.
To make the corner of a panel rounded, click on the panel first. Then, drag on the handler at top left to adjust the size of the rounded corner. The four
corners will be updated accordingly.
A panel can be presented as a titled pane or tabbed pane. To do this, right click on the panel and select Type > Titled Pane or Type > Tabbed Pane
from the popup menu.
When presented as titled pane or tabbed pane, you can edit the caption of the pane or tabs by double clicking on captions.
Wireframing tips - Table
Editing table header
To edit table header, double click on the table header and enter the content.
To adjust column width, drag directly on the column separator nearby. By doing so, the adjacent columns will be updated in their width.
To add more columns to a table, select the table first. Then, drag on the handler attached to the column separator between the first and the second
column to create more columns.
P. 1020
When you put a wireframe component (e.g. a label component) into a table component, a new row will be created automatically.
To hide away the table header, right click on the header and uncheck Show Header from the popup menu.
To adjust the fill color of a rectangle, click on the rectangle first. Then, click on the Fill Color button. After that, drag the slider or directly click on a
suggested color to apply it.
P. 1021
To adjust the thickness of the border of a rectangle, click on the rectangle first. Then, click on the Line Width button. After that, drag the slider or press
+ or - to adjust the thickness.
To make the corner of a rectangle rounded, click on the rectangle first. Then, drag on the handler at top left to adjust the size of the rounded corner.
The four corners will be updated accordingly.
To adjust the fill color of an oval, click on the oval first. Then, click on the Fill Color button. After that, drag the slider or directly click on a suggested
color to apply it.
To adjust the thickness of the border of an oval, click on the oval first. Then, click on the Line Width button. After that, drag the slider or press + or - to
adjust the thickness.
To add a side, select the polygon first. Then, drag on the white handler attached to the border of the polygon to split a border into two.
P. 1022
Adding a side
Then adjust the position of the new point.
Polygon edited
Adjusting fill color
To adjust the fill color of a polygon, click on the polygon first. Then, click on the Fill Color button. After that, drag the slider or directly click on a
suggested color to apply it.
To adjust the thickness of the border of a polygon, click on the polygon first. Then, click on the Line Width button. After that, drag the slider or press +
or - to adjust the thickness.
To add a point, select the line first. Then, drag on the white handler on the line to create a new point.
Adding a point
Then adjust the position of the point.
Line edited
Adjusting line color
To adjust the line color of a line, click on the line first. Then, click on the Line Color button. After that, drag the slider or directly click on a suggested
color to apply it.
P. 1023
To adjust the width of the border of an oval, click on the line first. Then, click on the Line Width button. After that, drag the slider or press + or - to
adjust the width.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Professional Edition
Enterprise Edition
P. 1024
Duplicate wireframe
The duplicate function allows you to re-use an existing wireframe to create a new one. Note that the duplicate function does not duplicate any child
state.
To duplicate a wireframe:
1.
2.
Right click on the background of wireframe or on the device and select Duplicate Wireframe... from the popup menu.
3.
Enter the name of the new wireframe and click Duplicate to confirm.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Professional Edition
Enterprise Edition
Duplicate wireframe
P. 1025
Once selected, you will immediately enter the screen capture mode. Drag directly on your screen to select the range to capture.
Release your mouse button to confirm the range. If you are not pleased with your selection, you can select again.
4.
P. 1026
Screen is captured. You can optionally edit the captured screen in the Screen Capture window, like to add arrow and notes into the screenshot.
Click Confirm to confirm the editing. Note that the screenshot is non-editable.
Confirm editing
6.
_
Captured screen placed in wireframe
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Professional Edition
Enterprise Edition
P. 1027
Open the wireframe in which you want to insert a screenshot, or create one. Note that you can add screenshot to any type of wireframe.
2.
Once selected, you will immediately enter the screen capture mode. Your computer screen is temporarily "frozen" for you to capture the region
you want. Drag directly on your screen to select the range to capture.
Capture screen
4.
Release your mouse button to confirm the range. If you are not pleased with your selection, you can select again.
5.
You can perform minor adjustment to the captured range. Press the Up/ Down/ Right/ Left key to adjust the position of the top left corner of the
captured region, or press Shift-Up/ Shift-Down/ Shift-Right/ Shift-Left to adjust the position of the bottom right corner of the captured region.
6.
P. 1028
Screen is captured. An image editor is opened for you to touch-up the captured content. You can optionally edit the captured screen in the
Screen Capture window, like to add arrow and notes into the screenshot.
8.
When ready, click Confirm to confirm the editing. Note that the screenshot is non-editable.
Confirm editing
9.
The captured image is automatically placed inside the wireframe. You can drag it to move it to the place you want.
Select Smart Edit from the diagram toolbar. The Smart Edit tool is grouped under the Selector tool. To use Smart Edit you need to press on
the Selector tool to reveal the Smart Edit tool.
Click on the little Smart Edit resource icon at the top left of a screenshot.
P. 1029
You can move a component to somewhere else by dragging the Move resource at the top right of the editing region.
You can change a screen component to another type, say, to change a drop down menu to a text field by performing the steps below:
1.
Click on the Convert resource at the top right of the editing region.
P. 1030
If you want to remove a component, press delete on the editing region. The background will be filled by a colored that best matches the edge of the
selected range.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Professional Edition
Enterprise Edition
P. 1031
Wireframe storyboard
Creating a wireframe storyboard
Visual Paradigm supports the organization and presentation of wireframes based on user-created storyboards. In this page you will learn how to create
a wireframe storyboard as well as to add/create wireframes in a storyboard.
Renaming a wireframe storyboard
If you want to change the name of a wireframe storyboard, rename it by performing the steps described in this page.
Storyboard
P. 1032
2.
To add a storyboard
3.
Input the storyboard name. You can treat a storyboard as a story. So if you want to represent the screen flow of the password retrieval process,
you can name it Password Retrieval.
4.
If your project has no wireframe in it, you will be asked to create one. If the project contains a wireframe, you can now add an existing wireframe
to the storyboard or just create a new wireframe. More about wireframe selection will be covered in the following sections.
P. 1033
Create/select a wireframe.
7.
Go back to the storyboard by clicking on the Done button on top of the wireframe.
2.
3.
If your project has no wireframe in it, you will be asked to create one. Select the suitable type of device/platform for your application/system. If
your system will run on multiple devices/platforms, please consider creating multiple storyboards.
Click New %TYPE% Wireframe where %TYPE% is the type of device/platform you selected.
5.
A blank, new wireframe appear and you can now begin editing.
P. 1034
When you finish editing, you can go back to the storyboard by clicking on the Done button on top of the wireframe.
State overview
If you want to create an entirely new wirefram:
1.
P. 1035
The remaining steps are same as those mentioned above, starting from step 3.
If you want to re-use an existing wireframe but make a bit of change, you should create a child state instead:
1.
Click Create Child State below the thumbnail of wireframe to create a child state under it.
Once clicked, a new wireframe state will be created. You can start editing it.
2.
3.
To select a wireframe
4.
P. 1036
Choosing a wireframe
5.
This shows the available states of the wireframe. Select the right one by checking the checkbox at bottom left corner. Make sure you do selected
a state in this step. Without doing so, the wireframe won't be associated with the storyboard.
Go back to the storyboard by clicking on the Done button on top of the state selection page.
2.
There is a button at the bottom right of a wireframe. Click on it and select Mouse Gesture > Pointer/Drag/Finger Gesture from the popup
menu. Note that Pointer and Drag are available for Desktop and Web wireframe, while Finger Gesture is available for Android phone, Android
tablet, iPad and iPhone wireframes.
P. 1037
Repositioning a pointer
Related Resources
The following resources may help you learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Professional Edition
Enterprise Edition
P. 1038
2.
Right click on the storyboard to rename and select Rename Storyboard... from the popup menu.
3.
Related Resources
The following resources may help you learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Professional Edition
Enterprise Edition
P. 1039
3.
Play storyboard
4.
This opens the wireframe player. The wireframe of the first step is shown in the player.
Playing a wireframe
You can move on to the next wireframe by pressing the Right key, or clicking on the arrow button at the bottom left of the player. Similarly, you
can press the Left key or click on the back button at the bottom left of the player to move to the previous wireframe.
Showing Annotations
To keep the wireframe clear and readable, annotations are hidden by default. You may click on the Show Annotations button t the bottom left of the
player to have them visible. Let’s show the annotations.
Show annotations
Wireframe playback
P. 1040
Exit playback
Related Resources
The following resources may help you learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Wireframe playback
P. 1041
2.
3.
In the center of the editor, select the wireframe(s) to reorder. You can perform multiple selection by first pressing Ctrl on a wireframe, and then
select the other wireframes one by one.
Reordering wireframes
5.
Related Resources
The following resources may help you learn more about the topic discussed in this page.
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Supported Editions
Professional Edition
Enterprise Edition
P. 1042
P. 1043
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1044
Analysis diagram
By analyzing a model element, you can know its relationships with other elements. This chapter shows you how to analyze things by forming and
reading an analysis diagram.
Grouping of nodes
Instead of having many many nodes show on analysis diagram, you may want to group nodes of same type to make the diagram tidier.
Analysis diagram
P. 1045
Right click on the diagram element we want to analyze and select Related Elements > Analysis... from the pop-up menu.
The result of analysis will be presented in analysis diagram. In the Analysis window, either select Create new diagram to present the result
in a new analysis diagram or select to present in an existing analysis diagram. The check boxes at the Analyse section governs the type(s) of
relationship to be analyzed. Click OK when ready.
Description
Transitor
The transited element of the chosen element or the element where the chosen element was transited from
Reference
P. 1046
Parent-Child
Sub-diagram
Relationship
The relationship(s) of the chosen element, such as association, dependencies, sequence flow, etc
Used
The connection with the chosen element, other than any other kinds of relationship types. For example, requirement
owned by use case added through use case description is a kind of Used relationship.
View
The view(s) of a model element, which can be seen as the shapes of a model element
Kinds of relationships that can analyze
An analysis diagram
The oval node at the center of the diagram represents the element you have chosen to analyze, the connectors branching out are the relationships with
the analyzing element and the nodes at the opposite end of connectors are the related elements.
Inside a node of a related element, you can see a tag (e.g. <<View>>) which represents the type of that related element. At the bottom part of a node
box is the name of the related element.
By reading the diagram, you can identify the relationship of a model element and determine the impact that may act upon the model when modifying
the model element.
Analyze further
Analysis diagram allows you to visualize the relationships between a model element and its related elements. If you want to visualize the relationship
between a related element with its related elements, you can analyze further by performing the steps below:
1.
Move your mouse pointer over the related node in the analysis diagram.
3.
P. 1047
Analyse Used
Note that by analyzing mutliple model elements on the same analysis diagram, the diagram may contain a lot of nodes and connectors, making
it hard to read and understand. To solve this problem, you may consider showing the result in another analysis diagram by selecting Analyse in
New Diagram... in the step above.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1048
Move the mouse pointer over the node that you want to update its relationships with others.
NOTE:
2.
Besides the central node, you may update/show the relationships of other Model nodes on diagram, too.
To click on Analyse
3.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1049
Grouping of nodes
To make it easier to identify the relationships of a chosen element, you can group all relationships of a particular kind into a single node, eliminating the
connectors being shown on diagram. To group, right click on the background of analysis diagram and select Presentation Options > Group By and
then the type of node from the popup menu.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Grouping of nodes
P. 1050
If the target model has only one view, that view is opened. If there a multiple views, the Show View window is presented. Select a view to open
and click Go to View at the bottom right of window.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1051
Matrix diagram
A matrix is a table, which shows the relationships among model elements of particular types. By reading a matrix, you can tell easily whether two model
elements are related or not, and what kind of relationship do they have. This chapter not only tells you how to create a matrix but also how to read it, to
get the information you need.
Creating a matrix
Shows you how to create a matrix.
Reading a matrix
Explains each part of a matrix in detail.
Matrix diagram
P. 1052
Creating a matrix
A matrix is a table, which shows the existence of relationships among model elements of particular types. By reading a matrix, you can tell easily
whether two model elements are related or not and what kind of relationship they have.
1.
Select Modeling > Impact Analysis > Matrix from the toolbar.
2.
Configure matrix
Field
Description
Diagram Name
Scope
The source of model elements to compare in matrix, in Project (all model elements), Diagram (only model
elements in specific diagrams which are selected by users) or under Model/Package.
Template
Template offers a default setup to Models on Column, Models on Row and By. It is available according to the
project content. For example, template "Use Case <-> Requirement" appears for selection when a project have use
case and requirement.
Available Models
All available models in your selected scope are listed here. You can select a model to add it in the target Models
on Row and/or Models on Column.
Models on Column
The type of model element to list at the column side of matrix. In order to list multiple types of model element,
select it/them on Available Models and click
Models on Row
The type of model element to list at the row side of matrix. In order to list multiple types of model element, select it/
them on Available Models and click
By
The way how matrix will match against rows and columns.
Sub Diagram - The column/row model element is placed in a sub diagram of the matching model element.
Child - The column/row model element is a child of the matching model element.
Relationship - The column/row model element is related with the matching model element. You can specify the
kind of relationship between model element, as well as the stereotype, if any, assigned to the relationship. Besides,
if you choose to match by Relationship, you will see the button Skip in Relationship.... This button allows you to
ignore specific kind(s) of model elements when considering if two elements are related or not. It's particularly useful
when two elements are conceptually connected with each other but with an intermediate element in between.
For instance, you may have two components connected with each other, but with an interface in between as the
provided and required interface of the components. Without skipping the interface (class) in between, the two
components will not be considered to be "related", but by skipping class, which is the real element type of an
interface, classes will be ignored and thus, the two components will be considered as "related".
Reference - The column/row model element is referencing the matching model element.
As Classifier - The column/row model element takes the matching model element as classifier.
Transitor - The column/row model element is transited from/to the matching model element.
Dependent - The column/row model element has properties that depend on the matching model element.
"Depend" means any of the following: (1) With any kind of relationship such as association, dependency, etc. (2)
As a contained element (3) As a link in description content (4) As a selected value for any property.
Using Term - The column/row model element is a term (element) and is indirectly used by the matching model
element, either or both as part of its name or in its description.
Creating a Matrix
P. 1053
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Creating a Matrix
P. 1054
Reading a matrix
Knowing how to read a matrix helps you to understand your model better and to perform further modifications more comfortably. In this chapter, we will
see how to read a matrix and how to refine the matrix content with the help of functionalities like hiding columns and rows and filter.
A matrix is a table with rows and columns, both represent sets of model elements of specific types. A cell in table is an intersection of a row and a
column which reflects the relationship of the row and column. If the cell is filled either by a tick or by a kind of relationship (when a matrix was set to
match things by Relationship), this means that the model elements of the row and column are related. The type of relationship can be checked by
referring to the drop down menu at the top left of matrix.
Name
Description
Sort
Adjust the way elements are ordered in rows and columns - by name, stereotype or ID
Matrix lists only rows and columns with matches by default. Uncheck it when you want to show
entries without matches as well.
Filter row
Type the full name of a model element or part of it that you are looking for to narrow down the
searching field in rows when too much data is displayed.
Filter column
Type the full name of a model element or part of it that you are looking for to narrow down the
searching field in columns when too much data is displayed.
Refresh
You can update the content of matrix by clicking this button manually, for reflecting the
changes you have made in models.
Export to Excel
Configure
By
Relationship
10 Relationship Stereotype
11 Rows
Rows and columns are ordered alphabetically by default. They help to re-order rows and
columns in moving vertically.
It helps to change the presentation between rows and columns, but not switch the actual
relationships between model elements being represented by them.
Rows and columns are ordered alphabetically by default. They help to re-order rows and
columns in moving horizontally.
15 Columns
Exporting Excel
You can export Excel file from matrix, and analyze relationships between model elements in worksheet in Excel. To export Excel:
1.
Click Export to Excel above the matrix, near the Configure button.
Reading a matrix
P. 1055
In the Export Excel dialog box, specify the output destination and click Save.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Reading a matrix
P. 1056
Select Diagram > New from the toolbar. In the New Diagram window, select Impact Analysis > Matrix Diagram. Click OK to confirm.
2.
Configure the matrix. If you want to place the terms at the top of matrix, add Term to Models on Column. If you want to place the terms on the
left hand side of matrix, add Term to Models on Row.
Click OK. The ticks show in the matrix indicate the use of term for specific element.
Matrix formed
5.
If you want to open a view of a model element, right click on the element and select Show View... from the popup menu. in the Show View
window, select the diagram to open and click Go to View.
P. 1057
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1058
Chart diagram
Chart diagram enables you to specify and show the relationship between model elements by mean of chart. This chapter shows you how to create and
configure chart.
Developing a chart
Shows you how to create and develop chart.
Configuring a chart
Shows you how to configure chart.
Chart diagram
P. 1059
Chart diagram
Visual Paradigm enables you to build a chart. In addition to the built-in RACI chart available for general purposes, you can define your own type of
chart for problem-specific purposes. In this page, you can learn how to develop a chart, define color for roles and define a new code type.
Developing a chart
1.
Select Modeling > Import Analysis > Chart from the toolbar.
2.
Select a model element type for row and column respectively to identify which participant is involved in an activity.
NOTE:
The choice of model element types will be in accordance with your exisiting model elements in the same project.
4.
Click OK button.
5.
You can then assign the role to participant(s) by clicking Mark Code to Cell button on the top of chart.
When the roles reveal, click the target role and select the target cell to assignment.
Assign role
Chart Diagram
P. 1060
Adding an item
Apart from selecting the existing model elements on chart, you can also create objects without model view. Those objects will have the similar
properties with model elements that you can assign role to them.
To create an item without model view:
1.
Right click on a model element where you want to insert an item in font of that model element and select Add item... from the pop-up menu.
Add an item
2.
Enter name for new item in the pop-up Input dialog box. Click OK button to confirm and close the dialog box.
The background color of columns and rows are white by default. You can specify background color for the entire columns/ rows by right clicking on the
target row/ column and then selecting color for it.
Chart Diagram
P. 1061
You can view and specify the properties of model elements by opening their specification dialog box.
To open a model element's specification:
1.
Right click on the target model element and select Open Specification... from the pop-up menu.
In specification dialog box, specify its properties, for example, description, references, tagged values and comments. Click OK button.
When reading the chart, you may want to view the model element on its source diagram.
You can view the model element by right clicking on the target model element and selecting Show View... from the pop-up menu.
Chart Diagram
P. 1062
You can arrange the order of model elements with your preference.
Right click on target row/ column and select Move up or Move Down from the pop-up menu.
Chart Diagram
P. 1063
2.
To define a color for a role, click the target role you want to change its color on the left, click the ... button next to Color and select a color from
the pop-up menu.
Click OK button.
In the pop-up Configure Code Type dialog box, select Add > Code Type from the pop-up menu at the bottom to add a code type.
To configure the roles under the new code type, select Add > Code from the pop-up menu.
Enter the name of the code in Name and a letter which presents the code in Code. Click the ... button next to Color and select a color for the
code from the pop-up menu.
Chart Diagram
P. 1064
Click OK button.
7.
The chart type you created previously is currently available from the combo box of Code Type. Select it from the combo box of Code Type.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Chart Diagram
P. 1065
P. 1066
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Notations
The description of notations is either extracted or derived from the OMG SoaML Specification v1.0.1.
Name
Representation
Description
Service Interface
Interface
Simple interfaces define one-way services that do not require a protocol. Such services
may be defined with only a single UML interface and then provided on a "Service" port and
consumed on a "Request" port.
Role
A ServiceInterface is a UML Class. It defines specific roles for each participant plays in
the service interaction. These roles have a name and an interface type. The interface of
the provider (which must be the type of one of the parts in the class) is realized (provided)
by the ServiceInterface class. The interface of the consumer (if any) must be used by the
class.
Connector
Capability
A Capability models the ability to act and produce an outcome that achieves a result that
may provide a service specified by a ServiceContract or ServiceInterface irrespective of the
Participant that might provide that service. A ServiceContract alone, has no dependencies
or expectation of how the capability is realized – thereby separating the concerns of
'what" vs. "how." The Capability may specify dependencies or internal process to detail how
that capability is provided including dependencies on other Capabilities. Capabilities are
shown in context using a service dependencies diagram.
P. 1067
Expose
The Expose dependency provides the ability to indicate what Capabilities that are required
by or are provided by a participant should be exposed through a Service Interface.
Dependency
The Provider may also have a uses dependency on the consumer interface, representing
the fact that the provider may call the consumer as part of a bi-directional interaction. These
are also known as "callbacks" in many technologies.
Realization
Usage
Message Type
Milestone
A Milestone depicts progress by defining a signal that is sent to an abstract observer. The
signal contains an integer value that intuitively represents the amount of progress that has
been achieved when passing a point attached to this Milestone.
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1068
P. 1069
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Notations
The description of notations is either extracted or derived from the OMG SoaML Specification v1.0.1.
Name
Representation
Description
Participant
Agent
Part
Property
Service Port
P. 1070
Request Port
Port
Service Channel
Connector
Capability
A Capability models the ability to act and produce an outcome that achieves
a result that may provide a service specified by a ServiceContract or
ServiceInterface irrespective of the Participant that might provide that service.
A ServiceContract alone, has no dependencies or expectation of how the
capability is realized – thereby separating the concerns of "what" vs.
"how." The Capability may specify dependencies or internal process to detail
how that capability is provided including dependencies on other Capabilities.
Capabilities are shown in context using a service dependencies diagram.
Realization
Usage
Dependency
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
P. 1071
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1072
P. 1073
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Notations
The description of notations is either extracted or derived from the OMG SoaML Specification v1.0.1.
Name
Representation
Description
Service Contract
Role
Provider
Consumer
P. 1074
Connector
Dependency
The Provider may also have a uses dependency on the consumer interface,
representing the fact that the provider may call the consumer as part of
a bi-directional interaction. These are also known as "callbacks" in many
technologies.
A list of supported notations in service participant diagram
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1075
P. 1076
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Notations
The description of notations is either extracted or derived from the OMG SoaML Specification v1.0.1.
Name
Representation
Services
Architecture
Internal
Participant
External
Participant
Service
Contract Use
(CollaborationUse)
Role Binding
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1077
P. 1078
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Notations
The description of notations is either extracted or derived from the OMG SoaML Specification v1.0.1.
Name
Representation
Description
Catalog
A named collection of related elements, including other catalogs characterized by a specific set of
categories. Applying a Category to an Element using a Categorization places that Element in the
Catalog.
Category
A Category is a piece of information about an element. A Category has a name indicating what the
information is about and a set of attributes and constraints that characterize the Category. An Element
may have many Categories and the same Category can be applied to many Elements. Categories
may be organized into Catalogs hierarchies.
Category Value
A CategoryValue provides values for the attributes of a Category. It may also be used to categorize
model elements providing detailed information for the category.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1079
Animation
Animation helps you make possible paths in an active diagram by presenting the paths in animation form. This chapter will tell you how to animate your
design and export the result to movie.
What is animation?
Describe animation in detail.
Animation
P. 1080
An animating path
and
button. By making use of the forward and backward buttons, you can walk through a path shape by shape.
What is animation?
P. 1081
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
What is animation?
P. 1082
Click Add Animation (graphically, a plus sign) at the top of the Animation Panel.
Add animation
3.
Give a meaningful name to the animation based on the flow you want to animate. Press Enter to confirm editing.
Named animation
4.
When you add an animation for a process that involves gateway, you need to select the outgoing flows for gateway(s) in order to complete the
path. To resolve an exclusive gateway requires the selection of the outgoing path. To resolve an inclusive gateway requires the selection of zero
to multiple outgoint paths. Make your selection and click the green arrow button to confirm.
P. 1083
Name
Description
Expand/Collapse
Backward
Play
Stop
Forward
Add Animation
Slider
Current Animation
Animation selection
10 Refresh
It is used for re-identifying the flow of animations base on the diagram content.
11 Options
12 Close
13 Flow of shapes
It displays all shapes of the current animation. Pressing on a shape here will highlight the corresponding shape in
diagram.
14 Shape name
The name of the selected or animating shape. A question mark indicates that the shape is a decision shape. You can
click on the question mark to re-select its outgoing flow.
15 Parallel flow
P. 1084
Description
It dims the components that are not a part of the selected path.
Jump to the first node of the selected path, or keep staying at the current viewing field.
Flow
Show description
Play voice
Voice can be recorded as description of model element. Check this if you want to play recorded voice
when playing the animation in exported HTML.
The description of Animation Options (General) window
P. 1085
Name
Description
Color set
Select a color set to controls the line and fill color of visited shape.
Line color
Fill color
Line weight
Ball color
The color of ball that goes through a path during animation for indicating the progress of
flow.
Speed
The background color for the top of progress bar in exported HTML.
The background color for the bottom of progress bar in exported HTML.
The description of Animation Options (General) window
Exporting Animation
You can export the animation to Web contents so that you can play it externally in another computer just by playing in a Web browser. To export
animation, right click beside the name of animation in Animation Panel and select Export... from the popup menu. Then, fill in the file path and click
OK in the Export window. You can add paths to be exported by clicking the plus button.
Export animation
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1086
In Sequence Diagram Animation dialog box, select a path and then click Play.
NOTE:
The animation tool can also be started by using any of the ways below:
Right-click on the diagram background and select Utilities > Animation... from the popup menu.
Click Show Action Bar on the right of the diagram pane, then select Animation.
Overview of Animation
The Sequence Diagram Animation dialog box will pop out after clicking Animation.... This dialog box is where you can select an execution path to
play an animation.
Name
Description
Backward
Play
Stop
Forward
Slider
Paths
P. 1087
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.
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.
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.
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 flying on diagram without attaching
to the invisible shape(s) when executing a path.
12 Export to Flash...
Select an output path for exporting this diagram's animation to Adobe Flash.
13 Minimize
14 Options pane
15 Advanced Options...
16 OK
17 Cancel
Advanced Options
Description
The background color of visited shape that cause an error. An error means the flow object that
causes a path invalid.
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.
P. 1088
Ball color
The color of ball that goes through a path during animation for indicating the progress of flow.
Speed
The background color for the top of progress bar in exported Flash movie.
The background color for the bottom of progress bar in exported Flash movie.
The description of Advanced Options dialog box
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.
3.
3.
Select the shapes that are shown on the Components list to direct the flow of animation.
4.
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.
P. 1089
Reviewing an Animation
1.
When everything is ready, click Play to start the animation of the selected path.
2.
After click Play, Sequence Diagram Animation dialog box will be minimized to the bottom of your diagram, with several buttons and a slider
revealing on it.
Button
Name
Description
Pause
Play
Forward
Stop
When the animation starts, a black ball will appear at beginning of path and traverse through the path until the end.
4.
When the black ball reaches a shape, the shape will turn into purple.
P. 1090
Exporting an Animation
You can export the animation to Web contents so that you can play it externally in another computer just by playing in a Web browser.
1.
From the Paths list in the Animation window, select the execution paths to export as Flash movie.
Path selection
2.
Click the Export to Flash... button at bottom left. This shows the Export to Flash dialog box. Here is a description of the Export to Flash
dialog box.
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 Viewer
When checked, default web browser will automatically start and play the exported Flash movie.
Dimension
Available
Available paths that can be selected to export to Flash movie for animation.
Selected
3.
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.
4.
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.
5.
Click Export. Open the HTML file in the web browser to play the movie. 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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1091
2.
In Activity Diagram Animation dialog box, select a path and then click Play.
NOTE:
Right-click on the diagram background and select Utilities > Animation... from the popup menu.
Click the drop-down menu of Modeling Tools and select Animation... on the toolbar.
Overview of Animation
The Activity Diagram Animation dialog box will pop out after clicking Animation.... This dialog box is where you can select an execution path to play
an animation.
Name
Description
Backward
Play
Stop
Forward
Slider
Paths
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.
P. 1092
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.
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.
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 Export to Flash...
Select an output path for exporting this diagram's animation to Adobe Flash.
13 Minimize
14 Options pane
15 Advanced Options...
16 OK
17 Cancel
Advanced Options
Description
The background color of visited shape that cause an error. An error means the flow object that
causes a path invalid.
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
P. 1093
transiting from an initial color to visited fill color. This option manages the initial background color
for visiting shape.
Visited line color
Ball color
The color of ball that goes through a path during animation for indicating the progress of flow.
Speed
The background color for the top of progress bar in exported Flash movie.
The background color for the bottom of progress bar in exported Flash movie.
The description of Advanced Options dialog box
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.
3.
3.
Select the shapes that are shown on the Components list to direct the flow of animation.
4.
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.
P. 1094
Reviewing an Animation
1.
When everything is ready, click Play to start the animation of the selected path.
2.
After click Play, Activity Diagram Animation dialog box will be minimized to the bottom of your diagram with several buttons and a slider
revealing on it.
Button
Name
Description
Pause
Play
Forward
Stop
When the animation starts, a black ball will appear at beginning of path and traverse through the path until the end.
4.
When the black ball reaches a shape, the shape will turn into purple.
P. 1095
Exporting an Animation
You can export the animation to Web contents so that you can play it externally in another computer just by playing in a Web browser.
1.
From the Paths list in the Animation window, select the execution paths to export as Flash movie.
Path selection
2.
Click the Export to Flash... button at bottom left. This shows the Export to Flash dialog box. Here is a description of the Export to Flash
dialog box.
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 Viewer
When checked, default web browser will automatically start and play the exported Flash movie.
Dimension
Available
Available paths that can be selected to export to Flash movie for animation.
Selected
3.
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.
4.
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.
5.
Click Export. Open the HTML file in the web browser to play the movie. 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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1096
Zachman Framework
Zachman Framework provides structured and disciplined way of defining an enterprise.
Zachman Framework
P. 1097
Zachman Framework
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 1098
In the window popped up, click Add... under the Diagrams tab.
4.
In the Select Diagram window, select the diagram(s) to add to cell and click OK.
NOTE:
5.
You can check Add as sub diagram to make the selected diagrams be added to the sub-diagrams of the cell element.
When unchecked, the selected diagram will have their parent elements unchanged.
Click OK to return to diagram. You can see that the symbol in the edited cell is highlighted.
Add/Edit terms
Here 'terms' refers to glossary terms. You can add terms to a cell.
1.
2.
This pops up a window with Terms tab selected. If you want to define a term here, click New Term in toolbar, which is the first button. Then,
enter the name of the term. If you want to add reference to an existing term, click on the Add Existing Terms button, which is the second
button. Then, select the terms to be added in the popup window and click OK to confirm.
P. 1099
Click OK to return to diagram. You can see that the symbol in the edited cell is highlighted.
Add/Edit rules
Business rules can also be added to cell.
1.
2.
This pops up a window with Rules tab selected. If you want to define a rule here, click New Business Rule in toolbar, which is the first button.
Then, enter the name of therule . If you want to add reference to an existing rule, click on the Add Existing Rules button, which is the second
button. Then, select the rules to add an in the popup window and click OK to confirm.
P. 1100
4.
Click OK to return to diagram. You can see that the symbol in the edited cell is highlighted.
Forming sub-level
1.
Click on the cell you want to edit.
2.
Click on the button at the left hand side of the cell for adding sub-level.
In the Sub-level window, select either of the following and click OK.
New Zachman framework - Create a new Zachman Framework and add it as the sub-level of the editing cell.
Select an existing Zachman framework - Select a Zachman Framework created before to be the sub-level of the editing cell.
Click OK. Now, you are on the sub-level. To go back to the previous level, you may click on the link at the top of Zachman Framework. Cells
with sub-level added will have their background painted.
Open sub-level
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
P. 1101
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 1102
Collapse the non-interested rows and columns to make the interested cell remain expanded and dominate the matrix.
Cells collapsed
On the contrary, you can click on the Expand button (+) to expand rows/columns.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 1103
P. 1104
P. 1105
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Notations
The description of notations is taken from OMG BMM Specification v1.1.
Name
Representation
Description
End
Vision
Goal
Objective
Means
P. 1106
Strategy
Tactic
Business Policy
Business Rule
Internal Influencer
External Influencer
P. 1107
Risk
Potential Reward
Organization Unit
Asset
When Courses of Action are being defined, 'things' that are used
in operating the enterprise often have to be considered. They are
represented in the Model as Assets, of two kinds:
• Fixed Assets - things that are kept long-term, maintained, reused,
and perhaps eventually replaced. They can be tangible, such as
equipment and buildings, or intangible, such as patents and licenses.
P. 1108
N/A
Quantify
N/A
Channel Efforts
N/A
N/A
Enable
N/A
Implement
N/A
Regulate
N/A
Judge
N/A
Use
N/A
Provide Impetus
N/A
Govern
N/A
Responsible
N/A
Source
N/A
Composition
N/A
A list of supported notations in Business Motivation Model (BMM) diagram
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 1109
ArchiMate diagram
ArchiMate is a modeling technique for describing enterprise architectures. You will learn in this chapter how to create archimate diagram, and learn the
notations supported by archimate diagram.
ArchiMate diagram
P. 1110
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Representation
Business actor
Business role
Business collaboration
Business process
Business function
Business interaction
Business event
Business service
Business interface
P. 1111
Location
Business object
Product
Contract
Representation
Meaning
Value
Representation
Application collaboration
Application component
Application service
Application function
Application interaction
Application interface
Data object
Representation
Node
Device
System software
P. 1112
Infrastructure interface
Infrastructure function
Infrastructure service
Artifact
Communication path
Network
A list of supported notations in ArchiMate diagram, for technology layer
Representation
Stakeholder
Driver
Assessment
Goal
Principle
Requirement
Constraint
Influence
A list of supported notations in ArchiMate diagram, for motivation layer
Representation
Plateau
Gap
Deliverable
Work
Package
A list of supported notations in ArchiMate diagram, for implementation & migration layer
P. 1113
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 1114
2.
Manage viewpoints
3.
Add a Viewpoint
4.
A list of standard viewpoints are listed, known as the predefined viewpoints. Check the ones that are required by your enterprise architecture
(project).
6.
Each predefined viewpoint comes with a set of preset properties such as stakeholders, layers, purpose, abstraction level, concerns and aspects.
You may change them by first selecting the viewpoint you want to change on the left hand side and editing the fields on the right hand side. Here
is a description of properties:
Property
Description
Name
Architecture Stakeholders
Layer
The perspective involved. The selection affects the visibility of tools that are available in diagram
toolbar in ArchiMate diagram.
P. 1115
Purpose
One of the two dimensions in classifying a viewpoint. The Purpose dimension allows the classification
of viewpoint base on the purpose of view.
Designing - Support architectures and designers in the design process.
Deciding - Assists stakeholders in decision-making.
Informing - Inform stakeholders who have a need in understanding the enterprise architecture.
Abstraction Level
One of the two dimensions in classifying a viewpoint. The Abstract Level dimension classify viewpoint
base on the level of detail of a view.
Details - Typically consider one layer and one aspect from the ArchiMate framework.
Coherence - Multiple layers or multiple aspects are spanned.
Overview - Addresses both multiple layers and multiple aspects.
Concerns
Aspects
Properties of a viewpoint
7.
2.
3.
4.
Click New.
5.
6.
7.
8.
P. 1116
Creating a Stakeholder
When you add a standard viewpoint, the stakeholders involved will be added to your project automatically. In addition to these 'default stakeholders',
you can create your own to suit your business and problem domain.
To create a stakeholder:
1.
2.
3.
4.
Click New.
Select View > Panes > Model Explorer in the toolbar. After openning the Model Explorer, you should see two nodes - Stakeholders and
Viewpoints, with stakeholders and viewpoints listed.
P. 1117
Model Explorer
2.
If you want to browse enterprise architecture base on a stakeholder or viewpoint, double click on it.
If you want to browse with another stakeholder/viewpoint, you can update the selection in the drop down at the top of the panel.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
P. 1118
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Visual Paradigm
P. 1119
Business rule
A business rule defines guideline with necessary constraint(s) needed for executing certain business operations. You will learn how to manage
business rules.
Business Rule
P. 1120
1.
2.
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
6.
This shows the rule editor. An ID is a set of number indicating the order of rule creation that is assigned automatically. You may change it if you like. Name the rule with a short and descriptive
phrase. Fill in the rule content in the Rule field.
Selected Business Rule
No.
1
Name
Rule
Description
A tab that shows the primary rule information such as its name and definition
P. 1121
Stereotypes
A list of stereotypes applied to the rule. You can extend a rule from a stereotype to add domain specific meaning to it. For example, you can extend a rule
from stereotype critical to represent an important rule.
Attributes
Read, add and remove attributes from the rule. Attributes can be added to denote extra properties to a rule.
ID
A value that makes each rule unique. When you create a rule, an ID will be assigned automatically. The assigned ID indicates the order of rule creation.
Name
Rule definition
Synchronize selection
When the checkbox is checked, the Terms and Facts' active node selection will follow the selection as pointed by the mouse pointer in the Rule
definition field.
Terms
Term definition
By selecting a term in Terms list, its definition will appear in the Definition field.
10
Facts
11
Term definition
By selecting a term in Facts list, its definition will appear in the Definition field.
1.
2.
Click on the diagram to create a business rule. Name the rule with a short and descriptive phrase and press Enterto confirm.
P. 1122
1.
Select rules
2.
Right click on the selection and select Group Business Rules from the popup menu.
P. 1123
To group rules
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1124
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Name
Description
Name
Model Element
Change the type of model element to be listed in grid. Although Business Rule is selected by default, you
may change it to other types.
Scope
The location to look for the business rules to list in grid. By default, business rules are found from the
whole project. You can change to find use cases from specific model or package, or to find only business
rules right at the root level. You can also restrict the scope to all diagrams, to within a specific diagram or
to all business rules that has not been visualized in any diagram.
Filter
Apply filter to grid content. Text entered here is matched against the Name property of business rules
listed in grid. Business rules that do not contain the entered text in their name are hidden.
Check it to list also business rules in referenced projects, in Business Rule Grid.
Font Size
Configure Grid
Click to show/hide the grid configuration panel, which allows you to enter the name of grid, the model
element to be listed in grid, the scope and to apply filter to grid content.
Select a business rule in Business Rule Grid and click this button to open the rule editor.
10 Open Specification...
Select a business rule in Business Rule Grid and click this button to open its specification.
Select a business rule in Business Rule Grid and click this button to acces its details in Business Rule
Details editor.
12 Show View...
Select a business rule in Business Rule Grid and click this button to list the diagrams that contains the
view of the selected business rule.
13 Visualize...
Select a business rule in Business Rule Grid and click this button to show it in a new or existing diagram.
P. 1125
14 Configure Columns...
Click to select the property(ies) of business rules to be listed in the grid, as columns.
15 Refresh
Click to refresh the grid content by showing the most updated information of business rules listed.
16 Export to Excel
19 Search
20 Clear
2.
4.
To enter the details of business rule, right click on the new business rule and select Open Rule Editor from the pop-up menu.
In Business Rule Editor, enter name and rule for the newly created business rule.
Creating fact
Highlight a word which you want to create to be a fact and select Create Fact from the pop-up menu.
Highlight a word which you want to create to be a term and select Create Term from the pop-up menu.
P. 1126
Right click on the column header at the top of a grid and select Add Tagged Value Column... from the popup menu.
Enter the tag name in the Input dialog box and click OK to confirm.
3.
You will see a new column appear in the last column of the grid.
Now, you can double click on a cell in that column to enter the value of the property (tag). When and only when you have entered a value, a tag
will be added into that specific model element. Note that once a tag is added, you cannot remove the tag by clearing the cell content. If you want
to remove the tag, you have to do it in the model element specification window.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1127
Fact diagram
Record and related terminologies under specific business domain by using fact diagram.
Fact Diagram
P. 1128
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Notations
Name
Representation
Description
Term
A meaningful noun or noun phase that business participants recognize and use in
communication.
Fact Type
Fact Association
Generalization
Split a fact type by right clicking on the fact association and selecting Split Binary Fact from the popup menu.
Move the mouse pointer over the added term. Press on the resource Term-Fact Type Association -> Fact Type and drag to the split fact type.
P. 1129
Release the mouse button. This connects the new term with split fact type.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1130
Decision diagram
Represent complex decision situations and business rules in the most simplest, organized manner.
Decision table
P. 1131
3.
Click Next.
4.
Enter the diagram name and description. The Location field enables you to select a model to store the diagram.
5.
Click OK.
Creating rules
The third button in the toolbar at the top of the decision table allows you to create rules. By selecting an existing rule and click on the create button, a
new rule will be inserted after the selected rule. Find the conditions and actions that match your rule. Double click on the corresponding cell and place a
mark on it. For example, enter "Y" to indicate "Yes". Alternatively, you can right click on a rule and add a new one after it via the popup menu.
P. 1132
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
P. 1133
Selecting a rule
2.
Click the Show Description button at the right hand side of the status bar to show the Description pane. Edit the description in the
Description pane.
description of a rule
P. 1134
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
P. 1135
Click the Filter button on the right of the International flights column.
Set filter
2.
Click the down arrow button. You can see the option <Variable> and Y.
Set filter
3.
Click Y. As a result, only those Action(s) that meet the Condition, International flights is/are appeared below. In this case, the Actions of
International flights are shown and other Actions which are unrelated to International flights are screened out. In this way, the table becomes
more user-friendly to read.
Set filter
Moreover, you can set multiple filters to more than one Conditions/ Actions. For example, other than International flights, if you want to buy the flight
ticket for your child which is under 2 year-old. In this case, one more Condition needs to be fulfilled which is Infant passengers (age: <2). Then, you can
set one more filter in the Infant passengers (age: <2) column.
Consequently, only the Action, Offer 70% discounts is shown in the Actions column. In other words, only this Action satisfies the Conditions,
International flights and Infant passengers (age: <2).
P. 1136
Click the Filter button on the right of the International flights column.
2.
Click the Down Arrow button. You can see the options <Variable> and Y
3.
Click <Variable> this time. Then, only the filter in the Conditions, International flights will be removed.
P. 1137
P. 1138
Process Simulation
With process simulation, 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 help study and execute process
improvements. This chapter provides you with detailed information about process simulation.
What is simulation?
Introduce simulation, and shows you some of the key features like simulation and resource chart.
Simulation charts
In addition to process simulation, you can produce charts to aid in the analysis of process performance.
Process Simulation
P. 1139
Key concepts
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.
P. 1140
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, a
long queue will be acculumated to wait for trancation.
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 represents 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 to
improve your process, you must set input that reflects 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.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1141
NOTE:
You can open Simulation Control Panel only for diagram that has selected Simulation 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.
Name
Description
Profile
To create a new profile for simulation, select Configure Profile... from the drop-down menu and name the newly created
profile in the Configure Profile dialog box.
Start / Pause
Click to start simulation when paused or stopped base on the resource, duration and scenario settings or to pause a
simulation when it is playing.
Stop
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.
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.
Current unit
Click to select the current unit, such as US Dollar, Hong Kong Dollar and Yen, for the consumption during simulating.
Simulation charts
Click to display a new window that display the completion, resource usage and queue time charts base on the settings of
resource, duration and scenario. You can treat it as a chart form of simulation outcome.
P. 1142
Close
Click to close the Simulation Control Panel. You can open it again by right clicking on the business process diagram and
selecting Show Simulation Control Panel from the popup menu.
Description of Simulation Control Panel
Name
Instance
Description
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 which allow you to set the number of instances of the 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 the instances, the more the 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.
Show Scenarios
Scenarios are the expected way of executing a business process during simulation. Click Show Scenarios to
list the scenarios, and add/remove scenarios in further.
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.
Click to add an available resource by giving its name, selecting/entering its type and setting its amount.
Name
Duration
Description
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, if it takes five minutes to present a document
to client in a body check operation, then set the business task Present Document's duration to be 5 m,
meaning 5 minutes.
The duration setting affects the performance of process - The less time is needed, the more efficient it is.
However, do not forget that the less time it takes to complete a task may affects the quality of work. During
P. 1143
process improvement, you need to keep the balance between efficiency and quality of work and adjust the
duration accordingly.
2
Cost
The cost the selected flow object need to spend to process and complete a job.
Show scenarios
Scenarios are the expected way of executing a business process during simulation. Click Show Scenarios to
list the scenarios, and add/remove scenarios in further.
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 document to client, you need
one resource Meeting Room, and one resource Projector.
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 projectors (resources), the maximum number of projector a flow object can require is from 0 to 6.
Available resources
The table of available resources lists out 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.
Click to add an available resource by giving its name, selecting/entering its type and setting its amount.
An overview of Simulation Control Panel while selected diagram background or showing scenarios
No.
Name
Description
Scenarios
Scenarios are the definitions of how to execute a business process during simulation. A scenario 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 in which 10 clients need to perform body checking in a
business process of body checking, to see whether the process can handle this situation well, you will add an
scenario Performing body check, with 10 as number of instances.
Add scenarios
Click this button to add an scenario with name and number of instances.
Remove scenario
Total cases
Path
The flow objects involved in a scenario. If there is a gateway in your diagram, you need to make a decision to
the outgoing path of the gateway object.
Highlight in diagram
Check this button to make the diagram highlight the path involved in the scenario selected in Scenarios
table.
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.
Click to add an available resource by giving its name, selecting/entering its type and setting its amount.
Description of Simulation Control Panel while selected diagram background or showing scenarios
P. 1144
When simulating
Name
Description
Pause
Stop
Clock
Display 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 it is based on the selection of time scale.
Scenarios
A list of scenarios 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 will
become 0 at the end of simulation.
Resources A 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.
Results
A list of completed scenarios. The Instances column shows the amount of completed scenarios.
Description of Simulation Control Panel while simulating
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1145
Right click on the background of the business process diagram that you want simulate and select Diagram Type > Simulation from the popup
menu.
In the Simulation 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 Process
Simulation?.
For each of the flow objects, select it in diagram and click Add under Required Resources in Simulation Control Panel to add the resource(s)
the participant needed to complete the job when reaching the selected flow object.
For each of the flow objects, select it in diagram and set in Simulation 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 Process Simulation?.
P. 1146
For each lane and pool (without lane), select it in diagram and set its instance in Simulation Control Panel which represents the number of
participants that take part in the process.
Click on the background of diagram or click Show Scenarios in Simulation Control Panel.
7.
Click Add under Scenarios in Simulation Control Panel to add the paths to be executed during simulation. For each scenario, set the name
that describe the path and the number of instances for the number of copies of the path to execute.
To add scenario
8.
Start simulation
Now, you can watch the simulation in diagram, to see the executions of scenarios and identify bottlenecks.
P. 1147
Simulation is running
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1148
Simulation charts
Sometimes, just by watching the Simulation outcome is not enough to find out the bottleneck, especially when the diagram is large and have many,
many bottlenecks. In such cases, you can produce charts for Simulation outcome, which helps quantify resource consumption and queuing time for
each flow object.
To read the charts, click Simulation Charts in Simulation Control Panel.
Completion chart
The completion chart primarily shows the status of scenarios completion against time.
Name
Description
Resource usage
Queue time
Time Cost
Time scale
Auto refresh
Check to let the chart body auto update against chart settings such as time scale and selection of scenarios.
Uncheck to update manually by clicking Refresh.
Refresh
Click to update the chart body against the chart settings such as time scale and selection of scenarios. This
button is available only when Auto Refresh is unchecked.
Check or uncheck the scenarios to show or hide in chart the change of the amount of not-yet-started
scenarios throughout simulation.
10 Processing scenarios
Check or uncheck the scenarios to show or hide in chart the change of the amount of processing scenarios
throughout simulation.
11 Completed scenarios
Check or uncheck the scenarios to show or hide in chart the change of the amount of completed scenarios
throughout simulation.
12 Chart body
Simulation charts
P. 1149
13 Export
14 OK
Click to close the Simulation charts window and go back to the diagram.
Description of completion chart
Name
Description
Complete
Queue time
Time Cost
Show by
Time scale
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.
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.
10 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.
11 Resource types
Check or uncheck the resource types to show or hide their usage in chart. This pane is active only when Resource
Type is selected in the drop down menu Show By.
12 Chart body
13 Export
Simulation charts
P. 1150
14 OK
Click to close the Simulation charts window and go back to the diagram.
Description of resource usage chart
Name
Description
Completion
Resource usage
Time Cost
Time scale
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.
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.
Nodes
Check or uncheck flow objects nodes to show or hide their queue time in chart.
10 Chart body
11 Export
12 OK
Click to close the simulacian charts window and go back to the diagram.
Description of queue time chart
Simulation charts
P. 1151
Name
Description
Completion
Resource usage
Queue Time
Time Cost
Auto refresh
Check to let the chart body auto update against chart settings such as time scale and selection of scenarios. Uncheck to
update manually by clicking Refresh.
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.
Nodes
Check or uncheck flow objects nodes to show or hide their queue time in chart.
Chart body
10 Export
11 OK
Click to close the Simulation charts window and go back to the diagram.
Description of queue time chart
Simulation charts
P. 1152
Name
Description
Completion
Resource Usage
Queue Time
Time Cost
Auto refresh
Check to let the chart body auto update against chart settings such as time scale and selection of scenarios.
Uncheck to update manually by clicking Refresh.
Refresh
Click to update the chart body against the chart settings such as time scale and selection of scenarios. This button is
available only when Auto Refresh is unchecked.
Nodes
Check or uncheck flow objects nodes to show or hide their cost per scenario in chart.
Chart body
10 Export
11 OK
Click to close the Simulation charts window and go back to the diagram.
Description of cost per flow object chart
Simulation charts
P. 1153
Name
Description
Completion
Resource Usage
Queue Time
Time Scale
Auto refresh
Check to let the chart body auto update against chart settings such as time scale and selection of scenarios.
Uncheck to update manually by clicking Refresh.
Refresh
Click to update the chart body against the chart settings such as time scale and selection of scenarios. This button is
available only when Auto Refresh is unchecked.
Nodes
Check or uncheck flow objects nodes to show or hide their cost per scenario in chart.
10 Chart body
11 Export
12 OK
Click to close the Simulation charts window and go back to the diagram.
Description of cost per flow object chart
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Simulation charts
P. 1154
Eclipse Integration
Overview and Installation of Eclipse Integration
Know how Visual Paradigm can work with Eclipse through Eclipse integration. Learn how to install the integration from Visual Paradigm.
Eclipse Integration
P. 1155
Installation
First of all, please make sure you have Eclipse 3.5 or above available. To install Eclipse Integration from Visual Paradigm:
1.
In Visual Paradigm, select Windows > Integration > IDE Integration... from the toolbar.
2.
Select Eclipse. You can run Visual Paradigm in multiple IDEs. In other words, if you need you can select multiple IDEs here. Click Next.
Specify the folder path of Eclipse. Click Next to start copying files to your IDE.
Path of Eclipse
NOTE:
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1156
Right click on the project and select Open Visual Paradigm from the popup menu.
Select from the Project Structure window the location of the Visual Paradigm project is to be saved. The Visual Paradigm project with .vpp
extension is the UML project file that is going to be associated with the selected Eclipse project file. Select Create in default path will save the
UML project to %Eclipse_Project_Directory%/vpproject while selecting Create at external location require you to specify the project path
you desire. If you want to create in default path for all projects, check Create in default path and Remember my decision.
Click OK.
Right click on the project and select Visual Paradigm Project > Import Visual Paradigm Project... from the popup menu.
P. 1157
Specify the path of source .vpp project as well as the location of the imported project file is to be saved. Select Create in default path will save
the UML project to %Eclipse_Project_Directory%/vpproject while selecting Create at external location require you to specify the project
path you desire. If you want to create in default path for all projects, check Create in default path and Remember my decision.
Click OK.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1158
Right click on the project and select Open Visual Paradigm from the popup menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1159
Update UML package and its containing classes from a package folder
P. 1160
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1161
Click
in Eclipse toolbar.
Click
Right click on the root node of Diagram Navigator and select Update Project to Code from the popup menu.
Right click on the package in any diagram and select Update to Code from the popup menu.
Right click on the package under Diagram Navigator/Model Explorer/Class Repository and select Update to Code from the popup menu.
P. 1162
Right click on the class in any diagram and select Update to Code from the popup menu.
Right click on the class under Diagram Navigator/Model Explorer/Class Repository and select Update to Code from the popup menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1163
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1164
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1165
P. 1166
Installation
First of all, please make sure you have Visual Studio 2008 or above installed. To install Visual Studio Integration from Visual Paradigm:
1.
In Visual Paradigm, select Windows > Integration > IDE Integration... from the toolbar.
2.
Select Visual Studio. You can run Visual Paradigm in multiple IDEs. In other words, if you need you can select multiple IDEs here. Click Next.
Select the version of Visual Studio to integrate with. Click Next to start copying files to your IDE.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1167
Right click on the project and select Open Visual Paradigm from the popup menu.
Select from the Project Structure window the location of the Visual Paradigm project is to be saved. The Visual Paradigm project, with .vpp
extension is the UML project file that is going to be associated with the selected Visual Studio project file. Select Create in default path will
save the UML project to %Visual Studio _Project_Directory%/vpproject while selecting Create at external location require you to specify
the project path you desire. If you want to create in default path for all projects, check Create in default path and Remember my decision.
Click OK.
Right click on the project and select Visual Paradigm Project > Import Visual Paradigm Project... from the popup menu.
P. 1168
Specify the path of source .vpp project as well as the location of the imported project file is to be saved. Select Create in default path will save
the UML project to %Visual Studio _Project_Directory%/vpproject while selecting Create at external location require you to specify the
project path you desire. If you want to create in default path for all projects, check Create in default path and Remember my decision.
Click OK.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1169
Right click on the project and select Open Visual Paradigm from the popup menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1170
Update UML package and its containing classes from a namespace folder
P. 1171
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1172
Click
Right click on the root node of Diagram Navigator and select Update All to Code from the popup menu.
Right click on the package in any diagram and select Update to Code from the popup menu.
Right click on the package under Diagram Navigator/Model Explorer/Class Repository and select Update to Code from the popup menu.
Right click on the class in any diagram and select Update to Code from the popup menu.
P. 1173
Right click on the class under Diagram Navigator/Model Explorer/Class Repository and select Update to Code from the popup menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1174
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1175
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1176
NetBeans Integration
Overview and Installation of NetBeans Integration
Know how VP-UML can work with NetBeans through NetBeans integration. Learn how to install the integration from Visual Paradigm.
NetBeans Integration
P. 1177
Installation
First of all, please make sure you have NetBeans 6.7 or above available. To install NetBeans Integration from Visual Paradigm:
1.
In Visual Paradigm, select Windows > Integration > IDE Integration... from the toolbar.
2.
Select NetBeans. You can run Visual Paradigm in multiple IDEs. In other words, if you need you can select multiple IDEs here. Click Next.
Specify the folder path of NetBeans. Click Next to start copying files to your IDE.
Path of NetBeans
NOTE:
NOTE:
If you cannot find any Visual Paradigm menus in NetBeans after the installation, it could be due to our plug-in failed to be recognized by
NetBeans. To solve this problem, please deactivate any plug-in in NetBeans and restart NetBeans.
You can manage plug-in in NetBeans by selecting Tools > Plugin in NetBeans.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1178
P. 1179
Right click on the project and select Open Visual Paradigm EE from the popup menu.
Select from the Project Structure window the location of the Visual Paradigm project is to be saved. The Visual Paradigm project, with .vpp
extension, is the UML project file that is going to be associated with the selected NetBeans project file. Select Create in default path will save
the UML project to %NetBeans_Project_Directory%/vpproject while selecting Create at external location require you to specify the project
path you desire. If you want to create in default path for all projects, check Create in default path and Remember my decision.
Click OK.
Right click on the project and select Visual Paradigm EE > Import Visual Paradigm EE Project... from the popup menu.
P. 1180
Specify the path of source .vpp project as well as the location of the imported project file is to be saved. Select Create in default path will save
the UML project to %NetBeans_Project_Directory%/vpproject while selecting Create at external location require you to specify the project
path you desire. If you want to create in default path for all projects check Create in default path and Remember my decision.
Click OK.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1181
Right click on the project and select Open Visual Paradigm EE from the popup menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1182
Update UML package and its containing classes from a package folder
P. 1183
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1184
Click
in NetBeans toolbar.
Click
Right click on the root node of Diagram Navigator and select Update Project to Code from the popup menu.
Right click on the package in any diagram and select Update to Code from the popup menu.
Right click on the package under Diagram Navigator/Model Explorer/Class Repository and select Update to Code from the popup menu.
Right click on the class in any diagram and select Update to Code from the popup menu.
P. 1185
Right click on the class under Diagram Navigator/Model Explorer/Class Repository and select Update to Code from the popup menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1186
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1187
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1188
P. 1189
Installation
First of all, please make sure you have IntelliJ IDEA 11.0 or above available. To install IntelliJ IDEA Integration from Visual Paradigm:
1.
In Visual Paradigm, select Windows > Integration > IDE Integration... from the toolbar.
2.
Select IntelliJ IDEA. You can run Visual Paradigm in multiple IDEs. In other words, if you need you can select multiple IDEs here. Click Next.
Specify the folder path of IntelliJ IDEA. Click Next to start copying files to your IDE.
NOTE:
IntelliJ IDEA integration can only be installed on one IntelliJ IDEA directory only.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1190
Right click on the project and select Visual Paradigm EE > Open Visual Paradigm EE from the popup menu.
Select from the Project Structure window the location of the Visual Paradigm project is to be saved. The Visual Paradigm project, with .vpp
extension, is the UML project file that is going to be associated with the selected IntelliJ IDEA project file. Select Create in default path will
save the UML project to %IntelliJ IDEA _Project_Directory%/vpproject while selecting Create at external location require you to specify the
project path you desire. If you want to create in default path for all projects, check Create in default path and Remember my decision.
Click OK.
Right click on the project and select Visual Paradigm EE > Visual Paradigm EE Project > Import Visual Paradigm EE Project... from the
popup menu.
P. 1191
Specify the path of source .vpp project as well as the location of the imported project file is to be saved. Select Create in default path will save
the UML project to %IntelliJ IDEA _Project_Directory%/vpproject while selecting Create at external location requires you to specify the
project path you desire. If you want to create in default path for all projects, check Create in default path and Remember my decision.
Click OK.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1192
Right click on the project and select Visual Paradigm EE > Open Visual Paradigm EE from the popup menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1193
_
Update UML package and its containing classes from a package folder
P. 1194
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1195
Click
Click
Right click on the root node of Diagram Navigator and select Update Project to Code from the popup menu.
Right click on the package in any diagram and select Update to Code from the popup menu.
Right click on the package under Diagram Navigator/Model Explorer/Class Repository and select Update to Code from the popup menu.
P. 1196
Right click on the class in any diagram and select Update to Code from the popup menu.
Right click on the class under Diagram Navigator/Model Explorer/Class Repository and select Update to Code from the popup menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1197
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1198
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1199
Exporting XML
Shows you how to export project data to XML file.
Importing XML
Shows you how to import XML to an opening project.
P. 1200
Exporting XML
Interoperability is the ability to exchange information between two systems and to use the information that has been exchanged. Visual Paradigm
supports interoperability with XML file. You can export project data to an XML, manipulate it externally, and feed the changes back to Visual Paradigm.
In this chapter, you will see how to export XML file of whole project or specific diagram in project.
Exporting whole project to XML
1.
Select Project > Export > XML... from the toolbar.
2.
3.
Check Export project to export everything in the project to XML or keep it unchecked and check the diagram(s) to export only their content.
4.
Click Export. Upon finishing, you can visit the output destination specified to obtain the XML.
In the Export to XML window, specify the output destination which is a folder for containing the exported XML files and optionally the image files
of diagrams.
3.
Click Export.
Name
Description
Output destination
XML structure
Export project
By selecting Export sub-diagrams when export parent, the sub-diagram(s) will also be
exported when the parent diagram(s) is exported.
For example, package MyWorks contains diagrams A and B. If you select to export
diagram A, its parent "MyWork" will get exported, too. With the option Export sub-
Exporting XML
P. 1201
diagrams when export parent on, B will get exported too since B is a sub-diagram of
package MyWorks. By turning off the option, B will be ignored when export.
5
Diagram list
Model elements
A list of model elements of your project. Select the model elements to export to XML.
Preview window
By checking the selected diagram and Show preview, it will be shown in preview window.
Preview mode
You can choose either Stretch or Real size to preview your diagram.
Stretch: The ratio of your diagram will be fit in the size of preview window.
Real size: The ratio of your diagram will be shown on the preview window as its real size.
When checked, image file of the selected diagrams will also be exported along with the
exported XML.
10 Export
11 Cancel
In the console, change directory to the scripts folder and execute ExportXML with parameters required.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-out
C:\Demo\Output
-diagram
-noimage
N/A
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Exporting XML
P. 1202
Importing XML
You can import changes made externally in XML back to Visual Paradigm, to update the project data. In this chapter, you will see how to import an
XML exported before. Notice that XML import is made in response to XML export in Visual Paradigm. Only XML exported from Visual Paradigm can be
imported.
Importing XML to current project
1.
Select Project > Import > XML... from the toolbar.
2.
3.
Click OK.
NOTE:
All changes made in project will be overwritten by data in XML. For example, if class Foo is renamed to Bar. By importing an XML
exported before renaming class, Bar will be renamed to Foo.
In the console, change directory to the scripts folder and execute ImportXML with the parameters required.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-file
C:\Demo\input\sample.xml
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Importing XML
P. 1203
Exporting VP project
Shows you how to export project data to project file.
Importing VP project
Shows you how to import project file to an opening project.
P. 1204
Exporting VP project
Interoperability is the ability to exchange information between two systems and to use the information that has been exchanged. Visual Paradigm
supports interoperability with native .vpp project file. You can export some of the diagrams to a project file, send to your team member for editing and
feed the changes back to Visual Paradigm. In this chapter, you will see how to export project file for diagrams in project. To export VP project:
1.
Select Project > Export > Visual Paradigm Project... from the toolbar.
2.
3.
Check in the diagram tree the diagrams to export. If you want to export the whole project, check the top most root node.
4.
Click Export button. Upon finishing, you can visit the output destination specified to obtain the .vpp project file.
Name
Description
Output destination
Preview window
By checking the selected diagram and Show preview, it will be shown in preview window.
Preview mode
You can choose either Stretch or Real size to preview your diagram.
Stretch: The ratio of your diagram will be fit in the size of preview window.
Real size: The ratio of your diagram will be shown on the preview window as its real size.
Export
Cancel
Help
More information about how to export VP Project can be obtained by clicking this button.
Description of Export Project dialog box
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Exporting VP project
P. 1205
Importing VP project
You can import a VP project to Visual Paradigm for importing changes made in an exported project, or to import model in another project. In this
chapter, you will see how to import a VP project. To import a project:
1.
Select Project > Import > Visual Paradigm Project... from the toolbar.
2.
Select the file path of the .vpp file to import in file chooser.
3.
Click Open.
NOTE:
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Importing VP project
P. 1206
P. 1207
2.
3.
4.
On the Model Types list at the right hand side, you can optionally select the type(s) of model elements to be exported.
5.
Click Export. Upon finishing, you can visit the output destination specified to obtain the Excel file.
P. 1208
No.
Field
Description
Output Path
Launch Editor
Export Style
Tagged values can be added to model elements to specify domain specific properties. You can add tagged values in
the specification dialog box of model element. Check Export Tagged Values if you want to export tagged values of
model elements.
Export Comments
You can add your own comments to model elements in their specification dialog box. Check Export Comments if
you want to export the comments to the Excel file.
Export PM Properties
PM properties is the short form of project management properties. You can set project management properties, such
as version, phrase, author, in the specification dialog box of a model element. Check Export PM Properties if you
want to export PM properties of model elements.
Test plan refers to the test plans that can be specified for Test Case elements in requirement diagram. Check
Export Test Plans to export the information of test plan to a separate sheet in Excel file.
You can specify the table records of entities created in ERDs. Check Export Table Records to export these table
records.
Model Elements
Select this tab and check the model elements you want to export to Excel.
10 Diagrams
All diagrams in the opening project are listed here. Select the diagrams to export to Excel.
11 Model Types
Check or uncheck model types to include and exclude the types of model elements in exporting.
12 Model Types
When you have updated the diagram selection in Diagrams list, the Model Types list will be updated to list the
types of diagram elements that appear in the chosen diagrams. By default, all diagram element types are checked,
meaning that diagram elements in those types will be exported to Excel. You can uncheck type(s) to ignore certain
type(s) of diagram elements when exporting.
13 Export
14 Cancel
In the console, change directory to the scripts folder and execute ExportExcel with parameters required.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-out
C:\Demo\Output\Sample.xlsx
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1209
P. 1210
In the file chooser, select the Excel file to import and click Open to confirm.
3.
In the Import dialog box, you can preview the changes you have made in the previous Excel file. If you want to keep a record of changes, click
on Save Details... at the bottom of dialog box to export the changes to an Excel file.
Import window
4.
In the console, change directory to the scripts folder and execute ImportExcel with the parameters required.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-file
C:\Demo\input\sample.xlsx
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1211
Do NOT just delete a row for deleting a model element. Instead, change the value No to Yes under the Delete? column.
P. 1212
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1213
Exporting XML
Shows you how to export project data to XMI file.
Importing XML
Shows you how to import XMI to an opening project.
P. 1214
Exporting XMI
Interoperability is the ability to exchange information between two systems and to use the information that has been exchanged. Visual Paradigm
supports interoperability with XMI file, a standard made for data exchange. You can export project data to an XMI, edit it externally with other softwares
that accepts XMI. In this chapter, you will see how to export XMI file.
Exporting project to XMI
1.
Select Project > Export > XMI... from the toolbar.
This displays the Export XMI dialog box.
2.
3.
Configure the exporting such as setting the XMI version and changing the encoding of XMI.
4.
Click OK button to start exporting. Upon finishing, you can visit the output destination specified to obtain the XMI.
Name
Description
File path
XMI version
There are three versions of XMI to suit different interoperability needs, including 1.0, 1.2 and
2.1. If the latest version 2.1 is selected, the following options are then available for selection:
Exporting XMI
P. 1215
Export Data Type to - Determine whether to export data type to UML or Ecore
primitive type
Encoding
In the console, change directory to the scripts folder and execute ExportXMI with the parameters required.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-out
C:\Demo\Output\sample.xmi
-type [optional]
1.0
2.1
-encoding [optional]
1.2
2.1
2.1UML2
UTF-8
Parameters for ExportXMI
Upon finishing, you can visit the output destination specified to obtain the XMI.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Exporting XMI
P. 1216
Importing XMI
You can migrate your works done in another software to Visual Paradigm through XMI, provided that the software supports XMI. In this chapter, you
will see how to import an XMI file.
Importing XMI to current project
1.
Select Project > Import > XMI... from the toolbar.
This displays the Import XMI dialog box.
2.
Specify the file path of the XMI to import and configure the import if necessary.
3.
Click OK.
NOTE:
All changes made in project will be overwritten by data in XMI. For example, if class Foo is renamed to Bar. By importing an XMI
exported before renaming class, Bar will be renamed to Foo.
Name
Description
File path
Matching
Fully follow import XMI (will prompt to delete model elements not in XMI file)
Import
Importing XMI
P. 1217
Cancel
10 Help
In the console, change directory to the scripts folder and execute ImportXMI with the parameters required.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-file
C:\Demo\input\sample.xmi
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Importing XMI
P. 1218
P. 1219
3.
Click OK button to start exporting. Upon finishing, you can visit the output destination specified to obtain the BPMN.
Name
Description
File path
Project specific content refers to contents that do not belong to BPMN. For example,
project management properties.
Encoding
Diagram
Preview
By checking the selected diagram and Show preview, it will be shown in preview
window.
Export
Cancel
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1220
3.
Click OK.
NOTE:
All changes made in project will be overwritten by data in XML. For example, if task Foo is renamed to Bar. By importing an XML
exported before renaming task, Bar will be renamed to Foo.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1221
P. 1222
2.
To import a Visio drawing into Visual Paradigm, select Project > Import > Visio... in the toolbar of Visual Paradigm.
3.
4.
Click OK to start importing. This popup another Import Visio dialog box. As the model structure is different among Visio and Visual Paradigm,
this dialog enables users to resolve inconsistency between Visio and Visual Paradigm.
Click on the button beside the shape node and select Not Import in the popup menu.
Click on the button beside the shape node and select Rename in the popup menu. Then,
enter the new name of shape and press the Enter key to confirm renaming/.
Click on the button beside the shape node and select an appropriate shape type to reset to.
Description of available import options on individual shape
5.
Click OK when the import is configured. The drawings can then be accessible in the Diagram Navigator. You can then double click on the
diagram node to open the diagram.
Name
Description
P. 1223
File path
By selecting this option, colors and fonts of the shapes to be imported will remain unchanged. Otherwise, Visual
Paradigm's default settings will be applied.
By selecting this option, shapes' size will be optimized to their minimum possible size. Otherwise, the original size
of the imported shapes will remain unchanged.
OK
Click to import.
Cancel
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1224
P. 1225
A Rose drawing
2.
To import a Rose model into Visual Paradigm, select Project > Import > Rose Project... in the toolbar of Visual Paradigm.
3.
Name
Description
File path
Import mode
Create Model
OK
Click to import.
Cancel
Help
4.
5.
When import is completed, select View > Project Browser in the toolbar. The Diagrams view lists the imported diagram(s). You can then
double click on the thumnail to open the diagram. .
P. 1226
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1227
P. 1228
A Rational drawing
2.
To import a Rational model into Visual Paradigm, select Project > Import > Rational Model... in the toolbar of Visual Paradigm.
3.
In the Import Rational Software Architect UML Model dialog box, specify the file path of the .emx file and click OK.
4.
Select View > Project Browser in the toolbar. The Diagrams view lists the imported diagram(s). You can then double click on the thumnail to
open the diagram.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1229
A Rational drawing
2.
To import the drawing into Visual Paradigm, select Project > Import > Rational DNX... in the toolbar of Visual Paradigm.
3.
In the Import Rational Diagram DNX dialog box, specify the file path of the .dnx file and click OK.
4.
After importing is completed, select View > Project Browser in the toolbar. The Diagrams view lists the imported diagram(s). You can then
double click on the thumnail to open the diagram.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1230
P. 1231
Here is a ERwin Data Modeler Project. In order to allow Visual Paradigm to import it, you need to save it as an XML file. Select File > Save As...
from the menu.
Select XML Files (*.xml) in Save as type and enter the file name in the Save As dialog box.
Click Save. This popup the Save as XML File dialog box.
4.
Keep using the default settings Standard XML Format and Only save minimum amount of information.
P. 1232
Click OK to confirm. This saves an XML file that can be used for importing into Visual Paradigm.
6.
To import an ERwin Data Modeler project into Visual Paradigm, select Project > Import > ERwin Project(XML)... in the toolbar of Visual
Paradigm.
7.
8.
Click OK to start importing. When import is completed, the Open Imported Entity Relationship Diagram(s) dialog box will appear.
9.
Select the diagram(s) to open and click Open to open them. The drawings will then be opened.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1233
P. 1234
To import a Rational Phapsody project into Visual Paradigm, select Project > Import > Rational Rhapsody Project ... in the toolbar of Visual
Paradigm.
3.
Specify the file path of the Rational Rhapsody Project in the pop-up Import Rhapsody dialog box.
4.
Click OK button when the import is configured. Select View > Project Browser in the toolbar. The Diagrams view lists the imported
diagram(s). You can then double click on the thumnail to open the diagram.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1235
To import a Rational System Architect project into Visual Paradigm, select Project > Import > Rational System Architect ... in the toolbar of
Visual Paradigm.
3.
Name
Description
File path
By selecting this option, colors and fonts of the shapes to be imported will remain unchanged.
Otherwise, Visual Paradigm's default settings will be applied.
By selecting this option, shapes' size will be optimized to their possible minimum size. Otherwise, the
original size of the imported shapes will remain unchanged.
OK
Cancel
4.
Click OK to start importing. When import is completed, the message pane will popup with a notification appear in it. Select View > Project
Browser in the toolbar. The Diagrams view lists the imported diagram(s). You can then double click on the thumnail to open the diagram.
P. 1236
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1237
P. 1238
3.
Click OK to start importing. When import is completed, the message pane will pop up with a notification. The drawings can then be accessible in
the Diagram Navigator. You can then double click on the diagram node to open the diagram.
NOTE:
Due to different ways in presenting diagrams in Visual Paradigm and NetBeans, the imported shapes may be bigger than normal.
To fit a shape's size, move the mouse cover over it and press on the resource icon
at the bottom right of shape.
To fit size for all shapes, right click on the diagram background and select Diagram Content > Auto Fit Shapes Size
in the popup menu.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
P. 1239
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1240
Importing Bizagi
You can import your previous work drawn in Bizagi to Visual Paradigm through the import feature, and continue modeling in Visual Paradigm. This
chapter shows you how to do.
Importing Bizagi
Outlines the steps involved in importing a Bizagi project.
Importing Bizagi
P. 1241
Importing Bizagi
Bizagi is one of the BPM softwares in the market. Since Visual Paradigm is compartible with Bizagi, you can import its .bpm file in Visual Paradigm.
Importing Bizagi is as simple as migrating the work from Bizagi to Visual Paradigm. You can perform further modeling on the imported models in Visual
Paradigm when necessary.
1.
A Bizagi drawing
2.
To import a Bizagi project into Visual Paradigm, select Project > Import > Bizagi ... from the toolbar.
3.
4.
5.
It will notify you that your Bizagi drawing is imported successfully in Message pane.
6.
Select View > Project Browser in the toolbar. The Diagrams view lists the imported diagram(s). You can then double click on the thumnail to
open the diagram.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Importing Bizagi
P. 1242
P. 1243
Select Project > Export > Active Diagram as Image... from toolbar.
2.
In the Save window, set the image quality. The higher the quality, the clearer the image, the larger the image size.
There are two options for exporting as PNG files - with and without background:
- With background: export diagram's background color.
- Without background: ignore the background color by exporting transparent background.
NOTE:
You can export diagrams to native PDF format. Since the exported PDF is of a small size, it can save a lot of space.
Also, because the diagram in PDF is a vector, it is scalable. There are two export options:
- PDF(diagram per page): selected diagrams will be exported to the same PDF file. Each diagram will occupy one page.
- PDF(diagram per file): each diagram will be exported in one new PDF file.
4.
5.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1244
3.
4.
Name
Description
Output destination
The Output destination is the directory where all the exported images are saved to. You can enter
the path in the text field directly or you can click on the ... button to browse for the directory.
Export type
To select the image format of the exported image, click on the pull-down box beside the Export type
field and select the format you want to use.
There are two options for exporting as PNG files - with and without background. With background will
export diagram's background color. Without diagram will ignore the background color by exporting
transparent background.
You can export Visual Paradigm diagram to native PDF format. Since the exported PDF is of a small
size, it can save a lot of space. Also, because the diagram in PDF is a vector, it is scalable. There are
two different options when you export. For PDF (diagram per page), all the diagrams selected will be
exported in the same PDF file. Each diagram will occupy one page. For PDF (diagram per file), each
diagram selected will be exported in one new PDF file.
Quality
The quality of image. By applying a higher quality, the images will be clearer but larger in file size. By
applying a lower quality, the images will look more blur but smaller in file size.
You can check the Auto overwrite existing files checkbox to allow overwriting of files in the export
process.
Diagrams
The Diagrams pane shows the diagrams in the current project. Check the checkbox beside the
diagram you want to export. The number of selected diagrams is displayed at the bottom of the
P. 1245
Diagram pane. The Preview pane also allows you to preview the exported image of the selected
diagram.
6
Show preview
Preview
The Preview pane shows the preview of the exported image of the selected diagram in the Diagrams
pane.
Preview mode
Select the size of the preview image by selecting from the pull-down box beside the Preview mode
field. Selecting Stretch will show the image in scaled size that fits to the preview area, while selecting
Real size will show the image in its actual size.
Diagram slicer
Click to configure how diagram is sliced into pieces. This is enabled only when the check box for Slice
Diagrams (for slicing all diagrams) is unchecked. For details about slicing diagrams, please refer to the
following section.
10 Graphics Anti-aliasing
Anti-aliasing is a method which handles the staircase pixels of slanted lines and curves to make them
look smoother. You can apply anti-aliasing to the exported images. To apply anti-aliasing to graphics,
check the Graphics Anti-aliasing checkbox .
11 Text Anti-aliasing
Anti-aliasing is a method which handles the staircase pixels of slanted lines and curves to make them
look smoother. You can apply anti-aliasing to the exported images. To apply anti-aliasing to text, check
the Text Anti-aliasing checkbox.
12 Max. Size
Maximum size of exported images. If the diagram size is larger than the maximum size, it will be
resized.
13 Slice Diagrams
Enable it to slice all diagrams into pieces to obtain multiple image files for a single diagram. For details,
please refer to the following section.
A frame is a border that prints around a diagram. By selecting None, frame won't be printed. By
selecting Export with frame, a frame will be added to exported images, making the diagram name
show at the top left of diagram. By selecting Export with border, a black and thin border will be added
to exported images.
16 Export
17 Cancel
18 Help
The way how diagram is sliced can be set per diagram or to all diagrams. To slice a diagram, click on the slice button right under the diagram preview
in the Diagram Exporter window. To slice all diagrams, enable Slice Diagrams and click on Slice All Diagrams button. Both ways open the Diagram
Slicer for configuring how diagram(s) is to be sliced.
P. 1246
Name
Description
No slicing
Fixed size
A simple strategy which slice exported diagram into pieces that have the same size.
Free slicing
User can customize how to slice the exported diagram by specifying the position of vertical slices and horizontal slices.
Fixed ratio
User can customize how to slice the exported diagram by specifying the position of vertical slices and horizontal slices.
Add row
Add column
Remove row
Remove column
Rows
10 Columns
11 Zoom in
12 Zoom out
14 Show label
15 Scale
The way of scaling. When configuring slicing for all diagrams, this part will not be displayed.
16 Width
17 Height
18 Ruler
Shows the size of the diagram. When the slicing strategy Free Slicing is selected, a new row and column can be
created by dragging a new one from the ruler.
19 Slice line
Lines that divide the diagram into pieces. The show the vertical and horizontal position that the diagram will be sliced
at. When Free Slicing or Fixed Ratio is selected, the lines can be dragged and moved.
P. 1247
20 Index label
Shows the index of the pieces. This index will be printed on the exported file as well.
21 Diagram
22 Total pieces
23 OK
24 Cancel
Slicing strategies
There are three slicing strategies - Fixed Size, Free Slicing and Fixed Ratio. Each gives a distinct way of slicing images.
Fixed size
Fixed Size is a simple strategy which slice exported diagram into pieces that have the same size. User specifies the number of columns and rows to
slice and then the exported diagram will be sliced into specific pieces.
Fixed Size
Free slicing
User can customize how to slice the exported diagram by specifying the position of vertical slices and horizontal slices. It is particularly useful to
prevent a shape from being sliced into pieces.
Free Slicing
Fixed ratio
Fixed Ratio strategy gains the benefit of Fixed Slice and Free Slicing. The width and height of pieces are the same but last row and column.
User can also customize the width and height of sliced pieces. Like Free Slicing, Fixed Ratio is size oriented. User modifies the size of pieces and
Diagram Slicer calculates the number of row and column to slice.
P. 1248
Fixed Ratio
Controlling size of exported image
Diagram Slicer not only slice diagram into pieces but also controls the total size of the exported diagrams. There are scale controls on the right of
the toolbar from the Diagram Slicer dialog. By default, the type of scale is Original. And it shows the size of diagram. The following are some of the
possible ways of controlling diagram size.
Control by size
To control the total size of the exported diagram by specific width and height, select Size from the Scale combo box and then enter the width and
height of the diagram. The ruler shows the size of the diagram.
Control by ratio
To control the total size of the exported diagram by specific ratio, select Ratio from the Scale combo box and enter the ratio in the field next to the
combo box. The total size of the exported diagram shows next to that field.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1249
3.
In the Save dialog box, set the image quality. The higher the quality, the clearer the image, the larger the image size.
There are two options for exporting as PNG files - with and without background:
- With background: export diagram's background color.
- Without background: ignore the background color by exporting transparent background.
NOTE:
You can export diagrams to native PDF format. Since the exported PDF is of a small size, it can save a lot of space.
Also, because the diagram in PDF is a vector, it is scalable. There are two export options:
- PDF(diagram per page): selected diagrams will be exported to the same PDF file. Each diagram will occupy one page.
- PDF(diagram per file): each diagram will be exported in one new PDF file.
5.
6.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1250
Implementing plugin
Detailed information about how to implement (code) a plugin will be covered.
Deploying plugin
Shows you how to deploy a plugin to Visual Paradigm.
P. 1251
Diagram
Diagram is contains diagram elements on different domain (such as Use Case Diagram, Class Diagram, ERD, etc...).
Plugin allows developer to create, retrieve, update and delete diagrams through the popup menu context or through the project (by iterating diagrams
within a project)
Diagram element
A model element does not contain information of appearance (such as x, y, width, height, etc...). It is the diagram element, which appear on the
user interface, that owns the appearance data. Diagram Element represents a view of a model element. A model element can be shown on different
diagrams (such as a class can be shown on 2 different class diagrams).
There are 2 kinds of diagram element: Shape and Connector. Shape represents the non-relationships diagram element (such as Class). Connector
represents the relationships (such as Generalization). Plugin allows developer to create, retrieve, update and delete diagram elements through the
popup menu context or through the project (to iterate all the diagrams and then the diagram elements appear on a diagram).
P. 1252
Action/Action controller
Action represents buttons and menus (menu, toolbar and popup menu), which contains the information on outlook (such as label, icon, mnemonic,
etc...) and responses to trigger the function call.
Action is used to represent the button on 3 regions: menu/toolbar, popup menu and diagram toolbar
Action Controller is the control (function call) of actions. Developer needs to implement different Action Controller on different region's actions.
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1253
Implementing plugin
Configuring development environment
The plugin API is in %Visual-Paradigm-Install-Dir%/lib/openapi.jar. In order to program a plugin, developer must import the jar into the development
classpaths.
Beginning of plugin.xml
plugin.xml is the base of a plugin, to develop a plugin, you should start from writing the plugin.xml. The basic directory structure is "Visual-ParadigmInstall-DIR/plugins/YOUR_PLUGIN_ID/plugin.xml"
For improving the variability of the plugin.xml, a properties file (plugin.properties) can be used for storing the value of the xml. Developer can assign the
value of the attributes in xml starts with '%', then the value will be read from the properties file. For example
In plugin.xml: <plugin id="sample.plugin name="%plugin.name" .../>
In plugin.properties: plugin.name=sample.plugin
Sample on XML:
< plugin
id= "sample.plugin"
name= "Sample Plugin"
description= "Sample Plugin"
provider= "Visual Paradigm"
class= "sample.plugin.SamplePlugin">
< runtime >
< library path= "lib/sampleplugin.jar" relativePath= "true"/>
</ runtime >
<!-- to be continued -->
</ plugin >
Table shows the description of elements in the plugin.xml.
Element
Attribute
plugin
plugin
Description
The root element of plugin.xml, specify the basic information of the plugin (id,
name, provider, etc...)
class
runtime
library (1..*)
Specify the .jar or directory as the classpaths required on the plugin. Such as
the classes of the plugin and some libraries the plugin required.
library (1..*)
Path
library (1..*)
Description on Code:
VPPlugin (com.vp.plugin.VPPlugin)
This class must be implemented and ref on <plugin class="xxx"... Otherwise, the plugin will not be loaded completely. In fact, the class can do nothing
on it.
The following is the sample code:
package sample.plugin;
public class SamplePlugin implements com.vp.plugin.VPPlugin {
// make sure there is a constructor without any parameters
public void loaded(com.vp.plugin.VPPluginInfo info) {
// called when the plugin is loaded
// developer can get the current plugin's id and the
// current plugin directory (default: %Visual-Paradigm%/plugins)of Visual-Paradigm from the VPPluginInfo.
}
public void unloaded() {
// called when the plugin is unloaded (when Visual Paradigm will be exited)
}
}
Implementing custom action
There are 2 main components for an Action: Action and Action Controller. Action represents the outlook, Action Controller responses to work as
function call. In order to create custom action, developer needs to define the Action on xml, and implement the Action Controller on code.
Sample on XML:
<plugin>
< actionSets>
<!-- to be continued -->
Implementing plugin
P. 1254
</ actionSets>
<!-- to be continued -->
</plugin>
Table shows the description of elements in the above XML.
Element
Attribute
Description
actionSets
There are differences on xml definition and code implementation of the 3 kinds of Actions (menu/toolbar, popup menu, diagram toolbar).
Custom action on menu/Toolbar
Developer can define the menu, menu item, toolbar, toolbar button and etc... on the plugin.xml. In order to trigger the menu item and toolbar button's
function call, Action Controller is required to be implemented and added into the Action. The Action Controller class on menu/toolbar actions is
com.vp.plugin.action.VPActionController.
There are 2 important attributes used on menu, action and separator: menuPath and toolbarPath .
menuPath is the path specified where is the item placed on menu, toolbarPath is the path specified where is the item placed on toolbar. The path is
formed by a set of 'name'. The 'name' is similar with the caption of the menu items (caption in English, ignores the "..." and remind the 'space'). '/' is
used as delimiter of the path. '#' is used to represent the front of the menu. Here, 4 examples will be given:
"label" in XML
"menupath" in XML
Remarks
Tools
Tools
Tools/Document
Tools/Document
Tools/Document/#
Tools/Document/#
Implementing plugin
P. 1255
icon= "icons/red.png"
style= "normal"
menuPath= "Tools/Document"
toolbarPath= "sample.plugin.actions.Toolbar1/#">
< actionController class= "sample.plugin.actions.ActionController"/>
</ action>
< separator
id= "sample.plugin.actions.Separator1"
menuPath= "Tools/sample.plugin.actions.Action1"
toolbarPath= "sample.plugin.actions.Toolbar1/sample.plugin.action.Action1"/>
</ actionSet>
The table shows the description of elements in the above XML.
Element
Attribute
Description
actionSets
toolbar (0..*)
toolbar (0..*)
toolbar (0..*)
menu (0..*)
action (0..*)
action (0..*)
actionController
actionController
separator (0..*)
Description on Code:
VPActionController (com.vp.plugin.action.VPActionController)
This class is used to perform the function call when the action is clicked. One Action Controller class refers to multi Actions is allowed.
Sample:
package sample.plugin.actions;
public class ActionController implements com.vp.plugin.action.VPActionController {
// make sure there is an constructor without any parameters
public void performAction(com.vp.plugin.action.VPAction action) {
// called when the button is clicked, the parameter action represents the Action which be clicked.
// developer also can set the properties of the action
}
public void update(com.vp.plugin.action.VPAction action) {
// *for the actions located on menu bar only
// when the parent menu is selected, this will be called,
// developer can set the properties of the action before it is shown (e.g. enable/disable the menu item)
}
}
Implementing plugin
P. 1256
Developer can define the menu, menu item and separator on the popup menu shown on the diagram. The popup menu on diagram is context sensitive
which based on what diagram element or diagram is selected. In order to make the menu item trigger the function call, Action Controller is required to
be implemented. For popup menu, com.vp.plugin.action.VPContextActionController is the interface required developer to implement.
Same as Action on Menu/Toolbar, menuPath is used to specify the location of the action (menu/menu item on popup menu).
Sample on XML:
< contextSensitiveActionSet id= "sample.plugin.actions.ActionSet2">
< contextTypes all= "false">
< include type="Class"/>
<!-- ignored when contextTypes.all = true -->
< exclude type="Package"/>
<!-- ignored when contextTypes.all = false -->
</ contextTypes>
<action
id= "sample.plugin.actions.ContextAction1"
label= "Sample Action [1]"
icon= "icons/blue.png"
style= "toggle"
menuPath= "OpenSpecification">
< actionController class= "sample.plugin.actions.ContextActionController"/>
</action>
</contextSensitiveActionSet>
Table shows the description of elements in the above XML.
Element
Attribute
Description
contextSensitvieActionSet (0..*)
contextTypes
contextTypes
Include
Include
type
exclude
type
actionController
actionController
class
Description on Code:
VPContextActionController (com.vp.plugin.action.VPContextActionController)
This class is used to perform the function call when the action is clicked. One Action Controller class refers to multi Actions is allowed.
Sample:
package sample.plugin.actions;
import java.awt.event.ActionEvent;
public class ContextActionController implements com.vp.plugin.action.VPContextActionController {
// make sure there is an constructor without any parameters
public void performAction(
com.vp.plugin.action.VPAction action,
Implementing plugin
P. 1257
com.vp.plugin.action.VPContext context,
ActionEvent e
){
// called when the button is clicked
}
public void update(
com.vp.plugin.action.VPAction action,
com.vp.plugin.action.VPContext context
){
// when the popup menu is selected, this will be called,
// developer can set the properties of the action before it is shown (e.g. enable/disable the menu item)
}
}
VPContext ( com.vp.plugin.action.VPContext)
Context will be passed into the Action Controller when the popup menu is shown or action is triggered. It is what the user selected on the diagram, can
be model, diagram element or/and diagram.
A diagram may contain many diagram elements, when user right-click on the diagram element or the diagram, a popup menu will be shown. So, the
context may be diagram element or diagram. However, the diagram element must be contained by diagram, then if popup menu is shown on a diagram
element, the context must contain both diagram element and diagram. And the diagram element always represents for a model, so that is possible the
context contains model, diagram element and diagram as same time. However, sometime, the popup menu is shown for a model only (e.g. select on
an attribute of a class, because there is no diagram element for the attribute, the class's diagram element will be contained in the context).
Custom diagram element (shape and connector)
Developer can define the shape to connect on the specified diagram. But it is not allowed to develop a custom model. ActionSet and Action are used
on definition of custom diagram element.
Sample on XML:
<actionSet id= "sample.plugin.actions.ShapeActionSet">
<action
id= "sample.plugin.actions.ShapeAction1"
actionType= "shapeAction"
label= "Sample Action {1}"
tooltip= "Sample Action {1}"
icon= "icons/yellow.png"
editorToolbarPath= "com.vp.diagram.ClassDiagram/Class">
< shapeCreatorInfo
shapeType= "sample.plugin.shape.Shape1"
defaultWidth= "30"
defaultHeight= "30"
controllerClass= "sample.plugin.actions.ShapeController1"
multilineCaption= "false"
captionStyle= "north"
resizable= "true"/>
</action>
<action
id= "sample.plugin.actions.ConnectorAction1"
actionType= "connectorAction"
label= "Sample Action {2}"
tooltip= "Sample Action {2}"
icon= "icons/green.png"
editorToolbarPath= "com.vp.diagram.ClassDiagram/sample.plugin.actions.ShapeAction1">
<connectorCreatorInfo
shapeType= "sample.plugin.connector.Connector1"
fromArrowHeadStyle= "Arrow1"
toArrowHeadStyle= "Arrow2"
fromArrowHeadSize= "verySmall"
toArrowHeadSize= "large"
dashes= "7,10"
lineWeight= "3"
connectorStyle= "rectilinear">
< connectionRules>
< connectionRule
fromShapeType= "sample.plugin.shape.Shape1"
toShapeType= "sample.plugin.shape.Shape1"
bidirection= "true"/>
< connectionRule
fromShapeType= "Class"
toShapeType= "sample.plugin.shape.Shape1"
bidirection= "true"/>
<connectionRule
fromShapeType= "Package"
toShapeType= "sample.plugin.shape.Shape1"
bidirection= "true"/>
</connectionRules>
</connectorCreatorInfo>
</action>
Implementing plugin
P. 1258
</actionSet>
Table shows the description of elements in the above XML.
Element
Attribute
Action
Description
Action
Action
editorToolbarPath
shapeCreatorInfo
shapeCreatorInfo
shapeType
shapeCreatorInfo
shapeCreatorInfo
controllerClass
connectorCreatorInfo
connectorCreatorInfo
shapeType
connectorCreatorInfo
connectorCreatorInfo
fromArrowHeadStyle (optional)
connectorCreatorInfo
toArrowHeadStyle (optional)
connectorCreatorInfo
connectorCreatorInfo
connectorCreatorInfo
dashes (optional)
connectorCreatorInfo
lineWeight (optional)
connectorRules
It is a collection of connectorRule.
connectorRule (1..*)
Description on Code:
VPShapeController ( com.vp.plugin.diagram.VPShapeController)
Implementing plugin
P. 1259
Developer can use the model element factory ( com.vp.plugin.model.IModelElementFactory) to create the model. Or based on a parent model (
com.vp.plugin.model.IModelElementParent) to create a child model.
IModelElementFactory can be access by IModelElementFactory.instance(). It provides the functions to create all the models.
IModelElementParent is the subclass of IModelElement. It provides the function to create the child into it. If the parent class is more specified, it may
support a more details function to create the child. For example, IClass is subclass of IModelElementParent, it provides createOperation() to create
an operation into it.
Sample on Code:
/*
* create model by IModelElementFactory
* result of the 2 methods: "class model is created and added into the project"
*
// assume in a code segment
IClass classModel1 = IModelElementFactory.instance().createClass();
IClass classModel2 = (IClass) IModelElementFactory.instance().create(IModelElementFactory. MODEL_TYPE_CLASS);
/*
* create model by IModelElementParent
* result of the first 2 methods, "operation model is created and added into the class model"
* result of the last method, "actor model is created and added into project", because actor cannot be the child of class model
*/
// assume in a code segment
IOperation operationModel1 = classModel1.createOperation();
IOperation operationModel2 = (IOperation) classModel1.create(IModelElementFactory. MODEL_TYPE_OPREATION);
IActor actorModel1 = (IActor) classModel1.create(IModelElementFactory. MODEL_TYPE_ACTOR);
Retrieving model
Developer can use the project ( com.vp.plugin.model.IProject) or the context ( com.vp.plugin.action.VPContext) from ActionController to retrieve
the models.
IProject is the project of Visual Paradigm. The project contains all models, diagram and diagram elements. It provides function (
modelElementIterator()) for the developer to iterate the models.
VPContext is the context of a popup menu. Developer can access the context by popup menu's action controller (
com.vp.plugin.action.VPContextActionController). Context may contain a model element if the popup menu is shown on a diagram element or
model.
Sample on Code:
/*
* retrieve model by IProject
*/
// assume in a code segment
IProject project = ApplicationManager.instance().getProjectManager().getProject();
Iterator iter = project.modelElementIterator();
while (iter.hasNext()) {
IModelEmenet modelElement = (IModelElement) iter.next();
// model element retrieved
}
/*
*retrieve model by VPContext
*/
// assume on a sub-class of com.vp.plugin.action.VPContextActionController
Implementing plugin
P. 1260
Developer can call a set of get/set methods on a model. Different model type has different properties. For setting and getting the model's property,
cast the IModelElement into its sub-class is necessary. For example, developer gets the IModelElement from the popup menu's context. Developer
checks whether the model is a IClass, then developer casts the IModelElement into IClass, and call the function IClass.setVisibility(xxx).
Sample on Code:
/*
* update a class model
*/
// assume in a code segment
IModelElement model = ...; // model is retrieved from somewhere
If (IModelElementFactory. MODEL_TYPE_CLASS.equals(model.getModelType()) ) {
IClass classModel = (IClassModel) model;
// set the class to be 'private'
classModel.setVisibility(IClass. VISIBILITY_PRIVATE);
// set super class
IClass superClassModel = ...; // another class model is retrieved, it will be set to be the previous model's super class
IGeneralization generalizationModel = IModelElementFactory.instance().createGeneralization();
generalizationModel.setFrom(superClassModel);
generalizationModel.setTo(classModel);
// get all "setName" operation from the class and set to be "protected final"
Iterator operationIter = classModel.operationIterator();
while (operationIter.hasNext()) {
IOperation operation = (IOperation) operationIter.next();
if ( "setName".equals(operation.getName()) ) {
operation.getJavaDetail( true).setJavaFinal( true);
operation.setVisibility(IOperation. VISIBILITY_PROTECTED);
}
}
}
Deleting model
Developer can delete the model by simple way, just call the IModelElement.delete().
Working with diagrams/Diagram elements
Plugin Support provides interface for the developer to create, retrieve update and delete the diagrams or diagram elements in Visual
Paradigm. The base class of the diagram is co m.vp.plugin.diagram.IDiagramUIModel. The base class of the diagram element is
com.vp.plugin.diagram.DiagramElement. All diagrams are contained in the project ( com.vp.plugin.model.IProject). And the diagram elements can
be found in the diagrams. The diagram elements can be contained by the diagrams.
Creating diagrams/Diagram elements
Developer can create the diagram or diagram element by com.vp.plugin.DiagramManager. DiagramManager can be accessed by
ApplicationManager.instance().getDiagramManager().
Sample on Code:
// assume in a code segment
DiagramManager diagramManager = ApplicationManager.instance().getDiagramManager();
/*
* create diagram
*/
IDiagramUIModel diagram = diagramManager.createDiagram(DiagramManager. DIAGRAM_TYPE_CLASS_DIAGRAM);
Implementing plugin
P. 1261
/*
* create diagram element with exists models
*/
IModelElement classModel1 = ...; // retrieved a class model from somewhere
IModelElement packageModel1 = classModel1.getParent(); // assume the class model is contained by a package
IDiagramElement packageDiagramElement1 = diagramManager.createDiagramElement(diagram, packageModel1);
IDiagramElement classDiagramElement1 = diagramManager.createDiagramElement(diagram, classModel1);
// class's diagram element should be a shape, not a connector
packageDiagramElement1.addChild((IShapeUIModel) classDiagramElement1);
/*
* create diagram element without models (the model will be created automatically)
*/
IDiagramElement newClassDiagramElement =
diagramManager.createDiagramElement(diagram, IClassDiagramUIModel. SHAPETYPE_CLASS);
IModelElement newClassModel = newClassDiagramElement.getModelElement();
/*
* open the created diagram
*/
diagramManager.openDiagram(diagram);
Retrieving diagrams/Diagram elements
Developer can use the project ( com.vp.plugin.model.IProject) to retrieve the diagrams. Use a diagram ( com.vp.plugin.diagram.IDiagramUIModel)
to retrieve the contained diagram elements. Or use the context ( com.vp.plugin.action.VPContext) from ActionController to retrieve the diagram and/
or diagram element.
IProject is the project of Visual Paradigm. The project contains all models, diagram and diagram elements. It provides function ( diagramIterator()) for
the developer to iterate the diagrams.
IDiagramUIModel is a diagram, which may contain many diagram elements.
VPContext is the context of a popup menu. Developer can access the context by popup menu's action controller (
com.vp.plugin.action.VPContextActionController). Context may contain a diagram and/or diagram elements.
Sample on Code:
/*
* retrieve diagram from IProject
*/
// assume in a code segment
IProject project = ApplicationManager.instance().getProjectManager().getProject();
Iterator diagramIter = project.diagramIterator();
while (diagramIter.hasNext()) {
IDiagramUIModel diagram = (IDiagramUIModel) diagramIter.next();
/*
* retrieve diagram element from IDiagramUIModel
*/
Iterator diagramElementIter = diagram.diagramElementIterator();
while (diagramElementIter.hasNext()) {
IDiagramElement diagramElement = (IDiagramElement) diagramElementIter.next();
}
}
/*
* retrieve diagram and diagram element from VPContext
*/
// assume on a sub-class of com.vp.plugin.action.VPContextActionController
public void update(VPAction action, VPContext context) {
IDiagramUIModel diagram = context.getDiagram();
IDiagramElement diagramElement = context.getDiagramElement();
// diagramElement may be null, if the popup menu shown for the diagram
}
/*
* retrieve connected connector from a shape
* because a connector can connected with both Shape and Connector, please check the
* both getToShape() and getToConnector() or getFromShape() and getFromConnector()
*/
// assume in a code segment
IShapeUIModel shape = ...; // retrieved the shape from somewhere
IConnectUIModel[] connectors = shape.toFromConnectorArray();
int count = connectors == null ? 0 : connectors. length;
for ( int i = 0; i < count; i++) {
IDiagramElement toDiagramElement = connectors[i].getToShape();
if (toDiagramElement == null) {
toDiagramElement = connectors[i].getToConnector();
}
}
Updateing diagrams/Diagram elements
IDiagramUIModel provides the functions to set the diagram outlook (size, background, etc...).
Implementing plugin
P. 1262
IDiagramElement is the super class of IShapeUIModel and IConnectorUIModel. Because there is a difference between shape and connector, the
IShapeUIModel and IConnectorUIModel provide different set of functions to update them.
Sample Code:
/*
* update a shape's size and set a connector's connector style
*/
// assume in a code segment
IShapeUIModel shape = ...; // retrieved the shape from somewhere
shape.setBounds(20, 20, 400, 400);
IConnector connector = ...; // retrieved the connector from somewhere
connector.setConnectorStyle(IConnector. CS_CURVE);
Deleting diagrams/Diagram elements
Developer can delete the diagram and diagram element by simple way, just call the IDiagramUIModel.delete() and IDiagramElement.delete().
Showing dialog on Visual Paradigm
Since Visual Paradigm may be integrated with different platforms which may not support Swing (e.g. Eclipse, Visual Studio). That may make the
process to be hung on if using the Swing dialog technology (e.g. JOptionPane and JDialog). So, it is necessary to use a special method to show the
dialog with Swing technology.
com.vp.plugin.ViewManager is an interface provides function for developer to show the dialog as same as show dialog by JOptionPane. Besides
that, Viewmanager supports developer to show message on Visual Paradigm's message pane and show custom dialog by implementing an interface (
com.vp.plugin.view.IDialogHandler).
Same as JOptionPane, to show a dialog, it is better to have a component as the invoker/parent component. To get the component in Visual Paradigm,
just call ViewManager.getRootFrame().
Showing message on message pane
ViewManager provides function showMessage(msg:String, msgTabId:String) to show the message on Message Pane. The parameter msg is the
content of the message, msgTabId is the id to identify the tab on Message Pane, which can be defined by developer.
In Swing, we may use the javax.swing.JOptionPane to show a message dialog (e.g. JOptionPane.showMessageDialog(...)). ViewrManager
provides the functions which simulate the JOptionPane. ViewManger provides a set of showXXXXDialog(...) functions for showing the dialog. The
signature of the functions are same with the JOptionPane. Developer need not feel strange on calling the showXXXXDialog(...) functions.
Showing custom dialog
In Swing, we may implement the javax.swing.JDialog and add our component on the dialog's content pane. But in plugin, developer is required to
implement an interface com.vp.plugin.view.IDialogHandler to work for the dialog.
IDialogHandler specify the behaviors of a dialog. There are 4 functions need to be implemented.
getComponent() : java.awt.Component
It is called once before the dialog is shown. Developer should return the content of the dialog (similar to the content pane).
prepare(dialog : com.vp.plugin.view.IDialog) : void
It is called after the getComponent(). A dialog is created on Visual Paradigm internally (it still not shown out). Developer can set the outlook of the
dialog on prepare(), such as title, bounds and modal, etc... For your convenience, the dialog will be shown on the screen center as default. If developer
don't want change the location, there is no necessary to call the setLocation() function.
shown()
It is called when the dialog is shown. Developer may need to do something when the dialog is shown, such as checking something before user to input
data on the dialog.
canClosed()
It is called when the dialog is closed by the user clicking on the close button of the frame. Developer may not allow the user to close the dialog (e.g.
failed on validation check), then please return 'false' on canClosed().
Implementing plugin
P. 1263
Sample on Code:
package sample.plugin.dialog;
// assume imported necessary classes
public class CustomDialogHandler implements IDialogHandler {
private IDialog _dialog;
private Component _component;
private JTextField _inputField1, _inputField2, _answerField;
public Component getComponent() {
this._inputField1 = new JTextField(10);
this._inputField2 = new JTextField(10);
this._answerField = new JTextField(10);
JLabel addLabel = new JLabel( " + "); JLabel equalLabel = new JLabel( " = ");
JButton okButton = new JButton( "Apply");
okButton.addActionListener( new ActionListener() {
public void actionPerformed(ActionEvent e) { ok();}
} );
JPanel pane = new JPanel();
pane.add( this._inputField1); pane.add(addLabel); pane.add( this._inputField2);
pane.add(equalLabel); pane.add( this._answerField); pane.add(okButton);
this._component = pane;
return pane;
}
public void prepare(IDialog dialog) {
this._dialog = dialog;
dialog.setModal(true);
dialog.setTitle( "Maths Test");
dialog.setResizable( false ); dialog.pack();
this._inputField1.setText(String.valueOf(( int)(Math.random()*10000)));
this._inputField2.setText(String.valueOf(( int)(Math.random()*10000)));
}
public void shown() {
ApplicationManager.instance().getViewManager().showMessageDialog(
this._component, "Maths Test is started, you have an half hour to finish this test.",
"Maths Test", JOptionPane. INFORMATION_MESSAGE
);
}
public boolean canClosed() {
if ( this.checkAnswer()) { return true; }
else {
ApplicationManager.instance().getViewManager().showMessageDialog(
this._component, "Incorrect",
"Maths Test", JOptionPane. ERROR_MESSAGE
);
return false;
}
}
private void ok() {
if ( this.checkAnswer() ) { this._dialog.close(); }
else {
ApplicationManager.instance().getViewManager().showMessageDialog(
this._component, "Incorrect",
"Maths Test", JOptionPane. ERROR_MESSAGE
);
}
}
private boolean checkAnswer() {
try {
int a = Integer.parse Int( this._inputField1.getText());
int b = Integer.parse Int( this._inputField2.getText());
int c = Integer.parse Int( this._answerField.getText());
return (a+b == c);
}
catch (Exception ex) { return false; }
}
}
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Implementing plugin
P. 1264
Deploying plugin
After preparing all the required files for a plugin (plugin.xml, plugin.properties, classes/libraries and other resources), developer can plug the plugin into
Visual Paradigm.
First, create a folder named plugins (notice the ' s') in the Visual Paradigm installation directory. Put the plugin files into "%Visual-Paradigm%\plugins
\%PLUGIN_ID%\". %PLUGIN_ID% is a directory named as the plugin id (use the id as the directory name to avoid duplicated directories defined in
plugins)
The following structure should be obtained:
%Visual Paradigm%
bin
lib
...
plugins
sample.plugin (%PLUGIN_ID %)
plugin.xml
plugin.properties
classes
sample (package)
... (other packages or classes or resources)
lib
sampleplugin.jar
... (others .jar)
icons (others resources)
red.png
...(other resources)
Below is an example of Vsiual Paradigm installation folder with plugin created in the plugins folder.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Deploying plugin
P. 1265
Generating report
The command needed to generate HTML/PDF/Word report
Project publisher
The command needed to publish a project
P. 1266
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file ExportDiagramImage and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-out
C:\Demo\Output
-diagram
A list of diagram required to export images. User can enter "*" for
representing all diagrams to supply the names of diagrams or to supply a
text file which includes the names of all diagrams
diagram_1 diagram_2
-type [optional]
png
png
png_with_background
jpg
svg
pdf
Parameters for ExportDiagramImage
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1267
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file ExportXMI and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-out
C:\Demo\Output\sample.xmi
-type [optional]
1.0
2.1
-encoding [optional]
1.2
2.1
2.1UML2
Importing XMI
To import XMI to a project through command line:
1.
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file ImportXMI and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-file
C:\Demo\input\sample.xmi
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1268
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file ExportXML and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-out
C:\Demo\Output
-diagram
-noimage
N/A
-refmodel
true
Importing XML
To import XML to a project through command line:
1.
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file ImportXML and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-file
C:\Demo\input\sample.xml
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1269
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file ExportExcel and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-out
C:\Demo\Output\Sample.xlsx
Parameters for ExportExcel
Importing Excel
To import Excel to a project through command line:
1.
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file ImportExcel and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-file
C:\Demo\input\sample.xlsx
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1270
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file GenerateORM and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-out
Folder for storing the generated files including the source code, required
libraries and mapping XML
C:\Demo\Output
-db [optional]
-code [optional]
-code
-ddl [optional]
-ddl
-exportdb [optional]
-exportdb
-dbmode [optional]
The action that you want to execute upon your database. Here is a list of
possible actions:
- Create
- Update
- DropAndCreate
- Drop
Create
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1271
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file Generatedocument and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-out
C:\Demo\Output\Mydocument.pdf
-type
html
-all [optional]
word
By default, only the selected diagrams (saved in vpp) will be covered when
generating document. By including -all, all diagrams will be covered.
-all
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1272
Instant Generator
To generate code from a project through command line:
1.
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file InstantGenerator and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-out
C:\Demo\Output
-template [optional]
The path of template folder. Unless specified, the default folder will be
selected.
C:\MyTemplates
-lang [optional]
Java
C++
-package
[optional]
C#
VB
.NET
PHP
ODL
ActionScript
IDL
C++
Delphi
Perl
XSD
Python
Objective-C
Ada95
Ruby
com.mypackage.model;com.mypackage.view
You may use ";" as separator, and note that all the sub-packages will be
included.
-class
[optional]
com.mypackage.model.Account;com.mypacka
NOTE:
Code generation through command line generates only classes selected when running Visual Paradigm. In other words, you must at
least generate once in Visual Paradigm in order to make command line generation work.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Instant generator
P. 1273
Instant Reverse
To reverse source code to a project through command line:
1.
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file InstantReverse and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-path
C:\Demo\Output\src
-lang
Specify the language of the source code to reverse. Here are the possible
options:
Java
Java
pathtype
sourcetype
"C++ Source"
Ada 9x Source"
XML
"XML Schema"
Hibernate
"Python Source"
Objective-C
Useful only for Java, pathtype defines the type of the path supplied for path. Here are the possible options:
file
folder
zip
Useful only for Java, sourcetype defines the type of source to reverse. Here
are the possible options:
source
-overwrite | -update
file
source
class
- overwrite
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Instant reverse
P. 1274
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file JavaCodeSync and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-project
Project path
C:
\Demo
\Demo.vpp
-src
C:
\Demo
\Output
\src
-generate | -reverse
Action to perform. Include -generate to indicate the update of code from model. Include -reverse to indicate
the update of model from code.
generate
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1275
Project Publisher
To publish project through command line:
1.
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file ProjectPublisher and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-out
C:\Demo\Output
-nickname
[optional]
Spanish
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Project publisher
P. 1276
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file UpdateTeamworkProject and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-workspace
C:\vpworkspace
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1277
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file build.xml and paste to the bin folder of Visual Paradigm installation directory.
3.
Open the build file in any text editor. Modify the properties vpsuiteInstallationPath, vpproduct, vpworkspace and headless to suit your
environment.
Modify task(s) specific parts by changing the values of parameters. For details about the parameters, refer to previous sections.
6.
Start the command prompt and navigate to the bin folder of Visual Paradigm installation directory.
7.
Enter ant build.xml, and then the task name to execute specific task.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1278
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file ExportDocComposer and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-diagram
"Doc1" "Doc2"
-out
C:\Demo\Output\
-type
html
word
word
Parameters for ExportDocComposer
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1279
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file CommitTeamworkProject and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-workspace
Workspace folder
C:\myworkspace
-project
Project path
C:\myworkspace\teamwork_client\projects
\MyProject\MyProject.vpp
Parameters for CommitTeamworkProject
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1280
Browse the scripts folder under the Visual Paradigm installation directory.
2.
Copy the script file Plugin and paste to the bin folder of Visual Paradigm installation directory.
3.
4.
5.
Description
Example
-project
Project path
C:\Demo\Demo.vpp
-pluginid
The ID of the plugin you want to run. It's the id defined in the <plugin>, in
plugin.xml.
"sample.plugin"
-pluginargs
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Tips and tricks, Q&A and solutions about Visual Paradigm plug-ins
P. 1281
Printing diagrams
This chapters covers the steps needed to print diagram(s) to printing devices.
Printing diagrams
Introduces the standard way of printing diagram with description to several printing configuration.
Quick print
Quick print is a lite way of printing diagram by ignoring some of the configuration options and preview of outcome.
Printing diagrams
P. 1282
Printing diagrams
The Print window dialog box allows you to preview the printout and provides a set of options for changing the printout style. To unfold the Print window
dialog box, select File > Print... from the toolbar.
An overview of Print window
Name
Quick Print
Print the diagram(s) without previewing them. The Quick Print dialog
box will be opened.
Page Setup
Adjust Margin
Select the use gradient color in printout. Since printing gradient color
will use up lots of memory, it is recommended to turn this option off for
better performance.
Zoom
If the Fit to Pages option is chosen, and there are multiple pages in
the printout, choosing Paper Base Layout will cause the distribution
of pages to be paper-oriented (the diagram size is ignored in arranging
the preview); while choosing Diagram Base Layout will cause the
distribution of pages to be diagram-oriented. Note that this option
affects the preview only; the order of the printout remains unchanged.
Change the order of the printout. A large diagram is divided into many
pages, choosing From left to right will arrange the printout order from
the pages on the left to the pages on the right, while choosing From
Description
Printing diagrams
P. 1283
top to bottom will arrange the print order from the pages on the top to
the pages on the bottom.
Fit to Ratio
Fit to Pages
Overlapping
Border
Switch to the Multiple Page Mode to set the multiple page options.
Help
Close the print preview pane and return to the design area.
Details of toolbar
Select the desired diagram(s) for printing. The selected diagram(s) will be shown in the preview area.
Diagram preview
2.
on the Print preview toolbar. The Print dialog box will be shown.
Printing diagrams
P. 1284
Select a specific printer, the page range and the number of copies to be printed. You may click the Properties... button to configure the printerspecific properties as well.
4.
Page setup
Page Setup allows you to specify the page size, orientation, as well as the margins of the pages.
2.
You can click the Size drop-down menu to select the paper size for printing.
3.
4.
You can enter the value into the Left, Right, Top and Bottom text fields to adjust the size of the corresponding margin.
5.
Adjusting margins
The Margins pane allows user to specify the margins of the pages, header and footer.
Printing diagrams
P. 1285
Adjusting margins
1. Click the Adjust Margin button
on the toolbar. The margin setting page will be shown in the preview area.
2. You can edit the margins size by entering the sizes into the text fields. Alternatively, click the spinner buttons to increase/ decrease the margin sizes.
3. Click the Finish Adjust Margin button
when you finish configuring the margin settings. The margin sizes will then be updated.
Zooming pages
Diagrams can be zoomed in or zoomed out according to the user's preference.
1.
Click the Zoom drop-down menu to select the desired zoom ratio.
The preview area will show the diagrams in the zoom ratio that you have selected.
Printing diagrams
P. 1286
Printing diagrams
P. 1287
Fit to ratio
Fit to Ratio is used to resize the diagrams in the printout to a specific ratio.
Click the Fit to drop-down menu and select Ratio.
You can enter the ratio into the text field. After editing the ratio, the diagrams in the printout will be resized at once.
Printing diagrams
P. 1288
Fit to ratio
Fit to pages
Fit to Pages is used to split the diagram to a desired number of pages when printing.
1.
2.
Click the row-column combination to select it (note that you can click and drag on the page selector to extend the selection). The diagram will be
split into multiple pages by the rows and columns that you have selected.
Printing diagrams
P. 1289
Fit to page
Input the overlapping percentage and press Enter in Overlapping text field.
2.
The printing area near the boundaries of the pages will be duplicated through the input value of overlapping percentage.
With frame
With border
No border
Select With frame/ With border/ No border option from the drop-down menu.
Printing diagrams
P. 1290
Printing diagrams
P. 1291
Clip marks
To show clip marks on the printout, click the Show Clip Marks on Page button
hide the clip marks, click the Hide Clip Marks on Page button
again.
on the toolbar. You will then switch to the edit header/footer pane.
Name
Description
Select Font
Select the font format. Note that you have to click the section you want its font to be formatted before you
start setting the font format.
Insert the page number. Note that you have to click the section you want page number to be inserted into
before you click it.
Insert the total number of pages. Note that you have to click the section you want the number of pages to be
inserted into before you click it.
Insert Date
Insert the date that the printing starts. Note that you have to click the section you want the date to be
inserted into before you click it.
Insert Time
Insert the time that the printing starts. Note that you have to click the section you want the time to be
inserted into before you click it.
Insert the file name of the Visual Paradigm project. Note that you have to click the section you want the file
name to be inserted into before you click it.
Printing diagrams
P. 1292
Insert the name of the Visual Paradigm project. Note that you have to click the section you want the project
name to be inserted into before you click it.
Insert the diagram name. Note that you have to click the section you want the diagram name to be inserted
into before you click it.
Insert the parent package. Note that you have to click the section you want the parent package to be
inserted into before you click it.
Insert the parent hierarchy. Note that you have to click the section you want the parent hierarchy to be
inserted into before you click it.
The description of editing of header/ footer toolbar
After you have finished editing the header/footer, click the Close Edit Header/Footer button
with the header and footer is shown in the figure below:
on the toolbar.
Click the icon behind Multiple Pages will pop the page selector out, where you can select the row-column combination for the printout. Alternatively,
you can type in the Row and Column text field directly.
Printing diagrams
P. 1293
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Printing diagrams
P. 1294
Alternatively, you can select Print > Quick Print... on the toolbar to launch quick print.
2.
In the Quick Print dialog box, select printout setting for the diagram.
3.
No.
Name
Print Range
Description
Diagrams - Check from the diagram tree to select the diagram(s) for printing.
Scaling
Select No scaling to print with diagrams' original size. Numbers of pages used for each diagram are subject to the
scale of diagrams. Select Fit to pages to print with specified number of pages per diagram with respect to the specified
number of rows and columns.
Border option
Page Setup...
It allows you to specify the page size, the orientation as well as the margins of the pages.
Select the use gradient color in printout. Since printing gradient color will use up lots of memory, it is recommended to
turn this option off for better performance.
Print background
Click to print diagram's background when printing. When un-clicked, background color is ignored in printing.
Page numbers
Page number can be optionally displayed in printout. By default, the numbering of pages is diagram based, meaning
that each diagram has its own set of numbers, and the numbers reset for a new diagram. The Global Page Number
option is to enable the continuous numbering of all diagrams.
Details of quick print dialog box
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Quick print
P. 1295
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Quick print
P. 1296
General Options
General
P. 1297
Project Options
Option Name
Description
The name of person who edit the project. This will be filled in as the author within project
management properties.
Action that happens when all views of a model element are being deleted:
Ask - (default) Prompt if you want to delete the model element as well.
Ask - (default) Prompt if you want to open the exported image file.
Yes - Open image file (when export single image) or image folder (when export multiple
images) directly.
Backup level
The number of files that will be saved as backup. When reached the limit, the next backup will
overwrite the earliest one.
(default false) If a model element has multiple views, delete any of them will never cause the
model element to be deleted, even if you are deleting a master view.
(default true) If checked, it will open the last opened project immediately when starting Visual
Paradigm. If unchecked, it will open new project.
None - (default) Do not surround the diagram with neither frame nor border.
Export with frame - Add a frame around image to show a border with the name of diagram
appear at top left of diagram.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Project
P. 1298
Description
Duplicating a model element from linked project will cause a local copy to be created.
No - Discard duplication.
You cannot place a shape inside a linked shape, such as a linked package. If you try to do this,
you will be warned by default. This option determines whether the warning will appear or not.
Caption Here
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Referenced project
P. 1299
Appearance Options
Option Name
Description
User Language
Language being applied on the user interface. This affects the text in menus, tooltips, dialog
content, report content, etc.
Select the font family and size of font to apply for the application user interface.
Date Format
Date Sample
The sample of date is shown after you select the format of date.
Time Format
Time Sample
The sample of time is shown after you select the format of time.
Measurement Unit
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Appearance
P. 1300
Connection Options
Option Name
Description
Use proxy
(default false) To check/uncheck in order to use a proxy server for connecting to the Internet.
Host
Port
Login name
The user name of the proxy server (if the proxy server required the user to login).
Password
The password of the proxy server (if the proxy server required the user to login).
VP can store multiple ElaborView connection. You may add a new one by clicking Add and
specify the connection properties after added.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Connection
P. 1301
Printing Options
Option Name
Description
Control whether to use gradient or solid color for shapes and diagrams when printing.
Control whether to print the diagram background color when printing diagram.
Printing Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Printing
P. 1302
Edition Options
Option Name
Description
(default true) When checked, executing features that are not available in the running edition will
be prompted, asking whether you want to advance to higher edition in order to use the feature.
When unchecked, those non supported features will be disabled.
Edition Options details
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Edition
P. 1303
Teamwork Options
Option Name
Description
(default false) Determines whether the export/import Teamwork project menus will appear in the
Projects menu of Teamwork Client dialog box
Teamwork Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Teamwork
P. 1304
Update Options
Option Name
Auto update
Description
Let the application checks for available updates with respect to the running build/version and
notify you to perform update whenever possible.
On every start - Check for updates everytime when starting Visual Paradigm
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Update
P. 1305
Diagramming Options
Diagramming
P. 1306
Appearance Options
Option Name
Description
Grid - Color
Grid - Width
Grid - Height
(default true) When checked, shapes will be docked to the closest grid line when being created/
moved. Otherwise, shapes can be moved freely as if the grid does not exist.
(default true) Determines whether the name of items will be shown in the pallet.
(default false) Determines whether the group will be expanded to display all items.
Yes - When move the mouse over a shape, the hidden layer indicator is shown
No - The hidden layer indicator isn't shown even when move the mouse over a shape
Prompt -Ask if users want to show hidden layer indicator when move the mouse over a
shape
Following Shape Foreground Color - Use the same color as the shape foreground
Glossary Terms
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Appearance
P. 1307
Environment Options
Option Name
Description
Inside selection area - (default) When selecting a range of shape, only shapes that are
completely inside the selection range are included in selection
Overlapped with selection area - When selecting a range of shape, shapes that are partly
or completely covered by the selection range are included in selection
Yes - When copy Use Case, the rich text format of Use Case Details will also be copied
(size of copied content will increase considerably)
No - When copy Use Case, Use Case Details will be copied as plain text
Prompt - Ask if user want to copy rich text for Use Case Details when copying XML
Never show - Never show Quick Preview when moving mouse cursor over diagram node in
Diagram Navigator
1.0 - 3.5 - The number of seconds that a Quick Preview will disappear after moving the
mouse cursor out of a diagram
Within Visual Paradigm - (default) When triggering the hotkey for Copy (Ctrl-C, by default),
it will perform copying within Visual Paradigm
Copy to Clipboard as Image (JPG) - When triggering the hotkey for Copy (Ctrl-C, by
default), it will perform copying as JPG image
Copy to Clipboard as Image (EMF) - When triggering the hotkey for Copy (Ctrl-C, by
default), it will perform copying as EMF image
Check to cause the help contents to be displayed when you paste a view on a diagram.
Unspecified - (default) Prompt for adding a frame or a border when copying shapes as
image
None - Do not add border nor frame to image when copy shapes as image
Copy with frame - Add a frame around image to show a border with the name of diagram
appear at top left of diagram
(default true) Show the shape content such as shape name when dragging shape.
When there is at least one logical view in your project, you can optionally select the logical view to
store a diagram during the creation of diagram. If you want to turn this option off, uncheck here.
Show the tooltip of shape when moving mouse pointer over shape
(default true) Prompt for applying design pattern even when there are remaining undo or redo due
to the undo and redo records will be cleared after applying design pattern.
Mouse gesutre enables you to create and connect elements by forming a gesture with the right
mouse button.
You can assign stereotypes to a shape through its popup menu. This option determines the
number of stereotypes to display in that popup menu.
Sometimes, the diagram border may be wrongly calculated. You may click the Reset to default
button to reset the range of diagram border.
Undo limit
The number of available undo that can be performed. The lower the limit, the higher the
application performance. Actions that beyond the undo limit will not be able to be undo. If you
want to have no limit, check Unlimited.
Environment Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Environment
P. 1308
Description
Yes - Automatically overwrite Sequence Diagram generated from Use Case Details when
generate again
Prompt - (default) Prompt for overwriting Sequence Diagram generated from Use Case
Details when generate again
Yes - Automatically overwrite diagram generated from Scenario when generate again
Prompt (default) Prompt for overwriting diagram generated from Scenario when generate
again
Ask - (default) Prompt for overwriting Flow of Events in Use Case Details when
Synchronize from Sequence Diagram
Yes - Overwrite Flow of Events in Use Case Details automatically when Synchronize from
Sequence Diagram
Model Generation Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Model Generation
P. 1309
Shape Options
Option Name
Description
Fit shape to image - Resize the image placeholder to fit the selected image
Fit image to shape - (default) Resize the image to fit into the image placeholder
Yes - Automatically contain the covered shapes after resizing a container to cover shapes
Prompt - (default) Ask if you want to contain covered shapes after resizing a container to
cover shapes
When you try to create a new member, like a column of an entity on a shape and if there is
another view of the model element, you can set whether to show the member on other view as
well.
Prompt - (default) Ask if you want to show the member on other view(s)
Determines whether to expand the parent when moving the shape around the parent's border.
<Ctrl> + <Enter> - Press Ctrl-Enter to create a new line when inline editing
<Alt> + <Enter> - (default) Press Alt-Enter to create a new line when inline editing
(default false) Determines whether a diagram overview will show contents for all nested diagrams.
(default false) Determines whether diagram overview will show rich text content.
(default true) When creating a class/ requirement/ an entity, you can select an existing class/
requirement/entity from a list so that a view of the selected class/requirement/entity can be
created. You can enable or disable the popup of such list.
(default true) For shapes that have member, like class and entitiy, when you add a member, it will
or will not resize the owner against the length of member, base on this option.
(default true) When you resize a shape that makes it touches the boundary of parent, this option
determines whether the parent will be expanded accordingly.
Shape Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Shape
P. 1310
Connector Options
Option Name
Description
(default false) Automatically pin connector's from end when connector is being created.
(default false) Automatically pin connector's to end when connector is being created.
(default true) Show connectors when dragging and dropping inter-related model elements/views
from tree to diagram.
(default false) Auto relocate connector when connector is being overlapped by another shape.
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Connector
P. 1311
Description
Show resources
(default true) Show group resources that appear when selecting multiple shapes.
(default false) Show generic resource but hide other resource icons.
0 - 2 - Time needed to wait from having mouse cursor hover on shape till the resource icons
appear.
Time needed to wait the resource icons to disappear when mouse cursor is moved out of a shape.
(default true) Always show the reference, subdiagram, transitor, documentation resource icon
at the bottom of shape no matter whether the shape has reference/sub-diagram/transitor/
documentation added/defined.
Resource Centric Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Resource Centric
P. 1312
Class Options
Option Name
Description
UML - (default) Show tooltip of child class in UML style like Package::Class
(default true) Enable to show fully qualified class and package name in tooltip like
Package::Class/ Package.Class (depending on the setting of Show parent style). Disable to
show only the hovering class or package name and type like Class : Class.
Class Options details
Description
Name
When an attribute entered matches with the name defined here, the type and default value will be
automatically filled.
Type
Automatically set attribute type value when the name user entered for an attribute matches with
name specified in Name.
Default Value
Automatically set default value when the name user entered for an attribute matches with name
specified in Name.
Auto Attribute Type of Class Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Class
P. 1313
Generalization Options
Option Name
Direction of creation
Description
from General to Specific - (default) When creating a generalization, the arrow head will
appear at the mouse release side
from Specific to General - When creaNessageting a generalization, the arrow head will
appear at the firstly selected shape
Generalization Options details
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Generalization
P. 1314
Description
Name
When a column entered matches with the name defined here, the type and default value will be
automatically filled.
Type
Automatically set column type value when the name user entered for a column matches with
name specified in Name.
Nullable
Automatically set column nullable when the name user entered for a column matches with name
specified in Name.
Default Value
Automatically set default value when the name user entered for a column matches with name
specified in Name.
Auto Column Type of Entity Options details
Description
(default true) Show the table record editor at the bottom of ERD for adding default table records to
database tables.
Behavior & Presentation of Entity Options details
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1315
Interaction Options
Option Name
Description
You can edit sequence diagram through the text editor pane that appears at the bottom of
diagram. This option controls the visibility of editor.
(default true) Fit message completion box's size everytime you activate it. If disabdeterminsled,
size adjusted manually won't be remembered.
(default true) When selecting an Operation in the message completion box, the documentation of
operation will appear next to the completion box.
Interaction Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Interaction
P. 1316
Description
Prompt - (default) Prompt for an action when an invalid actions related to connecting
shapes is discovered
Auto - (default) Show horizontal/vertical Lane header only when horizontal/vertical Lane
exist
Always Show - Always show both horizontal and vertical Lane headers even when Lane
does not exist
(default true) Show warning when trying to convert between Sub-Process and Task.
Business Process Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Business Process
P. 1317
Documentation Options
Option Name
Description
In a document in Doc. Composer, there are two ways for you to add a cover page. One is to
add a custom cover page and another one is to fill in the details of cover page in Documentation
Properties. You can choose either way to add a cover page, not both. By checking this option, you
will be prompted to disable the Document Properties option when you add a custom cover page.
Level detection
Max Level - The maximum number of heading levels that you want to apply numbering.
Levels detection - Set the style correspond to each level. If you select Heading 1 to be
Level 1, Doc. Composer will make Heading 1 numbered.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Documentation
P. 1318
View Options
View
P. 1319
View Options
Option Name
Description
Sort by name - (default) Sort tree nodes in Diagram Navigator by their names
Sort by name - (default) Sort tree nodes in Model Explorer by their names
Show relationships
(default false) Make sorting of tree nodes case sensitive (consider the case).
(default true) Show carriage return character for line breaks of shape names that are in multiple
lines.
View Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
View
P. 1320
Instant Reverse
P. 1321
.NET
C++
Description
Not specified - (default) Do not specify whether Instant Reverse of .NET is enabled or not.
Not specified - (default) Do not specify whether Instant Reverse of C++ is enabled or not.
System default - (default) The default system encoding will be selected as encoding for
source files that will be reversed
Other - Specify an encoding for the source files that will be reversed
(default true) Show the Instant Reverse Form Diagram dialog box after Instant Reverse, so that
you can form diagram after reversing code into Visual Paradigm.
Instant Reverse Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Instant Reverse
P. 1322
ORM Options
ORM
P. 1323
General Options
Option Name
Description
To make your design fits the Oracle requirement, you can check this option to let Visual Paradigm
warn you when naming table/constraint with more than 30 characters.
General Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
General
P. 1324
P. 1325
Description
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1326
Office Exchange
P. 1327
Launch viewer
Description
VP detects changes made in exported document and will suggest you to import changes back to
your project. This option determines whether the import will be on or off.
Not Specified - (default) You will be asked if you want to import the changes from
document to Visual Paradigm whenever changes are detected.
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Office Exchange
P. 1328
User Path
P. 1329
Description
(default false) Select to show user paths in references, instead of displaying resolved absolute
paths. A user path is displayed with its name enclosed by ${ }.
(default false) When adding a reference comprises a path that is not defined as a user path, you
will be prompted to add path as user path.
User Path Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
User Path
P. 1330
File Types
P. 1331
Press on the upper Add... button. This shows a dialog box where you can add file extension.
2.
Specify the Extension. Any file reference with this extension will be opened by the particular application or command. Note that for a valid
extension a dot is required to put in front of the name of that extension, such as .doc.
3.
Specify the Application/Command. The application or command for opening a file reference with file extension is same as that defined in the
Extension field.
A command can be entered directly to the text field and can include application arguments, while an application can be chosen from a file
chooser by pressing ... next to the text field.
4.
Specify the Name of this application or command. This is an optional field for identifying this file extension.
5.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
File Types
P. 1332
Spell Checking
P. 1333
Description
Dictionary
(default true) Do not classify the use of upper case in a word as a spelling mistake(unless the
spelling is wrong).
(default true) Do not classify the inclusion of number in word as a spelling mistake (unless the
spelling is wrong).
(default true) Do not classify Internet and file address as a spelling mistake.
Spell Checking Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Spell Checking
P. 1334
Keys Options
Keys
P. 1335
Keys Options
Customizable program shortcuts
Commands can be invoked by pressing certain keys in the keyboard as shortcuts. For example, holding down the Ctrl modifier key with the 'S' key
invokes the save command. Now, key bindings, which is the assignment of keys to commands, can be customized. This permits you to use the familiar
keystroke for invoking commands in Visual Paradigm.
To assign/re-assign a key:
1.
2.
3.
Press the key for invoking the command selected. The binding field will be updated accordingly.
4.
Press OK button to confirm the updates. You will be prompted to restart the application in order to make the changes take effect. By restarting,
you can invoke commands using the key defined.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Keys
P. 1336
Import/Export Options
Import/Export
P. 1337
XMI Options
Option Name
Description
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
XMI
P. 1338
Diagramming Options
Appearance
Environment
Model Generation
Shape
Connector
Class
Association
Generalization
Interaction
Component Diagram
Deployment Diagram
Business Process
Requirement Diagram
DFD
Communication Diagram
Textual Analysis
Diagramming
P. 1339
Appearance Options
Option Name
Description
Graphics anti-aliasing
Text anti-aliasing
Description Type
HTML - (default) HTML text that consists of formatting such as bold, italic, underline, table
Diagram background
(default true) Determines whether shapes are restricted to a built-in minimum size.
Fractional Metrics
(default true) When checked, fit size of shape will be performed correctly. When disabled, the
shape may look better but size may not fit.
Within Package Body - The name of package will be shown at the top of package shape
Within Package Tab - The name of package will be shown inside the package tab
Appearance Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Appearance
P. 1340
Environment Options
Option Name
Description
The default font face, size, color, bold and italic status for HTML content in description pane.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Environment
P. 1341
ID Generator Format
Description
Sequence Diagram - (default) Take Sequence Diagram to be the type of diagram that will
be generated by Scenario
Specify the ID format of various element types. If you want an ID to be generated to a type
of model element and you find the type does not exist in the table, click Add to add the type
manually. Then, specify the format of ID by specifying prefix, number of degits and suffix.
Model Generation Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Model Generation
P. 1342
Shape Options
Option Name
Description
Font
Default font settings for shape content, inlcuding font, size, color, bold and italic.
Click to reset formatting properties to factory-default. By clicking it, you are asked if you also want
to reset the formatting of all the shapes in project. Then, you are asked if you want to apply the
setting to workspace. By applying to workspace, newly created project will follow the factorydefault formatting setting, too.
(default false) Determines whether shapes in diagrams will fit in size automatically.
Shape Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Shape
P. 1343
Connector Options
Option Name
Description
Font
Connector Style
Round the shape - (default) Set the connector end to attach the round the shape
Follow center - Set the connector end to point to the center of attached shapes
Normal
Large
Extra large
Follow Connector Angle - Enforce connector caption to appear an the same horizontal level
as the connector
Follow Connector Angle and Keep Text Upright - Enforce connector caption to appear an
the same horizontal level as the connector but keep the text upright
Line Jumps
Caption orientation
Foreground
Background
(default true) Captions' background will become transparent, so that connectors can show
completely without having part of it covered by opaque caption.
Connector Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Connector
P. 1344
Class Options
Option Name
Description
(default true) Rename role when the owner class is being renamed.
(default false) Auto generate role names for a relationship when the relationship is created
between.
(default true) Allow to enter attribute name in multiple lines by pressing the new line key defined in
Diagramming > Shape.
(default true) Allow to enter class name in multiple lines by pressing the new line key defined in
Diagramming > Shape.
Auto rename - Automatic update constructor name when the class name is being updated
Do not rename - Do not update constructor name when the class name is being updated
Prompt - (default)
Always synchronize
Do not synchronize
Prompt
(default false) Show a horizontal line between each attribute or operation in class.
inout - (default) When creating a parameter in operation, the direction will be inout
protected internal (.NET only) - A new class will take protected internal as visibility when
programming language is set to be .NET
internal (.NET only) - A new class will take internal as visibility when programming
language is set to be .NET
protected internal (.NET only) - A new attribute will take protected internal as visibility when
programming language is set to be .NET
internal (.NET only) - A new attribute will take internal as visibility when programming
language is set to be .NET
protected internal (.NET only) - A new operation will take protected internal as visibility
when programming language is set to be .NET
internal (.NET only) - A new operation will take internal as visibility when programming
language is set to be .NET
Class
P. 1345
Specify the ordered property is checked or not when creating a new attribute.
Specify the unique property is checked or not when creating a new attribute.
Class Options details
Presentation
Option Name
Visibility style
Description
Fully-qualified - Show attribute type, operation return type and parameter type as full
qualified class name
Name only - (default) Show attribute type, operation return type and parameter type as
class name
Relative - Show attribute type, operation return type and parameter type as relative class
name
UML - (default) Show icons for representing class members' visibilities such as + for public,
minus for private
(default false) Show getter and setter symbol for attribute, in front of attribute name.
(default false) Automatic wrap class member against the class's width.
(default true) Display class as robustness analysis icon for classes stereotyped as boundary/
control/entity.
(default true) Show operation parameter name. When disabled, only parameter type, if defined,
would be shown.
Description
(default true) Automatically set attribute type and default value when the name user entered for an
attribute matches with one of those listed in the table followed.
Auto Attribute Type of Class Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
Class
P. 1346
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Class
P. 1347
Association Options
Option Name
Description
(default true) Show the role name of the from end of association.
(default true) Show the role visibility of the from end of association.
(default true) Show the role multiplicity me of the from end of association.
Show to multiplicity
Show direction
(default true) When you set the ownership at the end of an association (by right clicking on the
association end and selecting "Owned by"), with this option on, an attribute will be created in the
class on the opposite side.
Unspecified - A new association will set Navigable as Unspecified for both ends
True - (default) A new association will set Navigable as True for both ends
False - A new association will set Navigable as False for both ends
Unspecified - (default) A new association will set Visibility as Unspecified for both ends
private - A new association will set Visibility as private for both ends
protected - A new association will set Visibility as protected for both ends
package - A new association will set Visibility as package for both ends
public - A new association will set Visibility as public for both ends
protected internal (.NET only) - A new association will set Visibility as protected internal for
both ends when programming language is set to be .NET
internal (.NET only) - A new association will set Visibility as internal for both ends when
programming language is set to be .NET
(default false) Suppress implied "1" multiplicity for attribute and association end.
Prompt - Prompt if you want to make the name of association follow the association class
when creating the association class
Yes - Make the name of association follow the association class when creating the
association class
No - Do not make the name of association follow the association class when creating the
association class
(default true) You can create a "Referenced Attribute" from an association end in the Association
End Specification. With this option on, when you rename the referenced attribute, the name of
association end (i.e. the role) will be updated accordingly.
Association Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Association
P. 1348
Generalization Options
Option Name
Description
One Shape per Generalization - One generalization set shape per each Generalization
relationship
Dashed Line
Generalization Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Generalization
P. 1349
Description
(default false) Attach foreign key connector end points to the column associated.
(default true) Align the column properties, so that columns in entity will appear tidier.
(default true) Show grid lines between row within Entities and Database Views in ERD.
(default true) Show grid lines between row within Entities, Database Views and Classes in ORM.
Symbol
Text
Icon
Very Small
Small
Medium (default)
Large
Extra Large
Jumbo
Colossal
Pattern of primary keys that will be applied when synchronizing Class Diagram to Entity
Relationship Diagram, which may create primary key.
Index Pattern
Pattern of index.
ERD & ORM Options details
Auto Column
Option Name
Description
(default true) Automatically set column type and default value when the name user entered for a
column matches with one of those listed in the table followed.
Auto Column Type of ERD & ORM Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1350
P. 1351
Interaction Options
Option Name
Description
The effect when attaching a Destroy Message to a Lifeline, to know whether the Lifeline will be
marked stopped or not:
(default false) Show Sequence Messages' operation signatures in Sequence Diagram and
Communication Diagram.
(default true) Show Sequence Messages' stereotypes in Sequence Diagram and Communication
Diagram.
(default true) Show Activations in Sequence Diagram. If unchecked, sequence message will be
attached to Lifeline instead of Activations.
(default true) Display Lifeline as robustness analysis icon for Lifelines stereotyped as boundary/
control/entity.
(default false)
Interaction Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Interaction
P. 1352
Description
(default true) Show Use Case Extension Points within Use Case shapes.
Yes - Rename Extension Points to follow extend use case automatically when the name of
extend use case is changed.
No - Even when the name of extend use case is changed, the name of Extension Points
will not change to follow extend use case.
Prompt (default) - Ask if rename Extension Points to follow extend use case when the
name of extend use case is changed.
Use Case Diagram Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1353
Show Caption
Description
Activity Final Node - (default false) Show caption for Activity Final Node
Flow Final Node - (default false) Show caption for Flow Final Node
Auto - (default) Show horizontal and/or vertical Partition headers if there is Partitions in that
orientation
Always Show - Always show Partition headers regardless of the orientation of Partitions,
even if there is no Partition
Default (default)
Connect to vertex
(default true) Show the type of object node inside the object node shape.
Activity Diagram Options details
Description
Initial Pseudo State - (default false) Show caption for Initial Pseudo State
(default true) Automatic create an initial state when creating a State Machine Diagram.
(default false) Name tab is a a tiny rectangle that appear on top of a state and at the left hand
side, displaying the name of a state. Use state name tab is to enable such tab.
Triggers can be added to a Transition relationship. This option determines the visibility of Triggers.
(default true) Show the precondition, postcondition and body of internal activities in state.
State Machine Diagram Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1354
Description
Icon - Show only an icon representing a Component at the top right of Component
Keyword and Icon - (default) Show both keyword and icon for a Component
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Component Diagram
P. 1355
Description
Icon - Show only an icon representing an Artifact at the top right of Artifact
Keyword and Icon - (default) Show both keyword and icon for a Artifact
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Deployment Diagram
P. 1356
Description
Prompt - (default) Prompt if user want to change the Message to Message Flow, Sequence
Flow or cancel the action
Connect with Message Flow - Change or keep the relationship as Message Flow
Connect with Sequence Flow - Change or keep the relationship as Sequence Flow
Unspecified (default)
Embedded
Reusable
Reference
Event
Show Below Caption - Display ID as part of the caption, under the name
Presentation
Option Name
Connector Style
Description
Round the shape - Set the connection point style to Round the shape
Follow center - (default) Set the connection point style to Follow center
(default true) Show icons that represent the type of Task and Sub-Process.
(default false) Show a cross in BPMN gateway shape when the gateway has a "Data-Based
Exclusive Decision/Merge (XOR)" type.
(default true) Make the open rectangle of text annotation to follow the position of end of the
attached connector.
Business Process Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Business Process
P. 1357
Description
Wrap the text in compartments like part, reference, value and flow property in SysML block
Block Definition Diagram Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1358
Show Attributes
Description
Show Non-empty Attributes - Show only Requirement attributes that have values defined
Wrap member
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Requirement Diagram
P. 1359
DFD Options
Option Name
Description
Yes - When decompose a DFD, Data Stores and External Entities on the current diagram
will be copied to the decompose diagram
No - When decompose a DFD, Data Stores and External Entities on the current diagram
will not be copied to the decompose diagram
Prompt - (default) When decompose a DFD, prompt if user want the Data Stores and
External Entities on the current diagram to be copied to the decompose diagram
DFD Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
DFD
P. 1360
Description
On a link between lifeline, you can choose whether to group message arrows that follow the same
direction into a single arrow or show as separate message arrows.
Communication Diagram Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Communication Diagram
P. 1361
Highlight Option
Description
Case insensitive - (default) Words which are the same as the entered word, even in
different cases, are highlighted.
Case sensitive - Words which are the same as the entered word or/and with same case are
highlighted.
Extracted text - (default) When create requirement from a candidate requirement, its text
property will be filled by the candidate's extracted text.
Class description - When create requirement from a candidate requirement, its text
property will be filled by the candidate's class description.
Textual Analysis options details
Related Resources
The following resources may help you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Textual Analysis
P. 1362
Instant Reverse
P. 1363
Description
(default false) When drag and drop an element from tree to diagram, add also their parent (e.g.
Package) to diagram to contain the dropped shapes.
(default false)
(default false)
Instant Reverse Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Instant Reverse
P. 1364
ORM Options
ORM
P. 1365
General Options
Option Name
Synchronize Name
Getter/Setter Visibility
Description
Yes - Add quotes to SQL identifier to prevent potential violation when executing SQL
Yes - Auto update model element name when synchronize class diagram and ERD
No - Do not update model element name when synchronize class diagram and ERD
Prompt - (default) Prompt to update model element name when synchronize class diagram
and ERD
(default true) Automatically determine the most suitable precision and scale when synchronize
from attribute to column as decimal.
ID Generator
assigned - allow the application to assign an identifier to the object before save() is
called.
hilo - uses a hi/lo algorithm to efficiently generate identifiers of type long, short or int,
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 long, short or int.
increment - generates identifiers of type long, short or int that are unique only when no
other process is inserting data into the same table. Do not use in a cluster.
native - (default) picks identity, sequence or hilo depending upon the capabilities of
the underlying database.
seqhilo - uses a hi/lo algorithm to efficiently generate identifiers of type long, short or
int, given a named database sequence.
sequence - uses a sequence in DB2, PostgreSQL, Oracle. The returned identifier is of type
long, short or int
Automatic - (default) Automatically select attribute type when synchronize from column
numeric type
Big Decimal - Synchronize column numeric type to attribute as big decimal type
Formatted SQL
General
P. 1366
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
General
P. 1367
Synchronization Options
Option Name
Description
Upper camel case - words are joined without underscore ("_") and are capitalized
Lower camel case - Same as upper camel case except that the first character is lower case
Reverse camel case - each upper case character are considered as word separator, words
are joined with underscore ("_") and are lower case
Reverse camel to upper case - each upper case character are considered as word
separator, words are joined with underscore ("_") and are upper case
Upper camel case - words are joined without underscore ("_") and are capitalized
Lower camel case - Same as upper camel case except that the first character is lower case
Reverse camel case - each upper case character are considered as word separator, words
are joined with underscore ("_") and are lower case
Reverse camel to upper case - each upper case character are considered as word
separator, words are joined with underscore ("_") and are upper case
Upper camel case - words are joined without underscore ("_") and are capitalized
Lower camel case - Same as upper camel case except that the first character is lower case
Reverse camel case - each upper case character are considered as word separator, words
are joined with underscore ("_") and are lower case
Reverse camel to upper case - each upper case character are considered as word
separator, words are joined with underscore ("_") and are upper case
Upper camel case - words are joined without underscore ("_") and are capitalized
Lower camel case - Same as upper camel case except that the first character is lower case
Reverse camel case - each upper case character are considered as word separator, words
are joined with underscore ("_") and are lower case
Synchronization
P. 1368
Reverse camel to upper case - each upper case character are considered as word
separator, words are joined with underscore ("_") and are upper case
Synchronize Name
Yes
No
Prompt
Super Class
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Synchronization
P. 1369
P. 1370
Language
Description
C# - Generate code in C#
(default true) Generate try catch block for method calls that may produce exception.
(default false) Generate debug message to help tracing problems that happen when running
generated code.
(default false) Overwrite the transition methods if already exists in source code.
(default true) Generate sample code to help you to understand how to work with generated code.
State Code Engine Options details
Related Resources
The following resources may help to you learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1371
Data Type
P. 1372
In the Programming Language dialog box, select the language to switch to. The way how data-type will be mapped from the current language
to the chosen language is listed in the table following the data-type definition of that language.
Open the Project Options window by selecting Tools > Project Options from the main menu.
2.
Choose Data Type from the list on the left hand side of the Project Options window.
3.
In the Data Type page, click the plus button under Languages: to add a language.
4.
5.
6.
Enter its name and press OK to confirm. From now on, once you have set your own language as the language for your project, you can pickup
the associated data-types as attribute type, operation return type and parameter type.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Data Type
P. 1373
Code Synchronization
P. 1374
Code Options
Option Name
Description
(default int) Type that will be assigned to Attribute upon code generation when type is unspecified.
(default void) Return Type that will be assigned to operation upon code generation when return
type is unspecified.
(default int) Type that will be assigned to Parameter upon code generation when type is
unspecified.
(default true) When an operation is set from non-abstract to abstract, updating code will remove
the related method's body.
(default true) Generate getter's name as isXXXX() for getters that return a boolean value.
(default true) Add import statement for referencing classes in another package/namespace
instead of using fully qualified name inline.
(default false) Use fully qualified type name in import statements instead of using wildcard
character * to represent importing all classes in package.
Java Collection
Generate annotation on
System default - (default) The default system encoding will be selected as encoding for
source files
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Code
P. 1375
Class declaration
Constructor declaration
Method declaration
Enum declaration
Indentation policy
Indentation size
Description
Same line - (default) Brace for class declaration appears at the same line as the
declaration
Next line - Brace for class declaration appears at the line after the declaration
Same line - (default) Brace for constructor appears at the same line as the declaration
Next line - Brace for constructor appears at the line after the declaration
Same line - (default) Brace for method appears at the same line as the declaration
Next line - Brace for method appears at the line after the declaration
Same line - (default) Brace for enumeration appears at the same line as the declaration
Next line - Brace for enumeration to appear at the line after the declaration
Same line - (default) Brace for annotation type appears at the same line as the declaration
Next line - Brace for annotation type appears at the line after the declaration
Spaces - Use spaces as indentation. The number of spaces can be defined below
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1376
Description
Number of blank lines to appear before the first declaration within Class declarations.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
New Lines
P. 1377
Template Options
Option Name
Description
Operation Template
The content to fill in for operation body of code file synchronized from class.
Getter Template
The content to fill in for getter body of code file synchronized from class.
Setter Template
The content to fill in for setter body of code file synchronized from class.
Templates Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Templates
P. 1378
P. 1379
Code Options
Option Name
Description
(default int) Type that will be assigned to Attribute upon code generation when type is unspecified.
(default void) Return Type that will be assigned to operation upon code generation when return
type is unspecified.
(default int) Type that will be assigned to Parameter upon code generation when type is
unspecified.
System default - (default) The default system encoding will be selected as encoding for
source files
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Code
P. 1380
Class declaration
Constructor declaration
Method declaration
Enum declaration
Indentation policy
Indentation size
Description
Same line - (default) Brace for class declaration appears at the same line as the
declaration
Next line - Brace for class declaration appears at the line after the declaration
Same line - (default) Brace for constructor appears at the same line as the declaration
Next line - Brace for constructor appears at the line after the declaration
Same line - (default) Brace for method appears at the same line as the declaration
Next line - Brace for method appears at the line after the declaration
Same line - (default) Brace for enumeration appears at the same line as the declaration
Next line - Brace for enumeration tor appears at the line after the declaration
Same line - (default) Brace for annotation type appears at the same line as the declaration
Next line - Brace for annotation type appears at the line after the declaration
Spaces - Use spaces as indentation. The number of spaces can be defined below
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1381
Description
Number of blank lines to appear before the first declaration within Class declarations.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
New Lines
P. 1382
Template Options
Option Name
Description
Operation Template
The content to fill in for operation body of code file synchronized from class.
Getter Template
The content to fill in for getter body of code file synchronized from class.
Setter Template
The content to fill in for setter body of code file synchronized from class.
Templates Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Templates
P. 1383
Model Quality
P. 1384
Description
Model quality checking is the ability to check project data for potential flaws. The chekcing is done
automatically. Whenever a problem is detected, shapes will be underlined directly in diagram. You
may turn this function off by unchecking this option.
Model Quality Options details
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Model Quality
P. 1385
Automatic update
Automatic update refers to the ability to detect and download possible updates from the Internet. This chapters shows you how to work with the
automatic update feature.
Updating Agilian
How to perform manual update.
Automatic update
P. 1386
Run the Visual Paradigm Update program. You can run it under %Visual-Paradigm_Install_DIR%\bin.
This shows the update program. Select the place where the update program can look for the update files. If you want to update Visual Paradigm
to the latest build, select Visual Paradigm update server and click Check update. If you have a specific place where the update file is stored,
select Internal update server and fill in the URL. Click Check update button.
NOTE:
If you need to configure a proxy server for connection, click Proxy setting at bottom left.
NOTE:
A patch is special build made that contains specific bug fix/enhancement, made for specific users.
When and only when you are asked by Visual Paradigm to update to the latest patch build, click Update to latest patch.
3.
Confirm the build to update to and then click Perform Update. If there is a new version and if your software maintenance agreement is active,
you will see an option for upgrading to the new version. If you choose to upgrade to the new version, the update program will help you to grab
the new license upon the finishing of the upgrade.
4.
Allow the program download and update the files for you. When a file is found modified both in the latest build and the installation, you need
to select whether to keep the local copy, by clicking Ignore update or to apply the latest version by clicking Overwrite. When a file is found
removed in the latest build but exist in the installation, it will be listed in red. Since the file is obsolete and has already been removed in the latest
version, neither Overwrite button nor Ignore update button will be shown on screen. It will be removed without choice.
5.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1387
You can click on the message to start updating. If not, when you restart Visual Paradigm. You'll see the following dialog box:
By clicking Yes, the Visual Paradigm Update program will be launched. Update will be performed.
4.
Open the Application Options window by selecting Tools > Application Options... from the main menu.
2.
In the Application Options window, select General from the list at the left hand side, then open the Update tab.
3.
Select the interval of performing auto update from the Auto update drop down menu.
Description
Never
On every start
Daily
Weekly
Check for product updates every week, when starting Visual Paradigm
Monthly
Check for product updates every month, when starting Visual Paradigm
Available update interval
Click OK to confirm updating. From now on, once the interval elapsed and if there are available updates, you will see the Automatic Update
dialog box, letting you to update to the latest build.
P. 1388
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1389
Connection rules
Model elements can be linked together using connectors. There are connection rules to control the type of model elements a connector support.
Connection rules
P. 1390
Connection rules
P. 1391
System
Collaboration
Use case
Actor
Association,
Dependency,
Realization,
Generalization
Dependency,
Realization
Dependency,
Realization
Association,
Dependency,
Realization
System
Dependency,
Realization
Dependency,
Realization
Dependency,
Realization
Dependency,
Realization
Collaboration
Dependency,
Realization
Dependency,
Dependency,
Realization,
Generalization
Association,
Dependency,
Realization
Use case
Dependency,
Realization
Dependency,
Realization
Association,
Dependency,
Realization
Association,
Dependency,
Include,
Extend,
Realization,
Generalization
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1392
NARY
Collaboration
Model
Class
Generalization,
Realization,
Usage,
Association,
Aggregation,
Composition,
Dependency,
Binding Dependency,
Permission,
Access,
Import,
Merge,
Instantiation,
Substitution,
Abstraction,
Derive,
Refine,
Trace
Realization,
Association,
Aggregation,
Composition,
Dependency,
Access,
Import,
Merge,
Instantiation,
Substitution
Realization,
Dependency,
Binding Dependency,
Permission,
Access,
Import,
Merge,
Instantiation,
Substitution,
Abstraction,
Derive,
Refine,
Trace
Realization
Dependency,
Binding Dependency,
Permission,
Access,
Import,
Merge,
Instantiation,
Substitution,
Abstraction,
Derive,
Refine,
Trace
NARY
Realization,
Association,
Aggregation,
Composition,
Dependency,
Access,
Import,
Merge,
Instantiation,
Substitution
Realization,
Dependency,
Access,
Import,
Merge,
Instantiation,
Substitution
Realization,
Dependency,
Access,
Import,
Merge,
Instantiation,
Substitution,
Realization,
Dependency,
Access,
Import,
Merge,
Instantiation,
Substitution,
Collaboration
Realization,
Dependency,
Binding Dependency,
Permission,
Access,
Import,
Merge,
Instantiation,
Substitution,
Abstraction,
Derive,
Refine,
Trace
Realization,
Dependency,
Access,
Import,
Merge,
Instantiation,
Substitution
Generalization,
Realization,
Usage,
Dependency,
Binding Dependency,
Permission,
Access,
Import,
Merge,
Instantiation,
Substitution
Realization,
Dependency,
Binding Dependency,
Access,
Import,
Merge,
Instantiation,
Substitution,
Abstraction,
Derive,
Refine,
Trace
Model
Realization,
Dependency,
Binding Dependency,
Permission,
Access,
Import,
Merge,
Instantiation,
Substitution,
Abstraction,
Derive,
Refine,
Trace
Realization,
Dependency,
Access,
Import,
Merge,
Instantiation,
Substitution
Realization,
Dependency,
Binding Dependency,
Access,
Import,
Merge,
Instantiation,
Substitution,
Abstraction,
Derive,
Refine,
Trace
Generalization,
Realization,
Usage,
Dependency,
Binding Dependency,
Access,
Import,
Merge,
Instantiation,
Substitution,
Abstraction,
Derive,
Refine,
Trace
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1393
Combined fragment
Interaction use
Frame
Actor
Concurrent Continuation
Gate
Message
Message Message
Message
Message
Message
Message
Message
Message
Combined fragment
Interaction use
Frame
Actor
Concurrent
Continuation
Gate
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1394
Actor
Lifeline
Line,
Dependency
Link,
Dependency
Actor
Link,
Dependency
Link,
Generalization,
Dependency
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1395
Deep
history
Choice Junction
Fork
Join
Entry
point
Exit
point
Terminate
Final
state
Transition Transition
Transition Transition Transition Transition Transition Transition Transition Transition Transition Transition
Transition Transition Transition Transition Transition Transition Transition Transition Transition Transition
Initial
pseudo
state
Transition Transition
Transition Transition Transition Transition Transition Transition Transition Transition Transition Transition
Shallow
history
Transition
Transition Transition Transition Transition Transition Transition Transition Transition Transition Transition
Deep
history
Transition
Transition Transition Transition Transition Transition Transition Transition Transition Transition Transition
Choice
Transition
Transition Transition Transition Transition Transition Transition Transition Transition Transition Transition
Junction
Transition
Transition Transition Transition Transition Transition Transition Transition Transition Transition Transition
Fork
Transition
Transition Transition Transition Transition Transition Transition Transition Transition Transition Transition
Join
Transition Transition
Transition Transition Transition Transition Transition Transition Transition Transition Transition Transition
Entry
point
Transition Transition
Exit point
Transition Transition
Transition Transition Transition Transition Transition Transition Transition Transition Transition Transition
Terminate
Final state
Connection rules in state machine diagram
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1396
Activity
Control
Flow
Activity Action
parameter
node
Accept
event
action
Send
signal
action
Decision
node
Merge
node
Fork
node
Join
node
Initial
node
Activity
final
node
Flow
final
node
Input
pin
Output
pin
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Object
Flow
Control
Flow
Control
Flow
Object
Flow
Activity Object
parameter Flow
node
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Action
Control
Flow
Object
Flow
Control Control
Flow,
Flow
Exception
handler
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Object
Flow
Control
Flow
Control
Flow
Object
Exception
Flow,
handler
Exception
handler
Accept
event
action
Control
Flow
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Object
Flow
Control
Flow
Control
Flow
Object
Exception
Flow,
handler
Exception
handler
Send
signal
action
Control
Flow
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Object
Flow
Control
Flow
Control
Flow
Object
Exception
Flow,
handler
Exception
handler
Decision Control
node
Flow
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Object
Flow
Control
Flow
Control
Flow
Object
Flow
Merge
node
Control
Flow
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Object
Flow
Control
Flow
Control
Flow
Object
Flow
Fork
node
Control
Flow
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Object
Flow
Control
Flow
Control
Flow
Object
Flow
Join
node
Control
Flow
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Object
Flow
Control
Flow
Control
Flow
Object
Flow
Initial
node
Control
Flow
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Object
Flow
Control
Flow
Control
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Activity
final
node
Flow
final
node
Input
pin
Output
pin
Object
Flow
Value
pin
Object
node
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Central
buffer
node
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Data
store
node
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Interruptible
activity
region
Expansion
region
ExpansionObject
node
Flow
Exception Exception
handler handler
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
P. 1397
Swimlane
StructuredControl
Activity Flow
node
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Exception Exception
handler handler
ConditionalControl
node
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Exception Exception
handler handler
Loop
node
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Exception Exception
handler handler
Sequence Control
node
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Exception Exception
handler handler
Value
pin
Object
node
Central
buffer
node
Data
store
node
Sequence
node
Activity
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Activity
parameter
node
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Action
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Accept
event
action
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Send
signal
action
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Decision
node
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Merge
node
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Fork node
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Join node
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Initial
node
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Activity
final node
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Flow final
node
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Input pin
Output pin
Object
Flow
Value pin
Object
node
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Central
buffer
node
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Data store
node
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
P. 1398
Interruptible
activity
region
Expansion
region
Exception
handler
Expansion
node
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Object
Flow
Exception
handler
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Conditional Exception
node
handler
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Loop node
Exception
handler
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Sequence
node
Exception
handler
Control
Flow
Control
Flow
Control
Flow
Control
Flow
Swimlane
Structured
Activity
node
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1399
Interface
Port
Instance specification
Component
Dependency,
Generalization,
Realization,
Association,
Aggregation,
Composition,
Usage
Dependency,
Association,
Aggregation,
Composition,
Usage
Dependency,
Generalization,
Realization,
Association,
Aggregation,
Composition,
Usage
Dependency,
Realization
Interface
Dependency,
Realization,
Association,
Aggregation,
Composition,
Usage
Dependency,
Generalization,
Realization,
Association,
Aggregation,
Composition,
Usage
Dependency,
Generalization,
Realization,
Association,
Aggregation,
Composition
Dependency,
Generalization,
Realization,
Association,
Aggregation,
Composition
Port
Dependency,
Realization,
Association,
Aggregation,
Composition,
Usage
Dependency,
Association,
Aggregation,
Composition,
Usage
Dependency,
Realization,
Association,
Aggregation,
Composition
Dependency,
Realization
Instance specification
Dependency,
Realization
Dependency,
Generalization,
Realization,
Association,
Aggregation,
Composition
Dependency
Dependency,
Generalization,
Realization,
Link
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1400
Artifact
Deployment
specification
Component
Interface
Port
Instance
specification
Node
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Deployment,
Generalization,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Deployment,
Generalization,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation
Dependency,
Manifestation,
Realization
Dependency,
Manifestation,
Realization
Artifact
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization,
Usage
Dependency,
Manifestation
Dependency,
Manifestation,
Realization
Dependency,
Manifestation,
Realization
Deployment
specification
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization,
Usage
Dependency,
Manifestation
Dependency,
Manifestation,
Realization
Dependency,
Manifestation,
Realization
Component
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization
Dependency,
Manifestation,
Realization
Interface
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Realization
Dependency,
Manifestation,
Realization
Dependency,
Manifestation,
Realization
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization
Port
Dependency,
Manifestation,
Generalization,
Realization
Dependency,
Manifestation,
Generalization,
Realization
Dependency,
Manifestation,
Generalization,
Realization
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization,
Realization,
Usage
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Usage
Association,
Aggregation,
Composition,
Dependency,
Generalization,
Realization
Dependency,
Manifestation,
Generalization,
Realization
Instance
specification
Dependency,
Manifestation,
Realization
Dependency,
Manifestation,
Realization
Dependency,
Manifestation,
Realization
Dependency,
Manifestation,
Realization
Association,
Aggregation,
Composition,
Dependency,
Manifestation,
Generalization
Dependency,
Manifestation,
Realization
Link,
Dependency,
Manifestation,
Deployment,
Generalization,
Realization
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1401
Dependency,
Import,
Access,
Generalization,
Realization,
Merge
Subsystem Dependency,
Import,
Access,
Realization,
Merge
Subsystem
Dependency,
Import,
Access,
Realization,
Merge
Dependency,
Import,
Access,
Generalization,
Realization,
Merge
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1402
Class
Instance specification
Link,
Dependency,
Generalization,
Realization
Association,
Aggregation,
Composition,
Dependency,
Generalization,
Realization
Class
Association,
Aggregation,
Composition,
Dependency,
Generalization,
Realization
Association,
Aggregation,
Composition,
Dependency,
Generalization,
Realization
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1403
Part
Property
Interface
Port
Collaboration
Collaboration
Use
Class
Dependency,
Represents,
Occurrence,
Generalization,
Realization
Dependency,
Represents,
Occurrence,
Realization
Dependency,
Represents,
Occurrence,
Realization
Association,
Aggregation,
Composition,
Dependency,
Represents,
Occurrence,
Generalization
Association,
Aggregation,
Composition,
Dependency,
Represents,
Occurrence,
Generalization,
Realization
Association,
Aggregation,
Composition,
Dependency,
Represents,
Occurrence,
Realization
Association,
Aggregation,
Composition,
Dependency,
Represents,
Occurrence,
Realization
Part
Dependency,
Represents,
Occurrence,
Connector,
Dependency,
Represents,
Occurrence
Connector,
Dependency,
Represents,
Occurrence
Dependency,
Represents,
Occurrence
Connector,
Dependency,
Represents,
Occurrence
Dependency,
Represents,
Occurrence
Dependency,
Represents,
Occurrence,
Property
Dependency,
Represents,
Occurrence
Connector,
Dependency,
Represents,
Occurrence
Connector,
Dependency,
Represents,
Occurrence
Dependency,
Represents,
Occurrence
Connector,
Dependency,
Represents,
Occurrence
Dependency,
Represents,
Occurrence
Dependency,
Represents,
Occurrence
Interface
Association,
Aggregation,
Composition,
Dependency,
Represents,
Occurrence,
Generalization,
Realization
Dependency,
Represents,
Occurrence,
Realization
Dependency,
Represents,
Occurrence,
Realization
Association,
Aggregation,
Composition,
Dependency,
Represents,
Occurrence,
Generalization,
Realization
Association,
Aggregation,
Composition,
Dependency,
Represents,
Occurrence,
Generalization,
Realization
Association,
Aggregation,
Composition,
Dependency,
Represents,
Occurrence,
Realization
Association,
Aggregation,
Composition,
Dependency,
Represents,
Occurrence,
Realization
Port
Association,
Aggregation,
Composition,
Dependency,
Represents,
Occurrence,
Realization
Connector,
Dependency,
Represents,
Occurrence,
Realization
Connector,
Dependency,
Represents,
Occurrence,
Realization
Association,
Aggregation,
Composition,
Dependency,
Represents,
Occurrence
Connector,
Association,
Aggregation,
Composition,
Dependency,
Represents,
Occurrence,
Realization
Dependency,
Represents,
Occurrence,
Realization
Dependency,
Represents,
Occurrence,
Realization
Collaboration
Association,
Aggregation,
Composition,
Dependency
Represents,
Occurrence,
Realization
Dependency
Represents,
Occurrence,
Realization
Dependency
Represents,
Occurrence,
Realization
Association,
Aggregation,
Composition,
Dependency
Represents,
Occurrence
Association,
Aggregation,
Composition,
Dependency
Represents,
Occurrence,
Realization
Dependency
Represents,
Occurrence,
Realization
Association,
Aggregation,
Composition,
Dependency
Represents,
Occurrence,
Realization
Collaboration
Use
Association,
Aggregation,
Composition,
Dependency
Represents,
Occurrence,
Realization
Dependency
Represents,
Occurrence,
Realization
Dependency
Represents,
Occurrence,
Realization
Association,
Aggregation,
Composition,
Dependency
Represents,
Occurrence
Dependency
Represents,
Occurrence,
Realization
Association,
Aggregation,
Composition,
Dependency
Represents,
Occurrence,
Realization
Dependency
Represents,
Occurrence,
Realization
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1404
Interaction
use
Decision
node
Merge node
Fork node
Join node
Initial node
Activity final
Interaction
Control flow
Control flow
Control flow
Control flow
Control flow
Control flow
Control flow
Interaction
use
Control flow
Control flow
Control flow
Control flow
Control flow
Control flow
Control flow
Decision
node
Control flow
Control flow
Control flow
Control flow
Control flow
Control flow
Control flow
Merge node
Control flow
Control flow
Control flow
Control flow
Control flow
Control flow
Control flow
Fork node
Control flow
Control flow
Control flow
Control flow
Control flow
Control flow
Control flow
Join node
Control flow
Control flow
Control flow
Control flow
Control flow
Control flow
Control flow
Initial node
Control flow
Control flow
Control flow
Control flow
Control flow
Control flow
Control flow
Activity final
Connection rules in interaction overview diagram
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1405
Satisfy,
Refine
Testcase
Verify,
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1406
Decision
Business actor
Document
Process
Connector
Connector
Connector
Connector
Decision
Connector
Connector
Connector
Connector
Business actor
Connector
Connector
Connector
Connector
Document
Connector
Connector
Connector
Connector
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Basic diagram
P. 1407
View
Entity
One-to-one
relationship,
One-to-many
relationship,
Many-to-many
relationship
One-to-one
relationship,
One-to-many
relationship,
Many-to-many
relationship
View
One-to-one
relationship,
One-to-many
relationship,
Many-to-many
relationship
One-to-one
relationship,
One-to-many
relationship,
Many-to-many
relationship
Sequence
Stored
procedures
Stored
procedure
resultset
Triggers
Sequence
Stored
procedures
Stored
procedure
resultset
Triggers
Connection rules in entity relationship diagram
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1408
Association,
Aggregation,
Composition
Entity
View
Class-entity mapping
Class-entity mapping
One-to-one relationship,
One-to-many relationship,
Many-to-many relationship
One-to-one relationship,
One-to-many relationship,
Many-to-many relationship
View
One-to-one relationship,
One-to-many relationship,
Many-to-many relationship
One-to-one relationship,
One-to-many relationship,
Many-to-many relationship
Class-entity mapping
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1409
Subprocess
Start
event
Intermediate
event
End
event
GatewayChoreography
Choreography Call
task
Subactivity
process
Text
annotation
Data
Object
Pool/
Lane
Task
Sequence
flow,
Message
flow
Sequence Message
flow,
flow
Message
flow
Sequence
flow,
Message
flow
Association,Association,
ToToDirection Direction
Association Association,
Data
Association
Subprocess
Sequence
flow,
Message
flow
Sequence Message
flow,
flow
Message
flow
Sequence
flow,
Message
flow
Association,Association,
ToToDirection Direction
Association Association,
Data
Association
Start
event
Sequence Sequence
flow,
flow,
Intermediate
Sequence Sequence
event
flow,
flow,
End
event
Message
flow
Message
flow
Gateway
Sequence
flow,
Message
flow
Message
flow
Message
flow
Association,Association,
ToToDirection Direction
Association Association
Sequence
flow,
Message
flow
Sequence
flow,
Message
flow
Association,Association,
ToToDirection Direction
Association Association
Choreography
Sequence Sequence
task
flow,
flow,
Association,
ToDirection
Association
Choreography
Sequence Sequence
subflow,
flow,
process
Association,
ToDirection
Association
Call
activity
Sequence
flow,
Message
flow
Message
flow
Sequence Message
flow,
flow
Message
flow
Sequence
flow,
Message
flow
Association,Association,
ToToDirection Direction
Association Association,
Data
Association
Text
Association,Association,Association,Association,Association,Association,Association,Association,Association,
annotation ToToToToToToToToToDirection Direction Direction Direction Direction Direction Direction Direction Direction
Association Association Association Association Association Association Association Association Association
Data
object
Association,Association,Association,Association,Association,Association,
ToToToToToToDirection Direction Direction Direction Direction Direction
Association Association Association Association Association Association
Association,Association,
ToToDirection Direction
Association Association
Association,Association,Data
ToToAssociation
Direction Direction
Association Association
Pool/
lane
Association,
ToDirection
Association
Connection rules in business process diagram
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
P. 1410
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1411
Conversation link,
Sub-conversation link,
Call conversation link
Text annotation
Association
Text annotation
Association
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1412
External entity
Process
Data Flow,
Bidirectional data flow
External entity
Data Flow,
Bidirectional data flow
Data store
Data Flow,
Bidirectional data flow
Data Flow,
Bidirectional data flow
Data store
Data Flow,
Bidirectional data flow
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1413
Event
Function
And
operator
Or
operator
XOR
operator
Control
flow
Control
flow
Control
flow
Control
flow
Function
Control
flow
Control
flow
Control
flow
Control
flow
Control
flow
And
operator
Control
flow
Control
flow
Control
flow
Control
flow
Control
flow
Or
operator
Control
flow
Control
flow
Control
flow
Control
flow
Control
flow
XOR
operator
Control
flow
Control
flow
Control
flow
Control
flow
Control
flow
Organization
unit
Process
path
Information
resource
Organization
unit
Process
path
Information
resource
Control
flow
Information
flow
Organization
unit
assignment
Control
flow
Information
flow
Connection rules in EPC diagram
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1414
Send
Receive
Process link
Process link
Send
Process link
Process link
Process link
Process link
Process link
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1415
Line
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1416
Fact Type
Term-Fact Type Association
Fact
Type
Connection rules in fact diagram
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1417
Vision
Goal
Objective
Means
Mission
Strategy
Component
of Plan for,
Define,
Require
Enable,
Formulated
Based on,
Require,
Composition
Tactic
Business
Policy
Business
Rule
End
Vision
Goal
Amplify
Objective
Composition
Quantity
Composition
Strategy
Channel
Efforts,
Define,
Require
Channel
Efforts,
Define,
Require
Tactic
Channel
Efforts,
Define,
Require
Channel
Efforts,
Define,
Require
Business
Policy
Act as
Regulation,
Support
Achievement
Act as
Regulation,
Support
Achievement
Act as
Regulation,
Govern
Act as
Regulation,
Govern
Business
Rule
Act as
Regulation,
Act as
Regulation,
Act as
Regulation,
Govern
Act as
Regulation,
Govern
Means
Mission
Make
Operative
Define,
Require
Enable,
Define,
Formulated Require
Based on,
Require,
Composition
Define,
Require
Define,
Effect
Enforcement
Level,
Require
Composition Act as
Regulation,
Basis for
Internal
Influencer
External
Influencer
Regulation
Assessment Affect
Affect
Affect
Affect
Affect
Affect
Affect
Affect
Affect
Achievement, Achievement, Achievement, Achievement, Employment, Employment, Employment, Employment, Employment,
Use
Use
Use
Use
Use
Use
Use
Use
Provide
Impetus,
Use
Affect
Employment,
Provide
Impetus,
Use
Risk
Provide
Impetus
Provide
Impetus
Potential
Reward
Provide
Impetus
Provide
Impetus
Define,
Establish
Define,
Establish
Asset
Liability
P. 1418
Organization Define
Unit
Define
Define
Define
Define,
Establish
Define,
Establish
Business
Process
Define,
Establish
Define,
Establish
Deliver,
Realize
Deliver,
Realize
Asset
Liability
Connection rules in business motivation model diagram A
Business
Rule
Internal
External RegulationAssessment
Influencer Influencer
Risk
End
Vision
Goal
Objective
Means
Mission
Strategy
Define,
Require
Define,
Determine,
Require
Tactic
Define,
Effect
Enforcement
Level,
Require
Business
Policy
Act as
Regulation,
Basis for
Business
Rule
Define
Define,
(Offerings), Discharge,
Require
Require
(Resources)
Define,
Act as
Regulation
Act as
Act as
Act as
Regulation, Regulation, Regulation,
Govern
Govern
Act as
Regulation
Act as
Act as
Act as
Regulation, Regulation, Regulation,
Govern,
Govern
Guide
Define,
Discharge,
Internal
Influencer
External
Influencer
Regulation
Assessment Affect
Judge,
Employment,Use
Provide
Impetus,
Use
Risk
Provide
Impetus
Potential
Reward
Provide
Impetus
Organization Define,
Unit
Establish
Judge,
Use
Judge,
Use
Define,
Define,
Define
Recognize, Recognize,
Source
Source
Use
Identity,
Use
Identity,
Use
Define,
Make
Define,
Define
Define,
Responsible (Offerings), Responsible
Responsible
Business
Process
Deliver
(Offerings),
Manage
Asset
Liability
Claim
(Resources
Only)
Connection rules in business motivation model diagram B
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1419
Business
Business
Business
role
collaboration process
Business
actor
Aggregation, Assignment
Composition,
Specialization
Business
role
Assignment
Business
function
Business
interaction
Business
event
Junction
Business
service
Realization
Aggregation,
Composition,
Specialization
Assignment
Assignment
Assignment
Business
collaboration
Aggregation Aggregation,
Composition,
Specialization
Business
process
Assignment
Triggering, Triggering
Aggregation,
Composition,
Specialization
Triggering
Triggering
Triggering
Realization
Business
function
Assignment
Triggering
Triggering
Realization
Business
interaction
Assignment
Triggering
Realization
Triggering
Triggering
Triggering, Triggering
Aggregation,
Composition,
Specialization
Business
event
Triggering
Triggering
Triggering
Aggregation,
Composition,
Specialization
Junction
Triggering
Triggering
Triggering
Triggering
Business
service
Used by
Used by
Used by
Business
interface
Association
Business
object
Product
Assignment
Assignment
Aggregation,
Composition,
Specialization
Association
Assignment
Read
access
Read
access
Read
access
Used by
Read
access
Read
access
Aggregation
Contract
Read
access
Representation
Meaning
Value
Association
Application
collaboration
Assignment
Application
component
Assignment
Assignment
Assignment
Application
service
Used by
Used by
Used by
Used by
Application
function
Application
interaction
Application
interface
Used by
Data
object
P. 1420
Node
Device
System
software
Infrastructure
interface
Infrastructure
service
Artifact
Connection rules in archimate diagram A
Business
interface
Business
actor
Line
Business
role
Association
Business
collaboration
Association
Business
object
Business
process
Read access,
Write access,
Business
function
Read access,
Write access
Business
interaction
Read access,
Write access
Business
event
Read access,
Write access
Product
Contract
Representation
Meaning
Value
Junction
Business
service
Assignment
Business
interface
Aggregation,
Specialization
Business
object
Read access,
Write access
Read access,
Write access
Association,
Aggregation,
Specialization
Product
Association
Aggregation,
Specialization
Contract
Representation
Aggregation
Association
Aggregation,
Specialization
Realization,
Association
Meaning
Value
Association
Aggregation,
Specialization
Association
Association
Aggregation,
Specialization
Association
Aggregation,
Specialization
Application
collaboration
Application
component
Application
service
Application
P. 1421
function
Application
interaction
Application
interface
Data object
Realization
Node
Device
System
software
Infrastructure
interface
Infrastructure
service
Artifact
Connection rules in archimate diagram B
Application
collaboration
Application
component
Application
service
Application
function
Application
interaction
Application
interface
Data
object
Business
actor
Business
role
Require
Business
collaboration
Business
process
Assignment
Business
function
Business
interaction
Assignment
Assignment
Business
event
Junction
Business
service
Used by
Business
interface
Used by
Used by
Business
object
Product
Contract
Representation
Meaning
Value
Application
collaboration
Aggregation,
Composition,
Specialization
Association,
Aggregation
Application
component
Association,
Composition
Aggregation,
Composition,
Specialization
Assignment
Realization
Assignment,
Composition
Provide,
Require
Association,
Provide,
Require,
P. 1422
Composition
Application
service
Aggregation,
Composition,
Specialization
Application
function
Application
interaction
Assignment
Assignment
Application
interface
Realization
Assignment
Aggregation,
Composition,
Specialization
Realization
Association
Data
object
Read
access,
Write
access
Read
access,
Write
access
Aggregation,
Composition,
Specialization
Assignment
Read access,
Write access
Read
access,
Write
access
Aggregation,
Composition,
Specialization
Read access,
Write access
Read access,
Write access
Association,
Aggregation,
Composition,
Specialization
Node
Device
System
software
Infrastructure
interface
Infrastructure
service
Artifact
Realization
Realization
Connection rules in archimate diagram C
Node
Device
System software
Infrastructure
interface
Infrastructure
service
Artifact
Business
actor
Business
role
Business
collaboration
Business
process
Business
function
Business
interaction
Business
event
Junction
Business
service
Business
interface
Business
object
P. 1423
Product
Contract
Representation
Meaning
Value
Application
collaboration
Application
component
Application
service
Application
function
Application
interaction
Application
interface
Data
object
Node
Communication path,
Aggregation,
Composition,
Specialization
Composition
Composition
Provide,
Require
Realization
Assignment
Device
Network
Aggregation,
Composition,
Specialization
Assignment
Provide,
Require
Realization
Assignment
Assignment
Aggregation,
Composition,
Specialization
Provide,
Require
Realization
Assignment
Infrastructure
interface
Aggregation,
Composition,
Specialization
Assignment
Infrastructure
service
Assignment
Aggregation,
Composition,
Specialization
Read access,
Write access
Read access,
Write access
Aggregation,
Composition,
Specialization
System
software
Artifact
Assignment
Assignment
Assignment
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1424
Diagram containment,
Directional generic connector
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1425
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
P. 1426
Multi-Languages support
In Visual Paradigm, the default language is English. However, you might find it more convinient to use another language which is your first language
to operate the software, so that you can understand the commands more easily and to perform the desired actions faster. Actually, Visual Paradigm
supports the capability to allow users to switch to other langauges like Traditional Chinesem French and many others. In the following, we will show
you the way to switch your User Interface into your preferred language. Please follow the simple steps below.
1.
2.
Application window
3.
In the Installed User Language field, check your preferred language in the Use Column.
Click OK.
5.
Related Resources
The following resources may help you to learn more about the topic discussed in this page.
New to Visual Paradigm? We have a lot of UML tutorials written to help you get started with Visual Paradigm
Visual Paradigm Know-How - Tips and tricks, Q&A, solutions to users' problems
Multi-languages support
P. 1427