About using the LAN ClearCase/WAN ClearQuest UCM integration that utilizes the ClearQuest OSLC REST interface

Answer

This note describes how LAN ClearCase clients using the Rational ClearCase UCM / ClearQuest integration can utilize the Rational ClearQuest OSLC REST interface. ClearCase LAN clients (also called ClearCase thick clients and ClearCase native clients) include cleartool, Project Explorer, ClearCase Explorer, and so on. This designation does not include the ClearCase Remote Client (CCRC) or ClearQuest Web.

Supported Platforms

This feature requires that both the ClearCase thick client and the ClearQuest Web server are running at version 7.1.1 or later.

Overview

Previously, the ClearCase UCM/ClearQuest integration required that both ClearCase and ClearQuest be installed on the local machine. This implied that there must be a local ClearQuest database replica available. This also implied that both ClearCase and ClearQuest must be supported on the platform of the local machine.

Now, ClearCase UCM can communicate with ClearQuest through the ClearQuest OSLC REST API, which is installed with ClearQuest Web. Note that the option to continue to use a local ClearQuest client is still available.

The crmregister tool is used to specify a connection to the ClearQuest OSLC REST API (a web URL connection). By specifying this web URL connection, you configure the integration to take advantage of the new implementation for all CQ-enabled UCM Projects that use the specified ClearQuest database. A new option, -url, is used to do this. If a web URL connection is not provided then the LAN ClearCase/LAN ClearQuest configuration is assumed.

Example

The following is an example of how to specify a web connection. This command enables all CQ-Enabled UCM projects that are linked to the CQDB1 database to use this web connection. The -url option is new.

If you are using version 7.1.1:

> crmregister add -database CQDB1 -connection Connection1 -url http://<server1>:12080/oslc/cqrest -username user1 -password mypassword

Note: If the IBM HTTP Server (IHS) is properly configured, you can use http://<server1>/oslc/cqrest instead of http://<server1>:12080/oslc/cqrest.

If you are using version 7.1.2:

> crmregister add -database CQDB1 -connection Connection1 -url http://<server1>:12080/cqweb/oslc -username user1 -password mypassword

Note: If the IBM HTTP Server (IHS) is properly configured, you can use http://<server1>/oslc/cqrest instead of http://<server1>:12080/cqweb/oslc.

Note: In version 7.1.2, the OSLC base URI has changed from http://<server>/oslc/cqrest to http://<server>/cqweb/oslc.

Supported integration features

Currently, this new configuration only supports a subset of the integration features.

The following features are supported beginning in version 7.1.1:

• My Activities List

The My Activities List is the list of ClearQuest records that are available for a user to work on. This list can be viewed through the activity dropdown in a checkout dialog, in the My Activities list of ClearCase Explorer, etc.

The My Activities List is generated by running the query, UCMCustomQuery1. Only the default version of this query is supported: customization of UCMCustomQuery1 in Personal Queries or Public Queries/UCMSystemQueries is not supported.

Note: Currently there is a limitation in which only assigned ClearQuest records that have their UCM Project field set will show up in the My Activities List. This field is automatically set as a result of a cleartool setactivity operation. Alternatively, this field can be set manually during the triage process when a ClearQuest record is assigned to a user.

• Setactivity

The cleartool setactivity operation is supported. This allows the user to work on a given CQ Record. Alternatively, a user may perform this operation in the GUI such as when selecting an activity in the dropdown of a checkout, checkin, or add to source control dialog. If a required field is missing, however, the operation will fail and the user must manually fill in the required fields using a ClearQuest client. The automatic popup of the ClearQuest record form to supply the missing fields is not yet supported.

• Deliver/Rebase

Deliver and Rebase operations are supported from both the command line and ClearCase GUIs.

• Transition to Complete After Delivery Policy

This policy, when enabled, will automatically transition CQ records to the Complete state type after delivery. If a required field is missing, however, the operation will fail and the user must manually fill in the required fields using a ClearQuest client. The automatic popup of the ClearQuest record form to supply the missing fields is not yet supported.

• ClearQuest policies:
• Perform ClearQuest Action Before Delivery
• Perform ClearQuest Action After Delivery
• Perform ClearQuest Action Before Work On
• Transition To Complete After Changing Activity
• cleartool chactivity -headline

A ClearCase-initiated headline change can either be performed from the command line or using the ClearCase GUIs.

• cleartool chactivity -fcset src-activity-selector -tcset dest-activity-selector

The move changeset activity operation can be performed from the command line or using the ClearCase GUIs.

• View ClearQuest Project policies from ClearCase client

The ClearQuest Project policies can be viewed from the command line or using the ClearCase Project Explorer GUI. Modifying the ClearQuest Project policies is not supported from the command line or the ClearCase Project Explorer GUI.

• ClearQuest enable/disable a UCM Project

This operation may be performed through the cleartool chproject command line or through the ClearCase Project Explorer GUI.

• View ClearQuest record state and ID through cleartool describe -long activity-selector

• Delete a UCM Activity

This operation may be performed using the command line or ClearCase Project Explorer GUI.

The following operations are not supported:

• ClearQuest policies:
• Perform ClearQuest Action Before Changing Activity
• Perform ClearQuest Action After Changing Activity
• Transfer ClearQuest Mastership Before Delivery
• Transfer ClearQuest Mastership After Delivery
• Prompt for missing fields during ClearQuest record state transition
• Provide web connection information via GUI prompt
• ClearQuest record form prompt when viewing UCM Activity properties
• Provide credentials for Proxy Server
• My To Do list from Public Queries/UCMSystemQueries/UCMCustomQuery1
• My To Do list from Personal Queries/UCMCustomQuery1
• View ClearQuest record state and ID in ClearCase Project Explorer's Activities list
• Submit a new ClearQuest record from checkout, checkin, and add to source control dialog
• Delete a UCM Project
• Rename a UCM Project
• cleartool checkvob -ucm

Upgrading from 7.1.1.x to 7.1.2.x, 8.0.0.x, or 8.0.1.x

With the use of ClearQuest OSLC REST API you can upgrade the ClearQuest Web Server without requiring all of the ClearCase LAN clients to be upgraded. If both the ClearQuest Web Server and CCRC CM Server exist on the same machine they both need to be upgraded simultaneously to the new version.

Please note that once the ClearQuest Web Server is upgraded to 7.1.2.x, 8.0.0.x, or 8.0.1.x from 7.1.1.x the crmregister command (detailed above) will need to be re-run on both 7.1.1.x and 7.1.2.x, 8.0.0.x, or 8.0.1.x ClearCase LAN clients to use the new ClearQuest OSLC URL.

Additional Considerations

• This feature does not remove existing requirements on your ClearQuest Web Server. ClearCase is still required to be installed on the CQ Web Server. Furthermore, your CQ Web Server's ClearCase installation must have access to the same VOBs as your users' ClearCase native clients.
• You may choose to use a centralized ClearQuest Web Server to service multiple ClearCase replicas. However, your ClearQuest Web Server may have access only to a single ClearCase replica. Therefore ClearQuest Web-initiated headline changes will not be possible for ClearQuest records bound to UCM Activities at non-local ClearCase replicas. Users will only be able to perform headline changes as ClearCase-initiated operations at the mastering sites.

For more information

For more information about OSLC (Open Services for Lifecycle Collaboration), see:
Open Services for Lifecycle Collaboration Lifecycle integration inspired by the web

For more information about the OSLC Change Management specification see the Change Management topic

For more information about the ClearQuest OSLC CM API see the Jazz.net topic "ClearQuest OSLC CM REST API"