To connect to One Identity Safeguard for Privileged Sessions (SPS) and index the audit trails, you must configure the external indexer.


Unless you know exactly what you are doing, modify only the parameters you are instructed to.

To configure the external indexer

  1. Appendix: Log in to the SPS web interface, and navigate to Basic Settings > Local Services > Indexer service.

  2. To export the configuration file for the external indexer, click Export.

    NOTE: The Export button is displayed only after the configuration that enables SPS to use remote indexers is committed.

    The configuration file contains the listening address (IP and port) of SPS and the necessary keys for SSL authentication.

    Upload the file to the external indexer host.

  3. On the external indexer host, import the configuration file with the following command:

    indexer-box-config <configuration-file>.config
  4. To configure the external indexer service, open the /etc/indexer/indexerworker.cfg configuration file for editing.

  5. To edit the number of worker groups assigned to a certain worker process type, find the worker_groups line.

    A worker group has the following parameters:

    • name: the name of the worker group

    • count: the number of workers to use for processing

    • capabilities: the types of jobs the process performs (index, screenshot, video, near-realtime)

      NOTE: Setting the near-realtime capability exclusively determines whether active or closed sessions are indexed. For example:

      • If you set [near-realtime, index] capabilities for a worker, that worker only indexes active and ongoing sessions.

      • If you set [index, screenshot, video] capabilities for a worker, that worker only indexes closed sessions.

      NOTE: If you configure a connection policy with near real-time priority (Connection policy > Enable indexing > Priority), you must configure indexer workers that are capable of near real-time indexing. To configure such indexer workers, set the near-realtime capability for the relevant workers.

      NOTE: Indexer workers with the near-realtime capability require fewer CPU cores but more memory than indexer workers that do not have this capability.

    Make sure that the sum value of the workers are equal to the number of CPU cores in the host (or the number of CPU cores minus one if you want to save resources for other tasks).

    One Identity recommends using dedicated hosts for external indexing. If the host is not dedicated exclusively to the external indexer, decrease the number of workers accordingly.

  6. (Optional) To fine-tune performance, you can configure the number of OCR threads each worker can initiate using the ocr_thread_count key.

    The default setting is 3. When configuring this setting, pay attention to the available CPU cores, as raising the number of possible threads too high can impact performance negatively.

  7. (Optional) If instructed by One Identity Support, configure the OCR engine.

    Find the engine key, and change its value to one of the following options:

    • omnipage-external is the default setting. It provides the best performance and stability by allowing workers to initiate multiple OCR threads.

      This setting also allows you to search for images where OCR could not be performed. On the search UI of SPS, enter the OOCCRRCCRRAASSHH search string to list all such images. If possible, contact our Support Team, to help One Identity to further improve the engine.

      NOTE: Multiple OCR threads can only speed up processing graphical protocols (RDP, VNC, and ICA trails), and do not affect the processing speed for terminal-based protocols (telnet and SSH).

    • omnipage only supports one OCR thread per worker.

      If you have to use this option, make sure to also set the ocr_thread_count to 0.

  8. Save your changes.

  9. (Optional) Continue with uploading decryption keys to index encrypted audit trails. For more information, see Uploading decryption keys to the external indexer.

  10. (Optional) Start the indexer service. For more information, see Starting the external indexer.