Siebel Search Administration Guide > Configuring Index Mappings >

Defining Index Attributes


This topic covers defining the attribute values for the in-name attribute. Attributes are defined in name-value pairs. In the example <field bc-name="Description" in-name="keywords ui-name="Description" type="na"/>, in-name is an attribute name, and "keywords" is an optional attribute value. Table 11 lists the mandatory, recommend and optional attribute values for assigning to the in-name attribute. The in-name attribute and values are defined in the file <application_suite>_OSES_Field-Mappings.xml. The index fields are re-usable for mapping across business component fields.

Table 11. The in-name Attribute and Attribute Values
Attribute Name
Attribute Value
Description
Mandatory

in-name

accessURL

Used for mapping to the business component access URL field.

No

 

alias

Used for mapping to name fields.

No

 

author

This index field is reserved and cannot be mapped to user-defined fields. This index field maps to the business component Updated By field.

The Updated By field must also be populated in the Search Index Settings Available Fields applet in the Administration - Search UI.

Yes

 

body

Used for mapping to main content field. This field is mandatory and is used to generate search results.

Yes

 

city

Used for mapping to city name fields.

No

 

code01

Used for mapping to generic code or ID fields.

No

 

code02

Used for mapping to generic code or ID fields.

No

 

comment

Used for mapping to comment fields.

No

 

country

Used for mapping to country name fields.

No

 

createdBy

This index field is reserved and cannot be mapped to user-defined fields. This index field maps to the business component Created By field.

The Created By field must also be populated in the Search Index Settings Available Fields applet in the Administration - Search UI.

Yes

 

createdOn

This index field is reserved and cannot be mapped to user-defined fields. This index field maps to the Created business component field.

The Created field must also be populated in the Search Index Settings Available Fields applet in the Administration - Search UI.

Yes

 

csn

Used for mapping to customer ID number fields.

No

 

date01

Used for mapping to date fields.

No

 

date02

Used for mapping to date fields.

No

 

description

Used for mapping to generic descriptive fields, such as comments, FAQ or details.

Recommended

 

emailed

Used for mapping to email address fields.

No

 

faxNumber

Used for mapping to fax number fields.

No

 

firstName

Used for mapping to first name fields.

No

 

keywords

This index field corresponds to the Oracle Secure Enterprise Search Keywords search attribute, and, if configured, is used for cluster configuration. This field is recommended if automated keywords are required.

The following provides an example keywords definition for the SR Resolution Item business component:

<field bc-name="Description" in-name="Keywords" ui-name="Description" on-name="" nv-name="" one2many="" is-id="N" id-rank="" type="na"/>

This configuration ensures that the content of the SR Resolution Item Description field is mapped to the Oracle Secure Enterprise Search Keywords attribute. This definition tags the Description value as a keyword in the feed file. When Oracle Secure Enterprise Search crawls and indexes the feed file, it processes the value of the Description field as a keyword for cluster configuration and automated keywords.

For information on administering cluster configuration for automated keywords, see Administering Automated Keywords

For more information on search attributes, see Oracle Secure Enterprise Search Administrator's Guide.

Recommended

 

 

language

Used for mapping to language identifier fields.

No

 

lastModifiedDate

This index field is reserved and cannot be mapped to user-defined fields. This index field maps to the business component Updated field.

The Updated field must also be populated in the Search Index Settings Available Fields applet in the Administration - Search UI.

Yes

 

lastName

Used for mapping to last name fields.

No

 

level

Used for mapping to level fields.

No

 

listing01

Only to be used for one-to-many field mapping.

No

 

listing02

Only to be used for one-to-many field mapping.

No

 

location

Used for mapping to site, directory, or path fields.

No

 

name

Used for mapping to name fields.

No

 

orgName

Used for mapping to organization name fields.

No

 

owner

Used for mapping to Organization Information or other visibility information fields.

No

 

phoneNumber01

Used for mapping to phone number fields.

No

 

phoneNumber02

Used for mapping to phone number fields.

No

 

price

Used for mapping to price fields.

No

 

sblbctype

This index field is reserved and cannot be mapped to user-defined fields. This index field is used for mapping to the BC Name business component field, and is used to generate search results.

The BC Name field must also be populated in the Search Index Settings Available Fields applet in the Administration - Search UI.

Yes

 

sblrowid

This index field is reserved and cannot be mapped to user-defined fields. This index field is used for mapping to the business component ID field.

The ID field must also be populated in the Search Index Settings Available Fields applet in the Administration - Search UI.

Yes

 

sblvisibilityid

This index field is reserved and cannot be mapped to user-defined fields. This index field is used for mapping to the business component Organization ID, or other visibility control business component fields. The visibility ID is captured at index-time and stored in the database with the indexed records. At query-time, the User ID is sent with the search criteria and authenticated by the Oracle Secure Enterprise Search Web Service. The results are filtered based on the field's sblvisibilityid setting and the visibility setting of the group to which the user belongs.

This mapping is mandatory for access controlled business components.

See the Access Control chapter in the Siebel Security Guide for more information.

Yes

 

sblvisibilityinfo

This index field is reserved and cannot be mapped to user-defined fields. This index field is used for mapping to the business component Organization Information or other visibility information fields.

This mapping is optional, and is used for access controlled business components.

No

 

sourceHierarchy

Used for mapping to hierarchy information fields.

No

 

state

Used for mapping to geographical state fields.

No

 

status

Used for mapping to BusComp status fields.

No

 

street

Used for mapping to street address fields.

No

 

summary

Used for mapping to descriptive summary fields.

Recommended

 

textID

Used for mapping to text ID fields.

No

 

Title

Used for mapping to title information fields.

Yes

 

type

Used for mapping to record type fields.

No

 

value

Used for mapping to String value fields.

No

 

zipcode

Used for mapping to zip-code, postal-code and pin-code fields.

No

Siebel Search Administration Guide Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Legal Notices.