Case Summaries

A case summary is a specified subset of the attributes defined for a case class. The case summary defines the initial set of information that is returned about a case object when that object is returned as part of a search result.

At design time, you define the attributes that make up a case summary in the BOM Editor.

At runtime, when a user searches the case class for matching case objects (using the Openspace Case Management gadget), the case summary information is displayed for each matching case object. Each attribute is displayed as a column. The attribute's Label is used as the column heading. For example:

A case summary includes, by default, any attributes that are defined as case identifiers or case states. You cannot remove these attributes from the case summary. You can add any of the other attributes defined for the case class to the case summary provided that the attribute:

  • has multiplicity of either 0..1 or 1.
  • is either a primitive type or an enumeration.

You can also define the order in which case summary attributes will be displayed at runtime.

Case summary attributes can also be obtained using the getCaseSummary operation from the BusinessDataServices service in the BPM Web Service API. See the TIBCO ActiveMatrix BPM Developer's Guide for more information.