Adding a VersionVault UCM integration

The HCL VersionVault Unified Change Management (UCM) integration with HCL Compass links UCM projects and activities to Compass records.

The UCM integration with Compass has the following requirements:

  • A Compass schema that is enabled for UCM
  • VersionVault with a project enabled for Compass

Compass provides two predefined schemas that support UCM: the UnifiedChangeManagement schema and the Enterprise schema. You can implement UCM support by using one of these schemas. See Working with schemas.

You can also add UCM support to an existing schema by adding the appropriate packages. You must perform the following steps, in the specified order, to integrate UCM with packages:

  1. Add the AMStateType package.
  2. Set the default actions for UCM.
  3. Add the UCMPolicyScripts package.
  4. Add the UnifiedChangeManagement package.
  5. Optional: Add the BaseCMActivity package.
  6. Validate and apply the schema changes.
  7. Configure UCM.

See Enabling record types for integrations if you already have the AMStateType, UCMPolicyScripts, UnifiedChangeManagement, and BaseCMActivity packages in your schema and you want to apply the packages to a new record type.

Attention: While the UCM integration lets you work with VersionVault, do not add the VersionVault package to use the UCM integration. The VersionVault package is used only for a Base VersionVault integration that does not set predefined policies. See Optional: Adding the BaseCMActivity package for instructions on adding a Base VersionVault integration.

Adding the AMStateType package

  1. Use the Designer to ensure that the schema to which you want to add the package is checked in.
  2. Add the latest AMStateType package. See Applying package upgrades.
  3. The AMStateType package requires that you map state types and define default actions if these are not already defined.
    1. Select the record types to enable for UCM and click Next.
    2. Map the states in your schema to the UCM state types in the Setup State Types window:
    3. Repeat the state type mapping for each record type you enabled.
    4. Click Finish.

      Compass automatically validates your schema. The validation window indicates 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 Waiting to Ready to Active to Complete. See Displaying the state model for a record type and State type models for packages.

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 to the next state type in the UCM state type model. See Actions and action types.

Adding the UCMPolicyScripts package

  1. Use the Designer to ensure that the schema to which you want to add the package is checked in.
  2. Add the latest UCMPolicyScripts package. See Applying package upgrades.
Attention: Because you are not in a record when you are running these hooks, you must explicitly retrieve the record details. See Entities and Hooks.

Adding the UnifiedChangeManagement package

  1. Use the Designer to ensure that the schema to which you want to add the package is checked in.
  2. Add the latest UnifiedChangeManagement package. See Applying package upgrades.

Optional: Adding the BaseCMActivity package

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.

  1. Use the Designer to ensure that the schema to which you want to add the package is checked in.
  2. Add the latest BaseCMActivity package. See Applying package upgrades.
  3. Edit the state types for the BaseCMActivity package. See Applying package upgrades.

Validating and applying the schema changes

Save the schema changes after installing the last UCM package:

  1. Validate the schema changes. See Validating schema changes.
  2. Check in the schema to save the schema changes. See Checking in a schema.
  3. Apply the schema changes to the user database. See Upgrading a user database.

Configuring UCM

Configure HCL VersionVault UCM, as needed. See the VersionVault help for configuration details.