Skip Headers
Oracle® Secure Enterprise Search Administration API Guide
11g Release 1 (11.1.2.0.0)

E14133-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

altWord

Oracle SES uses alternate words to provide suggestions to users or to expand the search results. Alternate words are useful for correcting common typing errors and for including synonyms in a search. You can create up to four alternates for the same word.

Object Type

Creatable

Object Key

keyword altKeyword

Object Key Command Syntax

--KEYWORD=keyword --ALT_KEYWORD=altKeyword

State Properties

None

Supported Operations

create
createAll
delete
deleteAll
deleteList
export
exportAll
exportList
getAllObjectKeys
update
updateAll

Administration GUI Page

Search - Alternate Words

XML Description

The <search:altWords> element describes alternate word pairs:

<search:altWords>
   <search:altWord>
      <search:keyword>
      <search:altKeyword>
      <search:autoExpand>

Element Descriptions 

<search:altWords>

Contains one or more <search:altWord> elements.

<search:altWord>

Contains one of each of these elements:

<search:keyword>
<search:altKeyword>
<search:autoExpand>
<search:keyword>

Contains a search word or phrase. Keywords are not case sensitive. Required.

<search:altKeyword>

Contains a word or phrase that is suggested when users enter the keyword. Alternate words are displayed exactly as they appear here. Required.

<search:autoExpand>

Controls the display of alternative words in the search results: Set to true to include the alternative words automatically in the search, or set to false to display alternative word matches in a "do you mean..." message. The default is false.

Example

This XML document defines alternate words for OSES, text, and RAC:

<?xml version="1.0" encoding="UTF-8"?>
<search:config productVersion="11.1.2.0.0" xmlns:search="http://xmlns.oracle.com/search">
  <search:altWords>
    <search:altWord>
      <search:keyword>oses</search:keyword>
      <search:altKeyword>Oracle Secure Enterprise Search</search:altKeyword>
      <search:autoExpand>true</search:autoExpand>
    </search:altWord>
    <search:altWord>
      <search:keyword>rac</search:keyword>
      <search:altKeyword>Real Application Clusters</search:altKeyword>
      <search:autoExpand>false</search:autoExpand>
    </search:altWord>
    <search:altWord>
      <search:keyword>text</search:keyword>
      <search:altKeyword>Oracle Text</search:altKeyword>
      <search:autoExpand>false</search:autoExpand>
    </search:altWord>
   </search:altWords>
</search:config>