Example: Inserting and replacing catalog filter condition groups

You can insert and replace catalog filter condition groups by using the Data Load utility.

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.

Prerequisites

Ensure that the store exists.
Ensure that the catalog data exists.
Ensure that the catalog filter catalog group selection is loaded.

CSV file with sample catalog filter condition group data

CatalogFilterConditionGroup.csv

The file contains sample catalog filter condition group data. Each column is delimited by a comma.

Sample data
CatalogFilterName	StoreIdentifier	CatalogIdentifier	CatalogGroupIdentifier	ConditionGroupIdentifier	ConditionRelation
CatalogFilterA	Aurora	Aurora	Lounge Chairs	conditionLoungeChairAnd	And
CatalogFilterA	Aurora	Aurora	Lounge Chairs	conditionLoungeChairOr	Or

CSV column and XML element definitions

CatalogFilterName: Required, String: The name of the catalog filter. Ensure that the combination of CatalogIdentifier, StoreIdentifier, and CatalogFilterName are unique.
StoreIdentifier: Required, String: The identifier of the store that the catalog filter belongs to.
CatalogIdentifier: Required, String: The identifier of the catalog that the catalog filter belongs to.
CatalogGroupIdentifier: Required, String: The identifier of the catalog group to include or exclude in this catalog filter.
ConditionGroupIdentifier: Required, String: The unique name of the condition.
ConditionRelation: Required, String: The relationship for the condition: Or, And.

Other optional fields not included in the example are:

CatalogFilterId: Optional, String: The reference number of the catalog filter. If the reference number is provided in the CSV, then it is used. If this field is provided, then the CatalogFilterName, CatalogFilterName, CatalogIdentifier is not needed.
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 gets deleted. The default deleteValue is 1, deleteValue may be configured under <DataMapping> element in BusinessObjectConfigFile.
Field1: Optional, Long: Extension field for Long value.
Field2: Optional, Integer: Extension field for integer value.
Field3: Optional, String: Extension field for String value, the maximum length is 254.
Field4: Float(20,5): Extension field for float value.
Field5: Number: Extension field for Number value.

Business context data

The following code snippet from the wc-dataload-env.xml configuration file provides the required business context data:

<_config:BusinessContext storeIdentifier="AuroraESite" catalogIdentifier="Extended Sites Catalog Asset Store">
</_config:BusinessContext>

storeIdentifier: String: The store identifier. This parameter is used when the storeIdentifier is not provided in the CSV file. If the storeIdentifier is provided in the CSV file, it is used. The storeIdentifier is used to retrieve the storeID and the ownerID.
catalogIdentifier: String: The catalog identifier. This parameter is used when the catalog identifier is not provided in the CSV file. If the catalogIdentifier is provided in the CSV file, it 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.


<_config:DataReader 
className="com.ibm.commerce.foundation.dataload.datareader.CSVReader" 
firstLineIsHeader="true" 
useHeaderAsColumnName="true" />

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 above. Each column in the CSV file must have a mapping to the logical schema path. If the optional fields specified above 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="CatalogFilterIdentifier/UniqueID" value="CatalogFilterId" />
      
  <_config:mapping xpath="CatalogFilterIdentifier/ExternalIdentifier/Identifier" value="CatalogFilterName" />
  <_config:mapping xpath="CatalogFilterIdentifier/ExternalIdentifier/StoreIdentifier/ExternalIdentifier/NameIdentifier" value="StoreIdentifier" />
  <_config:mapping xpath="CatalogFilterIdentifier/ExternalIdentifier/CatalogIdentifier/ExternalIdentifier/Identifier" value="CatalogIdentifier" />
		
  <_config:mapping xpath="CatalogGroupSelection/CatalogGroupSelectionIdentifier/ExternalIdentifier/CatalogGroupIdentifier/ExternalIdentifier/GroupIdentifier" value="CatalogGroupIdentifier" />
  <_config:mapping xpath="CatalogGroupSelection/ConditionGroup/ConditionGroupIdentifier/ExternalIdentifier/Identifier" value="ConditionGroupIdentifier" />
	
  <_config:mapping xpath="CatalogGroupSelection/ConditionGroup/conditionRelation" value="ConditionRelation" />
  <_config:mapping xpath="CatalogGroupSelection/ConditionGroup/UserData/UserDataField[0]/Field1" value="Field1" />
  <_config:mapping xpath="CatalogGroupSelection/ConditionGroup/UserData/UserDataField[0]/Field2" value="Field2" />
  <_config:mapping xpath="CatalogGroupSelection/ConditionGroup/UserData/UserDataField[0]/Field3" value="Field3" />
  <_config:mapping xpath="CatalogGroupSelection/ConditionGroup/UserData/UserDataField[0]/Field4" value="Field4" />
  <_config:mapping xpath="CatalogGroupSelection/ConditionGroup/UserData/UserDataField[0]/Field5" value="Field5" />
 
  <_config:mapping xpath="" value="Delete"  deleteValue="1"/>
</_config:DataMapping>

Business object mediator

The mediator class name is com.ibm.commerce.catalogfilter.dataload.mediator.CatalogFilterConditionGroupMediator. The corresponding logical schema is CatalogFilter.xsd .

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.