---

searchAttr

Search attributes are attributes exposed to the search user. Oracle Secure Enterprise Search (SES) provides system-defined attributes, such as author and description, and enables administrators to create custom attributes.

When the indexed documents contain metadata, such as author and date information, you can let users refine their searches based on this information. For example, users can search for all documents by a particular author, that is, where the author attribute has a particular value.

Oracle Secure Enterprise Search has several default search attributes. They can be incorporated in search applications for a more detailed search and richer presentation. If an attribute List of Values (LOV) is available, then the crawler registers the LOV definition, which includes attribute value, attribute value display name, and its translation.

You can create, delete, and update custom attributes, and update the default attributes.

Object Type

Creatable

Object Key

name

Object Key Command Syntax

--NAME=object_name

-n object_name

State Properties

None

Supported Operations

create
createAll
delete
deleteAll
deleteList
export
exportAll
exportList
getAllObjectKeys
update
updateAll

Administration GUI Pages

Global Settings - Search Attributes
Global Settings - Search Attributes - Manage LOVs for Attribute
Global Settings - Translate Search Attribute Name
Global Settings - Translate LOV Display Name

XML Description

The <search:Attrs> element describes search attributes:

<search:searchAttrs>
   <search:searchAttr>
      <search:name>
      <search:type>
      <search:translations>
      <search:lovEntries>
         <search:lovEntry>>
            <search:lovValue>
            <search:sourceName>
            <search:translations>

Element Descriptions 

<search:searchAttrs>

Contains one or more <search:searchAttr> elements.

<search:searchAttr>

Describes a search attribute. It contains these elements:

<search:name>
<search:type>
<search:translations>
<search:lovEntries>

<search:name>

Name of the search attribute. (Required)

<search:type>

Data type of the attribute values. Set to STRING, NUMBER, or DATE. (Required)

<search:translations>

Contains translations of the object name for display. See "Providing Translations of Object Names".

<search:lovEntries>

Contains one or more <search:lovEntry> elements, each describing a list of values (LOV).

<search:lovValue>
<search:sourceName>
<search:translations>

<search:lovEntry>

Describes a list of values. It contains these child elements:

<search:lovValue>
<search:sourceName>
<search:translations>

<search:lovValue>

Name of the list of values. (Required)

<search:sourceName>

Name of the source for a source-specific list of values.

Example

This XML document describes a search attribute named Copyright:

<?xml version="1.0" encoding="UTF-8"?>
<search:config productVersion="11.2.1.0.0" xmlns:search="http://xmlns.oracle.com/search">
  <search:searchAttrs>
     <search:searchAttr>
         <search:name>Copyright</search:name>
         <search:type>DATE</search:type>
      </search:searchAttr>
   </search:searchAttrs>
</search:config>