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. It is an asynchronous event to a JMS queue.

Event Type Asynchronous event
Queue or Topic Queue
Destination tibco.aff.orchestrator.provider.planItem.failed.reply

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 should be mapped and sent back in the response message.

The event has the following payload:

Plan Item Failed Response

PlanI tem 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 to be able to 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 should be retried.
resume Type Required, Choice Flag indicating that the plan item should be resumed from the point of failure.
complete Type Required, Choice Flag indicating that the plan item should be marked as Complete and execution continue.
message Type 0-M Message type. See Appendix A for the specification of this type. If populated, this list of messages will be returned in any Submit Order Response message occurring after the call to the Plan Item Failed Handler occurred.