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 might be possible that this notification occurs 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.

Event Destination Type Destination Event Type
MilestoneReleaseRequest POST (REST) /v1/planitem/milestonerelease Asynchronous/Synchronous event
MilestoneReleaseRequest JMS Queue tibco.aff.orchestrator.planItem.milestone.release.request Asynchronous event

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

Property Type Cardinality Description
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 Milestone Release Request

Plan Item Milestone Release Request

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 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 Schema References for the specification of this type.
milestoneID String Required A unique identifier for the milestone within the plan item and plan to be released.
Note: If com.tibco.fom.orch.enableMilestoneReleaseDuringActivation is set, the milestone is released during the amendment, provided the related dependencies do not change during the amendment. If com.tibco.fom.orch.enableMilestoneReleaseDuringActivation is not set, the milestone is not released during amendment in the activated plan item, if it was already released before amendment.