Case summary event formats

Edit online
Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15
Case summary events are JSON objects that result from the aggregation of time series.
Important:

Defining a high number of fields in an OpenSearch index might lead to a so-called mappings explosion which might cause out-of-memory errors and difficult situations to recover from. The maximum number of fields in OpenSearch indices created by IBM® Business Automation Insights is set to 1000. Field and object mappings, and field aliases, count towards this limit. Ensure that the various documents that are stored in OpenSearch indices do not lead to reaching this limit.

By design, IBM Business Automation Insights defines a number of field mappings in OpenSearch indices that store Case summaries. The overall number of fields in an index grows as you audit new fields.

Since version 20.0.2, 67 field mappings are defined. Each audited field adds 1 field, which ends up as 2 mappings for text, and 1 mapping otherwise.

Defining a high number of fields in an OpenSearch index might lead to a so-called mappings explosion which might cause out-of-memory errors and difficult situations to recover from. The maximum number of fields in OpenSearch indices created by IBM Business Automation Insights is set to 1000. Field and object mappings, and field aliases, count towards this limit. Ensure that the various documents that are stored in OpenSearch indices do not lead to reaching this limit.

Table 1. Case summary attributes
Attribute Description Optional or required Type
case-folder-id The identifier of the case folder Required String
category The category of the event Required The icm string constant
case-health The current case health status. Applies only if case health is enabled. Optional String

Possible values: Good Health, Warning, Poor Health, No Health.

case-instance-id The identifier of the case instance Required String
case-instance-name The name of the case instance Required String
type The type of the case summary Required The case string constant
state The state of the case, based on the latest aggregated event Required A string constant

Possible values: Active, Completed
case-type-name The name of the case type Required String
case-type-display-name The display name of the case type Required String
case-stage The name of the current stage of the case Optional String
source-class-id The identifier of the source class of the case Required String
source-class-display-name The display name of the source class of the case Required String
solution-name The name of the solution to which the case belongs Required String
timestamp The timestamp of the last aggregated event to produce this summary Required A string that contains an ISO8601 date.
version The version number of the case summary Required String
data The business data Optional - Present if case properties are audited JSON object
start-time The time at which the case started Required A string that contains an ISO8601 date.
start-time-quarter The year quarter that contains the start-time value Required Number
end-time The time at which the last case event was received Required A string that contains an ISO8601 date.
end-time-quarter The year quarter that contains the end-time value Required Number
duration-seconds The case duration, in seconds Optional - Present if the difference between the start-time value and end-time value can be computed. Number

Example of a case summary

{
    "case-folder-id": "{604C8965-0000-C11D-B1D9-FC64F56BDC14}",
    "category": "icm",
    "case-instance-id": "{604C8965-0000-C11D-B1D9-FC64F56BDC14}",
    "case-instance-name": "000000140003",
    "type": "case",
    "state": "Complete",
    "case-type-name": "CCDM_CaseST",
    "case-type-display-name": "CaseST",
    "source-class-id": "{030F12CA-9DD6-4639-9A02-5897A3D4B2EC}",
    "source-class-display-name": "CaseST",
    "solution-name": "Credit Card Dispute Management",
    "timestamp": "2018-08-30T05:59:51.191Z",
    "version": "1.0.1",
    "data": {
        "CCDM_Priority": 5,
        "CCDM_CaseOwner": "Administrator",
        "CCDM_DateSubmitted": "2014-04-02T09:30:00.000Z",
        "CCDM_DateRequested": "2014-04-01T09:30:00.000Z",
        "CCDM_CustomerStatus": "Silver",
        "CCDM_BusinessUnit": "ECM"
    },
    "trace-id": "509a7167-0000-c51f-ad00-a59249b9912b",
    "span-id": "59d374a94b31f2b2",
    "parent-span-id": "66d374a94b31f2b2",
    "icm-system-id": "{8D0692D0-4E55-46B2-ABAE-307C88A97089}",
    "content-engine-server": "localhost",
    "emitter-logical-unique-id": "icpTest",
    "object-store-display-name": "tos",
    "object-store-symbolic-name": "tos",
    "object-store-id": "{8D0692D0-4E55-46B2-ABAE-307C88A97089}",
    "p8-domain-name": "myP8Domain",
    "p8-domain-id": "{99370115-636B-4267-B2CE-96471CB4B141}",
    "start-time": "2018-08-30T05:59:51.191Z",
    "start-time-quarter": 3,
    "end-time": "2018-08-30T05:59:51.191Z",
    "end-time-quarter": 3,
    "duration-seconds": 0
}