suggLink

Suggested links direct users to a designated Web site for particular query keywords. For example, a suggested link might be http://www.oracle.com/technetwork/indexes/documentation/index.html for 'Oracle Secure Enterprise Search documentation', 'Enterprise Search documentation', and 'Search documentation'.

Object Type

Creatable

Object Key

keyword linkUrl

Object Key Command Syntax

--KEYWORD=keyword --LINK_URL=url

State Properties

None

Supported Operations

create
createAll
delete
deleteAll
deleteList
export
exportAll
exportList
getAllObjectKeys
update
updateAll

Administration GUI Page

Search - Suggested Links

XML Description

The <search:suggLinks> element describes suggested links:

<search:suggLinks>
   <search:suggLink>
      <search:keyword>
      <search:linkUrl>
      <search:linkText>

Element Descriptions

<search:suggLinks>

Contains one or more <search:suggLink> elements, each describing a suggested link.

<search:suggLink>

Describes a suggested link. It contains one of each of these child elements:

<search:keyword>
<search:linkUrl>
<search:linkText>

<search:keyword>

A word or phrase with optional operators that identifies which search queries display this suggested link. (Required)

Do not enter special characters, such as #, $, =, &). You can include the following operators:

Operation	Syntax	Example
about	`ABOUT(term)`	about(dogs)
and	`term` `AND` `term`	dog and cat
near	`term` ;`term`	dog ; cat
or	`term` `OR` `term`	dog or cat
phrase	`phrase`	dog sled
stem	`$term`	$dog
thesaurus	`{BT \| NT \| SYN`}(`term`)	SYN(dog)
within	`term` `WITHIN` `term`	dog within title

<search:linkUrl>

A link to the suggested page, which appears in the result list., such as http://www.example.com. (Required)

<search:linkText>

The linked text that appears in the result list, such as Example Corp. (Required)

Example

This XML document describes a suggested link for a query on the term "oracle":

<search:config productVersion="11.2.1.0.0" xmlns:search="http://xmlns.oracle.com/search">
  <search:suggLinks>
    <search:suggLink>
      <search:keyword>oracle</search:keyword>
      <search:linkUrl>http://www.oracle.com</search:linkUrl>
      <search:linkText>Oracle</search:linkText>
    </search:suggLink>
  </search:suggLinks>
</search:config>