Set Plan Request

The request specification is as follows:

Queue or Topic	Queue
Destination	`tibco.aff.tds.plan.request`

The following properties should be passed in the request message header:

Element	Type	Cardinality	Description
_nm_	String	Required	Interface identifier name; MUST be set as SetPlanRequestEvent.
businessTransactionID	String	Optional	Unique identifier for tracing purposes across function calls.
planID	String	Required	Internal unique identifier for the plan to retrieve.
correlationID	String	Optional	Unique identifier for tracing purposes across a single function call. This is generally used by the calling application to correlate requests and responses.
requestReply	Boolean	Required	If set to true: The response will be sent on the temporary queue by default or on the destination set as JMSReplyTo property in the request message. If set to false: The response will be sent on `tibco.aff.tds.plan.reply` queue.
replace	Boolean	Required	If set to true: All the existing UDFs will be replaced by the UDFs that are present in the request. If set to false: The UDFs passed in the request will be merged with the existing UDFs. In any of the above case, the uniqueness of a UDF is maintained on the basis of the 'name' and 'flavor' combination in the UDF. A UDF having exactly same 'name' and 'flavor' will not be duplicated, if the flag `EnableUniqueUDFNames` is set to true in OMS configurations. In case of multiple UDFs with exactly same name and flavor in the request, the value from the last encountered UDF will be considered.
originator	String	Optional	The component which has originated this call. E.g. the name of the process component PC_BUNDLE_PROVIDE.

The request message body should contain the XML payload as per the following schema:

Set Plan 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.
Plan	Type	Required	Plan type.
plan/planID	String	Required	Internal unique identifier for the plan to update.
plan/ordered	String	Required	Internal unique identifier for the order related to the plan to update.
plan/orderRef	String	Required	External unique identifier for the order related to the plan to update.
plan/udf	Type	0-M
plan/udf/type	String	Optional	Type of the user defined field.
plan/udf/flavour	String	Optional	Flavour of the UDF. Must be set as output.
plan /udf/name	String	Required	Field name.
plan/udf/value	String	Required	Field value.
plan/planItem	Type	0-M	Plan item type.
plan/planItem/planItemID	String	Required	Internal unique identifier for the plan item to update.
plan/planItem/planItemName	String	Optional	Process component name.
plan/planItem/udf	Type	0-M	UDF type.
plan/planItem/udf/type	String	Optional	Type of the user defined field.
plan/planItem/udf/flavour	String	Optional	Flavour of the UDF. Must be set as output.
plan/planItem/udf/name	String	Required	Field name.
plan/planItem/udf/value	String	Required	Field value.
replace	Any	Optional	If true it completely replaces the plan item, otherwise merges the UDF data.