Operating the indexer

This section describes the use of the indexer in a single-server environment. Please contact the ConSol CM support or your ConSol CM consultant for information about the indexer in a cluster.

Indexer directory structure

The data directory is set using the system property cmas-core-shared, data.directory. The structure and content of the index directory are described in ConSol CM data directory.

Monitoring the indexer

The indexer status is displayed on the Index page of the Web Admin Suite. Alternatively, you can check the system property cmas-core-index-common, index.status. The following status can occur:

• GREEN: The index is fine. No action is required.
• YELLOW: There are solvable problems with the index, either pending administrative changes or pending retry tasks. You need to perform the required action in the Web Admin Suite.
• RED: There are errors. You need to rebuild the index in the Web Admin Suite.

In addition, you need to monitor the file system where the index is located to ensure that there are enough space and RAM available, that the file system is available (if it is mounted on another server), and that the synchronization between the master and slave nodes works correctly (if you have a clustered environment).

In addition, the following problems can indicate that the indexer is not running smoothly:

• The search in the Web Client does not work correctly. Newly created objects are not found or the search does not work at all.

• Incoming emails are not processed (processing requires a search for case and contact).

Backup and recovery of the index

All ConSol CM indices are stored on the file system. Please follow the following procedure to create an index backup, in order to avoid inconsistent states:

1. Back up the index using the following HTTP request. Replace the variables with the correct values for you system (URL, and name and password of the admin user):

   wget http://${indexing.master.host:port}/index/snapshot --user ${admin} --password ${password} -Obackup.jar

   This will download the full index into a backup.jar file. The received full snapshot will have the timestamp of the moment when the command was executed.

Please perform the following steps to restore the index:

1. Stop the ConSol CM server.

2. Clean the directories inside the index folder.

3. Unpack the backup.jar file to the index folder.

4. Restart the ConSol CM server.

5. Rebuild the index for the missing time period (between the creation of the backup and the restore) using the Web Admin Suite.

Fine-tuning the index

If the search is slow or you notice delays, you might increase the number of indexer threads in the CM system property cmas-core-index-common, index.task.worker.threads. The default value is 1. Do not set the value to a number higher than the number of CPU cores of the machine.