Symbolic names

When you design a case, Case Manager Builder assigns symbolic names for metadata objects such as property descriptions, document classes, and folder classes. You use the symbolic names when you refer to these metadata objects in calls to the methods that are provided by the IBM® Case Manager REST protocol.

Typically, the symbolic name is generated from the display name that you enter for an object. The symbolic name begins with a letter and consists of uppercase and lowercase ASCII letters, decimal digits, and underscores. It can contain a maximum of 64 characters. The Content Platform Engine enforces that symbolic names are unique within an object store.

The IBM Case Manager REST protocol uses the symbolic name that is assigned by Content Platform Engine for the following items:
  • Certain URI elements, including class names and object store names
  • Values for query parameters that reference metadata objects
  • The JSON payload for the names of object stores, case types, and activity types

Content Platform Engine requires symbolic names that are unique within the object store for metadata objects such as document classes and property templates. Instance objects, such as documents and folders, do not have symbolic names. For these objects, you use the GUID that is assigned to the object in the target object store.

In addition, solutions do not have symbolic names. To reference a solution, you use the solution name that is defined in Case Manager Builder.

Parent topic: Creating and managing case objects by using the IBM Case Manager REST protocol