Open topic with navigation

# IndexerGetStatus

Allows you to display the status of index actions in the HPE Content Component index queue.

NOTE:

This is an administrative action that can be sent only from AdminClients (which are set in the `[Server]` section of the configuration file).

Example:

An `IndexerGetStatus` action is sent to HPE Content Component following a DREADD index action. HPE Content Component returns the following output:

    <autnresponse>
    <action>INDEXERGETSTATUS</action>
    <response>SUCCESS</response>
    <responsedata>
    <timeformat>YYYY/MM/DD HH:NN:SS</timeformat>
    <state>Running</state>
    <item>
        <id>1</id>
        <origin_ip>127.0.0.1</origin_ip>
        <received_time>2015/03/31 16:14:43</received_time>
        <start_time>2015/03/31 16:14:44</start_time>
        <end_time>2015/03/31 16:16:44</end_time>
        <duration_secs>120</duration_secs>
        <percentage_processed>100</percentage_processed>
        <documents_processed>44710</documents_processed>
        <documents_deleted>0</documents_deleted>
        <status>-1</status>
        <description>Finished</description>
        <docidrange>1-44710</docidrange>
        <index_command>/DREADD?myfile.idx&KILLDUPLICATES=REFERENCE&DREDBNAME=Archive</index_command>
    </item>
    </responsedata>
    </autnresponse>

<timeformat> | The time and date format that the response uses.
<state> | The status of the Content component indexing thread.
<id> | The ID number of the Index action that was applied.
<origin_ip> | The IP address of the machine that sent the index action to HPE Content Component.
<received_time> | The time that the index action was received by HPE Content Component.
<start_time> | The time that HPE Content Component started processing the index action.
<end_time> | The time that HPE Content Component finished processing the index action.
<duration_secs> | The total amount of time in seconds that HPE Content Component spent processing the index action.
<percentage_processed> | The percentage of the index job that has been completed.
<documents_processed> | The number of documents that HPE Content Component 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 HPE Content Component’s index queue.
<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.

The DRECOMPACT index action also returns a `<drecompact_status>` section to show the time that each stage of the compaction takes. This section contains `<stage>` tags, with the following attributes:

name | The name of the compaction stage.
description | The description of the compaction stage.
percentage_complete | The percentage of the compaction stage that is complete.
time_seconds | The time that the compaction stage has taken.
paused | If you pause the `DRECOMPACT` index action, this attribute is set to `True` for the paused stage.

## Content Component Index Status Codes

The Content component returns the following status messages to show whether it is currently processing jobs, or if it is paused:

Running
Paused
Paused (DREFLUSHANDPAUSE)
Paused (out of disk space)
Paused (waiting for flush lock)
Inactive (no jobs)

## IndexerGetStatus Status Codes

Codes in bold are status messages. All other codes indicate there is a problem with the indexing process.

Code | Message | Explanation
--- | --- | ---
–1 | Finished | The indexing process is complete.
–2 | Out of disk space | HPE Content Component ran out of disk space before it completed the indexing process.
–3 | File not found | The index file was not found.
–4 | Database not found | The database into which you are trying to index was not found.
–5 | Bad parameter | The indexing action syntax is incorrect.
–6 | Database exists | The database you are trying to create already exists.
–7 | Queued | The indexing action is queued and it is run when all preceding indexing actions are complete.
–8 | Unavailable | HPE Content Component is about to shut down or indexing is paused. NOTE: For the DREUNDELETEDOC index action, a status of `-8` might mean that the operation is unavailable because NodeTableSecureDelete is turned on.
–9 | Out of Memory | HPE Content Component ran out of memory before the indexing process was completed.
–10 | Interrupted | The indexing action was interrupted.
–11 | XML is not well formed | Indexing failed because the XML is not well formed.
–12 | Retrying interrupted command | HPE Content Component is running an index action that was previously interrupted.
–13 | Backup in progress | HPE Content Component is performing a backup.
–14 | Max index size reached | The indexing job exceeds the maximum indexing size (your license determines the maximum indexing size).
–15 | Max number of sections reached | The indexing job exceeds the maximum number of sections that you can index. (Your license determines the number of sections you can index).
–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 | HPE Content Component ran out of file descriptors.
–20 | LanguageType not found | The language type of the index data was not found.
–21 | SecurityType not found | The security type of the index data was not found.
–22 | Child engines returned differing messages | The child servers returned different messages to the DIH. This code is reported by DIH only.
–23 | Badly formatted index command | The indexing action was rejected by a child server because the syntax is invalid.
–25 | To be sent to DRE | The index action is queued to be sent to the HPE Content Component. This code is reported by DIH only.
–26 | `DREADDDATA`: Data received did not include `#DREENDDATA` | The data in the `DREADDDATA` action did not contain a `#DREEDNDDATA` statement indicating the end of the data.
–27 | Command failed more times than the configured retry limit | The indexing action 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 server is invalid. This code is reported by DIH only.
–29 | Command was redistributed to sibling engines as this engine was either unavailable or not to accept index jobs. | The indexing action was sent to sibling servers because the child server 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` action 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 become available for searching after the next delayed sync cycle, which is specified in the DelayedSync parameter.
–35 | Initializing | 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.
–37 | Failed | The index action has permanently failed.
–38 | Processing in remote engine. | The target server of a DREEXPORTREMOTE operation is processing the exported documents.

If the `IndexerGetStatus` action returns zero or a positive number, this number indicates the percentage of the indexing job that has been completed.

NOTE:

This is an administrative action that can only be sent from HPE Content Component AdminClients (which are set in the HPE Content Component configuration file `[Server]` section).

## Example

    http://12.3.4.56:9000/action=IndexerGetStatus

This action uses port `9000` to request the status of the HPE Content Component index queue. HPE Content Component is located on a machine with the IP address `12.3.4.56`.

## Parameters

Parameter | Description | Required
--- | --- | ---
EpochTime | Modifies the time tags in the response. |
Index | The index ID of a specific index action. |
IndexAction | Controls indexing of IDX and XML files. |
IndexCmd | Filters the response to only those jobs matching the action. |
IndexStatus | The status that index jobs must have to return. |
MaxResults | The maximum number of index jobs to return. |
Priority | Sets the priority of an index job. | see Comments

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
EncryptResponse | Encrypt the output.
FileName | The file to write output to.
ForceTemplateRefresh | Forces the server to load the template from disk.
Output | Writes output to a file.
ResponseFormat | The format of the action output.
Template | The template to use for the action output.
TemplateParamCSVs | A list of variables to use for the specified template.

## Comments

To use Priority, you must set IndexAction to `SetPriority`.

© 2017 Hewlett Packard Enterprise Development LP | Send documentation feedback to HPE Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to AutonomyTPFeedback@hpe.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_HP_HTML5_bannerTitle.htm