IDOL Server 24.4
IDOL Server Help

# IndexerGetStatus

Displays the status of the most recent item in the index queue.

This action is similar to the IndexerGetStatus ACI action, but is not blocked when a `DREINITIAL` command is in progress and only returns the most recent item from the index queue.

NOTE: This is a service control action that can be sent only by users that belong to an authorization role that allows the `ServiceControl` standard role, or which enables the action explicitly. See Authorization Roles Configuration Parameters.

An `IndexerGetStatus` action returns the following output:

    <autnresponse>
      <action>INDEXERGETSTATUS</action>
      <response>SUCCESS</response>
      <responsedata>
        <item>
          <id>2</id>
          <origin_ip>::1</origin_ip>
          <received_time>2019/02/08 03:17:20</received_time>
          <start_time>2019/02/08 03:17:21</start_time>
          <end_time>Not Finished</end_time>
          <duration_secs>948</duration_secs>
          <documents_processed>218387</documents_processed>
          <documents_deleted>0</documents_deleted>
          <percentage_processed>25</percentage_processed>
          <status>0</status>
          <description>PROCESSING</description>
          <docidrange/>
          <index_command>/DREADD?Filename=my.idx&dredbname=database</index_command>
        </item>
      </responsedata>
    </autnresponse>

<id> | The ID number of the Index action.
<origin_ip> | The IP address of the machine that sent the index action to IDOL Server.
<received_time> | The time that the index action was received by IDOL Server.
<start_time> | The time that IDOL Server started processing the index action.
<end_time> | The time that IDOL Server finished processing the index action.
<duration_secs> | The total amount of time in seconds that IDOL Server spent processing the index action.
<percentage_processed> | The percentage of the index job that has been completed.
<documents_processed> | The number of documents that IDOL Server has processed during the indexing job.
<documents_deleted> | The number of documents deleted during the indexing process.
<status> | The status code of the current status of the index action in IDOL Server’s index queue. For more information about these status codes, refer to the documentation for the IndexerGetStatus ACI action.
<description> | The description of the `<status>` number.
<docidrange> | The range of docIDs of documents that have been processed during the index job.
<index_command> | The index action that was used for the index job.

For more information about the response, refer to the documentation for the IndexerGetStatus ACI action.

## Example

    http://12.3.4.56:9002/action=IndexerGetStatus

This action requests the status of the IDOL Server index queue.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
EpochTime | Specifies whether to return time values in epoch seconds, in UTC time.

Copyright 2024 Open Text
Version 24.4 | Last updated September 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Server 24.4

Topic Title: IndexerGetStatus