Process Events

Process events include:

  • Process start & end events (ProcStart and ProcEnd)
  • Process status event (ProcStatus)
  • Process step start & end events (StepStart and StepEnd)

A process must start with ProcStart and end with ProcEnd. In between these two events, the process can report the status through a ProcStatus. Optionally, processes can be broken down into steps by posting pairs of StepStart and StepEndevents. In addition to the common fields defined in this document, the following fields are common across all process events:

Name Description Data type Required
correlationId Used to link related activities that span processes or servers or both. String No
parentNodeId The nodeId of the parent process or a null value if process IDs are globally unique (which they are by default). Used to specify the parent process that was immediately upstream of this process. String No
parentProcessId The unique identifier of the parent processes. Used to specify the parent process that was immediately upstream of this process. String No
pctComplete The percentage complete for this process. Number No
processId The process ID (also known as the activity ID or transaction ID). All events with the same node ID and process ID belong to the same process. String Yes
processName The user friendly process name (also known as the activity name or transaction name). String No
submitter The ID of the user that submitted or started the activity or process. String No
submitterApp The name of the submitter application associated with this event. String No

Process Start & End Event

Process Start Event

A process start event indicates a process that has started and can trigger Service Level Criteria (SLC) rules. You must post a subsequent Process End event after the process completes (whether it completes successfully or not). Process events are correlated based on the unique combination of nodeId+processId. Process start events do not define any additional fields

Table 1. Example 
{  "event": "ProcStart",
  "msgId": "LSMG200I",
  "msgText": "Process number 680 (name PROCTEST, SNODE DANDER2K42) executing",
  "nodeId": "cron/cron123",
  "occurred":"2015-02-05T23:25:31.000+0000",
  "processId": "680",
  "processName":"PROCTEST",
  "sequence": 0,
  "type": "event"
}
Process End Event

A process end event represents the end of a process and can trigger Service Level Criteria (SLC) rules. Process end events do not define any additional fields.

Table 2. Example 
{  "event": "ProcEnd",  
  "msgId": "LSMG252I",
  "msgText": "A user process has completed successfully.",
  "nodeId": "cron/cron123",
  "occurred":  "2015-02-05T20:40:07.000+0000",
  "origNode": "DANDER2K46",
  "processId":  "679",
  "processName": "PROCTEST",
  "returnCode": "0",
   "sequence": 0,
  "type": "event"
}}

Process Status Event

A Process Status Event represent an intermediate status of a process. Process status events do not define any additional fields.

Process Step Start & End Event

Process Step Start Event

A process step start event represents the start of a subprocess or activity within a parent process and can be used to trigger step-based Service Level Criteria (SLC) rules. The step name is used to correlate start and end steps. Typically, the destination file and source file elements are only populated in process step events. You must post a subsequent process step end event after the process step completes (whether it completes successfully or not). Step events are correlated based on the unique combination of nodeId + processId + stepName. In addition to the fields defined for all process events, process step start events define the following fields:

Name Description Data type Required
stepName The unique name of the step within the process. String Yes
Table 3. Example 
{  "event": "StepStart",  
"msgId": "172207",
  "msgText": null,
  "nodeId": "cron/cron123",
  "occurred": "2015-02-05T14:39:05.000+0000",
  "processId": "DEV.CDSA_CDSERVER_ADAPTER_node1S0003839787326L52:842653",
  "processName": "DEV.CDSA",
  "returnCode": "8",
  "sequence": 0,
  "stepName": "83222314b5a2de919node1",
  "type":
    "event"
}
Process Step End Event

A process step end event represents the end of a process step. TypicallydestFile and sourceFile elements are found only in process step start and process step end events. Process step start event and correlated process step end events must have the same destFile and sourceFile elements and values. In addition to the fields defined for all process events, process step start events define the following fields:

Name Description Data type Required
stepName The unique name of the step within the process. String Yes
Table 4. Example 
{  "event": "StepEnd",  
"msgId": "172207",
  "msgText": null,
  "nodeId": "cron/cron123",
  "occurred": "2015-02-05T14:39:06.000+0000",
  "processId": "DEV.CDSA_CDSERVER_ADAPTER_node1S0003839787326L52:842653",
  "processName": "DEV.CDSA",
  "returnCode": "8",
  "sequence": 0,
  "stepName": "60231614b5a2de919node1",
  "type":
    "event"
}