Example: Master and sales catalogs

You can insert, replace, or delete your master and sales catalog by using the Data Load utility at the same time. These examples use a load file to demonstrate how to insert, replace, or delete your master and sales catalog.

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 column and XML element definitions

Identifier
(Required, String) The catalog identifier. This field cannot be null in Insert and it must be unique. In Replace or Delete, either this field or the CatalogUniqueId is required.
CatalogUniqueId
(Required, BigInt) The internal unique reference number of the catalog. In Replace or Delete, either this field or the Identifier is required.
Name
(String) The language-specific display name of this catalog.
Description
(String) A language-specific description of this catalog.
ShortDescription
(String) A language-specific short description of this catalog.
LongDescription
(String) A language-specific long description of this catalog.
Thumbnail
(String) The language-specific thumbnail image path of this catalog. For example, images/G1.jpg.
FullImage
(String) The language-specific full image path of this catalog. For example, images/G1.jpg.
MasterCatalog
(Boolean) A flag indicating whether the catalog is a master catalog. The default value is false. Any value other than true automatically defaults to false.
Delete
(String) A flag indicating whether to delete. Specify 1 to delete the row.

CSV file with sample catalog data

Insert or replace

In this example, you insert four new catalog data. The file contains sample master and sales catalog data. Each column is delimited by a comma. CSV file with sample catalog data
Formatted CSV file with column headings
Identifier Name Description ShortDescription LongDescription Thumbnail FullImage MasterCatalog
Example_master_cat Example master catalog Example master catalog description Example master catalog short description Example master catalog long description master_thumb/image.jpg master_full/image.jpg true
Summer_sales_cat1 Summer sales catalog Summer sales catalog description Summer sales catalog short description Summer sales catalog long description summer_thumb/image.jpg summer_full/image.jpg false
Winter_sales_cat2 Winter sales catalog Winter sales catalog description Winter sales catalog short description Winter sales catalog long description Winter_thumb/image.jpg Winter_full/image.jpg false
Spring_sales_cat3 Spring sales catalog Spring sales catalog description Spring sales catalog short description Spring sales catalog long description Spring_thumb/image.jpg Spring_full/image.jpg false

Delete

In this example, the first three rows of data are deleted, and the fourth row replaces an existing data. Each column is delimited by a comma. CSV file with sample catalog data to be deleted or replaced
Formatted CSV file with column headings
Identifier Name Description ShortDescription LongDescription Thumbnail FullImage MasterCatalog Delete
Example_master_cat Example master catalog Example master catalog description Example master catalog short description Example master catalog long description master_thumb/image.jpg master_full/image.jpg true 1
Summer_sales_cat1 Summer sales catalog Summer sales catalog description Summer sales catalog short description Summer sales catalog long description summer_thumb/image.jpg summer_full/image.jpg false 1
Winter_sales_cat2 Winter sales catalog Winter sales catalog description Winter sales catalog short description Winter sales catalog long description Winter_thumb/image.jpg Winter_full/image.jpg false 1
Spring_sales_cat3 Spring sales catalog Spring sales catalog new description Spring sales catalog new short description Spring sales catalog new long description Spring_thumb/image.jpg Spring_full/image.jpg false

Mapping data

The following code snippet from the catalog loader configuration file demonstrates how to map each value to a business object logical schema path.

<_config:DataMapping>
	<_config:mapping xpath="CatalogIdentifier/ExternalIdentifier/Identifier" value="Identifier" valueFrom="InputData"/>
	<_config:mapping xpath="CatalogIdentifier/UniqueID" value="CatalogUniqueId" valueFrom="InputData"/>
	<_config:mapping xpath="primary" value="MasterCatalog" valueFrom="InputData" />
	<_config:mapping xpath="Attributes/description" value="Description" valueFrom="InputData" />
	<_config:mapping xpath="Description[0]/Name" value="Name" valueFrom="InputData" />
	<_config:mapping xpath="Description[0]/ShortDescription" value="ShortDescription" valueFrom="InputData" />
	<_config:mapping xpath="Description[0]/LongDescription" value="LongDescription" valueFrom="InputData" />
	<_config:mapping xpath="Description[0]/Thumbnail" value="Thumbnail" valueFrom="InputData" />
	<_config:mapping xpath="Description[0]/FullImage" value="FullImage" valueFrom="InputData" />
	<_config:mapping xpath="" value="Delete" deleteValue="1"/>
</_config:DataMapping> 
If you perform an insert or replace operation, do not specify the "Delete" column in the CSV file or you can leave the "Delete" column empty.

Business object mediator

The mediator class name is com.ibm.commerce.catalog.dataload.mediator.CatalogMediator. If you want to initialize attribute dictionary for your store, see Initializing the attribute dictionary.

Note: When you use a mediator that is provided with HCL Commerce with the Data Load utility, the utility assumes that you are loading data for all columns for a business object. If you want to update the data in only specific columns, configure a column exclusion list for the load process. A column exclusion list causes the Data Load utility to ignore specific columns during the load operation. If you do not use a column exclusion list, the utility updates all columns in the row of a database table row when the utility updates the row. If no value is set in the input file, the utility can replace the existing column value with a default value or set the value to be null. For more information, see Configuring a column exclusion list.