State type models for packages

This topic explains the concept of HCL Compass state type models.

A state type is a label that defines the role of each state in the state model. Some HCL Compass schemas have packages that require that each state in the state model be assigned or mapped to a specific state type. For example, the UnifiedChangeManagement schema and package use state types to invoke specific HCL VersionVault actions. The Resolution package uses state types to invoke certain hooks when a record moves to a state mapped to the Resolved state type.

When you add a new state to a schema that uses state types, you must map the new state to a state type. See Mapping state types.

State type model for Resolution package

The following table and diagram show the state types and an example of a valid state mapping for the Resolution package.

State type
Description
Not_Resolved
The record is not resolved.
Resolved
The record is resolved.
Figure 1: State type model for Resolution package
The image illustrates the states, state types, and actions for record types in the Resolution package.

State type model for UnifiedChangeManagement package

The following table and diagram show the state types and a valid state mapping for the UCM package. The default actions of the states must provide a complete transition through the state type model.

State type Description Mapped state in UCM schema
Waiting Record not yet assigned, evaluated, or scheduled. Submitted Postponed
Ready Record was assigned. It appears in the To Do List query of the assigned user and is ready to be worked on. The ucm_project field might or might not be set. Assigned
Active User has started working on the record, which is now associated with a HCL VersionVault project and can contain HCL VersionVault element information. Opened
Complete

The record is in one of two states:

  • Worked on and completed, which is associated with a HCL VersionVault project and can contain HCL VersionVault element information, or not worked on and abandoned.
  • Postponed or closed, which might or might not be associated with a HCL VersionVault project.
Resolved Closed Duplicate
Figure 2: State type model for Enhancement record type
The image illustrates the states, state types, and actions for the Enhancement record type.