Example: Deleting offers with a single currency
The Data Load utility provides two modes for deleting offers with multiple currencies defined in a load file from your database: delete and replace. Use the delete mode to delete offers if the mode is set to "Delete" in the data load configuration file. Use the replace mode to delete offers if the mode is set to "Replace" in the data load configuration file. The behavior of each mode depends on whether the identifier is specified.
This example uses a CSV file to demonstrate how to insert, replace, or delete your data. You can also create and use an XML formatted file to insert, replace, or delete your data. If you choose to create and use an XML formatted file, ensure that your XML elements use the same names as are used for CSV column names.
CSV file with sample offer data to be deleted
- Replace mode
-
- Identifier specified: Deletes only the specified offer according to the Identifier when delete flag is set. If the offer with the Identifier does not exist in the database, no offer is deleted.
- Identifier not specified: Deletes all offers with same pair in the database when delete flag is set.
- Delete mode
- It ignores the delete flag and always delete offers when:
- Identifier specified: Deletes only the specified offer according to the Identifier. If the offer with the Identifier does not exist in the database, no offer is deleted.
- Identifier not specified: Deletes all offers with same pair in the database.
Standard Price List,1000573,1100456,3,2009-03-15 15:47:00.0,2009-05-15 15:47:00.0,
each,10,0,2009-03-16 15:47:00.0,Elegant wine glass,4.50,USD,y
Holiday price list,1000574,1100457,5,2009-12-15 15:47:00.0,2009-12-31 15:47:00.0,each,5,0,2009-11-28 15:47:00.0,
Decorative bed cover,55.84,BRL
Legacy system price list,1000575,1100458,2,2009-02-15 15:47:00.0,2009-06-02 15:47:00.0,each,10,0,2009-02-22 15:47:00.0,
Old Cologne,68.27,CNY
Overstock price list,1000576,1100459,3,2009-03-15 15:47:00.0,2009-03-31 15:47:00.0,each,10,0,2009-03-16 15:47:00.0,
Candle holder,2.32,EUR,y
The first row in the CSV file can also be column names, which depend on the
firstLineIsHeader
attribute in the price list data load configuration file. The
firstLineIsHeader
is an attribute of <_config:DataReader>
element. - firstLineIsHeader
-
- true
- Indicates that the first line in the CSV file is treated as column name data, and it is not inserted into the database.
- false
- Indicates that the first line in the CSV file is data to be read and inserted into the database.
CSV column and XML element definitions
The column order is defined in the offer data load configuration file. See the
number
attribute in the <_config:Data>
element.
- PriceListUniqueID
- (Optional, String) The identifier of the price list. When there is a data mapping for price list UniqueID in the price list data load configuration file, then the uniqueID is mandatory in the CSV file.
- PriceListName
- (Optional, String) The name of the price list that contains this offer. When you are deleting offer, price list name or price list UniqueID is optional. When both of them are not provided in CSV file, the default price list of the store is used to delete. If any of them is provided, the provided price list is used to delete. If both of them are provided in CSV file, the price list uniqueID is used to delete.
- CatentryUniqueID
- (Optional, String) The unique identifier for the related catentry. When there is a data mapping in the offer data load configuration file, the CatentryUniqueID is mandatory. If both of them are provided in CSV file, the CatentryUniqueID is used to delete.
- CatentryPartNumber
- (Mandatory, String) The part number of the catalog entry that this offer defined for.
- Identifier
-
(Optional, Double) The number that uniquely identifies the offer when the value for the column is combined with unique catalog entry ID and price list ID values for the offer. Maps to the OFFER.IDENTIFIER database column.
- Precedence
- (Optional, Double) When more than one Offer is effective at a particular time, the one with the highest precedence is used. If not specified in the input file, the value is set to "0.0".
- StartDate
- (Optional, Timestamp) The start of the time range during which this offer is effective. Use the
format
yyyy-mm-dd hh:mm:ss.millis
. - EndDate
- (Optional, Timestamp) The end of the time range during which this offer is effective. Use the
format
yyyy-mm-dd hh:mm:ss.millis
. - QuantityUnitIdentifier
- (Optional, String) The unit of measure for Minimum Quantity and Maximum Quantity.
- MaximumQuantity
- (Optional, Double) The maximum quantity that can be purchased in a single order under this offer.
- MinimumQuantity
- (Optional, Double) The minimum quantity that can be purchased in a single order under this offer.
- LastUpdate
- (Optional, Timestamp) The last time that the offer is updated. Use the format yyyy-mm-dd hh:mm:ss.millis.
- Description
- (Optional, String) The description for this offer.
- Price
- (Optional, Decimal) The price of the offer in the wanted currency.
- Currency
- (Optional, String) The currency that is specified for the offer price.
- Delete
- (Optional, String) Indicates whether this multiple-currency offer should be deleted. The deleteValue is the string that you want to use in the CSV file to indicate that you want to delete that offer. In this example, the string 'y' is used.
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 and how to map which columns should be deleted.
<_config:DataSource>
<_config:Data>
<_config:column number="1" name="PriceListUniqueId" />
<config:column number="2" name="PriceListName" />
<_config:column number="3" name="CatentryUniqueId" />
<_config:column number="4" name="CatentryPartNumber" />
<_config:column number="5" name="Identifier" />
<_config:column number="6" name="Precedence" />
<_config:column number="7" name="StartDate" />
<_config:column number="8" name="EndDate" />
<_config:column number="9" name="QuantityUnitIdentifier"/>
<_config:column number="10" name="MinimumQuantity" />
<_config:column number="11" name="MaximumQuantity" />
<_config:column number="12" name="LastUpdate" />
<_config:column number="13" name="Description" />
<_config:column number="14" name="Price" />
<_config:column number="15" name="Currency" />
<_config:column number="16" name="Delete" />
</_config:Data>
</_config:DataSource>
The
number
attribute in the <_config:column>
element, defines the
column order in the CSV record file. The name
attribute defines the column name
that is used in the <_config:DataMapping>
element.<_config:DataMapping>
<_config:mapping xpath="PriceListIdentifier/UniqueID" value="PriceListUniqueId" valueFrom="InputData" />
<_config:mapping xpath="PriceListIdentifier/ExternalIdentifier/Name" value="PriceListName"
valueFrom="InputData" />
<_config:mapping xpath="PriceEntry[0]/CatalogEntryIdentifier/UniqueID" value="CatentryUniqueId"
valueFrom="InputData" />
<_config:mapping xpath="PriceEntry[0]/CatalogEntryIdentifier/ExternalIdentifier/PartNumber"
value="CatentryPartNumber" valueFrom="InputData" />
<_config:mapping xpath="PriceEntry[0]/Qualifier" value="Identifier" valueFrom="InputData" />
<_config:mapping xpath="PriceEntry[0]/Precedence" value="Precedence" valueFrom="InputData" />
<_config:mapping xpath="PriceEntry[0]/StartDate" value="StartDate" valueFrom="InputData" />
<_config:mapping xpath="PriceEntry[0]/EndDate" value="EndDate" valueFrom="InputData" />
<_config:mapping xpath="PriceEntry[0]/QuantityUnit" value="QuantityUnitIdentifier" valueFrom="InputData" />
<_config:mapping xpath="PriceEntry[0]/MaximumQuantity" value="MaximumQuantity" valueFrom="InputData" />
<_config:mapping xpath="PriceEntry[0]/MinimumQuantity" value="MinimumQuantity" valueFrom="InputData" />
<_config:mapping xpath="PriceEntry[0]/LastUpdate" value="LASTUPDATE" valueFrom="InputData" />
<_config:mapping xpath="PriceEntry[0]/Description/Value" value="Description" valueFrom="InputData" />
<_config:mapping xpath="PriceEntry[0]/Price/Value" value="Price" valueFrom="InputData" />
<_config:mapping xpath="PriceEntry[0]/Price/Currency" value="Currency" valueFrom="InputData" />
<_config:mapping xpath="" value="Delete" valueFrom="InputData" deleteValue="y" />
</_config:DataMapping>
The
value
attribute in the <_config:DataMapping>
element must be
consistent with the name
attribute of the corresponding item in the
<_config:column>
element. Both attributes are case-sensitive.Business object mediator
The mediator class name is
com.ibm.commerce.price.dataload.mediator.OfferMediator
.
The following example shows how to configure the BusinessObjectMediator in the offer data load configuration file to mark an offer for deletion, or to delete it from the database.
<_config:BusinessObjectMediator className=
"com.ibm.commerce.price.dataload.mediator.OfferMediator">
<_config:property name="markOfferForDelete" value="true" />
</_config:BusinessObjectMediator>
- markOfferForDelete
-
- true
- The offer is marked for delete. To delete the records, use the Database Cleanup utility.
- false
- The offer is deleted from the database. All related records are cascade deleted.