1. Search Administration Guide
  2. Defining Index Elements

Defining Index Elements

Siebel Search index mapping fields are mapped to business component fields in the file SIA_OSES_Field-Mappings.xml or the file SSC_OSES_Field-Mappings.xml, to define searchable objects. The definitions in this mapping file are used to generate the XML data feed files, which Oracle Secure Enterprise Search crawls and indexes.

Once the index mappings have been defined in Application_Suite_OSES_Field-Mappings.xml, the Siebel Server must be restarted, and the Search Administration UI must be populated with the new Search Categories or Available Fields. See Administering Siebel Search Index Settings for Oracle Secure Enterprise Search.

The correct mapping file to use is determined as follows:

  • Use the file SSC_OSES_Field-Mappings.xml if you are using a Siebel application that operates across industries, such as Siebel Call Center, Siebel Sales or Siebel Marketing.

  • Use the file SIA_OSES_Field-Mappings.xml if you are using a Siebel industry application, such as Siebel Finance, Siebel Medical, or Siebel Pharma.

The following table lists the elements and attributes for defining business component index mappings.

Element Attributes Description Mandatory

BusComp

name

Name of the business component, for example:

name="Service Request Attachment"

Yes

ui-name

This is the string that will be displayed in the user interface, for example:

ui-name="SR Attachments"

Yes

on-name

This attribute is not supported.

No

url

This attribute takes the following format:


url="http://%webserver%/%objmgr%_%lang%/
start.swe?SWECmd=GotoView&SWEView=#VIEWNAME#&S
WERF=1&SWEHo=%hostName%&SWEBU=1&SWEApplet0=#AP
PLETNAME#&SWERowId0=#ROWID#"

Yes

parent

This attribute is used to specify the parent of a child business component, for example:

parent="Service Request"

No

fkey-field

This attribute is used to define a foreign key field, for example: 

fkey-field="Activity Id"

No

field

bc-name

Name of the business component field, for example:

bc-name="Attachment List"

The value displays in the Field Name column of the Available Fields list applet.

Yes

in-name

This is the index field for the business component field, for example: 

in-name="listing01"

See Defining Index Attributes for a list of required, recommended and optional in-name definitions.

Yes

ui-name

This is the string that will be displayed as the search result snippet in the user interface, for example: 

ui-name="Attachments"

This value populates the Available Fields list applet on the Siebel Search administration UI. The field name is displayed on the application UI if the Searchable flag option is selected in the Available Fields list applet.

No

on-name

This attribute is not supported.

No

nv-name

This attribute is not supported.

No

is-id

This attribute is not supported.

No

id-rank

This attribute is not supported.

No

on-name

This attribute is not supported.

No

one2many

This attribute is used for passing the business component child category information. This attribute is mandatory when you want to index a child business component, and the child business component has multiple rows associated with the parent business component. The one-to-many mapping must conform with the following format:

<Child Business Component Name>:<Child 
Fields><Child Reference Field>, for example, 
Service Request 
Attachment:ActivityFileSrcPath,ActivityFileNam
e,ActivityFileExt,Activity Id.

In this example the constituent parts are as follows:

Child Business Component Name. This must be the exact name defined in Siebel Tools. Child Business Component Name takes just one value, for example: Service Request Attachment.

Child Fields. Comma separated list of child business component fields to be indexed, for example: ActivityFileSrcPath,ActivityFileName. One or more values can be entered for Child Fields, each value must be separated by a comma.

Child Reference Field. Child Reference Field is the foreign key equivalent of the parent Business Component linked to PAR_ROW_ID of the child table, for example: Activity Id. Child Reference Field takes just one value.

Yes

type

Used to define the file type represented by the field. This attribute is mandatory for file fields. Valid values are as follows:

  • type="path"

  • type="filename"
  • type="ext"
  • type="na"

Yes