1. Search Administration Guide
  2. Enabling Search Engine in Siebel Application

Enabling Search Engine in Siebel Application

Prerequisites
  1. OpenSearch InstanceEnsure your OpenSearch instance is running and the YAML configuration file is set up.
  2. JVM Heap SizeConfigure the JVM heap to 4GB. Refer to the Performance Tuning Guide.

Follow these steps to configure and enable Siebel to leverage OpenSearch as the backend search engine.

  1. Log into Siebel Application.

    In Site Map, navigate to Administration - Application > System Preferences.

  2. Configure the following system preferences:

    System Preference Name System Preference Value Description
    Enable OpenSearch Y To Enable OpenSearch Service for Siebel Standard Objects and Files
    Enable OpenSearch FileIndexing Y To Enable OpenSearch Service for File Indexing
    Enable OpenSearch IncrFileIndx Y To Enable OpenSearch Service for Incremental File Indexing
    OpenSearch Index File Path <Provide Index File Path> To Provide OpenSearch Index File Path for Attachments
    • Enable OpenSearch: Set to Y to enable OpenSearch integration.
    • Enable OpenSearch FileIndexing (optional): Set to Y to enable file content indexing.
    • OpenSearch Index File Path (optional): Provide a file path accessible by Siebel with write permissions.
      • Windows format: \\<server>\fs
      • UNIX format: /home/export/fs
    • Enable OpenSearch IncrFileIndx (optional): Set to Y to enable incremental indexing of file content.
    Note: After making changes to system preferences, restart the Siebel Server for changes to take effect.

  3. Go to Site Map > Administration - Search > Search Engine Settings.

  4. In the list of search engines, locate or create the entry for OpenSearch and set:

    • Active: Y(mandatory for integration)
    • Auto Suggest Supported: Y
    Setting 'OpenSearch' active flag to 'Y' will trigger a RunTimeEvent (RTE) which will register the ML model as specified.

    Sample values:modelName: huggingface/sentence-transformers/msmarco-distilbert-base-tas-b

    modelVersion: 1.0.2

    Note:
    • The Sequence Number field is not used by the Siebel Search Adapter framework.

    • Once "OpenSearch" is active, Siebel Search UX will use only OpenSearch search engine to perform search.

  5. Configure OpenSearch Engine Driver Parameters.

    In the OpenSearch search engine configuration, set the following parameters:

    Name Default Value
    Batch Split Size 1000
    Batch Submit Size 100
    FileIndexing BatchSubmitSize 5
    FileIndexing NumOfBatchJobs 5
    Search Pipeline True
    JBSTimeout

    7500000 milliseconds. The default value is 2 minutes.

    • Batch Split 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.

    • Batch Submit 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.

      Refer to Configuring Siebel Search for Third-Party Search Engines for further information.

    • FileIndexing BatchSubmitSize: The number of file attachment 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. Do not change this value.

    • FileIndexing NumOfBatchJobs: The number of active batch jobs to index file attachments. The Object Manager query performance, search engine footprint size, and Siebel Server specification are used in determining optimum FileIndexing NumOfBatchJobs. Do not change this value.

    • Search Pipeline: When set to 'True,' changes to the weight factor in the YAML file will be updated in OpenSearch by triggering a Runtime Event.

    • JBSTimeout: Timeout for the indexing request. If this parameter is omitted, the default value is 2 minutes. This value should be set slightly higher than clientResponseTimeout inside Downstream Settings in YAML file.

JBSTimeout

JBSTimeout specifies the amount of time Siebel waits for a bulk indexing response from the Tomcat server. By default, Java Business Service calls are subject to timeout limits. This parameter allows administrators to configure a timeout value greater than 120000 milliseconds, making it suitable for large or long-running bulk indexing operations that may exceed the default threshold.

Here are the parameter details:

Parameter: JBSTimeout

Description: Specifies the timeout duration for waiting on a bulk indexing response from the Tomcat server

Unit: Milliseconds

Configuration Guidelines

  • JBSTimeout supports values greater than 120000 ms.
  • Configure JBSTimeout in conjunction with the clientResponseTimeout parameter in modersearchconfig.yaml.
  • The JBSTimeout value should be set slightly higher than clientResponseTimeout so that the Tomcat-side timeout occurs before the Siebel-side timeout. This allows the OpenSearch service to return a response or timeout condition in a controlled manner.

Example

If clientResponseTimeout in modersearchconfig.yaml is set to 7200 seconds, configure JBSTimeout to a slightly higher value, such as 7,500,000 ms.