Plan Item Suspend Request Event

Plan Item Suspend Request Event is sent by Orchestrator to a Process Component to request suspension of execution of a particular plan item. It is received by the Process Component which then either suspends execution or completes execution. 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.suspend.request
Note: The destination name tibco.aff.orchestrator.planItem.suspend.request is valid only if owner value is "". Otherwise, the destination would be as follows: (If owner value is defined), the destination would be tibco.aff.orchestrator.planItem.<ownertype>.suspend.request .

For example, if the owner value in the plan fragment model is BPM, the destination would be tibco.aff.orchestrator.planItem.BPM.suspend.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:

Plan Item Suspend Request

Plan Item Suspend 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 plan item to be suspended.
orderRef String Required External unique identifier for the order associated with the plan containing the plan item to be suspended.
planID String Required Internal unique identifier for the plan that contains the plan item to be suspended.
planItem Type Required Plan item type for the plan item to be suspended. See Appendix A for the specification of this type.