Configuring a text search server

After installing a text search server, use the Configuration Tool to customize some of the default properties.

Before you begin

Before configuring the properties for the text search server, make sure that the text search server is shut down. The Db2® database administrator can use the SYSPROC.SYSTS_STOP stored procedure to stop text search functions until configuration is complete. However, when the server is running, you can run the options to print the current authentication token, the server port, and the current properties of the system.

About this task

You can configure some of the system-level properties and the security properties.

System configuration:

The following list shows the command options for the system-level properties:
  • configureHTTPListener: Configures the server port and host name of the text search server
  • configureParams: Configures the parameters for the collection
  • generateToken: Generates the authentication token and encryption key
  • printToken: Prints the authentication token and encryption key
  • printAdminHTTPPort: Prints the administration HTTP port number
  • printAll: Prints all of the current values for the properties that you can configure
  • help: Displays the help message for the Configuration Tool

Security configuration:

Every API request from Db2 to a text search server is authenticated by using an authentication token. This authentication token is generated during installation of the text search server. The maximum length of the token string is 32 bytes. The Db2 database administrator must make note of and remember the authentication token so that he can copy the token to the SYSIBMTS.SYSTEXTSERVERS administration table.

An encryption key is a string of 32 bytes that is used to encrypt user IDs and password information, which the text search server needs to connect to Db2. The encryption key is generated and displayed during installation of the text search server. The Db2 database administrator must copy this encryption key to the SYSIBMTS.SYSTEXTSERVERS administration table, where it can be used by the SYSFUN.SYSTS_ENCRYPT user-defined function.

If the authentication token and encryption key are absent, the text search server creates them by using a random seed. You can obtain the current authentication token and encryption key values by running the Configuration Tool and printing the values.

Procedure

To configure the properties for the text search server:

Run the Configuration Tool by entering the appropriate command, as follows:
Option Description
On a Linux or zLinux server
configTool.sh  
configuration_command  
-configPath value  
[-locale value] 
-command_specific_arguments
On a Windows server
configTool.bat  
configuration_command  
-configPath value  
[-locale value] 
-command_specific_arguments

Example

For example, to print the current authentication token on a Linux server, use the following command:
configTool.sh printToken -configPath /opt/ibm/search/config