Oracle Commerce Guided Search - Why Precedence Rule Fired property format

Why Precedence Rule Fired property format

The DGraph.WhyPrecedenceRuleFired property value has a multi-part format that is made up of a list of trigger reasons and trigger values that were evaluated for each precedence rule.

The DGraph.WhyPrecedenceRuleFired property is returned as a JSON object with the following format:

[
  { "triggerReason" : "<Reason>", "triggerDimensionValues" : ["<DimensionID>, ... "], "ruleType" : "<Type>", "sourceDimension" : "<DimensionName>", 
   "sourceDimensionValue" : "<DimensionID>" },
   ...
]

The following table describes the reporting values in the DGraph.WhyPrecedenceRuleFired property. The specific reporting values depend on the precedence rules in the MDEX Engine and how many rules the MDEX Engine evaluated for the current set of available refinement dimensions.

Reporting Value	Description
<Reason>	The `triggerReason` can have any of the following values: `explicit` - The precedence rule triggered because a user explicitly selected a trigger dimension value in a navigation query. The `triggerDimensionValues` is a list of dimension IDs that triggered the rule. `explicitSelection` - The precedence rule triggered because an user explicitly selected a target dimension value, and there are more refinements available. The `triggerDimensionValues` is a list of dimension IDs that triggered the rule. `implicit` - The precedence rule triggered because a user implicitly selected a trigger dimension value. For example, it is implicit because a user could select a dimension value that resulted from a text search rather selecting a refinement from a navigation query. The `triggerDimensionValues` is a list of dimension IDs that triggered the rule. `implicitSelection` - The precedence rule triggered because a user implicitly selected a target dimension value, and there are more refinements available. `default` - The precedence rule triggered because it is a default rule that is set up to always trigger. (Forge creates default rules during automatic property mapping.)
<DimensionID>	The `triggerDimensionValues` is followed by a list of integers representing the dimension IDs.
<Type>	The `ruleType` can have any of the following values: `standard` - Standard precedence rules display the target dimension if the source dimension value or its descendants are in the navigation state. `leaf` - Leaf precedence rules display the target dimension only after leaf descendants of the source dimension value have been selected.
<DimensionName>	A string representing the name of the dimension.

The DGraph.WhyPrecedenceRuleFired property may contain any number of triggerReason reporting values. However, there is one exception in the case where the value of triggerReason is default. In that case, there would be a single triggerReason value.

Here is an example query that contains at least the following two URL query parameters: N=310002&Nx=whyprecedencerulefired. The value of 310002 is the dimension value ID that triggers a precedence rule for dimension 300000. The query produces a result with a root dimension value that contains the following DGraph.WhyPrecedenceRuleFired property:

<Dimension Id=300000 Name=Number of Digits>
        <Root>
          <DimVal Name="Number of Digits" Id=300000>
            <PropertyList Size=1>
              <Property Key="DGraph.WhyPrecedenceRuleFired" Value="[ { "triggerReason" : "explicitSelection", "triggerDimensionValues" : [310002] } ]">

Why Precedence Rule Fired property format

MDEX Engine Developer's Guide