Design object store extensions

Edit online
Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15
The design object store extensions include metadata that is required for design object store functions. The extensions provide property templates and implement custom classes, instances, and properties.
You can use IBM® Administration Console for Content Platform Engine to view the metadata. You can also view the following properties for the design object store AddOn:
Display name
<Release>Case Manager Design Object Store Extensions.
XML import data
CM_CMDOS_CEExtensions.xml
Installation type
Optional.
Prerequisites
Base Content Platform Engine Extensions.
Required by
None.
Important: Do not modify the values for properties on object classes that are created by Business Automation Workflow. Changing these values can cause application behavior issues. In addition, do not extend the classes for other software applications.

Choice lists

The design object store extensions define choice lists that provide collections of predefined property values that you can use to present users with a list of values from which to choose. To review these choice lists in IBM Administration Console for Content Platform Engine:
  1. In the domain navigation pane, select the design object store.
  2. In the object store navigation pane, click Data Design > Choice Lists.
The following table lists the choice lists that are defined by the design object store extensions:
Display name Description
CmAcmIntegrationTypeChoiceList Defines choices for the types of repository in which case documents are stored. By default, this value is set to Content Cortex repositories for solutions, project areas, target environments, and target object stores.
CmAcmRuleTypeChoiceList Defines choices that indicate whether a business rule is text-based or table-based.
CmAcmTargetEnvironmentTypeChoiceList Defines choices that indicate whether the target environment is a development environment or a production environment.
CmAcmTypeChoiceList Defines choices that indicate the type of a page. The choice list is used by the Type (CmAcmType) property of the Page (CmAcmPage) class.
CmAcmVcsStatusChoiceList Defines the choices that indicate the status of the Commit and Deliver actions in Case Builder, which are related to version control system (VCS) integration. The choice list is used by the Commit Status (CmAcmVcsCommitStatus) and Deliver Status (CmAcmVcsDeliverStatus) properties of the VCS Execution State (CmAcmVcsExecutionState).

Custom object classes

The design object store extensions define custom objects that are used to track solution artifact definitions and solution locks. To review these custom objects in IBM Administration Console for Content Platform Engine:
  1. In the domain navigation pane, select the design object store.
  2. In the object store navigation pane, click Data Design > Classes > Custom Object.
The following table lists the custom objects that are defined by the design object store extensions:
Display name (symbolic name) Description
Draft Area (CmAcmDraftArea) Defines an area that contains the saved solution artifact definitions.
Solution Lock Control (CmAcmSolutionLockControl) Defines the definition entries for locks in a solution and tracks the save sequence number for the solution.

Document classes

The design object store extensions define classes that represent various document objects that are associated with a solution. To review these document classes in IBM Administration Console for Content Platform Engine:
  1. In the domain navigation pane, select the design object store.
  2. In the object store navigation pane, click Data Design > Classes > Document.
The following table lists the document classes that are defined by the design object store extensions:
Display name (symbolic name) Description
Connection Definition (CmAcmConnectionDefinition) Defines the Case Builder or Case Client association with the target environment. One connection definition exists for each target environment to which a case management solution is deployed.
Page (CmAcmPage) Defines a page that contains the widgets that are required to complete a task.
Rule (CmAcmRule) Defines a business rule.
VCS Execution State (CmAcmVcsExecutionState) Defines the status of actions that are related to the version control system for a solution, such as commit and deliver.
View (CmAcmView) Defines a view for the Properties widget.
Widgets Package (CmAcmWidgetsPackage) Defines a package of widgets that can be used in workflows.

Folder classes

The design object store extensions define classes that represent various folder objects that are used as containers for solution objects. To review these document classes in IBM Administration Console for Content Platform Engine:
  1. In the domain navigation pane, select the design object store.
  2. In the object store navigation pane, click Data Design > Classes > Folder.
The following table lists the folder classes that are defined by the design object store extensions:
Display name (symbolic name) Description
ReinitArtifacts (CmAcmReinitArtifacts) Defines a folder that contains artifacts that are used when the test environment is reset. These artifacts include code modules and documents from the target object store, the manifest of the target environment, and the status of the most recent (current or past) reset of the test environment.
Solution Folder (CmAcmSolutionFolder) Defines a folder for a solution.