Visual Paradigm User's Guide

Last Modified: Sep 18, 2023

Download single PDF

File Size: 46 MB

Table of Contents

Part I. Getting started

1. Introduction to Visual Paradigm

1.1. Trademark Disclaimer

1.2. Visual Paradigm product overview

1.3. Visual Paradigm Products

1.4. Licensing

1.5. Software maintenance

1.6. System requirements

2. Installing Visual Paradigm

2.1. Windows 2000/NT/2003/XP/Vista/7/8/10

2.2. Mac OSX

2.3. Linux and Unix

3. Activating/De-activating Visual Paradigm

3.1. Starting Visual Paradigm

3.2. Deleting License

3.3. Activating Visual Paradigm with Academic License

4. Uninstalling Visual Paradigm

4.1. Uninstalling Visual Paradigm

5. User interface

5.1. Interface Overview

5.2. Toolbar

5.3. Diagram editor

5.4. Description pane

5.5. Message pane

5.6. Project Browser

5.7. Logical view

6. Working with projects

6.1. Creating Project

6.2. Saving Project

6.3. Organizing diagrams by Model Structure view

6.4. Manage Project Properties window

6.5. Switch to Diagram

Part II. UML modeling

1. Use case diagram

1.1. Drawing use case diagrams

1.2. Use case diagram notations guide

1.3. Documenting use case details

1.4. Note down use case related ideas in Use Case Note

1.5. Produce use case scenario from notes

2. Class diagram

2.1. Drawing class diagrams

3. Sequence diagram

3.1. Drawing sequence diagrams

4. Communication diagram

4.1. Drawing communication diagrams

5. State machine diagram

5.1. Creating state machine diagrams

6. Activity diagram

6.1. Drawing activity diagrams

6.2. Splitting Control Flow in Activity Diagram

7. Component diagram

7.1. Drawing component diagrams

8. Deployment diagram

8.1. Drawing deployment diagrams

9. Package diagram

9.1. Drawing package diagrams

10. Object diagram

10.1. Drawing object diagrams

11. Composite structure diagram

11.1. Drawing composite structure diagrams

12. Timing diagram

12.1. Drawing timing diagrams

13. Interaction overview diagram

13.1. Drawing interaction overview diagrams

14. Requirement diagram

14.1. Drawing requirement diagram

14.2. Customizing requirement types

14.3. Modeling and documenting test cases

14.4. Record and document software requirements in Requirement List

15. Textual analysis

15.1. Documenting Requirements with Textual Analysis Tool

15.2. Identifying important terms

15.3. Identifying candidate objects

15.4. Forming diagram from candidate objects

15.5. Candidate pane view

16. CRC card diagram

16.1. Drawing CRC card diagram

Part III. Project glossary

1. Working with glossary

1.1. Identify glossary term

1.2. Using Glossary Grid

2. Grid diagram

2.1. Creating grid diagram

2.2. Creating element in grid

2.3. Configuring property columns

2.4. Setting the scope of grid content

2.5. Filtering and searching in grid

2.6. Adding new property to model elements through grid

Part IV. BPMN toolset

1. Business Process Diagram

1.1. Drawing business process diagram

1.2. Pool and lane

1.3. Task and sub-process

1.4. Event

1.5. Gateway

1.6. Sequence and message flows

1.7. Choreography task and sub-process

1.8. Data object

1.9. Creating use cases from BPMN tasks

2. Conversation Diagram

2.1. Drawing BPMN conversation diagram

Part V. Project management

1. Maturity Analysis

1.1. Performing Maturity Analysis

2. Implementation Plan Diagram

2.1. Drawing an Implementation Plan

3. PERT Chart

3.1. Drawing a PERT Chart

4. Documentation Cabinet

4.1. Using Documentation Cabinet in Visual Paradigm

Part VI. Modeling toolset

1. Editing diagrams

1.1. Creating diagrams

1.2. Closing diagram

1.3. Model element and view

1.4. Opening diagram

1.5. Master view and auxiliary view

1.6. Resource Centric Interface

1.7. Tagged Values

1.8. Spell Checking

1.9. Diagram specification window

1.10. Model element specification window

1.11. Showing visible description in diagram

2. Project management properties

2.1. Using project management properties

2.2. Configuring project management properties look-ups

3. Style and formatting

3.1. Applying fill, line and font styles

3.2. Managing and applying styles

3.3. Setting line style

3.4. Setting line jumps options

3.5. Setting connector caption orientation

3.6. Format copier

3.7. Set connection point style

3.8. Present shape as primitive shape

4. General modeling techniques

4.1. Automatic Diagram Layout

4.2. Fit Shape Size

4.3. Diagram Element Selection

4.4. Copy and paste

4.5. Alignment guide

4.6. Reverse connector direction

4.7. Visualize related model elements

4.8. Adding comments

4.9. Pinning connector ends

4.10. Align and distribute diagram elements

4.11. Adjusting caption's position and angle in BPD

4.12. Zooming Diagram

4.13. Diagram grids

4.14. Search bar

5. Advanced modeling techniques

5.1. Sweeper and Magnet

5.2. Mouse gestures

5.3. Jumping to shape

5.4. Grouping diagram elements

5.5. Show/hide diagram elements

5.6. Layer

5.7. Making shape non-selectable

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

5.9. Using overview diagram

5.10. Changing model element type

5.11. Selecting contained shapes with InstantFreeze

6. Annotations and freehand shapes

6.1. UML note

6.2. Callout shape

6.3. Freehand shapes

7. Resource Referencing

7.1. Reference to external resources

7.2. Reference to diagrams, shapes and model elements

7.3. Diagram based reference mapping editor

7.4. Elaborating model element with sub diagram

7.5. Showing model indicator

7.6. In/Out flows in sub-diagram

8. Using shape editor

8.1. Creating Shape in Shape Editor

8.2. Creating Shapes from Stencil Pane

9. Customizing user interface

9.1. Hiding user interface components

9.2. Adjusting user interface font

10. Organizing works with model

10.1. Using model

10.2. Creating diagram under model

10.3. Moving diagram to model

11. Using stereotypes

11.1. Apply Stereotype to Model Element

11.2. Configure stereotypes

11.3. Shortcut of creating stereotyped model element

Part VII. ArchiMate tools

1. ArchiMate diagram

1.1. How to Draw ArchiMate 3.0.1 Diagrams

1.2. Use of Nesting

1.3. Formatting ArchiMate elements

1.4. Migrating from Archi to Visual Paradigm

1.5. Import/Export ArchiMate Model Exchange File into Visual Paradigm

1.6. Customizing ArchiMate language

2. ArchiMate Viewpoints

2.1. Working with Viewpoints

3. Example Viewpoints

3.1. Organization Viewpoint

3.2. Business Process Cooperation Viewpoint

3.3. Product Viewpoint

3.4. Application Cooperation Viewpoint

3.5. Application Usage Viewpoint

3.6. Implementation and Deployment Viewpoint

3.7. Technology Viewpoint

3.8. Technology Usage Viewpoint

3.9. Information Structure Viewpoint

3.10. Service Realization Viewpoint

3.11. Physical Viewpoint

3.12. Layered Viewpoint

3.13. Stakeholder Viewpoint

3.14. Goal Realization Viewpoint

3.15. Requirements Realization Viewpoint

3.16. Motivation Viewpoint

3.17. Strategy Viewpoint

3.18. Capability Map Viewpoint

3.19. Outcome Realization Viewpoint

3.20. Resource Map Viewpoint

3.21. Project Viewpoint

3.22. Migration Viewpoint

3.23. Implementation and Migration Viewpoint

Part VIII. Team collaboration

1. Getting started

1.1. Introduction to team collaboration

1.2. Teamwork Client in Visual Paradigm

2. Basic features

2.1. Checkout and open project

2.2. Commit works to server

2.3. Commit part of a project

2.4. Update project from server

2.5. Revert local modification

2.6. Import project to server

3. Advanced features

3.1. Branching in server

3.2. Tagging in Server

3.3. Roll back past revisions changes

3.4. Export revisions from server

3.5. Managing Teamwork Files

3.6. Model element/diagram protection

3.7. See the evolution of design using Visual History

3.8. Design recovery with Visual History

4. PostMania

4.1. What is PostMania?

4.2. Sharing Diagram

4.3. Getting Notified of New Posts

4.4. Posting and Replying

4.5. Following Post

4.6. Managing Shared Diagrams (Viewer Based)

4.7. Managing Diagram Viewers

4.8. Searching a Post

Part IX. Code engineering

1. Instant Reverse

1.1. Reverse engineering of Java sources and classes

1.2. Reverse engineering of C++ header files

1.3. Reverse engineering of .NET dll and exec files

1.4. Reverse engineering of CORBA IDL source file

1.5. Reverse engineering of Ada 9x source files

1.6. Reverse engineering of XML

1.7. Reverse engineering of XML schema

1.8. Hibernate mapping file

1.9. Reverse engineering of PHP 5.0 source files

1.10. Reverse engineering of Python

1.11. Reverse engineering of Objective-C

1.12. Java to sequence diagram

2. Instant Generation

2.1. Instant Generator for Java

2.2. Instant generate for C# source code

2.3. Instant generate for VB.NET source code

2.4. Instant Generator for PHP source code

2.5. Instant Generator for ODL source code

2.6. Instant Generator for ActionScript source code

2.7. Instant Generator for IDL source code

2.8. Instant Generator for C++ source code

2.9. Instant Generator for Delphi source code

2.10. Instant Generator for Perl source code

2.11. Instant Generator for XML schema file

2.12. Instant Generator for Python source code

2.13. Instant Generator for Objective-C source code

2.14. Instant Generator for Objective-C 2.0 source code

2.15. Instant Generator for Ada95

2.16. Instant Generator for Ruby

2.17. Customizing code generation

3. Java Round-Trip

3.1. Generate or Update Java code from UML classes

3.2. Generate or update UML classes from Java code

4. C++ Round-trip

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

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

5. Reverse ORM POJO Classes

5.1. Reversing POJO

6. Generating Object-Relational Mapping Code

6.1. Generating code and database

6.2. Lazy collection setting

6.3. Persistent API

6.4. Using generated code

6.5. Customizing getter and setter body

7. State Machine Diagram Code Generation

7.1. Modeling guidelines

7.2. Generating state machine code

7.3. Reverse state machine code

8. Generating REST API

8.1. Overview of REST API Generation

8.2. Modeling REST API

8.3. Generating REST API as Service Provider

8.4. Using REST API (as a Service Consumer)

Part X. Database design and engineering

1. Introduction

1.1. Overview of Database Design & Management with Visual Paradigm

1.2. Benefits of Designing Database with Visual Paradigm

1.3. Database Configuration

1.4. Sharing Database Configuration between Projects

1.5. Supported Database, JDBC Drivers and .NET Drivers

2. Designer Guides

2.1. Drawing Entity Relationship Diagram

2.2. Conceptual, Logical and Physical Data Model

2.3. Using Entity Domain

2.4. Using Column Domain

2.5. Applying Default Schema on ERD

2.6. Using Auto Column

2.7. Entering Sample Table Records for Entities

2.8. Modeling Database View

2.9. Modeling Stored Procedures in ERD

2.10. Modeling Triggers in ERD

2.11. Working with Unique Constraint

2.12. Using ID Generator

2.13. Different Inheritance Strategies

2.14. Using Discriminator Column

2.15. Using Array Table

2.16. Using Partial Table

2.17. Mapping Object Model to Data Model

2.18. Mapping Data Model to Object Model

2.19. Synchronizing object model and data model

3. Database Management Guides

3.1. Reverse Engineering ERD from Database

3.2. Reverse Engineering ERD from DDL

3.3. Generating Database from ERD

3.4. Patching Design Changes to Database

3.5. Copying SQL Statements from Entities in ERD

4. Programming Guides

4.1. What is Object Relational Mapping (ORM)?

4.2. Generating ORM Code from Database

4.3. Generating ORM code from class diagram

4.4. PersistentManager and Transaction

4.5. Using ORM Qualifier

4.6. Using ORM Criteria

Part XI. Advanced modeling toolset

1. Maintaining project reference

1.1. Referencing Another Project

1.2. Referencing other projects' model elements

1.3. Mirroring model element

1.4. Viewing referenced diagrams

1.5. Duplicating element from referenced project

1.6. Refactoring

2. Model element nicknaming

2.1. What is nickname?

2.2. Configure nickname

2.3. Using nickname

2.4. Export and import word document of nickname

3. Visual Diff

3.1. What is Visual Diff?

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

3.3. Comparing logical and physical ERD

4. Using design pattern

4.1. Defining design pattern

4.2. Applying design pattern

4.3. Synchronize design pattern with VPository

5. Model transitor

5.1. Model Transitor (Diagram Element and Model Element)

5.2. Model transitor for diagram

6. Customizing elements with profile

6.1. Drawing a profile diagram

7. Mind mapping diagram

7.1. Drawing mind mapping diagram

7.2. Formatting nodes

7.3. Linking nodes

7.4. Reference to resources

7.5. Relocating a branch

7.6. Layout nodes and diagram

8. Brainstorm

8.1. Using Brainstorm

8.2. Realizing Brainstorm Notes

9. Color Legend

9.1. Using Color Legend

Part XII. Document production

1. Publishing project to Web Site

1.1. Publish project using project publisher

1.2. Using the published contents

2. Doc. Composer - Introduction

2.1. Introducing Doc. Composer

3. Doc. Composer - Build from Scratch

4. Doc. Composer - Fill-in Doc

4.1. Introduction to the Fill-in Doc Mode

4.2. Understanding Doc Base

4.3. Understanding Doc Field

4.4. Creating a Fill-in Doc

4.5. Touching-Up a Document

4.6. Previewing a Document

4.7. Generating a Document

4.8. Doc Fields in Detail

4.9. Querying Diagrams

4.10. Querying Model Elements

4.11. Querying Diagram Elements

4.12. Using Custom Text

4.13. Working with Table

4.14. Managing Doc Templates in Team Environment

5. Doc. Composer - Writing Element Templates

5.1. What is Doc. Composer Template Language

5.2. Template Root

5.3. Text and Property

5.4. Looping (Non Connector)

5.5. Looping (Connector)

5.6. Sorting in Loop

5.7. Conditional Expression

5.8. Working with Table

5.9. Working with Image

5.10. Working with Break

5.11. Working with other DCTL Constructs

5.12. Reusing Template with Inline or Reference

5.13. Using variables in Doc. Composer

5.14. DCTL Examples

5.15. Supported Diagram Types

Part XIII. Business modeling

1. Data Flow Diagram

1.1. Creating data flow diagram

2. Event-driven Process Chain Diagram

2.1. Creating EPC diagram

3. Process Map Diagram

3.1. Creating process map diagram

4. Organization Chart

4.1. Creating organization chart

5. RACI Chart

5.1. Forming RACI Chart from Business Process Diagram

5.2. Forming RACI chart from EPC Diagram

6. Business Concept Diagram

6.1. Drawing Business Concept Diagram

Part XIV. Business rule

1. Business rule management

1.1. Managing business rules

1.2. Business rule grid

2. Fact Model

2.1. Creating Fact Model

3. Decision table

3.1. Creating Decision Table

3.2. Describing rules, conditions and actions in Decision Table

3.3. Filter in Decision Table

Part XV. Agile development

2. User Story

2.1. Writing general user stories

2.2. Writing user story in use case basis

2.3. Status of a user story

2.4. Performing estimation on a user story

2.5. Categorizing user stories by tag

2.6. Filtering user stories in UeXceler

2.7. Prioritize user stories

2.8. Sharing user stories by sharing links

2.9. Recording conversation items in user story

2.10. Recording confirmation items in user story

2.11. Using user story scenario

2.12. Perform scenario-based wireframing

2.13. Wireframe playback

2.14. Adding storyboard to user stories

2.15. Adding sub-diagrams and references to user stories

2.16. Tracing changings of a user story

2.17. Incorporating user stories in system design

4. Sprint

4.1. What is a sprint?

4.2. Adding a sprint

4.3. Adding user stories into a sprint

4.4. Adjusting sprint duration

4.5. Configuring sprint members

4.6. Assigning user stories to team members

4.7. Closing a sprint

4.8. Deleting a sprint

4.9. Using the Kanban Board

Part XVI. Wireframe

1. Wireframe

1.1. What is Wireframe?

1.2. What is a wireframe state?

1.3. Android phone wireframing skills

1.4. Android tablet wireframing skills

1.5. Desktop wireframing skills

1.6. iPad wireframing skills

1.7. iPhone wireframing skills

1.8. Web wireframing skills

1.9. Web wireframing with bootstrap components

1.10. Duplicate wireframe

1.11. Using the screen capture tool in wireframe

1.12. Using Smart Edit in wireframe

2. Storyboard

2.1. Creating a wireframe storyboard

2.2. Renaming a wireframe storyboard

2.3. Wireframe playback

2.4. Re-ordering wireframes in a wireframe storyboard

2.5. Moving a storyboard from/to user story

Part XVII. Impact analysis

1. Introduction of impact analysis

1.1. Introduction of impact analysis

2. Analysis Diagram

2.1. Analyzing a model element

2.2. Updating analyzed result

2.3. Grouping of nodes

2.4. Opening view from node

3. Matrix Diagram

3.1. Creating a Matrix

3.2. Reading a matrix

3.3. Showing the Use of Terms with Matrix

4. Chart Diagram

4.1. Chart Diagram

Part XVIII. CMMN toolset

1. CMMN Diagram

1.1. Drawing CMMN diagram

Part XIX. SoaML modeling

1. Service interface diagram

1.1. Creating service interface diagram

2. Service participant diagram

2.1. Creating service participant diagram

3. Service contract diagram

3.1. Creating service contract diagram

4. Services architecture diagram

4.1. Creating services architecture diagram

5. Service categorization diagram

5.1. Creating service categorization diagram

Part XX. Design animation

1. Animation

1.1. What is animation?

1.2. Animating business process diagram

1.3. Animating sequence diagram

1.4. Animating activity diagram

Part XXI. IDE Integration

1. Eclipse Integration

1.1. Overview and Installation of Eclipse Integration

1.2. Creating a UML Project in Eclipse

1.3. Opening a UML Project in Eclipse

1.4. Reverse Engineering in Eclipse

1.5. Code Generation from UML Model in Eclipse

1.6. Selecting UML Class from Source File in Eclipse

1.7. Selecting Source File in Eclipse from UML Class

2. Visual Studio Integration

2.1. Overview and Installation of Visual Studio Integration

2.2. Creating a UML Project in Visual Studio

2.3. Opening a UML Project in Visual Studio

2.4. Reverse Engineering in Visual Studio

2.5. Code Generation from UML Model in Visual Studio

2.6. Selecting UML Class from Source File in Visual Studio

2.7. Selecting Source File in Visual Studio from UML Class

3. NetBeans Integration

3.1. Overview and Installation of NetBeans Integration

3.2. Creating a UML Project in NetBeans

3.3. Opening a UML Project in NetBeans

3.4. Reverse Engineering in NetBeans

3.5. Code Generation from UML Model in NetBeans

3.6. Selecting UML Class from Source File in NetBeans

3.7. Selecting Source File in NetBeans from UML Class

4. IntelliJ IDEA Integration

4.1. Overview and Installation of IntelliJ IDEA Integration

4.2. Creating a UML Project in IntelliJ IDEA

4.3. Opening a UML Project in IntelliJ IDEA

4.4. Reverse Engineering in IntelliJ IDEA

4.5. Code Generation from UML Model in IntelliJ IDEA

4.6. Selecting UML Class from Source File in IntelliJ IDEA

4.7. Selecting Source File in IntelliJ IDEA from UML Class

Part XXII. Interoperability and integration

1. Export and Import XML

1.1. Exporting XML

1.2. Importing XML

2. Export and import VP project

2.1. Exporting Visual Paradigm project

2.2. Importing Visual Paradigm project

3. Export and Import Microsoft Excel

3.1. Exporting to Microsoft Excel

3.2. Importing Microsoft Excel file

3.3. Excel modification guidelines

4. Export and Import XMI

4.1. Exporting XMI

4.2. Importing XMI

5. Export and Import BPMN 2.0

5.1. Exporting BPMN 2.0

5.2. Importing BPMN 2.0

6. Importing Visio drawing

6.1. Importing Visio Drawing into Visual Paradigm

7. Importing Rational Rose model

7.1. Importing Rational Rose Model into Visual Paradigm

8. Importing Rational Software Architect File

8.1. Importing Rational Software Architect EMX into Visual Paradigm

8.2. Importing Rational Software Architect DNX into Visual Paradigm

9. Importing Erwin Data Modeler project file

9.1. Importing ERwin Data Modeler project file into Visual Paradigm

10. Importing Telelogic Rhapsody and System Architect project file

10.1. Importing Rational Rhapsody project into Visual Paradigm

10.2. Importing Rational System Architect into Visual Paradigm

11. Importing NetBeans 6.x UML diagrams

11.1. Importing NetBeans 6.x UML diagrams into Visual Paradigm

12. Importing Bizagi

12.1. Importing Bizagi

13. Exporting diagram to various graphic formats

13.1. Exporting active diagram as image

13.2. Exporting multiple diagrams as images

13.3. Exporting portion of diagram as image

14. Extend functionalities with Open API

14.1. Introduction to plugin support

14.2. Implementing plugin

14.3. Installing plugin

15. Command line interface

15.1. Exporting diagram image

15.2. Exporting and importing XMI

15.3. Exporting and importing XML

15.4. Exporting and importing Excel

15.5. Generating ORM code and/or database

15.6. Instant generator

15.7. Instant reverse

15.8. Java code synchronization

15.9. Project Publisher

15.10. Updating teamwork project from server

15.11. Executing operations with Apache Ant

15.12. Exporting document (Doc. Composer)

15.13. Committing project to server

15.14. Running Plug-in without Starting Visual Paradigm

16. Printing diagrams

16.1. Printing diagrams

16.2. Quick print

Part XXIII. Process simulation

1. Process Simulation

1.1. What is process simulation?

1.2. Simulation control panel

1.3. Simulating business process

1.4. Simulation charts

Part XXIV. Zachman and BMM

1. Zachman Framework

1.1. Creating Zachman Framework

1.2. Editing cell in Zachman Framework

1.3. Collapsing/Expanding rows or columns

2. Business Motivation Model diagram

2.1. Creating Business Motivation Model diagram

Part XXV. Appendix A - Application Options

1. General

1.1. Project

1.2. Referenced project

2. Diagramming

2.3. Model Generation

2.4. Shape

2.5. Connector

2.6. Resource Centric

2.11. Business Process

3. View

4. Instant Reverse

5. ORM

6. State Code Engine

6.1. State Code Engine

7. User Path

8. File Types

9. Spell Checking

10. Keys

11. Import/Export

Part XXVI. Appendix B - Project Options

1. Diagramming

2. Instant Reverse

2.1. Instant Reverse

3. ORM

3.1. General

3.2. Synchronization

4. State Code Engine

4.1. State Code Engine

5. Data Type

5.1. Data Type

6. Code Synchronization

6.1. Code

6.2. Brace and Identation

6.3. New Lines

6.4. Templates

7. C++ Code Synchronization

7.1. Code

7.2. Brace and Indentation

7.3. New Lines

7.4. Templates

8. Model Quality

8.1. Model Quality

Part XXVII. Appendix C

1. Product Update

1.1. Updating Visual Paradigm to Latest Build/Version

1.2. Automatic Update Notification

2. Connection Rules

2.1. Use case diagram connection rules

2.2. Class diagram connection rules

2.3. Sequence diagram connection rules

2.4. Communication diagram connection rules

2.5. State machine diagram connection rules

2.6. Activity diagram connection rules

2.7. Component diagram connection rules

2.8. Deployment diagram connection rules

2.9. Package diagram connection rules

2.10. Object diagram connection rules

2.11. Composite structure diagram connection rules

2.12. Interaction overview diagram connection rules

2.13. Requirement diagram connection rules

2.14. Entity relationship diagram connection rules

2.15. ORM diagram connection rules

2.16. Business process diagram connection rules

2.17. Conversation diagram connection rules

2.18. Data flow diagram connection rules

2.19. EPC diagram connection rules

2.20. Process map diagram connection rules

2.21. Organization chart connection rules

2.22. Overview diagram connection rules

2.23. Mind mapping diagram connection rules

3. Multi- Languages support

3.1. Multi-languages support

Visual Paradigm User's Guide

Product

Support

Learn

Company