Monitor 10.11 | pub.monitor.integrationProcessLogging Folder | pub.monitor.integrationProcessLogging:updateStepInstanceStatus
Updates the step status of an existing step instance.
Input Parameters
The following table lists the input parameters.
String The internal identifier (that is, process key) of the integration process definition that the step is a part of. You defined the process key when you added the process definition to the Process Audit Log using the pub.monitor.integrationProcessLogging:createProcessMetadata service.
A process key is 1 to 64 alphanumeric characters.
String The identifier of the process instance that the step instance is a part of. You assigned the process instance an identifier when you created the process instance using the pub.monitor.integrationProcessLogging:createProcessInstance service.
A process instance ID is 1 to 32 alphanumeric characters.
String The internal identifier of the process step whose status you want to update. The step identifier that you specify must already be defined in the Process Audit Log. You defined the step identifier and associated it with a process step when you added the step definition to the Process Audit Log using the pub.monitor.integrationProcessLogging:createStepMetadata service.
A step identifier is 1 to 128 alphanumeric characters.
Number Optional. The iteration of the step. Specify an iteration count if the step is executed multiple times within a single process instance, for example, if the step is within a loop or is an error handling step that can be executed more than one time. By default, the service uses a value of 1 for stepIteration.
String The status code number that represents the status you want to assign to the step instance. Status Reference.
If you are setting the value of status using Designer, Designer displays the list of status values rather than listing the status code numbers.
Output Parameters
The following table lists the output parameters.
String The outcome of updating the step status. If the service successfully updated the step status, result is “success”. If the service encountered an error attempting to update the step status, result contains the exception.
Usage Notes
*If the service encounters an error, it logs an error to the PRA_ERROR table. You can view the error using Monitor via the Step Instance Detail page for the step instance.
*You can specify any valid status regardless of the current status. There are no restrictions for what statuses you can use based on the current step status.