Overview of package application process

This topic explains the general steps involved in applying a package to a schema.

The process of applying a package to a schema can be as simple as selecting a package and clicking Finish or it can require as many as four steps:

  1. Selecting the schema.
  2. Selecting the package to apply.
  3. Selecting the record types in the schema that the package modifies.
  4. Mapping the state types in the schema to the states in the package.

You can perform the last two steps when you apply the package.

The order of the steps depends on whether you start the Package Wizard and select the schema to be modified or you check out a schema before you start the Package Wizard. As noted, you might not need to perform all steps, depending on the schema and the package selected.

Enabling record types

When a package is set to enable record types in your schema, you can specify which record types to modify. For example, a package might add fields to existing record types, and you might prefer not to add these fields in some record types. Other modifications that you might or might not make include adding actions and scripts.

For descriptions of packages, including the record types they modify, see HCL Compass packages.

Mapping state types

Some packages, such as the UnifiedChangeManagement package and the Resolution package, include a state model with state types. These packages include hooks that run when a change request enters one of these states.

A problem can arise if you apply one of these packages to an existing schema, and the state model of that schema does not include a method for getting to a state in the package. For example, if the package includes functions that are available only when a change request enters the Ready state, but the existing schema does not include a Ready state, the new functions are never available to users.

To prevent this situation, you are prompted to map the states in your schema to the state types in the package being applied (if the package includes any state types).

Every state type in the package must have at least one state from the existing schema mapped to it. This practice ensures that the schema created by applying the package includes a transition to every state type in the package.

For example, if functions in the package are available when a change request enters the Ready state, and you have mapped the Assigned state in the existing schema to the Ready state type in the package, the new functions are available when a change request enters the Assigned state.

Creating default actions

You can define default actions for states. Setting a default action ensures that there is always a way to move from a source state to a target state. Default actions are also useful for guiding users through your state model. A default action for a state appears in bold on the Actions menu in HCL Compass client.

Some schemas and packages, such as the UCM schema and package, require default actions. If you use the UCM schema or package, the default actions of your states must provide a valid path through the state type model.

Before you can define the default action for a state, you must create a state transition. See Creating a state transition.