Plan Item Suspend Request Event
Plan Item Suspend Request Event is sent by the 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.
Event | Destination Type | Destination | Event Type |
---|---|---|---|
PlanItemSuspendRequest
|
POST (REST) | /v1/planitem/suspendrequest | Asynchronous/Synchronous event |
PlanItemSuspendRequest
|
JMS Queue | tibco.aff.orchestrator.planItem.suspend.request | Asynchronous event |
tibco.aff.orchestrator.planItem.suspend.request
is valid only if the owner value is
""
. Otherwise, the destination is as follows:
(If the owner value is defined), the destination is
tibco.aff.orchestrator.planItem.<ownertype>.suspend.request
.
For example, if the owner value in the plan fragment model is
BPM
, the destination is
tibco.aff.orchestrator.planItem.BPM.suspend.request
.
In the case of 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 | A 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 a model is not specified,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:
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 | The 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 Schema References for the specification of this type. |