Record properties for all dimension values

CAS produces one dimension value for each Endeca record that CAS crawls. Each Endeca record may have record properties listed in the table below to specify information about a dimension value. The properties describe the name, specification, parent relationship, display order, and any synonyms for the dimension value.

Property Name

Property Value

dimval.spec

Required. The unique Id of a dimension value. The dimval.spec must be unique within a dimension.

dimval.dimension_name

Required. The name of the dimension that the dimension value belongs to.

dimval.display_order

Optional. A numeric value that specifies the display order of a dimension value relative to its sibling dimension values when returned as refinements. Dimension values with lower values display before dimension values with higher values. Valid values are integers between 0 and 2147483647. If this property is unspecified, the dimension value displays lower than dimension values with specified display orders.

Note

The dimval.display_order property sets display order for dimension values. You can set the display order of dimensions, relative to other dimensions, using the Configuration Import API or the Index Configuration Command-line Utility. For details about the API, see, Configuration Import API Reference (Javadoc). For details about the utility, see "Modifying Index Configuration for an Application" in the Oracle Commerce Guided Search Administrator's Guide.

dimval.parent_spec

Required. The unique Id of a parent dimension value. Root dimension values should have a value of forward slash ( / ).

dimval.display_name

Optional. The name of the dimension value indicated by dimval.spec.

dimval.match.use_spec

Optional. A Boolean value that specifies whether property matching is based on dimval.spec. A value of true uses a record's dimval.spec to match dimension values, false does not use dimval.spec.

If a record contains range value properties, the default value is false. If not, the default is true.

For guidance about configuring this property, see About dimension value matching.

dimval.search_synonym

Optional. A synonym for the dimension value's display name. Synonyms provide alternative ways of describing and consequently, searching a particular dimension.

Copyright © Legal Notices