Oracle Commerce Guided Search - Drc (Refinement Configuration for Dimension Search)

Drc (Refinement Configuration for Dimension Search)

The Drc parameter sets refinement configuration options for a dimension search query.

Note

The Drc parameter is not supported with compound dimension search.

Parameter

Drc

Name

Refinement Configuration for Dimension Search

Java setter method

ENEQuery.setDimSearchRefinementConfigs()

.NET setter property

ENEQuery.DimSearchRefinementConfigs

Type

<string>+<string>+<string>...

Description

Sets one or more dynamic refinement configurations for a dimension search query. Each refinement configuration option is delimited by the pipe character.

The configuration settings are:

id specifies a dimension value ID for the numresults, showcounts, and synonyms options. The id setting is not valid with maxdepth or includeinert.
numresults specifies the maximum number of dimension values to return for a specified id. Valid values are integers greater than or equal to zero. If an id setting is omitted, then the numresults setting applies to all dimensions as a global setting.
showcounts indicates whether to show the number of refinement counts for a specified id. Valid values are true to return counts and false to not return counts. If you omit an id setting, then the showcounts setting applies to all dimension values (a global setting).
synonyms indicates whether to show synonyms for a dimension value's refinements. Valid values are true to show synonyms and false to not show synonyms. If you omit id setting, then the synonyms setting applies to all dimension values (a global setting).
maxdepth indicates the maximum depth of dimension values to return. Valid values are 0 and 1. Specifying 0 returns either the root dimension value or values specified in with the Di parameter. Specifying 1 returns the root dimension value and the next level of the dimension hierarchy. If you omit maxdepth, all dimension values are returned by default (This is same as unlimited depth.) The maxdepth setting is a global setting for Drc; it cannot be restricted with the id setting.
includeinert indicates whether to return dimension values that are inert. Valid values are true which returns inert dimension values and false which does not. The default is false. The includeinert setting is a global setting for Drc; it cannot be restricted with the id setting.

Object

DimensionSearchResult

Dependency

D

Example 151. Examples

This example shows refinement counts for dimension values 134711 and 132830.

/controller.php?D=1*&Drc=id+134711+showcounts+true|id+132830+showcounts+false

This example shows refinement counts for all dimension values except dimension value 600000.

/controller.php?D=1*&Drc=showcounts+true|id+600000+showcounts+false

This example returns up to 10 dimension values per dimension for all dimension values except 600000 which returns up to 15 dimension values.

/controller.php?D=1*&Drc=numresults+10|id+600000+numresults+15

This example returns the synonyms for a dimension value with an id of 700000.

/controller.php?D=*&Di=700000&Drc=id+700000+synonyms+true

This example returns dimension values to a maximum depth of 1 for three dimensions indicated with the Di parameter.

/controller.php?D=*&Di=500000+400000+300000&Drc=maxdepth+1

Drc (Refinement Configuration for Dimension Search)

Note

MDEX Engine Developer's Guide