SUMMARY:
This solution details the contents of the wtb.cnf file for the
WebSpeed Transaction Server for Windows NT.
EXPLANATION:
(Lines beginning without the pound sign (#) are comments/descriptions.
Lines with a (#) contain keywords/information that the
transaction server uses.)
WebSpeed Transaction Broker Defaults file. Windows NT Version:
OPTIONAL: BrokerPort.
BrokerPort sets the TCP/IP port number that the broker listens
to for Web requests. Web requests start in a Web browser, travel
to the Web server, then to the Messenger, and finally to the
Broker through the port number you specify. In general, you
should specify a port number greater than 1024. On some systems,
specifying a number upwards of 5000 or so is preferable. The
port number you specify must be free and available on the
machine where you started the Broker.
On Windows NT, the services file is located in the
%SystemRoot%\system32\drivers\etc directory. To determine if a
port is available:
findstr <port-number>
%SystemRoot%\system32\drivers\etc\services
If the port number does not appear in the output of this
command, the port is available.
In addition to checking the services file for reserved
ports, the system can be checked for active ports.
On Windows NT, the following command will display any
active ports:
netstat -p tcp -a | findstr <port-number>
The Broker doesn't require a named port in the services file or
NIS services. However, you probably should add entries to your
services file for the BrokerPort and the range of ports between
AgentMinPort and AgentMaxPort.
This allows other users on the system to see that you have
reserved these ports.
After the Broker receives a request through the port number you
specify, the Broker tells the Messenger which Agent is available
to handle the request. The Messenger then connects directly to
the Agent using a different port number that is specific to the
Agent.
You must know the Brokerport number when you use the wtbman
utility to manage the Broker at runtime. In addition, the
Messenger Interface File executed by the Web server must be
configured to use this port.
Default: 2000
#BrokerPort 2000
OPTIONAL: AgentMinPort and AgentMaxPort
AgentMinPort sets the minimum port number that is available for
an Agent process. As with the BrokerPort parameter, you should
generally use port numbers greater than 5120, although you can
specify lower numbers. This parameter, together with the
AgentMaxPort parameter, is useful for configuring ports visible
through a firewall.
AgentMaxPort sets the maximum port number that is available for
an Agent process. As with the BrokerPort parameter, you should
generally use port numbers greater than 5120, although you can
specify lower numbers.
As each Agent starts up, it searches for a free port number to
use for its communication with the Messenger processes. This
search starts with the port specified by the AgentMinPort option
and stops with the port specified by AgentMaxPort option.
Default AgentMinPort: 5121
Default AgentMaxPort: 7096
#AgentMinPort 5121
#AgentMaxPort 7096
OPTIONAL: StartInstances
StartInstances sets how many Agents the Broker invokes as
startup. The Broker does not allow the pool of Agents to fall
below this value. The default setting is low because it is useful
to start with a small number of Agents and gradually increase the
number. This allows you to see how well your system handles the
increasing load demands of the additional Agents.
Default: 2
#StartInstances 2
OPTIONAL: BeginNewInstances
BeginNewInstances sets a threshold value that the Broker
uses to start additional Agents. The Broker always tries
to keep Agents available to service incoming requests.
However, if all Agents are currently actie when a request
comes in, then the Broker must start a new Agent to
service the request. Unfortunately, the request cannot
be serviced until the Agent is fully operational. To
avoid this delay, the Broker monitors the status of the
Agents and starts a new Agent when the threshold value is
reached. If the Broker determines that most of the
Agents are in a BUSY, LOCKED, or LIMBO state, the Broker
starts a new Agent before it is actually needed. You
determine the Broker's threshold by setting the
BeginNewInstances parameter to a positive value. When
the number of available Agents is equal to the value of
BeginNewInstances, the Broker starts a new Agent.
However, the Broker can only successfully start a new
Agent if:
- The total number of Agents does not exceed the value
of MaxInstances.
- Network ports are available (determined in part by
AgentMinPort and AgentMaxPort parameters).
- The total number of Agents does not exceed the
number of licensed users on the database server.
For example, if you set BeginNewInstances to 1 and the
number of running agents is 5, 4 of which are either in a
BUSY, LIMBO, or LOCKED state, the Broker starts another
Agent. This process continues until the maximum number of
Agents is reached (set by MaxInstances).
Default: 1
# BeginNewInstances 1
OPTIONAL: MaxInstances
The max number of Agents to launch. This number cannot
exceed the number of ports allowed by the AgentMinPort
and AgentMaxPort variables.
Default: 10
# MaxInstances 10
OPTIONAL and for UNIX only: User and Group
User sets the user ID for the Broker process. This
parameter tells the Broker what User ID to associate with
the running Broker and the Agents started by the Broker.
Group sets the group ID for the Broker process. By
placing all of its Agents within a single group, the
Broker can more quickly shutdown the Agents. If there
are multiple Brokers running on the same machine, make
sure the configuration file for each Broker uses
different group IDs.
Default: #-1
User nobody
Group nobody
REQUIRED: DefaultDirectory
DefaultDirectory sets the default directory for the
Broker. During startup, the Broker changes into this
directory, making it the current working directory for
itself and all of its Agents. In addition, this directory
is the default directory for the Broker's error and
session log files. You must specify an absolute pathname.
When the Broker reads this configuration file, the Broker
prefixes this pathname to all other relative pathnames
specified in this file (such as for ErrorLogfilename and
SessionLogFilename). You must create the directory before
you run the Broker. If the directory does not exist, the
Broker cannot create it at runtime. Specifying
environment variable names is not supported.
Default: none
# DefaultDirectory c:
OPTIONAL: ErrorLogFilename
ErrorLogFilename sets the location of the Broker's error
log file.If you specify a relative pathname, the Broker
prefixes the value of DefaultDirectory to the pathname.
If you do not specify a pathname, the Broker creates an
error.log file in the Broker's default directory.
# ErrorLogFilename error.log
OPTIONAL: SessionLogFilename
SessionLogFilename sets the location of the Broker's
session log file. If you specify a relative pathname, the
Broker prefixes the value of DefaultDirectory to the
pathname. If you do not specify a pathname, the Broker
creates a session.log file in the Broker's default
directory.
# SessionLogFilename session.log
REQUIRED: ExecutableFilename
ExecutableFilename sets the location of the Agent
executable. This parameter tells the Broker the location
and name of the Agent executable. On UNIX, the default is
<install-path>/bin/_wta. On Windows NT, the default is
<install-path>\bin\_wta.exe. This value is configured by
the installation process and should not need changing.
Specifying environment variable names is not supported.
# ExecutableFilename C:\WSRT\bin\_wta.exe
REQUIRED: AgentParams
AgentParams sets all command-line parameters necessary to
start your Agents. This must include the installation
path to web-disp.p or an equivalent startup procedure
capable of running web objects. Below is a list of the
most commonly needed parameters:
-weblog
This parameter forces system error messages from any
Agent to the Broker error log file. This is appropriate
for a production environment to prevent system errors
from showing up in the browser.
-db <path-to-database>
This parameter specifies the full path to a local
Progress Version 8.x database or the name of a remote
database or DataServer if the -H and -S options are
specified.
-H <hostname>
This parameter specifies the hostname where the remote
Progress database or DataServer schema holder is running.
-S <service-name>
This parameter specifies a named TCP/IP service on which
the remote PROGRESS database or DataServer schema holder
is running. This name must exist in the services file.
-N <protocol>
This parameter specifies the network protocol used to
connect to the remote database. Typically set to tcp.
-pf <parameter-file>
This optional parameter specifies a text file that can
contain database connection or session parameters such as
those described above. The parameter file must have a .pf
file extension. You generally should place this file in
the Broker's default directory. Putting database
connection parameters in a parameter file is useful when
you also want to connect to the specified database(s) or
DataServers from an interactive session for for
administration purposes.
The default setting for the AgentParams is as follows:
AgentParams -p web/objects/web-disp.p -cpstream iso8859-1
Reference to Written Documentation:
Progress System Administration Guide.
Progress System Administration Reference.