1. Search Administration Guide
  2. What’s New in This Release

4Configuring Siebel Search for Third-Party Search Engines

Configuring Siebel Search for Third-Party Search Engines

This chapter describes how to configure Siebel Search for third-party search engines. It includes the topic: Process of Configuring Siebel Search for Third-Party Search Engines.

Process of Configuring Siebel Search for Third-Party Search Engines

Siebel Search can work with any third-party search engine, provided that the third-party search engine has a Web service endpoint. If the third-party search engine has a Web service endpoint, then Siebel Search can do the following:

  • Send indexing and search requests to the Web service endpoint.

  • Receive responses and display the responses in the Siebel application’s Search Results view.

To set up third-party search engines for integration with Siebel Search, perform the following tasks. Note that the third-party Elastic Search Engine is used as an example in the tasks in this process.

  • Write a Web service for your Search Engine and host it on a Web server.

    For more information about writing a Web service for a search engine, see 2128418.1 (Article ID) on My Oracle Support.

    Configuring Siebel Search for Third-Party Search Engines

    Configuring Siebel Search for third-party search engines involves adding a new search engine record and configuring the search engine settings as required.

    This task is a step in Process of Configuring Siebel Search for Third-Party Search Engines.

    To configure Siebel Search for third-party search engines

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

    2. In the Search Engines applet, add a new record for the third-party search engine and configure the fields described in the following table for the new search engine.

      For example, add an Elastic Search Engine record with the values 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.

      Elastic SE

      Search Adapter

      Name of the search adapter, which maps to the search engine configured.

      WS Search Adapter Service.

      Sequence Number

      Indicates the position where the Elastic SE tab will appear in the Search Results view. For example, 1 indicates the first position and so on.

      2

      Active

      Indicates whether to show (Y) or hide (N) the Elastic SE tab in the Search Results view.

      Y

      Auto Suggest Supported

      Indicates whether to enable (Y) or disable (N) the auto suggest feature for search.

      Y

    3. In the Driver Parameters applet, configure the fields for the third-party search engine.

      For example, configure the fields shown in the following table for Elastic SE.

      Field Description Value

      URL

      The address of the Web Service for the third-party search engine.

      http://<ip_address>:<port_number>/SiebelSearchService/SiebelSearchService

      Batch Submit Size

      The number of records submitted at a time for indexing. The Object Manager query performance, search engine footprint size, and Siebel Server specification are used in determining optimum Batch Submit Size. Set the value to the following:

      • If you are using FTP indexing, set the value to less than or equal to 1500.

      1000

      Batch Split Size

      The number of business component records in a batch. The Object Manager query performance, search engine footprint size, and Siebel Server specification are used in determining optimum Batch Split Size. Set the value to the following:

      • If you are using FTP indexing, set the value to less than or equal to 4500.

      100

      Defining Index Categories for Third-Party Search Engines

      The following procedure shows you how to define index categories and the fields in each index category to index for third-party search engines.

      When setting up the fields to index in each index category,

      This task is a step in Process of Configuring Siebel Search for Third-Party Search Engines.

      To define new index categories for third-party search engines

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

      2. Click New (the plus (+) icon) to define a new category to index, and then do the following:

        1. In the BC Name field, click the look up icon, select a business component from the list that appears, and then click OK.

        2. In the Name field, enter a name for the new category.

        3. In the Name field, drilldown on the hyperlink.

      3. Go to the Available Fields tab and specify the fields in the category to be indexed as follows:

        1. Click New (the plus (+) icon) to add fields to the category as required.

        2. For each field in the category, select (Y) or deselect (N) the check box in the Searchable column.

          Y indicates to index the field and N indicates not to index the field in the category.

        3. (Optional) Enter a weighting for each field in the Weighting factor column.

      4. Go to the Applications tab and add applications and views to the category as follows:

        • Click New (the plus (+) icon), then add an Application Name.

        • In the Drilldown Views applet, click the plus (+) icon, then add new drilldown views.

          Note: When you specify multiple drilldown views for a category, the least restrictive view will be chosen for the user.

      Repeat this procedure for each index category that you want to define.

        Configuring Indexing for Third-Party Search Engines

        The following procedure shows you how to configure indexing for third-party search engines.

        This task is a step in Process of Configuring Siebel Search for Third-Party Search Engines.

        To configure indexing for third-party search engines

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

        2. In the Search Engine applet, navigate to the third-party search engine for which you want to configure indexing.

          For example, navigate to the Elastic SE record.

        3. In the Search Categories applet, click New (the plus (+) icon) to add a new search category, and then do the following:

          • In the Category Name field, click the look up icon, select a business component field from the list that appears, and then click OK.

          • Click the Index button.

          • Refresh the page to check the value in the Status Message field. The value in the Status Message field changes as it moves through the following stages: Not Started, Queued, In Progress, Indexed.

            Repeat this step for each category that you want the third-party search engine to index.

        4. In the Search Categories applet, drilldown on the indexed search category.

        5. Add applications and views to the selected indexed search category as follows:

          1. Select the Applications tab, click New (the plus (+) icon), and then add the application names.

          2. In the Drilldown Views applet, click the plus (+) icon, and then add the drilldown views.

          Configuring Incremental Indexing for Third-Party Search Engines

          The following procedure shows you how to configure incremental indexing for third-party search engines. Initially a full index of the category (for example Account) is performed, followed subsequently by the incremental indexing.

          This task is a step in Process of Configuring Siebel Search for Third-Party Search Engines.

          To configure incremental indexing for third-party search engines

          1. Enable the component groups for incremental indexing as follows:

            1. Navigate to the Administration - Server Configuration screen, then the Component Groups view.

            2. Query for and then enable the following component groups. To enable each component group, select the component, and then click Enable.

              • Search

              • MobileSync

          2. Configure the Enable Incremental Indexing system preference as follows:

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

            2. Add the Enable Incremental Indexing system preference and set its value to TRUE.

            3. Restart the Siebel server.

          3. Add a Job Template as follows:

            1. Navigate to the Administration Server Configuration screen, then the Job Template view.

            2. Add a new job template with the settings shown in the following table.

              Field Description

              Name

              Search Incremental Indexer

              Short Name

              SII

              Component Name

              Search Data Processor

              Component Type

              BusSvcMgr

            3. Set the following job parameters:

              Name Value

              Business Service Name

              Search Data Processor

              Method Name

              DoIncrementalIndex

          4. Add a new job as follows:

            1. Navigate to the Administration - Server Management screen, then the Job view.

            2. For the Component Job called Search Incremental Indexer, select the Repeating? check box.

            3. Set the following job details as required for the Search Incremental Indexer component job:

              • Schedule Start date and time

              • Expiration date and time

              • Delete Interval

              • Delete Unit

              • Repeating Information

              • Retry Information

            4. Set the following job parameters:

              Name Value

              Business Service Name

              Search Data Processor

              Method Name

              DoIncrementalIndex

            5. Submit the job.