Configuration Tool

Use the Configuration Tool to customize configuration settings after you install a text search server.

To customize most of the configuration settings, you must stop the text search server before running the Configuration Tool. However, when the server is running, you can run the options to display the current authentication token, the server port, and the current properties of the system.

Command

The command that you issue to run the Configuration Tool depends on whether the text search server is installed on a Linux®, Linux on IBM Z®, or Windows server.

Table 1. Commands to run the Configuration Tool
On a Linux or Linux on IBM Z server	On a Windows server
`configTool.sh configuration_command -configPath value [-locale value] -command_specific_arguments`	`configTool.bat configuration_command -configPath value [-locale value] -command_specific_arguments`

Global arguments

-configPath: Specifies the fully qualified path to the configuration directory, such as /opt/ibm/search/config. If this value contains blanks, you must enclose the value in quotation marks. This global argument is mandatory.
-locale: Specifies the five-character locale code, such as en_US for English or de_DE for German. The default value is en_US.

Command options

The Configuration Tool supports the following command options.

configureHTTPListener

Initializes the text search server and configures the HTTP port for the text search application, the administration HTTP port, and the hostname. After installing a text search server, you need to run this command to initialize the text search server.

You can configure the following parameters:

-adminHTTPPort: Specifies the administration HTTP port number.
-searchHTTPPort: Specifies the HTTP port number for the text search application. This parameter is optional.

Important: You must specify the same single value for both the administration HTTP port number and the HTTP port number for the text search application. Do not modify only one of these values later by using the Configuration Tool options -adminHTTPPort or -searchHTTPPort.

configureParams

Specifies the system parameters that you can configure. You can configure the following parameters:

-adminHTTPPort: Specifies the administration HTTP port number. This parameter is optional.
-searchHTTPPort: Specifies the HTTP port number for the text search application. This parameter is optional.
-configPath: Specifies the fully qualified path to the configuration directory, such as /opt/ibm/search/config. If this value contains blanks, you must enclose the value in quotation marks. This parameter is mandatory.
-logPath: Specifies the fully qualified path to the log directory. This parameter is optional.
-tempDirPath: Specifies the fully qualified path to the temporary directory. This parameter is optional.
-defaultDataPath: Specifies the fully qualified path to the default data directory for the text search index. This parameter is optional.
-installPath: Specifies the fully qualified path to the installation directory for the text search server. This parameter is optional.
-logLevel: Specifies the log level for system messages in the log file. The default level is INFO for informational. Additional options are FINE, FINER, FINEST, OFF, WARNING, and SEVERE. This parameter is optional.

printToken

Prints the current authentication token and encryption key.

printAdminHTTPPort

Prints the current value for the administration HTTP port.

printAll

Prints all of the current values for the options that you can configure with this tool.

generateToken

Generates the authentication token.

-seed: Specifies a random string that is used when generating the authentication token.

help

Prints the usage information for this tool.

Examples

Example 1: On a Linux server, use the following command to initialize the text search server and configure the available parameters:

configTool.sh configureHTTPListener 
-configPath <absolute path to config folder> 
[-locale <five-character locale string>] 
–adminHTTPPort <admin HTTP port number>
[–searchHTTPPort] <search HTTP port number>

Example 2: On a Windows server, use the following command to generate an authentication token:

configTool.bat generateToken –configPath 
[-locale <5-character locale string>] 
–seed <any random string>

Example 3: On a Linux server, use the following command to print the current authentication token:

configTool.sh printToken -configPath /opt/ibm/search/config