Using the Compass OSLC REST interface with VersionVault UCM

VersionVault UCM users can use Compass UCM integrations that use the Compass OSLC REST API. For information about the Compass OSLC REST API, refer to Compass documentation.

Supported client types

Use of the OSLC REST interface is supported by
  • Native VersionVault clients such as cleartool and VersionVault Windows Explorer.

Connecting to Compass

To specify the connection to the Compass OSLC REST API (a web URL connection), use the crmregister command. By specifying a web URL connection, you configure the integration to use the implementation for all Compass-enabled UCM Projects that use the specified Compass database. If a web URL connection is not provided, then the assumed configuration is a LAN connection to the Compass native Windows client.

Supported features

The OSLC REST interface supports the following features:
  • Listing activities. On VersionVault Windows Explorer, the My Activities list can be displayed through the activity dropdown in a checkout dialog. The 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.) Only assigned Compass records that have their UCM Project field set are displayed. This field is set by a cleartool setactivity operation or when a Compass record is assigned to a user.
  • Setting activities. Use cleartool setactivity to enable work on a specified Compass record. You can also set an activity in a VersionVault 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 fails and you must use Compass client to specify values for the required fields.
  • Delivering and Rebasing. These operations are supported by cleartool and the GUIs.
  • The Transition-to-Complete-After-Delivery Policy. When enabled, this policy transitions Compass records to the Complete state type after delivery. If a required field is missing, however, the operation fails and you must use Compass client to specify values for the required fields.
  • Other supported Compass policies:
    • Perform Compass Action Before Delivery
    • Perform Compass Action After Delivery
    • Perform Compass Action Before Work On
    • Transition To Complete After Changing Activity
  • Changing activity headlines. You can use the cleartool chactivity -headline command or the VersionVault GUIs to change an activity headline.
  • Moving change set activities. You can use either cleartool chactivity -fcset src-activity-selector -tcset dest-activity-selector or the VersionVault GUIs.
  • Viewing and changing Compass Project policies. You can display the project policies using cleartool lsproject or the VersionVault Project Explorer. Only the Project Explorer supports policy modifications.
  • Enabling or disabling a UCM Project. This operation may be performed using the cleartool chproject command or the VersionVault Project Explorer GUI.
  • Displaying Compass record state and ID information. Use cleartool describe -long activity-selector.
  • Deleting UCM activities. Use cleartool rmactivity or the VersionVault Project Explorer