|
ZBrokerServer.ini
Configuration File
Contents
Introduction
Document Conventions
File Location
Sections and Variables in ZBrokerServer.ini
Authorizing Remote Z39.50 Clients by IP Address
ZBrokerServer.ini File Example
Introduction
The
ZBrokerServer.ini file contains configuration information for the OCLC
SiteSearch WebZ software to allow external Z39.50 clients to access the
ZBase server.
The
ZBrokerServer.ini file contains several sections (appearing as [section_name]),
and each section contains one or more variables that define various server
operations. This document describes the sections and variables in ZBrokerServer.ini,
with a separate table for each section. A ZBrokerServer.ini
file example appears after the tables.
| Important
Note: |
Upon installation,
the ZBroker server is not configured to immediately start with the
WebZ system. Although this configuration file is included in your
environment, you must add the server to the OpServe.ini
file before the Operations (OpServe) component can access ZBroker
and allow external clients to connect to the server. |
Document
Conventions
- <WebZ_root>
is the location of your WebZ environment.
- "Default value"
is the value of a variable when WebZ was initially installed on your
system.
- Unless otherwise
specified, all variables must contain a value; they cannot be left empty.
- "External Z39.50
clients" refers to clients who search ZBase directly without going through
the JaSSI server and the WebZ interface.
File
Location
The
ZBrokerServer.ini file is located in the <WebZ_root>/ini
directory of your SiteSearch installation.
Sections
and Variables in ZBrokerServer.ini
ZBrokerServer.ini
contains the following sections:
[ZBroker]
Section
|
Variable
|
Description
|
Default |
|
port
|
Defines
the port that the ZBroker server will run on. Port 210 is the standard
Z39.50 access point. A ZBroker server connects to this port so that
external clients have a consistent port to connect to for ZBase
access.
| NOTE: |
The
ZBroker files should have the same owner as that of your other
SiteSearch files. See SiteSearch
Environment Ownership for more information.
However,
in a UNIX environment, your operating system may require that
processes that control port numbers under 1024 be owned by
the root account. To conform to good UNIX system administration
practices, we recommend that you use another workaround or
choose a port number greater than 1024 for the ZBroker port
instead of making the root account the owner of the ZBroker
process.
|
|
210
(the standard Z39.50 access point) |
|
IniFileRoot
|
Specifies
the location of the configuration files for the WebZ system. WebZ
appends this path to all of the configuration files referenced in
the ZBrokerServer.ini file that do not have a full path name.
|
<WebZ_root>/ini/ |
|
MaxClientConnections
|
Defines
the maximum number of simultaneous users allowed on a ZBroker server
at one time. If a server reaches its maximum number of users, the
server stops "listening" to the specified port, and the ZBroker
server starts a new ZBroker server to accept new remote sessions
from the port. The original server shuts down after all of its users
log off or time out.
|
100 |
|
StartCommand
|
Specifies
the location of the startup script for ZBroker and the command used
to start a ZBroker server. Only the ZBroker server itself uses this
command to launch a new server as described for the MaxClientConnections
variable.
|
<WebZ_root>/scripts/ssmgr.hostname
zbroker
where:
- <WebZ_root>/scripts/
is the location of the script
- ssmgr.hostname
zbroker is the start command
|
UseIPAsAutho
(beginning with version 4.1.2) |
Indicates
that you want to authorize non-SiteSearch Z39.50 clients that access
your WebZ environment via ZBroker by their Internet Protocol (IP)
addresses. Possible values are TRUE (authorize by IP address) or
FALSE (do not authorize by IP address). See Authorizing
Remote Z39.50 Clients by IP Address for more information.
|
FALSE (if
not specified) |
Back
to Sections list
[ZServer]
Section
|
Variable
|
Description
|
Default |
|
name
|
Provides
the name of the WebZ server that the ZBroker forwards Z39.50 requests
to, allowing external Z39.50 clients to search local databases and
remote Z39.50 and non-Z39.50 resources.
|
ZBase
(do not change this value)
|
|
inifile
|
Defines
the name and location of the server configuration file for the WebZ
server specified in the name variable in this section. The system
precedes this value with the value of the IniFileRoot
variable in the [ZBroker] section of this file.
|
servers/ZBase.ini |
Back
to Sections list
[Timers]
Section
|
Variable
|
Description
|
Default |
|
UserSessionIdleTimeout
|
Specifies
how long, in seconds, a user session remains idle before the ZBroker
automatically logs the user off the server.
|
900
(15 min.) |
|
ReadTimeout
|
Specifies
the amount of time, in seconds, that the ZBroker server should wait
on a response from another server across an open socket.
|
120
(2 min.) |
|
HouseKeepingInterval
|
Defines
how often, in seconds, ZBroker should perform housekeeping tasks.
ZBroker ensures that the rolling intervals for servers, users, and
statistics logs function correctly and flushes the logs if necessary.
The server also reports its current system load statistics to the
OpServe.
This variable
does not control how often garbage collection occurs; the Java Virtual
Machine performs garbage collection dynamically.
|
600
(10 min.) |
Back
to Sections list
[ServerTrace]
Section
|
Variable
|
Description
|
Default |
|
traceLevel
|
Specifies
the level of detail in the trace
messages written to the ZBroker server log file.
You can
also set ZBroker logging manually with the settrace
command in the ssadmin interface.
|
TRACE_NONE |
|
traceDirectory
|
Provides
the location of the directory ZBroker uses to store its server logs.
|
<WebZ_root>/logs |
|
traceFilename
|
Provides
the base name that ZBroker uses to write out server log files. ZBroker
adds the sessionid, time, and date stamps to this base name before
saving the server log.
|
zbroker.serverLog |
Back
to Sections list
[SessionTrace]
Section
|
Variable
|
Description
|
Default |
|
traceLevel
|
Specifies
the level of detail in the trace
messages written to the ZBroker user log file.
You can
also set ZBroker logging manually with the settrace
command in the ssadmin interface.
|
TRACE_NONE |
|
traceDirectory
|
Provides
the location of the directory where ZBroker stores user log files.
|
<WebZ_root>/logs |
|
traceFilename
|
Provides
the base name that ZBroker uses to write out user log files. ZBroker
adds the sessionid, time, and date stamps to this base name before
saving the user log.
|
zbroker.userLog |
Back
to Sections list
[Operations]
Section
|
Variable
|
Description
|
Default |
|
OpsConfigDir
|
Specifies
the location of the Operations directory where ZBroker reads server
load balancing values. The other WebZ servers have access to ZBroker's
load balancing values in this directory.
|
<WebZ_root>/ops |
|
ServerType
|
Identifies
the type of server defined in this configuration file. The OpServe
uses this information to execute administrative tasks for the ZBroker
server.
|
ZBroker
(do not change this value) |
|
HostMapIni
|
Defines
the location of the host environment configuration file used by
the WebZ software. This file contains information such as the ID,
name, and load distribution percentage of the servers hosting the
WebZ system. This file is located in the directory specified by
the IniFileRoot variable in the [ZBroker]
section of this file.
|
HostMap.ini |
Back
to Sections list
Return
to Contents
Authorizing
Remote Z39.50 Clients by IP Address
Beginning with
SiteSearch 4.1.2, follow these steps to configure and test IP authorization
of remote Z39.50 clients that access your SiteSearch environment.
ZBroker/ZBase
Configuration
Verifying
Proper ZBroker IP Authorization
5. Turn on
logging for the ZBroker server. Within ssadmin,
enter the following command:
settrace -t
zbroker trace_all ServerLog
|
|
6. Check
the log for the zbroker server: <WebZ_root>/logs/zbroker.serverlog.date.time.server#-port.
The ZBroker
Server Initialization section at the top of the log should contain
this line near the bottom of this section:
Use IP as
Autho : true
|
Verifying
that Authorization by IP Functions Correctly
7. Turn on
logging for the Access server. Within ssadmin,
enter the following command:
settrace -t
access trace_all ServerLog
|
|
8. Access
ZBase via ZBroker. Note the IP address of the system you are using.
|
| 9. Check
the log for the Access server: <WebZ_root>/logs/zbroker.serverlog.date.time.server#-port.
Make sure that
the log contains the IP address of the system you just used to access
ZBase. |
Return
to Contents
ZBrokerServer.ini
File Example
# ZBroker.ini
# program to manage external z39.50 connections
# from other than SiteSearch 4.0 clients
# replacement for wrkc process
# to run on port 210, must have 'root' as
# the owner of the process.
[ZBroker]
port = 210
IniFileRoot = <WebZ_root>/ini
MaxClientConnections = 100
StartCommand = <WebZ_root>/scripts/ssmgr.hostname zbroker
[ZServer]
name = ZBase
inifile = servers/ZBase.ini
# Given in seconds
[Timers]
UserSessionIdleTimeout = 900
ReadTimeout = 120
HouseKeepingInterval = 600
[ServerTrace]
traceLevel = TRACE_NONE
traceDirectory = <WebZ_root>/logs
traceFilename = zbroker.serverLog
[SessionTrace]
traceLevel = TRACE_NONE
traceDirectory = <WebZ_root>/logs
traceFilename = zbroker.userLog
[Operations]
OpsConfigDir = <WebZ_root>/ops
ServerType = ZBroker
HostMapIni = HostMap.ini
See Also
WebZ
Configuration Files
WebZ System Administration
Description of the WebZ System
|