View source for Visual Paradigm Installation and User's Guide

'''READ ME FIRST'''
*This tutorial '''<span style="color: rgb(224, 62, 45);">only</span> '''applies to the '''WINDOWS '''operating system, other operating systems have not yet been verified.
*This tutorial is based on this [https://circle.visual-paradigm.com/docs/ website] with simplifications and modifications. You can visit that website for more detailed UML information and guidelines.
*Contact Shuokai Ma ([mailto:s214919@student.dtu.dk s214919@student.dtu.dk]) if you find a problem or have suggestions for this Wiki.
= Visual Paradigm Installation =
== Download, Install and Activate Visual Paradigm ==

#Download the latest version of [https://www.visual-paradigm.com/download/ Visual Paradigm], and then install the Visual Paradigm by following the instructions of the installation wizard.
#Start <span class="notranslate">Visual Paradigm. When you see the following screen, select '''Subscription/Academic License'''.[[File:Choose subscription 26064.png|500px|center|thumb|Select Subscription / Academic License]]</span>
#Expand '''Academic Training Partner Program License'''.
#Copy the activation code from '''DTU Learn (Under Content -'''&gt;''' UML Modelling Tools -'''&gt;''' Visual Paradigm Academic License)'''.
#Paste the activation code to the textbox called Activation Code. And then enter your name and student email address (sxxxxxx@student.dtu.dk).[[File:Activation code 26065.png|500px|center|thumb|Activating Visual Paradigm]]
#Click '''Activate'''. You are prompted for an activation code.
#Go to your email inbox and Check your new email for the verification code.
#Copy the verification code and paste it to <span class="notranslate">Visual Paradigm</span>.[[File:Enter verification code 26066.png|500px|center|thumb|Pasting the verification code]]
#Click '''OK '''to confirm. <span class="notranslate">Visual Paradigm </span>will be activated if the verification code is valid.
= Visual Paradigm User's Guide =
<p class="mwt-heading">In order to create a diagram, you need first to create a project.</p>

== Create your first project in Visual Paradigm ==
To create a project, select '''Project -&gt; New''' from the toolbar.[[File:Create a new project 33403.png|500px|center|thumb|Create a new project]]

The '''New Project''' window appears.[[File:An overview of new project window 33404.png|500px|center|thumb|An overview of New Project window]]
{| class="wikitable" style="border-collapse: collapse; width: 100%; height: 184px;"
|- style="height: 23px;"
| style="width: 7.59245%; height: 23px; text-align: center;" | '''No.'''
| style="width: 22.3256%; height: 23px; text-align: center;" | '''Name'''
| style="width: 70.0818%; height: 23px; text-align: center;" | '''Description'''
|- style="height: 23px;"
| style="width: 7.59245%; height: 23px; text-align: center;" | 1
| style="width: 22.3256%; height: 23px;" | Name
| style="width: 70.0818%; height: 23px;" | The name of the project.
|- style="height: 23px;"
| style="width: 7.59245%; height: 23px; text-align: center;" | 2
| style="width: 22.3256%; height: 23px;" | Author
| style="width: 70.0818%; height: 23px;" | The person who creates the project.
|- style="height: 23px;"
| style="width: 7.59245%; height: 23px; text-align: center;" | 3
| style="width: 22.3256%; height: 23px;" | Data type set
| style="width: 70.0818%; height: 23px;" | It lets you select the programming/scripting language for the project. The language you selected mainly affects class modelling. For example, the selectable visibilities and primitive types vary among languages.
|- style="height: 23px;"
| style="width: 7.59245%; height: 23px; text-align: center;" | 4
| style="width: 22.3256%; height: 23px;" | Description
| style="width: 70.0818%; height: 23px;" | The project description.&nbsp;
|- style="height: 23px;"
| style="width: 7.59245%; height: 23px; text-align: center;" | 5
| style="width: 22.3256%; height: 23px;" | Create Project Management Lookup
| style="width: 70.0818%; height: 23px;" | Check it to automatically fill the project management lookups such as iteration, version, etc with default lookup values.
|- style="height: 23px;"
| style="width: 7.59245%; height: 23px; text-align: center;" | 6
| style="width: 22.3256%; height: 23px;" | Create Blank Project
| style="width: 70.0818%; height: 23px;" | Click to create the project.
|- style="height: 23px;"
| style="width: 7.59245%; height: 23px; text-align: center;" | 7
| style="width: 22.3256%; height: 23px;" | Cancel
| style="width: 70.0818%; height: 23px;" | Click to cancel creating the project, and close the window.
|}
Enter the name of the project and your name. And then you should choose '''UML''' as the Data type set and click '''Create Blank Project'''. When you have created the project, '''please first [[#Save the current project|save the current project]]''', since the autosave function will be enabled if you do that.&nbsp;
== UML modelling ==
This tutorial contains only the UML diagrams required for the course - Use Case Diagram, Class Diagram, Sequence Diagram & CRC Card Diagram

=== Use Case Diagram ===

<p>Perform the steps below to create a UML use case diagram in <span class="notranslate">Visual Paradigm</span>.</p>
#Select '''Diagram -&gt; New '''from the application toolbar.
#In the '''New Diagram''' window, search and select''' Use Case Diagram''', and then click '''Next'''.
#You can '''choose''' to create a blank diagram or use the template. We choose to '''create a blank diagram''' here.&nbsp;
#'''Enter''' the diagram name and maybe also the description. The '''Location''' field enables you to select a model to store the diagram. We are '''not''' going to change this value right now.
#Click '''OK'''.
[[File:Create a new use case diagram.png|500x500px|center|thumb|Create a new use case diagram]]

==== Drawing a system ====
To create a system in the use case diagram, select '''System''' on the diagram toolbar and then click it on the diagram pane. Finally, name the newly created system when it is created.[[File:Create a system 25217.png|200px|center|thumb|Create a system]]
==== Drawing an <span class="notranslate">actor</span> ====
<span class="notranslate">To draw an actor in a use case diagram, select '''Actor''' on the diagram toolbar and then click it on the diagram pane. Finally, name the newly created actor when it is created.</span>

<span class="notranslate"></span>[[File:Creatre an actor 25218.png|300px|center|thumb|Create an actor]]
==== Drawing a use case ====
You can then create a use case through Resource Catalog by doing the following:
#Move the mouse over a source shape (e.g. an actor).
#Press on the '''Resource Catalog''' button and drag it out.[[File:Resource catalog 26845.png|300px|center|middle|thumb|Resource Catalog]]
#Release the mouse button until it reaches your preferred place. (In the system box)[[File:Release the mouse button in the system box.png|200px|center|middle|thumb|Release the mouse button in the system box.]]
#Select '''Association -&gt; Use Case''' from Resource Catalog.[[File:Create use case from resource catalog 26846.png|300px|center|middle|thumb|To create a use case]]
#The source shape and the newly created use case are connected. Finally, name the newly created use case.[[File:Use case created 26847.png|300px|center|middle|thumb|Use Case created]]

=== Class Diagram ===
<p>Perform the steps below to create a UML class diagram in <span class="notranslate">Visual Paradigm</span>.</p>
#Select '''Diagram -&gt; New '''from the application toolbar.
#In the '''New Diagram''' window, search and select''' Class Diagram''', and then click '''Next'''.
#You can '''choose''' to create a blank diagram or use the template. We choose to '''create a blank diagram''' here.&nbsp;
#'''Enter''' the diagram name and maybe also the description. The '''Location''' field enables you to select a model to store the diagram. We are '''not''' going to change this value right now.
#Click '''OK'''.
[[File:Create a new class diagram.png|300px|center|thumb|Create a class diagram]]

==== Creating a class ====
To create a class in a class diagram, click '''Class''' on the diagram toolbar and then click on the diagram.[[File:Create class 25122.png|300px|center|thumb|Create class]]

Then a class will be created.[[File:Class created 26923.png|300px|center|thumb|Class created]]
==== Creating an attribute ====
To create an attribute, right-click the class and select '''Add -&gt; Attribute''' from the pop-up menu.[[File:Create attribute 25124.png|300px|center|thumb|Create attribute]]

Then an attribute is created.[[File:Attribute created 2538.png|300px|center|thumb|Attribute created]]

You can modify the speciation of the attribute by right-clicking the attribute and selecting '''Open Specification''' from the pop-up menu.[[File:Attribute specification.png|300px|center|thumb|Attribute Specification ]]

==== Creating an operation ====
To create an operation, right-click the class and select '''Add -&gt; Operation '''from the pop-up menu.[[File:Create operation 25125.png|300px|center|thumb|Create operation]]

Then an operation is created.[[File:Operation created 2541.png|300px|center|thumb|Operation created]]

You can modify the speciation of the attribute by right-clicking the operation and selecting '''Open Specification''' from the pop-up menu.[[File:Operation specification.png|300px|center|thumb|Operation Specification]]

==== Creating an association ====
You can create an associated class in a class diagram by doing the following:
#Move your mouse pointer over the source shape.
#Press on the '''Resource Catalog''' button and drag it out.[[File:Using resource catalog 26921.png|300px|center|thumb|Using Resource Catalog]]
#Release the mouse button at the place where you want the class to be created. If you want to connect to an existing class, drop at that class. Otherwise, drop at the empty space (either at the diagram background or container shape like package).
#If you are connecting to an existing class, select '''Association''' from '''Resource Catalog'''. If you are creating a new class, select '''Association -&gt; Class''' from '''Resource Catalog'''. If you want to create an aggregation or composition, select '''Aggregation -&gt; Class or Composition -&gt; Class''' instead.[[File:Create associated class 26922.png|300px|center|thumb|To create a class]]
#If you are creating a new class, you should see the class now and it is connected to the source shape. Enter its name and press '''Enter''' to confirm editing.[[File:Associated class created 26917.png|300px|center|thumb|Associated class created]]

===== The navigability of the association =====
To edit the navigability of an association end, right-click near the association end, select '''Navigable''' from the popup menu and then select the '''true''' value.[[image:edit_navigability_25126.png|500px|center|thumb|Edit navigability]]

===== The multiplicity of the association =====
To edit the multiplicity of an association end, right-click near the association end, select '''Multiplicity''' from the popup menu and then select a multiplicity.[[File:Edit multiplicity 25126.png|500px|center|thumb|Edit multiplicity]]
===== The direction of the association =====
To show the direction of an association, right-click on it and select '''Presentation Options -&gt; Show Direction''' from the pop-up menu.[[File:Show direction 25123.png|500px|center|thumb|Show direction]]
==== Creating a generalization ====
You can create a subclass by doing the following:
#Move your mouse pointer over the superclass.
#Press on the '''Resource Catalog''' button and drag it out.[[File:Using resource catalog 26918.png|300px|center|thumb|Using Resource Catalog]]
#Release the mouse button at the place where you want the subclass to be created. If you want to connect to an existing class, drop at that class. Otherwise, drop at the empty space (either at the diagram background or container shape like package).
#If you are connecting to an existing class, select '''Generalization''' from Resource Catalog. If you are creating a new class, select '''Generalization -&gt; Class''' from Resource Catalog.[[File:Select generalization 26919.png|300px|center|thumb|To create a subclass]]
If you are creating a new class, you should see the class now and it is connected to the source shape with a generalization. Enter its name and press '''Enter''' to confirm editing.[[File:Subclass created 26920.png|300px|center|thumb|Subclass created]]
==== Creating a dependency from/to attribute/operation ====
You can also add a dependency from and/or to an attribute or operation in class by doing the following:
#Select '''Dependency''' from the diagram toolbar.[[File:Select dependency 27435.png|300px|center|thumb|Dependency]]
#Press on the source shape or a class member.[[File:To press on source element 27432.png|300px|center|thumb|To press on the source operation]]
#Drag to the target shape, or a class member.[[File:Dragging to class member 27433.png|300px|center|thumb|Dragging to the target attribute]]
#Release the mouse button to create the dependency.[[File:Dependency created 27434.png|300px|center|thumb|Dependency created between an operation and a member]]

=== Sequence Diagram ===
<p>Perform the steps below to create a UML sequence diagram in <span class="notranslate">Visual Paradigm</span>.</p>
#Select '''Diagram -&gt; New '''from the application toolbar.
#In the '''New Diagram '''window, search and select''' Sequence Diagram''', and then click '''Next'''.
#You can '''choose''' to create a blank diagram or use the template. We choose to '''create a blank diagram '''here.&nbsp;
#'''Enter '''the diagram name and maybe also the description. The '''Location '''field enables you to select a model to store the diagram. We are '''not '''going to change this value right now.
#Click '''OK'''.
[[File:Sequence diagram.png|500px|center|thumb|Create a new sequence diagram]]
==== Creating an <span class="notranslate">actor</span> ====
<span class="notranslate">To create an actor, click '''Actor''' on the diagram toolbar and then click on the diagram.</span>

<span class="notranslate"></span>[[File:Create actor 25230.png|300px|center|thumb|Create an actor]]
==== Creating a lifeline ====
To create a lifeline, you can use '''Resource Catalog''':
#Move your mouse pointer over the source lifeline.
#Press on the '''Resource Catalog''' button and drag it out.[[File:Create lifeline 26851.png|300px|center|thumb|Using Resource Catalog]]
#Release the mouse button at the place where you want the lifeline to be created.
#Select '''Message -&gt; LifeLine''' from Resource Catalog.[[File:Select message 26852.png|500px|center|thumb|To create a lifeline]]
#A new lifeline will be created and connected to the actor/lifeline with a message. Enter its name and press '''Enter''' to confirm editing.[[File:Lifeline created 26853.png|400px|center|thumb|Lifeline created]]

==== Auto extending activation (Add a new message / Add a new activation) ====
When creating a new message between lifelines/actors, activation will be automatically extended.[[File:Extend activation 2117.png|300px|center|thumb|Auto extending activation]]

If you want to split the newly created activation into two or more, you can check the section '''[[#Spitting overlapping execution (activation)|Spitting overlapping execution (activation)]] '''below.

==== Spitting overlapping execution (activation) ====
You can split the overlapping execution (activation) by '''right-clicking''' the execution and selecting '''Spit Overlapping Execution'''.[[File:Spilt overlapping execution.png|500px|center|thumb|Spitting overlapping execution (activation)]]

Then the overlapping execution is split.[[File:Overlapping execution split.png|500px|center|thumb|The overlapping execution is split]]

=== CRC Card Diagram ===
<p>Perform the steps below to create a UML CRC card diagram in <span class="notranslate">Visual Paradigm</span>.</p>
#Select&nbsp;'''Diagram -&gt; New&nbsp;'''from the application toolbar.
#In the&nbsp;'''New Diagram&nbsp;'''window, search and select''' CRC Card Diagram''', and then click&nbsp;'''Next'''.
#You can&nbsp;'''choose'''&nbsp;to create a blank diagram or use the template. We choose to&nbsp;'''create a blank diagram&nbsp;'''here.&nbsp;
#'''Enter&nbsp;'''the diagram name and maybe also the description. The&nbsp;'''Location&nbsp;'''field enables you to select a model to store the diagram. We are&nbsp;'''not&nbsp;'''going to change this value right now.
#Click&nbsp;'''OK'''.
[[File:CRC card.png|500px|center|thumb|Create a new CRC card diagram]]
==== Creating CRC card ====
Click CRC Card on the diagram toolbar and then click on the diagram to create a CRC card. You can create as many as CRC card on a diagram by repeating this step.[[File:Click crc card 9973.png|300px|center|thumb|Create CRC card]]
==== Editing CRC card properties ====
All properties in a CRC card must be edited inline. To edit, double-click on the desired field, update its value and click on the diagram background to confirm editing.[[File:Edit description 9975.png|500px|center|thumb|Edit description]]
==== Adding attributes ====
Right-click on the '''Attributes''' heading and select '''Add -&gt; Attribute''' from the pop-up menu.[[File:Copy of 02 add attribute1 25314.png|500px|center|thumb|Add attribute]]

Enter the name and description. Repeat this step until all attributes are added.[[image:attribute_added_9977.png|500px|center|thumb|Attribute added]]
==== Adding responsibilities ====
Right-click on the '''Responsibilities''' heading and select '''Add -&gt; Responsibility''' from the pop-up menu. Similar to creating an attribute, enter the name and collaborator of each responsibility to show the relationship with other parties.[[File:Copy of 03 add responsibility1 25315.png|500px|center|thumb|Add responsibility]]

== Export the diagram as an image ==
You can export the opening diagram to an image file by doing the following:
#Select '''Project -&gt; Export -&gt; Active Diagram as Image...''' from the toolbar.
#In the '''Save''' window, set the image quality. The higher the quality, the clearer the image, and the larger the image size.[[File:Set image quality 21084.png|300px|center|thumb|Set the image quality]]
#Select the image format at the bottom of the window.
#Specify the filename.
#Click <strong style="font-size: 14.4px;">Save </strong><span style="font-size: 14.4px;">to export.</span><span style="font-size: 14.4px;"></span>
<pre>NOTE: There are two options for exporting as PNG files - with and without background:
- With background: export diagram's background colour. 
- Without background: ignore the background colour by exporting transparent background.</pre>

== Switch the different diagrams in the current project ==
You can switch the different diagrams in the current project by doing the following:
#Select '''View -&gt; Project Browser'''&nbsp;from the toolbar.[[File:Project browser.png|500px|center|thumb|Project Browser]]
#You can then choose the diagram you want to switch by double-clicking.[[File:Choose diagram.png|500px|center|thumb|Choose the diagram you want to switch]]

== Save the current project ==
You can save your current project by doing the following:
#Select '''Project -&gt; Save '''from the toolbar.
#Specify the filename.
#Click '''Save '''to save the project.

== Import / Open your project ==
You can import / Open your current project by doing the following:
#Select '''Project -&gt; Open '''from the toolbar.
#Choose the project you want to import/open.
#Click '''Open '''to import/open the project.
[[Category:Course 02161 Software Engineering 1|2]]