Initial configuration of an integrated Db2 Text Search server

The Configuration Tool is a command-line tool that you can use to perform the initial configuration of Db2 Text Search or to change the current configuration.

Before you begin

To customize most of the configuration settings, you must stop the Db2 Text Search instance services.

About this task

The most convenient method for the initial configuration after installation is to use the Db2 installer. For a manual initial configuration as well as any configuration updates, you must use the configuration tool.

Procedure

To perform the initial configuration of the Db2 Text Search server use the following steps. See the topic about the Configuration Tool for further details.

  1. Run the configTool command with the configureParams option to set the configuration path.
    • Review the following configuration options and change the defaults as needed:

      -defaultDataDirectory: location of the text index collections, each collection will be stored in its own subdirectory.

      -logPath: location of Text Search server log and trace files.

      -tempDirPath: path to the temporary directory.

      -installPath: path to Db2 Text Search install directory which is DB2PATH\db2tss on Windows and the DB2DIR/db2tss directory on Linux® and UNIX, where DB2DIR is the location of the Db2 copy.

      -maxHeapSize: maximum heap size of the text search server .

      For example, to configure the defaultDataDirectory and installPath options, issue the following command:
      configTool set -system -maxHeapSize <value> -configPath <full-path-to-configuration-folder>
      Note: The output from running the command configTool printAll -configPath lists the maxHeapSize parameter as startupHeapSize.
    • On Windows operating systems, specify the command as shown. You need to specify only configPath; all of the other parameters are assigned default paths and values.
      configTool
      -configPath absolute-path-to-config-folder
      
  2. Db2 Text Search authenticates text search index administration and text search requests by using an authentication token. Generate the authentication token by issuing the configTool command with the generateToken parameter, as follows:
    configTool generateToken 
    -configPath absolute-path-to-config-folder
    -seed value
    
  3. Specify the HTTP port by issuing the configTool command with theconfigureHTTPListener parameter, as follows:
    configTool configureHTTPListener  
    -configPath absolute-path-to-config-folder 
    -adminHTTPPort port-number 
    
    Note: The value of the port should be between 1024 and 65535.
    The administrative HTTP port allows communication between text search processes using TCP/IP. During the installation of a Db2 database product or during instance creation, you can specify a service name and port if you have root authority. These are used for updating the services file.
  4. Update the services file.
    When you use the Configuration Tool for configuration, the tool does not update the services file. Therefore, you must update the services file manually,
    Note: Only root users can update the services file. Non-root users must have the system administrator run the db2rfe command first.