JSON Definition for Events

The JSON definition created by Producers consists of metadata fields and payload. The metadata field contains data to identify the event type used by the Event Framework and the payload consists of data that is used by the Consumer.

For more information about Producers, see the Producer Activity section.

The following is an example for the format of the JSON definition:

{

"EVENT_TYPE": "VALUE" ,

"EVENT_SUB_TYPE": " VALUE " ,

"EVENT_SOURCE": " VALUE " ,

“EVENT_KEY”:”VALUE”,

“EVENT_REF_ID”:” VALUE”

"CORRELATION_ID": " VALUE ",

"EVENT_TIMESTAMP":" VALUE " ,

"PAYLOAD": {

//business specific JSON definition of the data being passed

}

}

The description for the JSON parameters in the preceding example are as follows:

• EVENT_TYPE: The type of event at the parent level. For example, CASE.
• EVENT SUB TYPE: The subtype of the event. For example, CLOSURE, CREATE, UPDATE.
• EVENT SOURCE: The source application where the event occurs. For example, ECM The Type, Sub Type, and Source determine the action to be executed by the consuming service.
• CORRELATIONID: The identifier to use in case of a request or response model. It is a unique value and in alphanumeric format. For example, A45211B11. Service A sends an event to B and in return expects event B to send a response that maps the response to the original request.
• EVENT_KEY: The key used by the Producer for the event. For example, 100.
• EVENT_REF_ID: The unique ID created by the sender for the event that will be used to handle duplicate messages. For example, 100.
• EVENT_TIMESTAMP: The date and time of the creation of the event. Check the latency or determine the date on which the event is applicable. For example, 02/029/2021 12:49.
• PAYLOAD: The business data required by the consumer service in the JSON format. The event framework not only parses the payload but also expects the consuming service to interpret and process the message.

An example for the payload is shown in the following:

{

"payload": {

"infodom": "INFODOM",

"applicationparams": {

"sourceApplicationId":

"APP-123456",

"onboardSystemCaseId":

"0000",

"onboardSystemCaseStatus": "",

"gkycId":

"xxx123yy123-abc123de456",

"gkycCaseId":

"CASE12345",

"event":

"Response Returned",

"ACTION":

"CASE90000",

"comments": [

"comment:RFI_response sent in document",

"comment:RFI_document attached" ],

"createdDate":

"mm-dd-yyyy hh-mm-ss UTC" },

"userid":

"EXAMPLE_USER",

"objecttype":

"DA_DCA",

"locale":

"en_US",

"objectid":

"OBJID0000",

"securitymap": {} } }