Share this page

# Configure workers.properties file for a single server

This topic provides details on how to configure workers.properties file for a single server.

In this topic:

## Requirements

As you edit the workers.properties file, keep the following requirements in mind:

- The worker name must match the name of OpenText PPM instance defined for the `KINTANA_SERVER_NAME` parameter in the server.conf file.

- For web servers such as Sun Java System Web Server, you must specify connection_pool_size, connection_pool_minsize, and connection_pool_timeout parameters (see comments in the following Sample file).

- It is recommended to set the connection_pool_timeout value to around 600 seconds. Additionally, set the attribute keepAliveTimeout (if it is set explicitly) or connectionTimeout in the AJP Connector element of the PPM_HOME/conf/jboss/server.xsl configuration file to an analogous value. Note that both keepAliveTimeout and connectionTimeout must be specified in milliseconds. For example, if connection_pool_timeout is set to 600, set Tomcat keepAliveTimeout or connectionTimeout to 600000 milliseconds. For details, see the Apache Tomcat Connectors documentation.

## Sample file

The following sample file shows the contents of a sample workers.properties file for a single-server configuration. Information that pertains to a clustered configuration is commented out.

    # JK 1.2.X configuration file. This file tells the external Web
    # server how to connect to the PPM Servers.
    # Place this file in the location you indicated in your Web
    # server configuration.
    # List of workers for handling incoming requests.
    worker.list=load_balancer
    # If "status" worker is defined (see below), then add it to the
    # list of workers.
    # worker.list=load_balancer,jkstatus
    # Defines the PPM Server instances. The
    # worker name is the value between the first and second period
    # (server1, in this case). Copy this block for each additional
    # server in the server cluster. Make sure the port number
    # matches the port defined in the EXTERNAL_WEB_PORT parameter
    # of the server.conf file, and that the worker name matches the
    # PPM Center instance name defined by the
    # KINTANA_SERVER_NAME parameter of the server.conf file. Please
    # note that, for a server cluster setup, each node in the cluster
    # has its own KINTANA_SERVER_NAME parameter.
    worker.server1.host=localhost
    worker.server1.port=8009
    worker.server1.type=ajp13
    worker.server1.lbfactor=1
    # The following three parameters are required for
    # Netscape-based Web servers such as Microsoft IIS.
    # For Netscape-based Web servers, set the
    # connection_pool_size equal to RqThrottle parameter in the Web
    # server's magnus.conf file. Keep connection_pool_minsize at 1
    # and connection_pool_timeout at 600. For Microsoft IIS, set
    # the connection_pool_size parameter to 512 or higher, as
    # necessary, to accommodate the load.
    # It is recommended that you not use these parameters with
    # Apache-based servers, including IBM HTTP Server, the PPM web
    # server, and Apache itself.
    #worker.server1.connection_pool_size=128
    #worker.server1.connection_pool_minsize=1
    #worker.server1.connection_pool_timeout=600
    # Clustered configurations only.
    # Defines a second PPM Server instance.#
    # worker.server2.host=localhost
    # worker.server2.port=8010
    # worker.server2.type=ajp13
    # worker.server2.lbfactor=1
    #See comments above regarding setting the following three
    # parameters.
    #worker.server2.connection_pool_size=128
    #worker.server2.connection_pool_minsize=1
    #worker.server2.connection_pool_timeout=600
    # Defines the load balancer. Be sure to list all servers in the
    # PPM cluster in the balance_workers group.
    worker.load_balancer.type=lb
    worker.load_balancer.balance_workers=server1
    # Optional. Define a special "status" worker. It enables
    # monitoring of jk plugin status. If enabled, add it to the list
    # of available workers (see above).
    #worker.jkstatus.type=status

For more information about how to configure a server cluster, see Configure a server cluster.

## Configure the workers.properties file

To configure the workers.properties file:

1. Navigate to the <PPM_Home>/integration/webserverplugins/configuration directory and open the workers.properties file in a text editor.

2. Set the worker.list parameter to `load_balancer.`

3. For the single server (or for each node in a cluster), configure the following values:

   1. Set <Worker_Name> to the name of OpenText PPM instance to which this worker connects. This is the name defined by the `KINTANA_SERVER_NAME` server configuration parameter in the `server.conf` file.

      Note: In a clustered setup, each server has its own `KINTANA_SERVER_NAME` parameter.

   2. Set the worker.server#.host parameter to the network address of the machine on which OpenText PPM is installed.

      Note: If the OpenText PPM instance runs on the same machine as the Web server, you can use `localhost`.

   3. Set the worker.server#.port parameter to the external Web port (`EXTERNAL_WEB_PORT` parameter) to use.

   4. Set the worker.server#.type parameter to `ajp13`, which is the protocol used to connect to the remote server.

   5. Set the worker.server#.lbfactor parameter to the load balancing factor used to distribute load to the PPM Servers.

      If all servers can handle approximately the same load, assign "1" to each server. If a server can handle twice as much load as another server, assign "2" to that more robust server and "1" to the other server.

4. Set the worker.load_balancer.type parameter to `lb`.

5. Set the worker.load_balancer.balance_workers parameter to a comma-delimited list of all servers in the cluster (as configured in step 3).

   Example:

       worker.load_balancer.balance_workers=worker1,worker2,worker3

6. (Optional) To enable the JK status page, add a worker of special type “status” (`worker.jkstatus.type=status`), and then add this worker to the list of workers (`worker.list`).

https://admhelp.microfocus.com PPM 8942
Tips to improve your search results... OpenText™ Project and Portfolio Management Help Center PPM Help 26.2-26.3 All View Local Help Center View Online Help Center Version: