Previous Next
vpuml_user_guide Chapter 14 - Team Collaboration with CVS

Chapter 14 - Team Collaboration with CVS Repository

CVS is widely adopted version control and collaboration platform. With VP-UML CVS repository integration you can record and keep history of all changes in your design in your CVS repository. Moreover, your designs are stored along with source codes in the same repository. This allows both design and source code to be backed up together, and also saves administration cost by needing only a single repository in your team. Other people who may need to only view your designs just need to use the free Viewer to have a look at the project. Please be reminded CVS repository is only available in Standard Edition or above.

In this chapter:

Starting the Teamwork Client Dialog Box

The Teamwork Client dialog box is the access point for all Teamwork functions, such as importing and managing projects, operating projects, reviewing and comparing projects and using branches and tags. There are three ways you can start Teamwork Client.
To start using the main menu, you can select Tools > Teamwork > Open Teamwork Client... .
Figure 14.1 - Open Teamwork Client using main menu

If not, you may use the tool bar to open the Teamwork Client dialog box.
Figure 14.2 - Open Teamwork Client using main menu

You can also right click on the project node of different panes and select Teamwork > Open Teamwork Client... .
Figure 14.3 - Open Teamwork Client with project node

By using any one of these methods, the Login to the Teamwork Server dialog box will be displayed.
 Figure 14.4 - Login to the Teamwork Server dialog box

You can select CVS as the server.
Figure 14.5 - Login to the Teamwork Server dialog box

Configure the details of the server connection, then click OK to confirm.
Figure 14.6 - Configure details of server conncetion

The Teamwork Client dialog box is opened.
Figure 14.7 - Teamwork Client dialog box



Name
 Function

Logout
 Logout from the server.

Manage project
 Manage projects in the server.

Import project
 Import a project into the server.

Open
 Open the selected project.
Check for Update
 Check for updates in the selected project.
Refresh projects Refresh the projects to get the latest status.
Tag... Create a tag for the selected project.
Branch... Create a branch for the selected project.
Merge... Merge the modification of branch to head.
Switch... Switch your location in the project.
Delete branch... Delete a branch.
Project Details... Show details of the selected project.
Revision Modification history of the selected project. 
Projects list Show projects selected to be managed.

Importing Project to the Repository

You can import your project to the repository by clicking the Import Project to Repository icon in the Teamwork Client dialog box.
Figure 14.8 - Select Import Project to Repository


The Import Project dialog box will be displayed. You can edit the project name and the type of project file you want to import.
Figure 14.9 - Import Project dialog box



Name Function

Project name
 Edit the name of the imported project.

Currently opened project
 Import the project you have opened.

Import existing project
 Import an existing project from the local file system.

Create new project
 Create a new project in the repository.
Create folder for project Create a folder for an imported project automatically.
Table 14.1

You can then select the repository where your project will be imported to. You may right-click on a folder and select New Remote Folder from the popup menu to create another folder inside it.
 Figure 14.10 - Open a new remote folder

Managing Teamwork Project

Only the first project user, who usually is Project Leader or Business Analyst, needs to import project to repository. Other team members may use the Manage Project dialog box to manage these working projects. To open the Manage Project dialog box, you can right-click on the Projects List in the Teamwork Client dialog box, and select Manage Project in the popup menu.

 Figure 14.11 - Select Manage Project

Select a project in the repositories and click Add selected to add the project to the Projects list. You may manage more than one teamwork project at the same time by selecting different projects and clicking Add selected.
 Figure 14.12 - Manage Project dialog box

If you want to remove a project which is added to your Projects list, select Remove selected to remove the project selected in the list.
 Figure 14.13 - Remove selected project

Checking Out Project

If you have already imported a project to server or selected a project to manage, you can checkout the project from the repository.
When you have just selected a project in the Projects list, the status is 'Not checked out'.
 Figure 14.14 - Project not checked out

Clicking Open Project will checkout the project and open it immediately.
 Figure 14.15 - Open the project

Alternatively, you can choose to checkout the project without opening it. Checkout Project is quite different from Open Project. After checking out the project, your will stay in the Teamwork Dialog for further actions. For example, creating branch, Merge change from branch. If you select Open Project, you will open the project for viewing and modification.
To checkout the project, click Checkout in Teamwork Client dialog box.
 Figure 14.16 - Checkout the project

The status of the project is now changed and the project has been checked out successfully.
 Figure 14.17 - Project checked out



Committing Project

After the project has been modified, you can share your local changes with other team members by committing the project to a server.
You may commit project in the toolbar.
 Figure 14.18 - Commit project

A Commit Project dialog box will show you the committing progress.
 Figure 14.19 - Commit project dialog box

A dialog box will be displayed and you may enter a description of the changes. Click OK.
 Figure 14.20 - Enter description of commit change

A Commit Model(s) dialog box shows the models you have modified. Click OK to commit.
 Figure 14.21 - Commit Model(s) dialog box

Sometimes, you may encounter conflict when committing models.
Figure 14.22 - Commit with conflict

You can choose to revert or overwrite to solve. For more details, please refer to the section 'Resolving Conflict'.
Figure 14.23 - Select overwrite or revert

Updating Project

Apart from committing the modified project to the server, you can also get teammates' changes on the server to your local area by updating teh project. To update a project, click the icon for update in the toolbar.

 Figure 14.24 - Update project

Update Model(s) dialog box is displayed. The models changed by others are shown. Click OK to update.
 Figure 14.25 - Update Model(s) dialog box

Reverting Project

You may encounter a situation when you have made a lot of changes in the project just to find there are a lot of mistakes. In this case, you may want to rollback all the changes and redo the whole project.
Here, you can revert all local changes by clicking the Revert button.
 Figure 14.26 - Revert project

A dialog box will show and ask if you want to revert. Click Yes to confirm and the project will be reverted.
 Figure 14.27 - Confirm revert project

Resolving Conflict

Sometimes, you may modify the same model as your teammate with different changes.  In this case, the server will not know which revision should be preserved and it will show a conflict.
Conflicts may happen when you commit the project.
Figure 14.28 - Conflict found in merging

Conflict may also happen when you update your project.
Figure 14.29 - Conflict found in updating

If a conflict appears, you can solve it by selecting the conflicting model and clicking Overwrite or Revert.
Overwrite keeps the local changes while Revert accepts changes from the server.
Figure 14.30 - Solving conflict


Viewing Revision History

From time to time, there may be a lot of changes made by you and your teammates.  In VP-UML, you can view previous revisions of the project.
To view the history of committed changes, open the Teamwork Client dialog box and select Revisions tag.
 Figure 14.31 - Select Revisions

You can see the different revisions of the project.
 Figure 14.32 - Different revisions of the project

You can see the model, diagram and diagram elements modified in that version. You can also see the check in description in that version.
 Figure 14.33 - Changes of different revisions

Checking Out Old Revision

You can checkout the old revision of project and make changes in it. Afterwards, you can commit your changes to the server.
To check out a revision of a project, select a revision and click Open Project.
Figure 14.34 - Check out old revision

Comparing Between Revisions

To see the differences between different revisions in VP-UML, select a revision.
Figure 14.35 - Select one revision

Then press Ctrl and click on the revision you want to compare with.
Figure 14.36 - Select another revision

Click Compare Project to compare.
Figure 14.37 - Select Compare Project

A Compare Projects from revision dialog box will appear and show you the differences between your selected revisions.
Figure 14.38 - Compare Project dialog box

Branch and Tag Project

Branch is a technique to separate the development of project from head. You can modify the project in branch while keep the most stable version design in head.
In this way, you can perform some research or time-taking task in branch and merge the changes to head only when the branch is proven to be stable.
Tag provides a convenient technique to manage and label a stable version. You can go back to check the stable version by switching to Tag.

Creating a Branch

Create a branch by clicking the icon for branch in toolbar.
Figure 14.39 Select branch

The Create Branch dialog box is displayed.  Enter the name of branch you want to create.
Figure 14.40 - Create Branch dialog box

Then, select a status of branch from the drop-down menu.
Figure 14.41 - Select from drop-down menu

Click OK to confirm creating the branch.
Figure 14.42 - Confirm creating branch

Managing a Branch

Similar to managing a project, you can manage a branch in the Manage Project dialog box.
First, select a branch under a project.
Figure 14.43 - Manage project dialog box

Click Add selected  to add the branch to your Projects list.
Figure 14.44 - Add selected branch

You can also click Remove selected  to remove the branch from the Projects list.
Figure 14.45 - Remove selected branch

Creating a Tag

You can label the stable version of project by creating a tag there.
To create a tag, select Tag... in the toolbar.
Figure 14.46 - Select Tag...

Then, edit the name of tag in Create Tag dialog box.
Figure 14.47 - Create Tag dialog box

Next, you can select the status after creating tag from the drop-down menu.
Figure 14.48 - Select the status after creating tag

After you have select OK, a message will show you that tag has been created.
Figure 14.49 - Message showing tag created

Managing a Tag

Similar to managing a branch, you can select a tag and click Add Selected in Manage Project dialog box to add the project to Projects list.
Figure 14.50 - Add selected project

You may remove the tag from Projects list by click Remove selected.
Figure 14.51 - Select Remove selected

Usage of Merge

When the project in your branch has been modified, you can merge the changes made to the head.
To merge, select the icon for merging in the toolbar.
Figure 14.52 - Icon for merging

The Merge dialog box is displayed. Select a branch to merge to, and select the revision you want to merge.
Figure 14.53 - Merge dialog box

The progress of merging is shown.
Figure 14.54 - Progress of merging

Then, a dialog box tells you what models and diagrams are going to be merged. Click OK to confirm the merge.
 
 Figure 14.55 - Models and diagrams which are going to merge

Suggested Branch Usage

This section will show you the suggested usage of the Branch with VP-UML CVS integration.
Here, you will learn how to create a single branch called "supportWebService". However, you can choose to have multiple branch running at the same time.
Figure 14.56 - Suggested branch usage
Previous Next
Visual Paradigm International Limited
Website: www.visual-paradigm.com
E-mail: support@visual-paradigm.com