Plan Item Failed Request Event

Plan Item Failed Request Event is sent by Orchestrator in response to a failed plan item. It is received by the Plan Item Failed Handler for manual processing. It is an asynchronous event to a JMS or REST queue.

Event Destination Type Destination Event Type
PlanItemFailedRequest POST (REST) /v1/planitem/errorhandlerrequest Asynchronous/Synchronous event
PlanItemFailedRequest JMS Queue tibco.aff.orchestrator.provider.planItem.failed.request Asynchronous event

The event has the following payload:

Plan Item Failed Request

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 Optional Unique identifier to correlate the request message with a response 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.
planItem Type Required Plan item type for the plan item that failed. See Schema References for the specification of this type.
errorHandler String Required Name of the error handler to invoke for this failed plan item. This value is either populated from the Process Component Model for the Process Component if it exists or with the default error handler from the Orchestrator configuration.
message Type 0-M Message type. See Schema References for the specification of this type. This is the list of messages as returned in the Plan Item Execute Response Event.