CMVCVersion Control User Guide

SDWB 5.
0 򔻐򗗠򙳰
CMVC Version Control Feature for

WebSphere Studio User Guide
Updated: December 19, 2003
© Copyright International Business Machines Corporation 2003. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
About this guide . . . . . . . . . . . . . . . . . . . . . . . . ix

Who should read this guide? . . . . . . . . . . . . . . . . . . . . ix
What has changed? . . . . . . . . . . . . . . . . . . . . . . . ix
What else should you read? . . . . . . . . . . . . . . . . . . . . ix
Terminology used in this guide . . . . . . . . . . . . . . . . . . . ix
How to send your comments . . . . . . . . . . . . . . . . . . . . ix
Chapter 1. Prerequisites . . . . . . . . . . . . . . . . . . . . . 1
Supported WebSphere Studio Workbench products . . . . . . . . . . . . 1
What is the WebSphere Studio Workbench? . . . . . . . . . . . . . 1
Supported Workbench products and versions . . . . . . . . . . . . . 2
Workbench download sites . . . . . . . . . . . . . . . . . . . . 2
Supported CMVC server versions . . . . . . . . . . . . . . . . . . 2
Chapter 2. Installing, updating, or removing the CMVC Version Control

Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Installing the CMVC Version Control Feature . . . . . . . . . . . . . . 3
Step 1. Open the Workbench Install/Update perspective . . . . . . . . . 3
Step 2. Create a site bookmark for the SDWB download site . . . . . . . 3
Step 3. Install the CMVC Version Control Feature . . . . . . . . . . . 5
Installing feature updates . . . . . . . . . . . . . . . . . . . . . 6
Step 1. Check for available feature updates . . . . . . . . . . . . . . 6
Step 2. If updates are available, open your Workbench Install/Update
perspective . . . . . . . . . . . . . . . . . . . . . . . . . 6
Step 3. Install updates for the CMVC Version Control Feature . . . . . . . 7
Removing features . . . . . . . . . . . . . . . . . . . . . . . . 8
Chapter 3. Getting started. . . . . . . . . . . . . . . . . . . . . 9

Setting global preferences . . . . . . . . . . . . . . . . . . . . . 9
Workbench label decoration preference . . . . . . . . . . . . . . . 9
CMVC preferences . . . . . . . . . . . . . . . . . . . . . . 10
CMVC label decoration preferences . . . . . . . . . . . . . . . . 14
Setting up and managing projects . . . . . . . . . . . . . . . . . . 15
Creating a project for CMVC files . . . . . . . . . . . . . . . . . 15
Associating a project with a CMVC location . . . . . . . . . . . . . 16
Working with preference sets. . . . . . . . . . . . . . . . . . 22
Changing CMVC project associations . . . . . . . . . . . . . . . 26
Removing CMVC project associations . . . . . . . . . . . . . . . 26
Using Workbench views to perform CMVC Version Control Feature tasks . . . 26
Any workspace navigation view . . . . . . . . . . . . . . . . . . 27
CMVC File Queries view . . . . . . . . . . . . . . . . . . . . 27
CMVC Repository Explorer . . . . . . . . . . . . . . . . . . . 28
Synchronize view . . . . . . . . . . . . . . . . . . . . . . . 28
CMVC Files Query List view . . . . . . . . . . . . . . . . . . . 29
Associating the CMVC views with a CMVC location . . . . . . . . . . . 30
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Chapter 4. File management tasks . . . . . . . . . . . . . . . . . 31

File management task reference . . . . . . . . . . . . . . . . . . 31
© Copyright IBM Corp. 2003 iii

File lists and queries . . . . . . . . . . . . . . . . . . . . . . . 32
Generating a list of files . . . . . . . . . . . . . . . . . . . . 32
Customizing file queries . . . . . . . . . . . . . . . . . . . . 33
Running the previous query . . . . . . . . . . . . . . . . . . . 34
Saving queries to the CMVC Files Query List view . . . . . . . . . . . 34
Running a saved query from the CMVC Files Query List view . . . . . . 36
Modifying saved queries . . . . . . . . . . . . . . . . . . . . 36
Deleting saved queries . . . . . . . . . . . . . . . . . . . . . 36
File actions . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Checking files into CMVC . . . . . . . . . . . . . . . . . . . . 36
Checking files out of CMVC . . . . . . . . . . . . . . . . . . . 36
Comparing files . . . . . . . . . . . . . . . . . . . . . . . . 37
Comparing workspace files with the most recent version in CMVC . . . . 37
Comparing workspace files with any version in CMVC . . . . . . . . 37
Comparing any two versions of a file in CMVC . . . . . . . . . . . 37
Creating files in CMVC . . . . . . . . . . . . . . . . . . . . . 38
Deleting files in CMVC . . . . . . . . . . . . . . . . . . . . . 38
Extracting files from CMVC . . . . . . . . . . . . . . . . . . . 38
Extracting files when a project is not created . . . . . . . . . . . . 38
Extracting files to an existing project . . . . . . . . . . . . . . . 38
Locking files in CMVC . . . . . . . . . . . . . . . . . . . . . 39
Merging files . . . . . . . . . . . . . . . . . . . . . . . . . 39
Merging workspace files with the most recent version in CMVC . . . . . 39
Merging workspace files with any version in CMVC . . . . . . . . . 39
Renaming files in CMVC . . . . . . . . . . . . . . . . . . . . 40
Replacing files . . . . . . . . . . . . . . . . . . . . . . . . 40
Replacing a workspace file with the most recent version in CMVC . . . . 40
Replacing workspace files with any version in CMVC . . . . . . . . . 40
Synchronizing workspace files with CMVC files . . . . . . . . . . . . 41
Synchronizing workspace files with the most recent versions in CMVC 42
Synchronizing workspace files with any level in CMVC . . . . . . . . 43
Synchronizing workspace lock decorators with CMVC . . . . . . . . 44
Undoing file changes in CMVC . . . . . . . . . . . . . . . . . . 45
Unlocking files in CMVC . . . . . . . . . . . . . . . . . . . . 45
Appendix A. Path Mapping Examples . . . . . . . . . . . . . . . . 47

Mapping workspace path names to CMVC file names: CMVC path name starts
with workspace project name . . . . . . . . . . . . . . . . . . . 48
Mapping workspace path names to CMVC file names: CMVC path name does
not start with workspace project name . . . . . . . . . . . . . . . 50
Appendix B. Synchronization Example . . . . . . . . . . . . . . . 55

Synchronizing workspace files with the most recent versions in CMVC . . . . 55
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
iv SDWB 5.0: CMVC Version Control Feature for WebSphere Studio User Guide
Figures
1. CMVC Support Web site . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Opening the Workbench Install/Update Perspective . . . . . . . . . . . . . . . . . . 3
3. Creating a new Site Bookmark . . . . . . . . . . . . . . . . . . . . . . . . . . 4
4. Settings for the SDWB 5.0 download site bookmark . . . . . . . . . . . . . . . . . . 4
5. SDWB Features Site Bookmark . . . . . . . . . . . . . . . . . . . . . . . . . . 5
6. Available SDWB features . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
7. Install information for CMVC Version Control Feature . . . . . . . . . . . . . . . . . . 6
8. Opening the Workbench Install/Update Perspective . . . . . . . . . . . . . . . . . . 7
9. Available SDWB features . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
10. Update information for CMVC Version Control Feature . . . . . . . . . . . . . . . . . 8
11. CMVC Support Web site . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
12. Workbench label decoration preference . . . . . . . . . . . . . . . . . . . . . . 10
13. CMVC preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
14. CMVC label decoration preferences . . . . . . . . . . . . . . . . . . . . . . . . 14
15. Label decorations in the Navigator view . . . . . . . . . . . . . . . . . . . . . . 15
16. Associating a project with CMVC . . . . . . . . . . . . . . . . . . . . . . . . . 16
17. Share Project wizard: Repository type . . . . . . . . . . . . . . . . . . . . . . . 17
18. Share Project wizard: Enter or choose a CMVC family . . . . . . . . . . . . . . . . . 18
19. Share Project wizard: CMVC user ID . . . . . . . . . . . . . . . . . . . . . . . 19
20. Share Project wizard: Preference set . . . . . . . . . . . . . . . . . . . . . . . 20
21. Share project wizard: New preference set . . . . . . . . . . . . . . . . . . . . . . 20
22. Project Properties window . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
23. Edit Preference window . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
24. Project Properties window showing modified preference set . . . . . . . . . . . . . . . 24
25. Project Properties window . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
26. Delete Preference window . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
27. Confirm window for removing shares . . . . . . . . . . . . . . . . . . . . . . . 26
28. Workbench Navigator view . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
29. CMVC File Queries view . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
30. CMVC Repository Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
31. Synchronize view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
32. CMVC Files Query List view . . . . . . . . . . . . . . . . . . . . . . . . . . 30
33. Choose location icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
34. Query icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
35. Query window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
36. Query icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
37. Query window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
38. Choose Query Rows window . . . . . . . . . . . . . . . . . . . . . . . . . . 34
39. Refresh icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
40. Query icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
41. Query window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
42. Save Query window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
43. Synchronize view after selecting Team > Synchronize > With Latest . . . . . . . . . . . 42
44. Resolving a conflict in the Synchronize view . . . . . . . . . . . . . . . . . . . . . 43
45. Choose a Level for Synchronization window . . . . . . . . . . . . . . . . . . . . . 43
46. Synchronize view after selecting Team > Synchronize > With Level . . . . . . . . . . . 44
47. Resolving a conflict in the Synchronize view . . . . . . . . . . . . . . . . . . . . . 44
48. Selecting a workspace file . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
49. Clicking Team > Lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
50. Suppress local path prefix mapping . . . . . . . . . . . . . . . . . . . . . . . . 49
51. Add prefix to CMVC path mapping . . . . . . . . . . . . . . . . . . . . . . . . 50
52. Selecting a workspace file . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
53. Clicking Team > Lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
© Copyright IBM Corp. 2003 v
54. CMVC path starts with project name mapping . . . . . . . . . . . . . . . . . . . . 52
55. Suppress local path prefix mapping . . . . . . . . . . . . . . . . . . . . . . . . 52
56. Add prefix to CMVC path mapping . . . . . . . . . . . . . . . . . . . . . . . . 53
vi SDWB 5.0: CMVC Version Control Feature for WebSphere Studio User Guide
Tables
1. Download sites for WebSphere Studio products . . . . . . . . . . . . . . . . . . . . 2
2. Global CMVC preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3. Label decorations: CMVC . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
4. Examples of path mapping definitions . . . . . . . . . . . . . . . . . . . . . . . 21
5. File management quick task reference . . . . . . . . . . . . . . . . . . . . . . . 31
© Copyright IBM Corp. 2003 vii

viii SDWB 5.0: CMVC Version Control Feature for WebSphere Studio User Guide
About this guide
Configuration Management Version Control (CMVC) integrates configuration
management, version control, change control, and problem tracking software
development processes in a distributed development environment. The CMVC
Version Control Feature for WebSphere Studio enables you to perform CMVC file
management tasks in an Eclipse environment.
This guide describes how to install and use the CMVC Version Control Feature. It
assumes that you are familiar with basic CMVC concepts and tasks.
Who should read this guide?

Read this guide if you want to use CMVC in an Eclipse environment.
What has changed?

v The URLs for the WSWB 2.1 and 2.1.1 download sites have been updated.
v Support for the SDWB 5.0 Tools and Solutions Portal ends 12/31/03. Therefore,
information about the Single Sign-on feature has been removed from the global
preferences section in Chapter 3. This optional feature enabled a user to log in to
all their CMVC families using their IBM Intranet ID and password.
v Support for the SDWB 5.0 Notification Framework and Technology Previews
ends 12/31/03. Therefore, information about how to receive dynamic notifications
about the state of files in CMVC has been removed.
What else should you read?

The most current CMVC Version Control Feature documentation is available on the
Web at http://w3.sdwb.ibm.com/cmvc/50documentation.html.
For CMVC conceptual and reference information, see the CMVC InfoCenter at
http://w3.sdwb.ibm.com/cmvc/5.0/infocenter/.
For information about CMVC change request management tasks that you can
perform in the Workbench, see the CMVC Change Request Management Feature
User Guide at http://w3.sdwb.ibm.com/cmvc/50documentation.html.
To access all SDWB documentation, see the SDWB Web site at

http://w3.sdwb.ibm.com/documentation.html
Terminology used in this guide

For more information about SDWB terminology, see the SDWB Glossary at
http://w3.sdwb.ibm.com/glossary.html.
For more information about IBM and industry terminology, search the IBM
Terminology Database at http://ibmterm.torolab.ibm.com/.
How to send your comments

We welcome and appreciate your input on the documentation. Please send any
comments or suggestions on this guide to sdwbid@us.ibm.com.
© Copyright IBM Corp. 2003 ix

x SDWB 5.0: CMVC Version Control Feature for WebSphere Studio User Guide
Chapter 1. Prerequisites
Supported WebSphere Studio Workbench products . . . . . . . . . . . . 1
What is the WebSphere Studio Workbench? . . . . . . . . . . . . . 1
Supported Workbench products and versions . . . . . . . . . . . . . 2
Workbench download sites . . . . . . . . . . . . . . . . . . . . 2
Supported CMVC server versions . . . . . . . . . . . . . . . . . . 2
Supported WebSphere Studio Workbench products

To use the CMVC Version Control Feature, you must first install a supported
WebSphere Studio Workbench (WSWB) product.
This section provides overview information about the WebSphere Studio Workbench
and installation instructions:
v “What is the WebSphere Studio Workbench?”
v “Supported Workbench products and versions” on page 2
v “Workbench download sites” on page 2
What is the WebSphere Studio Workbench?

IBM’s WebSphere Studio Workbench (WSWB) is an Integrated Development
Environment (IDE) based on the open-source Eclipse Project. Products across IBM
are being redesigned and delivered as components that extend the base WSWB
platform. These components, known as plug-ins, are packaged together as product
offerings, known as features.
In this CMVC Version Control Feature User Guide, WebSphere Studio Workbench
and Workbench refer to the WebSphere Studio products that are based on the
WSWB IDE and supported by the CMVC Version Control Feature.
In addition to providing an environment for integrated development, the Workbench

enables developers to seamlessly integrate their client applications into a framework
that provides a common and consistent interface for users of diverse applications.
Developers can use the prepackaged Workbench presentation and functions, or

they can extend and enhance their applications using Workbench extension points.
This can include simple enhancements such as menu items and icons, or more
complex enhancements such as application-specific perspectives and views. To
integrate applications into the Workbench, developers create Eclipse plug-ins (Java
and XML code) which are packaged as features, such as the CMVC Version
Control Feature. Users can easily install and update these features using the
Workbench Install/Update Manager.
Related information:
v For more information about WebSphere Studio Workbench, see the basic tutorial
in the Getting Started section of your Workbench product documentation. To
access your Workbench documentation, click Help > Help Contents.
v For more information about Eclipse and the open-source Eclipse Project, see the
Eclipse Web site at http://www.eclipse.org/.
© Copyright IBM Corp. 2003 1

Supported Workbench products and versions
The CMVC Version Control Feature can be used with the following WebSphere
Studio products:
v WebSphere Studio Workbench (WSWB), Version 2.1 and 2.1.1.
v WebSphere Studio Application Developer (WSAD), Version 5.1
v WebSphere Studio Application Developer Integration Edition (WSADIE), Version
5.1
v WebSphere Studio Enterprise Developer (WSED), Version 5.1
v WebSphere Studio Site Developer (WSSD), Version 5.1
v Any other WebSphere Studio product based on WSWB, Version 2.1 or 2.1.1
Notes:
1. Linux users: There is a reported problem with WSxD Version 5.1 on Linux
which prevents you from launching the CMVC Version Control Feature. This
problem is scheduled to be fixed in a future Fix Pack of WSxD. Until that fix is
available, see the Support Technote that provides a workaround for this
problem. You can access this Technote on the CMVC Support Web site.
https://ldbdcf1.southbury.ibm.com/software/support.nsf/site/sdwb+cmvc/
Figure 1. CMVC Support Web site
2. New Workbench users: See the Basic Tutorial in the Getting Started section
of your Workbench product documentation. To access Workbench
documentation, click Help > Help Contents.
Workbench download sites

Table 1. Download sites for WebSphere Studio products
Product URL
All WebSphere Studio http://w3.ibm.com/software/xl/ui2/downloads/downloads.jsp
products except WSWB
WSWB, Version 2.1.1 ftp://wswbanon@ott4f.ott.oti.com/teams/wswb/anon/out/2.1.1-GA/
WSWB, Version 2.1 ftp://wswbanon@ott4f.ott.oti.com/teams/wswb/anon/out/2.1/wswb-2.1-200303280912/
Supported CMVC server versions

The CMVC Version Control Feature supports communication with CMVC servers,
Version 4.0 or higher.
2 SDWB 5.0: CMVC Version Control Feature for WebSphere Studio User Guide
Chapter 2. Installing, updating, or removing the CMVC Version
Control Feature
Installing the CMVC Version Control Feature . . . . . . . . . . . . . . 3
Step 1. Open the Workbench Install/Update perspective . . . . . . . . . 3
Step 2. Create a site bookmark for the SDWB download site . . . . . . . 3
Step 3. Install the CMVC Version Control Feature . . . . . . . . . . . 5
Installing feature updates . . . . . . . . . . . . . . . . . . . . . 6
Step 1. Check for available feature updates . . . . . . . . . . . . . . 6
perspective . . . . . . . . . . . . . . . . . . . . . . . . . 6
Step 3. Install updates for the CMVC Version Control Feature . . . . . . . 7
Removing features . . . . . . . . . . . . . . . . . . . . . . . . 8
Installing the CMVC Version Control Feature

Use the steps in this section to install the CMVC Version Control Feature for the
first time. Before beginning, you must install a supported WebSphere Studio
Workbench product. For more information, see Chapter 1, “Prerequisites,” on page
1.
Step 1. Open the Workbench Install/Update perspective

Click Window > Open Perspective > Install/Update. If Install/Update is not in the
list, click Other to display all available perspectives.
Figure 2. Opening the Workbench Install/Update Perspective
Step 2. Create a site bookmark for the SDWB download site

Before you can download the CMVC Version Control Feature, you must create a
site bookmark for the SDWB download site. If you have already created this
bookmark for another SDWB feature install, go to “Step 3. Install the CMVC Version
Control Feature” on page 5.
To create a site bookmark:

1. Right-click anywhere in the Feature Updates view, then click New > Site
Bookmark.

Figure 3. Creating a new Site Bookmark
2. In the New Site Bookmark window:

a. Type a site name of your choice, for example, SDWB 5.0 Features.
b. Type the SDWB download site URL:
http://w3.sdwb.ibm.com/plugins/sdwb/install/.
c. Select Eclipse update site.
d. Click Finish.
Figure 4. Settings for the SDWB 5.0 download site bookmark
Figure 5. SDWB Features Site Bookmark
Step 3. Install the CMVC Version Control Feature

1. In the Feature Updates view, expand the SDWB download site folder.
Figure 6. Available SDWB features
2. Select the CMVC Version Control Feature. Information about the feature is
available in the Preview view.
Chapter 2. Installing, updating, or removing the CMVC Version Control Feature 5

Figure 7. Install information for CMVC Version Control Feature
3. To install, click Install Now > Next.

4. In the Feature License window, review and accept the license agreement, then
click Next.
5. In the Install Location window, specify an install directory for the feature, then
click Finish.
Recommendation:
For maintenance purposes, it is recommended that you specify a separate
install directory for each feature. See “Removing features” on page 8.
6. In the Feature Verification window, click Install to complete the installation.
7. When prompted to restart the Workbench:
v Click No if you are adding or updating other features.
v Click Yes if you have completed all feature installs and updates.
Installing feature updates
Step 1. Check for available feature updates

To check for available updates, click Help> Software Updates > New Updates.

perspective
Click Window > Open Perspective > Install/Update. If Install/Update is not in the
list, click Other to display all available perspectives.
Figure 8. Opening the Workbench Install/Update Perspective
Step 3. Install updates for the CMVC Version Control Feature

1. In the Feature Updates view, expand the SDWB download site folder.
Figure 9. Available SDWB features
2. Select the CMVC Version Control Feature:

v Click Install Now > Next to install the feature updates.
v If there is no Update Now push button in the Preview view, you have the
latest updates.
Chapter 2. Installing, updating, or removing the CMVC Version Control Feature 7

Figure 10. Update information for CMVC Version Control Feature
3. In the Feature License window, review and accept the license agreement, then
click Next.
4. In the Install Location window, click Finish.
5. In the Feature Verification window, click Install to complete the installation.
6. When prompted to restart the Workbench:
v Click No if you are adding or updating other features.
v Click Yes if you have completed all feature installs and updates.
Removing features
The Workbench allows you to disable features. However, disabling a feature does
not remove the feature from your file system.
The Workbench does not provide a feature uninstall option. Features must be
removed from the file system manually. If you need to remove a Workbench feature,
see the Support Technote on this topic. You can access this Technote on the CMVC
Support Web site.
https://ldbdcf1.southbury.ibm.com/software/support.nsf/site/sdwb+cmvc/
Figure 11. CMVC Support Web site
Chapter 3. Getting started
To use the CMVC Version Control Feature:
1. Install a supported WebSphere Studio Workbench product. For more
information, see Chapter 1, “Prerequisites,” on page 1.
2. Install the CMVC Version Control Feature using your Workbench Install/Update
Manager. For more information, see “Installing the CMVC Version Control
Feature” on page 3.
3. Set global preferences for your Workbench and the CMVC Version Control
Feature. For more information, see “Setting global preferences.”
4. Create Workbench projects for the CMVC Version Control Feature. For more
information, see “Setting up and managing projects” on page 15.
5. Familiarize yourself with the views associated with the CMVC Version Control
Feature. For more information, see “Using Workbench views to perform CMVC
Version Control Feature tasks” on page 26.
6. Associate the CMVC views with a CMVC location. For more information, see
“Associating the CMVC views with a CMVC location” on page 30.
7. Refer to the examples as needed to perform CMVC tasks. For more
information, see “Examples” on page 30.
Setting global preferences

You can set the following global preferences, which affect all CMVC Version Control
Feature actions:
v “Workbench label decoration preference”
v “CMVC preferences” on page 10
v “CMVC label decoration preferences” on page 14
Workbench label decoration preference

The Workbench label decoration preference is enabled by default. This preference
must be enabled for the CMVC Version Control Feature label decoration function to
work properly.
To verify that the Workbench label decoration preference is enabled:

1. Click Window > Preferences.
2. In the Preferences window, expand the Workbench entry, then click Label
Decorations.
3. Verify that the CMVC option is selected.

Figure 12. Workbench label decoration preference
CMVC preferences
To set global CMVC preferences:
2. In the Preferences window, expand the Team entry, then click CMVC.
Figure 13. CMVC preferences
Table 2. Global CMVC preferences

Option Description Default
Make checked-in/created/unlocked Files that you check in, create, or unlock in CMVC remain Off
files read-only, checked-out/locked in write mode in your workspace after the action is
files writeable complete; files that you check out or lock in CMVC are set
to read-only mode in your workspace after the action is
complete.
Turn this option on if you want workspace files you check

in, create, or unlock in CMVC set to read-only mode in
your workspace after the action is complete, and files that
you check out or lock in CMVC set to write mode.
Make extracted files read-only CMVC files that you extract to your workspace are set to Off
write mode.
Turn this option on if you want CMVC files that you

extract to your workspace to be read-only.
Chapter 3. Getting started 11

Table 2. Global CMVC preferences (continued)
Back up files on checkout/extract Existing files are not renamed when you check out or Off
extract files into a directory where the filename already
exits. Instead, the files are overwritten.
Turn this option on if you want CMVC to back up files that

already exist in a directory where you are checking out or
extracting files with the same filename. The checked out
or extracted file retains the filename. You can select the
format of the name of the backed up files.
After you turn on this option, you have two choices for the
format in which back up file names are assigned:
v ″x.txt″ becomes ″.x.txt″
v ″x.txt″ becomes ″x.$txt″
Show success messages CMVC issues a message after every successful action. On
Turn this option off if you want to see messages only if an

error occurs.
Show unlock dialog When you unlock a file in CMVC, the CMVC Version Off
Control Feature unlocks the file without you having to
confirm the action in the Unlock window.
Note: If you are working in concurrent development mode
with the track subprocess enabled, CMVC requires a
defect number to unlock files.
Turn this option on if you are working in a release using

concurrent development mode, and you want to confirm
file unlock actions in the Unlock window.
Allow keyword expansion when The CMVC Version Control Feature uses the keyword On
doing compare/merge/replace/sync expansion settings of a file stored in CMVC during
actions compare, merge, replace, and synchronize actions.
Turn this option off if you want to suppress keyword

expansion settings for all files during these actions.
Log command history CMVC command executions are not logged in the Off
Workbench error log.
Turn this option on if you want the CMVC command

executions occurring in the CMVC Version Control
Feature to be logged in the Workbench error log along
with the full CMVC command line that was executed.
Prefill defect/feature name on The Defect /feature(s) field of the CMVC Check In window Off
checkin is not prefilled with the defect or feature name used to
check out that file.
Turn this option on if you want to prefill the Defect

/feature(s) field of the Check In window with the defect or
feature name used to check out the file.
Note: If you attempt to check in two or more files that

have been checked out or locked using different defects,
the Defect/feature(s) field of the Check In window is
prefilled with both defect names. You must choose which
defect to use to check in the files.
Table 2. Global CMVC preferences (continued)
Prefill last-entered defect/feature The last defect or feature name you entered will not be Off
name prefilled in any windows during CMVC actions.
Turn this option on if you want the last-entered defect or

feature name to always be prefilled in every CMVC
actions window.
Note: When both the ″Prefill defect/feature name on

checkin″ and the ″Prefill last-entered defect/feature name″
preferences are turned on, the last-entered defect or
feature name should always be prefilled in every window
except Check In window. The Defect/feature(s) name field
of the Check In window is prefilled with the defect or
feature name used to check out or lock the file.
Ignore Derived Resources The CMVC Version Control Feature ignores derived On
resources, and therefore will not allow you to perform
CMVC actions on these resources. For more information
on derived resources, see the Preferences section of your
Workbench product documentation. The CMVC Version
Control Feature also honors the ignored resources
settings you specify. To access the Ignored Resources
settings, click Window > Preferences. Expand the Team
entry, then click Ignored Resources.
Turn this option off if you wish to perform CMVC actions

on derived resources.
Link local delete/move/rename This preference allows you to choose from three options:
actions with CMVC v Do not link actions
v Link actions and show the CMVC dialogs
v Link actions but do not show the CMVC dialogs
Do not link actions Selecting this option does not link local delete, move, and Selected
rename actions you perform on your workspace files with
CMVC. Therefore, the CMVC Version Control feature
does not perform these actions on the corresponding files
in CMVC.
Link actions and show the CMVC Selecting this option links local delete, move, and rename Not selected
dialogs actions you perform on your workspace files with CMVC.
The CMVC Version Control Feature performs these
actions on the corresponding files in CMVC and displays
messages to confirm these actions.
Note: When moving or renaming files, the CMVC Version

Control Feature will always perform the action on your
local workspace files regardless of whether the action is
successful in CMVC.
Link actions but do not show the Selecting this option links local delete, move, and rename Not selected
CMVC dialogs actions you perform on your workspace files with CMVC.
The CMVC Version Control Feature performs these
actions on the corresponding files in CMVC but does not
display messages to confirm these actions.
Note: When moving or renaming files, the CMVC Version

Control Feature will always perform the action on your
local workspace files regardless of whether the action is
successful in CMVC.

CMVC label decoration preferences
Label decorations show information about a file by modifying its label or icon.
Decorations allow you to obtain information about the state of a file without having
to look at its properties. By default, CMVC label decorations are enabled and are
required for the proper operation and use of the CMVC Version Control Feature.
Label decorations must be enabled in both the Workbench label decoration
preferences and the CMVC label decoration preferences to function properly.
Note: It is recommended that you do not change these default preferences.

Turning off these preferences will cause some CMVC actions, such as file
synchronization, compare with version, and merge with version, to function
improperly. Also, removing a CMVC project association causes all new and
changed file decorations in the workspace to disappear.
To set global label decoration preferences:

2. In the Preferences window, expand the Team entry.
3. Expand the CMVC entry, then click Label Decorations.
Figure 14. CMVC label decoration preferences
The following is a summary of the CMVC label decorations and their descriptions:
Table 3. Label decorations: CMVC
Label decoration Example Description
Lock decoration This decoration has two variations: the key icon
signifies that you have locked the file in CMVC; the
padlock icon signifies that someone else has locked
the file in CMVC. This decoration appears on the file
icon.
Version decoration [1.1] Shows the version number of the file in CMVC next to
the corresponding file in your workspace; this
decoration appears after the file name.
Change decoration *> Signifies that you have changed the workspace file but
have not checked the file into CMVC; this decoration
appears before the file name.
Create decoration ** Signifies that the file is present in your workspace but
does not exist in CMVC; this decoration appears before
the file name.
The following is the Navigator view showing resources with CMVC label
decorations:
Figure 15. Label decorations in the Navigator view
Setting up and managing projects

Eclipse-based products organize file resources into projects. For detailed
information about projects, see the Basic Tutorial in the Getting Started section of
your Workbench product documentation.
Creating a project for CMVC files

There are two ways you can create a project so that you can work with files from
CMVC. You can create a project by clicking File > New > Project. For more
information on creating projects using this method, see your Workbench product
documentation. You can also extract files from CMVC to a new workspace project.
See “Extracting files when a project is not created” on page 38 for more detail.

Associating a project with a CMVC location
To transfer files between your workspace and CMVC, you must first associate the
workspace project containing your files with a CMVC location. A CMVC location is
defined as username@familyname@host@port.
To associate a project with a CMVC location:

1. Right-click the project in your workspace.
2. Click Team > Share Project to open the Share Project wizard.
Figure 16. Associating a project with CMVC
3. In the Share Project wizard, click CMVC as your repository type, then click
Next.
Figure 17. Share Project wizard: Repository type
4. Enter the fully qualified name of your CMVC family in the format
familyname@host@port, then click Next.
Note: You can click Test Connection to ensure that you have a working
connection to your CMVC family
Note: The first time you associate a project with a CMVC location, you must
manually enter the name of your CMVC family. When you use the wizard
again, the family names you have previously entered are saved and
available as entries in the drop-down list.

Figure 18. Share Project wizard: Enter or choose a CMVC family
5. Type your CMVC user ID, then click Next. If you use password authentication,
you will be asked to type your password the first time you perform a CMVC
action.
Note: Although the CMVC Version Control Feature supports both host and
password authentication, password authentication is recommended
because it is more secure and flexible than host authentication.
Figure 19. Share Project wizard: CMVC user ID
6. You must create a new preference set for your project or select an existing
preference set. Click New to create a new preference set.

Figure 20. Share Project wizard: Preference set
7. In the New Preference Set window, type the required and optional information
for the preference set, then click OK.
Figure 21. Share project wizard: New preference set
Note: CMVC project preferences are organized as preference sets. A

preference set defines the CMVC properties associated with a project.
Once you have created a preference set, you can reuse it when setting
up other project associations to CMVC.
Each preference set is associated with only one CMVC release, and each
project can only be associated with one preference set. The CMVC release is
the only required property in a preference set. You can optionally:
v Specify a default component.
v Indicate whether you are working in concurrent development mode (this
corresponds to the CMVC_CONC_MODE environment variable in traditional
CMVC clients).
v Define default mappings between the path names of files in your local
workspace and the path names of files stored in CMVC.
Note: For more information on path mappings, see Appendix A, “Path

Mapping Examples,” on page 47
To define default workspace-to-CMVC path mappings, use the following
settings:
CMVC Path Begins with Project Name
By default, this setting is enabled. Turn this option off if you do not want
the path of the file in CMVC to begin with the workspace project name.
Remove Workspace Prefix
The text you enter in this field will be removed from the beginning of the
path of files in your workspace when mapping to CMVC.
Add Prefix to CMVC Path
The text you enter in this field will be added to the beginning of the path
of files in your workspace when mapping to CMVC.
Note: It is easiest to always remove any necessary prefixes before adding

prefixes. The dialog will show you the resulting path dynamically as you
type in the fields and give you a warning message in red if the
workspace file path does not match the path of the file in CMVC..
Table 4. shows examples of how these settings affect workspace-to-CMVC path
mappings.
Table 4. Examples of path mapping definitions
Path Remove Add Project Workspace path (see Note) CMVC path
setting Prefix Prefix name
checked?
Yes Project Project/src/ibm/test.java Project/src/ibm/test.java
No Project Project/src/ibm/test.java src/ibm/test.java
No src/ Project Project/src/ibm/test.java ibm/test.java
No src/ibm org/eclipse Project Project/src/ibm/test.java org/eclipse/test.java
Yes src stuff Project Project/src/ibm/test.java Project/stuff/ibm/test.java
Note: Workspace paths are defined from the workspace root. That is, they
begin with the project name, followed by the full path from the project
root.
8. Click Finish to exit the wizard. If you are using password authentication, the
CMVC Version Control Feature will prompt you to type your password the first
time you perform a CMVC action.
Related information:
v “Changing CMVC project associations” on page 26
v “Removing CMVC project associations” on page 26

Working with preference sets
Editing the preference set associated with a workspace project: After you
have associated a project with CMVC and created a preference set for the share,
you can change the preference set to associate the project with different CMVC
properties.
To edit a preference set:

1. Right-click on the shared project, then click Properties.
2. In the CMVC panel of the Properties window, click Edit. The fields are prefilled
with the values you chose when you created the preference set.
Figure 22. Project Properties window
3. In the Edit Preference window, edit the fields you want to change.
Note: The Affected Projects field lists the projects associated with the
preference set you are modifying. Changes you make to the preference
set apply to all of these projects.
Figure 23. Edit Preference window
4. Click OK. The new values for the preference set are shown in the Project
Properties window.

Figure 24. Project Properties window showing modified preference set
5. Click OK to close the Project Properties window.
Deleting a preference set: You can delete preference sets you have created that
are no longer associated with any of your workspace projects.
Note: You cannot delete a preference set that is still associated with a project. You
must first associated the project with a different preference set and then
delete the old preference set.
To delete a preference set:

1. Right-click on the shared project, then click Properties.
2. In the CMVC panel of the Properties window, click Delete.
Figure 25. Project Properties window
3. In the Delete Preference window, select the preference set you want to delete.
Note: The Affected Projects field lists the projects associated with the
preference set you are deleting. You cannot delete preference sets that
are being used by the current project or any other workspace project.
Figure 26. Delete Preference window
4. Click OK.

Changing CMVC project associations
After you have associated a project with CMVC, you can change the share to
reassociate the project with a different CMVC location.
To change a project association:

1. Right-click on the shared project, then click Team > Change CMVC Share
2. Follow the steps in the Share Project wizard to associate the project with the
new CMVC location. For more information about the Share Project to CMVC
wizard, see “Associating a project with a CMVC location” on page 16.
Removing CMVC project associations

A project can be associated with only one repository at a time.
To remove a project share:

1. Right-click on the shared project, then click Team > Remove Share.
Figure 27. Confirm window for removing shares
2. Click Yes to confirm that you want to remove the share.
Note: Removing a CMVC project association does not change the state of any
files either in your local workspace or in CMVC. However, label
decorations are shown only for projects that are shared with CMVC.
Removing a CMVC share will cause all new and changed file decorations
in the workspace to disappear. Be sure that all checked out and locked
files are checked back into CMVC before removing the project
association.
Using Workbench views to perform CMVC Version Control Feature

tasks
You can perform CMVC Version Control Feature tasks using the following views:
v “Any workspace navigation view” on page 27
v “CMVC File Queries view” on page 27
v “CMVC Repository Explorer” on page 28
v “Synchronize view” on page 28
v “CMVC Files Query List view” on page 29
For a list of tasks you can perform from each view, see the “File management task
reference” on page 31.
To show views in your workspace:

v Click Window > Show View.
v Select a view from the list or click Other for additional views.
v Click OK to show the view in your workspace.
Any workspace navigation view

To access CMVC actions from any workspace navigation view:
1. Right-click the file you want to perform a CMVC action on.
2. Click Team, then the task you want to perform.
The Team menu allows you to perform actions and interactions on the files in your
workspace and the files in CMVC. For a complete list of tasks you can perform from
any workspace navigation view, see the “File management task reference” on page
31.
Figure 28. Workbench Navigator view
CMVC File Queries view

The CMVC File Queries view exposes CMVC querying actions, allowing you to run
CMVC queries and perform actions on the resulting files. When you first show the
CMVC File Queries view in your Workbench, the view is empty. You must connect
to a CMVC location and run a query before you can perform CMVC actions. See
“Associating the CMVC views with a CMVC location” on page 30 for more
information about associating views with a CMVC location.
For a complete list of tasks you can perform from the CMVC File Queries view, see
the “File management task reference” on page 31

Figure 29. CMVC File Queries view
CMVC Repository Explorer

The CMVC Repository Explorer provides a tree structure view of the CMVC
Repository. You can use this view to browse the contents of CMVC and extract files
from CMVC to your workspace. When you first show the CMVC Repository Explorer
in your Workbench, the view is empty. You must connect to a CMVC location before
you can browse the repository. See “Associating the CMVC views with a CMVC
location” on page 30 for more information about associating views with a CMVC
location.
For a complete list of tasks you can perform from the CMVC Repository Explorer,
see the “File management task reference” on page 31.
Figure 30. CMVC Repository Explorer
Synchronize view
The Synchronize view gives you several options for synchronizing the files in your
local workspace with files in CMVC. If there are conflicts between the two sets of
files, the Synchronize function compares the version number associated with the file
in your workspace to the version number in CMVC. The Synchronize view uses
three different modes, which you can switch among by choosing the appropriate
mode on the title bar of the Synchronize view:
Mode Description
Incoming mode Only resources that have been created or
changed in CMVC since you last
synchronized your workspace files with the
files in CMVC are visible
Mode Description
Outgoing mode Only resources that have been created,
changed, or deleted in the workspace since
you last synchronized your workspace files
with the files in CMVC are visible
Incoming/outgoing mode Both incoming and outgoing changes are
visible
The different synchronization modes not only filter the files that you can view, but
the modes also restrict the set of CMVC actions you can perform on those files.
See “Synchronizing workspace files with CMVC files” on page 41 and the
Appendix B, “Synchronization Example,” on page 55 for more information.
The Synchronize view allows you to quickly see the state of files by using label
decorations. See the CMVC label decoration preferences section of “Setting global
preferences” on page 9 for a summary and description of the CMVC label
decorations.
For a complete list of tasks you can perform from the CMVC Synchronize view, see
the “File management task reference” on page 31.
Figure 31. Synchronize view
CMVC Files Query List view

The CMVC Files Query List view provides a tree structure view of saved CMVC
queries. You can save queries that you run in the CMVC File Queries view to the
CMVC Files Query List view, plus you can use this view to create new CMVC
queries, edit saved CMVC queries, and run saved CMVC queries.
For a complete list of tasks you can perform from the CMVC Query List view, see
the “File management task reference” on page 31.

Figure 32. CMVC Files Query List view
Associating the CMVC views with a CMVC location

Before you can access CMVC actions from the CMVC File Queries view or the
CMVC Repository Explorer, you must first associate the view with a CMVC location.
To associate the view with a CMVC location:

1. On the title bar of the view, click Choose Location.
Figure 33. Choose location icon
2. If you have not previously associated the view with any CMVC location, click
Create a New Location, then follow the instructions in the wizard.
Note: If you are using both the CMVC Version Control Feature and the CMVC
Change Request Management Feature, enter your CMVC location
information exactly the same way in both places. For example, if you
specify the host name for the family in one feature, specify the host
name, not an alias, in the other feature. This enables the features to
share your CMVC ID and password information so that you only have to
log in once.
If you have chosen a CMVC location before, select the location in the field
under Use Existing Location, then click OK. Type your password if your
CMVC family uses password authentication.
Examples
v Appendix A, “Path Mapping Examples,” on page 47
v Appendix B, “Synchronization Example,” on page 55
Chapter 4. File management tasks
File management task reference
Table 5 summarizes CMVC file management tasks and indicates where in the
Workbench you can perform them. For more information on these views and how to
show them in your workspace, see “Using Workbench views to perform CMVC
Version Control Feature tasks” on page 26.
Table 5. File management quick task reference
Task Any CMVC File CMVC CMVC CMVC Files
workspace Queries view Repository Synchronize view Query List view
navigation Explorer
view
Changing a CMVC share X
Checking in files X X X
Checking out files X X X
Choosing a CMVC X X
location
Comparing files X X
Creating files X X
Deleting files X X X
Destroying files X X
Extracting files X X X X
v Extracting files to a
new project
v Extracting a level
Locking files X X X
Merging files
Queries: X X
v Creating a query
v Customizing a query
v Editing a query
v Running a query
v Refreshing a query
v Saving a query
Recreating files X X
Removing a CMVC share X
Renaming files X X
Synchronizing file X X
contents
v Synchronizing with
latest
v Synchronizing with
level
Synchronizing lock X X
decorators
Undoing file changes X

Table 5. File management quick task reference (continued)
Task Any CMVC File CMVC CMVC CMVC Files
workspace Queries view Repository Synchronize view Query List view
navigation Explorer
view
Unlocking files X X X
File lists and queries
Generating a list of files

Before performing CMVC actions on one or more files in the CMVC File Queries
view, you must first generate a list of files.
To run a query and generate a list of files:

1. On the title bar of the CMVC File Queries view. click Query.
Figure 34. Query icon
2. In the Query window, type the required and optional information, such as
release and component, to define which files you would like listed in the CMVC
File Queries view.
Note: Click Choices to select from a list of options.
Figure 35. Query window
3. Click OK. The CMVC Version Control Feature lists the files in the CMVC File
Queries view.
Initially the files are sorted alphabetically by path name. To resort the list, click the
heading of any of the columns. Clicking on the same heading more than once sorts
the column first in ascending order, then in descending order.
Customizing file queries

You can specify which fields are available for you to run a CMVC query against.
These settings are global to all CMVC queries you perform.
To customize your query fields:

1. On the title bar of the CMVC File Queries view, click Query.
2. In the Query window, click Define Rows.
3. In the Choose Query Rows window, select the fields you want to query against
and deselect the fields you do not wish to query against.
Chapter 4. File management tasks 33

Figure 38. Choose Query Rows window
4. Click OK. The Query window shows the corresponding fields.
Running the previous query

To rerun the last query you performed, click Refresh on the title bar of the CMVC
File Queries view. You will be able to see any changes that have taken place to the
files since you last ran the query.
Figure 39. Refresh icon
Saving queries to the CMVC Files Query List view

You can save queries so that you can run these queries again at a later time. To
save a query:
1. On the title bar of the CMVC File Queries view, click Query.
2. In the Query window, type the object and type the required and optional
information to define which files you want listed in the CMVC File Queries view.
3. Before you click OK in the Query window to run the query, click Save Query to
save this query in the CMVC Files Query List view.
Figure 42. Save Query window
4. In the Save Query window, type a name for the query.
Note: By default, the query will be saved in the Query List folder. Click Create
New Folder to create a new folder where the query will be saved.
5. Click OK to close the Save Query window.
6. Back in the Query window, click OK. The CMVC Version Control Feature runs
the query, displays the results in the CMVC File Queries view, and saves the
query to in the CMVC Files Query List view.

Running a saved query from the CMVC Files Query List view
You can easily run queries you have saved in the CMVC Files Query List view. To
run a saved query, double-click the query you want to run in the CMVC Files Query
List view.The CMVC Version Control Feature runs the query and displays the
results in the CMVC File Queries view.
Modifying saved queries

After you have saved a query in the CMVC Files Query List view, you can modify
the query. To modify a saved query:
1. In the CMVC Files Query List view, click the query you want to modify.
2. Right-click, then click Rename.
3. Type a new name for the query, then click OK.
Deleting saved queries

You can delete queries you have saved in the CMVC Files Query List view. To
delete a saved query:
1. In the CMVC Files Query List view, click the query you want to delete.
2. Right-click, then click Delete.
Note: The CMVC Version Control Feature does not require you to confirm the
delete action for saved queries. If you accidentally delete a saved query,
you can undo the operation by right-clicking anywhere in the CMVC Files
Query List view, then clicking Undo Remove.
File actions
Checking files into CMVC

After you have made changes to a file that has been checked out, you must check
the file back into CMVC. If you are connected to a CMVC server at version 4.0 or
later, you must enter a defect or feature number when checking a file into CMVC.
To check files into CMVC:
1. Select the file you want to check in.
2. Right-click, then click Team > Check In.
3. In the Check In Files window, type the required and optional information, such
as a defect name.
Note: If you have the Prefill defect/feature name on checkin preference turned
on, this field will already contain the defect or feature name used to
check out the file. See “Setting global preferences” on page 9 for more
information about this and other preferences that affect CMVC file
management actions.
4. Click OK. The key icon is no longer next to the file in your workspace. This
indicates that you checked the file in successfully. The file is now unlocked, and
the most recent version is stored in CMVC.
Checking files out of CMVC

Checking out a file extracts a copy of the file to your workspace and locks the file in
CMVC. When a file is locked, it cannot be modified by other users. If you are
connected to a CMVC server at version 4.0 or later, you must enter a defect or
feature number when checking a file into CMVC.
To check a file out of CMVC:
1. Select the file you want to check out.
2. Right-click, then click Check Out.
3. In the Check Out Files window, type the required and optional information, such
as a defect name.
4. Click OK. A key icon appears next to the file in your workspace, indicating that
you have checked out the file successfully. The file is now locked in CMVC, and
a copy of the most recent version is in the workspace project you specified.
Comparing files
You can view the differences between two files by comparing them. You can
compare the version of a file in your workspace to the most recent version of the
file in CMVC, compare the version of a file in your workspace to any version of the
file in CMVC, or you can compare two CMVC versions of a file. If the two files are
the same, you will get a message that there are no differences between the
selected files. If there are differences in the files, you can merge the differences
together. See “Merging files” on page 39 for more information about merging files.
Also, see your Workbench product documentation for more information about the
Compare editor and its associated preferences.
Comparing workspace files with the most recent version in

CMVC
To compare a file in your workspace with the most recent version of the file in
CMVC:
1. Select the workspace file you want to compare with its CMVC counterpart.
2. Right-click, then select Compare With > Latest from Repository from the
context menu. The CMVC Compare editor, a content-oriented compare facility
used for comparing text and images, opens with your workspace version of the
file on the left side and the CMVC version of the file on the right side.
3. Use the arrow icons on the menu bar to scroll through the differences between
the files.
After you are done reviewing the differences between the files, you can merge the
files together if you would like. See “Merging files” on page 39 for details on this
function.
Comparing workspace files with any version in CMVC

To compare a file in your workspace with any version of the file in CMVC:
1. Select the workspace file you want to compare with its CMVC counterpart.
2. Right-click, then select Compare With > Version from the context menu.
3. The CMVC Compare editor, a content-oriented compare facility used for
comparing text and images, opens with your workspace version of the file on
the left side and the CMVC version of the file on the right side.
4. Use the arrow icons on the menu bar to scroll through the differences between
the files.
After you are done reviewing the differences between the files, you can merge the
files together if you would like. See “Merging files” on page 39 for details on this
function.
Comparing any two versions of a file in CMVC

To compare any two versions of a file in CMVC:
1. Select the file in your workspace, then click Compare With > Version.

2. In the Compare editor, select two rows of the table you want to compare.
3. Right-click, then click Compare. The CMVC Version Control Feature displays
the results of the compare in the bottom pane of the compare editor.
Creating files in CMVC

The first time you put a file into CMVC, that file must be created in CMVC. After you
create a file, you can then use the check out and check in functions to make
changes to the file.
To create a file in CMVC:

1. Select the file in your workspace that you want to create in CMVC.
2. Right-click, then click Team > Create.
3. In the Create Files window, type the required and optional information, such as
a defect name.
4. Click OK. The create decoration disappears from the file in your workspace,
indicating that the file has been created in CMVC. See “Setting global
preferences” on page 9 for more information about CMVC label decorations.
Deleting files in CMVC

Deleting a file in your workspace does not delete the corresponding file in CMVC,
unless you turned on one of the ″Link actions...″ options. See “Setting global
preferences” on page 9 for more information about these preferences.
To delete files:
1. Select the file you want to delete.
2. Right-click, then click Delete.
3. In the Delete window, type the required and optional information, such as defect
name.
4. Click OK to delete the file.
Extracting files from CMVC

Extracting a file copies the file from CMVC to your workspace. This action does not
lock the file in CMVC. If you are updating a file, be sure to check the file out to lock
the file in CMVC so that other users cannot modify the file at the same time.
Extracting files when a project is not created

If you want CMVC to create a new project for the files you are extracting:
1. In the CMVC File Queries view or the CMVC Repository Explorer, select the
CMVC file you want to extract.
2. Right-click, then click Extract to New Project.
3. Follow the instructions in the New Project wizard.
4. Click OK. The file is copied to your workspace in the new project.
Extracting files to an existing project

To extract files into a workspace project that you have already created:
1. Select the CMVC file you want to copy.
2. Right-click, then click Extract.
3. In the Extract window, select the project you want the file to be copied into. You
can optionally change the path mappings you specified in the startup wizard for
the project. See the Appendix A, “Path Mapping Examples,” on page 47 for
more detail.
4. Click OK. The file is copied to your workspace in the project you specified.
Locking files in CMVC

When you lock a file in CMVC, the file cannot be modified by other users.
To lock a file in CMVC:

1. Select the file you want to lock.
2. Right-click, then click Team > Lock.
3. In the Lock window, type the required and optional information, such as a defect
name. Update the path mappings of the file if necessary. See the Appendix A,
“Path Mapping Examples,” on page 47 for more details.
4. Click OK. A key icon appears next to the file in your workspace which indicates
that you have locked the file.
Note: A padlock icon next to a file indicates that someone else has locked the file.
Merging files
The CMVC Version Control Feature allows you to merge files in your workspace
with their counterparts stored in CMVC using the Eclipse compare/merge editors.
See your Workbench product documentation for more information about the basic
merge function provided in Eclipse. You can merge a file in your workspace with the
most recent version of that file in CMVC or merge a file in your workspace with any
version of that file in CMVC. The merge function is most commonly used in
conjunction with the compare function; after you compare two files, you can merge
together the differences, if there are any. See “Comparing files” on page 37 for
more information about comparing files.
Merging workspace files with the most recent version in CMVC

To merge a file in your workspace with the most recent version of the file in CMVC:
1. Select the file you want to merge.
2. Right-click, then click Merge With > Latest from Repository. The CMVC
Version Control Feature compares the files and displays the results in the
Structure Compare editor.
3. Scroll through the differences in the files using the arrow icons on the title bar of
the Text Compare editor.
4. Use the Copy All from Right to Left and Copy Current Change from Right
to Left buttons on the title bar of the Compare editor to merge text from the
CMVC file in the right pane to the workspace file in the left pane.
5. Save your changes.
Merging workspace files with any version in CMVC

To merge a file in your workspace with the any version of the file in CMVC that you
specify:
1. Select the file you want to merge.
2. Right-click, then click Merge With > Version. The CMVC Version Control
Feature compares the files and displays the results in the Compare editor.
3. In the Structure Compare editor, double-click the version of the file you want to
merge. The CMVC Version Control Feature opens the version of the file you
specified in the Text Compare editor.
4. Scroll through the differences in the files using the arrow icons on the title bar of
the Text Compare editor.

5. Use the Copy All from Right to Left and Copy Current Change from Right
to Left icons on the title bar of the Text Compare editor to merge text from the
CMVC file in the right pane to the workspace file in the left pane.
6. Save your changes.
Renaming files in CMVC

Renaming a file in your workspace does not rename the corresponding file in
CMVC, unless you turned on one of the ″Link actions...″ options. See “Setting
global preferences” on page 9 for more information about these options.
To rename a file in CMVC:

1. In the CMVC File Queries view, select the file the you want to rename.
2. Right-click, then click Rename.
3. In the Rename window, type the required and optional information, including the
new file name and a defect or feature name.
4. Click OK.
Replacing files
You can replace files in your workspace with files stored in CMVC. You can either
replace the files in your workspace with the most recent version of the
corresponding files in CMVC, or you can replace the files in your workspace with
any version of the files in CMVC that you choose. The CMVC Version Control
Feature uses the release and path mappings specified in the preference set of your
project to determine which files to extract from CMVC. Therefore, you must have
your path mappings set correctly to use the replacing files function. See
Appendix A, “Path Mapping Examples,” on page 47 for more detail about path
mappings. If no versions of a file exist in CMVC you will receive a message saying
the file was not found in CMVC.
Replacing a workspace file with the most recent version in

CMVC
To replace a file in your workspace with the most recent version of the file in
CMVC:
1. Select the file you want to replace.
2. Right-click, then select Replace With > Latest from Repository. The CMVC
Version Control Feature extracts the most recent version of the file from CMVC
to your workspace.
Note: If you are currently editing the file in your workspace when you attempt
to replace the file with the most current version in CMVC, the CMVC
Version Control Feature will ask you if you would like to replace the file.
Otherwise, the workspace file will be replaced with no prompting.
Replacing workspace files with any version in CMVC

To replace files in your workspace with the any version of the files in CMVC that
you choose:
1. Select the files you want to replace.
2. Right-click, then click Replace With > Version. The CMVC Version Control
Feature queries CMVC for all the version of that file and opens the Replace
editor.
3. Select the version of the file in CMVC you would like to replace your workspace
file with.
Note: You can compare your workspace file with particular version of the file in
CMVC from the Replace editor. To do this:
a. Select the version of the CMVC file you want to compare with your
workspace file.
b. Right-click, then click Compare. The two files open in the Compare
editor. See Comparing Files for more information about comparing
workspace files with files stored in CMVC.
4. Right-click, then click Replace. The CMVC Version Control Feature extracts the
version of the file you specified from CMVC to your workspace.
Synchronizing workspace files with CMVC files

The Synchronize function allows you to check whether newer versions of files have
been checked into CMVC since your last extract and then gives you several options
for synchronizing the files in your local workspace with files in CMVC. If there are
conflicts between the two sets of files, the Synchronize function compares the
version number associated with the file in your workspace to the version number in
CMVC. If the two sets of files are the same, the CMVC Version Control Feature
issues a message telling you there are no differences between the files. The
Synchronize view uses three different modes, which you can switch among by
choosing the appropriate mode on the title bar of the Synchronize view:
Mode Description
Incoming mode Only resources that have been created or
changed in CMVC since you last
synchronized your workspace files with the
files in CMVC are visible
Outgoing mode Only resources that have been created,
changed, or deleted in the workspace since
you last synchronized your workspace files
with the files in CMVC are visible
Incoming/outgoing mode Both incoming and outgoing changes are
visible
The different synchronization modes not only filter the files that you can view, but
the modes also restrict the set of CMVC actions you can perform on those files.
The following table summarizes which actions are available in the different modes
given three common scenarios when synchronizing workspace files with the most
recent files in CMVC:
Scenario Incoming mode Outgoing mode

Version number of the file in Since the files are the same, Since the files are the same,
your workspace matches the they are not shown in the they are not shown in the
version number of the file in Synchronize view Synchronize view
CMVC
The file does not exist in your You can choose to extract You can choose to delete the
workspace; the version the file from CMVC to your file in CMVC.
number of the file in CMVC is workspace.
1.1
The file exists in your You can choose to delete the You can create the file in
workspace, but does not file from your workspace. CMVC.
exist in CMVC.
Note: The Synchronize with Level function only uses the incoming mode; because
you are synchronizing with committed CMVC levels, you can only make

changes to the files in your workspace.
See “Using Workbench views to perform CMVC Version Control Feature tasks” on
page 26 for more information about the Synchronize view.
Synchronizing workspace files with the most recent versions in

CMVC
To synchronize your workspace files with the most recent version of the files in
CMVC:
1. Select the project or files in your workspace that you want to synchronize with
CMVC.
2. Right-click, then click Team > Synchronize > With Latest. The CMVC Version
Control Feature compares the files in your workspace with the files in CMVC
and produces a list of conflicts in the Synchronize view. The Synchronize view
is set to incoming mode by default. See “Using Workbench views to perform
CMVC Version Control Feature tasks” on page 26 for more information about
the Synchronize view and its three different modes.
Figure 43. Synchronize view after selecting Team > Synchronize > With Latest
Note: If the contents of your workspace are the same as the contents of
CMVC, nothing will appear in the Synchronize view, and you will get a
message saying the files are the same in both places.
3. In the Synchronize view, right-click the file you want to resolve, then select the
appropriate action to make the workspace file consistent with the file in CMVC.
You can also double-click the file to open the Compare editor, which allows you
to compare and merge together the contents of your workspace file with the
latest version in CMVC. See “Comparing files” on page 37 for more information
about comparing files.
Figure 44. Resolving a conflict in the Synchronize view
Synchronizing workspace files with any level in CMVC

To synchronize your workspace files with any level of the files in CMVC:
1. Select the project or files in your workspace that you want to synchronize with
CMVC.
2. Right-click, then click Team > Synchronize > With Level.
3. In the Choose a Level for Synchronization window, select whether you want to
synchronize your workspace files with a committed CMVC level, or whether you
want to synchronize your workspace files with an uncommitted CMVC level. If
there are no uncommitted CMVC levels, this option is disabled.
Figure 45. Choose a Level for Synchronization window
4. Click the level you want to synchronize with, then click OK. The CMVC Version
Control Feature compares the files in your workspace with the files in CMVC
and produces a list of conflicts in the Synchronize view. By default, the
Synchronize view is set to incoming mode; the outgoing and incoming/outgoing

modes are disabled when synchronizing with a level. Because the level has
been committed, you can only perform actions on your workspace files. See
“Using Workbench views to perform CMVC Version Control Feature tasks” on
page 26 for more information about the Synchronize view and its three different
modes.
Figure 46. Synchronize view after selecting Team > Synchronize > With Level
Note: If the contents of your workspace are the same as the contents of
CMVC, nothing will appear in the Synchronize view, and you will get a
message saying the files are the same in both places.
5. In the Synchronize view, right-click the file you want to resolve, then select the
appropriate action to make the workspace file consistent with the file in CMVC.
You can also double-click the file to open the Compare editor, which allows you
to compare the contents of your workspace file with the latest version in CMVC.
See “Comparing files” on page 37 for more information about comparing files.
Figure 47. Resolving a conflict in the Synchronize view
Synchronizing workspace lock decorators with CMVC

To ensure that you are seeing the correct lock decorators on the files in your
workspace, you must synchronize the lock decorators of the files. You can
synchronize the lock decorators for individual files or entire projects. See “Setting
global preferences” on page 9 for more information about label decorations.
To synchronize the lock decorators in your workspace with the state of files in
CMVC:
1. Select the project or files you want to synchronize.
2. Right-click, then click Team > Sync Lock from the context menu. The CMVC
Version Control Feature compares the files in your workspace with the files in
CMVC and changes the lock decorators in your workspace as needed.
Note: If the state of the files in your workspace are the same as the state of
the files in CMVC, no decorators will change in your workspace.
Undoing file changes in CMVC

Undoing file changes in CMVC does not modify the corresponding file in your
workspace.
To undo file changes on a file stored in CMVC:

1. In the CMVC File Queries view, select the file you want to undo changes for.
2. Right-click, then click Undo.
3. In the Undo window, type the required and optional information, such as a
defect or feature name.
4. Click OK.
Unlocking files in CMVC

After you unlock a file in CMVC, the file can be modified by other users.
To unlock a file in CMVC:

1. Select the file you want to unlock.
2. Right click, then click Team > Unlock.
3. Click OK. The key icon is no longer next to the file in your workspace, indicating
that you have unlocked the file.

Appendix A. Path Mapping Examples
The CMVC Version Control Feature allows you to use different directory structures
for the files in your workspace and the files in CMVC. The CMVC Version Control
Feature uses path mappings to associate these files. Path mappings are set up in
the project properties and always assume you are mapping from your workspace to
CMVC. After you have initially set up the path mappings correctly in your project
properties, you should not have to alter the path mappings again.
Note: The following CMVC functions depend on correctly configured path

mappings:
v Comparing files
v Extracting files
v Merging files
v Replacing files
v Synchronizing files
v Synchronizing lock decorators
Although you can override the path mappings when extracting, checking in,
checking out, creating, and locking files, it is not recommended.
You set up path mappings when you create a project. The options for changing the
path of your workspace files to match the path of the files in CMVC include:
Option Description
CMVC path starts with project name By default, this setting is enabled. Turn this
option off if you do not want the path of the
file in CMVC to begin with the workspace
project name.
Suppress local path prefix The text you enter in this field will be
removed from the beginning of the path of
files in your workspace when mapping to
CMVC.
Add prefix to CMVC path The text you enter in this field will be added
to the beginning of the path of files in your
workspace when mapping to CMVC.
This section includes the following examples of how to alter your path mappings to
get a correct association between the files in your workspace and the files in
CMVC:
v “Mapping workspace path names to CMVC file names: CMVC path name starts
with workspace project name” on page 48
v “Mapping workspace path names to CMVC file names: CMVC path name does
not start with workspace project name” on page 50
Note: The CMVC Version Control Feature assumes that you are mapping from
your workspace files to the files in CMVC.

Mapping workspace path names to CMVC file names: CMVC path
name starts with workspace project name
In this example, a developer has a workspace project, named Project, which
contains files that correspond to files stored in CMVC. The developer wants to lock
the file, abc.txt, in the workspace but the path of the file in the workspace is
different from the path of the file in CMVC. The path for each file follows:
Workspace file
Project/src/abc.txt
CMVC file
Project/abc/krc/abc.txt
To successfully lock the file, the developer must alter the path mappings to
associate the two files. The developer follows these steps:
1. The developer selects the file, abc.txt, in the workspace.
Figure 48. Selecting a workspace file
2. The developer right-clicks, then clicks Team > Lock.
Figure 49. Clicking Team > Lock
3. In the Lock window, the developer types the following information to correctly
set up the path mappings:
Note: The window shows you the resulting path dynamically as you type in the
fields and gives you a warning message in red if the file paths do not
match.
CMVC path starts with project name
Because both file paths begin with the project name, Project, the
developer leaves this option selected.
Suppress local path prefix
The file in CMVC does not contain an ″s″ in the path, so the developer
types ″s″ in this field to suppress the character resulting in the
workspace path: Project/rc/abc1.txt.
Figure 50. Suppress local path prefix mapping
Add prefix to CMVC path

The only difference now between the two file paths is that the CMVC
path contains a ″abc/k.″ The developer types ″abc/k″ in this field to add
this to the path, resulting in the workspace path Project/abc/krc/abc1.txt.
Appendix A. Path Mapping Examples 49

Figure 51. Add prefix to CMVC path mapping
4. The developer types in the other required and optional information, then clicks
OK. A key icon appears next to the file in the developer’s workspace, indicating
that the developer has successfully locked the file.
Mapping workspace path names to CMVC file names: CMVC path

name does not start with workspace project name
In this example, a developer has a workspace project, named Check, which
contains files that correspond to files stored in CMVC. The developer wants to lock
the file, abc.txt, in the workspace but the path of the file in the workspace is
different from the path of the file in CMVC. The path for each file follows:
Workspace file
Check/ssrc/abc.txt
CMVC file
Project/src/abc.txt
To successfully lock the file, the developer must alter the path mappings to
associate the two files. The developer follows these steps:
1. The developer selects the file, abc.txt, in the workspace.
Figure 52. Selecting a workspace file
2. The developer right-clicks, then clicks Team > Lock.
Figure 53. Clicking Team > Lock
3. In the Lock window, the developer types the following information to correctly
set up the path mappings:
Note: The window shows you the resulting path dynamically as you type in the
fields and gives you a warning message in red if the file paths do not
match.
CMVC path starts with project name
Because the path of the CMVC file does not begin with the workspace
project name, Check, the developer leaves deselects this option,
resulting in the path ssrc/abc.txt.

Figure 54. CMVC path starts with project name mapping
Suppress local path prefix

The file in CMVC does not contain an ″ssrc″ in the path, so the
developer types ″s″ in this field to suppress the first ″s,″ resulting in the
workspace path: Project/rc/abc1.txt.
Figure 55. Suppress local path prefix mapping
Add prefix to CMVC path

The only difference now between the two file paths is the beginning of
the path. The developer types ″Project″ in this field to add this to the
path, resulting in the workspace path Project/src/abc.txt.
Figure 56. Add prefix to CMVC path mapping
4. The developer types in the other required and optional information, then clicks
OK. A key icon appears next to the file in the developer’s workspace, indicating
that the developer has successfully locked the file.

Appendix B. Synchronization Example
The Synchronize function allows you to check whether newer versions of files have
been checked into CMVC since your last extract and then gives you several options
for synchronizing the files in your local workspace with files in CMVC.
Synchronizing workspace files with the most recent versions in CMVC

In this example, a developer has a workspace project, named Project, which
contains files that correspond to files stored in CMVC. The developer wants to see
if newer versions of the files have been checked into CMVC since the last extract.
To synchronize the files, the developer follows these steps:
1. The developer selects the workspace project, Project.
2. The developer right-clicks, then clicks Team > Synchronize > With Latest. The
CMVC Version Control Feature compares the files in the workspace with the
files in CMVC and produces a list of conflicts in the Synchronize view. The
Synchronize view is set to incoming mode by default.
3. In the Synchronize view, the developer sees that the file abc.txt exists in his
workspace, but not in CMVC. The developer no longer needs this file and
decides not to create the file in CMVC. The developer right-clicks abc.txt, then
clicks Delete Workspace File. The file is deleted from the developer’s
workspace.
4. Also in the Synchronize view, the developer sees that the file java.txt has been
created in CMVC since he last synchronized with the repository. The developer
right-clicks java.txt, then clicks Extract. Java.txt is copied to the developer’s
workspace.

Index
C L
CMVC Linux problem with WSxD products 2
Support Web site 8
CMVC InfoCenter ix
contact information ix P
preference set
deleting 24
D editing 22
downloading preferences, global
WebSphere Studio Workbench 1 CMVC Version Control Feature 9
security 9
Workbench 9
E project
Eclipse associating with CMVC 16
open-source project 1 creating 15
Web site 1 removing associations 26
example setting up a project share 16
synchronization 55 updating associations 26
examples
path mapping 47
Q
queries
F saving to the CMVC Files Query List view 34
feedback ix
files
checking into CMVC 36 R
checking out of CMVC 36 removing Workbench features 8
comparing any two versions in CMVC 37
comparing workspace version with CMVC file 37,
39, 40, 42, 43, 44 S
copying from CMVC 38 SDWB InfoCenter ix
creating in CMVC 38 SDWB terminology ix
deleting in CMVC 38 software requirements
extracting from CMVC 38 Linux workaround for WSxD problem 2
locking in CMVC 39 supported CMVC server version 2
merging workspace version with CMVC file 39 supported WebSphere Studio Workbench products
merging workspace version with most recent CMVC and versions 1
file 39 summary of changes ix
renaming in CMVC 40 supported WebSphere Studio Workbench products and
synchronizing workspace files with CMVC files 41 versions 1
undoing changes in CMVC 45
unlocking in CMVC 45
T
Task quick reference 31
G terminology
global settings 9 IBM and industry ix
SDWB ix
I
IBM Terminology Database ix U
Install/Update Manager 3, 6 updates to this guide ix
installing the CMVC Version Control Feature updating the CMVC Version Control Feature
instructions 3 instructions 6
URL for Install/Update Manager site bookmark 3 URL for Install/Update Manager site bookmark 6
using the Workbench Install/Update Manager 3 using the Workbench Install/Update Manager 6

V WebSphere Studio Workbench (continued)
downloading 1
Views
installing features 3
Any workspace navigation view 27
Linux problem with WSxD products 2
CMVC File Queries view 27
overview 1
CMVC Query List view 29
removing features 8
CMVC Repository Explorer 28
supported products and versions 1
CMVC Synchronize view 28
updating features 6
views, Workbench
Workbench
showing 26
perspectives 26
used by the CMVC Version Control Feature 26
views 26
W
WebSphere Studio Workbench
documentation 1

CMVCVersion Control User Guide

Загружено:

Сведения о документе

Оригинальное название

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

CMVCVersion Control User Guide

Загружено:

Авторское право:

Доступные форматы

SDWB 5.

CMVC Version Control Feature for

About this guide . . . . . . . . . . . . . . . . . . . . . . . . ix

Chapter 2. Installing, updating, or removing the CMVC Version Control

Chapter 3. Getting started. . . . . . . . . . . . . . . . . . . . . 9

Chapter 4. File management tasks . . . . . . . . . . . . . . . . . 31

© Copyright IBM Corp. 2003 iii

Appendix A. Path Mapping Examples . . . . . . . . . . . . . . . . 47

Appendix B. Synchronization Example . . . . . . . . . . . . . . . 55

© Copyright IBM Corp. 2003 vii

Who should read this guide?

What has changed?

What else should you read?

To access all SDWB documentation, see the SDWB Web site at

Terminology used in this guide

How to send your comments

© Copyright IBM Corp. 2003 ix

Supported WebSphere Studio Workbench products

What is the WebSphere Studio Workbench?

In addition to providing an environment for integrated development, the Workbench

Developers can use the prepackaged Workbench presentation and functions, or

© Copyright IBM Corp. 2003 1

Figure 1. CMVC Support Web site

Workbench download sites

Supported CMVC server versions

Installing the CMVC Version Control Feature

Step 1. Open the Workbench Install/Update perspective

Figure 2. Opening the Workbench Install/Update Perspective

Step 2. Create a site bookmark for the SDWB download site

To create a site bookmark:

© Copyright IBM Corp. 2003 3

2. In the New Site Bookmark window:

Figure 4. Settings for the SDWB 5.0 download site bookmark

Step 3. Install the CMVC Version Control Feature

Figure 6. Available SDWB features

Chapter 2. Installing, updating, or removing the CMVC Version Control Feature 5

3. To install, click Install Now > Next.

Installing feature updates

Step 1. Check for available feature updates

Step 2. If updates are available, open your Workbench Install/Update

Step 3. Install updates for the CMVC Version Control Feature

Figure 9. Available SDWB features

2. Select the CMVC Version Control Feature:

Chapter 2. Installing, updating, or removing the CMVC Version Control Feature 7

Figure 11. CMVC Support Web site

Setting global preferences

Workbench label decoration preference

To verify that the Workbench label decoration preference is enabled:

© Copyright IBM Corp. 2003 9

Table 2. Global CMVC preferences

Turn this option on if you want workspace files you check

Turn this option on if you want CMVC files that you

Chapter 3. Getting started 11

Turn this option on if you want CMVC to back up files that

Turn this option off if you want to see messages only if an

Turn this option on if you are working in a release using

Turn this option off if you want to suppress keyword

Turn this option on if you want the CMVC command

Turn this option on if you want to prefill the Defect

Note: If you attempt to check in two or more files that

Turn this option on if you want the last-entered defect or

Note: When both the ″Prefill defect/feature name on

Turn this option off if you wish to perform CMVC actions