You configure the structure of hierarchical dimensions by editing
a file named
rs_baseline_dimvals.xml
. For information about recommended
ways to structure hierarchical dimensions, refer to the
Oracle Commerce Guided Search Concepts Guide.
A default version of the
rs_baseline_dimvals.xml
file is provided with the
Discover Electronics reference application in the folder
Endeca\apps\Discover\test_data\baseline
. This version is
configured to work with the test data provided with the Discover Electronics
reference application.
To configure a hierarchical dimension suitable for use with your own product data, follow these steps:
Open the default version of
rs_baseline_dimvals.xml
for editing.Note
If you move your edited version of
rs_baseline_dimvals.xml
to a folder other thanEndeca\apps\Discover\test_data\baseline
, you must specify the new folder in theload_baseline_test_data.[bat|.sh]
script.Add a
<RECORD>
subelement to the<RECORDS>
element for each dimension value that you want to add.Run
Endeca\apps\Discover\control\load_baseline_testdata.bat
to load the edited version into CAS.
The following table lists the parameters of a
<RECORD>
subelement in
rs_baseline_dimvals.xml
that configure a dimension value
in a hierarchical dimension.
Parameter |
Type |
Description |
---|---|---|
STRING |
The name of the dimension to which this dimension value belongs. | |
STRING |
A value used to tag Endeca records to
dimension values. It is also used internally to identify dimension values. The
value of
| |
STRING |
The name for this dimension value that appears in refinement lists. | |
STRING |
The In flat hierarchies, / is the only possible value because only the root dimension value can be a parent. | |
FLOAT |
(for range dimension values only) The value of the lower bound of the range. The lower bound is exclusive by default. | |
BOOLEAN |
(for range dimension values only) Set to true to include the lower bound value in the range, or to false to exclude it. | |
FLOAT |
(for range dimension values only) The numeric value of the upper bound of the range. The upper bound is exclusive by default. If you omit the dimval.range.upper_bound parameter or do not specify a value for it, the upper boundary defaults to infinity. | |
BOOLEAN |
(for range dimension values only) Set to true to include the upper bound value in the range, or to false to exclude it. | |
INTEGER |
The position in refinement lists where this dimension value appears. Lower numbers specify earlier positions. | |
BOOLEAN |
Specifies whether property matching is based
on the
| |
STRING |
A synonym for the dimension value's display name. A keyword search on the synonym will produce the same result as a keyword search on its display name. Synonyms can be applied only to leaf dimension values.
NoteA search synonym applies to search results on a particular product represented by a dimension value. Thesaurus entries, in contrast, are defined globally and are used for searches across all products. For information about thesaurus entries, refer to the Oracle Commerce Guided Search Workbench User's Guide.
|
For example, the following excerpt from
rs_baseline_dimvals.xml
defines a record that configures a range dimension
value in a hierarchical dimension named
camera.megapixel_range
:
<RECORDS> <RECORD> <PROP NAME="Endeca.Id"> <PVAL>camera.megapixel_range:Over 20</PVAL> </PROP> <PROP NAME="dimval.display_name"> <PVAL>Over 20</PVAL> </PROP> <PROP NAME="dimval.dimension_name"> <PVAL>camera.megapixel_range</PVAL> </PROP> <PROP NAME="dimval.parent_spec"> <PVAL>/</PVAL> </PROP> <PROP NAME="dimval.range.upper_bound"> <PVAL>250</PVAL> </PROP> <PROP NAME="dimval.range.upper_bound_inclusive"> <PVAL>true</PVAL> </PROP> <PROP NAME="dimval.range.lower_bound_inclusive"> <PVAL>false</PVAL> </PROP> <PROP NAME="dimval.display_order"> <PVAL>5</PVAL> </PROP> <PROP NAME="dimval.range.lower_bound"> <PVAL>20</PVAL> </PROP> <PROP NAME="dimval.spec"> <PVAL>Over 20</PVAL> </PROP> </RECORD> . . .
This record in
rs_baseline_dimvals.xml
file configures a range
dimension value in the hierarchical dimension
camera.megapixel_range
as follows:
It creates a dimension value whose Endeca ID is "
camera.megapixel_range:Over 20
":<PROP NAME="Endeca.Id"> <PVAL>camera.megapixel_range:Over 20</PVAL> </PROP>
Every
Endeca.Id
value must be unique within its record store.Note
The value of the
Endeca.ID
property is, by convention, the dimension name, followed by a colon (:) and the display name of this dimension value.It specifies that the parent of "
camera.megapixel_range:Over 20
" is the root dimension valute of the dimension:<PROP NAME="dimval.parent_spec"> <PVAL>/</PVAL> </PROP>
It identifies the name of the dimension as "
camera.megapixel_range
":<PROP NAME="dimval.dimension_name"> <PVAL>camera.megapixel_range</PVAL> </PROP>
It sets the display name of the dimension value to "
Over 20
":<PROP NAME="dimval.display_name"> <PVAL>Over 20</PVAL> </PROP>
It sets upper and lower boundaries to the range for this dimension value:
<PROP NAME="dimval.range.upper_bound"> <PVAL>250</PVAL> </PROP> <PROP NAME="dimval.range.upper_bound_inclusive"> <PVAL>true</PVAL> </PROP> <PROP NAME="dimval.range.lower_bound_inclusive"> <PVAL>false</PVAL> </PROP> . . . <PROP NAME="dimval.range.lower_bound"> <PVAL>20</PVAL> </PROP>
It specifies an ID for this dimension value; the ID must be unique within this dimension:
<PROP NAME="dimval.spec"> <PVAL>Over 20</PVAL> </PROP>
Note
For information about how
dimval.spec
is used to tag Endeca records to dimension values, see Introduction: Making Endeca records accessible to shoppers.