Retrieving breadcrumbs in a search query

Breadcrumbs returned by the Conversation Web Service in response to a search query can reflect spelling correction and DYM (Did You Mean) information.

The following requirements must be met to implement breadcrumbs that also return spelling correction and DYM information in response to a search query:
  • The spelling must be enabled in the data store. To enable spelling, after you install the Oracle Endeca Server and create a data store, run the admin?op=updateaspell command.
  • The request must include the ContentElementConfig element for the BreadcrumbHandler. This ensures that breadcrumbs are returned:
    <ContentElementConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:type="BreadcrumbConfig"
      ReturnFullPath="false"
      HandlerFunction="BreadcrumbHandler"
      HandlerNamespace="http://www.endeca.com/MDEX/conversation/1/0"
      Id="Breadcrumbs" />
  • If you would like to return DYM and spelling correction results with breadcrumbs, the request must include the ContentElementConfig element for the SearchAdjustmentHandler:
    <ContentElementConfig 
      xmlns="http://www.endeca.com/MDEX/conversation/1/0"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:type="SearchAdjustmentConfig"
      HandlerFunction="SearchAdjustmentHandler"
      HandlerNamespace="http://www.endeca.com/MDEX/conversation/1/0"
      Id="SearchAdjustments" />

In the response, breadcrumbs are returned in the order in which they were added.