Plan Item Execute Request Event
Plan Item Execute Request Event is sent by 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 then executes. It is an asynchronous event to a JMS queue. The response is another asynchronous event on a different JMS queue.
| Event Type | Asynchronous event |
| Queue or Topic | Queue |
| Destination | tibco.aff.orchestrator.planItem.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.
The event has the following properties:
| Property | Type | Cardinality | Description |
| processComponentID | String | Required | Unique identifier for the Process Component to be executed. |
| processComponentName | String | Required | Name of the Process Component to be executed. This is the name as configured in the Process Component Model for the specified processComponentID. If there is no model 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 there is no model 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 there is no model 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 there is no model 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. |
| originator | String | Optional | The value of the NODE_ID that is assigned to the instance. This property is sent by the Orchestrator in all the outbound JMS messages and is expected to be mapped back by the external systems (process components, feasibility providers, pre-qualification failure handlers, and error handlers) in the corresponding response messages. |
The payload specification is as follows:
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 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 Appendix A 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 Orchestrator that it should proceed. |
| notifyAtMilestoneID | String | 0-M | MilestoneID for a milestone within the Process Component where the Process Component must notify Orchestrator that the milestone has been passed during execution. |