IndexerGetStatus

Allows you to check whether the DIH has successfully indexed data into the child IDOL servers to which it is connected. The IndexerGetStatus command displays the status of the index queue:

Example:

An IndexerGetStatus action is sent to the DIH following a DREADD index command. The DIH returns the following output:

<autnresponse>
<action>INDEXERGETSTATUS</action>
<response>SUCCESS</response>
<responsedata>
<item>
    <id>1</id>
    <origin_ip>127.0.0.1</origin_ip>
    <received_time>2008/10/22 11:30:13</received_time>
    <start_time>2008/10/22 11:30:14</start_time>
    <end_time>2008/10/22 11:32:14</end_time>
    <duration_secs>120</duration_secs>
    <percentage_processed>100</percentage_processed>
    <status>-1</status>
    <description>Finished</description>
    <index_command>
    /DREADD?myfile.idx&KILLDUPLICATES=REFERENCE&DREDBNAME=Archive
    </index_command>
</item>
</responsedata>
</autnresponse>

 

<id> The ID number of the Index command that was applied.
<origin_ip> The IP address of the machine that sent the index command to the DIH.
<received_time> The time that the command was received by the DIH.
<start_time> The time that the DIH started processing the index command.
<end_time> The time that the DIH finished processing the index command.
<duration_secs> The total amount of time in seconds that the DIH spent processing the index command.
<status> The status code of the current status of the index command in the DIH's index queue.
<description> The description of the <status> number.
<index_command> The index command that was used for the index job.


IndexerGetStatus Status Codes:

-1     Finished The indexing process is finished.
-2     Out of disk space IDOL server ran out of disk space before the indexing process could be completed.
-3     File not found The index file could not be found.
-4     Database not found The database into which you are trying to index could not be found.
-5     Bad parameter The indexing command syntax is incorrect.
-6     Database exists The database you are trying to create already exists.
-7     Queued The indexing command is queued and will be executed when all preceding indexing commands are finished.
-8     Unavailable IDOL server is about to shut down or indexing is paused.
-9     Out of Memory IDOL server ran out of memory before the indexing process could be completed.
-10     Interrupted The indexing command was interrupted.
-11     XML is not well formed Indexing failed because the XML is not well formed.
-12     Retrying interrupted command IDOL server is executing an indexing command that was previously been interrupted.
-13     Backup in progress IDOL server is performing a backup.
-14     Max index size reached The indexing job exceeds the maximum indexing size (the maximum indexing size is determined by your license).
-15     Max number of sections reached The indexing job exceeds the maximum number of sections that can be indexed. (the number of sections you can index is determined by your license).
-16     Indexing Paused The indexing process was paused.
-17     Indexing Resumed The indexing process was restarted.
-18     Indexing Cancelled The indexing process was cancelled.
-19     Out of file descriptors IDOL server ran out of file descriptors.
-20     LanguageType not found The language type of the index data could not be found.
-21     SecurityType not found The security type of the index data could not be found.
-22     Child engines returned differing messages The child engines returned different messages to the DIH. This code is reported by DIH only.
-23     Badly formatted index command The indexing command was rejected by a child engine because the syntax is invalid.
-25     To be sent to DRE The index command is queued to be sent to the IDOL server. This code is reported by DIH only.
-26     DREADDDATA: Data received did not include #DREENDDATA The data in the DREADDDATA command did not contain a #DREEDNDDATA statement indicating the end of the data.
-27     Command failed more times than the configured retry limit The indexing command exceeded the maximum number of retries specified by the MaximumRetries parameter in the DIH configuration. This code is reported by DIH only.
-28     The index ID specified is invalid. The index ID returned by the child engine is invalid. This code is reported by DIH only.
-29     Command was redistributed to sibling engines as this engine was either unavailable or not accepting index jobs. The indexing command was sent to sibling engines because the child engine was either unavailable or not accepting indexing jobs. This code is reported by DIH only.
-30     Database name too long The name of the database in which you are indexing documents is too long. The length is defined internally as 63 characters.
-31     Command ignored due to id match The DREINITIAL command was ignored because it did not match the ID specified in the InitialID parameter.
-33       The database cannot be created because the maximum number of databases was exceeded. The maximum is defined internally as 32,767.
-34     Pending commit The indexing job is complete and the documents will be available for searching after the next delayed sync cycle, which is specified in the DelayedSync parameter.
-35     Initialising The indexing job is being started. This code is reported by DIH only.
-36     Reading IDX The IDX file is being read from disk, prior to being sent to the DRE. This code is reported by DIH only.

If the IndexerGetStatus command returns a positive number, this number indicates the percentage of the indexing job that has been completed.

The following codes are status messages. All other codes indicate there is a problem with the indexing process:

Finished (-1)

Queued (-7)

Retrying interrupted command (-12)

Backup in progress (-13)

Indexing Paused (-16)

Indexing Resumed (-17)

To be sent to DRE (-25)

Pending commit (-34)

Initialising (-35)

Reading IDX (-36)

Note: This is an administrative action command that can only be sent from DIH's AdminClients (which are set in the IDOL server configuration file's [Server] section).

Example

http://12.3.4.56:16000/action=IndexerGetStatus

This command uses port 16000 to request the status of DIH's index queue. DIH is located on a machine with the IP address 12.3.4.56.

Parameter Description Required
Child The ID of child servers whose details are to be returned. see Comment
ChildDetails Show the details of child servers.  
EncryptResponse Encrypts DIH server output.
FileName The file to which DIH output is written.
ForceTemplateRefresh Forces the template to be loaded from disk.
Index The index ID of a specific index command.
IndexAction Controls indexing of IDX and XML files.
IndexCmd Filters the response only to those jobs matching the command.
IndexStatus Specifies the status index jobs must have to be returned.
MaxResults The top number of index jobs to be returned.
PollChildren Whether to poll child servers.
Priority Sets the priority of an indexing job.
Output Writes DIH output to a file.
Summary Whether to return a summary page instead of the full status results.
Template The template to use for the action's output.
Comments

To use Priority, you must set IndexAction=SetPriority.

By default, the command reports a job finished only when the job is reported finished by all the DIH's children. This can result in large queue sizes. To mark each job finished when it is reported finished by one child, set the Polling parameter in the [Server] section to false.

The Child parameter can only be set if the ChildDetails parameter is set to true.