Increasing the number of refinements to be displayed

The number of refinements that are displayed defaults to 10. If this number is not sufficient, you can increase it using NavigationMenuConfig in the Conversation Web Service request.

Generally, when the request from the Conversation Web Service asks for attributes to return in response to a query, it asks for all of them that were requested with a RefinementGroupConfig element.

To provide a meaningful navigation experience, Endeca Server returns only those attributes that actually have refinements on them and that are not filtered by precedence rules. In other words, the attributes are returned based on the navigation state.

For the request to return refinements if they are present in the data set, the Expose attribute should be set to true in the RefinementConfig. Its default value is false.

The Conversation Web Service uses the following logic to identify the number of refinements to be displayed:

The number of refinements that are displayed defaults to 10. If this number is not sufficient, you can increase it using NavigationMenuConfig in the Conversation Web Service request. You can override it in a global setting or per each refinement value, which are both optional and are not specified by default:
- The global configuration setting controls this number for all attributes in a particular navigation menu. You specify it in the MaximumRefinementCount attribute of the RefinementConfig element. The setting is per content element, not per query.
- Further, the setting per each refinement value controls the number returned for each attribute. You specify it in the attribute MaximumCount in the RefinementConfig element.

For example, in this configuration for the navigation menu, MaximumRefinementCount is set to 15. In addition, for the WineType refinement value, MaximumCount is set to 40. MaximumCount is not set in each of the other refinement values.

<NavigationMenuConfig Id="NavigationMenu" MaximumRefinementCount="15">
   <RefinementGroupConfig Name="WineCharacteristics" Expose="true">
     <RefinementConfig Name="WineType" Spec="/" MaximumCount="40"/>
     <RefinementConfig Name="Year"/>
     <RefinementConfig Name="Score"/>
   </RefinementGroupConfig>
</NavigationMenuConfig>

This request returns up to 40 refinement values for WineType. It returns up to 15 refinement values for each of the other two refinement values (Year and Score).

The attribute HasMore (with possible Boolean values true or false) in the response specifies whether the total refinement count exceeds the value returned with the MaximumRefinementCount.

The following example shows a response where the HasMore attribute is set to true in the NavigationMenuItem type of the Conversation Web Service response:

<cs:Results xmlns:cs="http://www.endeca.com/MDEX/conversation/3/0" 
    xmlns:mdex="http://www.endeca.com/MDEX/XQuery/2009/09">
  <State xmlns="http://www.endeca.com/MDEX/conversation/3/0">
  <cs:NavigationMenu" Id="NavigationMenu">
    <cs:NavigationMenuItemGroup Name="WineCharacteristics" HasRefinablePRoperties="true">
      <cs:NavigationMenuItem Name="WineType" DisplayName="Wine Type" MultiSelect="Or" HasMore="true">
         <cs:ExposureControl Exposed="true"/>
         <cs:Refinement Name="WineType" Spec="Red" Label="Red" Count="31021"/>
         <cs:Refinement Name="WineType" Spec="White" Label="White" Count="23031"/>
         <cs:Refinement Name="WineType" Spec="Sparkling" Label="Sparkling" Count="3020"/>
         <cs:RootDimensionValue DimensionName="WineType" Spec="/"/>
         <cs:FullPath>
           <cs:DimensionValue DimensionName="WineType" Spec="/">WineType</cs:DimensionValue>
         </cs:FullPath>
      </cs:NavigationMenuItem>
    </cs:NavigationMenuItemGroup>
  </cs:NavigationMenu>
</cs:Results>