Plan Item Execute Request Event

Plan Item Execute Request Event is sent by the Orchestrator to a Process Component to request the fulfillment of a particular plan item. It is received by the Process Component and a series of tasks are run. It can be an asynchronous or synchronous event by a REST service or JMS. The response is another asynchronous or synchronous event on a different orchestrator endpoint or JMS queue.

Event Destination Type Destination Event Type
PlanItemExecuteRequest POST (REST) /v1/planitem/executionrequest Asynchronous/Synchronous event
PlanItemExecuteRequest JMS Queue tibco.aff.orchestrator.planItem.execute.request Asynchronous event
Note: The destination name tibco.aff.orchestrator.planItem.execute.request is valid only if the owner value is "". Otherwise, the destination would be as follows: (If the owner value is defined), the destination would be tibco.aff.orchestrator.planItem.<ownertype>.execute.request.

For example, if the owner value in the plan fragment model is BPM, the destination would be tibco.aff.orchestrator.planItem.BPM.execute.request.

Note: In the case of the REST service, you can check the owner in the header property processComponent name.

Orchestrator sends the below properties in the header according to their technology (HTTP header, JMS header).

Property Type Cardinality Description
processComponentID String Required Unique identifier for the Process Component to be run.
processComponentName String Required Name of the Process Component to be run. This is the name as configured in the Process Component Model for the specified processComponentID. If a model is not specified, then this field is null.
processComponentVersion String Required Version of the Process Component to be executed. This is the version as configured in the Process Component Model for the specified processComponentID. If a model is not specified, then this field is null.
processComponentType String Required Type of the Process Component to be executed. This is the type as configured in the Process Component Model for the specified processComponentID. If a model is not specified, then this field is null.
processComponentRecordType String Required

It is a class of processComponentType. This is the processComponentRecordType as configured in the Process Component Model. If a model is not specified, then this field is null.

JMSPriority Integer Required It is the standard JMS message priority to be sent in the outbound message to support order priority.

The payload specification is as follows:

Plan Item Execute Request

The following table lists the details of the elements.

Element Type Cardinality Description
businessTransactionID String Optional A unique identifier for tracing purposes across function calls.
correlationID String Optional A 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 plan item to execute.
orderRef String Required External unique identifier for the order associated with the plan containing the plan item to execute.
planID String Required Internal unique identifier for the plan that contains the plan item to execute.
planItem Type Required Plan item type for the plan item to execute. See Schema References for the specification of this type.
sla Type Optional Service level agreement type.
sla/typicalDuration Long Required Typical duration in msec for this execution when SLAs are implemented in the Process Component.
sla/maximumDuration Long Required Maximum duration in msec for this execution when SLAs are implemented in the Process Component.
waitAtMilestoneID String 0-M Milestone ID for a milestone within the Process Component where execution must wait until notified by the Orchestrator that it must proceed.
notifyAtMilestoneID String 0-M MilestoneID for a milestone within the Process Component where the Process Component must notify the Orchestrator that the milestone has been passed during execution.