GetStatus Action

The GetStatus action returns information about the status of IDOL Server and its components, as well as the configuration and content of the server.

http://IDOLhost:port/action=GetStatus

where:

IDOLhost is the IP address or name of the machine on which IDOL Server is installed.
port is the ACI port by which you send actions to IDOL Server (set by the Port parameter in the [Server] section of the IDOL Server configuration file).

The GetStatus action is a diagnostic tool that you can use to check information about your server.

You can use the output from GetStatus to:

  • view some of the IDOL Server configuration options without opening the configuration file.

  • check that all IDOL Server components are running.

  • monitor the number of documents in IDOL Server and see how close the server is to the configured document limit.

  • monitor how many index actions IDOL Server has processed, and check the size of the index queue, for example to:

    • determine whether the server processes incoming index actions as fast as it receives them.

    • determine how many items the server has left to process, before performing maintenance or backups.

  • check the results of the latest index validation.

  • check language configuration and determine how many documents in the server use each configured language type.

  • check document security configuration and determine how many documents in the server belong to each configured security type.

  • check user security configuration.

TIP: You can also view status information by using the IDOL Admin interface. For more information, refer to the IDOL Admin User Guide.

NOTE: OpenText recommends that you contact OpenText Support before taking actions based on the information in the GetStatus action.