1. Implementation Guide
  2. Integration
  3. External Status Update
  4. Payload Specification

Payload Specification

Attribute Description

processName

Name of the root process in a given cycle/flow

Note: Process names in the callback response are prefixed with the name of the schedule. For instance, a callback response sent for Process "P1" would have processName attribute as MERCH_P1 on return.

processExecutionId

Unique identifier generated by POM to track the process executions.

activityName

Name of the job for which the callback/status update is sent.

activityExecutionId

Unique identifier generated by POM to track the job run instance.

callerId

Identifier provided by the caller to POM when submitting the invocation/execution request. POM returns the same ID back to caller.

correlationId

Identifier provided by the caller to POM when submitting the invocation/execution request. POM returns the same ID back to caller

callBackServiceDataDetail.<KeyName>

Key value pairs supplied to POM when submitting the invocation/execution request. Those are returned back to the caller

failedActivity

In the case where the callback is for a failed job, this field is populated with the details of the failed Job.

status

Status of the job execution -

  • COMPLETED

  • SKIPPED

  • ERROR

  • SKIPPED_ON_ERROR

activityStatus

Status of the job, and the derived activity state:

  • ERROR - ACTIVITY_FAILED

  • COMPLETED - ACTIVITY_COMPLETED

  • SKIPPED - ACTIVITY_COMPLETED

  • SKIPPED_ON_ERROR - ACTIVITY_COMPLETED

Payload Examples

Below are sample external status update payloads for the MERCH schedule.

Description Payload

Hourly Job Callback

 
{
   " callerId " : "XXX",
   " correlationId " : "37",
   " processName " : "MERCH_ BATCH_PROCESS _01",
   " processExecutionId " : "MERCH_ BATCH_PROCESS_01 ~asfasfdasdfas",
   " activityName " : " MERCH_ BATCH_JOB",
   " activityExecutionId " : "123456",
   " status " : "COMPLETED",
   " activityStatus " : "ACTIVITY_COMPLETED",
   " failedActivity " : null
}

Nightly Job Callback

 
{
   " callerId " : "XXX",
   " correlationId " : "37",
   " processName " : "MERCH_ START_NIGHT_BATCH_PROCESS ",
   " processExecutionId " : "MERCH_ START_NIGHT_BATCH_PROCESS ~asfasfdasdfas",
   " activityName " : " MERCH_ START_NIGHT_BATCH_JOB",
   " activityExecutionId " : "123456",
   " status " : "COMPLETED",
   " activityStatus " : "ACTIVITY_COMPLETED",
   " failedActivity " : null
}