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

9Setting Up Oracle Secure Enterprise Search for Siebel Remote

About Installing Search for the Siebel Remote Client

This topic covers installation of Search for Siebel Remote, and installation of related Siebel components. The Siebel Mobile Client must be installed before installing Search for Siebel Remote. See Siebel Remote and Replication Manager Administration Guide for information on the Siebel Mobile Web Client and Siebel Remote. Siebel Search for Siebel Remote is supported in employee-facing applications, and is not supported in customer-facing applications.

Note: Siebel Search for Siebel Remote is supported only on the Windows operating system.

    Upgrading from Siebel Search Version 7.x

    Any custom search objects which were defined in Siebel Search Version 7.x must be redefined in the file SSC_DSM_Field-Mappings.xml. See Configuring Index Mappings for Oracle Secure Enterprise Search.

      Creating the Siebel Search Center Directory Structure on the Siebel Remote Client

      This topic covers creation of the directories that are required when using Siebel Search for Siebel Remote.

      To create the Siebel Search Center Directory Structure on the Siebel Remote Client

      1. Create the Siebel Search Center Config directory D:\fs\SSC\Config\ under the Siebel File System on the Siebel Remote client.

      2. Create a directory for storing the XML feed files on the Siebel Server, for example, D:\fs\SSC\xmlidata.

        The XML feed files are generated at runtime and temporarily stored in the \xmlidata folder. The feed files are automatically deleted once indexing completes.

      3. Create a directory for storing the XML field mapping file on the Siebel Server, for example, D:\fs\SSC\Config.

      Installing Oracle Secure Enterprise Search for Siebel Remote

      Siebel Mobile Search crawls Siebel data in RSS feed format. The file ConfigRSS.exe is used to install and configure Siebel Mobile Search.

      To install Oracle Secure Enterprise Search for Siebel Remote

      1. Install the client for Siebel Remote.

        This installs dsm.zip to <mobile client install dir>\BIN\.

      2. Extract the contents of dsm.zip to create the directory <mobile client install dir>\BIN\dsm\.

      3. Copy the XML field mapping file from the mobile Client installation directory at <mobile client install dir>\BIN\ to the config directory at D:\fs\SSC\Config\. The correct mapping file to copy is determined as follows:

        • Copy 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.

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

      4. Rename the XML field mapping file to SSC_DSM_Field-Mappings.xml.

      5. Double-click on the file ConfigRSS.exe to install the Disconnected Search Module (DSM) client.

      6. Complete the DSM Configuration fields. Some fields are described in the following table.

        Field Description

        Install Directory

        This is the install directory for the DSM log file and encrypted password file. The default value is:

        C:\Documents and Settings\<UserName>\MyDocuments\Disconnected Search

        Feed Location

        Location where the XML-based indexable data files will be generated. Set the value to: 

        D:\fs\SSC\xmlidata

        HTTP Port

        This is the port of the DSM listener. The default value is 8095. This value will be required when configuring the DSM Index Listener field in the Mobile Search administration view.

        User Name

        Create a user name for DSM. This value is also required when setting the DSM Username setting in the Search Engine Settings view.

        Password

        Create a password for DSM. This value is also required when setting the DSM Password setting in the Search Engine Settings view.

      7. Click Install.

      Starting the DSM Listener

      This topic covers enabling Siebel Search for Siebel Remote by starting the Disconnected Search Module (DSM) Listener.

      To start the Disconnected Search Module Listener

      1. Double-click on the file SearchAPI.exe on the Siebel Mobile client.

        This file is located at <mobile client install dir>\BIN\dsm\.

      2. Enter the DSM User Name and Password.

      3. Select Debug Mode to enable debug logging level.

        This setting is optional, and is only required if you wish to view logging information.

      4. Click Start Listener.

      Configuring Search Field Mapping Settings for Siebel Remote

      This topic covers configuring the Search field mapping settings for Siebel Remote The settings enclosed in percentage tags in the field mapping file must be configured to Search for Siebel Remote.

      To configure Search field mapping settings for Siebel Remote

      1. Open the file D:\fs\SSC\Config\SSC_DSM_Field-Mappings.xml in an XML or text editor.

      2. Configure all fields enclosed in percentage tags. The fields are described in the following table:

        Field Description

        %webserver%

        Set the value to the IP address of the Mobile Client host computer.

        %objmgr%

        Set the object manager value to the application that is running, for example, CallCenter or Fins.

        %lang%

        Set the value to the language which the Siebel application is configured for, for example, the value for English is enu.

        %hostName%

        Set the value to the IP address of the Mobile Client host computer.

      Adding the Siebel Mobile Search Administration Screen for Siebel Remote

      The Siebel Mobile Search Administration screen must be added for each application project in Siebel Tools.

      Note: The Mobile Search Administration screen has already been added for the Call Center application.

      To add the Mobile Search Administration screen for Siebel Remote

      1. Connect to Tools.

      2. From the Object Explorer, expand the Application object type.

      3. Select the application in the Object Explorer.

        Note the project to which the application belongs.

      4. Lock the application project.

      5. From the Object Explorer, expand the Application object type.

      6. Select Screen Menu Item.

      7. Choose Edit, and then New Record, and use the information in the following table to define the object properties:

        Property Description

        Screen

        Set the value to Search Mobile Admin View Screen.

        Sequence

        Use Screen View Sequence Editor to determine the sequence of views. Do not edit the Sequence property of the Screen View Object manually. See Configuring Siebel Business Applications for defining Sequence for Screen View Objects.

        Text - String Reference

        Set the value to:

        SBL_ADMINISTRATION_-_MOBILE_SEARCH

      8. Compile the changes.

      Verifying the Business Component Search Connector Settings for Siebel Remote

      The Search business component connector for Siebel Remote is preconfigured. This task covers verifying the connector settings.

      To verify the Search Connector settings for Siebel Remote

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

        The Search Connector Settings List applet is displayed.

      2. Verify the settings in the following table. Values are case-sensitive.

        Field Description

        Name

        The preconfigured value must be set to Mobile Business Component.

        Library Name

        The preconfigured value must be set to buscomp.

        Engine Name

        The preconfigured value must be set to DSM.

      Activating Search for Siebel Remote

      Siebel Search for Siebel Remote is activated by selecting the Default Flag option in the Search Engine Settings view. Only one search engine can be activated at any one time—make sure that the Default Flg option is selected for just one search engine.

      To activate Search for Siebel Remote

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

      2. Select the Default Flag option for DSM Search Engine.

      Configuring Search Engine Settings for Siebel Remote

      This topic covers configuration of the Search Engine Settings view for Siebel Remote.

      To configure search engine settings for Siebel Remote

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

      2. Complete the search engine fields described in the following.

        Field Description

        Batch Submit Size

        The number of records submitted at a time in each feed for indexing. Set the value to less than or equal to 1500.

        The Object Manager query performance, search engine footprint size, and Siebel Server specification are used in determining optimum Batch Submit Size.

        DSM Index Listener

        Set the value to http://<localhost>:<HTTP Port>/?index, where HTTP Port is the port of the DSM Listener. HTTP Port is defined when installing the Mobile Search client. The default value is:

        http://localhost:8095/?index

        DSM Password

        This is the password that was created when installing the DSM client. See Installing Oracle Secure Enterprise Search for Siebel Remote.

        DSM Username

        This is the user name that was created when installing the DSM client. See Installing Oracle Secure Enterprise Search for Siebel Remote.

        Dupmarked

        This setting configures the marking of duplicates in the result set. Set the value to False.

        Dupremoved

        This setting configures the removal of duplicates from the result set. Set the value to True.

        Filename

        This value configures the path of the DSM field mapping file SSC_DSM_Field-Mappings.xml on the Mobile client. Set the value to:

        D:\fs\SSC\Config\SSC_DSM_Field-Mappings.xml

        Recordcount

        This setting configures the inclusion of an estimate in the result for the number of records in the result set. Set the value to True.

        Shared Search UNC Location

        This is the Siebel Search Center location for storing configuration and XML data files. It is the parent directory of the Xmlidata directory. The address format is D:\fs\SSC.

        WebServer Address

        URL for the Search Service. The address format is http://localhost:<HTTP_Port>/. The default value is:

        http://localhost:8095/

        XML Indexable Data Location

        This is the Siebel Search Center location where the XML feed files are temporarily stored for the DSM Listener to access and index. The path format is:

        D:\fs\SSC\xmlidata\

      3. Select Save Record on the list applet.

      4. Log out and log in to the Mobile Client for the changes to take effect.

      Note: The Siebel Server must be restarted every time a change is made to Search Engine Settings configuration.

      Process of Setting Up the Index Definition for the Siebel Remote Client

      Search Categories for each Siebel application are defined in Search Definition groupings in the Search Definition view. This view can be used for creating or customizing Search Definitions and Search Definition Categories. This topic covers configuring the Mobile Client Search Definition in the Siebel Mobile Search administration UI, and then adding the definition to the application configuration file.

      To set up the index definition for the Search mobile client, perform the following tasks:

        Configuring the Search Definition for Siebel Remote

        This topic covers configuring the Mobile Client Search definition in the Search Definition view of the Administration - Mobile Search screen. The list of Categories displayed in the Search Index Settings view is determined by the default Search Definition in the Search Definition view.

        To configure the default search definition for Siebel Remote

        1. Navigate to Administration - Mobile Search screen, then the Search Definition view.

        2. Select Mobile Client Search Definition.

        3. Select the Default Flg option.

          Configuring the Application Configuration File

          This topic covers configuring the Search Definition in the SearchDefName parameter of the application configuration file for the Siebel Mobile Client. Application configuration file names are in the format <application>.cfg, for example, the file shm.cfg is the Siebel Hospitality application configuration file, and the file uagent.cfg is the Siebel Call Center application configuration file. Verify that you are using the correct application configuration file by checking the ApplicationName parameter in the file.

          Note: This configuration change must be applied to each application configuration file for each language in the enterprise.

          To configure the application configuration file

          1. Open the application configuration file in a text editor. On Windows the file is located at: <install_dir>bin\<language>\<application>.cfg

          2. Go to the SIEBEL section of the configuration file.

          3. Change the value of the SearchDefName parameter to Mobile Client Search Definition, and save the changes.

            Activating Search Run-Time Events for Siebel Remote

            Activating preconfigured Search run-time events is required to enable refresh indexing. Search runtime events monitor create, update and delete events executed on Search Objects in the data repository. The Action Sets create records in the transaction table and trigger the Search Content business service method UpdateIndex.

            To activate the Search run-time events for Siebel Remote

            1. Navigate to Administration - Runtime Events screen, then the Action Sets view.

            2. Query on the Update Index Action Set.

            3. Select the Active and Enable Export options to activate the Update Index run-time events.

            Note: Incremental indexing is not supported for disconnected Mobile Search.

            Synchronizing Siebel Search for Siebel Remote

            See Siebel Remote and Replication Manager Administration Guide for information on synchronizing a Mobile Web Client with the Siebel Remote server.

            Search Functionality Supported for Siebel Remote

            The following table summarizes the Search functionality available for Siebel Remote.

            Functionality Supported for Siebel Remote

            Siebel Open UI

            No

            Business component indexing

            Yes

            File system indexing

            No

            Web source indexing

            No

            Database source indexing

            No

            IMAP email source indexing

            No

            Lotus notes source indexing

            No

            Secure indexing

            No

            Refresh indexing

            Yes

            Incremental indexing

            Manual incremental indexing supported.

            Asynchronous indexing

            No

            Index status monitoring

            No

            Real time database queries

            No. Searches are run against search indices.

            Full text search

            Yes

            Keyword search

            Yes

            Automated suggested keywords

            No

            Filter field search (also called parametric search)

            Yes

            Wildcard search

            Yes. Does not apply to punctuation characters, such as spaces, or commas. Applies to characters only within a word.

            Case insensitive search

            Yes

            Boolean operators

            Yes. Supports AND and OR Boolean operators.

            Searches on content in attachments

            Yes

            Searches on external data sources and file systems

            Yes

            Search by file format

            No

            Associate option in search results

            Yes

            Password Encryption

            No