OrderLine user-defined field Change
OrderLine user-defined field change is a type of an order amendment where the amended order lines contain changed user-defined fields and/or newly added user-defined fields along with the user-defined fields from the original order request. All other order request attributes remain unchanged. This application can identify if the orders have changed only about User-Defined Fields by inspecting the order lines to identify if the User-Defined Fields have been modified or added.
Sample Order Line in TIBCO Order Management
<ord1:line> <ord1:lineNumber>1</ord1:lineNumber> <ord1:productID>MODEM</ord1:productID> <ord1:productVersion>1.0</ord1:productVersion> <ord1:quantity>1</ord1:quantity> <ord1:uom>UOM</ord1:uom> <ord1:action>PROVIDE</ord1:action> <ord1:requiredByDate>2011-04-30T13:20:00-05:00</ord1:requiredByDate> <ord1:udf> <ord1:name>Region</ord1:name> <ord1:value>Asia</ord1:value> </ord1:udf> </ord1:line>
Identifying user-defined field Amendment
TIBCO Order Management checks the following conditions to identify the user-defined field change amendment scenario. All the following conditions, which are mentioned, hold true for the user-defined field change amendment:
- The number of order lines in the initial order must match the number of order lines in the amended order.
- The product Id in order line in the initial order must match with the product Id in the corresponding order line of the amended order.
- The action in order line in the initial order must match with the action in the corresponding order line of the amended order.
- The RequiredByDate in order line in the initial order must match with the RequiredByDate in the corresponding order line of the amended order.
Execution Plan Modification Rules (EPMR) Characteristics
The application provides more granular execution plan modification rules actions to be configured for user-defined field modifications based on the status of the plan items, to have more control when generating the COMPENSATE or REDO plan items.
The format of execution plan modification rule characteristics is as follows:
EPMR_ACTION_<<action>>_UDF_CHANGE
: Using this format Execution Plan Modification Rules action can be configured per amendment type. The supported values of <<action>> are:PROVIDE
CEASE
UPDATE
WITHDRAW
The following is an example of the characteristic configured in the product model with Execution Plan Modification Rules:
<ns0:characteristics> <ns0:name>EPMR_ACTION_PROVIDE_UDF_CHANGE</ns0:name> <ns0:description>Characteristic</ns0:description> <ns0:instanceOptional/> <ns0:instanceCeaseSequence/> <ns0:instanceUpdateSequence/> <ns0:instanceSequence/> <ns0:instanceMin>0</ns0:instanceMin> <ns0:instanceMax>0</ns0:instanceMax> <ns0:evaluationPriority/> <ns0:value> <ns0:type>PROVIDE</ns0:type> <ns0:discreteValue>COMPENSATE_RESTART</ns0:discreteValue> <ns0:mandatoryValue>true</ns0:mandatoryValue> </ns0:value> <ns0:simpleRule> <ns0:name>EPMR_ACTION_PROVIDE_UDF_CHANGE</ns0:name> <ns0:ruleSetOutcome>Characteristic</ns0:ruleSetOutcome> </ns0:simpleRule> </ns0:characteristics>
EPMR_ACTION_<<action>>_UDF_CHANGE_<<Plan Item Status>>
: Using this format, the Execution Plan Modification Rules action can be configured per Amendment Type and Plan Item Status. The supported values of Plan Item Status are:COMPLETE
SUSPENDED
PENDING
EXECUTION
The following is an example of the characteristic configured in the product model with Execution Plan Modification Rules:
<ns0:characteristics> <ns0:name>EPMR_ACTION_PROVIDE_UDF_CHANGE_SUSPENDED</ns0:name> <ns0:description>Characteristic</ns0:description> <ns0:instanceOptional/> <ns0:instanceCeaseSequence/> <ns0:instanceUpdateSequence/> <ns0:instanceSequence/> <ns0:instanceMin>0</ns0:instanceMin> <ns0:instanceMax>0</ns0:instanceMax> <ns0:evaluationPriority/> <ns0:value> <ns0:type>PROVIDE</ns0:type> <ns0:discreteValue>COMPENSATE_RESTART</ns0:discreteValue> <ns0:mandatoryValue>true</ns0:mandatoryValue> </ns0:value> <ns0:simpleRule> <ns0:name>EPMR_ACTION_PROVIDE_UDF_CHANGE</ns0:name> <ns0:ruleSetOutcome>Characteristic</ns0:ruleSetOutcome> </ns0:simpleRule> </ns0:characteristics>
Backward Compatibility with TIBCO Order Management
TIBCO Order Management supports the use of
MODIFICATION_IDNETIFYING_ATTR
udf to denote the user-defined field being changed through the use of a flag. This flag, called EnableModificationIdentifyingAttribute, can be configured from the Configurator UI for the AOPD service application.
The default value of this flag is
FALSE
.
Predefined User-Defined Fields
Changes in the following user-defined fields are ignored by the application:
ORDERLINE
GLOBAL_PRODUCT_NAME
EOL
ACTION
M_EPS_UDFS