IBM Support

Capabilities and limitations of ClearCase UCM integrations with ClearQuest

Question & Answer


How do the features of ClearCase UCM integrations with ClearQuest differ?


Over the course of many releases, ClearCase has introduced a variety of integrations with various change management (CM) systems, such as ClearQuest and Rational Team Concert. The implementations of these integrations were always dependent on the CM system and the ClearCase context: GUIs, command line interfaces, integrated with Eclipse, the ClearCase local client (CCLC; the "thick" client, which supports dynamic and snapshot views), and the ClearCase remote client (CCRC, which supports automatic and Web views). Further, the integrations are differentiated by the ClearCase configuration management model: Unified Change Management (UCM) or base ClearCase.

The Change Management Integration (CMI) architecture was introduced in 2013. It is a robust implementation in the core of ClearCase that provides a uniform and extensible integration across all ClearCase contexts and both configuration management models.

  • CMI supports the GUIs and command line interfaces of CCLC and CCRC.
  • It supports both base ClearCase and UCM. Further, it allows multiple CM systems to be used in a single ClearCase UCM project context.
  • As of ClearCase versions and, CMI be configured for ClearQuest, Rational Team Concert, and Jira.
  • It provides security for customers who require smart card authentication.

CMI was designed to accommodate the realities of a loosely coupled integration. The older UCM-CCLC integration, in particular, created the illusion that ClearCase and ClearQuest were tightly coupled. However, separate transactions--one for ClearCase and one for ClearQuest--are required to complete an integrated operation, which means that the operations may only partially succeed and leave ClearCase and ClearQuest data in inconsistent states. CMI logs partial failures and supports replaying failed operations to restore consistency.

As a result of the different design goals, CMI provides features not possible with the older integrations and does not provide some of the features of the older integrations. However, bear in mind that features available only in the older integrations are supported in sharply limited contexts that may not be adaptable to evolving business requirements.

The table that follows compares the capabilities and limitations of the following ClearCase integrations with ClearQuest.
  • ClearCase UCM with locally installed ClearQuest, referred to as the local client integration.
    this integration is not supported in V9.0 and later releases
  • ClearCase UCM with ClearQuest Web, referred to as the web client integration.
  • ClearCase Change Management Interface (CMI) configured for ClearQuest, referred to as the CMI integration.

FeatureLocal client integrationWeb client integrationCMI integrationNotes
Uses remote OSLC Change Management (CM) interface on CM serverNoYesYes
Requires local ClearQuest clientYesNoNo.
Is configurable on UCM streamNoNoYes
Is configurable on UCM projectYesYesNo
Is configurable on base ClearCase branch typeNoNoYes
Supports base ClearCaseNoNoYes
Supports record creation from ClearCaseYesYes, for ClearTeam Explorer; no, for other ClearCase interfacesNoThe local client integration enables you to use the cleartool mkactivity command to create a new ClearQuest record.
Hides activity creationYesYesNoThe local and web integrations intentionally restrict you to using only ClearQuest records as your activities.
Supports ClearTeam ExplorerNoYesSomeUsing the web integration, you can perform a WorkOn operation, run queries, and find activities. CMI supports ClearTeam Explorer but does not make use of its built-in ClearQuest functionality (that is, ClearQuest nodes in the Navigator pane).
Supports rcleartoolNoNoNo
Can perform StartWork operations from ClearQuestYesYesNoFrom the local client integration, you can set the record/activity as the current one. The web client integration opens a ClearCase browser (that is, one of the "Explorers" or xclearcase) for you to select a view.
Displays ClearQuest records instead of activitiesYesYesNoThe local and web client integrations do not display UCM activities. Work is performed on the record and the linked activity is hidden.
Can link activities to recordsYesYesYesThe local and web integrations match the IDs and Headlines of the record to the corresponding activity. They also populate the record with the stream, VOB, and view information. CMI creates only links between the activity and the record.
Unsets activities from view after deliveryYesYesNo, but a ClearCase trigger can be used to effect an equivalent operation for CMI
Supports ClearQuest server side connection to CCYesYesNoSome customization in the local and web client integrations, in the form of BASIC or Perl scripts, is supported. Some of the ClearQuest defaults call back to ClearCase as well, but they can do whatever the administrator configures them to do. This is part of the ClearQuest UCM package and allows ClearQuest to control the policies governing the local and web client integrations.
Supports ClearQuest UCM Package (fields controlled)YesYesNoSeveral fields on the ClearQuest records that use the UCM Package (which is required for for both the local and web client integrations) are not user-modifiable. Queries are populated against these fields. There is a tab on the ClearQuest form reserved for the package (Unified Change Management) that contains the UCM Project, Stream, View, and the Change Set, which is fetched from ClearCase and not stored locally in ClearQuest.
Supports policiesYesYesSomeMost of the ClearQuest integration policies are for performing ClearQuest actions that are specified in the scripts, either before or after some ClearCase operation: WorkOn, deliver, or chactivity
Provides policy administration GUIYesYesNoThe local and web client integrations support changing policies using the Project Explorer GUI. This also includes which record types are allowed. You can view the policies from either integration in the project record. They are modifiable by the local client integration, but not by the web client integration.
Can query for records to useYesYesYes
Supports custom static queries (none of the integrations support custom dynamic queries)YesYes, for ClearTeam Explorer; no for other ClearCase interfacesYes, extensiveThe local client integration supports modification of UCMCustomQuery1. For CMI, a query must be specified (there is no default).
Supports state transitionsYesYesYesThe local and web client integrations support enforced state transitions as well as some optional transitions that are configured by policy. CMI supports state transitions for both UCM and base ClearCase.
Supports custom state transitionsNoNoYes, extensiveCMI supports customizable state transitions, but they are not configured by default. Because the UCM package strictly controls the record types, it is not possible to customize state transitions.
Supports ClearCase triggers for restricting configurationYesYesYesConfiguration of the local and web client integrations can be restricted with triggers on chproject and mkproject operations. For CMI, configuration can be restricted with triggers on mkcmprovider and rmprovider.
Supports configuration inheritanceNoNoYesWith CMI, a child streams inherits the parent's configuration, unless CMI is explicitly configured on the child stream.
Supports proxy serversNoYesNoThe web client integration supports proxy servers through the Windows and Unix/Linux native GUIs and ClearTeam Explorer.
Supports ClearTeam Explorer ClearQuest proxy serversNoYesNoThe web client integration uses the cq-db-mapfile to support both a back-end proxy and a proxy for the ClearQuest Change Management API through ClearTeam Explorer.
Supports ClearQuest Multisite YesYesNoSome policies in the local and web client integrations allow you to change the mastership of a record to the ClearQuest replica that is associated with the ClearCase replica that masters the linked activity. You cannot change mastership if the ClearQuest record is not locally mastered.
Supports ClearCase Multisite YesYesYesIn a ClearCase MultiSite deployment, you must create the CMI attribute types to have shared mastership and you must specify the VOB's mkcmprovider configuration at the site that masters the replica object of interest. The site must also master the branch types or streams that are to be configured. Tasks on the ClearCase side are VOB objects and are replicated. Both base ClearCase and UCM are supported.
Supports multiple Change Management (CM) server connectionsNoNoYes, except for a configuration of ClearTeam Explorer with the Rational Team Concert Bridge
Supports other task providersNoNoYesCMI can also be configured for Rational Team Concert and JIRA.
Checks credentials on registrationYesYesNoCMI maps user credentials but does not verify them (intentionally).
Provides GUI for crmregister operationsYesNoNo
Supports smart card authenticationNoNoYes
Supports discordance repairYesYesYes
Logs errorsNoNoYes
Supports replayYesYesYes
Supports atomic checkin operationsNoNoYes
Supports Cadence Virtuoso integrationNoNoYes
Supports automatic viewsNoYesYes
Supports ClearCase MultiSite and ClearQuest MultiSite used togetherNoNoYes
Supports migration from (perl-based) Base CC integrationNoNoYesCMI supports full migration (except any custom perl scripts) of all existing links from the perl-based integration to CMI.

[{"Product":{"code":"SSSH27","label":"Rational ClearCase"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Integrations","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF010","label":"HP-UX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"}],"Version":";;;;;;9.0.0","Edition":"","Line of Business":{"code":"LOB36","label":"IBM Automation"}}]

Document Information

Modified date:
24 October 2018