Page tree
Skip to end of metadata
Go to start of metadata


The Indexes page shows statistics and lets you perform actions on indexes and their sub-components:

View incoming links.

Working with Indexes

To view indexes, select System Management -> Indexes in the AIE Administrator. The Indexes screen appears showing data for the indexes in your system.


Indexes have multiple index engines only if the system index is configured for partitioning or redundancy.

The following statistics are provided for each index and its underlying index engines.




The current status of the index engine.

COMMITTINGEngine is performing a commit operation.
INACTIVEEngine is not active.
STARTINGEngine is starting.
OPTIMIZINGEngine is performing an optimize operation.
INDEXINGEngine is actively receiving documents.
RECOVERINGEngine is recovering.
MERGINGEngine is merging segments.
ERROREngine is in error and requires intervention.
LOCKED (or LOCKED/STARTING)See Index Locking for details. (applicable to writers only)

active docs

The total number of committed documents. This number indicates the number of queryable documents.

total docs

The total number of documents in the index including those documents that have not been committed.

system docs

The total number of internal Attivio documents. This number includes documents in hidden zones such as security prinicpals and ACLs as well as those created by the searchanalytics module.


The number of queries since the index last started.

index size

Index size.

Performing Index Actions

Note that you can click:

  • commit to flush all outstanding documents to disk as a new segment. Uncommitted segments are then made searchable for future queries. See commits for further details.
  • optimize to send an optimize message to the ingestion workflow. Optimization aggressively merges index segments to create a minimal number of large, deletion-free segments.   See Optimize Message for further details.
  • delete all to delete all data from an index.

    As there is no undo for this action, be very sure that this is what you want to do. See Deleting the Entire Index for details.

  • xml status to download a diagnostic file for the index.
  • Hide the navigation pane with the show/hide button to see more or less of the status tables as desired.

Index Locking/Unlocking

An Attivio index partition can become locked (for writing) to guard against the loss of data. The reasons for this occurring can vary and is more likely in clustered environments involving YARN-managed indexes. Consult with Attivio Support if this is occurring in your environment on a consistent basis.

Partitions will be locked for one of two reasons:

  1. The Java process hosting the index partition is in fact still running but the process is NOT registered with the content dispatcher. This can be due to ZooKeeper timeout, busy node, long running garbage collection, etc. In this case, the indexer is actually still running, but it will appear as LOCKED. In this case, you should not unlock the partition. There are two things you can do:

    1. Wait for the partition to shutdown cleanly or otherwise recover.

    2. Kill the process manually, and then unlock once the process is dead.

  2. The Java process hosting the index partition was terminated forcefully/abruptly (kill -9). In this case it is safe to unlock the partition from the UI.

When a partition is LOCKED, the "LOCKED" text will be a link. If this link points to a url that successfully loads when clicked, then you have the first case (still running). If the link points to a url that cannot be accessed (connection failed), then you are looking at the latter case and you should unlock the partition.

  • No labels