Configuring a stand-alone Db2 Text Search server

Use the configuration tool to customize some default properties after installing the stand-alone Db2 Text Search server. You can configure the relevant system level properties and the security properties for your system.

Before configuring the properties, ensure that the stand-alone Db2 Text Search server is shut down and that the text search services are stopped. Do not restart the text search server until you finish both the configuration of the stand-alone text search server and complete required configuration updates of the enabled databases in the associated Db2 instance.

You can use the configuration tool to view text search server properties even when the text search server is stopped.

System configuration

Make sure to review and configure at minimum the following properties with the configuration tool:
  • configureHTTPListener: Configures the Db2 Text Search server port and host name
  • generateToken: Generates the authentication token and encryption key
  • defaultDataDirectory: Configures the parameters for the collection
Remember: If the value for configPath contains blanks, you must enclose the value in quotation marks.

For details, and additional optional configuration see the topic about the configuration tool for Db2 Text Search.

Security configuration

Every API request from a Db2 database server to a stand-alone Db2 Text Search server is authenticated by an authentication token. An initial token is generated during the installation of the stand-alone text search server.
  1. Use the configuration tool to explicitly provide a seed value and generate the authentication token. The maximum length of the token string is 32 bytes.
  2. Run the configuration tool on the Db2 instance to set the matching token value.
  3. Store the connection information including the token in the SYSIBMTS.TSSERVER administrative view for each enabled database.

You can use the Db2 Text Search configuration tool to show the current authentication token and encryption key values. However, it is impossible to determine the seed value used by the stand-alone Db2 Text Search server. Generate the token explicitly with the configTool utility and update the master configuration on the Db2 instance to match the configured values for the token.

To configure the properties for the text search server run the configuration tool by entering the appropriate platform-specific command:
  • On Linux® and UNIX platforms:
    configTool.sh configuration_command -configPath value 
[-locale value] -command_specific_arguments
  • On Windows platforms:
    configTool.bat configuration_command -configPath value 
[-locale value] -command_specific_arguments
For example, to print the current authentication token on a Linux server, use the following command:
configTool.sh printToken -configPath /opt/ibm/ECMTextSearch/config
Note: For a stand-alone Db2 Text Search server on Linux and UNIX platforms, the configuration tool command must be specified in full including the .sh suffix. Only the integrated Text Search server supports the script names without the suffix.