Example: Catalog entry defining attribute allowed values

You can use the Data Load utility to insert, replace, or delete allowed values for defining attributes at the product level. You can enter multiple allowed values for each attribute at the same time.

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

PartNumber
(Required, String) The catalog entry identifier (product). Either this field or the CatalogEntryUniqueId is required. The part number for a catalog entry displays in Management Center as the value for the catalog entry Code property.
CatalogEntryUniqueId
(Required, BigInt) The internal unique reference number of the catalog entry (product). Either this field or the PartNumber is required.
Name
(String) The name of this attribute. This field is language sensitive.
ValueSequence
(Double) A sequence number that is used to control the order in which attribute values are displayed in an attribute. This value cannot be NULL. The default value = 0.
Value
(String|Integer|Float)) The value of the attribute.
Image1
(String) The path of the first image of this attribute. This field is language sensitive.
Image2
(String) The path of the second image of this attribute. This field is language sensitive.
AttachmentID
(BigInt) The reference number of an attachment that is associated with the attribute value.
Delete
(String) A flag indicating whether to delete. Specify 1 to delete the row.

Other optional fields not included in the example are:

ValueField1
(Integer) A user-defined attribute value field available for customization purposes.
ValueField2
(String) A user-defined attribute value field available for customization purposes.
ValueField3
(String) A user-defined attribute value field available for customization purposes.

CSV file with sample catalog entry defining attribute data

Insert or replace

In this example, the CSV file contains sample allowed values for defining attributes. CSV file with sample defining attribute allowed values. Due to the large number of fields in the CSV file, the table is split into two sections:

Formatted CSV file with column headings
PartNumber Name ValueSequence Value
Example-PN-10001 Color 1 Red
Example-PN-10001 Color 2 Blue
Example-PN-10002 Size 3 Large
Example-PN-10002 Size 4 Small
Formatted CSV file with column headings - continued
Image1 Image2 AttachmentID
Red1/image.jpg Red2/image.jpg 1221
Blue1/image.jpg Blue2/image.jpg
Large1/image.jpg Large2/image.jpg 1222
Small1/image.jpg Small2/image.jpg

Delete

In this example, the CSV file contains sample allowed values for defining attributes that are to be deleted. CSV file with sample defining attribute allowed values. Due to the large number of fields in the CSV file, the table is split into two sections:

Formatted CSV file with column headings
PartNumber Name ValueSequence Value
Example-PN-10001 Color 1 Red
Example-PN-10001 Color 2 Blue
Example-PN-10002 Size 3 Large
Example-PN-10002 Size 4 Small
Formatted CSV file with column headings - continued
Image1 Image2 UnitOfMeasure AttachmentID Delete
Red1/image.jpg Red2/image.jpg 1221 1
Blue1/image.jpg Blue2/image.jpg 1
Large1/image.jpg Large2/image.jpg 1222 1
Small1/image.jpg Small2/image.jpg 1

Mapping data

The following code snippet from the catalog entry defining attribute allowed values loader configuration file demonstrates how to map each value to a business object logical schema path.
<_config:DataMapping>
	<_config:mapping xpath="CatalogEntryIdentifier/ExternalIdentifier/PartNumber" value="PartNumber" valueFrom="InputData"/>
	<_config:mapping xpath="CatalogEntryIdentifier/UniqueID" value="CatalogEntryUniqueId" valueFrom="InputData"/>
	<_config:mapping xpath="CatalogEntryAttributes/Attributes[0]/AttributeIdentifier/UniqueID" value="AttributeUniqueId" valueFrom="InputData"/>
	<_config:mapping xpath="CatalogEntryAttributes/Attributes[0]/Name" value="Name" valueFrom="InputData" />
	<_config:mapping xpath="CatalogEntryAttributes/Attributes[0]/AllowedValue/displaySequence" value="ValueSequence" valueFrom="InputData" />
	<_config:mapping xpath="CatalogEntryAttributes/Attributes[0]/AllowedValue/identifier" value="Value" valueFrom="InputData" />
	<_config:mapping xpath="CatalogEntryAttributes/Attributes[0]/AllowedValue/Value" value="Value" valueFrom="InputData" />
	<_config:mapping xpath="CatalogEntryAttributes/Attributes[0]/AllowedValue/ExtendedValue/Image1" value="Image1" valueFrom="InputData"/>
	<_config:mapping xpath="CatalogEntryAttributes/Attributes[0]/AllowedValue/ExtendedValue/Image2" value="Image2" valueFrom="InputData" />
	<_config:mapping xpath="CatalogEntryAttributes/Attributes[0]/AllowedValue/ExtendedValue/Field1" value="ValueField1" valueFrom="InputData" />
	<_config:mapping xpath="CatalogEntryAttributes/Attributes[0]/AllowedValue/ExtendedValue/Field2" value="ValueField2" valueFrom="InputData" />
	<_config:mapping xpath="CatalogEntryAttributes/Attributes[0]/AllowedValue/ExtendedValue/Field3" value="ValueField3" valueFrom="InputData" />
	<_config:mapping xpath="CatalogEntryAttributes/Attributes[0]/AllowedValue/ExtendedValue/AttachmentID" value="AttachmentID" valueFrom="InputData" />
	<_config:mapping xpath="" value="Delete" valueFrom="InputData" 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.CatalogEntryAttributeMediator.

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.