VERIFIED SOLUTION i
X

How to enable indexerd (new indexer)

UPDATED: October 18, 2017


As of Vault 6.x there is a new index engine that can be used.  It takes more CPU and memory than the old indexer but is more efficient at handling multiple requests.  It is turned off by default in a new 6.0 / 6.1 install.

How do you turn this on and start using it?



Vault Indexer as a Service
Indexer as a Service
The Indexer as a Service is a new operational model that runs the indexing as a service within
Vault. In release 6.0, the Indexer as a Service was only available for Vault under Windows
non-unicode databases. With release 6.1, it is available on all supported Vault platforms
(Windows, AIX, Sparc Solaris, and x86 Linux) and supports Unicode databases.
Notes:
• Under Windows, the Indexer as a Service runs as a Windows service.
• Under AIX/Solaris/Linux, the Indexer as a Service runs as a daemon process.
As a service, the indexing activity is performed using a central service (indexerd) that all Vault
components communicate with for their indexing related activity. With the legacy indexers
(standard and Unicode), the access logic for reading and updating the index files was included
in each component.
The Indexer as a Service (indexerd) is installed by default. The default setting for databases is
still the old indexer (referred to as “legacy indexer”). If you set up the correct modedefault for a
database in the database.ini file, then the database will be under the control of the Indexer as
a Service.
Improvements
The Indexer as a Service offers the following improvements to indexing:
• Robustness: The Indexer as a Service is
more tolerant of sudden system failures.
If the indexer is stopped suddenly, the
index.dr2 file will still be valid.
Speed: The Indexer as a Service can achieve a higher throughput rate because the index
activities are now multi-threaded.
Note: A multi-core processing platform is required because little or no speed
improvement may be observed on a single core platform. In addition, the new structure of
the index itself will allow for a more consistent throughput when adding or updating
index record regardless of the index size. The legacy indexers will slow down adding
records as the index grows larger.
• File and Backup changes:
The legacy indexer stores its index information in the index subdirectory. Each database
has a series of files with a file type of dri that represents the index information.
The Indexer as a Service stores all of its
index information for all of the
databases in a single file (index.dr2).
The index.dr2 file will be stored in the
index path (<drpath>\server\index) for
Windows and (<drpath>/server/index) for AIX/Solaris/Linux. If your Vault system index
files are currently backed up, then the backup of the indexer.dr2 file should be added to
the process. If you create a backup directory by using the backup flag file, then the
index.dr2 file will be copied as part of the copying of the index directory.
Resource Requirements
The Indexer as a Service is a heavily multi-threaded and memory intensive service and should
only be enabled on multi-core systems with at least 16 GB of memory (at least 3 GB of free
memory in normal operation). If the platform also hosts other applications than Vault, the
total memory requirement will be higher.
A Vault system that converts an existing database to use the Indexer as a Service can expect to
see the service use a significant amount of memory and processing power while it is indexing.
This may affect the operation of other
components (both Vault and non-Vault) if the
capacity of the underlying system is
insufficient to accommodate the Indexer as a
service. You should expect the Indexer as a
Service to consume the most resources
during a job loading operation or during a
re-index operation.
Enabling the Indexer as a Service
To enable a database to use the Indexer as a Service, the database.ini file must be modified.
Refer to “Database initialization file” on page 60 for further information.
Converting an existing database to use the Indexer as a Service
If there is already a database using the legacy indexer, it can be converted to use the Indexer as
a Service by following these steps:
1. Stop Vault (including the Indexer as a Service).
2. Backup the legacy index files (.dri files in the index/name_of_database subdirectory). Note
the name/date/time of the last job added to the legacy database. This can be determined
by examining the .drd files in the docdata directory.
3. Update the database.ini file to mark the database as using the Indexer as a Service
(ModeDefault=2).
4. Restart Vault services (including the Indexer as a Service)
5. Reindex all the jobs that were part of the database using the .reindex flag file. This process
involves creating a flag file in the process directory for each job that was previously placed
in the database.
• Under Windows, the vaultflag.bat file can assist in creating these flag files.
• Under AIX/Solaris, and Linux, the script file vaultflag.sh can be used.
Converting a database back to the legacy database
To convert a database back to using a legacy indexer:
1. Stop Vault (including the Indexer as a Service).
2. Update the database.ini file to mark the database as using the legacy indexer (remove
ModeDefault=2).
3. Restart Vault services.
4. Reindex all the jobs that were submitted since the database was converted to the Indexer
as a Service. This can be determined by examining the .drd files in the docdata directory. A
reindex flag file will need to be created in the process directory for each job that should
be reindexed.
• Under Windows, the flag.bat file can assist in creating these flag files.
• Under AIX/Solaris/Linux, the
vaultflag.sh script file can be used..
Installation Changes
The Vault Windows installer will install a
service with a description of Vault Indexer. The service module name is indexerd.exe. If you are
not using the Indexer as a Service, it is recommended that you stop the service and change the
service property that automatically starts the service at boot up.
The Vault AIX/Solaris/Linux installer will install a "vault" script that will allow you to start and
stop the Vault components (indexer included). If you are not using the Indexer as a Service in
your AIX/Solaris/Linux system, please use the vault_noindexer script to start and stop the Vault
system.
Specifying "vault_noindexer start" will start Vault without starting the Indexer as Service
daemon.
Log Files
The Indexer as a Service will create log files in the server\log directory. The log file names will
be indexerd followed by a date and time stamp. The filetype will be "log" for the Windows
version and “server/log” for the non-Windows versions.. The format of the log files will be the
same as for other Vault services.
An example of the filename is: indexerd.20120131.115528.5300.log
e2util utility
The e2util utility will work with indices controlled by the Indexer as a Service. e2util will
determine if the index is a legacy or an Indexer as a Service index based on the ModeDefault
setting for the database in the database.ini file.
Indexcheck utility
The indexcheck utility can work with the indexer as a service by using the new -mode option.
Refer to “indexcheck” on page 82 for indepth information on the following parameters:
• -mode
• -copy
• -dbinfo
• -crc
Unsupported Utilities
The utilities that will not work with the indexer as a service are:
• Databasecheck
• Scanidx
New initialization file
The Indexer as a Service uses an initialization file named indexerd.ini. which contains two
options to control the indexer as a service thread count and the indexer as a service cache
size. For more information, refer to “Vault initialization files” on page 31.
Trouble Shooting
• What happened: Queries or job loading appears to have stopped.
What to do: Check the status of the Indexer as a Service. Queries and job loading will
start but not progress if the indexer service is not running.
• What happened: indexcheck reports that it cannot find a dri file and the index is
controlled by the Indexer as a Service.
What to do: Ensure that -mode: 2 was specified on the command line.
• What happened: The indexer appears to be using all the processor capacity and not
allowing other work to progress.
What to do: Try reducing the thread count. Specifying more threads than the system can
service can cause overall performance to degrade.

Environment Details

Vault Windows 6.0, all platforms Vault 6.1

Downloads

  • No Downloads