The following functions are supported:
- Retrieve Canister status - Displays an XML version of Short Term Canister data points that can tell you the state of the current Short Term Canister.
- Retrieve a replayable list of all active sessions - Retrieves a list of all active sessions in the Short Term Canister with a link that enables them to be replayed. If CX RealiTea Viewer is installed on the same machine, it can load all active sessions.
- Perform session search - Enables searching of the Short and Long Term Canisters. You can select the Canister to search, which allows you to search active or completed sessions or both types.
- Retrieve Canister Events - Enables retrieval of all configured Canister events from the machine on which Search Server is running.
- Rebuild indexes - If index files are corrupted, you can rebuild indexes using the check and fix command. This command pulls TLC files from the Canister and converts them to indexes.
- Drain the Short Term Canister of sessions - Search Server provides access to governor operations so you can drain the Canister, start spooling data, and more.
- Retrieve event definitions - The Search Server that is also the Event Master server can retrieve the event definitions from the database.
- Distribution searches - The Search Server hosted on the Portal Server distributes searches executed through the Portal interface to Search Servers located on other machines to retrieve sessions.
Search Server issues URL commands and returns sessions in XML format.
Search Server hosts
Search Server can be co-located on the systems hosting the following components, or it can be hosted on a standalone server. Depending on the server where it is installed, its primary function may vary.
Component | Primary function of Search Server |
---|---|
Portal Server | The Search Server instance on the Portal is typically defined as the Event Master, which means that it is the designated server to retrieve event definitions from the database. These event definitions are cached on the server for retrieval as needed.
|
Canister Server | The Search Server on an individual Canister is responsible for executing the searches submitted to it from other servers and returning the session information in XML format to the requestor. |
cxConnect for Data Analysis Server | The Search Server on a cxConnect for Data Analysis Server manages the search queries executed as part of cxConnect for Data Analysis tasks to retrieve sessions for extraction and saving into one of the supported formats. |
cxVerify Server | The Search Server on a cxVerify Server manages the search queries executed as part of cxVerify tasks to retrieve sessions for extraction and export. |
Report Server | In some deployments, the Search Server that aggregates search results for Portal users is located on the Report Server to offload processing from the Portal Server. This deployment is not common. |