|
Access
Server Configuration Files
Contents
Introduction
Document Conventions
Sections and Variables in Access Server Configuration
Files
File Example
Introduction
The Access server
configuration files contain configuration information for the Access servers
in the Access component of the Open SiteSearch software. The Access component
allows you to provide patron authentication and profiling for WebZ users
using a relational database management system (RDBMS). If you have Database
Builder and are using its Record Builder application, you can also use
the Access component to provide authentication for Record Builder staff.
See Access Component Overview for more
information about the Access component.
There are separate
Access servers for WebZ and Record Builder, named Access and AccessRB,
respectively. Each server has its own configuration file – AccessServer.ini
for the WebZ Access server and AccessServer_rb.ini for the Record Builder
Access server.
Document
Conventions
- <WebZ_root>
is the location of your WebZ environment.
- The default
value shown in the Default column applies to both AccessServer.ini and
AccessServer_rb.ini unless otherwise indicated.
- Unless otherwise
specified, all variables must contain a value; they cannot be left empty
(blank).
Sections
and Variables in Access Server Configuration Files
AccessServer.ini
and AccessServer_rb.ini each contain several sections (appearing as [section_name]):
Each section
contains one or more variables that define various server operations.
The following tables describe each section and its variables.
Location:
You can find AccessServer.ini and AccessServer_rb.ini in the <WebZ_root>/ini
directory of your SiteSearch installation.
[Access]
Section
|
Variable
|
Description
|
Default |
|
port
|
Defines
the port that the Access server runs on. A value of 0 allows the
Java Virtual Machine interpreter to dynamically determine a port
every time the Access server starts.
|
0 |
|
IniFileRoot
|
Specifies
the location of the configuration files for the WebZ system.
|
<WebZ_root>/ini |
Return
to Sections list
[ServerTrace]
Section
|
Variable
|
Description
|
Default |
|
traceLevel
|
Specifies
the level of detail in the trace
messages written to the Access server log file.
You can
set logging manually set by using the settrace
command in the ssadmin interface.
|
TRACE_NONE |
|
traceDirectory
|
Provides
the location of the directory Access uses to store its server logs.
|
<WebZ_root>/logs |
|
traceFilename
|
Provides
the base name that Access uses to write out server log files. Access
adds the sessionid, time, and date stamps to this base name before
saving the server log.
|
AccessServer.ini
access.serverLog
AccessServer_rb.ini
access_rb.serverLog
|
|
rollInterval
|
Defines
how frequently, in seconds, Access saves and closes the current
log and creates a new log file in its place. A value of 0 indicates
that the WebZ system does not automatically roll log files.
You can
also perform this task manually by using the flushlog command in
the ssadmin interface.
|
0 |
Return
to Sections list
[Timers]
Section
|
Variable
|
Description
|
Default |
|
HouseKeepingInterval
|
Defines how
often, in seconds, Access should perform housekeeping tasks. Access
ensures that the rolling intervals for server logs function correctly
and flush the logs if necessary. The server also reports its current
system load statistics to the OpServe.
This variable
does not set how often garbage collection occurs; garbage collection
is performed dynamically by the Java programming language.
|
1800
(30 min.)
|
|
idleGCTimer
AccessServer_ini.only
(beginning
with version 4.1.2a)
|
(Optional)
Specifies how long, in seconds, remains idle before the OpServe
submits a system garbage collection call (system.gc()) for it. 900
seconds (15 minutes) is a recommended value for this variable.
The OpServe
detects when a server has no active sessions and stores this information.
When the OpServe polls servers, it checks the length of time a server
has been idle. The OpServe compares the idleGCTimer value to the
amount of time the server has been idle.
|
If
the server's idleGCTimer value
|
the
OpServe...
|
| is
less than or equal to the length of time the server has been
idle |
issues
a system garbage collection call to the JVM for the server. |
| is
greater than the length of time the server has been idle |
does
nothing. |
| is
null or is -1 |
does
nothing. |
| is
0 |
issues
a system garbage collection call to the JVM for the server. |
Example
1. The OpServe polling period is 300 seconds (5 minutes) and
the Access server's idleGCTimer is 0. OpServe issues a system garbage
collection for this server if it is idle when OpServe checks the
server's state.
Example
2. The OpServe polling period is 300 seconds (5 minutes) and
the Access server''s idleGCTimer is 900 (15 minutes). OpServe issues
a system garbage collection for this server if it is has been idle
for at least 15 minutes when OpServe checks the length of the server's
idle time.
|
NULL |
Return
to Sections list
[Operations]
Section
|
Variable
|
Description
|
Default |
|
OpsConfigDir
|
Specifies
the location of the Operations directory where Access reads server
load balancing values. The other SiteSearch servers also have access
to this server's load balancing values in the defined directory.
|
<WebZ_root>/ops |
|
ServerType
|
Identifies
the type of server that is defined in this configuration file. The
OpServe and its administrative client,
ssadmin, use this information to
execute administrative tasks for the Access server.
|
AccessServer.ini
Access
AccessServer_rb.ini
AccessRB
|
|
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
SiteSearch system.
The file
is located in the directory specified by the IniFileRoot variable
in the [Access] section above.
|
HostMap.ini
|
Return
to Sections list
[JDBC]
Section
|
Variable
|
Description
|
Default |
|
SQLDriver
|
Specifies
the fully qualified class name of the SQL driver. For UNIX environments,
the location of this file depends the SiteSearch version, as follows:
| Version |
|
Location |
| 4.1.2/4.1.2a |
|
<WebZ_root>/mysql/classes/lib/mysql_comp.jar |
| 4.1.1/4.1.0 |
|
<WebZ_root>/msql/classes/lib/msql-jdbc.jar |
| 4.0.x |
|
<WebZ_root>/msql/classes/lib/imaginary.zip |
|
org.gjt.mm.mysql.Driver
(UNIX – beginning with version 4.1.2)
com.imaginary.sql.msql.MsqlDriver
(UNIX – version 4.1.1 and earlier)
sun.jdbc.odbc.JdbcOdbcDriver
(Windows NT)
|
|
URL
|
Defines
the Uniform Resource Locator (URL) and protocols that the JDBC driver
uses to locate the SQL server. For MySQL (beginning with version
4.1.2), the URL has the following syntax:
jdbc:mysql://hostname:port/databasename
where
- hostname
is the host system running the msql server
- port
is the port that the mSQL server is running on and must be greater
than 1024
- databasename
is the name of your relational authorization database: accessdb
for AccessServer.ini and rbdb for AccessServer_rb.ini
For mSQL
(version 4.1.1 and earlier), the URL has the following syntax:
jdbc:msql://hostname:port/databasename
| Notes: |
(1)
The value for port MUST equal the port value defined
in the:
- port
variable of the my.cnf file in the <WebZ_root>/mysql/data
directory
(beginning with version 4.1.2)
-
TCP_Port variable of the msql.conf file in the <WebZ_root>/msql/
directory
(version 4.1.1 and earlier)
Both
of these values are pre-configured based on the information
that you enter during the WebZ installation. If you wish to
move your MySQL or mSQL server to a different port, you must
change the values specified in this file and the my.cnf or
msql.conf file.
|
| (2)
If you use a different JDBC driver, check the URL protocol defined
in the driver's documentation to ensure that you use appropriate
syntax for this variable. |
|
as configured
during installation |
| Notes: |
(1) The
next two variables are commented out by default. Remove the
comment characters and enter values only if your RDBMS requires
them. |
|
(2) mSQL
DOES NOT require these values. |
|
| UserName |
User name needed
to open the your database.
|
Commented out
|
| Password |
Password needed
to open your access database. |
Commented out |
Return
to Sections list
[TablePurpose]
Section
This section includes
a list of the tables included in your authentication relational database
and the types of data resources stored in each table. The default authentication
database is accessdb for WebZ and rbdb
for Record Builder. The following table lists default table names and
table purposes. These values must accurately reflect the structure of
your database.
| Notes: |
(1) The table
purpose values are case sensitive. |
| : |
(2) Do not
rename the table purpose values.
|
| |
(3) See
accessdb
for a list of the required tables for the Access component for WebZ.
Do not delete or rename any values in this section for AccessServer_rb.ini. |
| |
|
Return
to Sections list
[ColumnPurpose]
Section
This section defines
the table columns and their purpose in the database that the Access server
uses to authorize a user. The values in this section should accurately
reflect the structure of your database tables. Specify the table column
as tablename.columnname, where table.columnname
refers to a column in a specific database table. For example,
authos.pwd refers to the pwd column in the authos table.
The column purpose values are case sensitive.
Return
to Sections list
[TableLinks]
Section
This section provides
a "map" of the relationships between the different tables and their columns.
The data that the columns below contain is shared between the two tables,
"linking" the tables together in the database. Specify the table column
as tablename.columnname, where table.columnname
refers to a column in a specific database table. For example,
authos.userdbkey refers to the userdbkey column in the authos table.
| |
| Note: |
Some of the
links in AccessServer_rb.ini are not used. However, because the Access
server for Record Builder (AccessServerRB) is identical to the Access
server for WebZ, AccessServerRB expects to see these links, so you
should not delete them. |
Return
to Sections list
File
Example
This example is
the AccessServer.ini file shipped with SiteSearch 4.1.2.
#AccessServer.ini
[Access]
Port = 0
IniFileRoot = <WebZ_root>/ini
[ServerTrace]
traceLevel = TRACE_NONE
traceDirectory = <WebZ_root>/logs
traceFilename = access.serverLog
rollInterval = 0
[Operations]
OpsConfigDir = <WebZ_root>/ops
ServerType = Access
HostMapIni = HostMap.ini
[JDBC]
SQLDriver=org.gjt.mm.mysql.Driver
URL=jdbc:mysql://hostname:port/accessdb
# The following variables may be required by your database
# management system - if so, uncomment them and set them
#UserName=
#Password=
[TablePurpose]
authos=AUTHORIZATION
userdb=USERDB
dbs=DATABASE
resources=RESOURCE
inst=INSTITUTION
instdbill=ILLBYDB
userresource=USERRESOURCE
[ColumnPurpose]
authos.autho=AUTHORIZATION
authos.pwd=PASSWORD
authos.sessions=MAX_SESSIONS
userdb.userdbkey=USERDBKEY
dbs.dbname=DBNAME
db.dbid=DBID
resources.resourceid=RSRCID
resources.resourceautho=AUTHORIZATION
resources.resourcepwd=PASSWORD
resources.resourcename=RSRCNAME
userresource.resourceid=RSRCID
userresource.dbid=DBID
userresource.db_autho=AUTHORIZATION
userresource.db_password=PASSWORD
[TableLinks]
authos.userdbkey=userdb.userdbkey
userdb.dbid=dbs.dbid
authos.userresourcekey=userresource.userresourcekey
userresource.resourceid=resources.resourceid
authos.instkey=inst.instkey
inst.illdbkey=instdbill.illdbkey
See Also
Access
Client Configuration Files
Configuring the Access Component for WebZ
(UNIX)
Configuring the Access Component for WebZ
(Windows NT)
Configuring the Access Component for
Record Builder (UNIX)
Configuring the Access Component for
Record Builder (Windows NT)
Configuration Files that Support the Access
Component
ssadmin Command Reference
WebZ Configuration Files
Record Builder Configuration Files
WebZ System Administration
Record Builder Administration
|