The following table describes the parameters that can apply to an attribute in index_config.json that configures a dimension (that is, an attribute that includes the parameter "jcr:primaryType" : endeca:dimension"):

Attribute Parameter

Type

Description

displayOrder

INTEGER

Specifies where this dimension appears with respect to the other dimensions in refinement lists. Dimensions with lower numbers appear before dimensions with higher numbers. The value of displayOrder can be any integer between 0 and 2147483647.

If no displayOrder value is specified, the dimension appears after dimensions with specified displayOrder values. When two or more dimensions have the same displayOrder value, or no value, the dimensions are ordered alphabetically by name.

Note that Experience Manager users can override the default order by using the Guided Navigation cartridge for specific search and navigation states. For more information, refer to the Oracle Commerce Workbench User's Guide.

isAutogen

BOOLEAN

Optional. If isAutogen = true, a dimension value is added to this dimension automatically when each source record is loaded into CAS. For information about how to configure the automatic generation of dimensions and dimension values, see Introduction: flat dimensions and hierarchical dimensions.

If isAutogen = false or is omitted, the dimension is hierarchical. In this case, dimension values are not added automatically when records are loaded into CAS. Instead, hierarchical dimensions, dimension values, and the parent-child relationships among dimension values are configured in a file named rs_baseline_dimvals.xml. For more information, see Configuring dimension values for hierarchical dimensions.

isHierarchicalDimensionSearchEnabled

BOOLEAN

Optional. When set to TRUE, a dimension search examines ancestor dimension values in this dimension. When set to false, it considers only dimension values at the lowest level of the hierarchy. The default is false.

When this parameter is set to TRUE, the common parameter isRecordSearchEnabled must also be set to TRUE.

Note

This property applies only to keyword searches and does not affect Guided Navigation.

For more information, see Hierarchical searches.

isHierarchicalRecordSearchEnabled

BOOLEAN

Optional. When set to TRUE, a record search examines records tagged to ancestor dimension values in this dimension. When set to false, it examines only records tagged to dimension values at the lowest level of the hierarchy. The default is false.

When this parameter is set to TRUE, the common parameter isRecordSearchEnabled must also be set to TRUE.

If omitted, isHierarchicalRecordSearchEnabled is set to the value of isRecordSearchEnabled.

Note

This property applies only to keyword searches and does not affect Guided Navigation.

For more information, see Hierarchical searches.

multiSelectType

STRING

Optional. This parameter determines the content of the refinements list (dimension values) or results list (records) when you select multiple dimension values in this dimension. The possible values are AND, OR, and NONE.

When AND is specified, the results list includes only those records that are tagged to all of the selected dimension values. The results list words will contain only those records that have multiple properties, each of which tags the record to a different one of the selected dimension values. Selecting additional dimension values is likely to reduce the size of the results list.

When OR is specified, the results list contains records that are tagged to any one of the selected dimension values. For this dimension, selecting additional dimension values is likely to increase the size of the results list.

When NONE is specified, only a single dimension value can be selected. Thus, after selecting your first dimension value, you would not be able to select other dimension values in this dimension.

For information about how to tag records to dimension values, see Introduction: making Endeca records accessible through Guided Navigation.

rangeComparisonType

STRING

Optional. The rangeComparisonType enumerates the types that can be used to map source properties to dimension values that represent ranges. The valid types are ALPHA, INTEGER, FLOAT, DOUBLE, and DATETIME .


Copyright © Legal Notices