3Configuring Siebel Find

Configuring Siebel Find

This chapter describes how to configure Siebel Find objects and Find functionally. It includes the following topics:

• About Siebel Tools Configuration Tasks

• About Siebel Tools Find Objects

• Configuring Searchable Find Categories

• Configuring Find Parameters for Computer Telephony Integration

• Configuring Siebel Find for the Search Results View

• Displaying System Fields in Find Results

• Configuring Access Control for Find Operations

• Integrating Siebel Search With Siebel Applications

• Siebel Tools Find Object Reference

This chapter assumes knowledge of Siebel Tools. For more information, see Using Siebel Tools.

About Siebel Tools Configuration Tasks

Siebel Tools is a declarative software development tool that allows you to configure the underlying data and data presentation of your Siebel application without making changes to the program source code. Siebel Business Applications provide a core set of search object definitions that you can use as a basis for your tailored application. There are no source code modifications, nor modifications to schema. Siebel Tools uses the Siebel Runtime Repository configuration provided by Oracle.

About Siebel Tools Find Objects

Your Siebel application contains a list of application-specific Find objects. Users have access to the Find objects that are associated to the application being used, depending on their responsibilities. You can also specify a default Find object for your Siebel application. Find objects identify business components and corresponding fields that can be searched. Global Find items are used to perform find operations on particular business components. Following execution of a Find, the Find Results view in the main window lists records from the application that satisfy the Find criteria.

Note: Customizing Siebel Find using virtual business components (VBCs) is not supported.

Configuring Searchable Find Categories

This topic covers the activation of Find objects to display as searchable Find categories in the Search Center Look In list.

To configure searchable Find categories

1. Log in to Siebel Tools.

2. Select the application for which Find categories are to be configured in the Application Object Explorer.

3. Navigate to Application Find in the Object Explorer and activate the Find Objects that you want to display as searchable Find categories in the Search Toolbar.

4. Make sure that the relevant Business Components are part of the Search Execution Business Object.

5. Update the repository and deliver the updates.

   Note: Changes made to the Application Find object in Siebel Tools are automatically reflected in the UI.

Configuring Find Parameters for Computer Telephony Integration

This topic covers configuring event response parameters for Find to enable CTI (Computer Telephony Integration) functionality in the Siebel Search Center. OnInboundCallReceived event response, to automatically launch the Search Center with pre-populated search criteria, when an agent accepts a call on the CTI toolbar.

Siebel CTI provides voice-channel support for call center agents using Siebel Business Applications. Agents are notified of incoming calls through the communications toolbar, and can perform a range of call-handling activities using the toolbar and related menu commands. If the CTI Find parameters are defined for the OnInboundCallReceived Event Response, and if QuerySpec does not return any records, then the Search Center is automatically launched when the agent accepts a call. The Search Center is automatically pre-populated with the criteria specified in the Find Event Response parameters. For more information on configuring Siebel CTI, see Siebel CTI Administration Guide

To configure Find and Computer Telephony Integration for the Siebel Search Center

1. Navigate to Site Map, Administration - Communications screen, then the All Configurations view.

2. Select the Configuration for which you want to define the Event Response.

3. Select the Event Handlers tab.

4. Select the OnInboundCallReceived Event Response.

5. Click the Event Response Parameters tab and configure the Find parameters. Some fields are described in the following table.

Field	Sample Value	Description
FindDialog	Service Request	Find object name to determine what Find Category is displayed in the Look In field when the Search Center is launched. The Find object name must match that defined in the Find column of the Application Find view in Siebel Tools for the Siebel application that you are using, for example, set this to the Service Request business component.
FindField.<Display Name>	{ANI}	The FindField.<Display Name> Event Response Parameter is used to dynamically pre-populate Find fields in the Search Center. The Display Name must match that defined in Siebel Tools. The following sample FindField.<Display Name> Event Response Parameters are used to define pre-populated field values for the Service Requests Find Category: FindField.CSN. Set this field value to {ANI} to pre-populate the Service Request CSN (Customer Service Number) field with the incoming telephone number. At runtime, on answering a call from the CTI toolbar, the Find CSN field in the Search Center is pre-populated with the telephone number of the incoming call. FindField.First Name. Set this field value to {@UserName} to pre-populate the Service Request First Name field with the agent’s User Name. At runtime, on answering a call from the CTI toolbar, the Find First Name field in the Search Center is pre-populated with the agent’s User Name for the Siebel application.

Configuring Siebel Find for the Search Results View

Siebel Find is installed, activated, and configured by default in Siebel business applications. However to enable or disable Siebel Find so that it appears or is hidden in the Search Results view, to enable or disable auto suggest for Siebel Find, or to change the position of the Siebel Find tab in the Search Results view, then complete the steps in the following procedure.

Note: The search engine settings for Siebel Find are configured in the Administration - Search screen, Search Engine Settings view. For information about the different search engine settings that you can set for Oracle Secure Enterprise Search and third-party search engines in general, see Configuring Search Engine Settings for Oracle Secure Enterprise Search and Configuring Siebel Search for Third-Party Search Engines.

Search results are displayed in the Search Results view. In the Search Results view, when you drill down on a record to see the detailed record information, the search results are retained. This mode of display is known as Results Retention Mode. Preview and Attach features are available in Results Retention Mode

To configure Siebel Find for the Search Results view

1. Navigate to the Administration - Search screen, then the Search Engine Settings view.

2. In the Search Engine applet, go to the Siebel Find record and modify the values for the record as shown in the following table.

   Field	Description	Value
   Engine Name	Name of the search engine, which appears as the tab display name in the Search Results view.	Siebel Find Note: Siebel Find is the default display name but you can modify this as required.
   Search Adapter	Name of the search adapter, which maps to the search engine configured.	Siebel Find Adapter Service
   Sequence Number	Indicates the position where the the Siebel Find tab will appear in the Search Results view. For example, 1 indicates the first position and so on.	1
   Active	Indicates whether to show (Y) or hide (N) the Siebel Find tab in the Search Results view.	Y
   Auto Suggest Supported	Indicates whether to enable (Y) or disable (N) the auto suggest feature for Siebel Find.	Y

3. In the Driver Parameters applet, configure the driver parameters for Siebel Find as shown in the following table.

   Name	Description	Default Value
   Default Categories	If no category is specified for a search, then Siebel Find searches categories according to the value in this parameter setting.	All Note: All means to search all categories.

Displaying System Fields in Find Results

This topic covers exposing system fields in the Find Results view. For more information on system fields and system columns, see Configuring Siebel Business Applications.

Note that for third-party search engines, the data displayed in the Find Results view is as follows and you cannot modify the data:

• Result title, which is in the following format: Category Name - Matched Field Name - Matched Field Value.

• Result fields, which appear when you click the arrow beside a result to show a summary of the search result. The result fields include all the indexed fields, but system fields such as RowID, Created on, and Created By are not included.

Displaying the ID System Field in Find Results

This topic provides an example of exposing a system field that already exists in the Field picklist, such as the ID system field. The ID system field represents the ROW_ID column in the base table. This example uses the Accounts business component.

To display the ID system field in the Find Results view

1. Log in to Siebel Tools.

2. Select Find in the Object Explorer.

3. Query for Account.

4. In the Object Explorer, navigate to the Find Field object.

5. Right-click on the Find Field object and create a new record with the following details:

   • Display Name = ID

   • Field = Row ID

   • Display In Results = TRUE

6. Update the repository and deliver the updates.

Displaying the Created System Field in Find Results

This topic provides an example of exposing a system field that does not already exists in the Field picklist, such as the Created system field. An alias field must be created for the system field, such as Date Created. For information on which column name to use for each system field, see Configuring Siebel Business Applications. This example uses the Accounts business component.

To display the Created system field in the Find Results view

1. Log in to Siebel Tools.

2. Select Business Component in the Object Explorer.

3. Query for Account.

4. In the Object Explorer, navigate to the Field object.

5. Right-click on the Find field and create a new record with the following details:

   • Column = CREATED

   • Name = Date Created

6. Select Find in the Object Explorer.

7. Query for Account.

8. In the Object Explorer, navigate to the Find Field object.

9. Right-click on the Find Field object and create a new record with the following details:

   • Display Name = Created

   • Field = Create Date

   • Display In Results = TRUE

10. Update the repository and deliver the updates.

Configuring Access Control for Find Operations

Access control for Find is accomplished through specifying views for a Find object. For example, you can define All Accounts across Organizations as a Find View for an Account Find object. Within Siebel Search, visibility determines the set of records displayed to the user from specific business components in the Find Results view. The user’s access to records is determined through a combination of user position, Siebel Tools object attributes, and record values. The following visibility modes can be applied for Find operations within Siebel Business Applications:

• All Organizations view. The user has access to all records.

• All view. User has access to all records in his or her own organization.

• Team view. User has access to records in his or her team.

• My view. User has access only to his or her own records.

For more information on each visibility mode, and on setting up visibility within your Siebel application, see Siebel Security Guide.

Integrating Siebel Search With Siebel Applications

Siebel Search is enabled by default for most Siebel applications. You can search or query for records in your Siebel application provided that a search control has been configured in Siebel Tools for the specific view or applet in question. If you do not see a search toolbar or text box when you navigate to a view or applet in your Siebel application, then a search control has not been configured in Siebel Tools for that particular view or applet.

You can customize Siebel Search to suit your own business needs. The following procedure shows you how to integrate Siebel Search in to an application.

To integrate Siebel Search in to an application

1. Log in to Siebel Tools and do the following:

   1. Go to the Application object and make a note of the Container Web Page.

      The Container Web Page specifies the Web page object definitions that Siebel CRM uses to display the elements that surround a Siebel view. This page contains typical user interface elements, such as viewbars, screenbars, logos, search control, and so on.

   2. Go to the Web Page object and search for the Container Web Page that you noted in Step a.

      • Expand the Web Page object and then add a new Web Page Item entry with the values shown in the following table:

        Field Name	Value
        Name	Search Results Pane Applet
        Type	Applet
        Item Identifier	10,000

      • Drill down into the Web Page Item that you added in the previous step and then add a new Web Page Item Parameter with the values shown in the following table:

        Field Name	Value
        Name	Mode
        Value	Edit List

      • Make a note of the Web Template for the current Web Page.

   3. Go to the Web Template object in Siebel Tools and search for the Web Template for the current Web page that you noted in the previous step.

      In the definition for that Web Template, add the following piece of code:

      <!-- SEARCH TOOLBAR START -->
      <div class="siebui-banner-btn siebui-srch-banner-btn" title="Search Button">
          <div id="s_srch_new" class="siebui-search-esearch bannerDiv 
      ToolbarButton">
              <div id="srch_icon_new" class="ui-menubar siebui-search-tb-btn siebui-
      icon-search" title="Search" role="text"><span></span></div>
          </div>
      </div>
      <div id="searchtoolbar" class="siebui-banner-btn siebui-search-bar" 
      title="Search Toolbar">
          <div id="searchtoolbaroption" class="siebui-search-option">
              <button class="siebui-search-toolbar-options siebui-closed" 
      id="srch_toolbar_option">
              </button>
              <ul class="ui-menu ui-widget ui-widget-content siebui-search-dropdown-
      menu-hide" role="menubar" tabindex="0">
                  <li id="srch_settings" class="siebui-appmenu-item ui-menu-item"><a 
      href="c_Feed_File_Example_vp203175.ditac_Feed_File_Example_vp203175.dita" class="ui-state-disabled"></a></li>
                  <li id="srch_adv_find" class="siebui-appmenu-item ui-menu-item"><a 
      href="c_Feed_File_Example_vp203175.ditac_Feed_File_Example_vp203175.dita" class="ui-state-disabled"></a></li>
                  <li id="srch_adv_search" class="siebui-appmenu-item ui-menu-item"><a 
      href="c_Feed_File_Example_vp203175.ditac_Feed_File_Example_vp203175.dita" class="ui-state-disabled"></a></li>
                  <li id="srch_barcode" class="siebui-appmenu-item ui-menu-item"><a 
      href="c_Feed_File_Example_vp203175.ditac_Feed_File_Example_vp203175.dita"></a></li>
              </ul>
          </div>
          <div id="searchtoolbarsrch" class="siebui-search-text">
              <input type="text" id="srch_toolbar_text_box" class="siebui-search-
      toolbar-textbox"/>
          </div>
      </div>
      <!-- SEARCH TOOLBAR END -->
      

2. Log in to your Siebel application and modify the manifest as follows:

   Note: If your application uses a custom Web Page presentation model or physical renderer, then manifest changes are not required so skip this step and proceed to Step 3.

   1. Navigate to the Administration - Application screen, then the Manifest Administration view.

   2. Query for the following:

      Field Name	Value
      Type	Web Page
      Name	Container Web Page

   3. Activate the Web Page entries (if not already activated).

   4. Select Physical Renderer in the Usage Type field, click Navigate to Files, and then do the following:

      • Inactivate the following existing Name entry: Name = ‘siebel/webpgpr.js’

      • Associate a new file with Name as follows: Name = ‘siebel/searchrenderer.js'

   5. Select Presentation Model in the Usage Type field, click Navigate to Files, and then do the following:

      • Delete the following existing Name entry: Name = ‘siebel/webpgpm.js’

      • Associate a new file with Name as follows: Name = ‘siebel/searchmodel.js '

3. If using a customized Web Page presentation model or physical renderer, then make sure that your application inherits the following searchmodel and searchrenderer to enable the search functionality in the Web Page presentation model and physical renderer:

   Note: This step is required only if your application uses a custom Web Page presentation model or physical renderer. All customized Web Page presentation model and physical renderer is inherited from the Search presentation model and physical renderer.

   • The Presentation Model (siebel/searchmodel) inherits siebel/webpgpm

     Sample code for the custom presentation model is as follows:

     if (typeof (SiebelAppFacade.ShoppingCartWebPagePM) === "undefined") {
         SiebelJS.Namespace('SiebelAppFacade.ShoppingCartWebPagePM');
         define("siebel/shoppingcartwebpagepm", ["siebel/searchmodel.js"], function () {
     

   • The Physical Renderer (siebel/searchrenderer) inherits siebel/webpgpr

     Sample code for the custom physical renderer is as follows:

     if (typeof (SiebelAppFacade.ShoppingCartWebPagePR) === "undefined") {
         SiebelJS.Namespace('SiebelAppFacade.ShoppingCartWebPagePR');
         define("siebel/shoppingcartwebpagepr", ["siebel/searchrenderer.js"], function () {

Siebel Tools Find Object Reference

This topic contains reference information on Find Objects contained in your Siebel application. These include the following:

• Find Object

• Application Find Object

• Find Field Object

• Find View Object

• Find Field Locale Object

• Find Locale Object

• Find Pick View Object

Find Object

A Find object definition creates a searchable Find Category that can be added to the Search Center Look In list, and a corresponding set of Find fields and possible views. The Find fields and find views are implemented as child object definitions of the Find object. Predefined Find objects are provided for each Siebel application.

Find Object Properties

The following table lists the Find object properties.

Property	Required	Description
Applet	Required	The applet that will be used by the Find object. It is required that the applet defined be on every one of the views defined in the Find views for the Find operation to work properly. When configuring the Find object, the choices you have for selecting come from the business component on the applet.
Destination Field	Optional	A TRUE or FALSE value, which if TRUE, highlights this Find object definition in the Search Center list. This property applies only to the initial find operation in the application.
Display Name	Optional	The name that will be displayed to the user, such as Accounts.
Drilldown View	Optional	The view that appears when the user drills down. If this property is not set (has no value), then the view is taken from the Find View records. If a Drilldown View is not specified, the view in the Find Views that the user has access to will be used. You cannot disable the drilldown on find objects.
Name	Required	The name of the Find object definition. This is referenced when setting up Application Find object definitions that use this Find object definition.
Preview	Optional	The view that appears when a user invokes the Preview button. This feature allows the user to preview a result record in a pop-up window.

Application Find Object

An application Find object definition associates one Find object definition with one application. Application Find is a child object type of Application. The name of the Find object definition appears in the Find property in the Application Find object definition. Each application has multiple Find objects defined as Find Categories in the Search Center Look In list, each one included by virtue of an Application Find object definition. You can also specify a default find in the Object Properties list.

Application Find Object Properties

The following table lists the Application Find object properties.

Property	Required	Description
Default Find	Optional	Valid values for the Application Find Default Find object are TRUE or FALSE. Setting this value to TRUE allows you to set the default Find object for your application. The default find object is defined in the Application Default Find property. For information on the Application Default Find property, see Siebel Object Types Reference. The default Find object displays as the default Find category in the Search Center Look In list.
Find	Required	The Find object definition to include in the application. Example values include Contact and Account.
Name	Required	It is the same as the Find property.
Sequence	Required	The order in which the Find Category appears in the Search Center Look In list. This property takes an Integer value.
Text	Required	The translatable text that appears as the title of the Find dialog box.

Find Field Object

The Find Field is a child object type of Find. A Find Field object definition adds a find field to its parent Find object definition. The find field appears as a text box in the Search Center when the parent Find is active. Each child Find Field object definition provides the parent Find with a find value text box and corresponding Find field name to search.

Find Field Object Properties

The following table lists the Find Field object properties.

Property	Required	Description
Display Name	Optional	The text (or key to localized text) that will be displayed for this find field when its parent Find object definition is active in the Search Center window.
Field	Required	The field being searched in the business component.
Name	Required	Name of the search field added.
Sequence	Optional	The position of this find field in the list of fields displayed in the Search Center-Find category for the parent Find object definition.
Display in Results	Optional	Selecting this option allows the field to be displayed on the find results applet in the Search Center. By default, the whole field value will be displayed, but you can set a limit so that characters after the maximum length will be skipped. An ellipsis (...) is appended to the end of the results when a limit is set. You must use the user property in Find Results List Applet to set the length limit. Use the following applet user properties: User Property Name: [Find object Name] User Property Value: [Find Field] = [Length] If there is more than one, use the following applet user property syntax: User Property Value: [Find Field Name] = [Length], [Find Field Name] = [Length], [Find Field Name] = [Length]...
Display in Entry	Optional	Selecting this option allows the field to be displayed on the find entry applet in the Search Center.

Find Field Object Rules and Assumptions

• Boolean operators are not supported when searching on a Find object.

• The field specified in a find field must be a field that exists in the business component for the applet for the Find object definition.

• The Search Center-Find category and a query by example (QBE) can have different behavior for multi value fields, because the Search Center will generate the same query as if you did an EXISTS query on the field in QBE. You can verify this by embedding your QBE expression with Exists(), for example, (Ada*).

• QBE supports both types of querying, but to keep the Search Center simple, Siebel Business Applications implement a query that works in all cases. This query uses the syntax Ada* (where the wildcard, as indicated by an asterisk (*) is appended to the search text). If you want to mimic the behavior of the nonExists version with the Search Center-Find category, you must create a join from the primary ID field for the MVLink to the table containing the data. Then add a field to the table you joined to, and point your find field to this new field. This configuration change will cause the query to do a query on the join field that does not use EXISTS.

• If you want to do an exact search in a Find field, prefix the search text with an equal sign (=), for example, = Ada. The query uses the syntax = Ada. (No wildcard is appended to the text.)

• Do not configure the State field as a Find Field for a Find object.

  For example, if the Accounts Find object configuration in Siebel Tools includes the State Find Field, then the State field appears as an option (in the Accounts Find object menu) in the UI. In such a case, do the following in Siebel Tools to remove the State field from the Accounts Find object menu:

  • Deactivate the Find Field, then update the repository and deliver the update.

  • Disable the State field for the required language.

  • Disable the State Find Field for the Accounts Find Object.

Find View Object

Each Find view object definition specifies a view that can be activated when the parent Find is initiated from the Search Center. Each find view specifies a different visibility level for the same business component. The views are acted upon in a fixed order, as specified in the Sequence property of the Find view object, until a view is encountered in which the user can view data. The visibility for this view is then applied to the results from the query on the Find object.

For a given user, the find operation uses the first find view object definition that is in the user’s responsibility list. Because different views apply different visibility, you have the least restrictive views, first in the list, and the most restrictive, last. This order allows users with different responsibilities to find items using the most broad visibility that they have access to use.

Find View Object Properties

The following table lists the Find View object properties.

Property	Required	Description
Sequence	Optional	The order that views are used for the Find object definition.
View	Required	The name of the view to be used for the find operation when this find view is used.

Find Field Locale Object

Locale objects are children of Find Field objects and contain all translatable information. Locale objects represent language-specific overrides used with the Find Field object type.

Find Field Locale Object Properties

The following table lists the Find Field Locale object properties.

Property	Required	Description
Display Name	Optional	The text or that will be displayed for this find field when its parent Find object definition is active in the Search Center.
Name	Required	The abbreviation of the language being used. For example, the value ENU is used to denote U.S. English.

Find Locale Object

Find Locale objects are children of UI objects and contain all translatable information. They represent the language-specific overrides, used with the Find object type.

Find Locale Object Properties

The following table lists the Find Locale object properties.

Property	Required	Description
Display Name	Optional	Description on the Find Locale object property.
Name	Required	The abbreviation of the language. For example, the value ENU is used to denote U.S. English.

Find Pick View Object

Users can associate find results from the Search Center with the active record in the main content area. The Pick View object, located under Find Pick View, identifies the applet that can receive the selected item from the Find Results List as an associated record. This applies only to applets that can handle such associations.

Find Pick View Object Properties

The following table lists the Find Pick View object properties.

Property	Required	Description
Applet Name	Required	Name of the applet
View Name	Required	Name of the view containing the applet
Name	Required	Logical name of the pick view
Field Name	Optional	Name of the multivalue group field that will receive the search result