Adding a Rational UCM integration

The Unified Change Management (UCM) integration links Rational® ClearCase® UCM projects and activities to Rational ClearQuest® records.

This is also known as a UCM-Rational ClearCase integration.

The UCM integration requires:

Rational ClearQuest provides two predefined schemas that support UCM: the UnifiedChangeManagement schema, and the Enterprise schema. The easiest way to implement UCM is to use one of these schemas. For instructions on using schemas, see Working with ClearQuest schemas.

You can also add UCM support to an existing schema by adding the correct packages to it. This section describes integrating Rational ClearQuest and UCM by adding packages. These packages must be added in the order described in each step.

Note: Although the UCM integration allows you to work with Rational ClearCase, you must not add the Rational ClearCase package for this integration. The Rational ClearCase package is used only for a Base Rational ClearCase integration,which does not set up predefined Rational ClearCase policies. See Adding independent integrations for instructions on adding a Base Rational ClearCase integration.

Integrating Rational UCM with packages requires that the following steps be done in the order listed. Each step is described in the sections that follow.

  1. Adding the AMStateTypes package.
  2. Setting the default actions for UCM.
  3. Adding the UCMPolicyScripts package.
  4. Adding the UnifiedChangeManagement package.
  5. Adding the BaseCMActivity package (optional).
  6. Saving the schema changes.
  7. Configuring Rational UCM.
Warning: To avoid errors, you must install packages in the order described.
Note: If you already have the AMStateType, UCMPolicyScripts, UnifiedChangeManagement, and BaseCMActivity packages in your schema, and you just want to apply them to a new record type, see Enabling record types for integrations.

For complete information on setting up and using the UCM integration, see IBM Rational ClearCase Guide to Managing Software Projects.

Adding the AMStateTypes package

  1. In Rational ClearQuest Designer, make sure the schema you want to add the package to is checked in. To check in a schema, click File > Check In.
  2. Click Package > Package Wizard and add the latest AMStateType package. See Applying package upgrades for detailed instructions.

    The AMStateType package requires you to map state types and define default actions, if they have not already been defined.

    Select the record type(s) to enable for UCM and click Next to display the Setup State Types window.
  3. In the Setup State Types window, map the states in your schema to the UCM state types:
  4. Repeat the state type mapping for each record type you enabled. Click Finish.

    Rational ClearQuest automatically validates your schema. The validation window will indicate that you need to set default actions.

Setting the default actions for UCM

The State Transition Matrix in your schema must provide at least one path through the state type model for the UnifiedChangeManagement package, from the Waiting state type, to Ready, to Active, to Complete. See To display the State Transition Matrix for a Defect record type and State-type models for packages for more information.

For each state in your schema, except the state mapped to the UCM Complete state, you must assign a default action that moves the record from that state to the next state type in the UCM state type model. See Working with actions and action types or more information.

To assign default actions:

  1. In Rational ClearQuest Designer, expand Record Types, then expand the record type you enabled for UCM, and double-click its State Transition Matrix.
  2. In the State Transition Matrix, right-click a state and click Properties to open the Properties window for that state.
  3. In the Default Action tab of the Properties window, select a default action for the state. The Default Action tab lists the actions you have created for your state transitions in the State Transition Matrix.

    For each state, select the action that moves the record to a state that is mapped to the next state type in the UCM model. For example, the Submitted state (Waiting) moves to the Assigned state (Ready) through the Assign default action. If your schema has a Closed state and it is mapped to the Complete state type, it does not need a default action.

  4. Click File > Check In to check in the schema. See Checking in a schema for detailed instructions.

For more information, see Working with actions and action types and State-type models for packages.

Adding the UCMPolicyScripts package

  1. With the schema checked in, click Package > Package Wizard and add the latest UCMPolicyScripts. See Applying package upgrades for detailed instructions.
  2. Select File > Check In to check in the schema.
Note: Because you are not in a record when you are running these hooks, you must explicitly retrieve the record details. For more information, see Entities and Hooks.

Adding the UnifiedChangeManagement package

  1. With the schema checked in, click Package > Package Wizard and add the latest UnifiedChangeManagement package.
  2. Select File > Check In to check in the schema.

Adding the BaseCMActivity package (optional)

The BaseCMActivity package adds a lightweight activity record type to your schema. You can use this alternative to the Defect record type as is, enable it for UCM, or develop it into a new record type. This package is optional. For a more intense activity tracker, see Using IBM Rational ClearQuest Project Tracker.

  1. With the schema checked in, click Package > Package Wizard and add the latest BaseCMActivity package.
  2. Edit the state types for the BaseCMActivity package. See Applying package upgrades for detailed instructions.
  3. Click File > Check In to check in the schema.

Saving the schema changes

After installing the last UCM package, do the following:

  1. Validate the schema changes. See Validating schema changes for detailed instructions.
  2. Click File > Check In to save the schema changes. See Checking in a schema for detailed instructions.
  3. Apply schema changes to the user database by clicking Database > Upgrade Database. See Upgrading a user database.

Configuring Rational UCM

Configure the UCM application as needed. See IBM Rational ClearCase Guide to Managing Software Projects for more configuration information.

Related concepts
Overview of Rational ClearQuest integration packages
Rational ClearQuest integration packages

Feedback