|
Siebel Search Administration Guide Addendum for FAST InStream > Customizing Search Objects for FAST >
Defining Custom Searchable Objects for Integration with FAST InStream
All user-defined objects which should be searchable need to be mapped to index profile fields in the <application_suite>_SSC_Field-Mappings.xml file. This topic covers the Search DTD used in <application_suite>_SSC_Field-Mappings.xml, and the rules for defining object attributes and elements, to create custom search objects. Once the new custom Business Components or fields have been defined in <application_suite>_SSC_Field-Mappings.xml, the Siebel Server needs to be restarted, and the Search Administration UI needs to be populated with the new Search Categories or Available Fields. See Administering Search Indices. Searchable Object DTD for Siebel and FAST Integration
Each searchable object definition in <application_suite>_SSC_Field-Mappings.xml can include the attributes bc-name, ip-name, nv-name, ui-name and type, and must conform to the following DTD:
<!DOCTYPE searchable-object [
<!ELEMENT searchable-object (BusComp*)>
<!ELEMENT BusComp (field+)>
<!ATTLIST BusComp
name CDATA #REQUIRED
ui-name CDATA #REQUIRED>
<!ELEMENT field EMPTY>
<!ATTLIST field
bc-name CDATA #REQUIRED
ip-name CDATA #REQUIRED
nv-name CDATA ""
ui-name CDATA #REQUIRED
type (path | filename | ext | na) "na" >
]>
FAST Field Mapping Rules for One-To-One Relationships
Each one-to-one field mapping defined in <application_suite>_SSC_Field-Mappings.xml must comply with the rules listed in Table 3. The corresponding UI fields in the Search Index Settings and Available Fields applet are also listed.
Table 3. One-To-One Field Mapping Rules for Integration with FAST InStream
|
|
bc-name |
This field attribute corresponds to the Business Component field name in Siebel Tools. The value displays in the Field Name column of the Available Fields list applet. This is a mandatory, non-empty attribute. |
ip-name |
Corresponds to the mapped field in index-profile.xml. This attribute must take one of the fields listed in Table 2. This is a mandatory non-empty attribute. |
nv-name |
This field attribute corresponds to the navigator name, if available. This field attribute is optional. |
ui-name |
Provides the (non-internationalized) name for the UI Field attribute in the Search Center view. The field name is only displayed on the application UI if the Searchable flag is checked in the Available Fields list applet. A non-empty value must be provided if the field is to be added to the body field teaser of the result set. This value defines the Display Name on the Search UI Available Fields list applet. This field attribute is optional. |
FAST Field Mapping Rules for One-To-Many Relationships
Each one-to-many field mapping defined in <Application>_Field-Mappings.xml must comply with the rules listed in Table 4. The corresponding UI fields in the Search Index Settings and Available Fields applets are also listed. Each search category can have a maximum of two 1:M fields. Each child category should be mapped to a separate index profile field.
Table 4. One-To-Many Field Mapping Rules for Integration with FAST InStream
|
|
bc-name |
This field attribute corresponds to the Business Component field name in Siebel Tools. The value displays in the Field Name column of the Available Fields list applet. This is a mandatory, non-empty attribute. |
ip-name |
This attribute is used to specify one-to-many field mappings. in-name must take the index profile field namelist or sgenlist. |
nv-name |
This field attribute must be empty for 1:M mappings. |
ui-name |
This field attribute is mandatory for 1:M mappings and must conform with to the following format: <Child Bus Comp Name>:<Child Fields><Child Reference Field>, for example, Service Request Attachment:ActivityFileSrcPath,ActivityFileName,ActivityFileExt,Activity Id.
In the above example the constituent parts are as follows: Child Bus Comp Name. Service Request Attachment. This must be the exact name defined in Siebel Tools. Child Bus Comp Name takes just one value. 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 Bus Comp linked to PAR_ROW_ID of the child table, for example Activity Id. Child Reference Field takes just one value. |
type |
The type attribute must be specified as na for 1:M mappings. This attribute corresponds to the type of information represented by the field value, for example path or filename. |
|
