Plan Item Milestone Release Request Event
Plan Item Milestone Release Event is sent by Orchestrator to a Process Component to instruct it to continue execution when stopped at a particular milestone. It may be possible that this notification will occur before the Process Component has reached the milestone during execution. Therefore it is necessary for the Process Component to maintain a state of the milestone at any time during execution. There is no response to this interface.
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. |
planID | String | Required | Internal unique identifier for the plan that contains the plan item with the milestone to be released. |
planItemID | String | Required | Unique identifier for the plan item that contains the milestone to be released. |
milestoneID | String | Required | Unique identifier for the milestone within the plan item and plan to be released. |
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:
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 with the milestone to be released. |
orderRef | String | Required | External unique identifier for the order associated with the plan containing the plan item with the milestone to be released. |
planID | String | Required | Internal unique identifier for the plan that contains the plan item with the milestone to be released. |
planItem | Type | Required | Plan item type for the plan item with the milestone to be released. See Appendix A for the specification of this type. |
milestoneID | String | Required | Unique identifier for the milestone within the plan item and plan to be released. |
Copyright © Cloud Software Group, Inc. All rights reserved.