Item data mapping

A common XML is used to communicate with external systems.

The following shows the common XML:


<Item Action="Create/Modify/Delete" ItemID="" UnitOfMeasure=""
OrganizationCode="" ShortDescription="" ExtendedDescription=""
BundleFulfillmentMode="" LeadTime="" MinOrderQuantity="" IsModelItem="" Model=""
ModelItemUnitOfMeasure="" KitCode="" ConfiguredModelKey="" IsConfigurable=""
IsPreConfigured="">
            <ItemInstructionList Reset="">
                  <ItemInstruction InstructionText="" SeqNo=""
InstructionType="ORDERING"/> 
            </ItemInstructionList>
            <Components Reset="">
<Component ComponentItemID="" ComponentOrganizationCode=""
ComponentUnitOfMeasure="" KitQuantity=" "/>
            </Components>
</Item>

Database fields for item data mapping

These are the database fields for the attributes for Item Data Mapping:

Attribute Order Fulfillment Database Field Comment
Item
ItemID YFS_ITEM.ITEM_ID  
UnitOfMeasure YFS_ITEM.UOM
Note: The values in this field must be manually kept in synch between the two applications.
OrganizationCode
YFS_ITEM.ORGANIZATION_
CODE
 Assume that the catalog is maintained at the hub level.
ShortDescription
YFS_ITEM.SHORT_
DESCRIPTION
 This field is required to avoid errors.
Extended Description
YFS_ITEM.EXTENDED_
DESCRIPTION
  
BundleFulfillment
Mode
YFS_ITEM.BUNDLE_
FULFILLMENT_MODE
 This value should be based on the following:
  • 01" for ShipTogether when the configurable item is a non-container only item.
  • 02" for Ship Independently when the configurable item is a container only item.
LeadTime
YFS_ITEM.LEAD_TIME
  
MinOrderQuantity
YFS_ITEM.MIN_ORDER_
QUANTITY
  
Model
YFS_ITEM.MODEL
 The existing MODEL field is used to store the parent SKU to represent the aggregate item. Do not confuse with CONFIGURED_MODEL_KEY of the configurable item.
ModelItemUnitOf
Measure
YFS_ITEM.MODEL_ITEM_
UOM
 This field stores the unit of measure of the parent SKU.
IsModelItem
YFS_ITEM.IS_MODEL_ITEM
 The value stored in this field should be "Y" if the product is of the type "Aggregate".
KitCode
YFS_ITEM.KIT_CODE
 The value for this field is based on the following:
  • PK" if the product is of the type "ASSEMBLY" and the
    CMGT_PRODUCT.
    COMPONENT_SUB_
    TYPE
    field indicates that the product is a physical kit.
  • BUNDLE" if the product is of the type "ASSEMBLY" and the
    CMGT_PRODUCT.
    COMPONENT_SUB_
    TYPE
    field indicates that the product is a bundle.
  • BUNDLE" if product is of the type "CONFIGURABLE"
ConfiguredModelKey
YFS_ITEM.CONFIGURED_
MODEL_KEY
  
IsConfigurable
YFS_ITEM.IS_
CONFIGURABLE
 The value of this field should be "Y" if the product is of the type "CONFIGURABLE".
IsPreConfigured
YFS_ITEM.IS_PRE_
CONFIGURED
  
ItemInstructionList/ItemInstruction
InstructionText
YFS_ITEM_INSTRUCTION.
INSTRUCTION_TEXT
  
InstructionType
YFS_ITEM_INSTRUCTION.
INSTRUCTION_TYPE
  
SeqNo
YFS_ITEM_INSTRUCTION.
SEQ_NO
  
Components/Component
ComponentItemID
YFS_KIT_ITEM.COMPONENT_
ITEM_KEY

Based on ComponentItemID,

ComponentOrganizationCode,

and

ComponentUnitOfMeasure.

  
Component
OrganizationCode
YFS_KIT_ITEM.COMPONENT
_IT

Based on ComponentItemID, ComponentOrganizationCode, ComponentUnitOfMeasure

 Assume that the catalog is maintained at the hub level.
ComponentUnitOf
Measure
YFS_KIT_ITEM.COMPONENT
_ITEM_KEY

Based on ComponentItemID, ComponentOrganizationCode, ComponentUnitOfMeasure

 Unit of measure of the config line (configurable) or part (assembly)
KitQuantity
YFS_KIT_ITEM.KIT_
QUANTITY
  
Note: Extended attributes can be provided under the /Item/@Extn element.
Note: Product item statuses must be manually kept in sync between the external system and Sterling Order Management System Software.

There are two scenarios in which statuses are updated during product item synchronization:

  • A new product item is added to either the external system or Sterling Order Management System Software. During synchronization, the product item is added, and the status updated to Held in Sterling Order Management System Software or In Creation in the external system.
  • If a product item is deleted in Sterling Order Management System Software, the status in the external system is updated to Blocked. In addition, when that product item is retrieved in the UI of the external system, text is displayed in the UI to indicate that this product has been deleted in Sterling Order Management System Software.
  • If a product is deleted from the external system, a message is sent to Sterling Order Management System Software. By default, items are removed from the database. This can be avoided by modifying the XSL translator in this step by changing Action="Delete" to Action="Modify" and placing the item into a custom status.