AttributeDictionaryAttributeAndAllowedValues

Use the AttributeDictionaryAttributeAndAllowedValues keyword to load attribute dictionary attributes and predefined (allowed) values.

Previously, you could load this data only in CSV formatted files. You can now load information in a CSV or XML formatted input file. Your input file must contain CSV column or XML element names and definitions that specify the characteristics of the business object type you are loading into your database.

If you are loading attributes to the store for the first time, you must log out of the Management Center and then log on again to see the attribute dictionary and the attributes within the dictionary. The load file columns specify the characteristics of the attribute dictionary attribute and its predefined values, such as display sequence and descriptions.

Note: To load attribute dictionary attributes predefined values in other languages, use the AttributeDictionaryAttributeAllowedValues keyword.

CSV column and XML element definitions

Identifier
(String) The unique reference name for identifying the attribute. Either this field or the AttributeUniqueId is required.
AttributeUniqueId
(Integer) The unique reference number of the attribute. Either this field or the Identifier is required.
Type
(Mandatory, String) The data type of the attribute.
  • STRING
  • INTEGER
  • FLOAT
This field cannot be null.
AttributeType
(Integer) The type of the attribute:
Predefined values
1
Assigned values
2 or null
Sequence
(Decimal) A number that is used to control the order in which attribute values display for an attribute dictionary attribute. Attribute values display in ascending order. The default value is 0.
Displayable
(Boolean) Indicates whether an attribute is displayable. There is no business logic that is associated with the usage of this field. It is provided by default for you to extend to meet your individual business needs. Set the column value to be true for displayable attributes. Set the column value to be false or null for attributes that are not displayable. Any value other than true automatically defaults to false.
Searchable

(Boolean) Indicates whether an attribute is indexed by and can be located in the storefront by using HCL Commerce search. Set the column value to 'true' to make an attribute searchable. Set the column value to be 'false' or null for attributes that are not searchable. Any value other than 'true' automatically defaults to false.

Comparable
(Boolean) Indicates whether an attribute is comparable. There is no business logic that is associated with the usage of this field. It is provided by default for you to extend to meet your individual business needs. Set the column value to be true for comparable attributes. Set the column value to be false or null for attributes that are not comparable. Any value other than true automatically defaults to false.
Facetable
(Boolean) Indicates whether an attribute can be used for displaying facets in the storefront left sidebar to filter product listings. Facets are created in the storefront left sidebar, enabling usable filters to target meaningful product results. The storefront displays a count for each facet value. This count indicates the number of products that share that facet value. Set the column value to be true for attributes that can be used in faceted navigation. Set the column value to be false or null for attributes that are not for use in faceted navigation.Setting an attribute as for use in faceted navigation makes the attribute usable in the Search Criteria and Result target in marketing activities and search rules.
Important: When an attribute is specified as being used in faceted navigation, it is also specified as searchable in your storefront. Links are created for the attribute throughout the HCL Commerce database and search index. For reliability and consistency, these searchable links remain intact despite clearing the check box for making an attribute for use in faceted navigation. You cannot unmark an attribute as searchable. When an attribute is selected for use in faceted navigation, the attribute is automatically set as searchable in the storefront. Business users can remove the Use in faceted navigation setting, but they cannot remove the attribute from being searchable. To remove the attribute from being searchable, you must manually update the HCL Commerce database to remove the records that make the attribute searchable.
When you load data to set or change a faceted navigation attribute or to delete the attribute, the load operation can update the following HCL Commerce search database tables in addition to the attribute dictionary database tables. To update these search tables, configure the load operation to use the com.ibm.commerce.catalog.dataload.mediator.AttributeDictionaryAttributeSearchIndexMediator business object mediator.
  • FACET
  • SRCHATTR
  • SRCHATTRPROP
  • ATTRDICTSRCHCONF
  • SRCHPROPRELV
STOREDISPLAY
(Integer) Specifies that this attribute is for use as a ribbon ad in the storefront.
Merchandisable
(Boolean) Indicates that the attribute can be used as a merchandising attribute in the creation of search conditions for use by any of the following objects:
  • Marketing activities for finding catalog entries to recommend to customers in e-Marketing Spots.

    Merchandising attributes can also be used in search conditions within a marketing activity to identify a current page target.

  • Search rules for finding catalog entries.
  • Sales and rule-based categories for finding catalog entries to assign to the categories.
Only attributes with predefined values can be used as merchandising attributes. An attribute that is identified as for 'Use in merchandising' is intended for internal business use to create these rules and activities. If you set a merchandising attribute to be displayable, searchable, or facetable when you load information for an attribute, then the attribute can also appear on the storefront. Set the column value to be true for merchandising attributes. Set the column value to be false or null for attributes that are not for use in merchandising. Any value other than true automatically defaults to false. When you load data to set or change a merchandising attribute or to delete the attribute, the load operation can update the following HCL Commerce search database tables in addition to the attribute dictionary database tables. Configure the load operation to use the com.ibm.commerce.catalog.dataload.mediator.AttributeDictionaryAttributeSearchIndexMediator business object mediator.
  • SRCHATTR
  • SRCHATTRPROP
  • ATTRDICTSRCHCONF
AttributeField1
(Integer) A custom field for attribute information.
AttributeField2
(Integer) A custom field for attribute information.
AttributeField3
(String) A custom field for attribute information.
Language
(Integer) The language identifier for language-specific fields. For example:
  • -1 for English
  • -2 for French.
LanguageId
(Integer) The language identifier for language-specific fields. For example:
  • -1 for English
  • -2 for French.
The Language column is renamed to LanguageId. You must specify only one language identifier; use LanguageId instead of Language as the language identifier.
(Integer) The language ID for language-specific fields (Name, ShortDescription, LongDescription, AuxDescription1, AuxDescription2, Thumbnail, FullImage, Published, and Keyword). For instance:
  • -1 for English
  • -2 for French.
Name
(String) The language-specific name of the attribute.
Description
(String) A language-specific description of this attribute.
SecondaryDescription
(String) The language-specific secondary description of this attribute.
GroupName
(String) The name of the attribute group this attribute belongs to.

The GroupName column is renamed to AssociatedKeyword. Although both GroupName and AssociatedKeyword are supported and map to the same database column, use AssociatedKeyword instead of GroupName.

AssociatedKeyword
(String) An associated keyword for an attribute.
ATTRDESC.GROUPNAME
Field1
(String)A custom field for attribute information.
Footnote
(String) Use this field to store auxiliary attribute data such as a footnote.
UnitOfMeasure
(String) Use this field to specify the unit of measure that is used for the attribute.
AllowedValue1
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue1
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue2
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue2
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue3
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue3
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue4
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue4
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue5
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue5
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue6
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue6
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue7
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue7
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue8
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue8
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue9
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue9
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue10
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue10
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue11
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue11
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue12
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue12
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue13
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue13
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue14
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue14
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue15
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue15
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue16
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue16
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue17
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue17
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue18
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue18
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue19
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue19
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue20
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue20
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue21
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue21
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue22
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue22
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue23
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue23
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue24
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue24
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
AllowedValue25
(String|Integer|Float) A predefined value of the attribute.
ImagePath1ForValue25
(String) Where applicable, the relative path to the image that represents the predefined attribute value, such as a swatch image. Example: images/catalog/clothing/women/swatches/swatch_pink.png
Delete
(String) A flag that indicates whether to delete the attribute. Specify 1 to delete the row.