Case Classes and Local Classes

A BOM must contain a case class. It can also contain further case classes and local classes.

Type Icon Description
Case

A case class is a template for a case object. A case class:
  • must have a case identifier.
  • must have a case state attribute.
  • can have summary attributes.
  • can have searchable attributes.

You can create case objects from case classes using either a case data service task in a process or a public API. Creating a case object returns a case reference. That reference can be used by any process to find and manipulate that case object.

Note: Unlike local objects, which exist only over the lifespan of a process instance, case objects are persisted - each case object is stored in the case data tables that represent the case model from which the case object was instantiated.
Local A local class is a template for a local object. A local class:
  • cannot have a case identifier.
  • cannot have a case state attribute.
  • cannot have summary attributes.
  • cannot have searchable attributes.
Note: A business object created from a local class only has local scope, even though the class exists in a BOM. The local object is not persisted to the case data store and can only be accessed by the process that creates it.

Note: You can convert a class from its existing type to the other type. For example, right-click the case class and select the Convert to Local menu option.