Configure Smart Search

User Role: Administrator

To configure Smart Search, follow these steps:

  1. From the System Navigator, click System Administration > Ongoing Maintenance > Smart Analytics > Smart Search.

    The Smart Search Configuration page opens.

  2. From the Add Knowledgebase section, specify the following settings as needed:

    • Knowledgebase name: Specifies the name of the library you want to add.
    • Knowledgebase type: Specifies the type of the library you want to add.
    • Add: Adds the library you specified as a new knowledgebase.

      Once you click the Add button, the new IDOL knowledgebase record is added and a new knowledgebase maintenance page is displayed. Configure the required knowledgebase information on the maintenance page. For detailed information about different types and configuration steps of knowledgebases, see Manage Smart Search Knowledgebases.

  3. From the Environment Configuration section, modify the following settings as needed:

    • Expiry days: Smart Search removes the data that was indexed longer than the setting in this field from search.
    • Assign the default knowledge view group to all operators: If this option is selected, the default knowledge view group is assigned to all operators.
    • Connector configuration: Click to configure and monitor the status of the connectors and servers. For detailed information, see Configure connectors.
  4. From the Current Knowledgebase List section, you can check the following information.

    Field Description
    Knowledgebase Name

    Specifies the name of the Smart Search knowledgebase.

    Note When the administrator adds a new library, users can only see this library available on the list after next login.

    Type Specifies the type of the Smart Search knowledgebase.
    Display Name Specifies the display name for the Smart Search knowledgebase. You can change this value from a knowledgebase details page.
    Interval Displays the current interval used to update the selected knowledgebase index. Each interval unit is 5 minutes (default). You can change this value from a knowledgebase details page.
    Index Status

    Displays the current index status of the library. A library has the following four index status:

    • Offline: the library is newly added or the Smart Search server is shut down.
    • Not started: the Full Reindex button is clicked for the library and the indexing is in the queue.
    • Indexing: the indexing for the library is ongoing.
    • Finished: the indexing for the library is finished.
    Doc count Displays the number of records in the library. The number of the records is affected by the replica settings. When a content server is disabled, the number may be incorrect before you redistribute the server data.
    Last Index time Displays the time when the libary is last indexed.
    Full Reindex:

    When you click the Full Reindex button, the IDOL search engine performs a full re-index of the selected library. However, because indexing runs as a background process, the search engine does not begin indexing until the specified refresh interval is reached.

    Performing a full re-index on a large knowledgebase may have a significant impact on system resources. Therefore, it is recommended that you perform a full re-index of a small amount of records in a knowledgebase, for example, records created within 90 days. For the rest of the records, you can perform incremental indexing by using the AddToKMBUTable ScriptLibrary. For more information, see Perform indexing of large-scale knowledgebases.

    Refresh Status Refreshes the index status of the knowledgebases.

    To modify settings for any current knowledgebase, click the respective link from the list. For detailed information about knowledgebase settings, see Manage Smart Search Knowledgebases.

  5. When you first install the IDOL search engine after having used the Solr search engine, you need to do the following:

    Check libraries in the Current Knowledgebase List. From the kmsearchsecurity script of each library, delete the code which you updated to enable Mandanten Security for libraries when using Solr, and then replace the deleted code with the following:

    function getSecurityInfo(user, record)
    
    {
    
    return "";
    
    }
    

    Note Starting from Service Manager 9.41, Mandanten security control is introduced as a built-in feature in Smart Search. Users no longer need to implement it manually by updating the KM search security script. If you keep the KM Search security script which was updated for Mandanten security, the built-in Mandanten control in Smart Search does not work.

  6. Click Save to save your modification.
  7. Click Full Re-index.
  8. Log off and then log onto Service Manager for the changes to work.
  9. Perform a Smart Search to verify your configuration.

    If you encounter session time out or long response time when performing the first Smart Search after indexing, set a higher value for the TermCachePersistentKB parameter in the [TermCache] section for all content server configuration files(content<N>.cfg) and then restart your content servers.

    Note The default value for this parameter is 512000. You can configure the parameter value according to system memory availability and desired querying speed. For example, if you selected All-in-one install template when deploying Smart Analytics, you can keep the default value unchanged. If you deployed your content servers on multiple machines, it is recommended you modify the value to 2097152.