OrderLine UDF Change

OrderLine UDF change is an order amendment type where the amended order lines have changed only their corresponding UDFs. All other attributes remain unchanged. This application is able to identify if the orders have changed only with respect to UDFs by inspecting the orderlines to identify if the UDFs have been modified, added or removed. This way of identifying the amended UDF is different from TIBCO Fulfillment Order Management 2.0.1 and prior, where UDF only change was identified by checking value of special UDF (MODIFICATION_IDENTIFYING_ATTR) passed in the order line. Starting from TIBCO Fulfillment Order Management 2.1.0, there is no need to pass MODIFICATION_IDENTIFYING_ATTR UDF to tell the application which UDF is being modified.

Here is the sample orderline showing the changes between TIBCO Fulfillment Order Management 2.1.0 and TIBCO Fulfillment Order Management 2.0.1 and prior:

Sample OrderLine in TIBCO Fulfillment Order Management 2.0.1

<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:actionMode>MOVE</ord1:actionMode>
               <ord1:requiredByDate>2011-04-30T13:20:00-05:00</ord1:requiredByDate>
               <ord1:inventoryID>1</ord1:inventoryID>
               <ord1:notes>NOTES</ord1:notes>
               <ord1:slaID>SLA_ID</ord1:slaID>
                <ord1:udf>
                    <ord1:name>MODIFICATION_IDENTIFYING_ATTR</ord1:name>
                    <ord1:value>Region</ord1:value>
                </ord1:udf>
                <ord1:udf>
                    <ord1:name>Region</ord1:name>
                    <ord1:value>Antarctica</ord1:value>
                </ord1:udf>
</ord1:line>

Sample Order Line in TIBCO Fulfillment Order Management 2.1.0

<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:actionMode>MOVE</ord1:actionMode>
            <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 UDF only Amendment

TIBCO Fulfillment Order Management checks the following conditions to identify UDF only change amendment scenario. All the following conditions, which are mentioned, will hold true for UDF Only Change Amendment:

  • Number of order lines in initial order must match number of order lines in amended order.
  • The product Id in order line in Initial Order must match with the product Id in corresponding order line of amended order.
  • The Action in order line in Initial Order must match with the Action in corresponding order line of amended order.
  • The RequiredByDate in order line in Initial Order must match with the RequiredByDate in corresponding order line of amended order.

New EPMR Characteristics

Starting with the version number 2.1.0, the application provides more granular EPMR actions to be configured for UDF modifications based on the status of the plan items, so as to have more control while generating the COMPENSATE or REDO plan items.

The format of new EPMR characteristics are:

  1. EPMR_ACTION_<<action>>_UDF_CHANGE: Using this format EPMR action can be configured on per Amendment Type. The supported values of <<action>> are:
    1. PROVIDE
    2. CEASE
    3. UPDATE
    4. WITHDRAW

    The following is an example of the characteristic, configured in product model with EPMR:

    <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>
    
  2. EPMR_ACTION_<<action>>_UDF_CHANGE_<<Plan Item Status>>: Using this format, EPMR action can be configured on per Amendment Type and Plan Item Status . The supported values of Plan Item Status are:
    1. COMPLETE
    2. SUSPENDED
    3. PENDING
    4. EXECUTION

    The following is an example of the characteristic, configured in product model with EPMR:

    <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 Fulfillment Order Management 2.0.1

TIBCO Fulfillment Order Management 3.0.0 supports the use of MODIFICATION_IDNETIFYING_ATTR udf to denote the UDF being changed through the use of a flag. This flag , called EnableModificationIdentifyingAttribute, can configured from the Configurator UI is as shown in the following figure:

The default value of this flag is FALSE.

Predefined UDFs

Changes in following UDFs are ignored by the application:

  • ORDERLINE
  • GLOBAL_PRODUCT_NAME
  • EOL
  • ACTION
  • M_EPS_UDFS
Note: The changes done only in the UDFs at the order header level in an amendment request doesn’t have any impact on the existing plan in terms of the creation of compensatory and redo plan items. There will be no changes in the dependencies between the plan items either. However, the amendment plan will contain the updated value of the UDFs. The plan items which go into EXECUTION post amendment will be able to get the updated value of the header level UDFs using GetPlan JMS data interface or GetOrderExecutionPlan service.