VP-UML User’s Guide (Part 1)

Visual Paradigm for the Unified Modeling Language:VP-UML 6.0 User's Guide The software and documentation are furnished under the Visual Paradigm for UML license agreement and may be used only in accordance with the terms of the agreement. Copyright Information Copyright © 1999-2007 by Visual Paradigm. All rights reserved. The material made available by Visual Paradigm in this document is protected under the laws and various international laws and treaties. No portion of this document or the material contained on it may be reproduced in any form or by any means without prior written permission from Visual Paradigm. Every effort has been made to ensure the accuracy of this document. However, Visual Paradigm makes no warranties with respect to this documentation and disclaims any implied warranties of merchantability and fitness for a particular purpose. The information in this document is subject to change without notice. All examples with names, company names, or companies that appear in this document are imaginary and do not refer to, or portray, in name or substance, any actual names, companies, entities, or institutions. Any resemblance to any real person, company, entity, or institution is purely coincidental. Trademark Information Visual Paradigm for UML is registered trademark of Visual Paradigm. Sun, Sun ONE, Java, Java2, J2EE and EJB, NetBeans are all registered trademarks of Sun Microsystems, Inc. Eclipse is registered trademark of Eclipse. JBuilder is registered trademark of Borland Corporation. IntelliJ and IntelliJ IDEA are registered trademarks of JetBrains. Microsoft, Windows, Windows NT, Visio, and the Windows logo are trademarks or registered trademarks of Microsoft Corporation. Oracle is a registered trademark, and JDeveloper is a trademark or registered trademark of Oracle Corporation. BEA is registered trademarks of BEA Systems, Inc. BEA WebLogic Workshop is trademark of BEA Systems, Inc. Rational Rose is registered trademark of International Business Machines Corporation. WinZip is a registered trademark of WinZip Computing, Inc. Other trademarks or service marks referenced herein are property of their respective owners. Visual Paradigm for UML License Agreement

THE USE OF THE SOFTWARE LICENSED TO YOU IS SUBJECT TO THE TERMS AND CONDITIONS OF THIS SOFTWARE LICENSE AGREEMENT. BY INSTALLING, COPYING, OR OTHERWISE USING THE SOFTWARE, YOU ACKNOWLEDGE THAT YOU HAVE READ THIS AGREEMENT, UNDERSTAND IT, AND AGREE TO BE BOUNDED BY ALL OF THE TERMS AND CONDITIONS OF THIS SOFTWARE LICENSE AGREEMENT.

1. Limited License Grant. Visual Paradigm grants to you ("the Licensee") a personal, non-exclusive, non-transferable, limited, perpetual, revocable license to install and use Visual Paradigm Products ("the Software" or "the Product"). The Licensee must not re-distribute the Software in whole or in part, either separately or included with a product. 2. Restrictions. The Software is confidential copyrighted information of Visual Paradigm, and Visual Paradigm and/or its licensors retain title to all copies. The Licensee shall not modify, adapt, decompile, disassemble, decrypt, extract, or otherwise reverse engineer the Software. Software may not be leased, rented, transferred, distributed, assigned, or sublicensed, in whole or in part. The Software contains valuable trade secrets. The Licensee promises not to extract any information or concepts from it as part of an effort to compete with the licensor, nor to assist anyone else in such an effort. The Licensee agrees not to remove, modify, delete or destroy any proprietary right notices of Visual Paradigm and its licensors, including copyright notices, in the Software. 3. Disclaimer of Warranty. The software and documentation are provided "AS IS," WITH NO WARRANTIES WHATSOEVER. ALL EXPRESS OR IMPLIED REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH THE LICENSEE. THERE IS NO WARRANTY THE DOCUMENTATION, Visual Paradigm's EFFORTS OR THE LICENSED SOFTWARE WILL FULFILL ANY OF LICENSEE'S PARTICULAR PURPOSES OR NEEDS. IF THESE WARRANTIES ARE UNENFORCEABLE UNDER APPLICABLE LAW, THEN Visual Paradigm DISCLAIMS SUCH WARRANTIES TO THE MAXIMUM EXTENT PERMITTED BY SUCH APPLICABLE LAW. 4. Limitation of Liability. Visual Paradigm AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY THE LICENSEE OR ANY THIRD PARTY AS A RESULT OF USING OR DISTRIBUTING SOFTWARE. IN NO EVENT WILL Visual Paradigm OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, EXEMPLARY, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS OF

0-3 VP-UML User’s Guide (Part 1)

THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE THE SOFTWARE, EVEN IF Visual Paradigm HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 5. Termination. The Licensee may terminate this License at any time by destroying all copies of Software. Visual Paradigm will not be obligated to refund any License Fees, if any, paid by the Licensee for such termination. This License will terminate immediately without notice from Visual Paradigm if the Licensee fails to comply with any provision of this License. Upon such termination, the Licensee must destroy all copies of the Software. Visual Paradigm reserves all rights to terminate this License.

SPECIFIC DISCLAIMER FOR HIGH-RISK ACTIVITIES. The SOFTWARE is not designed or intended for use in high- risk activities including, without restricting the generality of the foregoing, on-line control of aircraft, air traffic, aircraft navigation or aircraft communications; or in the design, construction, operation or maintenance of any nuclear facility. Visual Paradigm disclaims any express or implied warranty of fitness for such purposes or any other purposes. NOTICE. The Product is not intended for personal, family or household use; rather, it is intended exclusively for professional use. Its utilization requires skills that differ from those needed to use consumer software products such as word processing or spreadsheet software. GOVERNMENT RIGHTS. If the Software is licensed by or on behalf of a unit or agency of any government, the Licensee agrees that the Software is "commercial computer software", "commercial computer software documentation" or similar terms and that, in the absence of a written agreement to the contrary, the Licensee's rights with respect to the Software are limited by the terms of this Agreement. Acknowledgements This Product includes software developed by the Apache Software Foundation (http://www.apache.org). Copyright © 1999 The Apache Software Foundation. All rights reserved.

0-4 VP-UML User’s Guide (Part 1)

Table of Contents

Chapter 1 - Getting Started with Visual Paradigm for UML Launching VP-UML...... 1 - 2 Specifying a Workspace ...... 1 - 2 Importing a License Key...... 1 - 3 Dockable Environment...... 1 - 5 Using the Dockable Environment...... 1 - 5 Menus and Toolbars...... 1 - 7 Menus ...... 1 - 8 Toolbars...... 1 - 15 Panes ...... 1 - 19 Diagram Navigator Pane...... 1 - 19 Model Pane ...... 1 - 20 Class Repository Pane ...... 1 - 21 Logical View Pane...... 1 - 21 ORM Pane ...... 1 - 22 Stencil Pane ...... 1 - 22 Property Pane...... 1 - 23 Diagram Overview Pane...... 1 - 23 Documentation Pane...... 1 - 23 Message Pane...... 1 - 23 Layout and Perspective ...... 1 - 24 Saving Perspective...... 1 - 24 Opening Perspective ...... 1 - 24 Managing Perspective...... 1 - 25 Resetting Perspective...... 1 - 25 Open Specification Dialog Box...... 1 - 26 Navigating between Diagram Elements...... 1 - 27

Part 1 - Working with Visual Paradigm for UML

Chapter 2 - Working with Projects Creating a New Project...... 2 -2 Opening a Project...... 2 -3 Saving a Project...... 2 -3 Exporting and Importing (Merging) of Project ...... 2 -3 Exporting Project...... 2 -4 Importing (Merging) a VP-UML Project...... 2 -4 Project Template ...... 2 -4 Saving Project as Template...... 2 -5 Maintaining Project Template...... 2 -5 Managing Project Properties ...... 2 -6

Chapter 3 - Working with Diagrams Creating Diagram Elements ...... 3 -2 Creating Shapes ...... 3 -2 Creating Connectors ...... 3 -2 Creating Self-Connection...... 3 -3 Resource-Centric Interface...... 3 -3 Using the Resource-Centric Interface...... 3 -3 Show Extra Resources ...... 3 -4 Auto Hide Resource Centric ...... 3 -4 Enabling/Disabling the Resource-Centric Interface Feature...... 3 -4 Group Selection Resources...... 3 -4 Connector Styles ...... 3 -5 Follow Diagram Connector Style ...... 3 -5 Rectilinear Connector Style ...... 3 -6 Oblique Connector Style...... 3 -7 Curve Connector Style...... 3 -7 Round Oblique Connector Style ...... 3 -7

0-5 VP-UML User’s Guide (Part 1)

Round Rectilinear Connector Style...... 3 -8 Change Connector Style...... 3 -8 Set a Default Connector Style...... 3 -9 Connection Point ...... 3 -9 Setting Connection Point Style ...... 3 -9 Pinning the Connection End Point ...... 3 -10 Basic Editing Features...... 3 -11 Undo...... 3 -11 Redo...... 3 -11 Copy...... 3 -11 Paste...... 3 -12 Delete...... 3 -14 Finding a Model Element ...... 3 -14 Jumping to Shape/Model...... 3 -15 Jumping to Shape in Active Diagram ...... 3 -15 Jumping to Element in Project...... 3 -17 Fill Color ...... 3 -18 Format Fill Color Dialog Box...... 3 -18 Line Format ...... 3 -20 Format Line Dialog Box ...... 3 -21 Alignment...... 3 -21 Referenced Shape for Alignment...... 3 -22 Using the Align Shapes Dialog Box ...... 3 -23 Distribute Shapes...... 3 -23 Using the Distribute Shapes Dialog Box...... 3 -24 Grouping...... 3 -24 Grouping Shapes...... 3 -24 Ungrouping Shapes...... 3 -24 Resizing Shapes in Group...... 3 -24 Zooming ...... 3 -25 Zooming In ...... 3 -25 Zooming Out...... 3 -26 Zooming to 100% ...... 3 -26 Zooming to a Specific Ratio ...... 3 -26 Zooming to Fit Diagram to Window...... 3 -27 Zooming to Region ...... 3 -27 Grid...... 3 -28 Showing/Hiding Grids ...... 3 -28 Snap to Grid ...... 3 -28 Grid Size ...... 3 -29 Grid Color...... 3 -29 Form Diagram from Model ...... 3 -29 Customize Form Diagram Properties...... 3 -30 Hierarchical Diagram...... 3 -31 Navigation Diagram...... 3 -32 Compartment Visibility Control...... 3 -32 Quick Previewer ...... 3 -33 Fast Scroll...... 3 -34 Fast Scroll using Middle Mouse Button...... 3 -34 Sub-Diagrams...... 3 -34 Creating a Sub-Diagram...... 3 -34 Selecting Existing Diagrams as Sub-Diagrams...... 3 -35 Viewing the List of Sub-Diagrams ...... 3 -36 Opening Sub-Diagrams...... 3 -36 Removing Sub-Diagrams...... 3 -36 Navigating to the Parent Element of a Sub-Diagram...... 3 -37 References ...... 3 -37 Adding Referenced File ...... 3 -37 Adding Referenced URL ...... 3 -38 Editing References ...... 3 -39 Reordering References...... 3 -40 Opening References ...... 3 -40 Removing References ...... 3 -41 User Path...... 3 -41

0-6 VP-UML User’s Guide (Part 1)

Logical View...... 3 -42 Creating a Logical View...... 3 -42 Creating Diagram(s) under View...... 3 -42 Moving Diagram(s) between Views ...... 3 -42 Exporting and Importing View ...... 3 -42 Modeler ...... 3 -43 Stencil ...... 3 -43 Installing Visio Send to VP Plugin ...... 3 -43 Sending Shape from Visio to VP-UML...... 3 -44 Importing a Stencil...... 3 -45 Opening a Stencil...... 3 -46 Creating Shape from Stencil ...... 3 -46 Closing a Stencil ...... 3 -46 Exporting Diagram as Images ...... 3 -47 Exporting the Active Diagram as an Image ...... 3 -47 Exporting Diagrams as Images ...... 3 -47 Mouse Gesture...... 3 -48 Gesture Start Point and Direction ...... 3 -49 Initial State and Final State...... 3 -50 Connecting Shapes using Mouse Gesture...... 3 -50 Creating Class Members using Mouse Gesture ...... 3 -50

Chapter 4 - Generating Documentation Report Writer...... 4 -2 Launching Report Writer ...... 4 -2 Panes...... 4 -3 Toolbar...... 4 -6 Constructing a Report ...... 4 -7 Applying Style to Report ...... 4 -8 Updating Table of Contents...... 4 -10 Exporting a report ...... 4 -10 Importing a Report...... 4 -10 Updating a Report...... 4 -11 Printing a report ...... 4 -11 PDF Report Generation...... 4 -11 The Generate PDF Dialog Box...... 4 -12 Generating a PDF Report...... 4 -13 Defining Image Quality ...... 4 -14 Defining the page information ...... 4 -14 HTML Report Generation ...... 4 -18 The Generate HTML Dialog Box...... 4 -18 Generating an HTML Report...... 4 -19 Defining Image Quality ...... 4 -20 Defining the Document Info ...... 4 -20 Word Report Generation ...... 4 -21 The Generate Word Dialog Box ...... 4 -21 Generating a Word Report...... 4 -23 Defining Image Quality ...... 4 -24 Defining the page information ...... 4 -24 Printing Diagrams...... 4 -27 Print Preview ...... 4 -27 Printing a Diagram with Preview...... 4 -29 Printing a Diagram with Quick Print ...... 4 -37 Project Publisher ...... 4 -38 Launching Project Publisher ...... 4 -38 Using Project Publisher ...... 4 -38 Using the Published Project...... 4 -39

Chapter 5 - Interoperability XMI Importer and Exporter...... 5 -2 Supported XMI File version ...... 5 -2 Importing an XMI File...... 5 -3 Exporting an XMI file...... 5 -4

0-7 VP-UML User’s Guide (Part 1)

Rose Importer ...... 5 -5 Importing a Rose Project...... 5 -5 Interoperability with Word ...... 5 -7 Exporting Use Case Model to Word ...... 5 -7 Modifying Exported Word File...... 5 -11 Importing Use Case Model from Word...... 5 -13 Real-Time Update...... 5 -13 XML Importer and Exporter...... 5 -14 Exporting an XML File...... 5 -14 Importing an XML File...... 5 -16 ERwin modeler project file Importer...... 5 -17 Importing an ERwin Data Modeler Project...... 5 -17 Oracle workflow engine BPEL generator...... 5 -18 Generating BPEL for Oracle workflow engine...... 5 -18 JBoss workflow engine BPEL generator...... 5 -20 Generating BPEL for JBoss workflow engine ...... 5 -20

Chapter 6 - Automatic Diagrams Layout Auto Layout...... 6 -2 Class Diagram...... 6 -2 Activity Diagram ...... 6 -3 State Machine Diagram...... 6 -3 Communication Diagram...... 6 -3 Other Diagrams...... 6 -4 Performing Layout...... 6 -4 Orthogonal Layout...... 6 -4 Hierarchic Layout...... 6 -5 Directed Tree Layout...... 6 -6 Balloon Tree Layout...... 6 -6 Compact Tree Layout ...... 6 -7 Horizontal-Vertical Tree Layout ...... 6 -8 BBC Compact Circular Layout ...... 6 -8 BBC Isolated Circular Layout ...... 6 -9 Single Cycle Circular Layout ...... 6 -10 Organic Layout...... 6 -10 Smart Organic Layout ...... 6 -11 Organic Edge Route Layout ...... 6 -12 Orthogonal Edge Route Layout...... 6 -13

Chapter 7 - Instant Reverse What is Instant Reverse? ...... 7 -2 SupportedSources...... 7 -2 Using Instant Reverse...... 7 -3 Java Instant Reverse ...... 7 -4 On-Demand Java Instant Reverse ...... 7 -5

Chapter 8 - Incorporating Visio® and Images to Diagrams Introduction to Visio® Shapes ...... 8 -2 Creating Visio® Shapes ...... 8 -2 Editing Visio® Shapes ...... 8 -3 Resizing Visio® Shapes ...... 8 -4 Fitting Visio® Shape Size ...... 8 -4 What is Image Shape? ...... 8 -4 Creating Image Shapes ...... 8 -5 Creating Image Shapes by Using Diagram Toolbar...... 8 -5 Creating Image Shapes by Copy and Paste...... 8 -6 Creating Image Shapes by Drag and Drop...... 8 -7 Selecting Image ...... 8 -7 Selecting Linked File...... 8 -8 Image Scaling Option ...... 8 -8 Exporting Image ...... 8 -9 Exporting Linked File...... 8 -9

0-8 VP-UML User’s Guide (Part 1)

Chapter 9 - Team Collaboration VP Teamwork Server ...... 9 -2 Starting the Teamwork Client...... 9 -3 Checking out a Project...... 9 -4 Checking in a Project...... 9 -5 Updating a Project ...... 9 -6 Reverting a Project...... 9 -6 Checking for Updates ...... 9 -7 Refresh Project List ...... 9 -7 Export Project ...... 9 -7 Import Project ...... 9 -8 Viewing the Checkin Version History...... 9 -8 Closing the Teamwork Client ...... 9 -9 Logout the Teamwork Client...... 9 -9 CVS and Subversion ...... 9 -10 Starting the Teamwork Client...... 9 -10 Importing a Project to the Server ...... 9 -12 Checking out a Project...... 9 -13 Checking in a Project...... 9 -14 Updating a Project ...... 9 -16 Reverting a Project...... 9 -16 Checking for Updates ...... 9 -16 Refresh Project List ...... 9 -17 Export Project ...... 9 -17 Import Project ...... 9 -17 Viewing the Checkin Version History...... 9 -18 Closing the Teamwork Client ...... 9 -18 Logout the Teamwork Client...... 9 -19

Appendix A - Configuring Application Options Configuring Application Options using the Application Options Dialog Box...... A -2 General...... A -2 Diagramming ...... A -3 View...... A -6 Instant Reverse...... A -7 ORM ...... A -8

Appendix B - Configuring Stereotypes and Tagged Value Introduction ...... B -2 Adding Stereotype to a Model Element ...... B -2 Configuring Stereotypes...... B -3 Creating a New Stereotype ...... B -4 Editing a Stereotype...... B -5 Using the Stereotype Specification Dialog Box...... B -6 Adding Tagged Value to a Stereotype ...... B -6 Adding Tagged Value to a Model Element...... B -9 Stereotype Formats...... B -11 Configuring Stereotype Formats...... B -11 Changing Stereotype Formats...... B -14

Appendix C - Supported Mouse Gestures

Appendix D - Keyboard Shortcuts

Appendix E – Glossary

0-9 VP-UML User’s Guide (Part 1)

0-10

Getting Started with 1 Visual Paradigm for UML VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Chapter 1 - Getting Started with Visual Paradigm for UML

Welcome to Visual Paradigm for UML (VP-UML), a powerful visual UML CASE tool. The tool is designed for a wide range of users, including Software Engineers, System Analysts, Business Analysts, System Architects alike, who are interested in building software systems reliably through the use of the Object-Oriented approach. The VP-UML environment provides an intuitive means to carry out Object-Oriented system analysis and design, where you can create UML diagrams through simple drag and drop operations. It is a collection of menus, toolbars and windows that make up the development workspace, which allows you to create different types of diagrams in a totally visual environment. This chapter offers a detailed overview of the VP-UML visual environment. You will learn the use of menus, toolbars, dockable panes, and how to configure your own working environment by applying different perspectives. In this chapter:

• Dockable Environment • Function of Panes • Description on Menu items and Toolbars • Configuring Environment with Perspective

Launching VP-UML

Specifying a Workspace

When VP-UML is starting, the Workspace Launcher is displayed.

Figure 1.1 - Select workspace A workspace of VP-UML is a repository of UML project (s) and configuration detail. In terms of physical storage, a workspace is a directory in file system where the UML project file and configuration files are located.

By default, the workspace is selected as %HOME_DIRECTORY%\.vpworkspace. To specify another directory as the workspace, you can enter its path in the text field directly, or you can click on the ... button to browse for a suitable directory. To apply the specified path as the default workspace and restrict the dialog to appear again, check the option Use this as the default and do not ask again Once everything is ready, click OK to confirm the path for workspace and continue starting VP-UML.

1-2 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Importing a Workspace In case you have an existing workspace, you can import it so that all its default settings, user interface perspectives and other preferences can be preserved, all the projects in the existing workspace will also be copied to the workspace. To import a workspace, click Import Workspace... in the Workspace Launcher, and then specify the path of the workspace used for import.

Figure 1.2 - Import workspace

If the specified workspace already exists, you will be prompted by the Confirm Workspace Overwrite dialog box asking you to confirm overwriting the existing workspace. If you press Yes , all the setting of the specified workspace will be overwritten by the workspace to be imported.

Figure 1.3 - Confirm workspace overwrite

Importing a License Key

A valid license key is required for launching VP-UML. If you have not imported the license key file during the installation of VP-Suite, the License Key Manager will be displayed and ask you for the license key.

Figure 1.4 - License Key Manager

1-3 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

To import a License Key:

1. Either select License Keys > Import... or press on the Import License Key button on the toolbar. This displays the Import License Key dialog box.

Figure 1.5 - Import license key

2. From the File field, enter the file path of license key. You can enter the path in the text field directly, or you can click on the ... button to browse for license key file. 3. Click Import .

The imported key is then displayed in the Key Manager.

Figure 1.6 - The imported key displayed in Key Manager

To start up VP-UML, click Close from the License Key Manager to start VP-UML right away.

Showing Keys of All Products Different license keys match different editions, version and kinds of products. By default, only license key (s) which matches the edition, version and the product brand of the running product will be displayed in the License Key Manager. To display/hide even the incompatible keys, perform one of the following actions:

• Check/uncheck Show All Products from toolbar • Select from main menu License Keys > Show All Keys .

Showing Expired Keys Those expired license keys are hidden by default. To display/hide the expired license keys, perform one of the following actions:

• Check/uncheck Show Expired from toolbar • Select from main menu License Keys > Show Expired License Keys.

Removing a key To remove an existing license key from the license key repository:

1. Select from the License Key Manager the license key that you wish to remove 2. Either select License Keys > Remove from main menu or press on the Remove button on the toolbar.

Importing a Floating License Key To import a floating license key:

1-4 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

1. Select License Keys > Floating License... from main menu. This displays the Floating License dialog box. 2. From any of the available slot, specify a host name or IP that hosts a running floating license server, along with its port number. 3. Click OK . This closes the Floating License dialog box.

To start up VP-UML, click Close from the License Key Manager to start VP-UML right

Note Please ensure you have specified a host IP that hosts a running floating license server with a valid port number (default = 1998).

Requesting for a License Key License key of the requested product is sent to your email address while you downloaded the VP-Suite. If you have not received an email with a license key file, or if you wish to evaluate the product which does not have a corresponding key, you can request a license key by pressing the Request Key button on the toolbar. You will be then directed to a web page for which you can specify the licensee detail and request for a license key file. After submitting the licensee details, the license key file will be sent to your email accordingly.

Dockable Environment

VP-UML adapts dockable environment which allows you to drag UI components around to customize your favorite working environment. You can save the environment as a perspective which you can reopen later. It allows you to use different perspectives for different purposes.

Using the Dockable Environment

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

Figure 1.7 - Dragging a dockable frame

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

1-5 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Docking a Dockable Frame into another Container If you drag the dockable frame and release it over another container, the gray outline will change its shape to fit the dockable area of the container.

Figure 1.8 - Drag a dockable frame to another container

If you release the frame, it will be docked into the underlying container and also removed from its original container.

Figure 1.9 - Docked to another container

Dragging a Tab out of a Tab Pane Each tab in the tab pane is also a dockable frame, and can be dragged and docked. You can drag a tab out of a tab pane to make it a floating window.

Figure 1.10 - Drag a Tab out of tab pane to make it a floating window. You can also drag the tab over a container and dock the tab into it.

1-6 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Docking a Dockable Frame into a Tab Pane You can also drag the tab (and any dockable frames, including floating frames) and dock it into another tab pane. You will see the outline changed to a tab shape if you drag the tab over a tab pane.

Figure 1.11 - Docking a dockable frame into a Tab Pane

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

Figure 1.12 - Making a dockable frame auto-hide

Note

If you set a dockable frame in a tab pane to auto-hide, the whole tab pane will be hidden.

Menus and Toolbars

At the top of the VP-UML main window, the menu bar is immediately beneath the title bar. You can execute commands by pressing the left mouse button on the menu items. Menus are logically grouped into six categories: File, Edit, View, Tools, Window and Help. Under each menu is a set of submenus and menu items, providing access to different commands based on the menu. Toolbars are horizontal bars placed below the menu bar. They store all the frequently used commands that appear as a row of buttons. The grouping of buttons (commands) is task-based. Unavailable menu item or button implies that the corresponding command is not available. With an available menu item or button, you can simply click on it to perform the corresponding command.

1-7 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Menus

File Menu

Figure 1.13 - File menu

Menu Item Hot Key Function To create either a new UML 1.x or a new UML 2.0 project. The New Project dialog box will New Project Ctrl-N appear which allows you to create a blank project, a project created from existing project templates, or import from other CASE tool project files. New Diagram To create a new diagram of the selected type. Open Project... Ctrl-O To open an existing project. Reopen To reopen the most recently opened projects. To save the current project. If the project is a new one, this operation is equivalent to "Save Save Project Ctrl-S Project as... Save Project as... To save the current project to a different location. Save as Project To save a project template that based on the structure of the current project. Template... Maintain Project To rename a project template or modify its description. You can also delete a template. Templates... Close Project To close the current project thus all the diagrams. Import > VP-UML To merge an external project with the current one. Project... Import > Rose To import a Rose model into the current project. Project... Import > XMI... To import an XMI file into the current project. Import > XML... To import an XML file into the current project. Import > ERwin To import an ERwin project XML file into the current project. Project (XML) Import > MS Word to To import a MS Word to update the use case model in the current project. Use Case Model... Export > VP-UML To export the current project. It allows you to choose any diagram(s) within the current

Project... project to export. Export > XMI... To export the current project as XMI file. Export > XML... To export the current project as XML file. Export > Active To export the active diagram as image.

1-8 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Diagram as Image... Export > Diagrams as To select and export diagrams as images. Image... Export > Selection as To export the selected portion of diagram as images. Image... Export > Use Case To export use case model as an MS Word document. Model to MS Word... To print selected diagrams in the current project. A new dialog box will be presented, Print... Ctrl-P allowing you to select the diagrams to be printed, as well as configuring various printing options. To print selected diagrams in the current project without previewing them, hence speeds up Quick Print... the printing task. To view or change project properties such as general project information and PDF report Project Properties... generation options. Switch Workspace... To switch to another workspace to work on. Exit To exit VP-UML.

Table 1.1 - Menu items

Edit Menu

Figure 1.14 - Edit Menu

Menu Item Hot Key Function Undo Ctrl-Z To undo the last action that you performed. Redo Ctrl-Y To redo the last action that you performed. To cut the selected diagram elements from the diagram and copy them to the Cut Ctrl-X application clipboard. Copy -> Default To copy the selected diagram elements based on the default copy action which Copy (Within VP- Ctrl-C configured at Tools > Options > Diagramming > Environment UML) Copy > Within VP- To copy the selected diagram elements from the diagram to the application clipboard. UML Copy -> To To copy the selected diagram elements from the diagram to the system clipboard. The Ctrl-Shift-C Clipboard as OLE diagram elements can then be pasted to OLE containers like Word, Excel and

1-9 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

PowerPoint, which can be edited directly. Copy > To Clipboard as Image Ctrl-Alt-C To copy the selected diagram elements as an image (JPG) to the system clipboard. (JPG) Copy > To Clipboard as Image Ctrl-Alt- Shift -C To copy the selected diagram elements as an image (EMF) to the system clipboard. (EMF) Duplicate Ctrl-E To duplicate the selected diagram elements. Change From/To To change the from/to shape of the selected connector. Shape... Paste View Ctrl-V To paste the contents of the application clipboard to the drawing pane. To paste the copied model. Unlike the Paste View function, it clones a new model Paste Model which is unlinked with the source model. Delete Delete To delete the selected diagram elements from the diagram. Delete View Only To delete the views of selected diagram elements from the diagram. Repeat Create Shape F3 To repeat create the last created shape. Select All Ctrl-A To select all the diagram elements from the current diagram. To select all diagram elements in the diagram those are of the same type as the Select All of Same currently selected diagram element. For example, if a Use Case is selected, invoking Type "Select All of Same Type" will select all the Use Cases in the diagram. Deselect Ctrl-D To deselect all diagram elements. Find... Ctrl-F To find elements (model elements and diagram elements) in the current project. Jump to Element in Ctrl-J To jump to an element in the active diagram. Active Diagram... To jump to an element in the project. If the selected element belongs to a diagram, this diagram will be opened, and the element will be selected and centered in the diagram. Jump to Element... Ctrl-Shift-J If the selected element is a model that does not have a view, it will be selected in the Model pane. To organize shapes in group. The group can manipulate related shapes together Group Ctrl-G (select, deselect, move, align and resize). Ungroup Ctrl-Shift-G To ungroup the grouped shapes in diagram. To align the selected diagram elements in the way that they will be aligned using the Align Shapes > Top top side of the top-most diagram element as the reference of alignment. Align Shapes > To align the selected diagram elements in the way that they will be aligned using the

Bottom bottom side of the bottom-most diagram element as the reference of alignment. To align the selected diagram elements in the way that they will be aligned using the Align Shapes > Left left side of left-most diagram element as the reference of alignment. Align Shapes > To align the selected diagram elements in the way that they will be aligned using the

Right right side of right-most diagram element as the reference of alignment. To align the selected diagram elements in the way that the centers of them will be Align Shapes > aligned using the X-coordinate of center of the first diagram element as the reference Horizontal Center of alignment. To align the selected diagram elements in the way that the centers them will be Align Shapes > aligned using the Y-coordinate of center of the first diagram element as the reference Vertical Center of alignment. Align Shapes > To align the selected diagram elements in the way that the widths of them will be set

Same Width to the same value, which is the largest value among the selected diagram element. Align Shapes > To align the selected diagram elements in the way that the widths of them will be set

Same Height to the same value, which is the largest value among the selected diagram element. Align Shapes > To align the selected diagram elements in the way that the widths and heights of them

Same Width and will be set to the same value, which is the largest value among the selected diagram

1-10 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Height element. Align Shapes > To display the Align Shapes dialog box that allows you to configure the top/bottom, F12 Align Shapes... left/right alignments and same width/same height options all at a time. Distribute Shapes > To distribute selected diagram elements with uniform horizontal space. Horizontally Distribute Shapes > To distribute selected diagram elements with uniform vertical space. Vertically Distribute Shapes > To distribute selected diagram elements with uniform horizontal space between their

By Left Edges left edges. Distribute Shapes > To distribute selected diagram elements with uniform horizontal space between their By Horizontal centers. Centers Distribute Shapes > To distribute selected diagram elements with uniform horizontal space between their

By Right Edges right edges. Distribute Shapes > To distribute selected diagram elements with uniform vertical space between their top

By Top Edges edges. Distribute Shapes > To distribute selected diagram elements with uniform vertical space between their

By Vertical Centers centers. Distribute Shapes > To distribute selected diagram elements with uniform vertical space between their

By Bottom Edges bottom edges. Distribute Shapes > To display the Distribute Shapes dialog box that allows you to configure the top/down

Distribute Shapes... and left/right alignments options all at a time.

Table 1.2 - Edit Menu

View Menu

Figure 1.15 - View menu

Menu Item Hot Key Function Panes > Diagram Ctrl-Shift-I To open/activate the Diagram Navigator. Navigator Panes > Model Ctrl-Shift-O To open/activate the Model Pane. Panes > Class Ctrl-Shift-L To open/activate the Class Repository Pane. Repository Panes > Logical View Ctrl-Shift-A To open/activate the Logical View Pane. Panes > ORM Ctrl-Shift-R To open/activate the ORM Pane. Panes > Stencil Ctrl-Shift-S To open/activate the Stencil Pane. Panes > Property Ctrl-Shift-P To open/activate the Property Pane. Panes > Diagram Ctrl-Shift-V To open/activate the Diagram Overview Pane. Overview

1-11 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Panes > Documentation Ctrl-Shift-U To open/activate the Documentation Pane. Panes > Message Ctrl-Shift-M To open/activate the Message Pane. Grid To show up the grid at the diagram pane. Snap to Grid To snap diagram elements to grid. Resource Centric > Ctrl-R To provide resource icons around diagram elements for better usability. Resources Resource Centric > To show group resources of the resource-centric feature. Group Resources Resource Centric > To show extra resources of the resource-centric feature. Extra Resources Resource Centric > Generic Resources To show only generic resources of the resource-centric feature. Only Save Perspective as... To save the current environment as a perspective that can be reused later. Open Perspective To open a pre-defined perspective. Manage Perspectives... To view/edit/remove perspectives. Reset Perspective to To reset the perspective of the UI components to their default positions in the current

Default perspective. To display only the Toolbar and the Diagram Pane, all the other UI components will Full Screen F11 be hidden. If VP-UML is already in full screen mode, uncheck this menu item to restore the environment before switching to full screen. Zoom In Ctrl-Equals To magnify the diagram by 10%. Zoom Out Ctrl-Minus To diminished the diagram by 10%. Zoom 100% (Actual Ctrl-0 To view the diagram in its actual size. Size) Zoom to Region To zoom the diagram to fit a particular region.

Table 1.3 - View Menu

Tools Menu

Figure 1.16 - Tools Menu

Menu Item Hot Key Function Report > Generate HTML To generate reports in HTML format. Report... Report > Generate PDF Report... To generate reports in PDF format.

1-12 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Report > Generate Word Report... To generate reports in MS Word format. Report > Report Writer... To present Report Writer for ad hoc report creation. To publish Visual Paradigm projects to technical and professional Web Project Publisher... documents. The published Web content can be accessed in any Web browsers. Use Case Scheduling... To perform Use Case scheduling. Configure Stereotypes... To create, edit or remove stereotypes. Configure Requirement To configure enumerations used in requirement diagrams. Enumerations... Instant Reverse > Instant To reverse files to VP-UML models. The Instant Reverse Options dialog box

Reverse... will appear asking for a type for reversing. Instant Reverse -> Java... To reverse Java source and class files into VP-UML models. Instant Reverse -> C++ Source... To reverse C++ source files into VP-UML models. Instant Reverse -> .NET dll or exe To reverse .NET dll or exe files into VP-UML models. files Instant Reverse -> CORBA IDL To reverse CORBA IDL files into VP-UML models. Source... Instant Reverse -> Ada 9x To reverse Ada 9x source files into VP-UML models. Source... Instant Reverse -> XML... To reverse XML files into VP-UML models. Instant Reverse -> XML Schema... To reverse XML schemas into VP-UML models. Instant Reverse -> JDBC... To reverse database tables through JDBC into VP-UML models. Instant Reverse -> Hibernate... To reverse Hibernate mapping XML file into VP-UML models. Instant Reverse -> PHP 5.0 To reverse PHP 5.0 source files into VP-UML models. Source... Instant Generator -> Instant To open the Instant Generator dialog box to select the type of source to generate

Generator... from VP-UML model. Instant Generator -> Java... To generate Java code from VP-UML models. Instant Generator -> C#... To generate C# code from VP-UML models. Instant Generator -> VB.NET... To generate Visual Basic .NET code from VP-UML models. Instant Generator -> PHP... To generate PHP from VP-UML models. Instant Generator -> ODL... To generate ODL from VP-UML models. Instant Generator -> To generate ActionScript from VP-UML models. ActionScript... Instant Generator -> IDL... To generate IDL from VP-UML models. Instant Generator -> C++... To generate C++ code from VP-UML models. Instant Generator -> Delphi... To generate Delphi code from VP-UML models. Instant Generator -> Perl... To generate Perl from VP-UML models. Instant Generator -> XSD... To generate XML schema from VP-UML models. Instant Generator -> Python... To generate Python from VP-UML models. Instant Generator -> Objective- To generate Objective-C code from VP-UML models. C... To generate Java code from VP-UML models. The generated code will update Java Round-trip -> Generate only the changes you have made to the models instead of overwriting Code... everything, which means your custom code in the generated file can be retained. Java Round-trip -> Reverse Code... To reverse Java code to VP-UML models. Object-Relational Mapping (ORM) To display wizard for automating tasks like code generation from database,

> Wizards... generating code and database from ERD and Class Diagram.

1-13 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Object-Relational Mapping (ORM) To specify information of database(s) such as JDBC driver file and connection

> Database Configuration... string. Object-Relational Mapping (ORM) To reverse existing database into Entity Relationship Diagram (ERD). > Reverse Database... Object-Relational Mapping (ORM) To reverse Java classes into Class Diagram. > Reverse Java Classes... Object-Relational Mapping (ORM) To reverse Hibernate mapping XML file into VP-UML models. > Reverse Hibernate... Object-Relational Mapping (ORM) > Reverse Enterprise Object To reverse Enterprise Object Framework into VP-UML models. Framework... Object-Relational Mapping (OR M) To synchronize the current Entity Relationship Diagram to Class Diagram. > Synchronize to Class Diagram Object-Relational Mapping (ORM) > Synchronize to Entity To synchronize the current Class Diagram to Entity Relationship Diagram. Relationship Diagram... Object-Relational Mapping (ORM) To generate database from existing Entity Relationship Diagram. > Generate Database... Object-Relational Mapping (ORM) To generate the persistent classes for preserving the state and data of an

> Generate Code... application through Object-Relational Mapping. To display the IDE Integration dialog box. You can then select to install IDE Integration... integration with Eclipse, JBuilder, NetBeans, IntelliJ IDEA, JDeveloper or WebLogic Workshop. Visio Integration... To install a plug-in in Visio that allows Visio stencils to be used in VP-UML. Shape Editor... To open Shape Editor for creating/editing stencils. Teamwork > Open Teamwork To open the Teamwork client for performing team operations like project

Client... checkout, checkin. Teamwork > Commit... To commit the current project to Teamwork Server. DB-VA SQL To start the DB-VA SQL application. Key Manager... To open the Key Manager to manage the license key files. Options... To configure various VP-UML options, such as look and feel, and backup level.

Table 1.4 - Tool Menu

Window Menu

Figure 1.17 - Window Menu

Menu Item Hot Key Function Previous Diagram Alt-Left To switch to the previous diagram. Next Diagram Alt-Right To switch to the next diagram. Tile To arrange windows in tile formation. Cascade To arrange windows in cascade formation.

1-14 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Navigate To select and focus on an existing window. Switch to Diagram... Ctrl-Shift-E To manage windows by selecting windows to close, and/or activate a selected window. To switch to the Start Page which enables you to create a new project or open an existing Start Page project. Close Active Ctrl-W To close the active window. Window Close All Windows Ctrl-Shift-W To close all opened windows.

Table 1.5 - Window Menu

Help Menu

Figure 1.18 - Help Menu

Menu Item Hot Key Function Visual Paradigm for UML To show the online help documentation. %EDITION% Help Mouse Gestures... To show all available mouse gestures and the instructions of using them. Visual Paradigm on the Web > Online To get Online Support from Visual Paradigm Home Page. Support Visual Paradigm on the Web > Visual To access the Visual Paradigm Home Page on the Internet for more

Paradigm Home Page information about VP-UML. About Visual Paradigm for UML To show version/license details about your copy of VP-UML, as well as

%EDITION%... information about the system and the environment.

Table 1.6 - Help Menu

Toolbars

Toolbar Icon Button Function

Standard New Project To create a new project. Open Project To open an existing project. Save Project To save the current project. Print To print the diagrams in the current project. To cut the selected diagram elements from the diagram and copy them Cut to the application clipboard.

Copy within VP-UML To copy selected diagram elements to the application clipboard. Copy to Clipboard as To copy selected diagram elements to the system clipboard as an OLE OLE object. Copy to Clipboard as To copy selected diagram elements to the system clipboard as a JPG Image (JPG) image. Copy to Clipboard as To copy selected diagram elements to the system clipboard as an EMF Image (EMF) image. To paste the copied diagram elements from the application clipboard Paste View to the current diagram.

Paste Model To paste the copied model. Unlike pure Paste function, it clones a new

1-15 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

model which is composed of the data of the copied model.

Undo To undo the last operation. Redo To redo the last operation. Align Top To align selected diagram elements to the top. Align Bottom To align selected diagram elements to the bottom. Align Left To align selected diagram elements to the left. Align Right To align selected diagram elements to the right. Align To align selected diagram elements horizontally. Horizontal Center

Align Vertical Center To align selected diagram elements vertically. Same Width To set selected diagram elements to the same width. Same Height To set selected diagram elements to the same height. Same Width and To set selected diagram elements to the same width and height. Height To align the selected diagram elements. An Align Shapes Dialog will Align Shapes display asking for the align option. To distribute the selected diagram elements evenly within the range Distribute Shapes between the top-most selected diagram element and the bottom-most Horizontally selected diagram element. To distribute the selected diagram elements evenly within the range Distribute Shapes between the left-most selected diagram element and the right-most Vertically selected diagram element. Distribute Shapes by To distribute selected diagram elements with uniform horizontal space Left Edges between their left edges. Distribute Shapes by To distribute selected diagram elements with uniform horizontal space Horizontal Centers between their centers. Distribute Shapes by To distribute selected diagram elements with uniform horizontal space Right Edges between their right edges. Distribute To distribute selected diagram elements with uniform vertical space Shapes by Top Edges between their top edges. Distribute Shapes by To distribute selected diagram elements with uniform vertical space Vertical Centers between their centers. Distribute To distribute selected diagram elements with uniform vertical space Shapes by Bottom between their bottom edges. Edges To distribute the selected diagram elements. A Distribute Shapes Distribute Shapes Dialog will display asking for the distribute option.

Zoom In To zoom in the diagram Zoom Out To zoom out the diagram. Zoom 100% To zoom the diagram to 100% (actual size). Zoom to Region To zoom the diagram to fit a particular region. Select Zoom To zoom the diagram with the selected zoom ratio.

To copy the style and formats of selected shapes and apply them to Format Copier other shapes.

Select font family To set the font family.

1-16 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Select font size To set the font size.

Bold To set the bold style of font.

Italic To set the italic style of font.

Font Color To set the color of the font.

Help To view the online help documentation.

Diagram New Use Case To create a new Use Case diagram. Diagram

New Class Diagram To create a new Class Diagram. New Sequence To create a new Sequence Diagram. Diagram New Communication To create a new Communication Diagram. Diagram New State Machine To create a new State Machine Diagram. Diagram

New Activity Diagram To create a new Activity Diagram. New Component To create a new Component Diagram. Diagram New Deployment To create a new Deployment Diagram. Diagram

New Package Diagram To create a new Package Diagram. New Object Diagram To create a new Object Diagram. New Composite To create a new Composite Structure Diagram. Structure Diagram

New Timing Diagram To create a new Timing Diagram. New Interaction To create a new Interaction Overview Diagram. Overview Diagram

New Textual Analysis To create a new Textual Analysis. New Requirement To create a new Requirement Diagram. Diagram

New Basic Diagram To create a new Business Workflow Diagram. New CRC Card To create a new CRC Card Diagram. Diagram New Entity To create a new Entity Relationship Diagram. Relationship Diagram

New ORM Diagram To create a new ORM Diagram. New Data Flow To create a new Data Flow Diagram. Diagram

New EJB Diagram To create a new EJB Diagram. New Business Process To create a new Business Process Diagram. Diagram New Overview To create a new Overview Diagram. Diagram

Navigate Previous Diagram To switch to the previous diagram in navigation history. Next Diagram To switch to the next diagram in navigation history.

1-17 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Diagram Navigator Open the Diagram Navigator Pane. Model Open the Model Pane. Class Repository Open the Class Repository Pane. Logical View Open the Logical Pane. ORM Open the ORM Pane. Stencil Open the Stencil Pane. Property Open the Property Pane. Diagram Overview Open the Diagram Overview Pane. Documentation Open the Documentation Pane. Message Open the Message Pane. Import and Import VP-UML To import model and diagrams from VP-UML project. Export Project

Import Rose Project To import model and diagrams from a Rose project. Import XMI To import model and diagrams from an XMI file. Import XML To import model and diagrams from an XML file. Import MS Word to To import use case model from an MS Word file. Use Case Model

Import ERwin Project To import a MS Word to update the use case model in the current (XML) project.

Export VP-UML To export the current project. Project

Export XMI To export the current project as XMI file.

Export XML To export the current project as XML file. Export Active Diagram To export the active diagram as image. as Image There are 3 kinds of diagram export: Export Active Diagram as Image - To export the current active Export Diagram as diagram as Image. Image Export Diagram As Image - Show the Diagram Exporter Dialog Export Selection As Image - Only export the selected diagram elements. Export Selection as To export the selected portion of diagram as images. Image Export Use Case Model To export use case model as an MS Word document. to MS Word Report Generate HTML To generate reports in HTML format. Report

Generate PDF Report To generate reports in PDF format. Generate Word Report To generate reports in MS Word format. Report Writer To display the Report Writer for creating report. To publish Visual Paradigm projects to technical and professional Project Publisher Web documents. The published Web content can be accessed in any Web browsers.

Teamwork Open Teamwork Client To open the Teamwork client. Commit To commit the current project to teamwork server.

1-18 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Tools Use Case Scheduling To open the Use Case Scheduling Dialog box. To reverse an instant of source code such as Java (sources and class), C++ source, .NET dll or exe files, PHP source, CORBA IDL source, Instant Reverse Ada9x source, XML, XML schema, Hibernate mapping and database through JDBC. To open the Instant Generator dialog box to select the type of source Instant Generator to generate from VP-UML model. To generate Java code from VP-UML models. The generated code will update only the changes you have made to the models instead of Update to Code overwriting everything, which means your custom code in the generated file can be retained.

Update to Model To reverse Java code to VP-UML models. To display the IDE Integration dialog box. You can then select to IDE Integration install integration with Eclipse, JBuilder, NetBeans, IntelliJ IDEA, JDeveloper or WebLogic Workshop.

DB-VA SQL To start the DB-VA SQL application. Shape Editor To open Shape Editor for creating/editing stencils. Table 1.7 - Toolbar description.

Panes

When VP-UML is executed you are taken to the VP-UML modeling environment where you can create and develop your UML diagrams. Several panes are displayed by default, such as the Diagram Navigator Pane, Property Pane and Message Pane. You can resize panes, dock/undock them, close them and toggle their auto-hide options.

Diagram Navigator Pane

The Diagram Navigator Pane displays all diagrams within the project in a project tree and organizes them by their diagram type.

Figure 1.19 - Diagram Navigator Pane

Button Icon Description

New Diagram To create a new diagram. Collapse To collapse all the nodes within the project tree.

1-19 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Expand To expand all the nodes within the project tree. Show Diagram View To show only diagrams but not models in the tree. Sort by Name To sort diagrams within the project tree by alphabetical order of their names Sort by Type To sort diagrams within the project tree by their diagram type. Move Selected Model Up To move selected models upwards. Move Selected Model Down To move selected models downwards. Refresh To refresh the project tree within the Diagram Pane. Table 1.8 - Diagram Navigator Pane

Model Pane

The Model Pane displays all models within the project in a tree.

Figure 1.20 - Model Pane

Button Icon Description

New Model To create a new model.

Collapse To collapse all the nodes within the project tree. Expand To expand all the nodes within the project tree. To display the models within the project without sorting. Ordering of models will be based on No Sorting their order of creation.

Sort by Name To sort models within the project tree by alphabetical order of their names Sort by Type To sort models within the project tree by their model type. Move Selected Model To move selected models upwards. Up Move Selected Model To move selected models downwards. Down

Refresh To refresh the project tree within the Model Pane. Table 1.9 -Model Pane

1-20 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Class Repository Pane

The Class Repository Pane displays all classes within the project in a tree.

Figure 1.21 - Class Repository Pane

Button Icon Description

New Model To create a new model.

Collapse To collapse all the nodes within the project tree. Expand To expand all the nodes within the project tree. Reverse Code... To reverse Java code to VP-UML models. Instant To reverse files to VP-UML models. The Instant Reverse Options dialog box will appear asking for a Reverse... type for reversing.

Refresh To refresh the project tree within the Class Repository Pane. Table 1.10 - Class Repository Pane

Logical View Pane

The Logical View refers to a user's view of the way project is organized. It provides another view of creating, structuring and sharing the UML diagrams and models apart from the traditional Diagram Navigator, Model Tree View and Class Repository.

Figure 1.21 - Logical View Pane

Button Icon Description

Collapse To collapse all the nodes within the project tree. Expand To expand all the nodes within the project tree. Set Logical View Structure To set the current Logical View structure as the default one. Logical View structure in new as Default projects will follow the default style.

Refresh To refresh the project tree within the Logical View Pane. Table 1.11 - Logical View Pane

1-21 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

ORM Pane

Display a list of classes and database tables from the specified classpath (s) and database (s). You can click Refresh to update the content under Class View and DataBase View whenever there are changes to source code or database. You can drag classes or entities onto diagrams and generate source code/database from them when necessary.

Figure 1.22 - ORM Pane

Button Icon Description Classpath To specify the classpath from which the details of Classes within those paths are to be displayed Configuration under Class View. To refresh the content under both Views by retrieving information of both classes and database Refresh tables from the specified path of source. Database To specify the target database(s) for which the information of their database tables is to be Configuration displayed under DataBase View.

Table 1.12 - ORM Pane

Stencil Pane

Although the original UML notations are rich, but still may not expressive enough to present your idea. The stencil in VP- UML provides a large variety of shapes apart from the ordinary UML notations, and you can place the stencil in UML diagram to present your own idea. Stencil Pane is a repository where the imported those shapes are stored.

Figure 1.23 - Stencil Pane

Button Icon Description

Import Stencil... To browse and import the shapes sent from MS Visio. Select Stencil To list the available category of stencil. Click on a category to display its stencil in the Stencil Pane. Stencil Options To configure stencil such as creating, renaming and deleting a category. Stencil Pane

1-22 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Property Pane

Every diagram and diagram element have their own properties. The Property pane allows you to view and edit properties for all diagrams and diagram elements.

Figure 1.24 - Property Pane

Diagram Overview Pane

The Diagram Overview pane, also known as the Diagram Monitor, shows an overview of the diagram. The Diagram Monitor allows you to navigate the whole diagram pane when the diagram is larger than the display area of the diagram pane.

Figure 1.25 - Diagram Overview Pane

Documentation Pane

You can view/modify the documentation for all diagrams or diagram elements.

Figure 1.26 - Documentation Pane

Message Pane

Display the log and find results in two tabs.

Figure 1.27 - Message Pane

1-23 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Tab Description The field for showing messages generated by the application. You can right-click on the blank region and choose Log from popup menu to display Information, Warning or Error log, with or without displaying the time. You can also copy or remove logs. The field for presenting the search result. It will be activated only when you have performed a "Find" operation. The Find find result, the models and diagrams, will be placed in the message pane. You can also copy or remove the results by Results popup menu.

Figure 1.28 - Message Pane

Layout and Perspective

Saving Perspective

If you are satisfied with the current UI environment and want to re-apply this environment later, you can save it as a perspective. In order to do this, choose View >Save Perspective as... from main menu. This displays the Save Perspective As dialog box.

Figure 1.29 - Saving Perspective It allows you to supply the perspective name in the Name field, and you can select whether this perspective should be shown in the menu by selecting/deselecting the Show in Menu checkbox. You can optionally provide a description for this perspective. After you have supplied the necessary information click OK to confirm.

Opening Perspective

To open a perspective, choose View > Open Perspective from main menu, and select the perspective that you want to open. You may also click Others... from the popup menu to view a list of available perspectives, together with their detailed information, and the description and preview of each perspective.

Figure 1.30 - Select Layout perspective dialog

Note

You can click once on the picture of the Preview pane to see a larger preview.

1-24 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Managing Perspective

To manage perspectives, choose View >Manage Perspectives... from main menu. This displays the Layout Perspective Configure dialog box.

Figure 1.31 - Layout perspective configure dialog On the upper-left corner is a list of perspectives. You can rename them and select whether they should appear in the menu, or reorder them using the Move up and Move down buttons beside the table.

Figure 1.32 - Press on Move Up button

To remove perspectives select one or more perspectives in the table and click the Remove button. The preview of the selected perspective will be displayed in the Preview pane , where you can see a larger preview by clicking once on the picture of the Preview pane . The Perspective Preview dialog box will appear displaying how VP-UML will look like after the selected perspective is applied. You may then click once on the preview picture to close the preview dialog box.

Figure 1.33 - Perspective Preview You may also edit the description of the perspective by typing directly in the Description field.

Resetting Perspective

To reset to the default perspective of the currently applied perspective, choose View > Reset Perspective to Default from main menu. All the UI components will then be reset to its original locations and sizes as defined in the perspective.

1-25 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Open Specification Dialog Box

The open specification dialog box is a top-level window which enables you to browse for and edit the detail of model elements or diagrams. It can be invoked by right-clicking on either a model or a diagram and select Open Specification... from popup menu.

Figure 1.34 - Open Actor Specification Figure 1.35 - Open Diagram Specification

Figure 1.36 - Actor Specification The open specification dialog box contains several pages which show different aspects of the selected item. Basically, general information such as name, stereotype, documentation, files are included in most of the model elements. For some of the model elements, relationship between other diagram elements (children, relations) and information that is specific to the diagram elements (attributes/operations in Class, sub-diagrams of Package) will be displayed, too. There are five buttons at the bottom of the dialog box. They are Reset , OK , Cancel , Apply and Help . Button Description Reset Reset the changes made in the dialog box. OK Accept the changes and close the dialog box. Cancel Cancel and close the dialog box. Apply Apply the changes immediately without closing the dialog box. Help Display the help information of the Open Specification dialog box.

Table 1.29 - Specification Dialog Button

1-26 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

Navigating between Diagram Elements

You can navigate to other diagram elements via the open specification dialog box. This can be done in two ways. For diagram elements with a one-to-many relationship such as relations, children, you can invoke the open specification dialog box of a selected diagram element by clicking on the Open Specification... button.

Figure 1.37 - Open Association Specification

Some of the properties of the diagram element are references to another diagram element (or a reference to itself) such as Supplier/Client of a Dependency, or Role A/Role B of an Association. In this case you can click on the ... button besides this property to navigate to that diagram element.

Figure 1.38 - Association Specification

Note that if the open specification dialog box of the referenced diagram element is already opened, this button will be disabled.

1-27 VP-UML User’s Guide (Part 1) Chapter 1 – Getting Started with Visual Paradigm for UML

1-28

Part 1 – Working with Visual Paradigm for UML VP-UML User’s Guide (Part 1)

Part 1 - Working with Visual Paradigm for UML

Welcome to Visual Paradigm for UML (VP-UML), a powerful visual UML CASE tool. Visual Paradigm for UML is designed for a wide range of users, including Software Engineers, System Analysts, Business Analysts, System Architects alike, who are interested in building software systems reliably through the use of the Object-Oriented approach. This part explains in detail how to use VP-UML to perform UML modeling, such that you can develop your application in a faster, better and cheaper way. In this part:

• Getting Started with Visual Paradigm for UML • Working with Projects • Working with Diagrams • Generating Documentation • Interoperability • Automatic Diagrams Layout • Instant Reverse • Incorporating Visio® and Images to Diagrams • Working with Teamwork Projects

2 Working with Projects VP-UML User’s Guide (Part 1) Chapter 2 – Working with Projects

Chapter 2 - Working with Projects

A VP-UML project is a virtual container that stores all the diagrams and models related details. A VP-UML project file, with extension .vpp, is a physical entity of project. This chapter offers basis in working with VP-UML project, say creating, exporting and merging a project. In this chapter:

• Creating, Opening and Saving Projects • Exporting and Importing Projects • Working with Project Templates • Managing Project Properties

Creating a New Project

To create a new project, select from main menu File > New Project or press Ctrl-N. This displays the New Project dialog box. Specify all the relevant information and click Create Blank Project .

Figure 2.1 - New Project Dialog

Tab Field Description UML Select either UML 1.x or UML 2.0. Different set of UML notations will be available to support / version software development with different UML version. Properties The name of the VP-UML project. The name " untitled" will be adopted as the name of project Project name by default. Author The one who create the project. Company The company that the project belongs to. Project Enter any information that you think maybe relevant to your project. description Select from the list the desired template. Preview will be presented at the right-hand side by selecting any of them. A template is a predefined project structure. Diagram(s) with empty Template Templates content will be created in the new project, following the structure and diagram names defined in the template. Other CASE Specify the file path of the Rose model that you wish to import into the new VP-UML project. Import from Tool Project Selecting Model Only will only import the model from the Rose project, while selecting Model Rose and Diagram will import both the model and the diagrams (view) from the Rose project. Import from Specify the file path of the XMI file that you wish to import into the new VP-UML project. XMI

Table 2.1 - New Proejct Dialog

2-2 VP-UML User’s Guide (Part 1) Chapter 2 – Working with Projects

Opening a Project

To open an existing project, select File > Open Project... from the main menu or press Ctrl-O. This displays the Open dialog box. In the dialog, locate the VP-UML project file (with extension. vpp) and click Open to open the project file. VP-UML also provides access to the most recently opened projects. You can click to open project from the recent project list on the start page. An alternative is to open the project file by choosing File > Reopen > %FILE_PATH% from the main menu. The maximum size of the list on start page is 5, while the list from File menu is 10.

Saving a Project

Once the project is modified, you can save it to commit the changes to the project file. To save a project, select File > Save Project from main menu. If the project has not been saved yet, this displays the Save dialog box so you can specify a location for the file and click Save to save the file. If the project has been saved before, it will commit the project data to the file.

Note Alternatively, you can press Ctrl-S, or click the Save Project button on the toolbar, or select from main menu File > Save Project as... to save a project. Notice that selecting the File > Save Project as... from main menu is for saving the project to another location.

Exporting and Importing (Merging) of Project

If you are maintaining a large VP-UML project that contains many diagrams, you can use the export project facility to split it into smaller projects by selecting the desired diagrams. Each exported project is self-contained, which means it has all the diagrams and model elements of the selected diagrams, and the modification of the project does not affect the original project that it is derived from. After you have modified the exported project, you can merge the changes to the original project using the merge project facility. The project export and merge facilities together facilitate the sharing of a project among collaborative workers.

Figure 2.2 - Export/Import Diagram

2-3 VP-UML User’s Guide (Part 1) Chapter 2 – Working with Projects

Exporting Project

To export the current project into a new project, choose File > Export > VP-UML Project... from main menu. This displays the Export Project dialog box. Specify all the relevant information and click Export .

Figure 2.3 - Export Diagram

Field Description Output The Output destination is the directory where exported project is saved to. You can enter the path in the text destination field directly, or you can click on the ... button to browse for a VP-UML project file. Diagrams Check the diagrams for exporting. Models inside those diagrams will also be exported. The Preview pane shows the preview of the exported image of the selected diagram in the Diagrams pane. You can check/uncheck the Show preview checkbox to enable/disable the preview. Preview You can 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.

Table 2.2 - Export diagram

Importing (Merging) a VP-UML Project

To import a project, opening the master project in VP-UML (the project where the exported projects are derived from). After that, select File > Import > VP-UML Project... from main menu. This displays the Open dialog box. In the dialog, locate the VP-UML project file (with extension .vpp) and click Open to open the project file. The changes in the selected project will be merged to the master project.

Note You can select a project to import even it is not created using project export. However, the merging process will update every model elements in the project, instead of only the modified elements in this case.

Project Template

A project template is a pre-defined project structure that can be used over again on new projects. It defines the diagram type as well as their name of a project. For example, if you have created two class diagrams in a project, Domain Model and MyClassDiagram, and you think this project structure will be used over again in your development you can save this project as a project template for future use.

2-4 VP-UML User’s Guide (Part 1) Chapter 2 – Working with Projects

Saving Project as Template

To save the current project as a template, select File > Save as Project Template... from main menu. This displays the Save Template dialog box.

Figure 2.4 - Save Project as template

Field Description Template name Specify the name for this project template. Template Description Enter any information that you think maybe relevant to this project template.

Table 2.3 - Save project as template

Maintaining Project Template

To maintain existing templates, choose File > Maintain Project Template... from main menu. This displays the Maintain Templates dialog box.

Figure 2.5 - Maintain Project Template

By selecting a template from the Templates list, its preview will be shown on the Template Preview tree. To rename a template, select and right-click on the target template from the Templates list, select Rename... from popup menu, enter a new name and then click OK to commit. To edit the template description, select the target template from the Templates list and edit the description in the Template Description text field.

2-5 VP-UML User’s Guide (Part 1) Chapter 2 – Working with Projects

To remove a template, select and right-click on the target template from the Template list and select Delete Project Template from popup menu.

Managing Project Properties

To query/modify the project properties, choose File > Project Properties... from main menu. This displays the Project Properties dialog box which consists of three pages: General and PDF Report .

Figure 2.6 - Managing Project Properties

Tab Field Description General The name of the VP-UML project. The name " untitled" will be Project name adopted as the name of project by default. Author The one who create the project. Company The company that the project belongs to. Project description Enter any information that you think maybe relevant to your project. PDF Report To select the destination directory for the generated report. You can (Please refer to Chapter 4 for more File location type the path in the text field or you can browse the location by details on PDF Report Generation) clicking on the ...button. If this option is selected, the default browser of the system will be Launch viewer opened automatically to show the generated document. If this option is selected, the image of the selected diagrams will be Generate diagrams generated to the report. Generate model's The defined file and URL link in the project will be generated if this file/URL link option is selected. Generate Use Case Select to include use case scheduling in the report. Scheduling Template Select the template for generating the report. Anti-aliasing Graphics To enable/disable the graphic anti-aliasing of the diagram images. Text To enable/disable the text anti-aliasing of the diagram images. Diagram quality To select the image quality of the diagrams in the report. Print Diagrams To select which diagram will be generated in the report.

Table 2.4 - MProject Properties

2-6

3 Working with Diagrams VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Chapter 3 - Working with Diagrams

This chapter will show you how to perform visual modeling in VP-UML such as drawing diagram elements (shapes and connectors), customizing connectors, editing the diagrams and exporting diagram as image. In this chapter:

• Creating diagram elements • Editing diagram and diagram elements • Using diagram layout • Using the compartment settings for classes

Creating Diagram Elements

After creating a new diagram, you can create diagram elements using the diagram toolbar. In this section, we will introduce the techniques of how to create diagram elements and connectors:

• Creating Shapes • Creating Connectors • Creating Self-Connection

Creating Shapes

To create a shape, click on a diagram element button from the diagram toolbar and click on the diagram pane to create it.

Figure 3.1 - Create Shapes

Creating Connectors

To create a connector, select the desired connector from the diagram toolbar and click on the source shape. Drag the connector to the destination shape. VP-UML provides continuous UML syntax checking. You will see a stop sign when you try to create an invalid connection. For example, you cannot create a generalization relationship between an actor and a use case.

Figure 3.2 - Try to create an invalid connection If the connection is valid you will see a blue rounded rectangle surrounding the destination shape.

Figure 3.3 - Try to create a valid connection

3-2 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Creating Self-Connection

Some of the shapes can have a connection to itself. For example, Self-Association of a Class or Self-Link of an Object in Communication Diagram. To create a self-connection click on the connector button on the diagram toolbar and click once on the target object.

Figure 3.3 - Create self-connection

Resource-Centric Interface

A user interface based on the Resource-Centric approach is adopted in VP-UML to enable UML diagrams to be constructed intuitively with minimal efforts. With the novel interface, only valid editing resources are grouped around a graphical entity, totally eliminating invalid operations during diagram construction. The resources of a diagram element are visible only when it is being selected. Each available resource is displayed as an icon surrounding the element. You can also move the mouse over a resource to see the tool tip associated with it.

Figure 3.4 - Resource-Centric

Using the Resource-Centric Interface

A resource is usually used to create a shape from another shape, and connect them with a connector. For example, if you drag the resource "Association -> Use Case" from an Actor element to the white space of the diagram, a new Use Case will be created, and it connects the Actor with an Association.

Figure 3.5 - Create shape by using resource-centric

You can also use the resource-centric interface to create a connection between existing shapes. For example, if you have created an Actor element and a Use Case element, drag the resource "Association -> Use Case" from the Actor element to the Use Case element to connect them with an Association relationship.

Figure 3.6 - Create an association by using resource-centric

If you try to use the resource-centric interface to perform invalid connections between shapes (for example, dragging the "Association -> Actor" resource from an Actor element to a Use Case element) a stop sign will display to indicate that the current action is invalid.

Figure 3.7 - Try to create an invalid association by using resource-centric

3-3 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Show Extra Resources

By default the resource centric interface displays the most commonly used resources of a diagram element. You can choose to view those less common resources. This can be done by clicking on the View menu. When the view menu appears, select Extra Resources to view the extra resources of the diagram elements. The figures below show the view of a Class element with "Show Extra Resources" turned off and on.

Figure 3.8 - Resource-centric of Action Figure 3.9 - Action with an Extra Resource-Centric

Auto Hide Resource Centric

VP-UML will automatically hide the resource centric components. When you select the shape, the resource centric components will show. When you move the mouse pointer out of the shape, the resource centric will automatically hide.

Figure 3.10 - Auto hide resource-centric

Enabling/Disabling the Resource-Centric Interface Feature

To enable/disable the resource centric interface feature, click on the View menu to check/uncheck Resources checkbox.

Group Selection Resources

When editing a diagram, you can take advantage of group selection resources to help you align or distribute selected shapes more efficiently. The group selection resources available are the alignment resource, distribution resource and same size resource. You can either click on a resource to perform the last selected action, or click on the drop-down button to select an action to perform in the popup menu.

Figure 3.11 - Group selection

3-4 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Alignment Resource The alignment resource will be visible when two or more shapes are selected and you mouse over one of the selected shapes.

Figure 3.12 - Alignment resources

Distribution Resource The distribution resource will be visible when three or more shapes are selected and you mouse over one of the selected shapes.

Figure 3.13 - Distribution resources

Same Size Resource The same size resource will be visible when two or more shapes are selected and you mouse over one of the selected shapes.

Figure 3.14 - Adjust Size resources

Enabling/Disabling Group Selection Resources To enable/disable group selection resources, open the Options dialog box, Diagramming > Resource Centric and select/deselect the Show group resources option.

Connector Styles

Connectors are the lines that connect two shapes. When more shapes are created and more connectors appear, you may find that it is annoying to handle the spaghetti like connectors. To overcome this problem, VP-UML provides six connector styles to help you handle the connectors, namely Follow Diagram, Rectilinear, Oblique, Curve, Round Oblique and Round Rectilinear.

Follow Diagram Connector Style

Follow Diagram is a "virtual" connector style in which the actual style will be determined by the owner diagram. When you right-click on a diagram you can set its default connector style from its popup menu, once the diagram connector style is changed, all connectors whose connector style is set to Follow Diagram will be updated to follow the new style.

3-5 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Rectilinear Connector Style

Once the connector is set to Rectilinear, the connector always remains either horizontal or vertical. You cannot create a breakpoint on the connector by yourself. The breakpoints are generated on the connector automatically after you reshape the line. In the following figure, there is a pin icon at each end of the connector. Pinning a connection end point allows the pinned end point of a connector to be fixed, no matter how the connecting shapes are moved. For further details, please refer to Connection Point > Pinning the Connection End Point in this chapter.

Figure 3.15 - Rectilinear Connector Style

To reshape the connector, you can drag the lines or the break points at the connector. There are two different effects for dragging lines: dragging on lines and dragging on break points.

Dragging on Lines There is a horizontal line and vertical line along the connector. If you are dragging on the horizontal lines, the lines can only move up and down. In the following figures, the line we want to move is in red. As you can see, the right end point of the red line is touching Class2. After moving the red line upwards, the right end point of the red line does not touch Class2. To rectify this, a vertical line is automatically created to continue the connection between Class and Class2.

Figure 3.16 - Drag on the line

The result of dragging vertical line is similar to dragging horizontal line. The difference is that the line is restricted to vertical movement (either from left to right or from right to left). When two shapes are disconnected, a horizontal line will be created at the end of point to continue the connection between shapes.

Dragging on Break Points Dragging on break points provides two dimensional movements to the point to modify the connectors. The point being moved may affect all lines of the connector that depends on the numbers of line in the connector. The following figures demonstrate the result of dragging the orange point along the red arrow.

Figure 3.17 - Drag on break point

3-6 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Oblique Connector Style

There is no boundary for the modification of the connectors. You can create break points anywhere you like on the connector. The lines in the connector would not be aligned with the horizontal or vertical axis. If you drag a line, a new breakpoint will be created on the drag point and two lines will be created. If you wish to modify a line to horizontal line or vertical line, you need to do it yourself. The following figures demonstrate the modifications to the connector. In the below figure, we break the connector by clicking the red point. The new breakpoint is created when you drag the connector away from its starting point. When you release the mouse click the breakpoint will have finalized.

Figure 3.18 - Oblique Connector Style

The figure below shows the modification to the connector with the oblique connector style. The connector is divided into two lines and a new break point (red point) is created on the connector.

Figure 3.19 - Create a break point by drag on the line

Note

You can use the Point Eraser in the Diagram Toolbar to erase the connector points.

Curve Connector Style

By applying the Curve connector style, the connector will be arranged as a smooth curve line. To change the curve shape, simply add/move/remove point(s) on the connector and the curve will be automatically re-calculated according to the points. The Curve connector style makes the connectors much easier to route in complex diagrams to avoid crossing connectors.

Figure 3.20 - Curve Connector Style

Round Oblique Connector Style

The behavior of Round Oblique connector style is the same as that of Oblique connector style. The only difference is the corners of the connector using Round Oblique style will appear as round.

Figure 3.21 - Round Oblique Connector Style

3-7 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Round Rectilinear Connector Style

The behavior of Round Rectilinear connector style is the same as that of Rectilinear connector style. The only difference is the corners of the connector using Round Rectilinear style will appear as round.

Figure 3.22 - Round Rectilinear Connector Style

Change Connector Style

When a new connector is created, it follows the default connector style which is defined in the Options of the application. It is possible to change the connector style individually. There are two ways to change the connector style. The first one is via a popup menu and the other is via the Property table . To change the connector style via popup menu:

1. Right click the connector that you want to change its style. 2. Select the Connector Style menu. And then the connector style sub-menu appears. 3. Select either Rectilinear , Oblique , Curve , Round Oblique or Round Rectilinear .

Figure 3.23 - Change connector style on popup menu To change the connector style via Property table :

1. Select the connector whose style you want to change. 2. Find the Connector style row in the Property table. 3. Click the Value column of Connector style row. 4. Select either Rectilinear , Oblique , Curve , Round Oblique or Round Rectilinear .

Figure 3.24 - Change connector style on properties table

3-8 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Set a Default Connector Style

Default connector style can be set from the Options. To set default connector style:

1. Select Tools > Options... from main menu. This displays the Options dialog box. 2. Open the Diagramming page. 3. Select the Environment tab. 4. From the row Connector Style , select either Rectilinear , Round Rectilinear , Oblique , Round Oblique or Curve . 5. Press OK button to confirm changes.

Connection Point

Each shape has a property called Connection Point that specifies how the connecting points of the connectors should move if the shape is being moved.

Setting Connection Point Style

To set the connection point style: Using the popup menu

1. Select one or more shapes and right-click on the selection. 2. Select the Format > Connection Point... from popup menu. This displays the Select Connection Point Style dialog box.

Figure 3.25 - Select Connection Point Style Dialog

3. Select either Round the shape or Follow center for the connection point style. Upon selecting a style an animation will appear to emulate the effect of the selected connection point style. 4. Click OK to confirm the change.

Using the property table

1. Select a shape. 2. Select either Round the shape or Follow center from the Value field of the Connection point property.

Figure 3.26 - Properties Table

3-9 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Round the Shape Upon selecting the "Round the shape" connection point style the last connect point of the connector will move along the bounds of the shape.

Figure 3.27 - Round the shape

Follow Center Upon selecting the "Follow center" connection point style the last connect point of the connector will be determined by the center of the shape.

Figure 3.28 - Follow center

Pinning the Connection End Point

Pinning a connection end point allows the pinned end point of a connector to be fixed, no matter how the connecting shapes are moved. In figure below, the connection end point linking the class Bank is pinned to the location of the getAccount operation.

Figure 3.29 - Pin a connector point

In VP-UML a connecting end point is unpinned by default. If a connecting end point is unpinned, its location will be determined by the connection point style of the connecting shape. To pin a connection and an end point: Using Resource-Centric Interface

1. Click once on the connector to select it. 2. There is a "pin" resource for each connection end point. If the end point is currently pinned an icon will be displayed (a pin with shorter needle). If the end point is currently unpinned, an "unpinned" icon will be displayed (a pin with longer needle). In the figure below, the end point connecting the class Bank is pinned, while the end point connecting the class BankConsortium is unpinned. 3. Click once on the resource to toggle its pin state.

Figure 3.30 - Toggle the pin state Using the popup menu

1. Right-click on the connector. 2. Select the Pin menu from the popup menu, the Pin sub-menu appears. 3. Select either From Point or To Point to pin/unpin the desired connection end point.

3-10 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Basic Editing Features

In this section we will talk about the basic editing features in VP-UML, including:

• Undo • Redo • Copy • Paste • Delete

Undo

You can roll back undesirable changes by performing Undo. To undo an action, perform one of the following actions:

• Select Edit > Undo from main menu. • Click on the Undo button on toolbar. • Press Ctrl-Z.

Redo

This feature is to re-perform actions that were just undone. To redo an action, perform one of the following actions:

• Select Edit > Redo from main menu. • Click on the Redo button on toolbar. • Press Ctrl-Y.

Copy

You can select and copy diagram element(s) and reuse it later on. There are five kinds of copy available in VP-UML.

• Default Copy • Copying within VP-UML • Copying to Clipboard as OLE • Copying to Clipboard as Image (JPG) • Copying to Clipboard as Image (EMF)

Default Copy The default copy is triggered when the hotkey Ctrl + C is pressed. The actual action performed by default copy follows the VP- UML application option (as configured in the Options dialog box -> Diagramming category -> Environment page). The default copy action can be set to one of the following:

• Copying within VP-UML • Copying to Clipboard as OLE • Copying to Clipboard as Image (JPG) • Copying to Clipboard as Image (EMF)

The default "default copy" action is Copying within VP-UML.

3-11 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Copying within VP-UML Copying diagram elements within VP-UML allows you to copy selected diagram elements to the application clipboard. You can paste the diagram elements to other VP-UML diagrams from the current project or across another project.

Note

You cannot paste the selected content to other applications.

To copy selected diagram elements within VP-UML, perform one of the following actions:

• Select Edit > Copy > Within VP-UML from main menu. • Click on the Copy drop down button on the toolbar and select Copy within VP-UML from the drop down menu. • Right-click on the selected diagram elements and choose Copy > Copy within VP-UML from popup menu. • Press Ctrl-C.

Copying to the Clipboard as Image (JPG)

Copying diagram elements as JPG image will copy the selected diagram element as a JPG image to the system clipboard. This feature is available to any Java-enabled platforms. To copy selected diagram elements to the system clipboard as JPG image, perform one of the following actions:

• Select Edit > Copy > To Clipboard as Image (JPG) from main menu. • Click on the Copy drop down button on the toolbar and select Copy to Clipboard as Image (JPG) from the drop down menu. • Right-click on the selection and choose Copy > Copy to Clipboard as Image (JPG) from popup menu. • Press Ctrl-Alt-C.

Copying to the Clipboard as Image (EMF)

Copying diagram elements as EMG image will copy the selected diagram element as an EMF image to the system clipboard. Unlike copy as JPG image, the copied content is in EMF (Enhanced Metafile) format, which is a more scalable format that image quality can remain even being resized/zoomed.

Note

The copy to system clipboard as EMF image feature is available on Windows platforms only.

To copy selected diagram elements to the system clipboard as EMF image, perform one of the following actions:

• Select Edit > Copy > To Clipboard as Image (EMF) from main menu. • Click on the Copy drop down button on the toolbar and select Copy to Clipboard as Image (EMF) from the drop down menu. • Right-click on the selection and choose Copy > Copy to Clipboard as Image (EMF) from popup menu. • Press Ctrl-Alt-Shift-C.

Paste

You can select different paste methods according to what you have copied.

• Most commonly you will paste copied diagram elements obtained using the "Copy within VP-UML" command, in that case you can choose whether the pasted diagram elements will share the same model as the source elements.

3-12 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

• If you have copied an image to the clipboard, either within VP-UML or using external applications, you can paste the copied content as an image shape in the diagram.

Pasting Copied Diagram Elements You can paste the copied diagram elements to the current diagram or another one. There are two ways in pasting diagram elements. One is to paste with model sharing and another one is to paste without model sharing.

Note

You can only paste the content that is copied using the " Copy within VP-UML " command.

Pasting with Model Sharing The pasted diagram elements share the same instance of the copied diagram elements. Any changes made on the pasted elements will result in the same changes appearing on the elements copied. To paste diagram element with model sharing, perform one of the following actions:

• Select Edit > Paste from main menu. • Click on the Paste drop down button on the toolbar and select Paste from the drop down menu. • Right-click on the target diagram and choose Paste from popup menu. • Press Ctrl-V

Pasting without Model Sharing It clones a copy of the copied diagram elements and pastes them to the diagram. To paste diagram element without model sharing, perform one of the following actions:

• Select Edit > Paste (not Share Model) from main menu. • Click on the Paste drop down button on the toolbar and select Paste (not Share Model) from the drop down menu. • Right-click on the target diagram and choose Paste with Model from popup menu.

Pasting as Image Shape With image shape, you can easily annotate and document your diagrams with related images. Instead of creating an image shape manually, you can copy an image from any application to the clipboard and then paste it to the diagram as a new shape.

Figure 3.31 - Paste as Image Shape To paste an image shape, perform one of the following actions:

• Select Edit > Paste from main menu. • Click on the Paste drop down button on the toolbar and select Paste from the drop down menu. • Right-click on the target diagram and choose Paste from popup menu. • Press Ctrl-V

3-13 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Delete

This feature is to remove the selected diagram elements. To delete diagram element, select the diagram elements for to be removed and perform one of the following actions:

• Select Edit > Delete from main menu. • Right-click on the selection and choose Delete from popup menu. • Press Delete .

Finding a Model Element

Model elements can be searched for in the project. To find a model element, you should first display the Find dialog box. To display the Find dialog box, select Edit > Find from main menu.

Figure 3.32 - Find Model Element Dialog

Field Description Text Enter the text for which you want to search. Scope Select from drop-down menu any of the options to narrow the search in different ways: Find in All Diagrams - To search for model elements in all diagrams within the project. Find in diagram Find in Opened Diagrams - To search for model elements in all opened diagrams within the project. Find in active diagram only - To search for model elements in the active diagram. Do not find in diagrams - Not to search for model elements in any of the diagrams. Check/Uncheck to enable/disable searching for model elements from existing models within the Find in model project. Include documentation of Check/Uncheck to enable/disable searching not only the name of the model, but also the elements documentation of the model. Model Types This option is available only when Find in model is checked. This enables to search model All model types elements with all types. This option is available only when Find in model is checked. This enables to search model Specified model types elements with model type same as the one specified from the list beneath it. Option Check/Uncheck to determine whether or not a case sensitive or insensitive search is to be Case Sensitive performed.

3-14 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Accept models only if their name and/or documentation match exactly the word specified in Text Match whole words only field. General commands Reset Reset the changes made in the dialog box. Find Find model elements according to the scope specified from the Find dialog box. Close Close the Find dialog box without performing search. Help Display the Help content of Configure Stereotypes dialog box.

Table 3.1 Search result is to be displayed in the Find Results page of the Message Pane .

Figure 3.33 - Find result You can copy, remove or clear result (s) by right-clicking on the result (s) and selecting the corresponding commands from popup menu.

Jumping to Shape/Model

In order to let you locate the desired shape/model easier and faster, the jump to shape/model facility is introduced. You can select either jump to a shape in the active diagram, or jump to any shape/model in the current project.

Jumping to Shape in Active Diagram

1. With a diagram active, select menu Edit > Jump to Element in Active Diagram..., or press the hotkey Ctrl + J .

Figure 3.34 - Select Jump to shape in active diagram

3-15 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

2. The jump to shape pane is shown. If you are uncertain about the name of the shape to jump to, press the Up/Down arrow key to popup the shape list and browse for it there.

Figure 3.35 - Shape in the active diagram is shown

3. Upon the selection of an item in the list, extra information like the parent of the selected element is shown. If you keep selecting an item for one second, the corresponding element will be "spotlighted" in the diagram.

Figure 3.36 - Spotlight on the diagram when select the Shape

4. When the spotlighting is in action, the jump to shape pane will reposition itself to avoid overlapping with the target shape if the Auto position option is selected.

Figure 3.37 - Auto position

5. If you know the name of the shape to find, you can type all or part of its name to filter the items in the list so you can located the shape must faster. Wildcard characters * (all combination of characters) and ? (any one character) can also be used.

Figure 3.38 - Filter the shapes

3-16 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

6. With the desired item in the list selected, press the Enter Key. The corresponding element will be selected and centered in the diagram.

Figure 3.39 - Auto select the shape and centered in diagram

Jumping to Element in Project

1. Select menu Edit > Jump to Element... , or press the hotkey Ctrl + Shift + J .

Figure 3.40 - Select Jump to element

2. The jump to element pane is shown. Similar to jump to shape in active diagram, you can press the Up/Down arrow key to popup the list of elements, and type text to filter the list. But this time the list is filled with all shapes and models in the project, regardless of the diagram they reside. To let you identify which diagram a selected element comes from, its diagram name is also displayed.

Figure 3.41 - Select the Element

3. If the selected item refers to an element in the active diagram, this element will be spotlighted in the diagram.

Figure 3.42 - Spotlight in the diagram

3-17 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

4. With the desired element in the list selected, press the Enter Key. If the selected element belongs to a diagram, this diagram will be opened, and the element will be selected and centered in the diagram. If the selected element is a model that does not have a view, it will be selected in the Model pane.

Figure 3.43 - Select in Model pane

Fill Color

All of the shapes have a fill color property, which allows you to select a solid fill color or a gradient fill color and you can define its transparency as well. To format fill color for shapes, select the desired shapes and perform one of the following actions:

• Right-click on the selection and choose Format > Fill... from popup menu. • From the property table, click on the ... button of the Fill property to invoke the Format Fill Color dialog box.

In both cases, the Format Fill Color dialog box will be display.

Format Fill Color Dialog Box

The Format Fill Color dialog box allows you to select the fill color type (solid or gradient) and you can create your own fill color by configuring the transparency, gradient style and colors.

Figure 3.44 - Format Fill Color Dialog

Field Description Select the fill style of the fill color. It can either be Solid (a single color) or Gradient (a fill color that is Fill Style mixed by two colors). 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 Transparency color completely transparent. You can adjust the transparency by dragging the slider, or by typing the value in the text field.

3-18 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Alternatively, you can click the Opaque button to set the fill color to opaque, or click the Transparent button to set the fill color to transparent. The Preview pane displays a rectangle that is filled with the editing fill color. The background is filled with Preview checkers so that you can also preview the transparency of the fill color as well. Save as Default To save the current fill color as the default fill color for new shapes click the Set as Default button. Fill Color

Table 3.2

Formatting a Solid Fill Color Upon selecting Solid from the Fill style field, you will see the detail pane for formatting a solid fill color.

Figure 3.45 - Select Solid Fill Style

Field Description This field displays the current selected color. It will display the color name if the selected color is a default Color color (Black, White, Yellow, etc); otherwise the RGB value of the selected color will be displayed. Default Color The default color list displays a list of pre-defined colors. Each color is displayed with a color preview and a List color name. You can view the RGB value of a color by moving the mouse pointer over the color. The custom color pane display a wider range of colors that you can select from. And you can define a new Custom Color custom color by clicking on the Custom... button. The newly defined color will be added to the recent color list Pane (located at the bottom two rows of the custom color pane) for later reuse. Save as Default Fill To save the current fill color as the default fill color for new shapes click the Set as Default button. Color

Table 3.3

3-19 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Formatting a Gradient Fill Color Upon selecting Gradient from the Fill style field you will see the detail pane for formatting a gradient fill color.

Figure 3.46 - Select Gradient Fill style

Field Description You can select the first color of the gradient from the Color 1 field. To select a color click the ...button or Color 1 double-click on the color editor. A color chooser will appear for you to select a color. You can select the second color of the gradient from the Color 2 field. To select a color click on the ...button or Color 2 double-click on the color editor. A color chooser will appear for you to select a color. 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 Gradient you must select a combination of colors that does not already exist in the color themes. Color To rename a theme click on the Rename... button or double-click on the desired theme. An input dialog will Themes 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. The Gradient Style pane allows you to select the gradient style of the gradient fill color (the angle of how the Gradient gradient color is drawn). There are sixteen pre-defined gradient styles, which are shown as toggle buttons in the Style Gradient Style pane. To select a gradient style to use click on one of the styles.

Table 3.4

Line Format

You can format the line of a shape so that you can adjust its stroke style, weight (thickness), color and transparency. To format the line of a shape, select the desired shapes and perform one of the following actions:

• Right-click on the selection and choose Format > Line... from popup menu. • From the property table, click on the ... button of the Line property to invoke the Format Line dialog box.

In both cases, the Format Line dialog box will be display.

3-20 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Format Line Dialog Box

The Format Line dialog box allows you to format the line of a shape.

Figure 3.47 - Format Line Diagram

Field Description Select the style (stroke) of the line. You can select one of the 23 styles (including "None" , which Style means no line) to apply in the combo box, a preview will be shown for each of the style item. Adjust the weight (thickness) of a line. The greater the value, the thicker is the line. You can use the up/down button to increase/decrease the line weight, or you can type directly in the text field. The allowable line weight range from 1 to 20.

Weight Note 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 line color. Just click on the ... button beside the Color field to select a color either Color 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). Specify the transparency of the line. The greater the value, the more transparent is the shape. 0 (zero) transparency makes the line completely opaque, while 100 transparency makes the line completely transparent. Transparency You can adjust the transparency either by dragging the slider, or by typing the value in the text field. Alternatively you can click on the Opaque button to set the fill color to opaque, or click on the Transparent button to set the fill color to transparent. The Preview pane displays a rectangle that is surrounded by the line with the selected line Preview format applied. Save as Default To save the current line format as the default line format for new shapes click the Set as Line Format Default button.

Table 3.5

Alignment

This feature provides a facility to align selected diagram elements. To align shapes, perform one of the following actions:

• From the main menu, choose Edit > Align Shapes and select one of the alignment methods. You may also select the menu item Align Shapes... to align selected diagram elements by using a dialog box. This will be described later in the section. • Right-click on the selection and choose Alignment from popup menu and select one of the alignment methods in the popup menu. You may also select the menu item Align Shapes... to align selected diagram elements by using a dialog box. This will be described later in the section. • Click on the drop down arrow beside the Alignment button on toolbar and select one of the alignment methods from the popup menu. You may also select the menu item Align Shapes... to align selected diagram elements using a dialog box.

3-21 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

There are several ways in aligning shapes. The description of the alignment methods can be found in the below table. Alignment Description The selected diagram elements will be aligned using the top side of the top-most diagram element as the Top reference of alignment. The selected diagram elements will be aligned using the bottom side of the bottom-most diagram element as the Bottom reference of alignment. The selected diagram elements will be aligned using the left side of the left-most diagram element as the Left reference of alignment. The selected diagram elements will be aligned using the right side of the right-most diagram element as the Right reference of alignment. The centers of the selected diagram elements will be aligned using the x-coordinate of the first diagram element Horizontal as the reference of alignment. The centers of the selected diagram elements will be aligned using the y-coordinate of the first diagram element Vertical as the reference of alignment. The widths of the selected diagram elements will be set to the same value, which is the largest value among the Same Width selected diagram elements. Same The heights of the selected diagram elements will be set to the same value, which is the largest value among the Height selected diagram elements.

Table 3.6 Apart from clicking on the drop down arrow to invoke the alignment selection popup menu, you can also click the alignment button to align diagram elements using the last alignment method selected. Every time you select an alignment method to be used, the alignment button changes its icon and tool tip to reflect the last alignment method you selected.

Figure 3.47 - Align shapes

Referenced Shape for Alignment

When there are multiple shapes selected the last selected shape will be used as the referenced shape for alignment. That is, the alignment method, will be performed based on the position/size of the referenced shape. The referenced shape will be rendered with its resize handles surrounded by black rectangles.

Figure 3.48 You can set a shape as the referenced shape for alignment (if it is currently not) by shift-clicking on the shape for two times (the first time to deselect the shape, and the second time to reselect it).

3-22 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Using the Align Shapes Dialog Box

You can invoke the Align Shapes Dialog either in the menu bar or the toolbar, or using the hot key F12 . The Align Shapes dialog box allows you to configure the top/bottom, left/right alignments and same width/same height options all at a time. Select the desired options and click OK to apply the settings.

Figure 3.49 - Align Shapes Dialog

Distribute Shapes

This feature provides a facility to distribute selected diagram elements with the uniform space. The feature will be active when there are more than two diagram elements selected in the diagram. To distribute shapes, perform one of the following actions:

• From the main menu, choose Edit > Distribute Shapes and select one of the distribution methods. You may also select the menu item Distribute Shapes... to distribute the selected shapes by using a dialog box. This will be described later in the section. • Right-click on the selection and choose Distribute Shapes from popup menu and select one of the distribution methods in the popup menu. You may also select the menu item Distribute Shapes... to distribute shapes by using a dialog box. This will be described later in the section. • Click on the drop down arrow beside the Distribute Shapes button on toolbar and select one of the distribution methods from the popup menu. You may also select the menu item Distribute Shapes... to distribute selected shapes using a dialog box.

There are several ways in distributing shapes. The description of the distribution methods can be found in the table below. Distribution Description Vertically The selected diagram elements will be distributed with the uniform vertical space. The selected diagram elements will be distributed with the uniform vertical space between their top By Top Edges edges. By Vertical Centers The selected diagram elements will be distributed with the uniform vertical space between their centers. The selected diagram elements will be distributed with the uniform vertical space between their bottom By Bottom Edges edges. Horizontally The selected diagram elements will be distributed with the same horizontal space. The selected diagram elements will be distributed with the uniform horizontal space between their left By Left Edges edges. By Horizontal The selected diagram elements will be distributed with the uniform horizontal space between their Centers centers. The selected diagram elements will be distributed with the uniform horizontal space between their right By Right Edges edges.

Table 3.7

3-23 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Using the Distribute Shapes Dialog Box

You can invoke the Distribute Shapes dialog box either in the menu bar or the toolbar. The Distribute Shapes dialog box allows you to configure the top/bottom and left/right distribution at a time. Select the desired options and click OK to apply the settings.

Figure 3.50 - Distribute Shapes Dialog

Grouping

The grouping feature allows you to organize shapes in group, so you can manipulate related shapes together (select, deselect, move, align and resize) more easily. Groups can be formed on shapes, and you can even form a new group on top of existing groups.

Grouping Shapes

To group shapes, select shapes in the diagram and perform one of the following actions:

• Select menu Edit > Group . • Right-click on the selection and select Grouping > Group from the popup menu.

Ungrouping Shapes

To ungroup shapes, select the grouped shapes in the diagram and perform one of the following actions:

• Select menu Edit > Ungroup . • Right-click on the selection and select Grouping > Ungroup from the popup menu.

Since grouping can be performed on top

Resizing Shapes in Group

In some cases, you may want to resize multiple shapes on the diagram, VP-UML allows you to resize the shapes in a group, which in turn reduces the handling time for resizing the shapes individually. When you resize one shape of the selected shapes, all the selected shapes will resize in proportion to the size of the resizing shape. To resize the shapes in a group:

3-24 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

1. Select multiple desired shapes on the diagram.

Figure 3.51 - Multiple desired shapes on diagram

2. Resize one of the selected shapes. All selected shapes will resize proportionally.

Figure 3.52 - Resize one of the selected shapes. All selected shapes will resize proportionally

Note If the size of the resizing shape returns to its original shapes before resizing, all selected shapes will not resize accordingly.

Zooming

Zooming In

The zoom in feature allows you to get a close-up view of the diagram. To perform zoom in, perform one of the following actions:

• Select View > Zoom in from main menu. • Click on the Zoom In button on toolbar. • Right-click on the target diagram and choose Zoom > Zoom In from popup menu. • Press Ctrl-= (Ctrl-Equals).

3-25 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Zooming Out

The zoom out feature allows you to see more of the diagram at a reduced size. To perform zoom out, perform one of the following actions:

• Select View > Zoom Out from main menu. • Click on the Zoom Out button on toolbar. • Right-click on the target diagram and choose Zoom > Zoom Out from popup menu. • Press Ctrl-- (Ctrl-Minus).

Zooming to 100%

The zoom to 100% feature allows you to view the diagram in its actual size (100%). To restore the zoom ratio to 100%, perform one of the following actions:

• Select View > Zoom 100% (Actual Size) from main menu. • Click on the Zoom 100% (Actual Size) button on toolbar. • Right-click on the target diagram and choose Zoom > Zoom 100% from popup menu. • Press Ctrl-0.

Zooming to a Specific Ratio

The zoom to a specific ratio feature allows you to choose the zooming ratio from the dropdown list. To perform zoom to a specific ratio, perform one of the following actions:

• Click on the Select Zoom drop down button on the toolbar, select a zoom ratio from the drop down menu or enter a specific zoom ratio to the text field.

Figure 3.53 - Select zoom ratio Figure 3.54 - Enter zoom ratio

• Right-click on the target diagram and choose Open Specification from popup menu. This displays the Diagram Specification dialog box. From the dialog box, select a zoom ratio from the Zoom ratio drop down menu, or enter the specific zoom ratio to the field. • From the property table, select a zoom ratio from the drop down menu on the row Zoom ratio , or enter the specific zoom ratio to the field.

3-26 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Zooming to Fit Diagram to Window

Beside standard zoom in/out and zoom to ratio, there are dynamic zoom options that allow you to zoom the diagram to fit its content to window. Click on the Select Zoom drop down button on the toolbar (or click on the Zoom ratio combo box in the Property pane when a diagram is active), scroll down and you will see the Page , Width and Height zoom items.

• Page - Zoom the whole diagram to fit to window • Width - Zoom the width of the diagram to fit to window • Height - Zoom the height of the diagram to fit to window

Figure 3.55 - Select zoom ratio to fit with page Just select the zoom item to apply the corresponding zoom option

Figure 3.56 - Zoom to show all the Page

Zooming to Region

The zoom to region feature allows you to zoom the diagram to any selected region.

1. To zoom a diagram to region, click on the Zoom to Region button on the toolbar.

Figure 3.57 - Zoom to region

3-27 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

2. Press the mouse on the diagram, hold and drag the desired zoom region (just like multi-select shapes). The region is indicated by the dotted-line rectangle.

Figure 3.58 - Select the zoom region in the diagram

3. Release the mouse button and you will see the diagram is zoomed to the desired region.

Figure 3.59 - Zoom to the Region

Grid

Showing/Hiding Grids

To toggle the visibility of grid lines, perform one of the following actions:

• Check/Uncheck View > Grid from main menu to show/hide grid lines. • Right-click on the target diagram, check/uncheck Grid Visible from popup menu to show/hide grid lines. • From the property table, check/uncheck Visible under Grid heading to show/hide grid lines. • Right-click on the target diagram and choose Open Specification from popup menu. This displays the Diagram Specification dialog box. From the dialog box, switch to Grid Setting tab and check/uncheck Grid Visible to show/hide grid lines.

Snap to Grid

This feature is used to set whether diagram elements should stick to grid lines when moving in the diagram. To turn the option on/off, perform one of the following actions:

• Check/Uncheck View > Snap to Grid from main menu to turn on/off the snap to grid option. • Right-click on the target diagram, check/uncheck Snap to Grid from popup menu to turn on/off the snap to grid option. • From the property table, check/uncheck Snap to Grid under Grid heading to turn on/off the snap to grid option. • Right-click on the target diagram and choose Open Specification from popup menu. This displays the Diagram Specification dialog box. From the dialog box, switch to Grid Setting tab and check/uncheck Snap to Grid to turn on/off the snap to grid option.

3-28 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Grid Size

To adjust the grid size, perform one of the following actions:

• From the property table, enter the value for Width and Height property under Grid heading. • Right-click on the target diagram and choose Open Specification from popup menu. This displays the Diagram Specification dialog box. From the dialog box, switch to Grid Setting tab and enter the value for Width and Height.

Grid Color

To adjust the grid color, perform one of the following actions:

• Right-click on the target diagram and select Grid Color... from popup menu. This displays the Select Grid Color dialog box for setting the grid color. • From the property table, click the ... button in the Value column of Color property under Grid heading. This displays a color chooser for selecting a grid color. • Right-click on the target diagram and choose Open Specification from popup menu. This displays the Diagram Specification dialog box. From the dialog box, switch to Grid Setting tab, click on the button ...from the Grid Color field and select the grid color from the drop-down color chooser.

Note

The grids must be visible before setting the grid color.

Form Diagram from Model

You can form a diagram with the selected models (classes/packages) in the Model Pane and Class Repository Pane .

1. Open/Activate the Model Pane or Class Repository Pane . 2. Select the classes and packages you would like them to appear in the new Class Diagram. 3. Right-click on the selection and select Form Diagram from popup menu. 4. Choose from one of the Form Diagram types ( Customize..., Hierarchical , or Navigation ) in the cascading menu.

Figure 3.60 - Form diagram from model

Note

Currently VP-UML allows you to form diagrams with only packages and classes.

3-29 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Customize Form Diagram Properties

If you select Customize... from the popup menu mentioned in previous section, the Form Diagram dialog box appears. Select the relationships you want to show in the new diagram in the Form Diagram tab, between the diagram elements of the selected models and their related diagram elements.

Figure 3.61 - Form Diagram Dialog A new diagram is created with the diagram elements of the selected models, the related diagram elements and the relationships between the diagram elements.

Figure 3.62 - The generated Class Diagram In this case, the class model called "Customer" is selected. The new diagram (on the right hand side) shows the relationships between the "Customer" model and other models.

Figure 3.63 - The association of the selected classes are included in the new diagram

3-30 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Presentation Options Click the Presentation Options tab on the Form Diagram dialog box to set the presentation options for the classes in the new diagram.

Figure 3.64 - The presentation options

Hierarchical Diagram

If you selected Hierarchical in the cascading menu, a new diagram is created with the diagram elements of the selected models, the parents and children of the diagram elements and the generalization relationships between the diagram elements.

Figure 3.65 - Hierarchical Diagram In this case, the class model called "Clerk" is selected. The new diagram (on the right hand side) shows the generalization relationships between the "Clerk" model and other related models.

Figure 3.66 - Show the inheritance hierarchical in the new diagram

3-31 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Navigation Diagram

If you selected Navigation in the cascading menu, a new diagram is created with the diagram elements of the selected models, the sources (non-navigable diagram elements) and targets (navigable diagram elements) of the diagram elements and the association relationships between the diagram elements.

Figure 3.67 - Navigation Diagram In this case, the class model called "Order" is selected. The new diagram (on the right hand side) shows the association relationships between the "Order" model and other related models.

Figure 3.68 - show the navigation association of the selected classes.

Compartment Visibility Control

VP-UML provides a visibility control in class diagram. It allows you to hide or show the attribute or operation using the resource-centric of a class. To show the attributes compartment or operations compartment click the "+" sign button in resource-centric. To hide the attributes or operation click the "-"sign button in resource-centric.

Figure 3.69 - Compartment Visibility Control

Note When you reverse the code into class diagram(s) the attributes and operations are visible by default. The compartment visibility control is useful when you want to hide the attributes or operations in one click (saves time to choose presentation option in the popup menu).

3-32 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Quick Previewer

VP-UML provides a quick preview for the diagrams and the shapes. It allows you to preview diagrams and their documentation.

Figure 3.70 - Quick Previewer To preview a diagram, move the mouse cursor over a Diagram node. This displays to Quick Previewer. To open the diagram, click the button on the toolbar. To resize the Quick Previewer window:

1. Move the cursor to the bottom right-hand corner of the Quick Previewer window. The cursor changes to " " , indicating that you can resize the window. 2. Press on it. 3. Drag to resize the window. 4. Releases the mouse press until you are satisfied with the size of Quick Previewer.

Apart from preview image, Quick Previewer also shows the documentation of diagrams. To display the documentation of a diagram, Click the button on the toolbar of the previewer and

Figure 3.71 - Preview documentation VP-UML records the size and position of the previewer and restores this when displaying again. To reset this record, double- click the toolbar of the previewer window.

3-33 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Fast Scroll

Fast Scroll Window allows you quickly scan through diagram by providing an instant display to a selected portion of diagram.

Figure 3.72 - Fast Scroll

To open fast scroll click the button on the bottom-right corner of the diagram. Click on the fast scroll window to select the portion of diagram to display on diagram pane. The fast scroll window will close after it has lost focus.

Fast Scroll using Middle Mouse Button

Besides using the Fast Scroll window, if you are using a 3-button mouse, you can hold down the middle mouse button and drag to quickly scroll the diagram to the desired direction. Note that the direction you drag will be opposite to the direction that the diagram scrolls. That is, if you want the diagram to scroll down, you need to drag upwards.

Sub-Diagrams

Most diagram elements in VP-UML allow sub-diagrams to be defined to facilitate the traceability across diagrams.

Creating a Sub-Diagram

To create a new sub-diagram for a diagram element, perform one of the following actions:

• Right-click on the diagram element and choose Sub Diagrams from the popup menu to expand it. A list of recommended sub-diagram types (according to the nature of the model) is shown. If the type of diagram you want to add is not one of the recommended types, select Other Diagrams to expand it. From the Sub Diagrams or Other Diagrams menu, select %SUB_DIAGRAM_TYPE% > Create %SUB_DIAGRAM_TYPE% (e.g. Sub Diagrams > Use Case Diagram > Create Use Case Diagram). • Right-click on the diagram element and choose Open Specification from popup menu. This displays the Open Specification dialog box. From the dialog box, switch to Diagram tab, click Add . A list of recommended sub- diagram types (according to the nature of the model) is shown. If the type of diagram you want to add is not one of the recommended types, select Other Diagrams to expand it. From the root menu or Other Diagrams menu, select the desired type of sub-diagram to create.

3-34 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Selecting Existing Diagrams as Sub-Diagrams

To select existing diagrams as sub-diagram:

• Right-click on the diagram element for adding sub-diagrams and chooses Sub Diagrams > Add Existing Diagram... from popup menu. • Right-click on the model element for adding sub-diagrams and chooses Open Specification... from popup menu. This displays the Open Specification dialog box for that model element. Switch to the Diagrams tab, press Add and select Existing Diagram... from popup menu.

Figure 3.73 - Add existing diagram to Sub-Diagram In both cases, the Add Sub Diagrams Dialog will be displayed.

Figure 3.74 - Select the existing diagram The Add Sub Diagrams Dialog shows all the selectable diagrams. Selectable diagrams are all diagrams in the project excluding the following:

• The parent diagram of the selected diagram element • The existing sub-diagram of the selected diagram element

Select the diagrams to add as sub-diagrams

3-35 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Viewing the List of Sub-Diagrams

To open sub-diagram from its parent diagram element:

• Right-click on the diagram element and choose Open Specification from popup menu. This displays the Open Specification dialog box. From the dialog box, switch to Diagram tab. Sub-diagrams of that diagram element are shown in the table.

Opening Sub-Diagrams

To open sub-diagram from a parent diagram element, perform one of the following actions:

• Right-click on the diagram element and choose Sub Diagrams > %SUB_DIAGRAM_TYPE% > %SUB_DIAGRAM_NAME% from popup menu. • Right-click on the diagram element and choose Open Specification from popup menu. This displays the Open Specification dialog box. From the dialog box, switch to Diagram tab, click Add and select the subject-diagram type for creating a sub-diagram. • Select the sub-diagram from resource icon of that diagram element:

Figure 3.74 - Open Sub-diagram

Removing Sub-Diagrams

To remove a sub-diagram from its parent diagram element, perform one of the following actions:

• Right-click on the diagram element and choose Open Specification from popup menu. This displays the Open Specification dialog box. From the dialog box, switch to Diagram tab. Sub-diagrams of that diagram element are shown in the table. Select the sub-diagram that you want to remove and click Remove to remove it. • Activate the Diagram Navigator , expand the tree node of that diagram element, select the sub-diagrams that you want to remove and then right-click of them and select Detach from Parent from popup menu.

Figure 3.75 - Remove Sub-Diagram

3-36 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Navigating to the Parent Element of a Sub-Diagram

The diagram title bar of a sub-diagram will have the name of the parent element preceding the diagram name. Click on the name of the parent element and this element will be selected.

Figure 3.76 - Navigating to the Parent Element

References

References here refer to resources include files and URLs that you want to associated with a model. After you have added the references, you can open them in the tool with the default application/web browser whenever you need them.

Adding Referenced File

To add a referenced file using the open specification dialog box:

1. Open the open specification dialog box of the model, select the References page. 2. Click the Add File... button, or right-click on the table and select Add File... from the popup menu.

Figure 3.77 - Add Reference Files

To add a referenced file using the "References" resource:

1. Mouse over a shape, its resources are shown. Click on the References resource (located at the lower left corner of the shape, with a shortcut arrow icon).

Figure 3.78 - Edit reference resource-centric

3-37 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

2. Select Add File... in the popup menu.

Figure 3.79 - Select Add File in the popup menu Using either method, the reference details pane will be shown. Specify the file path in Path or browse by clicking the ... button. You may optionally provide a description for the reference in Description .

Figure 3.80 - Edit Reference

Adding Referenced URL

To add a referenced URL using the open specification dialog box:

1. Open the open specification dialog box of the model, select the References page. 2. Click the Add URL... button, or right-click on the table and select Add URL... from the popup menu.

Figure 3.81 - Add URL References

To add a referenced URL using the "References" resource:

1. Mouse over a shape, its resources are shown. Click on the References resource (located at the lower left corner of the shape, with a shortcut arrow icon).

Figure 3.82 - Click on Edit Reference Resource-Centric

3-38 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

2. Select Add URL... in the popup menu.

Figure 3.83 - Add URL in popup menu

Using either method, the reference details pane will be shown. Specify the URL path in Path and you may optionally provide a description for the reference in Description .

Figure 3.84 - Edit the URL and description

Editing References

To edit references:

1. Open the open specification dialog box of the model, select the References page. Alternatively click on the References resource of a shape and select Edit References from the popup menu.

Figure 3.85 - Open edit reference dialog

2. Right-click on a reference and select Edit from the popup menu.

Figure 3.86 - Edit reference by click on popup menu

3. Alternatively, click the Details button to show the details pane if it is not already showing.

Figure 3.87 - Show reference details

3-39 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

4. Using either method, the reference details pane will be shown. Then you can edit the path and description of the selected reference.

Figure 3.88 - The reference details

Reordering References

To reorder references:

1. Open the open specification dialog box of the model, select the References page. 2. Select one or more references in the table. 3. Click on the Move up /Move down button to move the selection upwards/downwards. Alternatively right-click on the selection and select Move Up /Move Down from the popup menu.

Figure 3.89 - Re-ordering reference

Opening References

To open references:

1. Open the open specification dialog box of the model, select the References page. 2. Select one or more references in the table. 3. Click on the Open... button, or press the Enter key, or right-click on the selection and select Open... from the popup menu.

Figure 3.90 - Press Open button to open the selected references.

4. Alternatively, click on the References resource of a shape and select a reference from the popup menu.

Figure 3.91 - Open reference by click on popup menu

5. The selected references will be opened by the default applications or web browser.

3-40 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Removing References

To remove references:

1. Open the open specification dialog box of the model, select the References page. 2. Select the unwanted references in the table. Click the Remove button, or press the Delete key, or right-click on the selection and select Remove from the popup menu.

Figure 3.92 - Remove reference

User Path

A user path is a variable that refers to a base path in user's computer. You can add a reference to local file using user path so that the reference refers to a file relative to a user path, instead of an absolute path. This means you can move references files to a different location, or even to a different computer, and can still open them as long as the user path value is up-to-date.

Configuring User Paths To configure user paths, select menu Tools > Options... . Select the User Path category in the Options dialog box.

Figure 3.93 - Configure User Paths

• To add a user path, click Add... , and then enter the name and path in the Add User Path dialog box.

Figure 3.94 - Add User Path

• To edit a user path, select it in the table and click Edit... , and then edit the name and path in the Edit User Path dialog box. • To remove user paths, select unwanted user paths in the table and click Remove . • Show user path - Select to show user paths in references, instead of displaying resolved absolute paths. A user path is displayed with its name enclosed by ${ }.

Figure 3.95 - Using User Path in the references

3-41 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

• Prompt to specify user path - Select to enable prompt for user path after adding a reference to file whose base path is not defined as a user path.

Figure 3.100 - Specify user path

Logical View

The Logical View refers to a user's view of the way project is organized. It provides another view of creating, structuring and sharing the UML diagrams and models apart from the traditional Diagram Navigator, Model Tree View and Class Repository.

Figure 3.103 - Logic View Pane

Creating a Logical View

To create a view:

1. Right-click on the project node, top-most node, of the Logical View pane and choose Add View from popup menu. This creates a new View under the project node. 2. Right-click on the new view and choose Rename... from the popup menu to provide a name for the view. 3. Enter the name in the displayed input box and click OK to confirm the changes.

Creating Diagram(s) under View

To create diagram under a view, right-click on the view that hold the new diagram and choose Create Diagram > Create %DIAGRAM_TYPE% from popup menu. This creates a blank diagram of the selected type under the chosen view.

Moving Diagram(s) between Views

To move diagram from one view to another, simply drag on it and drop it to the target view. The diagram will therefore transfer from original view to target view.

Exporting and Importing View

You can export the current Logical View structure as an XML file and apply it over and again on other projects. There are two options for importing a Logical View structure. Append to existing structure The imported structure will append to the current structure, no modification will be made on the existing one.

Replace existing structure The imported structure will replace the current structure therefore predefined structure will be removed. For any diagram in the current project that have the same name as any of the diagram name in the XML file, the diagram name will display in the Logical View of the current project. Otherwise the name will not be shown in the imported structure.

3-42 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Modeler

Modeler is a generic diagramming environment providing plenty of shapes apart from ordinary UML notations. You can create UML diagrams with the shapes from the stencils in VP-UML. Although the original UML notations are rich, but still may not expressive enough to present your idea. Stencils in VP-UML provide a large variety of shapes apart from the ordinary shapes, and can be used in the UML diagram.

Stencil

A stencil is a collection of shapes associated with a particular drawing type. Stencils are stored under Stencil Pane which displays all the available stencils in tabbed pages.

Figure 3.104 - Stencil Stencil in VP-UML allow displaying shapes imported from Microsoft Visio, and you can use those shapes repeatedly in any UML diagrams by dragging a shape from stencil from drawing pane.

Installing Visio Send to VP Plugin

To import shapes from Visio to VP-UML, you need to first install "Visio Send to VP Plugin" which is bundled with VP-Suite and then send Visio shapes to VP-UML by using the plugin. To install the plugin:

1. Run the installer by either selecting Tools > Visio Integration... from the menu bar in VP-UML , or double-click the file %VP-SUITE_HOME%/bundled/VisioSendToVP.msi . This displays the Visio Send to VP Setup Wizard which guides you through the installation process.

Figure 3.105 - Installing Visio Send to VP Plugin

3-43 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

2. Click Next to start the installation. 3. Locate the installation folder for the plugin and click Next . 4. Confirm the installation and then click Next . This starts the file copying process. 5. Once the installation is complete click Close .

Sending Shape from Visio to VP-UML

You can send shapes from Visio to VP-UML by sending either all shapes within the active Visio drawing pane or only the selected shapes.

Sending All Shapes to VP-UML

1. Drop shape(s) onto the Visio drawing pane for sending to VP-UML. 2. Select Tools > VP > Send All Shapes to VP from menu bar.

Figure 3.106 - Send selected shapes to VP

3. A progress bar displays showing the progress of sending process. 4. After all the shapes have been sent to VP-UML, a dialog displays and lists the shapes that have been sent. Click OK to confirm it.

Figure 3.107 - Confirm send shapes to VP

3-44 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Sending Selected Shapes to VP-UML

1. Select shapes from Visio drawing pane to send to VP-UML.

Figure 3.108 - Select shapes in Visio

2. Select Tool > VP > Send Selected Shapes to VP form menu bar. 3. A progress bar displays showing the progress of sending process. 4. After all the selected shapes have been sent to VP-UML, a dialog displays and lists the shapes that have been sent. Click OK to confirm it.

Importing a Stencil

To add shapes sent from Visio to VP-UML:

1. Activate the Stencil Pane . 2. Click the button on the Stencil Pane. This display the Import Stencil Dialog . Select the stencil for importing, enter a name for the stencil, assign a diagram type for holding the stencil and click OK .

Figure 3.109 - Import Stencil Dialog

Field Description Shapes The shapes imported from Visio are grouped into a stencil. Click on a stencil to take a look at the Import shapes for that stencil from Preview panel. from Click on the drop-down menu and choose a diagram type for holding the stencil. To create a new Shapes diagram type, choose Create new diagram type . You will be prompted to enter a name and a import to description of that diagram type. Enter the information and click OK to confirm. Name Provide a name for the stencil.

Table 3.8

3-45 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

3. The stencil pane displays the imported stencil with all the available shapes associated with that stencil.

Figure 3.110 - The shapes is imported to stencil

Opening a Stencil

To open a stencil, click the button on the Stencil Pane, and then select a desired one from the drop-down menu.

Creating Shape from Stencil

You can move a shape from the stencil onto your UML drawing by drag-n-drop. To drag-and-drop to create shape:

1. Move the cursor to a desired shape in the stencil. 2. Press on it. 3. Drag it out of the stencil pane. 4. Drop it onto the diagram pane.

From now on, you can treat the shape as a usual

Figure 3.11 - Create shape from stencil

Note An alternative way to create shape from stencil is by clicking on a shape inside the stencil for placing on the diagram and click on the diagram to create the selected shape.

Closing a Stencil

To close an opened stencil, right-click on the title bar of the stencil you want to close and choose Close from popup menu.

3-46 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Exporting Diagram as Images

Exporting the Active Diagram as an Image

This feature is to export the active diagram as image file. To export the active diagram as image file, perform one of the following actions:

• Select File > Export > Active Diagram as Image... from main menu. • Click on the Export Active Diagram as Image button on the toolbar.

In both cases, a file chooser dialog box will appear where you can specify

Exporting Diagrams as Images

This feature is to export one or more diagrams as images. To export the active diagram as image file, perform one of the following actions:

• Select File > Export > Diagrams as Image... from main menu. • Click on the Export Diagram as Image button on the toolbar.

In both cases, the Diagram Exporter dialog box will be displayed. You

Figure 3.112 - Diagram exporter

Field Description Output The Output destination is the directory where all the exported images are saved to. You can enter the path in destination the text field directly, or you can click on the ... button to browse for the directory. To select the image format of the exported image click on the pull-down box beside the Export type field and Export type select the format you want to use. The Diagrams pane shows the diagrams in the current project. Check the checkbox beside the diagram that Diagrams you want to export. The number of selected diagrams is displayed at the bottom of the Diagram pane. Besides, the Preview pane allows you to preview the exported image of the selected diagram.

3-47 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

The Preview pane shows the preview of the exported image of the selected diagram in the Diagrams pane. You can check/uncheck the Show preview checkbox to enable/disable the preview. Preview You can 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. 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 Anti-aliasing Graphics checkbox in the Antialiasing pane. Likewise, you can check the Text checkbox in the Antialiasing pane to apply anti-aliasing to text. Auto overwrite You can check the Auto overwrite existing files checkbox to allow overwrite of files in the export process. existing files Maximum size of exported images. If the diagram size is larger than max. size, it will be resized to smaller Max. Size than max. size.

Table 3.9

Slice diagrams User can slice a large diagram into pieces(number of files), as well as to restrict the size of the exported diagram.

Figure 3.113 - Slice diagrams There are three slicing strategies. They are Fixed Slice , Free Slicing and Fixed Ratio . Slicing Description strategies Fixed Slice is a simple strategy which slice exported diagram into pieces that have the same size. User specifies Fixed Slice the number of columns and rows to slice and then the exported diagram will be sliced into specific pieces. Free User can customize how to slice the exported diagram by specifying the position of vertical slices and horizontal Slicing slices. It is particularly useful to prevent a shape from being sliced into pieces. Fixed Ratio strategy gain 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 Fixed Ratio Ratio is size oriented. User modifies the size of pieces and Diagram Slicer calculates the number of row and column to slice.

Table 3.10

Mouse Gesture

Mouse gestures allow you to execute common commands and create UML models within the diagrams. The following is the 11 basic gestures supported by VP-UML: Gestures Description Gestures Descriptions

Down V Right Down V Left

3-48 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Clock-wise Rectangle* Counter Clock-wise Rectangle*

Folder Shape* Right V Left#

Down V Up# Right V Left V Right V Down V Left V Up*#

Left V Down V Right V Down V Left (squarish S) Right V Down V Left V Up - Right

Left V Down V Right V Up - Left

Table 3.11 The node is the start point of each gesture * Start at any point # Bi-directional To use mouse gestures, simply hold down the right mouse button and move the mouse to form the gesture (a blue path will be shown indicating your gesture). When you release the button, the gesture command will be execute. A full list of gesture command can be found in the Appendix C .

Figure 3.114 - Mouse Gesture Example

Gesture Start Point and Direction

For the gestures marked as "Start at Any Point" like the Clock-wise Rectangle, start from any corner will give you the same result. And for the gestures marked as "Bi-directional" like "Right-Left" , start from right or left will also give you the same results.

= = =

=

Figure 3.115 - Gesture Start Point and Direction

3-49 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Initial State and Final State

The initial state and final state are using the same gestures. The gesture will create an initial state if initial state is not exist in the diagram, and a final state will be created if there is an initial state but no final state. If the diagram has both initial state and final state, the gesture will do nothing

Connecting Shapes using Mouse Gesture

Right-click on a shape and then drag over another shape, release the mouse until you see the blue gesture path drawn between them. A connector will be created between the shapes, whose turning points are determined by the gesture path you dragged.

Figure 3.116 - Create association If you drag the mouse gesture from a shape but release it over empty space of the diagram, a popup menu will appear for you to select a connector-shape pair. After selected a pair, a new shape together with a new connector of the selected types are created.

Figure 3.117 - Create Use Case with Association

Creating Class Members using Mouse Gesture

Creating Attribute Right-click on a class, drag to the left and release the mouse until you see the blue gesture line, an attribute will be created.

Figure 3.118 - Create attribute Note that if you release the mouse OUTSIDE the class, the created attribute will be stereotyped as Property, and with its Setter and Getter properties automatically set to true.

Figure 3.119 - Attribute created with getter and setter

3-50 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

Creating Operation Right-click on a class, drag to the right and release the mouse until you see the blue gesture line, an operation will be created.

Figure 3.120 - Create operation

Note that if you release the mouse INSIDE the class, the created operation will have its visibility set to protected instead of public.

3-51 VP-UML User’s Guide (Part 1) Chapter 3 – Working with Diagrams

3-52

4 Generating Documentation VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Chapter 4 - Generating Documentation

VP-UML provides several report generation facilities for documenting the project. Report Writer streamlines your work by keeping the project and document in sync. HTML/PDF report generation facility outputs project as web pages and PDF document portable to different platform and environment. Word report generation outputs report in MS Word format. Sophisticated printing facility enable printing UML diagrams as hard copy which increase the ease of reading and understanding. Project Publisher exports the project into interactive web pages that can be read in any web browsers with no additional plug-in required. In this chapter:

• Ad-hoc Report Generation • PDF Report Generation • HTML Report Generation • Word Report Generation • Printing facility • Project Publisher

Report Writer

The Report Writer is a sophisticated tool for report creation. Users can output the existing project as reports by documenting their project within VP-UML. VP-UML offers seamless integration of UML modeling tool with word processor to provide a unified documenting environment. By dragging the models from VP-UML to Report Writer, data is extracted from models and content is created in Report Writer. Retaining the conformance between documentation and design is a tedious task. Report Writer maintains the consistency between them. If you create a new model, the content will be appended to the existing one. If you remove a model, the generated element will be removed. If you re-edit the models, the content will be refreshed. Users can also apply their own style for the generated element, which make the Report Writer more flexible.

Launching Report Writer

To launch Report Writer, perform one of the following actions:

• Select Tools > Report > Report Writer... from main menu. • Click on the Report Writer button on the toolbar.

Installing Report Engine If it is the first time you start the Report Writer, the Report Engine Installation dialog box will be displayed asking for the installation of Report Engine.

Figure 4.1 - Report Engine Installation Dialog

4-2 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

To install Report Engine, perform one of the following actions:

• Choose from the Report Engine Installation dialog box the option Download from Internet and click OK . This downloads the Report Engine from the Internet and automatically proceeds with Report Engine installation once the download has been completed. • Choose from the Report Engine Installation dialog box the option Select in local file system , locate the report engine and then click OK to start the Report Engine installation. The Report Engine can be obtained by clicking Download with browser . You can enter the path directly on the text field or click ... to locate the file from file chooser.

Entering Report Information If this is the first time to launch Report Writer, the Template dialog box will be displayed and ask for the information of the new report. Enter the report information and select a desired report theme for the report, preview of the selected theme is shown on the preview pane. Click OK to start Report Writer when everything is ready.

Figure 4.2 - Templates Dialog

Panes

When Report Writer is launched you are taken to the Report Writer environment where you can create and edit your reports. Three distinct panes are presented on the screen: the Project Explorer , Template Pane and the Writer Pane .

Figure 4.3 - Report Writer

Diagram Navigator

4-3 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

The Diagram Navigator displays all diagrams within the project in a form of a project tree and organizes them by their diagram type. Through the use of a folding tree structure you can browse the names of these diagrams by either expanding or collapsing the folders and perform sorting by diagram type and name.

Figure 4.4 - Diagram Navigator

Button Icon Description

Collapse To collapse all the nodes within the project tree. Expand To expand all the nodes within the project tree. Show Diagram View To show only diagrams but not models in the tree. Sort by Name To sort diagrams within the project tree by alphabetical order of their names Sort by Type To sort diagrams within the project tree by their diagram type. Move Selected Model Up To move selected models upwards.

Move Selected Model Down To move selected models downwards.

Refresh To refresh the project tree within the Diagram Pane. Table 4.1

Model Tree The Model Pane displays models within the project in a form of a project tree. Notice that not all the diagram elements are displayed. In fact, only the elements that are available for generating report content are shown.

Figure 4.5 - Model Tree

Button Icon Description

Collapse To collapse all the nodes within the project tree. Expand To expand all the nodes within the project tree. No Sorting To display the models within the project without sorting. Ordering of models will be based on

4-4 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

their order of creation.

Sort by Name To sort models within the project tree by alphabetical order of their names Sort by Type To sort models within the project tree by their model type. Move Selected Model To move the selected models upwards. Up Move Selected Model To move the selected models downwards. Down

Refresh To refresh the project tree within the Model Pane. Table 4.2

Template Pane The Template Pane display all the templates available for the model or diagram selected in Property Pane .

Figure 4.6 - Property Pane

Each template represents the corresponding report content of a particular model or diagram. By dragging a template onto Writer Pane , report content will be printed on the report. There are three types of template: Text , Image and Table . Each of them has its own appearance in the report content. Type Icon Description The generated element block is mainly composed of text. It is mainly used in the documentation template of Text elements. The generated element block is mainly composed of image. Recently it is used in the diagram template for UML Image Diagram. The generated element block is mainly composed of table. Most of the content-related templates are using this Table type of template. Table 4.3

4-5 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Writer Pane Writer Pane embeds a word processor to provide a report editing environment.

Figure 4.7 - Writer Pane

Toolbar

Toolbar is the horizontal bars placed below the menu bar. They store all the frequently used commands that appear as a row of buttons. Icon Button Function

New Report... To create a new report. Save Report To save modified reports. To import an external document (either an .sxw or a .doc file) Import Report... as a report.

Export Report... To export the current report as an .sxw or .doc file. Export All Reports... To export all the reports within the current project. To update the content within the current report from the VP- Update from Model UML models.

Print Report... To print the current report by supplying the printer name. Undo To undo the last action you performed. Redo To redo the last action you performed.

Select Report To select a report from the current project for editing.

Remove Report... To remove the existing report(s). Click to Show Stylist To display the stylist dialog box for modifying the style. Copy Style to Current Report To copy the style settings defined in another report.

4-6 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

To display bookmarks that outlines the boundary for each Click to Show Bookmarks generated element.

Insert Hyperlink To insert a hyperlink. Click to Generate Model To include documentation of model when generating Documentation content.

Close Report Dialog To close Report Writer and go back to VP-UML. Table 4.4

Constructing a Report

Creating a Generated Element The term "Generated element" here means a block of report content generated by Report Writer and consists of details of a particular diagram or model element. To create a generated element block:

1. Click to select the desired model element from either the Diagram Navigator or Mode Tree for content generation. 2. The supported templates for the selected model element are shown on the Template Pane . Each template represents a way in presenting the selected model element on the report. For example, "Children" template of a System represents a list of children placed inside a particular System.

Figure 4.8 - Template Pane

3. Drag the desired template from the Template Pane and drop it onto the report.

Figure 4.9 - Drag the template from template pane and drop it onto report

4. When the cursor drags over the Writer Pane , a tiny straight line
will appear in the report indicating the position of the expected position of the generated element. Once you've dropped the template onto the report, corresponding content will be generated element to the dropped position.

Figure 4.10 - Drag the template to report

4-7 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Note The update process will replace ALL the contents within each generated element without notification. Therefore please insert the content wisely and to ensure that it is not located inside the scope of any generated elements. Note To create a new report, select from main menu Report > New Report...or click on the New Report...button on the toolbar.

Showing the Bookmarks Creating a new generated element within the boundary of an existing one is dangerous because it might have chance that content will be messed up during a report update process. To avoid this, you can display bookmarks to indicate the start and end position of each generated element, and to prevent dropping a new one within the scope of the existing generated element.

Figure 4.11 - Showing bookmarks To show/hide bookmarks:

• Check/Uncheck Tool > Show Indicator from main menu to show/hide bookmarks. • Select/Deselect Click to Show Bookmarks /Click to Hide Bookmark on the toolbar to show/hide bookmarks.

Applying Style to Report

A style in Report Writer is a collection of formatting attributes that describe the nature of paragraphs. The generated element highly adopts the predefined styles in Report Writer therefore users can customize the related styles to bring consistency to the whole document. There are two ways for applying style to report.

Style configuration The Stylist dialog box allows you to configure the pre-defined styles. To display the Stylist dialog box:

• Select Tool > Show Stylist from main menu. • Click the Click to Show Stylist button on the toolbar.

In both cases, the Stylist dialog box display.

Figure 4.12 - Stylist

4-8 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

To edit the style, right-click on the highlighted style and choose Modify... from popup menu. This displays the dialog box for the selected style. You can now adjust it with your own preference. When everything is ready, please click OK to commit the settings and exit the dialog.

Figure 4.13 - Edit Paragraph Style The changes will take effect immediately and you will notice the style is applied to those generated elements using the same style.

Figure 4.14 - Style Change

Loading Style from Other Report The Copy Style dialog box allows you to copy the style from existing report. To display the Copy Style dialog box:

• Select Tool > Copy Style from main menu. • Click the Copy Style to Current Report button on the toolbar.

In both cases, the Stylist dialog box display.

Figure 4.15 - Copy Style Dialog

Select a desired report for getting the style configuration and click Copy Style . The style configuration in the current report is replaced by the style configuration of the selected report. All the predefined styles will be overwritten.

4-9 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Updating Table of Contents

There is a predefined Table of Contents in each of the report template. Here is the pre-built Table of Contents structure: Level Paragraph Style 0 Heading 1 (VP) 1 Heading 2 (VP) 2 Heading 3 (VP) 3 - 9 None

Table 4.5 To update the Table of Contents, right-click on the caption Table of Contents and select Update Index/Table from popup menu.

Exporting a report

You can export report as file and edit it outside VP-UML. Supported format includes Microsoft Word 97/2000/XP document (with extension .doc) and OpenOffice.org 1.0 Text Document (with extension .sxw).

Exporting current report

1. Click on the Export Report... button on the toolbar or select Report > Export Report... from main menu. This display the Save dialog box. 2. In the Save dialog box, enter the file name and select OpenOffice.org 1.0 Text Document (.sxw) format or Microsoft Word 97/2000/XP (.doc) format for exporting. 3. When everything is ready, click Save to export the report.

Exporting all report(s)

1. Click the Export All Reports... button on the toolbar or select Report > Export All Reports... from main menu. This display the Save dialog box. 2. In the Save dialog box, enter the directory for storing the reports in the File name field and select either OpenOffice.org 1.0 Documents or Microsoft Word Documents for the Document Type . 3. When everything is ready, click Save to export the report(s).

Importing a Report

You can import a document back into Report Writer for data updating. To import a report:

1. Click the Import Report... button on the toolbar or select Report > Import Report... from main menu. This displays the Open dialog box. 2. In the Open dialog box, select either OpenOffice.org 1.0 Text Document (.sxw) format or Microsoft Word 97/2000XP (.doc) format for importing. Select a file and click Open to import the selected document into Report Writer. 3. If the document is exported from Report Writer previously, a dialog will appear and ask for overwriting the existing one or not.

Figure 4.16 - Confirm overwrite existing report If you click Yes , the existing report will be replaced by the imported one. If you click No , the imported report will be stored into Report

4-10 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Updating a Report

In reality, software design keeps on changing from time to time. Originally, users need to modify the related documents manually to ensure that it is fully conform to the latest design. Report Writer binds closely with the VP-UML project, hence generated element can then be updated without affecting the user-defined content. To update a report, choose the desired report for updating from the drop-down menu and click the Update from Model button from the toolbar or select Report > Update from Model from main menu. Update process will start automatically. Data will be extracted from project and replace with the content within the existing generated element.

Note Please do not click on the Writer Pane while update process is undergoing. Otherwise it may affect the accuracy of content. The worse case is damaging the generated element, updating cannot perform anymore unless you remove the damaged block manually. Note The update process will replace ALL the contents within each generated element without notification. Therefore please insert your content wisely and to ensure that it is not located inside the scope of any generated element.

Printing a report

There are two ways for printing the reports. The first one is to print the currently opened report and another one is to print all the reports within the project. The following steps demonstrate how you can print reports in Report Writer.

1. Click the Print Report... button on the toolbar or select Report > Print Report... from main menu. This displays the Print dialog box asking for the printer name. 2. Select the printer for printing the document from the drop down menu. 3. To print the currently opened report, click Print Current... To print all reports, click Print All...

Note

Do not click on the Writer Pane while printing process is undergoing. Otherwise it may affect the print job.

4-11 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

PDF Report Generation

The Generate PDF Dialog Box

The Generate PDF dialog box provides a set of options for changing the report style. To display the dialog box, perform one of the following actions:

• Select Tools > Report > Generate PDF Report... from main menu. • Click on the Generate PDF Report button on the toolbar.

In both cases, the Generate PDF dialog box will be displayed.

Figure 4.17 - Generate PDF Dialog

Field Description To select the destination directory for the generated report. You can type the path in the text field File location or you can browse the location by clicking on the ...button. If this option is selected, the default browser of the system will be opened automatically to show Launch viewer the generated document. Generate table of contents If this options is selected, table of content for this document will be generated to the report Generate table of figures If this options is selected, table of figures for this document will be generated to the report Generate diagrams If this option is selected, the image of the selected diagrams will be generated to the report. Generate reference Select to generate links for referenced files/URLs defined in models. (file/URL) link Generate models/diagrams Select to generate links for navigating to related models and diagrams. link Icon - using Icon to represent the type of shape and diagram elements Shape type style Text - using text to represent the type of shape and diagram elements Details Children Select to generate children of model Members Select to generate members of model Properties Select to generate properties of model Relationships Select to generate relationships of model References Select to generate references of model Sub-diagrams Select to generate sub-diagrams of model Tagged values Select to generates tagged values of model Comments Select to generates comments of model

4-12 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Anti-aliasing Graphics To enable/disable the graphic anti-aliasing of the diagram images. Text To enable/disable the text anti-aliasing of the diagram images.

Table 4.6

Generating a PDF Report

To generate a PDF Report:

1. Open the Generate PDF dialog box. 2. Enter the destination location of the generated document in the File location field. 3. Select the report options, such as Generate diagrams , Generate reference (file/URL) link , etc...if necessary. 4. Select the details field such as Children, Members . 5. Define the page settings for the report. 6. Define advanced report information such as Header/Footer and Document Info if necessary. 7. Select the diagrams to generate in the report. 8. Click Generate to start generating the report.

Figure 4.18 - PDF Report

Figure 4.19 - The Generated PDF Report

4-13 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Defining Image Quality

There are two image quality options for the PDF Report: Anti-aliasing for Graphic and Text . Since the dimension of the paper limits the size of the image in the PDF report, VP-UML provides an extra image quality option in the PDF report to control how the output image will be scaled in the report. To change the diagram quality option, select the Anti-aliasing option.

Figure 4.20 - Define image quality

Defining the page information

This option allows the user to define the page settings, such as the paper size and orientation of the report. To configure the page settings:

1. Open the Generate PDF Report dialog box. 2. Select the Page tab .

Figure 4.21 - Page setup

Field Description Page size To select the paper size of the generated report. Page Orientation This option is use to select the orientation of the report (portrait/landscape). Page Margin To specify the page margins of the report.

Table 4.7 Selecting the Page size VP-UML supports a wide range of page sizes for PDF report generation. Different paper sizes can be selected in the Page size drop-down menu.

Figure 4.22 - Select the Page Size

4-14 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Selecting the Page Orientation To select the page orientation for the output report, select the desired orientation option in the Page Orientation section.

Figure 4.23 - Select the Page Orientation Adjusting the Page Margins To adjust the page margins enter the value in the text box at the margin side you want to adjust, or drag the margin in the preview page.

Figure 4.24 - Adjust the page margin

Defining a Cover Page To define the Cover Page

1. Open the Generate PDF Report dialog box. 2. Select the Cover Page tab. 3. Check the Generate Cover Page checkbox to include Cover Page in the report. 4. Enter information such as Logo image path for the background, Report Title , Organization name and Author Name .

Figure 4.25 - Adjust the page margin

4-15 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Defining a Header/Footer To define the Header/Footer of the document:

1. Open the Generate PDF Report dialog box. 2. Select the Header/Footer tab. 3. Insert text or picture in header or footer section to include header/footer in the report.

Figure 4.26 - Define a Header/Footer

Table 4.8 Three sections, Left Section, Center Section and Right Section, was predefined for user to insert text, or even pictures, page number, time, etc to the report Header and Footer. Separator can be added to the report in order to separate the region between Header, Content and Footer.

Defining the Header/Footer Style VP-UML supports four types of header/footer style for the PDF report. They are described in the table below: Header/Footer Style Description

To format text style, such as font style, size and color.

To insert an image to the header or footer

Insert page number

Insert page count

Insert date

Insert time

Insert project name

Insert report file name

Insert user name

Table 4.9

4-16 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Defining Document Info To define the document info:

1. Open the Generate PDF dialog box. 2. Select the Document Info page.

Figure 4.27 - Define Document Info

Field Description Title The title of the report. Author The author of the report. Subject The subject of the report. Keywords The keywords of the report. Info header The info header of the report. Info header content The info header content of the report. Allow modify Select to allow modification on the report.

Table 4.10

Figure 4.28 - The generated PDF Document Info

4-17 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

HTML Report Generation

Figure 4.29 - HTML Report

The Generate HTML Dialog Box

The Generate HTML dialog box provides a set of options for changing the report style. To display the dialog box, perform one of the following actions:

• Select Tools > Report > Generate HTML Report... from main menu. • Click on the Generate HTML Report button on the toolbar.

In both cases, the Generate HTML dialog box will be displayed.

Figure 4.30 - Generate HTML dialog

Field Description To select the destination directory for the generated report. You can type in the path in the text File location field or you can browse the location by clicking on the ...button. If this option is selected, the default browser of the system will be open automatically to show the Launch viewer generated report.

4-18 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Generate table of contents If this options is selected, table of contents for this document will be generated to the report. Generate table of figures If this options is selected, table of figures for this document will be generated to the report. Generate diagrams If this option is selected, the image of the selected diagrams will be generated to the report. Generate reference (file/URL) link Select to generate links for referenced files/URLs defined in models. Generate models/diagrams link Select to generate links for navigating to related models and diagrams. Copy reference files Select to copy referenced files defined in models to the report output directory.

Icon - using Icon to represent the type of shape and diagram elements Shape type style Text - using text to represent the type of shape and diagram elements Details

Children Select to generate children of model.

Members Select to generate members of model.

Properties Select to generate properties of model.

Relationships Select to generate relationships of model.

References Select to generate references of model.

Sub-diagrams Select to generate sub-diagrams of model.

Tagged values Select to generates tagged values of model.

Comments Select to generates comments of model. Anti-aliasing Graphics To enable/disable the graphic anti-aliasing of the diagram images. Text To enable/disable the text anti-aliasing of the diagram images. Print Diagrams To select which diagram will be generated in the report.

Table 4.10

Generating an HTML Report

To generate an HTML Report:

1. Open the Generate HTML dialog box. 2. Specify the destination location of the report in the File location field. 3. Configure the report properties, such as Generate diagrams , Generate reference (file/URL) link , etc...if necessary. 4. Select the template of the report that will be generated. 5. Select the diagram's image quality if Generate diagrams is selected. 6. Define advanced report information such as Front Page and Document Info if necessary. 7. Select the diagram to generate in the report. 8. Click Generate to start generating the report.

Figure 4.31 - Generating HTML report Figure 4.32 - The generated HTML report

4-19 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Defining Image Quality

There are two image quality options for the HTML Report: graphics and text anti-aliasing. To enable/disable the anti-aliasing options, check/uncheck the anti-aliasing options checkbox. The below two images show the difference in graphics with anti- aliasing enabled (left) and graphics with anti-aliasing disabled (right).

Figure 4.33 - Images with anti-aliasing Figure 4.34 - Images without anti-aliasing

Defining the Document Info

To define the document info:

1. Open the Generate HTML dialog. 2. Select the Document Info tab.

Figure 4.35 - Set the Document Info

Field Description Title Specify the title of the HTML report. Author Specify the author of the HTML report. Keywords Specify the keywords meta-tag of the HTML report.

Table 4.12

Command Line HTML Report Generation VP-UML has a command-line interface to let you to generate HTML reports for your projects. To run the command line to generate HTML report, type the following: cd /bin ../jre/bin/java -Xms128m -Xmx512m -cp ".;../lib/vpplatform.jar;../lib/jniwrap.jar;../lib/winpack.jar" RV -noui -project -todir generatehtml

Using script file VP-UML has provided the batch file and shell script for you to generate the report in command line.

For Microsoft® Windows users: cd HTMLDocGenerator.bat

4-20 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

For Linux users: cd ./HTMLDocGenerator.sh

Command Line PDF Report Generation VP-UML has a command-line interface to let you to generate PDF reports for your projects. To run the command line to generate PDF report, type the following: cd /bin ..\jre\bin\java -Xms128m -Xmx512m -cp ".;..\lib\vpplatform.jar;..\lib\jniwrap.jar;..\lib\winpack.jar" RV -noui -project -todir generatepdf

Using script file VP-UML has provided the batch file and shell script for you to generate the report in command line.

For Microsoft® Windows users: cd \bin PDFDocGenerator.bat

For Linux users: cd /bin ./ PDFDocGenerator.sh

Word Report Generation

The Generate Word Dialog Box

The Generate Word dialog box provides a set of options for changing the report style. To display the dialog box, perform one of the following actions:

• Select Tools > Report > Generate Word Report... from main menu. • Click on the Generate Word Report button on the toolbar.

4-21 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

In both cases, the Generate Word dialog box will be displayed.

Figure 4.36 - Generate Word Dialog

Field Description To select the destination path for the generated report. You can type the path in the text field or File location you can browse the location by clicking on the ...button. If this option is selected, the default application of the system will be opened automatically to Launch viewer show the generated document. Generate table of contents If this options is selected, table of content for this document will be generated to the report Generate table of figures If this options is selected, table of figures for this document will be generated to the report Generate diagrams If this option is selected, the image of the selected diagrams will be generated to the report. Generate reference Select to generate links for referenced files/URLs defined in models. (file/URL) link Generate models/diagrams Select to generate links for navigating to related models and diagrams. link Icon - using Icon to represent the type of shape and diagram elements Shape type style Text - using text to represent the type of shape and diagram elements Details Children Select to generate children of model. Members Select to generate members of model. Properties Select to generate properties of model. Relationships Select to generate relationships of model. References Select to generate references of model. Sub-diagrams Select to generate sub-diagrams of model. Tagged values Select to generates tagged values of model. Comments Select to generates comments of model. Anti-aliasing Graphics To enable/disable the graphic anti-aliasing of the diagram images. Text To enable/disable the text anti-aliasing of the diagram images.

Table 4.13

4-22 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Generating a Word Report

To generate a Word Report:

1. Open the Generate Word dialog box. 2. Enter the destination location of the generated document in the File location field. 3. Select the report options, such as Generate diagrams , Generate reference (file/URL) link , etc...if necessary. 4. Select the details field such as Children, Members . 5. Define the page settings for the report. 6. Define advanced report information such as Header/Footer and Document Info if necessary. 7. Select the diagrams to generate in the report. 8. Click Generate to start generating the report.

Figure 4.37 - Word Report

Figure 4.38 - The Generated Word Report

4-23 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Defining Image Quality

There are two image quality options for the Word Report: Anti-aliasing for Graphic and Text . Since the dimension of the paper limits the size of the image in the Word report, VP-UML provides an extra image quality option in the Word report to control how the output image will be scaled in the report. To change the diagram quality option, select the Anti-aliasing option.

Figure 4.39 - Define image quality

Defining the page information

This option allows the user to define the page settings, such as the paper size and orientation of the report. To configure the page settings:

1. Open the Generate Word Report dialog box. 2. Select the Page tab .

Figure 4.40 - Page setup

Field Description Page size To select the paper size of the generated report. Page Orientation This option is use to select the orientation of the report (portrait/landscape). Page Margin To specify the page margins of the report.

Table 4.14 Selecting the Page size VP-UML supports a wide range of page sizes for Word report generation. Different paper sizes can be selected in the Page size drop-down menu.

Figure 4.41 - Select the Page Size

4-24 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Selecting the Page Orientation To select the page orientation for the output report, select the desired orientation option in the Page Orientation section.

Figure 4.42 - Select the Page Orientation

Adjusting the Page Margins To adjust the page margins enter the value in the text box at the margin side you want to adjust, or drag the margin in the preview page.

Figure 4.43 - Adjust the page margin

Defining a Cover Page To define the Cover Page

1. Open the Generate Word Report dialog box. 2. Select the Cover Page tab. 3. Check the Generate cover page checkbox to include Cover Page in the report. 4. Enter information such as Logo image path for the background, Title , Organization name and Author Name .

Figure 4.44 - Configuring the cover page of report

4-25 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Defining a Header/Footer To define the Header/Footer of the document:

1. Open the Generate Word Report dialog box. 2. Select the Header/Footer tab. 3. Insert text or picture in header or footer section to include header/footer in the report.

Figure 4.45 - Define a Header/Footer

Three sections, Left Section, Center Section and Right Section, was predefined for user to insert text, or even pictures, page number, time, etc to the report Header and Footer. Separator can be added to the report in order to separate the region between Header, Content and Footer.

Defining the Header/Footer Style VP-UML supports several types of header/footer style for the Word report. They are described in the table below: Header/Footer Style Description

To format text style, such as font style, size and color.

To align content to left.

To align content to center.

To align content to right.

To insert an image to the header or footer

Insert page number

Insert page count

Insert date

Insert time

Insert project name

Insert report file name

Insert user name

Table 4.15

4-26 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Defining Document Info To define the document info:

1. Open the Generate Word dialog box. 2. Select the Document Info page.

Figure 4.46 - Define Document Info

Field Description Title The title of the report. Author The author of the report. Subject The subject of the report. Keywords The keywords of the report.

Table 4.16

Printing Diagrams

Print Preview

The Print Preview dialog box allows you to preview to printout and provides a set of options for changing the printout style. To display the dialog box, perform one of the following actions:

• Select File > Print... from main menu. • Click on the Print button on the toolbar.

In both cases, the Print Preview dialog box will

Figure 4.48 - Print preview dialog

4-27 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

The toolbar of the print preview pane allows you to configure the print settings. The buttons and their descriptions are shown in the table below: Icon Button Function

Print Print the diagram(s). The Print dialog box will be opened. Print diagrams without previewing them. The Quick Print dialog will be Quick Print opened. Set up the page properties for the diagrams to be printed such as paper size Page Setup and orientation.

Adjust Margins Adjust the margins of the pages to be printed. Select to use gradient color in printout. Since printing gradient color will Use Gradient Color use up lots of memory, it is recommended to turn this option off for better performance.

Zoom Select the percentage to reduce/enlarge the print preview of diagrams.

If the Fit to Pages option is selected, and there are multiple pages in the printout, selecting Paper Base Layout will cause the distribution of pages Paper Base to be paper-oriented (the diagram size is ignored in arranging the preview); Layout/Diagram / while selecting Diagram Base Layout will cause the distribution of pages Base Layout to be diagram-oriented. Note that this option affects the preview only; the order of the printout remains unchanged. To change the order of the printout. Consider a large diagram is divided into many pages, selecting From left to right will arrange the printout / Paper Place Style order from the pages on the left to the pages on the right, while selecting From top to bottom will arrange the print order from the pages on the top to the pages on the bottom.

Fit to Ratio Set the diagram size to fit to the specified ratio.

Fit to Pages Set the diagram to be printed on the number of pages specified.

Overlapping Set the percentage of the margins to overlap among adjacent pages.

Show/Hide Clip Select/deselect to show/hide the clip marks on the printout. Marks on Page

Edit Header/Footer Edit the header and the footer of the printout. Multipl e Page Mode Switch to the Multiple Page Mode to set the multiple page options. Help Calling the VP-UML help file Close Print Preview Close the print preview pane and return to the design area. Table 4.17

4-28 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Printing a Diagram with Preview

You can use the Print command to select the printer. Set the range of pages and number of copies to be printed. The Print command is available once a project is open.

1. Select the desired diagrams for printing. The selected diagrams will be shown at the preview area.

Figure 4.49 - Diagram Preview

2. Click on the Print button on the Print Preview Toolbar. The Print dialog box appears.

Figure 4.50 - Print the Diagram

3. Select the printer to use, the page range and the number of copies to be printed. You may click on the Properties... button to configure the printer-specific properties as well. 4. Click OK to start printing.

4-29 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Page Setup Page Setup allows user to specify the page size, the orientation as well as the margins of the pages.

Figure 4.51 - Page setup

1. Click on the Page Setup button on the toolbar. The Page Setup dialog box appears. 2. You can click on the Size drop-down menu to select the paper size to use. 3. You can select the orientation for the page(s) to be printed (either Portrait or Landscape ) in the Orientation field. 4. You can enter the value into the Left , Right , Top and Bottom text fields to adjust the size of the corresponding margin. 5. Click OK to confirm the settings.

Adjusting Margins The Margins pane allows user to specify the margins of the pages, header and footer.

Figure 4.52 - Adjusting Margins

1. Click on the Adjust Margins button on the Toolbar. The preview area shows the margin setting page.

4-30 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

2. You can edit the margins sizes by entering the sizes into the text fields. Alternatively, click on the spinner buttons to increase/decrease the margin sizes. 3. Click the Finish Adjust Margin button when you have finished configuring the margin settings. The margin sizes will then be updated.

Zooming Pages Diagrams can be zoomed in or zoomed out according to user preference. Click on the Zoom drop-down menu to select the desired zoom ratio.

Figure 4.53 - Set the Zoom ratio The preview area will show the diagrams in the zoom ratio that you have selected.

Figure 4.54 - Preview in the preview dialog

4-31 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Selecting the Preview Layout There are two layouts that you can select for the print preview, the Paper Base Layout and the Diagram Base Layout . If the Fit to Pages option is selected, and there are multiple pages in the printout, selecting Paper Base Layout will cause the distribution of pages to be paper-oriented (the diagram size is ignored in arranging the preview); while selecting 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 To select a layout of the preview, click on the Paper Base Layout button or Diagram Base Layout button on the toolbar, a popup menu appears where you can select the layout to use. The preview after applying the Paper Base Layout:

Figure 4.55 - Preview in paper Base Layout The preview after applying the Diagram Base Layout:

Figure 4.56 - Preview in Diagram Base Layout

4-32 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Setting Paper Place Style You can select the paper place style to change the order of the printout. To select the paper place style, click on the Paper Place Style button on the toolbar. A popup menu appears where you can select a paper place style. Consider a large diagram is divided into many pages, selecting From left to right will arrange the printout order from the pages on the left to the pages on the right, while selecting From top to bottom will arrange the print order from the pages on the top to the pages on the bottom The order of the printout after selecting From left to right .

Figure 4.57 - Printout order is left to right

Fit to Ratio Fit to Ratio is used to resize the diagrams in the printout to a specific ratio. Click on the Fit to drop-down menu and select Ratio . You can enter the ratio into the textbox. For example, enter 150 to set the ratio to 150%. After the have edited the ratio, the diagrams in the printout will be resized to the new ratio.

Figure 4.58 - Fit to ratio

4-33 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Fit to Pages Fit to Pages is used to split the diagram to desired number of pages when printing.

1. Click on the Fit to drop-down menu and select Pages . 2. Click on the Multiple Pages button on the toolbar. The page selector appears.

Figure 4.57 - Select multiple pages Page

3. Click on 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.

Figure 4.59 - Fit to page

Setting the Diagram Overlap Percentage Overlapping is used when users want the diagrams to have overlapping at the boundaries between pages. This is particularly useful when you have a large diagram that span multiple pages and you want to stick the pages of the printout together; the overlapping area can then be used as a hint when sticking the pages.

Figure 4.60- Multiple page without overlap

4-34 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

1. Click on the Overlapping textbox to input the overlapping percentage and press the Enter key. 2. The printing area near the boundaries of the pages will be duplicated by the overlapping percentage inputted.

Figure 4.60 - Multiple page with overlap

Showing/Hiding Clip Marks on Page Clip marks act as an indication of the boundary of a page.

Figure 4.61 - Clip marks

To show clip marks on the printout click on the Show Clip Marks on Page button . You will see the boundaries of the pages are surrounded by clip marks. To hide the clip marks click on the Hide Clip Marks on Page button again.

Editing Header/Footer of the Pages

To edit the header/footer of the printout click on the Edit Header/Footer button on the toolbar. You will then switch to the edit header/footer pane.

Figure 4.62 - Editing Header/Footer of the Pages You can edit the header and the footer in the Header panel and the Footer panel respectively. Each of the panel consists of the Left Section, Center Section and the Right Section , which represents the position that the content will be located in the header/footer. There is a toolbar between the Header panel and the Footer panel, which facilitates the editing of header/footer. The description of the buttons in the toolbar can be found in the following table: Icon Name Description Select the font to use for the selected section. Note that you must click on the section once in order Select Font to select it

Insert Page Number Insert the page number in the selected section

4-35 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Insert Number of Insert the total number of pages in the selected section Page

Insert Date Insert the date that the printing starts in the selected section Insert Time Insert the time that the printing starts in the selected section Insert File Name Insert the file name of the VP-UML project in the selected section Insert Project Name Insert the name of the VP-UML project in the selected section Insert Diagram Name Insert the diagram name in the selected section Table 4.18 After you have finished editing the header/footer, click on the Close Edit Header/Footer button to switch to the print preview mode. A sample page that has the header and footer formatted is shown in the picture below:

Figure 4.63 - Page with header and footer

The Multiple Page Mode The Multiple Page Mode allows users to configure how the diagrams should be distributes in multiple pages. To switch to the Multiple Page Mode click on the Multiple Page Mode button on the toolbar. Click on the button beside the Multiple Pages field will invoke the page selector, where you can select the row-column combination for the printout. Alternatively, you can type in the Row and Column text field directly.

Figure 4.64 - Select multiple page

4-36 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Click on the button beside the Page Style field to change the printout order. Consider a large diagram is divided into many pages, selecting From left to right will arrange the printout order from the pages on the left to the pages on the right, while selecting From top to bottom will arrange the print order from the pages on the top to the pages on the bottom.

Figure 4.65 - Distributes diagram in multiple page After you have finished configuring the multiple page settings click on the Close Multiple Page Mode button to close the Multiple Page Mode.

Printing a Diagram with Quick Print

The Quick Print feature allows you to print diagrams without previewing them, hence speed up the print job. To perform quick print, perform one of the following actions:

• Select File > Quick Print... from main menu • Select File > Print... from main menu. This displays the Print Preview dialog box. Click on the toolbar of the Print Preview dialog box.

In both cases, the Quick Print dialog box will show.

Figure 4.66 - Quick Print dialog

Field Description Click on either of the below options to specify the print range. All - Print all the diagrams within the current UML project Print Range Active - Print only the active UML diagram Diagrams - Check from the diagram tree to select the diagram(s) for printing Select No scaling to print with diagrams' original size. Numbers of pages use on each diagram are subject to the Scaling 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.

4-37 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Border Select border option of printout. option Page Page Setup allows you to specify the page size, the orientation as well as the margins of the pages. Setup... Page Check to print diagrams with page number on it. numbers Use gradient Select to use gradient color in printout. color

Table 4.19

Project Publisher

The Project Publisher is a tool that exports the project, including detailed information of diagrams and models, into interactive and elegantly organized web pages. The generated web pages can be read in any web browsers with no additional plug-in required, so you can sent the published project to collaborative partners even they do not have Visual Paradigm products installed.

Launching Project Publisher

To launch Project Publisher, perform one of the following actions:

• Select Tools > Project Publisher... from main menu. • Click on the Project Publisher button on the toolbar.

The Project Publisher dialog box appears.

Using Project Publisher

To publish the project, you need to enter the Output directory where the published files will be saved to. You may select the Launch viewer option so the default web browser on your computer will open the index page of the published project when the process is completed.

Figure 4.67 - Project Publisher Click OK to start publishing. The progress dialog box will appear while generating the content and the Project publishing complete message will show once it is done.

4-38 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Using the Published Project

Go to the output directory of the published project and open the file index.html with a web browser. The web page is organized in frames, namely the Navigator Pane , Menu Pane and Content Pane .

Figure 4.68 - Published project

Navigator Pane It comprises of the Diagram Navigator , Model Navigator and Class 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.

Figure 4.69 - Diagram Navigator

• Model Navigator 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.

Figure 4.70 - 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.

Figure 4.71 - Class Navigator

4-39 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

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. For more details about the possible contents please refer to the Navigator Pane section. 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.

Figure 4.72 - Menu Navigator

Content Pane It shows the details of the item (diagram, model or package/class) you clicked in the Menu Pane or Content Pane.

Diagram Content

Figure 4.73 - The 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.

Figure 4.74 - Shape link to the descriptions

4-40 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Using Jump to The Jump to combo box 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.

Figure 4.75 - Jump to an element Besides, there will be two shortcut buttons above the selected shape.

• The Back to top button brings you to the top of the page.

Figure 4.76 - Back to top button

• The Open specification button brings you to the details page of the shape.

Figure 4.77 - Open Specification button Models The Models section of the diagram content page shows the name, type and documentation of the models of all shapes in the diagram. You can click on the link of a model to view its details.

Figure 4.78 - Model list

4-41 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Model Content

Figure 4.79 - The Model Content The type, name and general model properties of a model are shown in the content page. 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.

Figure 4.80 - Parent Hierarchy Relationships The summary of the relationships of the model is shown in the Relationships Summary section. Just click on a relationship interested and it will take you to the relationship's details in the Relationships Detail section.

Figure 4.81 - Relationship summary

4-42 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

Other Model Details Certain types of model have their own properties, for example, attributes and operations of class, or columns of ERD table. They are also included in the content page as custom sections. For instance, the Operations Overview and the Operations Detail sections show the overview and details of the operations of a class respectively.

Figure 4.82 - Other Class details

4-43 VP-UML User’s Guide (Part 1) Chapter 4 – Generating Documentation

4-44

5 Interoperability VP-UML User’s Guide (Part 1) Chapter 5 - Interoperability

Chapter 5 - Interoperability

XMI, short for XML Metadata Interchange, is a widely used XMI based format for exchanging metadata information. The most common use of XMI is for interchange of UML objects. VP-UML facilitates excellent interoperability by allowing exchanging UML diagrams and models via XMI. Apart from this, you also can import models created from IBM Rational Rose previously. This chapter guides you through the process of importing an XMI file and IBM Rational Rose model, and exporting VP-UML project as a XMI file. In this chapter:

• XMI Importer and Exporter • Rose Importer • Use Case to MS Word Importer and Exporter • XML Importer and Exporter • ERwin modeler project file Importer • Oracle workflow engine BPEL generator • JBoss workflow engine BPEL generator

XMI Importer and Exporter

Figure 5.1 - XMI Import and Export

Supported XMI File version

VP-UML supports the importing several version of XMI files. Let's see the following table for details. Supports Import XMI files version Supports Export XMI files version XMI 1.0 for UML 1.x XMI 1.0 for UML 1.x XMI 1.2 for UML 1.x XMI 1.2 for UML 1.x XMI 2.1 for UML 1.x XMI 2.1 for UML 1.x XMI 1.0 for UML 2.0 XMI 1.0 for UML 2.0 XMI 1.2 for UML 2.0 XMI 1.2 for UML 2.0 XMI 2.1 for UML 2.0 XMI 2.1 for UML 2.0

Table 5.1 - Supported XMI version

5-2 VP-UML User’s Guide (Part 1) Chapter 5 - Interoperability

Importing an XMI File

The diagram below shows the class diagram in MagicDraw® before exporting as an XMI file.

Figure 5.2 - Class Diagram created by MagicDraw To import an XMI file into VP-UML:

1. Select File > Import > XMI... from main menu. This display the Import XMI dialog box. 2. In the dialog, locate the XMI file and click OK to open it. You can enter the path directly on the text field or click ... to locate the file from file chooser. 3. Since different tool support XMI in different ways, it may have chances that some elements proprietary to a particular tool could not be imported into VP-UML. If that's the case, the Log Details dialog box will be shown and display the problems.

Figure 5.3 - XMI Import Log Details

4. Upon finishing, diagrams and models from the XMI files are imported into VP-UML.

Figure 5.4 - Class Diagram and Model imported from XMI

5-3 VP-UML User’s Guide (Part 1) Chapter 5 – Interoperability

Note If the XMI file do not contains the view information, you can use the Form Diagram function to create the diagram from model. For more details about Form Diagram, please check the Form Diagram section in Chapter 3 - Working with Diagrams.

Exporting an XMI file

The diagram below shows a Use Case Diagram created in VP-UML before exporting as an XMI file.

Figure 5.5 - Use Case Diagram To export a VP-UML project into a XMI file:

1. Select File > Export > XMI... from main menu. This display the Export XMI dialog box. 2. In the dialog, locate the XMI file and click OK to export the project to the specified file path. You can enter the path directly on the text field or click ... to locate the file from file chooser. 3. Upon finishing, diagrams and models from the VP-UML project are exported as an XMI file.

Figure 5.6 - The exported XMI

5-4 VP-UML User’s Guide (Part 1) Chapter 5 - Interoperability

Note VP-UML does not support customization of generating XMI file. Instead, the exported XMI file can compatible to most vendors. Note The time required to export the xmi file depends on the size of the project, if the project is very large it may take several minutes.

Rose Importer

You can import into VP-UML the models designed in IBM Rational Rose®.

Figure 5.7 - Import from Rational Rose

Importing a Rose Project

To import a Rose project into VP-UML:

1. Design and save the model in Rose as a .mdl model file (e.g. project01.mdl).

Figure 5.8 - Modeling in Rational Rose ®

2. Launch VP-UML. Select File > Import > Rose Project... from main menu. This displays the Import Rose Option dialog box.

Figure 5.9 - Import Rose Option Dialog

5-5 VP-UML User’s Guide (Part 1) Chapter 5 – Interoperability

Field Description File path Specify the file path of the Rose model that you wish to import into the VP-UML project. Import Selecting Model Only will only import the model from the Rose project, while selecting Model and mode Diagram will import both the model and the diagrams (view) from the Rose project.

Table 5.7

3. Locate the MDL file (with extension .mdl). You can enter the path directly on the text field or click ... to locate the file from file chooser. 4. You can also select the import mode: choose Model only to import the models only (no diagrams will be created), or Model and diagram to import both the models and the diagrams. 5. Click OK to start importing the MDL file. 6. When the progress dialog box appears click to expand the dialog. The message pane appears.

Figure 5.10 - Importing MDL

7. The message pane shows the messages to indicate the progress of the importing process. When the process has finished click on the Close button in the progress dialog box to close.

Figure 5.11 - Message show in the dialog when import complete

8. The models/diagrams will be imported. Expand the project tree from Diagram Navigator and choose to browse for a diagram.

Figure 5.12 - Diagram Imported and show in Diagram Navigator

5-6 VP-UML User’s Guide (Part 1) Chapter 5 - Interoperability

9. Double-click on a diagram in the project tree to open the imported diagrams.

Figure 5.13 - The imported diagram

Interoperability with Word

Through interoperability with Word, you can export use case model of a project to a MS Word file. More than just a Word document, you can modify its content externally and then import it back to VP-UML to update the use case models.

Exporting Use Case Model to Word

1. To export use case model to Word, select menu Export > Use Case Model to MS Word... .

Figure 5.14 - Select Export > Use Case Model to MS Word

5-7 VP-UML User’s Guide (Part 1) Chapter 5 – Interoperability

2. The Export Use Case to MS Word dialog box is shown.

Figure 5.15 - Export Use Case Model to MS Word Dialog

3. Specify the path of the output Word file in Output destination . 4. The Export Models pane shows the models that will be exported (by default all use case diagram models are added to the list). The listing order determines the order of models that appears in the Word file.

Adding/Removing Exported Models

1. To remove models, select them and click the Remove Selected Model button (the "minus" button), or press the Delete key.

Figure 5.16 - Remove selected model

2. To add back removed models, click the Add Model button (the "plus" button). In the Add Model dialog box, select the models to add and click OK .

Figure 5.17 - Add Model Dialog

5-8 VP-UML User’s Guide (Part 1) Chapter 5 - Interoperability

3. To export only a certain types of models, click the Setup Visible of Model Type button (the "tick" button).

Figure 5.18 - Setup the Visibility of model Type

4. In the Setup Visible of Model Type dialog box, deselect the types of models that you do not want to include in the exported Word file.

Figure 5.19 - Setup Visible of Model Type Dialog

Reordering Exported Models

1. To sort the models, select a sorting mode in the combo box above the Export Models list.

No Sort - No sorting applied Sort by Name - Sort models by their names in ascending alphabetical order. Sort by Type - Sort models by their model types in ascending alphabetical order.

Figure 5.20 - Sorting Options

2. To reorder individual models, select them and click the Move up or Move down button. After moving models up or down, the sorting mode will be reset to No Sort automatically.

Figure 5.21 - Reordering the models

5-9 VP-UML User’s Guide (Part 1) Chapter 5 – Interoperability

Other Export Options

Figure 5.22 - Other export option

Launch MS Word - Select to open the Word file using MS Word when export finished. Insert page break after element - Select to insert a page break after each model element. Generate TOC - Select to generate TOC (table of contents) at the beginning of the Word file. Generate blank Use Case and Actor - Select to generate blank Use Case and Actor content at the end of the file. This is useful when you want to add new models to the Word file and then import them to VP-UML. You can then duplicate the blank content as template for new models.

Figure 5.23 - The Blank Use Case and Actor in exported document After the models and options are configured, click Export to export the models to Word file. Here shows an extracted page of an exported file.

Figure 5.24 - The exported document

5-10 VP-UML User’s Guide (Part 1) Chapter 5 - Interoperability

Modifying Exported Word File

Since the exported Word file is a standard MS Word document, you can modify it freely. However, if you want to import it back to VP-UML later, some guidelines has to be followed for modification.

Adding new Use Case/Actor To add new use case or actor, copy the content of an existing model and modify it. You may also select the Generate blank Use Case and Actor option when export so that blank use case and actor are generated in the exported Word file.

Editing General Properties

• For general properties like Use Case Details and Actor Details , the property name (the left-most column with text in bold) should keep unmodified, otherwise they cannot be recognized when import. • To edit values of properties, edit the text of the cell on the right of the property name (with an exception for Documentation, whose value cell is located under the property name). • For boolean properties (e.g. Abstract) either true or false (case-insensitive) should be entered. • For properties with fixed selection (e.g. Rank), only value within the selection should be entered (case-sensitive).

Figure 5.25 - The format of Use Case Details document

Editing Use Case Description

• To edit the name of a use case description, edit the text in the first row (with green background). • To add a new item, create a new row in the table. • To add a new flow of events item, duplicate an existing flow of events item and change to a new name.

Figure 5.26 - Flow of Event

• Rename of item is not supported for import. It will be treated as a new item. For instance, renaming "Preconditions" to "Preconditions2" will result in a new item "Preconditions2" to be created when import, while the item "Preconditions" remains unchanged. • Remove of items is not supported for import.

5-11 VP-UML User’s Guide (Part 1) Chapter 5 – Interoperability

• To add one or more use case description, copy the whole use case description table and paste it under the Use Case Description header, and then modify the copied content.

Figure 5.27 - Use Case Descriptions

Editing Extension Points Any modification to the extension points are ignored when import.

Editing Relations

• The relationships can be edited in the Relations table.

Figure 5.28 - Relationship

• To edit name of a relationship, edit the text in the Name column. • Change type of relationships is not supported when import. • To change from/to element of a relationship, edit the text to the name of the element in the From/To column respectively. • To add new relationships, insert a new row in the Relations table, enter its name in Name column, type in Type column (either Association , Generalization , Include or Extends ), from/to element name in From /To column respectively. • Remove of relationships is not supported when import.

5-12 VP-UML User’s Guide (Part 1) Chapter 5 - Interoperability

Importing Use Case Model from Word

1. To import use case model from Word, select menu Import > MS Word to Use Case Model... .

Figure 5.29 - Import Use Case Model from MS Word

2. In the Import Use Case from MS Word dialog box, select the Word file to import, and then click Import .

Figure 5.30 - Import Use Case from MS Word Dialog

3. The Word file will be examined, new models will be imported and updated models will be merged from the Word file. For the supported modifications for import, please reference the Modifying Exported Word File section.

Real-Time Update

1. After you have exported a project as Word file, if you have modified the Word file before switching to VP-UML with the source project opening, you will be asked whether you want to import the modified Word file to the VP-UML project. Just click Yes to perform import of the Word file automatically.

Figure 5.31 - Real-Time Update

5-13 VP-UML User’s Guide (Part 1) Chapter 5 – Interoperability

XML Importer and Exporter

Exporting an XML File

The diagram below shows a Use Case Diagram created in VP-UML before exporting as an XML file.

Figure 5.32 - Use Case Diagram for Export XML To export a VP-UML project into a XML file:

Figure 5.33 - Export to XML Dialog

1. Select File > Export > XML... from main menu. This display the Export to XML dialog box. 2. In the dialog, locate the XML file and click OK to export the project to the specified file path. You can enter the path directly on the text field or click ... to locate the file from file chooser. 3. If you want to export the whole project(all diagrams and models), select the Export project option.

Figure 5.34- Export project option

5-14 VP-UML User’s Guide (Part 1) Chapter 5 - Interoperability

4. If you only want to export certain diagrams and the related models, ensure the Export project was unselected, and then select desired diagrams in the Diagrams pane.

Figure 5.35 - Select diagram to Export pane

5. Upon finishing, click on the Export button and then diagrams and models from the VP-UML project are exported as an XML file. 6. When the export process finished, open the output destination folder, you can found the project.xml , together with images of selected diagrams.

Figure 5.36 - Generate Files

7. After you have XML have been exported, you can modify either manually or programmatically.

Figure 5.37 - Content of generated XML content

5-15 VP-UML User’s Guide (Part 1) Chapter 5 – Interoperability

Importing an XML File

To import an XMI file into VP-UML:

1. Select File > Import > XML... from main menu. This display the Import XML dialog box.

Figure 5.38 - Menu for Import XML File

2. In the dialog, locate the XML file and click OK to open it. You can enter the path directly on the text field or click ... to locate the file from file chooser.

Figure 5.39 - Import XML Dialog box

3. Diagrams and Models were imported to the current project. If model is already exist in the currently, model will be updated if available.

Figure 5.40 - Models of imported XML

5-16 VP-UML User’s Guide (Part 1) Chapter 5 - Interoperability

ERwin modeler project file Importer

Importing an ERwin Data Modeler Project

To import an ERwin Project into VP-UML:

1. Design and save the model in ERwin Data Modeler as a XML file.

Figure 5.41 - Modeling in ERwin

2. Launch VP-UML. Select File > Import > ERwin Project (XML)... from main menu. This display the AllFusion ERwin Data Modeler Project Importer dialog box.

Figure 5.42 - Menu for Import ERwin Project

5-17 VP-UML User’s Guide (Part 1) Chapter 5 – Interoperability

3. In the dialog, locate the ERwin Project file and click OK to start import. You can enter the path directly on the text field or click ... to locate the file from file chooser.

Figure 5.43 - Import ERwin Project Dialog box

4. Diagrams and Models were imported to the current project.

Figure 5.44 - Model of Imported ERwin Project

Oracle workflow engine BPEL generator

Generating BPEL for Oracle workflow engine

To generate BPEL for Oracle workflow engine:

1. Design a Business Process Diagram in VP-UML.

Figure 5.45 - Business Process Diagram

5-18 VP-UML User’s Guide (Part 1) Chapter 5 - Interoperability

2. Right click on diagram. Select Generate > BPEL... . This display the Export BPEL dialog box.

Figure 5.46 - Menu for generate BPEL

3. In the dialog, specify the path of the output BPEL files in Output directory . Select Oracle BPEL Process Manager (10.1.2) in Target server . Click OK to start export.

Figure 5.47 - Export BPEL Dialog box

4. List of exported files will be shown.

Figure 5.48 - Exported files

5-19 VP-UML User’s Guide (Part 1) Chapter 5 – Interoperability

JBoss workflow engine BPEL generator

Generating BPEL for JBoss workflow engine

To generate BPEL for JBoss workflow engine:

1. Design a Business Process Diagram in VP-UML.

Figure 5.49 - Business Process Diagram

2. Right click on diagram. Select Generate > BPEL... . This display the Export BPEL dialog box.

Figure 5.50 - Menu for generate BPEL

3. In the dialog, specify the path of the output BPEL files in Output directory . Select JBoss jBPM BPEL (1.1 beta1) in Target server . Click OK to start export.

Figure 5.51 - Export BPEL Dialog box

5-20 VP-UML User’s Guide (Part 1) Chapter 5 - Interoperability

4. List of exported files will be shown.

Figure 5.52 - Exported files

5-21 VP-UML User’s Guide (Part 1) Chapter 5 – Interoperability

5-22

6 Automatic Diagrams Layout VP-UML User’s Guide (Part 1) Chapter 6 – Automatic Diagrams Layout

Chapter 6 - Automatic Diagrams Layout

VP-UML provides a layout facility for arranging diagram elements in diagrams(Use Case Diagram, Class Diagram, Communication Diagram, State Machine Diagram, Activity Diagram, Component Diagram, Deployment Diagram, Composite Structure Diagram, Timing Diagram, Interaction Overview Diagram, Overview Diagram, Business Workflow Diagram). It re- layouts the diagram elements so that they do not overlap, and the relationship links are arranged so that they will not cross over one another. Different layout styles and configurable options are provided, which allows very flexible and sophisticated layout to be adopted for diagrams. In this chapter:

• Using diagram layout facility • Setting the diagram layout options

Auto Layout

Auto Layout can arrange the shapes by selecting the most suitable layout automatically. It is best for arranging the shapes when user has no special preference in choosing a specific layout. To apply Auto Layout to the diagram, right-click on the diagram and select Layout > Auto Layout from the popup menu.

Figure 6.1 - Select Auto Layout

Class Diagram

Hierarchy base (Factory class diagram)

Figure 6.2 - Hierarchy base (Factory class diagram)

6-2 VP-UML User’s Guide (Part 1) Chapter 6 – Automatic Diagrams Layout

Navigation base (Mediator class diagram)

Figure 6.3 - Navigation base (Mediator class diagram)

Activity Diagram

Figure 6.4 - Auto layout of activity diagram

State Machine Diagram

Figure 6.5 - Auto layout of state machine diagram

Communication Diagram

Figure 6.6 - Auto layout of communication diagram

6-3 VP-UML User’s Guide (Part 1) Chapter 6 – Automatic Diagrams Layout

Other Diagrams

Figure 6.7 - Auto layout of other diagrams

Performing Layout

• To layout all the diagram elements in the diagram, right-click on the diagram and select Layout from the popup menu. • To layout the selected diagram elements, right-click on the selection and select Layout from the popup menu (make sure there are more than one diagram elements selected).

Figure 6.8 - Performing layout

Orthogonal Layout

Orthogonal Layout arranges shapes based on the topology-shape-metrics approach. It is best for arranging shapes and connectors in Class Diagrams. It is the default layout in VP-UML. Every time you drag the models from the Model Tree to a diagram, the orthogonal layout will be applied to arrange the newly created shapes in the Class Diagram.

Figure 6.9 - Orthogonal Layout

6-4 VP-UML User’s Guide (Part 1) Chapter 6 – Automatic Diagrams Layout

Layout Grid Size : the virtual grid size for layout. Each shape will be placed in a way that its center point lays on a virtual grid point.

Figure 6.10 - Orthogonal Layout setting

Hierarchic Layout

Hierarchic Layout arranges shapes in a flow. It is best for arranging shapes that have hierarchical relationships such as generalization relationships and realization relationships.

Figure 6.11 - Hierarchic Layout

Min. Layout Distance : the minimal vertical distance between the shapes Min. Shape Distance : the minimal horizontal 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, simplex Connector Style : the style of the connectors -polyline style or orthogonal style

Figure 6.12 - Hierarchic Layout setting

6-5 VP-UML User’s Guide (Part 1) Chapter 6 – Automatic Diagrams Layout

Directed Tree Layout

Directed Tree Layout is one of the tree layouts in VP-UML. It can arrange shapes in a tree structure. It is best for arranging shapes that have hierarchical relationships such as generalization relationships and realization relationships.

Figure 6.13 - Directed Tree Layout

Min. Layer Distance : the minimal vertical distance between the shapes Min. Shape Distance : the minimal horizontal distance between the shapes Orientation : the layout direction for arranging nodes and connectors -top to bottom, left to right, bottom to top, and right to left Connector End Point Style : how the connector end points will be placed -shape centered, border centered, border distributed Orthogonal Connector : whether the connectors will be arranged in orthogonal style

Figure 6.14 - Directed Tree Layout Setting

Balloon Tree Layout

Balloon Tree Layout is one of the tree layouts in VP-UML. It can arrange shapes in a tree structure in a radial fashion. It is best for arranging large trees.

Figure 6.15 - Balloon Tree Layout

6-6 VP-UML User’s Guide (Part 1) Chapter 6 – Automatic Diagrams Layout

Min. Connector Length : the minimal distance between the connectors and shapes Preferred Child Wedge : the angle that the child node will be placed around its parent node Preferred Root Wedge : the angle that a node will be placed around the root node Root Node Policy : determines which node is chosen as the tree root node for layout -directed root, center root, and weighted center root

Figure 6.16 - Balloon Tree Layout Setting

Compact Tree Layout

Compact Tree Layout is one of the tree layouts in VP-UML. It can arrange shapes in a tree structure. You can set the aspect ratio (relation of tree width to tree height) of the resultant tree.

Figure 6.17 - Compact Tree Layout

Horizontal Spacing : the horizontal spacing between the shapes Vertical Spacing : the vertical spacing between the shapes Min. Connector Length : the vertical distance of the connector segments Aspect Ratio : the relation of the tree width to the tree height

Figure 6.18 - Compact Tree Layout Setting

6-7 VP-UML User’s Guide (Part 1) Chapter 6 – Automatic Diagrams Layout

Horizontal-Vertical Tree Layout

Horizontal-Vertical Tree Layout is one of the tree layouts in VP-UML. It can arrange shapes in a tree structure horizontally and vertically.

Figure 6.19 - Horizontal-Vertical Tree Layout

Horizontal Spacing : the horizontal spacing between the shapes Vertical Spacing : the vertical spacing between the shapes

Figure 6.20 - Horizontal-Vertical Tree Layout Setting

BBC Compact Circular Layout

BBC Compact Circular Layout is one of the circular layouts in VP-UML. It can arrange shapes in a radial tree structure. The detected group is laid out on the separate circles. It is best for arranging shapes that belongs to more than one group with ring structure.

Figure 6.21 - BBC Compact Circular Layout

6-8 VP-UML User’s Guide (Part 1) Chapter 6 – Automatic Diagrams Layout

Maximal Deviation Angle: the maximal angle of deviation Preferred Child Wedge: the angle that the child node will be placed around its parent node Minimal Edge Length: the minimal distance between the shapes Compactness Factor: the parameter affect the length of connector. The smaller the compactness factor, the length of connectors will be shorter and the layout will be more compact. Allow Overlaps: whether the shape can be overlapped

Figure 6.22 - BBC Compact Circular Layout Setting

BBC Isolated Circular Layout

BBC Isolated Circular Layout is one of the circular layouts in VP-UML. It can arrange shapes in many isolated ring structure. It is best for arranging shapes that belongs to one group with ring structure.

Figure 6.23 - BBC Isolated Circular Layout

The attributes of this layout is the same as BBC Compact Circular Layout.

6-9 VP-UML User’s Guide (Part 1) Chapter 6 – Automatic Diagrams Layout

Single Cycle Circular Layout

Single Cycle Layout is one of the circular layouts in VP-UML. It can arrange shapes in circular structure in single circle.

Figure 6.24 - Single Cycle Circular Layout

Choose radius automatically: determine the radius of circular structure automatically or manually Minimal Node Distance: the minimal distance between the nodes Fixed radius: the radius of circular structure

Figure 6.25 - Single Cycle Circular Layout Setting

Organic Layout

Organic Layout is one of the organic layouts in VP-UML. It can arrange shapes in a star or ring structure. It is best for arranging the shapes that have highly connectivity relationship.

Figure 6.26 - Organic Layout

6-10 VP-UML User’s Guide (Part 1) Chapter 6 – Automatic Diagrams 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 affect the distance between shapes Gravity Factor: the factor affect 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 affect the distance between shapes which belong to the same ring or star structure

Figure 6.27 - Organic Layout Setting

Smart Organic Layout

Smart Organic Layout is one of the organic layouts in VP-UML. It is a variant of the Organic Layout. It can set the ratio of the quality to the producing time of layout and control the compactness of layout.

Figure 6.28 - Smart Organic Layout

6-11 VP-UML User’s Guide (Part 1) Chapter 6 – Automatic Diagrams Layout

Compactness: the factor that set less or more compact layout. Deterministic: whether the layouter is in deterministic mode Minimal Node Distance: the minimal distance between nodes Node Overlaps Allowed: whether the node can be overlapped Node Size Aware: whether the node size can be aware Preferred Minimal Node Distance: the preferred minimal distance between the nodes Quality Time Ratio: the ratio of the quality of layout to the producing time of layout

Figure 6.29 - Smart Organic Layout Setting

Organic Edge Route Layout

Organic Edge Route Layout is one of the edge route layouts in VP-UML. It can arrange the connectors without affecting the location of shapes. It can ensure that the shapes will not overlap and keep a sepecfic minimal distance.

Figure 6.30 - Organic Edge Route Layout

Minimal Distance: the minimal distance of the connectors Route All: whether all the connectors will be routed Use Existing Bends: whether using existing bends

Figure 6.31 - Organic Edge Route Layout setting

6-12 VP-UML User’s Guide (Part 1) Chapter 6 – Automatic Diagrams Layout

Orthogonal Edge Route Layout

Route Connectors can arrange the connectors using vertical and horizontal line segments only. It is best for arranging the connectors that have complicated route.

Figure 6.32 - Orthogonal Edge Route Layout

Center to space ratio: the ratio of center to the distance between center and nodes Coupled distances: the distance between coupled nodes Crossing cost: the cost of crossing connector Custom border capacity: the capacity of the border Local crossing minimization: whether the local crossing of connectors will be minimized Minimum distance: the minimum distance of connectors Minimum distance to node: the minimum distance between the shapes Rerouting: whether the connector that have many crossing will be rerouted Routing style: the style of routing

Figure 6.33 - Orthogonal Edge Route Layout setting

6-13 VP-UML User’s Guide (Part 1) Chapter 6 – Automatic Diagrams Layout

6-14

7 Instant Reverse VP-UML User’s Guide (Part 1) Chapter 7 – Instant Reverse

Chapter 7 - Instant Reverse

VP-UML provides a handy way to reverse engineer various sources (including binary files) into UML class models. This feature is called Instant Reverse. The use of Instant Reverse is discussed in this chapter. In this chapter:

• What is Instant Reverse? • Supported Sources • Using Instant Reverse • Java Instant Reverse

What is Instant Reverse?

The Instant Reverse facility of VP-UML allows you to reverse engineer different types of source or binary files into UML class models, such as java source, java classes, C++ Source, JDBC, .NET binaries, etc...(More types will be supported soon). This chapter provides a brief description on the supported formats and the steps required to reverse engineer source code into UML class models in VP-UML.

SupportedSources

Instant Reverse currently supports eleven types of sources (Instant Types), they are Java source, Java class, C++ source, .NET binaries, windows executables, JDBC, XML, XML schema, CORBA IDL source, PHP 5.0 source, Hibernate and Ada 9x Source. For reversing Java source, you can supply a single source file or a directory. For reversing Java classes, you can supply a single class file, a jar file, a zip file or a directory. For reversing C++ source, you can supply a .cpp source file or a .h header file. For reversing .NET binaries, you must supply a single binary file (.dll or .exe), and the related files must in the same directory as the source file. Supported Instant Extension Remarks Type Java Source Dir/.java Java Class Dir/.class/.jar/.zip Must be created by MicrosoftR Visual Studio .NET Dynamic Link Library .dll Only need to supply one .dll file. All other required .dll files will be lookup automatically. Windows Executable .exe Must be created by MicrosoftR Visual Studio .NET XML .xml XML Schema .xsd C++ Source .h/.cpp CORBA IDL Source .idl PHP 5.0 Source Dir/.php/.inc Hibernate .hbm.xml Reverse the database schema of the specific database according to the given JDBC JDBC Connection URL. Ada 9x Source .ada/.adb/.ads

Table 7.1

7-2 VP-UML User’s Guide (Part 1) Chapter 7 – Instant Reverse

Using Instant Reverse

To use Instant Reverse, perform one of the following actions:

• Select Tools > Instant Reverse > %INSTANT_TYPE% from main menu. You can also select the menu item Instant Reverse... to display the Instant Reverse dialog box for choosing an instant type in further. • Click on the drop down arrow beside the Instant Reverse button on toolbar and select one of the instant types from the popup menu. You may also select the menu item Instant Reverse... to display the Instant Reverse dialog box for choosing an instant type in further.

In both cases, the Instant Reverse Options dialog box will be displayed. Select the Instant Type for reverse engineering, the Update Type and the source to reverse. Press OK to start reversing when everything is ready.

Figure 7.1 - Instant Reverse Dialog

Fields Description You can select the Instant Type in the Instant Type combo box. If you open the Instant Reverse Options dialog by Instant selecting a type under Instant Reverse sub-menu, the related Instant Type will be selected automatically. Different Type Instant Types will have a different file chooser when selecting sources to reverse. The action performed can be specified when duplicate models appear when reversing the source. If you select Update Update duplicate class(es) in the Update Type, the model in the repository will be updated by the reversed model Type automatically. If you select Replace duplicate class(es), the model in the repository will be replaced by the reversed model. You must specify the path of the source which you want to reverse. To define the source path, you can enter the path Path directly in the Path text field, or press the ... button to open the file chooser and select the path. For different Instant Type, the allowed file types will be shown in the file chooser automatically.

Table7.2 Whilst reversing the source, a progress bar displays indicates that Instant Reverse is in progress. When Instant Reverse has finished, a message will popup. Click OK to confirm it. Switch the Model Pane or Class Repository Pane and see the reversed models.

Figure 7.2 - Model Pane

7-3 VP-UML User’s Guide (Part 1) Chapter 7 – Instant Reverse

To create diagrams with the reversed models, you can simply drag it out and put it in the diagram pane or using the Form Diagram facility.

Figure 7.3 - Form diagram from selected model

If Instant Reverse fails, a dialog will pop up with the reason why it failed to reverse the source.

Figure 7.4 - Failure Message

Java Instant Reverse

Instant Reverse supports the reverse engineering of Java up to version 1.5. Besides, there are more advanced options for Java Instant Reverse compared to other languages. Select menu Tools > Instant Reverse > Java... , the Instant Reverse dialog box appears with the Java Instant Reverse options for configuration.

Figure 7.5 - Java Instant Reverse Dialog

The buttons on the right are used for adding, removing and reordering of Java source/class paths. Button Description Add JARs... Select JAR files to add to the instant reverse paths. Add Class Folder... Select class folders to add to the instant reverse paths. Add ZIPs... Select ZIP files to add to the instant reverse paths. Add Source Folder... Select source folders to add to the instant reverse paths.

7-4 VP-UML User’s Guide (Part 1) Chapter 7 – Instant Reverse

Remove Remove selected instant reverse paths. Up Move selected instant reverse paths upwards. Down Move selected instant reverse paths downwards.

Table 7.3 Select the Reverse source on demand option if you want the paths to be reversed to UML models only when you request it (see the On-Demand Java Instant Reverse section later in this chapter for details). If this option is not selected, the instant reverse paths will be reversed to UML models once you click OK.

On-Demand Java Instant Reverse

After performed instant reverse of Java with the Reverse source on demand option selected, the Class Repository will have the reversed paths added under the Java Resources node.

Figure 7.6 - Class Repository

There are three kinds of on-demand Java instant reverse you can use, they are reverse to Class Repository, reverse to diagram and reverse by drag-and-drop.

Reverse to Class Repository In the Class Repository's Java Resources node, select the desired resources to reverse, right-click on the selection and select Reverse "" to Class Repository from the popup menu.

Figure 7.8 - Revert resources to Class Repository

The resources will be reversed to UML models and added to the project, but no diagrams or shapes will be generated.

Figure 7.9 - Resource reversed in Class Repository

7-5 VP-UML User’s Guide (Part 1) Chapter 7 – Instant Reverse

Reverse to Diagram In the Class Repository's Java Resources node, select the desired resources to reverse, right-click on the selection and select Reverse "" to from the popup menu to expand it.

Figure 7.10 - Revert resources to form a new diagram

If you selected the New Class Diagram menu, a new class diagram will be generated from the reversed UML models.

Figure 7.11 - The reversed Class Diagram

If there is an active class diagram and you selected the " " (Active Diagram) menu, the shapes of the reversed UML models will be generated and appended to the empty space of this diagram.

Reverse by Drag-and-Drop In the Class Repository's Java Resources node, select the desired resources to reverse, drag the selection over the target class diagram and then release the mouse button to drop it.

Figure 7.12 - Reverse by Drag and Drop

The shapes of the reversed UML models will be generated and placed to the location of this diagram where you dropped the resources.

7-6

Incorporating Visio® and 8 Images to Diagrams VP-UML User’s Guide (Part 1) Chapter 8 – Incorporating Visio® and Images to Diagrams

Chapter 8 - Incorporating Visio® and Images to Diagrams

Beside standard UML notations, you can extend the possibilities of diagramming and modeling by incorporating images to diagrams via Visio shapes and Image shapes. Visio® is a generic diagramming tool providing plenty of shapes for business and technical diagrams. With the Visio® integration, you can create UML diagrams with Visio® drawings in VP-UML. In this chapter, you will learn how to create and edit Visio® Shapes on UML diagrams in VP-UML. Image Shape is a shape that displays an image on the diagram. It is the most convenient way of adding images to the diagrams to document and annotate important ideas. In this chapter:

• What is Visio® Shape in VP-UML? • Creating Visio® Shapes • Editing Visio® Shapes • Resizing Visio® Shapes • What is Image Shape? • Creating Image Shapes • Selecting Image • Selecting Linked File • Image Scaling Option • Exporting Image • Exporting Linked File

Introduction to Visio® Shapes

Visio® Shape is a type of diagram element in VP-UML. Each Visio® Shape is correspondent to a Visio® document and the content of the Visio® document will be displayed on the diagrams in VP-UML. You can draw Visio® Shapes on all types of UML diagrams. Visio® Shapes can contain UML diagram elements and they can be connected by generic connectors.

Figure 8.1 - Visio® Shapes

Creating Visio® Shapes

It's as easy as ABC to create Visio® Shapes on UML diagrams in VP-UML. You can create a Visio® Shape as if creating a class on a class diagram. Before you are able to create Visio® Shapes, you are required to install Visio® 2003 on your machine. If your Visio® 2003 is installed properly, you should be able to found that there is a new icon on the diagram toolbar in each UML diagram.

8-2 VP-UML User’s Guide (Part 1) Chapter 8 – Incorporating Visio® and Images to Diagrams

1. Click the Visio Shape button on the diagram toolbar

Figure 8.2 - The visio shape button

2. Click on the desired location on the UML diagram. An empty Visio® Shape will be created.

Figure 8.3 - Visio Shape

3. After creating a blank new Visio® Shape, you can either edit it at once or later. To edit a Visio® Shape, please see the following section.

Editing Visio® Shapes

You can edit the Visio® Shape you just created or an existing Visio® Shape on your UML diagram by a double-click.

Figure 8.4 - Edit Visio Shape with Visio®

1. Double-click the desired Visio® Shape on your UML diagram. 2. VP-UML will be in Visio®-edit mode. In this mode, you are not allowed to edit the VP-UML diagrams. 3. Visio® program will be started with the diagram containing the content of the Visio® Shape (The diagram is blank if the Visio® Shape is just created). 4. Edit the Visio® diagram in Visio® program. You can edit the Visio® diagram as if editing diagrams in the standalone Visio® program. 5. After editing the Visio® diagram, close the Visio® program to apply the changes. 6. VP-UML will exit the Visio®-edit mode and you will find that the Visio® Shape in your UML diagram will be updated with the exact content of the Visio® diagram.

8-3 VP-UML User’s Guide (Part 1) Chapter 8 – Incorporating Visio® and Images to Diagrams

7. If you want to cancel the editing of the Visio® Shape, switch back to VP-UML and then click on the Cancel button on the Visio® Shape.

Figure 8.5 - Cancel Edit

Resizing Visio® Shapes

You can resize Visio® Shapes on your UML diagrams in VP-UML. No matter how you resize the Visio® Shapes, their image quality will be kept up.

Figure 8.6 - Resize Visio Shape

Fitting Visio® Shape Size

You can use the fit size facility to resize the shapes to fit their contents in VP-UML. However, fitting the size of a VP-UML shape is different from fitting the size of a Visio® Shape. The size of a Visio® Shape will be fitted to the original content of the Visio® diagram.

What is Image Shape?

Image Shape is a utility for displaying an image on any diagrams, and it can also act as a link to a file. Unlike Visio shapes, you do not need a 3rd party application to be installed in order to use it. With Image Shape, you can easily add images to document and annotate important ideas in the diagram.

Figure 8.7 - Image

8-4 VP-UML User’s Guide (Part 1) Chapter 8 – Incorporating Visio® and Images to Diagrams

Like standard shapes in VP-UML, an Image Shape can be connected to other shapes (via Generic Connector) and can have a caption.

Note The caption of Image Shape is empty by default; just double-click on it to edit the caption. Unlike other shapes in VP-UML, the caption of Image Shape is freely movable.

Creating Image Shapes

You can either create an Image Shape using the diagram toolbar, by copy and paste, or by drag and drop.

Creating Image Shapes by Using Diagram Toolbar

1. Click on the Image Shape button on the diagram toolbar.

Figure 8.8 - The Image Shape button

2. Click on the diagram, an Image Shape is created and a file dialog shows for selecting an image. Upon selecting an image, its preview is shown on the right of the dialog box.

Figure 8.9 - Selected Image Dialog

3. In the Image Location group, select an option:

Embedded - The source image will be copied and embedded into the project, which means any modification to or removal of the source image will not affect the image in this Image Shape. The advantage of using embedded image is the image remains even when the source image no longer exists; while the disadvantage is the project file size will grow since images are copied to the project, and the embedded image cannot update when the source image is updated.

8-5 VP-UML User’s Guide (Part 1) Chapter 8 – Incorporating Visio® and Images to Diagrams

Linked - The Image Shape links the source image for display, which means any modification to or removal of the source image will also be reflected in this Image Shape. The advantage of using linked image is the project file size will not grow since images are just linked but not copied to the project, and the image in the Image Shape will update when the source image is updated; while the disadvantage is the image will lost when the source image no longer exists.

4. After selecting the image location option, click Open to confirm.

Creating Image Shapes by Copy and Paste

1. Copy an image to the clipboard.

Figure 8.10 - Copy image to system clipboard

2. Switch to VP-UML, open a diagram, select menu Edit > Paste or use hotkey Ctrl+V . An image shape is created with the copied content.

Figure 8.11 - Paste image in VP-UML will convert to Image shape automatically

Note

The image location of the Image Shape created by copy and paste will be set to Embedded.

8-6 VP-UML User’s Guide (Part 1) Chapter 8 – Incorporating Visio® and Images to Diagrams

Creating Image Shapes by Drag and Drop

1. Drag one or more files from your computer and drop to a diagram in VP-UML.

Figure 8.12 - Drop a file to diagram

2. An image shape will be created for each dropped file. 3. If you dropped an image file to the diagram, an image shape will be created that embed the dropped image. 4. If you dropped a non-image file to the diagram, an image shape will be created that links to this file. And it shows the system icon of the file for indication. Refer to Selecting Linked File for more information on how to link the image shape to file.

Figure 8.13 - Use Case Diagram with Image shape You can double click on the shape to open the file directly.

Selecting Image

No matter what method you used to create an Image Shape, you can change its source image later on. To selecting an image, perform one of the following actions:

1. Right-click on an Image Shape and select Select Image... from the popup menu.

Figure 8.14 - Select image by click on popup menu

8-7 VP-UML User’s Guide (Part 1) Chapter 8 – Incorporating Visio® and Images to Diagrams

2. Select an Image Shape, click on the button next to the Image property in the Property table.

Figure 8.15 - Select image on Property pane

A file dialog shows for selecting an image. For details on the options in selecting an image, please refer to Creating Image Shapes by Using Diagram Toolbar earlier in this chapter.

Selecting Linked File

An Image Shape can act as a link to a file. To select the linked file, perform one of the following actions:

1. Right-click on an Image Shape and select Select Linked File... from the popup menu. 2. Select an Image Shape, click on the button next to the Linked File property in the Property table.

A file dialog shows for selecting a linked file. Once an Image Shape is linked to a file, you can double-click it to open the linked file.

Figure 8.16 - Image shape with linked file

Image Scaling Option

Image Shape has two image scaling options which determine how an image will be displayed when the Image Shape changes it size.

1. To select an image scaling option, right-click on the Image Shape and select Scaling from the popup menu.

Figure 8.17 - Image shape scaling option

8-8 VP-UML User’s Guide (Part 1) Chapter 8 – Incorporating Visio® and Images to Diagrams

Fit to Shape - The image will be expanded or shrunk to fit the shape when the Image Shape changes its size.

Figure 8.18 - Image resize to fit the shape Actual Size - The image will always be displayed in its actual size no matter how large the Image Shape is.

Figure 8.19 - Fit image size

Exporting Image

To export image from an Image Shape, right-click on it and select Export Image... from the popup menu. A file dialog will show for selecting the path of the exported image. You may also choose the exported image format as either JPG or PNG.

Figure 8.20 - Export image dialog

Exporting Linked File

To export the linked file from an Image Shape, right-click on it and select Export Linked File... from the popup menu. A file dialog will show for selecting the path of the exported file.

Figure 8.21 - Export linked file

8-9 VP-UML User’s Guide (Part 1) Chapter 8 – Incorporating Visio® and Images to Diagrams

8-10

9 Team Collaboration VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

Chapter 9 - Team Collaboration

When several team members are working on the same project but different parts, the correctness and integrity of model are always concerns. The time and effort spent on sharing the work done by team members are expensive, and it is very risky that the previous works may be overwritten by the new changes. Visual Paradigm's Teamwork collaboration support aims to facilitate collaborative modeling by allowing concurrent modeling and versioning. There are three ways of working with Visual Paradigm's project as a team. The first one is by using the VP Teamwork Server product provided by Visual Paradigm. The second and the third are to make use of the CVS and Subversion integrations that comes with the client products. In this chapter:

• VP Teamwork Server • CVS and Subversion integration

VP Teamwork Server

VP Teamwork Server is a version control system developed for the Visual Paradigm users. With VP Teamwork Server, users can manage changes to their project easily, and model collaboratively and concurrently with other team members. Here is an outline of the roles and responsibilities in a Team working environment through the use of Teamwork Server. Server-side:

• The administrator creates teamwork users • The administrator creates projects, and assigns selected users to the project. The Read/update project permission is granted to users individually.

Client-side:

• The user logs in to the VP Teamwork Server • The user checks out (download) a project from the server and opens it in VP-UML on the client side. • The user modifies the project locally, and then checks in (upload) the project to the server for updating. • If the user has been granted the update project permission, the server will compare the local project with the user uploaded project, and begin the two-phase checkin process. • The first phase checks whether conflicts are found. A conflict is the modification of a model/view element that is also modified by other teamwork users. If no conflict is found, the server proceeds to the second phase. Otherwise the teamwork client will notify the user of the conflicts, and ask him/her to select the conflict resolve method before proceeding to the second phase. • In the second phase, a new version of the project is created by merging the changes made by the user with the latest project copy on the server. • The new project is checked-out (downloaded) from the server to the client, and is reopened so that the user can work on the latest project.

More detailed explanations can be found in the coming section.

9-2 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

Starting the Teamwork Client

To start the Teamwork Client , select Tools > Teamwork > Open Teamwork Client... from main menu. This displays the Login to the Teamwork Server dialog box. To log in to the Teamwork Server:

1. Select Teamwork Server as Server. 2. Enter in the User name field the name of user under which to connect. 3. Enter in the Password field the user password. 4. Enter the IP address of the Teamwork Server in Server host . 5. Enter the port number of the Teamwork Server in Port number . 6. Select Remember password if you do not want to enter the password every time. 7. If connecting behind a proxy server, select Use proxy and fill in the proxy settings in Proxy host and Port . 8. Click Login to login to the Teamwork Server.

Figure 9.1 - Login to the Teamwork Server dialog

9. This shows the Teamwork Client dialog box.

Figure 9.2 - The Teamwork Server dialog

The default port number of the Teamwork Server is 1999.

9-3 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

Checking out a Project

The checkout project function downloads a project from the teamwork server to the client's workspace, so that you can view and edit it in VP-UML. To checkout a project:

1. Start the Teamwork Client and log in to the teamwork server. 2. From the Projects list, select the project that you want to download to your local machine. 3. Perform any of the follow actions: • Select the Action > Checkout Project from main menu • Click on the Checkout Project button on the toolbar to checkout the selected project. • Click on the Checkout button in the Project Details page.

Or you can simply click "Open Project", checkout will be done automatically before opening the project.

The following table describe the fields in the Project Detail page. Field Description Project name The name of the project is displayed File path The local file path of the project. This field is empty if the project is not yet checked out Checkout time The last checkout time of the project. This field is empty if the project is not yet checked out Version The teamwork project version. This field is empty if the project is not yet checked-out The project status. Possible status are: Not checked out -The project is not yet checked out Up-to-date (local project not modified) -The project is up-to-date, and the local project file is not modified since the last checkout Up-to-date (local project modified) -The project is up-to-date, and the local project file is modified since the last checkout Has update (local project not modified) -A newer version of the project is available on the server, and the local project file is not modified since the last checkout Status Has update (local project modified) -A newer version of the project is available on the server, and the local project file is modified since the last checkout Error in checking project status -The project status cannot be determined. You should check out the project again if you see this status Not connected to the teamwork server -The current client session is no longer valid. You should re-connect to the teamwork server if you see this status

The project status is refreshed automatically when a project is selected in the project list. Description Displays the project description Delete local project file Delete the local project file after logging out when logout Open Project Click this button to open the project in SDE for viewing or editing Versions... Displays the checkin version history of the selected project Table 9.1

9-4 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

Checking in a Project

The checkin/commit project function allows you to commit the project changes (that you have made to the local project) to the teamwork server. Checkin can be done both from the application or from the Teamwork Client dialog box. To checkin a project from the application, perform any of the following actions:

• Click on the Commit button on toolbar. • Select Tools > Teamwork > Commit... from the main menu.

To checkin a project from the Teamwork Client dialog box:

1. Start the Teamwork Client and log in to the teamwork server. 2. Perform any of the follow actions: • Select the Action > Checkin Project from main menu • Click on the Checkin Project button on the toolbar to checkout the selected project.

After that, you are asked to enter the description of the changes made since the last checkin. Enter whatever information you think that is useful to distinguish between different versions and press OK to proceed.

Figure 9.3 - Commit Project dialog

This shows the Commit Model(s) dialog box, which list the changes that you have made, updates available from the server and the conflicts. After press OK , the project will be committed and updated from server, and reopened in VP-UML. If there are conflicts found in the checkin process, you will need to resolve the conflicts before proceeding further.

Figure 9.4 - Checkin Model(s) dialog

9-5 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

The changes and conflicts are listed in the tree:

• The Green Icon indicate changes you have made. • The Red Icon indicate conflicts occurred. • The Property Name displays the name of the property. • The Value displays the value you have set. • The Original Value displays the value when you checkout from server. • The Conflict Value displays the value committed by other users. • The Version shows the latest version of the property. • The Conflict Version indicate the version that cause conflict. • The Select next conflict and Select previous conflict navigate between the conflict models/properties. • You can resolve conflict by overwrite or revert your changes. You can click on the Overwrite button to overwrite the change made by other users, or click on the Revert button to undo the change you have made. After you have clicked Overwrite or Revert button, you can click on the Reset button to undo your overwrite or revert action. • The Overwrite all conflicts , Revert all conflicts , and Reset all conflicts applies overwrite, revert, and reset on all models/properties. • After you have handled the conflicts, click OK in the Checkin Project dialog box to proceed with the checkin process, or click Cancel if you want to check in again later. • If the check in is done successfully, the project will be checked-out from the server to update the local copy of the project and will be reopened in VP-UML automatically.

Updating a Project

The update project function updates the project by downloading changes made by other team members from the Teamwork Server to the local project. Updating can be done both from the application or from the Teamwork Client dialog box. To update a project from the application, perform any of the following actions:

• Click on the Update button on toolbar. • Select Tools > Teamwork > Update from the main menu.

To update a project from the Teamwork Client dialog box:

1. Start the Teamwork Client and log in to the teamwork server. 2. Perform any of the follow actions: • Select the Action > Update Project from main menu • Click on the Update Project button on the toolbar to update the selected project.

Reverting a Project

The revert project function force the local project to revert to the latest version of project available in the Teamwork Server. To revert a project:

1. Start the Teamwork Client and log in to the teamwork server. 2. Click on the Revert Project button from the toolbar.

9-6 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

Checking for Updates

Check for update allows you to check whether there is a newer version of the project available on the Teamwork Server. To check for update, select Tools > Teamwork > Open Teamwork Client... from main menu to display the Teamwork Client dialog box. Select a project in the project list and perform one of the following actions:

• Select the Action > Check for Update from main menu. • Click on the Check for Update button on toolbar.

The checking result will be displayed in the message pane.

Figure 9.5 - Message pane display successful message

If there is a newer version of the project available on the server, you can run an update to download the changes made by other members to your local copy.

Refresh Project List

Refresh project list allows you to refresh the list of projects available to you. This is particularly useful when the administrator has assigned new projects to you after you have logged in.

To refresh project list, select Tools > Teamwork > Open Teamwork Client... from main menu to display the Teamwork Client dialog box and perform one of the following actions:

• Select the Action > Refresh Projects from main menu. • Click on the Refresh Projects button on toolbar.

Export Project

If you want to carry the teamwork project to another computer, you can use the export project function. To export a project, select Tools > Teamwork > Open Teamwork Client... from main menu to display the Teamwork Client dialog box. Select a project in the project list and perform one of the following actions:

• Select the Action > Export Project... from main menu. • Click on the Export Project button on toolbar.

When the Export Project file dialog box appears, specify the location.

9-7 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

Import Project

The import project function allows you to import a project that has been exported previously using the export project function. To import a project, select Tools > Teamwork > Open Teamwork Client... from main menu to display the Teamwork Client dialog box. Select a project in the project list and perform one of the following actions:

• Select the Action > Import Project... from main menu. • Click on the Import Project button on toolbar.

When the Import Project file dialog box appears, select the project

Only projects exported using the export project function can be imported.

Viewing the Checkin Version History

To view the checkin version history of a project, open the Teamwork Client and select the project in the project list, then click on the Versions tab.

Figure 9.6 - Versions tab

The Project Version History appears which shows the checkin history of the selected project.

Figure 9.7 - Project Versions History dialog

Field Description Display Select the number of latest versions to display in the project version list A list of project checkin versions, which shows the version number, checkin user name and checkin Project versions date time of each version Open Project Click this button to open the project for viewing Checkin Description A description entered by user for individual check-in Modified model A list of modified model elements in this version elements Modified diagrams A list of modified diagrams in this version

9-8 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

Modified diagram A list of modified diagram elements in this version elements Conflicts A list of conflicts found during the checkin process of this version Table 9.2

Closing the Teamwork Client

To close the Teamwork Client , click on the Close button (located at the lower-right corner of the Teamwork Client window).

Closing a Teamwork Client will only hide the Teamwork Client window, the Teamwork Client is still connected to the teamwork server. You must log out the Teamwork Client in order to disconnect from the teamwork server.

Logout the Teamwork Client

To logout the Teamwork Client , open the Teamwork Client and perform one of the following actions:

• Select the Session > Logout from main menu. • Click on the Logout button on the toolbar

If you exit from VP-UML, you will be logged out of the Teamwork Client automatically.

After you have logged out, you can select Session > Login from the menu or click on the Login button on the toolbar to login again.

9-9 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

CVS and Subversion

Concurrent Versions System (CVS) and Subversion (SVN) are both popular version control systems that store artifacts in a central repository and help keep track of changes and histories. The way VP-UML integrates with CVS and Subversion are very similar, except that they require different set of login detail for logging into the server.

Starting the Teamwork Client

To start the Teamwork Client , select Tools > Teamwork > Open Teamwork Client... from main menu. This shows the Login to the Teamwork Server dialog box.

Figure 9.8 - The Login to Teamwork Client box

For CVS users, fill in the fields as instructed below, then press Login to login to the CVS server. Field Description Server CVS User name The name of user under which to connect Password Password for the user The path of the cvs.exe file (The default is pointed to the cvs.exe inside $vp-suite-install- CVS Path dir/bin/vp_windows/cvs) Connection The type of CVS connection for the repository (The default is pserver) type Host The address of the host Repository path The path of the repository at the host address Table 9.3 For Subversion users, fill in the fields as instructed below, then press Login to login to the Subversion server. Field Description Server Subversion User name The name of user under which to connect Password Password for the user Repository The path of the Subversion repository The path of the svn.exe file (The default is pointed to the svn.exe inside $vp-suite-install- SVN Path dir/bin/vp_windows/svn/bin) Table 9.4

9-10 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

This shows the Manage Project dialog box for you to select project(s) from the server to work with.

Figure 9.9 - The Manage Project dialog box To manage a project, select a project and press the > button to move it to the Projects list. When done, press the OK button to proceed. This shows the Teamwork Client dialog box.

Figure 9.10 - The Teamwork Client box

9-11 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

Importing a Project to the Server

Users who take part in a project can add a Visual Paradigm project to the server. We call this process to import a project to the server. To import a project to the server:

1. Start the Teamwork Client and log in to the CVS/Subversion server. 2. Press Import... This shows the Import project dialog box.

Figure 9.11 - The Import Project dialog box

3. Enter the project name of which to import. 4. Specify the source of the project to import to the Subversion server.

Option Description Currently opened project The project that is opened in the running application Create new project A blank and new Visual Paradigm project Import existing project An external project file

Table 9.5

9-12 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

5. To create a remote folder to store the project in server, right-click on a tree node and select New Remote Folder from the pop-up menu.

Figure 9.12 - Creating a remote folder

6. If Create folder for project is checked, this will create a remote folder, which have the same name as the project file, for storing the project file. 7. Click OK when done.

Checking out a Project

The checkout project function downloads a project from the server to the client's workspace, so that you can view and edit it in VP-UML. To checkout a project:

1. Start the Teamwork Client and log in to the CVS/Subversion server. 2. From the Projects list, select the project that you want to download to your local machine. 3. Perform any of the follow actions: • Select the Action > Checkout Project from main menu • Click on the Checkout Project button on the toolbar to update the selected project. • Click on the Checkout button in the Project Details page.

Or you can simply click "Open Project", checkout will be done automatically before opening the project.

9-13 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

The following table describe the fields in the Project Detail page. Field Description Project name The name of the project is displayed File path The local file path of the project. This field is empty if the project is not yet checked out Checkout time The last checkout time of the project. This field is empty if the project is not yet checked out Version The teamwork project version. This field is empty if the project is not yet checked-out The project status. Possible status are: Not checked out -The project is not yet checked out Up-to-date (local project not modified) -The project is up-to-date, and the local project file is not modified since the last checkout Up-to-date (local project modified) -The project is up-to-date, and the local project file is modified since the last checkout Has update (local project not modified) -A newer version of the project is available on the server, and the local project file is not modified since the last checkout Status Has update (local project modified) -A newer version of the project is available on the server, and the local project file is modified since the last checkout Error in checking project status -The project status cannot be determined. You should check out the project again if you see this status Not connected to the teamwork server -The current client session is no longer valid. You should re-connect to the teamwork server if you see this status

The project status is refreshed automatically when a project is selected in the project list. Description Displays the project description Delete local project file Delete the local project file after logging out when logout Open Project Click this button to open the project in SDE for viewing or editing Versions... Displays the checkin version history of the selected project Table 9.6

Checking in a Project

The checkin/commit project function allows you to commit the project changes (that you have made to the local project) to the CVS/Subversion server. Checkin can be done both from the application or from the Teamwork Client dialog box. To checkin a project from the application, perform any of the following actions:

• Click on the Commit button on toolbar. • Select Tools > Teamwork > Commit... from the main menu.

To checkin a project from the Teamwork Client dialog box:

1. Start the Teamwork Client and log in to the server. 2. Perform any of the follow actions: • Select the Action > Checkin Project from main menu • Click on the Checkin Project button on the toolbar to checkout the selected project.

9-14 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

After that, you are asked to enter the description of the changes made since the last checkin. Enter whatever information you think that is useful to distinguish between different versions and press OK to proceed.

Figure 9.13 - Commit Project dialog

This shows the Commit Model(s) dialog box, which list the changes that you have made, updates available from the server and the conflicts. After press OK , the project will be committed and updated from server, and reopened in VP-UML. If there are conflicts found in the checkin process, you will need to resolve the conflicts before proceeding further.

Figure 9.14 - Commit Models dialog The changes and conflicts are listed in the tree:

• The Green Icon indicate changes you have made. • The Red Icon indicate conflicts occurred. • The Property Name displays the name of the property. • The Value displays the value you have set. • The Original Value displays the value when you checkout from server. • The Conflict Value displays the value committed by other users. • The Version shows the latest version of the property. • The Conflict Version indicate the version that cause conflict. • The Select next conflict and Select previous conflict navigate between the conflict models/properties. • You can resolve conflict by overwrite or revert your changes. You can click on the Overwrite button to overwrite the change made by other users, or click on the Revert button to undo the change you have made. After you have clicked Overwrite or Revert button, you can click on the Reset button to undo your overwrite or revert action. • The Overwrite all conflicts , Revert all conflicts , and Reset all conflicts applies overwrite, revert, and reset on all models/properties. • After you have handled the conflicts, click OK in the Checkin Project dialog box to proceed with the checkin process, or click Cancel if you want to check in again later. • If the check in is done successfully, the project will be checked-out from the server to update the local copy of the project and will be reopened in VP-UML automatically.

9-15 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

Updating a Project

The update project function updates the project by downloading changes made by other team members from the CVS/Subversion Server to the local project. Updating can be done both from the application or from the Teamwork Client dialog box. To update a project from the application, perform any of the following actions:

• Click on the Update button on toolbar. • Select Tools > Teamwork > Update from the main menu.

To update a project from the Teamwork Client dialog box:

1. Start the Teamwork Client and log in to the server. 2. Perform any of the follow actions: • Select the Action > Update Project from main menu • Click on the Update Project button on the toolbar to checkout the selected project.

Reverting a Project

The revert project function force the local project to revert to the latest version of project available in the CSV/Subversion Server. To revert a project:

1. Start the Teamwork Client and log in to the server. 2. Click on the Revert Project button from the toolbar.

Checking for Updates

Check for update allows you to check whether there is a newer version of the project available on the CVS/Subversion server. To check for update, select Tools > Teamwork > Open Teamwork Client... from main menu to display the Teamwork Client dialog box. Select a project in the project list and perform one of the following actions:

• Select the Action > Check for Update from main menu. • Click on the Check for Update button on toolbar.

The checking result will be displayed in the message pane.

Figure 9.15 - Message pane display successful message

If there is a newer version of the project available on the server, you can run an update to download the changes made by other members to your local copy.

9-16 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

Refresh Project List

Refresh project list allows you to refresh the list of projects available to you. This is particularly useful when the administrator has assigned new projects to you after you have logged in.

To refresh project list, select Tools > Teamwork > Open Teamwork Client... from main menu to display the Teamwork Client dialog box and perform one of the following actions:

• Select the Action > Refresh Projects from main menu. • Click on the Refresh Projects button on toolbar.

Export Project

If you want to carry the teamwork project to another computer, you can use the export project function. To export a project, select Tools > Teamwork > Open Teamwork Client... from main menu to display the Teamwork Client dialog box. Select a project in the project list and perform one of the following actions:

• Select the Action > Export Project... from main menu. • Click on the Export Project button on toolbar.

When the Export Project file dialog box appears, specify the location.

Import Project

The import project function allows you to import a project that has been exported previously using the export project function. To import a project, select Tools > Teamwork > Open Teamwork Client... from main menu to display the Teamwork Client dialog box. Select a project in the project list and perform one of the following actions:

• Select the Action > Import Project... from main menu. • Click on the Import Project button on toolbar.

When the Import Project file dialog box appears, select the project

Only projects exported using the export project function can be imported.

9-17 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

Viewing the Checkin Version History

To view the checkin version history of a project, open the Teamwork Client and select the project in the project list, then click on the Versions tab.

Figure 9.16 - Versions tab

The Project Version History appears which shows the checkin history of the selected project.

Figure 9.17 - Project Versions History dialog

Field Description Display Select the number of latest versions to display in the project version list A list of project checkin versions, which shows the version number, checkin user name and checkin Project versions date time of each version Open Project Click this button to open the project for viewing Checkin Description A description entered by user for individual check-in Modified model A list of modified model elements in this version elements Modified diagrams A list of modified diagrams in this version Modified diagram A list of modified diagram elements in this version elements Conflicts A list of conflicts found during the checkin process of this version Table 9.7

Closing the Teamwork Client

To close the Teamwork Client , click on the Close button (located at the lower-right corner of the Teamwork Client window).

Closing a Teamwork Client will only hide the Teamwork Client window, the Teamwork Client is still connected to the server. You must log out the Teamwork Client in order to disconnect from the server.

9-18 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

Logout the Teamwork Client

To logout the Teamwork Client , open the Teamwork Client and perform one of the following actions:

• Select the Session > Logout from main menu. • Click on the Logout button on the toolbar

If you exit from VP-UML, you will be logged out of the Teamwork Client automatically.

After you have logged out, you can select Session > Login from the menu or click on the Login button on the toolbar to login again.

9-19 VP-UML User’s Guide (Part 1) Chapter 9 – Team Collaboration

9-20

A Configuring Application Options VP-UML User’s Guide (Part 1) Appendix A – Configuring Application Options

Appendix A - Configuring Application Options

This chapter will describe the configurable Application Options and how they can be configured.

Configuring Application Options using the Application Options Dialog Box

The Application Options can be configured in the Application Options dialog box. To invoke the application dialog, choose Tools > Options... from main menu. The Application Options dialog consists of five pages: General , Diagramming , Diagram/Model View, Instant Reverse and ORM . Each page represents a category of options whose descriptions are described below.

General

The General page of the Application Options dialog box contains general application options, such as auto save options, look and feel configuration and proxy server settings.

Figure A.1 - Application Option (General)

Option Description Project Auto save project Check/Uncheck Auto save project to enable/disable to auto-saving of project file. Click on the Auto save interval (mins) drop down menu and select a time interval for performing Auto save interval (mins): an auto-save at regular time interval. Backup level Set the number of backup copy of project file to maintain. Confirm close project Select this option if you want a dialog asking for confirmation every time you try to close a project. Select this option if you want a dialog asking for confirmation every time you try to delete a Confirm delete diagram diagram. Confirm delete shape Select this option if you want a dialog asking for confirmation every time you try to delete shapes. Open last project on Select if you want VP-UML to load the last opened project on startup. startup Appearance

A-2 VP-UML User’s Guide (Part 1) Appendix A – Configuring Application Options

Look and Feel Click on the Look and feel drop down menu and select a look and feel for the program interface. Click on the Theme drop down menu and select the theme for the selected Look and Feel. The Theme theme setting is only available for "Office 2003 LookAndFeel" . Click on the User Language drop down menu and select a language. This is used for changing the User Language language of the VP-UML program interface. Connection Email Enter the Email field to specify your email address. Check/Uncheck Use Proxy to enable/disable the need of using a proxy server for connecting to the Use Proxy Internet. Host Enter the Host field to specify the host of the proxy server. Port Enter the Port field to specify the port of the proxy server. Enter the Login name field to specify the user name of the proxy server (if the proxy server Login name required the user to login). Enter the Password field to specify the password of the proxy server (if the proxy server required Password the user to login). Printing Use gradient color when Select to use gradient color in printing diagrams. print diagram

Table A.1

Diagramming

The Diagramming page of the Application Options dialog box contains diagram-related options, such as grid settings and anti- aliasing options.

Figure A.2 - Application Option (Diagramming)

Option Description Appearance Show grid Check/Uncheck Show grid to show/hide grid lines. Color Click on the Color field or the ...button beside it to adjust the grid color. Width Enter the Width field to specify the width of the grid. Height Enter the Height field to specify the height of the grid.

A-3 VP-UML User’s Guide (Part 1) Appendix A – Configuring Application Options

Check/Uncheck Snap to grid to set whether diagram elements should/should not stick to Snap to grid grid lines when moving in the diagram Graphics anti-aliasing Check/Uncheck Graphics anti-aliasing to enable/disable smoothing of edges on graphics. Text Anti-Aliasing Check/Uncheck Text anti-aliasing to enable/disable smoothing of text. Select to use either HTML (rich-text) or plain text format in documentation of models and Documentation type diagrams. Click on the Diagram background field or the ... button beside it to adjust the default Diagram background background color of all diagrams. Environment Connector Style Select either Rectilinear or Oblique or Curve for connector style. Select either Round the shape or Follow center to specify how the connecting points of Connection Point Style the connectors should move if the shape is being moved. Select either Case insensitive or Case sensitive to specify the highlight option in Textual Textual Analysis Highlight Analysis, whether to highlight words which are the same as the entered word or/and with Option same case. Select Yes to enable clearing of the opposite side content in flow of event, i.e. In a row within a flow of event, entering text on either Actor Input or System Response result in Clear opposite side content in removing the content of the opposite side). Click No to disable clearing of the opposite side flow of event content in flow of event. Click Prompt to enable prompting for clearing opposite side content every time you enter text on one side for which its opposite side has existing content. Select the diagram alignment guide style to either Show edges (show guides at edges of the Alignment Guide closest shape) or Show center (show a guide that lies on the center of the closest shape). Delay of show Quick Preview in Enter the time (in second) needed for the Quick Preview for being displayed after the Diagram Navigator (second) mouse is hover on any diagram node in Diagram Navigator. Select the default copy action (the action that will be performed when user press hotkey Default Copy Action Ctrl + C in diagram). Show sequence number in Check/Uncheck to enable/disable showing sequence numbers for messages display in collaboration diagram. collaboration diagram. Show sequence number in Check/Uncheck to enable/disable showing sequence numbers for messages display in sequence diagram. sequence diagram. Show shape content when Check/Uncheck to enable/disable showing the content of shapes but not just the outline. dragging Check/Uncheck to enable/disable showing the guide which helps aligning shapes on Show diagram alignment guide diagram. Show Message Operation Signature for Sequence Diagram Select to show operation signature of messages in Sequence Diagram and Communication and Communication Diagram Diagram. (diagram-based) Model Generation Generate Sequence Diagram from Select to allow overwrite of sequence diagram generated from use case description without Use Case Description Overwrite prompt. Existing Diagram Generate Diagram from Scenario Select to allow overwrite of diagram generated from scenario (activity diagram) without Overwrite Existing Diagram prompt. Overwrite Flow of Events when Select to allow overwrite of flow of events of use case description synchronized from Synchronize from Sequence sequence diagram without prompt. Diagram Default generate diagram type Select the default type of diagram to be generated from scenario (activity diagram). from scenario Shape Font Enter the font family of shape text.

A-4 VP-UML User’s Guide (Part 1) Appendix A – Configuring Application Options

Size Enter the font size of shape text. Bold Check/Uncheck to set the shape text to/not to be bold. Italic Check/Uncheck to set the shape text to/not to be italic. Click on the Color field or the ... button beside it to adjust the default font color of all Color shapes. Check/Uncheck to enable/disable extra resource icons in addition to those originally Show extra resources supported. Auto hide resource delay (second) Enter the time interval for hiding resources icons after they have lost focus. Click on the Color field or the ... button beside it to adjust the default fore color of all Shape foreground shapes. Click on the Color field or the ... button beside it to adjust the default background color of Shape background all shapes. Auto fit size (diagram-based) Select to keep shapes in diagram fit-to-size. Pin from Select to pin the "from" end of connector by default. Pin to Select to pin the "to" end of connector by default. Class Check/Uncheck Use model assist to enable/disable the Model Assist feature that allows Use model assist automatic class name completion. Show package structure on model Check/Uncheck to enable/disable displaying also the package name of the list of available assist models when using Model Assist feature. Set the default option for displaying attributes of classes, it can be one of the following: Hide all: All attributes are hidden. Show attribute option Show all: All attributes are shown. Show public only: Only public attributes are shown. Set the default option for displaying operations of classes, it can be one of the following: Hide all: All operations are hidden. Show operation option Show all: All operations are shown. Show public only: Only public operations are shown. The default visibility style for Class. It can either be: Icon - Visibilities are represented by icons). Visibility style UML - Visibilities are represented by UML visibility symbols like + for public, - for private. Off - Visibility is not shown. Show attribute initial value Check/Uncheck to enable/disable the display of initial value of attributes Show attribute multiplicity Check/Uncheck to enable/disable the display of multiplicity of attributes Show operation signature Check/Uncheck to enable/disable the display of operation signature of attributes Check/Uncheck to enable/disable the display of stereotype of class members (e.g. attributes Show class member stereotype and operations) Check/Uncheck to enable/disable the display of the owner of classes and packages (e.g. Show owner of class/package package) Show template parameter Check/Uncheck to enable/disable the display of template parameter of classes. Display as Robustness Analysis Check/Uncheck to enable/disable displaying classes as robustness analysis icon. icon Display as stereotype icon Check/uncheck to enable/disable displaying classes as stereotype icon (if any). Auto-synchronize role name Select to enable auto synchronization of role names of associations. Auto-generate role name Select to enable auto generation of role names when creating associations. ERD Show column type Select to show the data type of table columns in ERD and ORM diagram by default.

Table A.2

A-5 VP-UML User’s Guide (Part 1) Appendix A – Configuring Application Options

View

The View page of the Application Options dialog box contains options related to the view of Diagram Navigator, Model Tree and Class Repository.

Figure A.3 - Application Option (View)

Option Description Diagram Navigator Sort Specify the sort type to use for the Diagram Navigator . It can either be Sort by name (sort by the Type element name, which is the default option) or Sort by type (sort by the element type). Specify the sort type to use for the Model Pane . It can either be No sort , Sort by name (sort by the Model Pane Sort Type element name, which is the default option) or Sort by type (sort by the element type). Class Repository sort Specify the sort type to use for the Class Repository . It can either be Sort by name (sort by the type element name, which is the default option) or Sort by type (sort by the type). Show data types Check/Uncheck to enable/disable the display of data types in the Model Pane . Show relationships Check/Uncheck to enable/disable the display of relationships in the Model Pane . Show sub diagrams Select to show sub diagrams of diagram elements in Diagram Navigator . Show Activation in Select to show activations (sequence diagram) in Diagram Navigator . Diagram Navigator

Table A.3

A-6 VP-UML User’s Guide (Part 1) Appendix A – Configuring Application Options

Instant Reverse

The Instant Reverse page of the Application Options dialog box contains options related to instant reverse for a specific language.

Figure A.4 - Application Option (Instant Reverse)

Option Description .NET Select the availability of Instant Reverse on .NET. It can either be Not Specified , Enabled or Disabled . C++ Select the availability of Instant Reverse on C++. It can either be Not Specified , Enabled or Disabled .

Table A.4

A-7 VP-UML User’s Guide (Part 1) Appendix A – Configuring Application Options

ORM

The ORM page of the Application Options dialog box contains options related to ORM code generation.

Figure A.5 - Application Option (ORM)

Option Description Quote SQL Allows you to specify the usage of quoted name on reserved word. By using Quote SQL Identifier, the Identifier reserved word will be quoted when generating the data definition language and used as an ordinary word.

Table A.5

A-8

Configuring Stereotypes and B Tagged Value VP-UML User’s Guide (Part 1) Appendix B – Configuring Stereotypes and Tagged Value

Appendix B - Configuring Stereotypes and Tagged Value

This chapter explains in detail how to apply Stereotypes and Tagged Value to categorize model elements.

Introduction

Stereotype allows you to categorize different kind of model elements. It may specify additional constraints and tag definitions for the models. It may also be used to indicate a difference in meaning or usage between two model elements with an identical structure. An icon or formatting (fill, line and font) can be specified to a stereotype to present the elements that apply that stereotype. We know that everything in UML contains its own properties. Tagged values let you add properties for specifying keyword- value pairs of model elements. You can define tags that apply to a model element or a stereotype.

Adding Stereotype to a Model Element

Figure B.1 - Class with Stereotypes To add stereotype for a model element:

1. Select the desired model element from the diagram. 2. Right-click on the selection and choose Stereotypes > Stereotypes... from popup menu.

Figure B.2 - Select Stereotype in popup menu

3. This displays the Stereotypes page of the Class Specification dialog box.

Figure B.3 - Class specification dialog (stereotypes)

B-2 VP-UML User’s Guide (Part 1) Appendix A – Configuring Stereotypes and Tagged Value

4. Select a stereotype listed under the All list. 5. Press on > to assign the stereotype to the model element.

Note To assign multiple stereotypes to a model element, press on the ctrl key and select the desired stereotypes and press >> to assign them to the model element.

6. Press OK to apply the setting.

Configuring Stereotypes

Apart from using existing stereotypes, you can create new stereotypes to suit your need. Similarly, you can edit stereotypes to change their properties and appearance in diagram. To configure stereotypes, you must first display the Configure Stereotypes dialog box. Select from main menu Tools > Configure Stereotypes... to display the dialog box.

Figure B.4 - Configure Stereotypes dialog

Command Description Allows you to create a new stereotype for a particular model element by displaying the Stereotype Specification Add dialog box of the new stereotype. Fill in the details of the new stereotype from that dialog box and confirm the changes. A new stereotype is to be created. Allows you to edit an existing stereotype by displaying the Stereotype Specification dialog box of the selected Edit stereotype. Fill in the details of the stereotype from that dialog box and confirm the changes. The properties of that stereotype are to be created. Remove Remove a stereotype available to a particular model element. OK Close the dialog box by committing all changes made. Cancel Close the dialog box without saving any changes made. Help Display the Help content of Configure Stereotypes dialog box.

Table B.1

B-3 VP-UML User’s Guide (Part 1) Appendix A – Configuring Stereotypes and Tagged Value

Creating a New Stereotype

To create a new stereotype:

1. Displays the Configure Stereotypes dialog box. 2. Select the model element for which the new stereotype is to be available to.

Figure B.5 - Model Elements

3. Press on the Add... button. This displays the Stereotype Specification dialog box for specifying the details of the new stereotype.

Figure B.6 - Stereotypes Specification dialog

4. Specify the details of the stereotype such as its name, documentation and its icon. (For more details on the use of Stereotype Specification dialog box, please refer to the following section in this chapter) 5. Click OK to confirm the changes.

The new stereotype is now available to the selected model element.

Figure B.7 - User defined stereotypes

B-4 VP-UML User’s Guide (Part 1) Appendix A – Configuring Stereotypes and Tagged Value

Editing a Stereotype

Figure B.8 - Modify stereotype To edit a stereotype:

1. Displays the Configure Stereotypes dialog box. 2. Select a stereotype from the Stereotypes list for editing. The stereotype can be a predefined one or one defined by you.

Figure B.9 - Select stereotype from the Stereotype list

3. Press on the Edit... button. This displays the Stereotype Specification dialog box for specifying the details of the new stereotype.

Figure B.10 - Edit Stereotype

4. Specify the details of the stereotype such as its name, documentation and its icon. (For more details on the use of Stereotype Specification dialog box, please refer to the following section in this chapter) 5. Click OK to confirm the changes.

If the stereotype is in use by a model element, the appearance of that stereotype is to be refreshed by pressing OK from the Configure Stereotypes dialog box for committing those changes made.

B-5 VP-UML User’s Guide (Part 1) Appendix A – Configuring Stereotypes and Tagged Value

Using the Stereotype Specification Dialog Box

Either you are going to create or going to edit a stereotype you will come across the Stereotype Specification dialog box.

Figure B.11 - Stereotype specification dialog

Field Description Name The name of the stereotype.

Icon Path An image assigned to this stereotype. Click ... to select the path of the image, or click to discard the icon. To specify the appearance of the stereotyped shapes. Their usages will be described in detail in the Stereotype Fill, Line, Font Formats section later in this chapter. Documentation The description or any information relevant to the stereotype. Abstract To specify the stereotype as abstract. Leaf To specify the stereotype as leaf. Root To specify the stereotype as root. Reset Reset all changes made. OK Close the dialog box by committing all changes made. Cancel Close the dialog box without saving any changes made. Apply Committing all changes made. Help Display the Help content of Stereotypes Specification dialog box.

Table B.2

Adding Tagged Value to a Stereotype

To add Tagged Value definitions to a stereotype:

1. Select Tools > Configure Stereotypes... from main menu. This displays the Configure Stereotypes dialog box. 2. Select the desired stereotype and click Edit...

Figure B.12 - Press Rdit button to open Stereotype specification

B-6 VP-UML User’s Guide (Part 1) Appendix A – Configuring Stereotypes and Tagged Value

3. The Stereotype Specification dialog box is displayed. Switch to the Tagged Value Definitions tab.

Figure B.13 - Tagged value definitions

4. Click Add . This displays two kind of tag for selection. One is Text Tag and another is Model Element Tag. Click on the desired one.

Figure B.14 - Tag options

Adding Text Tag to stereotype From the Stereotype Specification dialog box, press Add and then select Text Tag from popup menu.

Figure B.15 - Add Text tag This displays a new Tag entry.

Figure B.16 - A new text tag entry To change the name of the Tag, double click to the Name field and enter a new name.

Figure B.17 - Rename the tag

B-7 VP-UML User’s Guide (Part 1) Appendix A – Configuring Stereotypes and Tagged Value

You can also change the type of Tag from Text to Model Element. To change the type, click on Type field and select a type from popup menu.

Figure B.18 - Change the type of tag To specify a default value of the Tag, double click to the Default Value field and enter a value.

Figure B.19 - Enter the value

Adding Model Element Tag to a stereotype From the Stereotype Specification dialog box, press Add and then select Model Element Tag from popup menu.

Figure B.20 - Add Model Element Tag This displays a new Tag entry.

Figure B.21 - A new model element tag To change the name of the Tag, double click to the Name field and enter a new name.

Figure B.22 - Rename the model element tag You can also change the type of Tag from Text to Model Element. To change the type, click on Type field and select a type from popup menu.

Figure B.23 - Change the type of tag To specify a default value of the Tag, double click to the Default Value field and enter a value.

Figure B.24 - Enter the value of tag

B-8 VP-UML User’s Guide (Part 1) Appendix A – Configuring Stereotypes and Tagged Value

Adding Tagged Value to a Model Element

To add Tagged Value definitions to a model element:

1. Right-click on a model element and select Open Specification... from popup menu.

Figure B.25 - Open specification

2. The specification dialog box is displayed. Switch to the Tagged Value Definitions tab.

Figure B.26 - Actor Specification dialog

3. Click Add . This displays two kind of tag for selection. One is Text Tag and another is Model Element Tag. Click on the desired one.

Figure B.27 - Add Tag options

Adding Text Tag to Model Element From the Stereotype Specification dialog box, press Add and then select Text Tag from popup menu.

Figure B.28 - Add text tag

B-9 VP-UML User’s Guide (Part 1) Appendix A – Configuring Stereotypes and Tagged Value

This displays a new Tag entry.

Figure B.29 - The new text tag To change the name of the Tag, double click to the Name field and enter a new name.

Figure B.30 - The name of tag You can also change the type of Tag from Text to Model Element. To change the type, click on Type field and select a type from popup menu.

Figure B.31 - the type of tag To specify a default value of the Tag, double click to the Value field and enter a value.

Figure B.32 - The value of tag

Adding Model Element Tag to a Model Element From the Stereotype Specification dialog box, press Add and then select Model Element Tag from popup menu.

Figure B.33 - Add Model element Tag This displays a new Tag entry.

Figure B.24 - The blank new model element tag To change the name of the Tag, double click to the Name field and enter a new name.

Figure B.25 - The name of tag

B-10 VP-UML User’s Guide (Part 1) Appendix A – Configuring Stereotypes and Tagged Value

You can also change the type of Tag from Text to Model Element. To change the type, click on Type field and select a type from popup menu.

Figure B.26 - The type of tag To specify a default value of the Tag, double click to the Value field and enter a value.

Figure B.27 - The tag value

Stereotype Formats

You can configure the formats of stereotypes including fill, line and font, so that stereotyped elements can be easily distinguished and emphasized in the diagram.

Configuring Stereotype Formats

1. To configure stereotype formats, select menu Tools > Configure Stereotypes.... 2. In the Configure Stereotypes dialog box, select a model type in Model elements and the target stereotype in Stereotypes . Click the Edit... button.

Figure B.28 - Configure Stereotype dialog

B-11 VP-UML User’s Guide (Part 1) Appendix A – Configuring Stereotypes and Tagged Value

3. The Stereotype Specification is shown.

Figure B.29 - Stereotype Specification dialog

Applying Fill Color

1. To apply fill color to stereotype, select the Use checkbox and click the ... button of the Fill property.

Figure B.30 - Edit fill of stereotype

2. Select a fill color in the Format Fill dialog box and click OK .

Figure B.31 - Format Fill dialog

B-12 VP-UML User’s Guide (Part 1) Appendix A – Configuring Stereotypes and Tagged Value

Applying Line Style

1. To apply line style to stereotype, select the Use checkbox and click the ... button of the Line property.

Figure B.32 - Edit line of stereotype

2. Configure the line style in the Format Line dialog box and click OK .

Figure B.33 - Format Line dialog

Applying Font

1. To apply font to stereotype, select the Use checkbox and click the ... button of the Font property.

Figure B.34 - edit Font

2. Select a font in the Select Font dialog box and click OK .

Figure B.35 - Select Font dialog

B-13 VP-UML User’s Guide (Part 1) Appendix A – Configuring Stereotypes and Tagged Value

After setting a stereotype to a shape, the formats of the stereotype will be applied to the shape immediately.

Figure B.36 - The Modified stereotype

Changing Stereotype Formats

1. Just like configure stereotype formats, open the Configure Stereotypes dialog box and select a model type in Model elements and the target stereotype in Stereotypes . Click the Edit... button to edit its fill, line and font in the Stereotype Specification .

Figure B.36 - Edit the format of stereotype

2. After changed stereotype formats, it is important that you ensure the Apply changes to stereotypes in current project option is selected, otherwise stereotypes already used in the current project will not be updated.

Figure B.37 - apply the change to current project

B-14 VP-UML User’s Guide (Part 1) Appendix A – Configuring Stereotypes and Tagged Value

3. The appearances of shapes that assigned the changed stereotype are updated.

Figure B.38 - Model style updated

B-15 VP-UML User’s Guide (Part 1) Appendix A – Configuring Stereotypes and Tagged Value

B-16

C Supported Mouse Gestures VP-UML User’s Guide (Part 1) Appendix C – Supported Mouse Gestures

Appendix C - Supported Mouse Gestures

General Commands

Show Diagrams Thumbnail Layout Diagram Open Diagram Specification Close Diagram View

Activity Diagram (UML 2.0)

Initial Node/Final Node (If there is no Initial Node, an Action Activity Decision Node Initial Node will be created. Else if there is no Final Node, a Final Node will be created)

Activity Diagram (UML 1.x)

Horizontal Synchronization Action State Sub-Activity Swimlane Bar

Initial State/Final State(If there is no Initial State, an Vertical Synchronization Bar Initial State will be created. Else if there is no Final State, a Final State will be created)

Class Diagram

Synchronize to ERD Class Package

Communication Diagram

Synchronize to Sequence Lifeline Actor Package Diagram

C-2 VP-UML User’s Guide (Part 1) Appendix C – Supported Mouse Gestures

Component Diagram

Component Instance Specification Package

Composite Structure Diagram

Class Interface Collaboration Collaboration Use

Deployment Diagram

Node Component Node Instance Package

EJB Diagram

Synchronize to ERD Entity Bean Message-Driven Bean Session Bean

Package

Entity Relationship Diagram

Synchronize to Class Diagram Entity

Interaction Overview Diagram

Initial Node/Final Node(If there is no Initial Node, an Interaction Decision Node Initial Node will be created. Else if there is no Final Node, a Final Node will be created)

C-3 VP-UML User’s Guide (Part 1) Appendix C – Supported Mouse Gestures

Object Diagram

Instance Specification Class Package

ORM Diagram

Class Entity Package

Overview Diagram

Diagram Overview

Package Diagram

Package

Sequence Diagram

Synchronize to Lifeline Actor Alt Combined Fragment Communication Diagram

Loop Combined Fragment

State Machine Diagram (UML 2.0)

Initial Node/Final Node(If there is no Initial Node, an State Submachine State Initial Node will be created. Else if there is no Final Node, a Final Node will be created)

C-4 VP-UML User’s Guide (Part 1) Appendix C – Supported Mouse Gestures

State Machine Diagram (UML 1.x)

Horizontal Synchronization State Concurrent State Submachine State Bar

Initial State/Final State(If there is no Initial State, an Vertical Synchronization Bar Initial State will be created. Else if there is no Final State, a Final State will be created)

Timing Diagram

Frame

Use Case Diagram

Use Case Actor Package

C-5 VP-UML User’s Guide (Part 1) Appendix C – Supported Mouse Gestures

C-6

D Keyboard Shortcuts VP-UML User’s Guide (Part 1) Appendix D – Keyboard Shortcuts Gestures

Appendix D - Keyboard Shortcuts

Action Hot Key Description To create either a new UML 1.x or a new UML 2.0 project. The Create New Project dialog box New Project... Ctrl-N will appear which allows you to create a blank project, a project created from existing project templates, or import from other CASE tool project files. Open Project... Ctrl-O To open an existing project. To save the current project. If the project is a new one, this operation is equivalent to "Save Save Project Ctrl-S Project as... Ctrl-Shift- New Diagram... To create a new diagram. N To print selected diagrams in the current project. A new dialog box will be presented, allowing Print... Ctrl-P you to select the diagrams to be printed, as well as configuring various printing options. Undo Ctrl-Z To undo the last action that you performed. Redo Ctrl-Y To redo the last action that you performed. Repeat Create... F3 To repeat create last shape. To cut the selected diagram elements from the diagram and copy them to the application Cut Ctrl-X clipboard. To perform the copy action as configured in the VP-UML application options (Options dialog Default Copy Ctrl-C box -> Diagramming category -> Environment page). The default "default copy" action is Copying within VP-UML. To copy the selected diagram elements from the diagram to the system clipboard. The diagram Copy to Ctrl-Shift- elements can then be pasted to OLE containers like Word, Excel and Powe rPoint, which can be Clipboard as OLE C edited directly. Copy to Clipboard as Ctrl-Alt-C To copy the selected diagram elements as a JPG image to the system clipboard. Image (JPG) Copy to Ctrl-Alt- Clipboard as To copy the selected diagram elements as an EMF image to the system clipboard. Shift-C Image (EMF) Duplicate Ctrl-E To duplicate the selected diagram elements. Paste View Ctrl-V To paste the contents of the application clipboard to the drawing pane. Delete Delete To delete the selected diagram elements from the diagram. Select All Ctrl-A To select all the diagram elements from the current diagram. Deselect Ctrl-D To deselect all diagram elements. Find Ctrl-F To find elements (model elements and diagram elements) in the current project. Jump to Element in Active Ctrl-J To jump to an element in the active diagram. Diagram... To jump to an element in the project. If the selected element belongs to a diagram, this diagram Jump to Ctrl-Shift-J will be opened, and the element will be selected and centered in the diagram. If the selected Element... element is a model that does not have a view, it will be selected in the Model pane. To organize shapes in group. The group can manipulate related shapes together (select, Group Ctrl-G deselect, move, align and resize). Ctrl-Shift- Ungroup To ungroup the grouped shapes in diagram. G To display the Align Shapes dialog box that allows you to configure the top/bottom, left/right Align Shapes F12 alignments and same width/same height options all at a time.

D-2 VP-UML User’s Guide (Part 1) Appendix D – Keyboard Shortcuts

Ctrl-Shift- Show Diagram Navigator To open/activate the Diagram Navigator. I Ctrl-Shift- Show Model Pane To open/activate the Model Pane. O Ctrl-Shift- Show Class Repository To open/activate the Class Repository Pane. L Ctrl-Shift- Show Logical View To open/activate the Logical View Pane. A Ctrl-Shift- Show ORM Pane To open/activate the ORM Pane. R Ctrl-Shift- Show Stencil Pane To open/activate the Stencil Pane. S Ctrl-Shift- Show Property Pane To open/activate the Property Pane. P Show Diagram Overview Ctrl-Shift- To open/activate the Diagram Overview Pane. Pane V Show Documentation Ctrl-Shift- To open/activate the Documentation Pane. Pane U Ctrl-Shift- Show Message Pane To open/activate the Message Pane. M Toggle Show Resources Ctrl-R To toggle the visibility of resources. To toggle the full screen mode (display only the Toolbar and the Diagram Pane, all the Full Screen F11 other UI components will be hidden). Ctrl- Zoom In To magnify the diagram by 10%. Equals Ctrl- Zoom Out To diminished the diagram by 10%. Minus Zoom 100% (Actual Ctrl-0 To view the diagram in its actual size. Size) Previous Diagram Alt-Left To switch to the previous diagram. Next Diagram Alt-Right To switch to the next diagram. Ctrl-Shift- Switch to Diagram... To manage windows by selecting windows to close, and/or activate a selected window. E Close Active Window Ctrl-W To close the active window. Ctrl-Shift- Close All Windows To close all opened the windows. W Open Specification... Enter To open the specification of active diagram or diagram element

Table D-1

Classes Action Hot Key Description Add Attribute Alt-Shift-A To add a attribute to a currently selected Class Add Operation Alt-Shift-O To add an operation to a currently selected Class

Table D-2

D-3 VP-UML User’s Guide (Part 1) Appendix D – Keyboard Shortcuts

Entities

Action Hot Key Description New Column Alt-Shift-C To add a new column to an currently selected Entity or ResultSet

Table D-3

D-4

E Glossary VP-UML User’s Guide (Part 1) Appendix E - Glossary

Appendix E - Glossary

A Activity diagrams are an amalgamation of a number of techniques: Jim Odell's event diagrams, SDL state modeling techniques, workflow modeling and petri-nets. They can also be considered as variants of state Activity diagram diagrams. Activity diagrams are organized according to actions and mainly target towards representing the internal behaviors of a method or a use case. They describe the sequencing of activities, with support for both conditional and parallel behaviors. Actor input In editing flow of event, an actor input is the input from an actor to the system. Align to grid Whether diagram elements should align to grid when being moved. Anti-aliasing A method which handles the staircase pixels of slanted lines and curves to make them look smoother. Application The global options in VP-UML. Options VP-UML provides an auto save feature that saves a copy of the current project periodically. If the Auto save application terminates abnormally, with this feature turned on, when you start VP-UML again the system will check if an auto save file exists. If so, it will ask you whether you want to recover the project. Automatic A facility to automatically detect the containment rule for a container. For example, an Actor will not be containment rule contained in the System Boundary even if they are moved into the container's region. detection B Every time you save a project a backup file will be created. The backup file name is determined by the Backup files original project file name, followed by a "~" and the version number. A backup file with a larger version number means that it is more recent than those with smaller version numbers. The diagram toolbar groups some of the diagram elements that are similar in nature. For example, Package and Subsystem are grouped into a single button group. Buttons that are grouped are indicated by a small Button group triangle on the lower-right-hand corner. To view the list of items under the group click on the small triangle, or click on the button and hold until the selection list appears. C Candidate Class The candidate class pane, located at the upper-right corner of the textual analysis pane, displays the Pane candidate classes as rectangle shapes. In performing textual analysis, the Candidate Class View hides the Problem Statement Editor and only Candidate class displays the Candidate Class Pane and the Data Dictionary Table. It allows you to concentrate on further view editing of the identified candidate classes, such as specifying the candidate class type or creating models. Cascade Arrange the opened windows diagonally, with the active window on top. Class diagrams are the most common diagram found for modeling object-oriented systems. They are used to describe the types of objects and their relationships by providing a static, structural view of a system. Class diagram They are important not only for visualizing, specifying, and documenting structural models, but also for constructing executable systems through forward and reverse engineering. A project may contain many classes. The Class Repository View lists all the classes within the current Class repository project. Collaboration diagrams emphasize the organization of objects that are involved in an interaction. Collaboration Collaboration is a mechanism composed of both structural and behavioral elements. Two important diagram features - the concept of a path and the sequence number - distinguish collaboration diagrams from sequence diagrams. Component Component diagrams show the various components (physical modules of code) in a system and their diagram dependencies. A component can often be the same as a package. To copy the selected diagram elements to the system clipboard as image. This feature is supported in both Copy as image the Windows platform and the Linux platform. To copy the selected diagram elements to the system clipboard as OLE objects, so that the copied content Copy to system can be pasted to OLE containers like Microsoft Word/Excel/PowerPoint. And you can directly edit the clipboard OLE object inside the document. This feature is supported in Windows platform only.

E-2 VP-UML User’s Guide (Part 1) Appendix E - Glossary

Copy within VP- To copy the selected diagram elements to the application clipboard. You can then paste the diagram UML elements to other VP-UML diagrams. D The data dictionary table, which located at the lower-right area of the textual analysis pane, provides a Data dictionary table view for the candidate classes. It displays all the information of a candidate class. You can edit its table name and type, as well as adding description to the candidate class. Data dictionary In performing textual analysis, the Data Dictionary View displays only the Data Dictionary Table. It view allows you to concentrate on filling the candidate class information in the data dictionary. Deployment diagrams show the physical layout and relationships among software and hardware Deployment components in the implemented system. It shows how components and objects are routed and moved diagram around a distributed system. In the print preview pane, if the Fit to Pages option is selected, and there are multiple pages in the printout, Diagram base selecting Diagram Base Layout will cause the distribution of pages to be diagram-oriented. Note that this layout option affects the preview only, the order of the printout remains unchanged. Diagram element A diagram element is a shape or a connector that represent the view of its underlying model element. Diagram exporter The diagram exporter allows you to export selected diagrams as images in JPG, PNG or SVG format. Diagram pane The diagram pane contains the opened diagrams; it allows you edit multiple diagrams at the same time. The diagram toolbar contains the buttons of the diagram elements available for developing the active Diagram toolbar diagram. A project may consist of many diagrams. The Diagram Navigator lists all the diagrams within the project. Diagram navigator Through the use of a folding tree structure, you can browse the names of these diagrams by expanding or collapsing the folders and perform sorting by diagram type. When generating HTML/PDF reports, the document info (such as title, author, keywords) you specified Document info becomes the meta data of the report. Users can open the HTML source/PDF document summary to view this information. Documentation The Documentation pane allows you to enter a description about a diagram or a diagram element. pane E Extra Resource- By default, the resource-centric interface displays the most commonly used resources of a diagram Centric element. The least commonly used resources are hidden by default, and they are called the extra resources. F Flow of event A section in the use case description for editing the base paths and the alternative paths in a use case. H HTML report To generate report for the VP-UML project in HTML format. generation J Java-enabled Any platforms that have Java runtime installed and thus able to run Java programs. platforms L A feature to layout the shapes so that they do not overlap, and to layout the connectors so that they do not Layout diagram cross with one another. The license key is a file that you import using the License Key Manager so that you can start using VP- License key UML. License Key The License Key Manager allows you to manage the license key files of Visual Paradigm products. Manager The Logical View refers to a user's view of the way project is organized. It provides another view of Logical View creating, structuring and sharing the UML diagrams and models apart from the traditional Diagram Navigator, Model Tree View and Class Repository. Look and Feel The appearance of VP-UML user interface.

E-3 VP-UML User’s Guide (Part 1) Appendix E – Glossary

M The message pane logs the messages for the operations that you performed. For example, Java language Message pane syntax checking, model validation, report generation, etc. A model element stores the model data. A diagram element associates a model element, and a model Model element element may be associated with more than one diagram element (multiple views). Model repository The repository where the model elements are stored. The Model Tree View lists all the model elements within the current project. Model elements can be Model tree view dragged to appropriate diagrams to create a new diagram element. Model validation A process to validate the models against UML syntax. O OLE An object that supports the OLE protocol for object linking and embedding. The open specification dialog of a diagram allows you to configure the diagram settings, such as the Open specification diagram name and grid settings; while the open specification dialog of a model element allows you to dialog configure its model data. Display a list of classes and database tables from the specified classpath (s) and database (s). You can click Refresh to update the content under Class View and DataBase View whenever there are changes to ORM Pane source code or database. You can drag classes or entities onto diagrams and generate source code/database from them when necessary. P If the Fit to Pages option is selected, and there are multiple pages in the printout, selecting Paper Base Paper base layout Layout will cause the distribution of pages to be paper-oriented (the diagram size is ignored in arranging the preview). Note that this option affects the preview only; the order of the printout remains unchanged. To change the order of the printout. Consider a large diagram is divided into many pages, selecting From left to right will arrange the printout order from the pages on the left to the pages on the right, while Paper place style selecting From top to bottom will arrange the print order from the pages on the top to the pages on the bottom. Pattern watermark The watermark that repeats the product name diagonally in the printout, exported image or copied content. PDF report To generate report for the VP-UML project in PDF format. generation The Preview pane, also known as the Diagram Monitor, shows an overall view of the diagram. The Preview pane Diagram Monitor allows you to navigate the whole diagram pane when the diagram is larger than the display area of the diagram pane. The print preview pane allows you to configure various print settings, preview the printout and print the Print preview pane diagrams. Problem statement A description about the problem to investigate. Problem statement The problem statement editor is the text editor located on the left of the text analysis pane, which allows editor you to view and edit the problem statement. Problem statement The Problem Statement View displays the Problem Statement Editor, the Candidate Class Pane and the view Data Dictionary Table; it allows you to concentrate on editing the problem statement. The project explorer pane contains three views: the Diagram Navigator, the Model Tree View, and the Project explorer Class Repository View. Each view shows different perspectives of the project. There are four pages associated with the Properties Pane: the Property page, the Preview page, the Properties pane Documentation page and the Element Viewer page. Every diagram and diagram element has its own properties. The Property pane in the Properties Pane Property pane allows you to view and edit various its properties. Q Quick Print To print diagrams without previewing them hence speeds the print job. R Realistic containment A specific effect to indicate a diagram element moving in/out of a container. interaction

E-4 VP-UML User’s Guide (Part 1) Appendix E - Glossary

When there are multiple shapes selected, the last selected shape will be used as the referenced shape for Reference shape alignment. That is, the alignment methods will be performed based on the position/size of the referenced for alignment shape. The referenced shape will be rendered with its resize handles surrounded by black rectangles. Report Writer A feature for performing agile report creation. A user interface based on the Resource-Centric approach is adopted in VP-UML to enable UML diagrams Resource-centric to be constructed intuitively with minimal efforts. With the novel interface, only valid editing resources are grouped around a graphical entity, totally eliminating invalid operations during diagram construction. The Rose importer allows you to import a Rational Rose project file and convert it as the diagrams and Rose importer models into your VP-UML project. Round trip Round trip engineering is the process to convert from diagram to code, and to convert from code to engineering diagram. S If you have resized the diagram pane to the extent that some of the buttons on the diagram toolbar are not Scrollable toolbar visible, an "Up" button and a "Down" button will appear. You can click on these buttons to scroll up or down to the desired buttons on the toolbar. Sequence diagram captures the behavior of a single use case and displays a number of example objects, as well as the messages that are passed between these objects within the use case from a temporal standpoint. Sequence diagram There are two important features, which are the object lifeline and the focus of control that distinguish them from collaborative diagrams. Single line The watermark that prints a single line of the product name in the printout, exported image or copied watermark content. State diagrams, sometimes referred to as state chart diagrams, are a common technique to describe the dynamic behavior of a system. They represent state machines from the perspective of states and State diagram transitions, describing all the possible states that a particular object can get into and how the object's state changes as a result of events that affect the object. In most Object-Oriented techniques, state diagrams are drawn for a single class to show the lifetime behaviors of a single object. Although the original UML notations are rich, but still may not expressive enough to present your idea. The stencil in VP-UML provides a large variety of shapes apart from the ordinary UML notations, and Stencil Pane you can place the stencil in UML diagram to present your own idea. Stencil Pane is a repository where the imported those shapes are stored. The stereotype concept provides a way of classifying (marking) elements so that they behave in some Stereotype respects as if they were instances of new "virtual" metamodel constructs. A facility to associate a diagram with other lower level UML diagrams to facilitate levels of abstraction Sub-diagrams and increase the traceability among UML diagrams. System response In editing flow of event, a system response is the response from the system (to an actor input). T Textual analysis is a process to analyze the system domain. It helps to identify the candidate classes in a Textual analysis problem statement. Tile Arrange the opened windows so that all windows are visible at the diagram pane. Arrange the opened windows horizontally. The windows are resized to share the available workspace Tile horizontally height, without overlapping each other. Arrange the opened windows vertically. The windows are resized to share the available workspace width, Tile vertically without overlapping each other. U The Unified Modeling Language (UML) is a language for specifying, visualizing, constructing, and documenting the artifacts of software systems, as well as for business UML modeling and other non-software systems. The UML represents a collection of the best engineering practices that have proven successful in the modeling of large and complex systems. Use case A use case description describes the use case, including the preconditions, post-conditions, flow of events, description etc. Use case detail A use case detail holds one or more use case description.

E-5 VP-UML User’s Guide (Part 1) Appendix E – Glossary

Use case diagrams, together with activity diagrams, state diagrams, sequence diagrams and collaboration diagrams, are the five diagrams in UML for modeling the dynamic aspects of a system. Invented by Ivar Use case Jacobson, use case diagrams are central to modeling the behaviors of the system, a sub-system or a class, diagram providing a means to visualize, specify and document the behaviors of an element. They describe the behavior of a system from a user's perspective by using actions and reactions. A use case shows the relationships between actors and objects, and between the system and its environment. Use case To schedule the use cases by assigning priorities. scheduling V Visio VP-UML allows you to create Visio drawing in UML diagrams. Besides, you can also import Visio stencil into integration VP-UML and use the Visio shape in UML diagrams. Visual Paradigm Abbreviated as VP-Suite, Visual Paradigm Suite allows you to install all Visual Paradigm leading CASE Tools. Suite X XMI The XMI importer imports the models from an XMI file into a VP-UML project. importer

Table E.1

E-6