Plan Item Failed Response Event
Plan Item Failed Response Event is sent by Plan Item Failed Handler as a response to the failed plan item. Orchestrator receives the result and interprets the result accordingly.
Event | Destination Type | Destination | Event Type |
---|---|---|---|
PlanItemFailedResponse
|
POST (REST) | /v1/planitem/errorHandlerreply | Asynchronous/Synchronous event |
PlanItemFailedResponse
|
JMS Queue | tibco.aff.orchestrator.provider.planItem.failed.reply | Asynchronous event |
The event has the following property:
Property | Type | Cardinality | Description |
---|---|---|---|
originator | String | Optional | The value of the originator property in the PlanItemFailedRequest message, received from the Orchestrator, which must be mapped and sent back in the response message. |
The event has the following payload:
Plan Item Failed Response
The following table lists the details of the elements.
Element | Type | Cardinality | Description |
---|---|---|---|
businessTransactionID | String | Optional | Unique identifier for tracing purposes across function calls. |
correlationID | String | Required | Unique identifier to correlate the request message with a response message. Even though this field is marked as optional in the response schema, it is required for Orchestrator can correlate the response with the correct version of the submitted order. Populate this field the same as correlationID in the request message. |
orderID | String | Required | Internal unique identifier for the order associated with the plan containing the failed plan item. |
orderRef | String | Required | External unique identifier for the order associated with the plan containing the failed plan item. |
planID | String | Required | Internal unique identifier for the plan that contains the failed plan item. |
planItemID | String | Required | Unique identifier for the plan item within the plan that failed. |
retry | Type | Required, Choice | Flag indicating that the plan item must be retried. |
resume | Type | Required, Choice | Flag indicating that the plan item must be resumed from the point of failure. |
complete | Type | Required, Choice | Flag indicating that the plan item must be marked as Complete and the execution continues. |
message | Type | 0-M | Message type. See Schema References for the specification of this type. If populated, this list of messages are returned in any Submit Order Response message occurring after the call to the Plan Item Failed Handler occurred. |