Enabling snippeting

You enable snippeting globally for the Oracle Endeca Server via the RECSEARCH_CONFIG configuration document.

The Oracle Endeca Server has several configuration documents that configure some features. You can edit them using the format specified in the Dgraph Configuration Reference appendix in this guide. After these documents are edited, you can send them to the Oracle Endeca Server using the Configuration Web Service or Integrator ETL.

The RECSEARCH_CONFIG document allows inclusion of SEARCH_INTERFACE, which in turn lets you specify the snippet size for each of its members. The following example shows the syntax:
<RECSEARCH_CONFIG>
   <SEARCH_INTERFACE NAME="MySearch">
     <MEMBER_NAME SNIPPET_SIZE="12">Description</MEMBER_NAME>
   </SEARCH_INTERFACE>
</RECSEARCH_CONFIG>

The presence of the SNIPPET_SIZE attribute enables snippeting for the MEMBER_NAME attribute, and the value of SNIPPET_SIZE specifies the maximum number of words a snippet can contain. Omitting this attribute or setting its value to zero disables snippeting.

Each member of a search interface is enabled and configured separately. In other words, snippeting results are enabled and configured for each member of a search interface and not for all members of a single search interface.

Note: A search interface member is an attribute that has been enabled for search and that has been added to the SEARCH_INTERFACE element.

You can enable and configure any number of individual search interface members. Each member that you enable produces its own snippet. Enabling a member in one search interface does not affect that member if it appears in other search interfaces. For example, enabling the Description attribute for Search Interface A does not affect the Description attribute in Search Interface B.

To enable snippeting:

  1. In any text editor, edit the RECSEARCH_CONFIG document, similar to the following example:
    <RECSEARCH_CONFIG>
      <SEARCH_INTERFACE NAME="MySearch">
        <MEMBER_NAME SNIPPET_SIZE="10">Description</MEMBER_NAME> 
      </SEARCH_INTERFACE>
    </RECSEARCH_CONFIG>

    In this example, the snippet size is set to 10 for an attribute "Description".

  2. Use the Configuration Web Service or Integrator ETL to send the RECSEARCH_CONFIG document to the data domain in the Oracle Endeca Server.

    For information on the Configuration Web Service, see the section in this guide, or the Oracle Endeca API References. For information on Integrator ETL, see the Oracle Endeca Information Discovery Integrator ETL User's Guide.