Example: Inserting and replacing receipts

Use the Data Load utility to load receipts data into the RECEIPT table.

Prerequisites

Before you run this example, ensure that the following prerequisites are fulfilled:

• Make sure that the inventory system is ATP, that is, check STORE table to make sure INVENTORYSYSTEM=-1
• Catalog data, catalog group data, and catalog entry data that is used in this sample is loaded into the database.
• ATP inventory configuration data is loaded into the database.
• The data of VendorName in the source CSV file exists in the table VENDOR of the database.

CSV file with sample receipt data

CSV column and XML element definitions

PartNumber

(string) The part number of this item. It uniquely identifies an item for a particular owner. Together with the owner identifier, it is used to retrieve the primary key of ITEMSPC table, that is, ITEMSPC_ID. This field is required and cannot be null if the CatalogEntryUniqueId field is not specified in CSV file.

CreateTime

(Required, timestamp) The date and time this record is created. The default format of the input is "yyyy-mm-dd hh:mm:ss.SSSSSS". The length of the fractional seconds must be no more than 6. The format can be customized by setting timestampPattern property in wc-dataload.xml. This field is part of the unique index of RECEIPT table. This field is required and cannot be null.

ReceiptDate

(Timestamp) The date and time the inventory was received. The format is same as specified in CreateTime. The current time is used if it is empty in CSV file.

Quantity

(Integer) The quantity received. 0 is used if it is not provided.

Cost

(Double) The unit cost.

Currency

(String) The currency of the unit cost. This is a currency code as per ISO 4217 standards.

VendorName

(String) The vendor that supplied the inventory.

Comment1

(String) The comments. The length of the comment should be no more than 254.

Comment2

(String) The other comments. The length of the comment should be no more than 254.

CatEntryStoreIdentifier

(String) This identifier is used in an extended sites store. If the CatalogEntry is defined in a catalog entry asset store, this field stands for the identifier of the catalog entry asset store. This identifier is used to retrieve the catalog entryOwner.

This field is required if you are using an extended sites store.

Other optional fields not included in the example:

CurrentStoreIdentifier

(String) The identifier of the store that this item belongs to, such as ConsumerDirect. This column can be added into CSV if the item belongs to a store that is different from the store that is defined in BusinessContext elements of wc-dataload-env.xml. If this column is not provided in the CSV file, the StoreIdentifier in the business context is used.

FulfillmentCenterId

(Integer) The identifier of the fulfillment center that this item belongs to. This column can be added into CSV if the item belongs to a fulfillment center that is different from the one defined in BusinessContext property of wc-dataload-env.xml. If this column is not provided in the CSV file, the fulfillmentCenterIdentifier is retrieved by FulfillmentCenterName. If it is not found, the fulfillmentCenterIdentifier in the business context is used. If it is not specified in either CSV file or business context, the default fufillmentCenter of the specified store is used.

FulfillmentCenterName

(String) The name of the fulfillment center that this item belongs to, such as ConsumerDirect Home. This column is used to retrieve fulfillmentCenterIdentifier.

OwnerId

(Long) The identifier of the owner of this item. If it is not specified in the CSV file, the owner of the catalog entry asset store is retrieved. If it is not found, the owner of current store is retrieved. If it is not found either, the ownerId specified in BusinessContext property of wc-dataload-env.xml is used.

CatalogEntryUniqueId

(Long) The identifier of the catalog entry. It is used to retrieve the primary key of ITEMSPC table, that is, ITEMSPC_ID. If this field is not specified in CSV file, ITEMSPC_ID is retrieved by part number and owner of the item.

Delete

(String) Indicates whether to delete this record. This field takes effect when dataLoadMode is "replace". If the value of this field equals to deleteValue, the corresponding record is deleted. The default deleteValue is 1 and the deleteValue can be configured under <DataMapping> element in BusinessObjectConfigFile.

Business context data

The following code snippet from the wc-dataload-env.xml configuration file provides the business context data necessary for loading the receipt data:

<_config:BusinessContext storeIdentifier="ConsumerDirect">

  <_config:property name="fulfillmentCenterName" value="ConsumerDirect Home"/>

  <_config:property name="ownerId" value="7000000000000000102"/>

</_config:BusinessContext>

storeIdentifier

(String) The identifier of the store this item belongs to, such as ConsumerDirect. It is used if CSV file does not provide this information. The StoreIdentifier is used to retrieve the storeID and the ownerID.

fulfillmentCenterId

(String) The identifier of the fulfillment center this item belongs to, for example "ConsumerDirect Home". It is used if the identifier cannot be retrieved by FulfillmentCenterId or FulfillmentCenterName specified in CSV file.

fulfillmentCenterName

(String) The name of the fulfillment center this item belongs to, for example "ConsumerDirect Home". It is used to retrieve the fulfillmentCenterID, if fulfillmentCenterID is not retrieved from CSV file or defined in business context.

ownerId

(Long) The identifier of the owner of this item. It is used if the item owner is not provided in CSV file and cannot be retrieved by specified store identifier.

Mapping data

The following snippet from the sample configuration file demonstrates how to map each column of data in the source CSV file to a value.

<_config:DataReader className="com.ibm.commerce.foundation.dataload.datareader.CSVReader" firstLineIsHeader="true">
  <_config:Data>
  <_config:column number="1" name="PartNumber" />
  <_config:column number="2" name="CreationTime" />
  <_config:column number="3" name="ReceiptDate" />
  <_config:column number="4" name="Quantity" />
  <_config:column number="5" name="Cost" />
  <_config:column number="6" name="Currency" />
  <_config:column number="7" name="VendorName" />
  <_config:column number="8" name="Comment1" />
  <_config:column number="9" name="Comment2" />
  <_config:column number="10" name="CatEntryStoreIdentifier" />
                                     
 </_config:Data>

</_config:DataReader >

The following snippet from the sample configuration file demonstrates how to map each column of the data in the CSV file to a business object logical schema path. The attribute 'value' represents the name of a column of the CSV file, which is defined in the configuration snippet. Each column in the CSV file must have a mapping to the logical schema path. If the optional fields specified are present in the CSV file, the mapping for them must be added. The mapping logical schema path is specified in the following table.

<_config:DataMapping>
                       
   <_config:mapping xpath="InventoryReceiptIdentifier/ExternalIdentifier/CatalogEntryIdentifier/ExternalIdentifier/PartNumber" value="PartNumber" valueFrom="InputData" />
   <_config:mapping xpath="InventoryReceiptIdentifier/ExternalIdentifier/CreationTime" value="CreationTime" valueFrom="InputData" />
   <_config:mapping xpath="ReceiptDate" value="ReceiptDate" valueFrom="InputData" /> 
   <_config:mapping xpath="QuantityReceived/value" value="Quantity" valueFrom="InputData" />
   <_config:mapping xpath="QuantityOnHand/value" value="Quantity" valueFrom="InputData" />
   <_config:mapping xpath="UnitCost/value" value="Cost" valueFrom="InputData" />
   <_config:mapping xpath="UnitCost/currency" value="Currency" valueFrom="InputData" />
   <_config:mapping xpath="VendorName" value="VendorName" valueFrom="InputData" />
   <_config:mapping xpath="Comment1" value="Comment1" valueFrom="InputData" />
   <_config:mapping xpath="Comment2" value="Comment2" valueFrom="InputData" />
   <_config:mapping xpath="InventoryReceiptIdentifier/ExternalIdentifier/CatalogEntryIdentifier/ExternalIdentifier/StoreIdentifier/ExternalIdentifier/NameIdentifier" value="CatEntryStoreIdentifier" />
   
</_config:DataMapping>

Business object mediator

The mediator class name is com.ibm.commerce.inventory.dataload.mediator.InventoryReceiptMediator. The corresponding logical schema is InventoryReceipt.xsd.