|
Variable
|
Description
|
Req/
Opt |
Default |
|
autho
|
Defines
the default authorization parameter to use for accessing the database
server. Also requires the use of the password
variable in some cases.
| Notes: |
(1)
For information regarding the value of the autho variable,
contact the system administrator of the database server.
|
| (2)
If you specify multiple authos for this server in the resources
table of accessdb for the WebZ Access
component, leave this variable blank. |
|
Opt |
N/A |
|
dbIniFile
ZBase.ini and
ZBase_rb.ini
only
|
Specifies
the file which lists the databases available to the WebZ system.
|
Req |
N/A |
|
dbSectionName
ZBase.ini and
ZBase_rb.ini
only
|
Specifies
which section in the file (specified by the value of dbIniFile)
contains information about databases available to the ZBase server.
| Note: |
This
value is typically set to ZBaseDBs
for both ZBase.ini and ZBase_rb.ini.
|
|
Req |
N/A |
|
hostname
|
The fully-qualified
hostname or Internet Protocol (IP) address of the database server.
| Note: |
This
value is typically set to localhost for both ZBase.ini and
ZBase_rb.ini.
|
|
Req |
N/A |
|
initWaitTimeout
|
Controls
the amount of time (specified in seconds) the virtual catalog waits
for an INIT response from a remote Z39.50 server.
The default
value of 0 indicates that the catalog waits infinitely for a response.
|
Opt |
0 |
|
largeSetLowerBound
|
Defines
the threshold that determines if a result set is a large-set. If
the number of results from a search is greater than largeSetLowerBound,
the result is a large-set.
| Note: |
If
the number of results is less than largeSetLowerBound and
greater than smallSetUpperBound, the
result is a medium-set.
|
|
Opt |
N/A |
|
maxMessageLen
|
Defines
the maximum length (in bytes) of response messages sent by the database
server.
|
Opt |
10000000
(if not specified) |
|
mustDeleteFirst
|
Indicates
whether the database server maintains only one result set per session.
If so, the result set must be deleted prior to successive searches.
Possible values are TRUE (must delete result set) or FALSE (allows
multiple result sets to exist).
|
Opt |
FALSE
(if
not specified)
|
|
noPiggybackedPresents
|
Indicates
whether the database server supports piggybacked presents. Possible
values are TRUE (allows piggybacked presents) or FALSE (does not
allow piggybacked presents).
|
Opt |
FALSE
(if not specified) |
|
oneConnectionPerUserForAllDbs
|
Indicates
whether the database server opens only one connection to the server
per database. Possible values are TRUE (opens only one connection
per user) or FALSE (opens a connection to EACH database on the server
per database).
| Notes: |
(1)
If
set to TRUE, one connection to the database server handles
all transaction. Thus, if a patron searches five databases,
each search request must use the single connection. If set
to FALSE, the server opens a connection to each database on
the server. If a user searches five databases, each search
request uses a separate connection.
|
| (2)
If your subscription to the remote database server is based
on the number of simultaneous user connections, keep in mind
that setting this variable to FALSE increases the average number
of simultaneous connections per user. |
|
Opt |
TRUE
(if not specified) |
|
password
|
Defines
the default password parameter to use for accessing the database
server. Typically used in conjunction with the autho
variable.
| Notes: |
(1)
For information regarding the value of the password variable,
contact the system administrator of the database server.
|
| (2)
If you specify multiple passwords for this server in the resources
table of accessdb for the WebZ Access
component, leave this variable blank. |
|
Opt |
N/A |
|
port
|
The port
the WebZ ZBase server connects to on the remote database server.
| Notes: |
(1)
In
ZBase.ini and ZBase_rb.ini, the value of port is typically
set to 0 (connects to first available open).
|
| (2)
Contact the system administrator of the remote database server
for information about port settings. |
|
Req |
N/A |
|
preferredMessageLen
|
Defines
the preferred length (in bytes) of response messages sent by the
database server. This value cannot exceed the value of maxMessageLen.
|
Opt |
5000000
(if
not specified) |
|
queryType
|
The Z39.50
query protocol to use with the database server. Possible values
are 0, 1, and 101.
| Notes: |
(1)
In
ZBase.ini and ZBase_rb.ini, set queryType to 0. A value of
0 sends a raw query down to ZBase and customizes the query
type for each target.
|
|
Opt |
101
(if not specified) |
|
readTimeout
|
Defines
the amount of time (in seconds) a server waits for a response from
a Z39.50 server.
The default
of 0 indicates that the server waits infinitely to get a successful
Z39.50 INIT response.
|
Req |
0 |
| scanStepSize |
In a scan,
specifies the desired number of entries in the term-list between
two adjacent entries in the response. The default of 0 indicates
that the target server should not skip any entries.
| Notes: |
(1)
In
ZBase.ini and ZBase_rb.ini, set scanStepSize to 0.
|
| (2)
Contact the system administrator of the remote database server
for information about scan step sizes supported by the server. |
|
Opt |
0 |
|
smallSetUpperBound
|
Defines
the threshold that determines if a result set is a small-set. If
the number of results from a search is less than the value of smallSetUpperBound,
the result is a small-set.
If the
number of results is greater than smallSetUpperBound but less than
largeSetLowerBound, the result is a medium-set.
|
Opt |
0
(if not specified) |
|
supportsMergeReads
(beginning with version 4.1.0)
|
Indicates whether
your WebZ environment supports combined result sets. A combined
result set displays result sets from multiple databases into one
continuous result set. The display indicates the database from which
each record was retrieved. Possible values are TRUE (supports combined
result sets) or FALSE (does not support combined result sets).
See What
is Combined Result Set Functionality? for more information about
combined result sets.
|
Opt |
FALSE |
|
SupportsMultiDbQuery
|
Indicates
whether the database server supports search requests that contain
a list of multiple databases to query. Possible values are TRUE
(supports multiple database queries) or FALSE (does not support
multiple database queries).
| Note: |
Set the
value of this variable to TRUE in both ZBase.ini and ZBase_rb.ini.
|
|
Opt |
FALSE
(if not specified) |
|
SupportsReconnect
|
Indicates
whether the database server allows an external Z39.50 client to
close a connection, then reopen it. Possible values are TRUE (supports
reconnect) or FALSE (does not support reconnect).
| Note: |
Set the
value of this variable to TRUE in both ZBase.ini and ZBase_rb.ini.
|
|
Opt |
TRUE
(if not specified) |
|
SupportsScan
|
Indicates
whether the database server allows you to scan a result set. Possible
values are TRUE (supports scan) or FALSE (does not support scan).
| Note: |
Set the
value of this variable to TRUE in both ZBase.ini and ZBase_rb.ini.
|
|
Opt |
TRUE
(if not specified) |
|
supportsSort
|
Indicates
whether the database server can sort a result set. Possible values
are TRUE (supports sort) or FALSE (does not support sort).
| Notes: |
(1)
Always
set the value of this variable to TRUE in both ZBase.ini and
ZBase_rb.ini.
|
| (2)
If you set supportsSort to TRUE, you are only indicating that
the database server can sort result sets. You have not enabled
sorting for a database hosted by this server until you also
set SupportsSort=TRUE
in the [database] section of the database's configuration file
and add a [sort] section
to the database's configuration file. |
|
Opt |
TRUE
(if not specified) |
|
supportsSummaryDbResults
|
Indicates
whether the database server can present search results per database
in response to a cross-database search. Possible values are TRUE
(supports summary) or FALSE (does not support summary).
| Notes: |
(1)
Set the
value of this variable to TRUE in both ZBase.ini and ZBase_rb.ini.
|
| (2)
To illustrate the use of summary results, suppose a user issues
a cross-database search on three databases. The summary results
of this search would contain information such as this: "Total
records found: 626. Database1 found 25 records, Database2 found
497 records, and Database3 found 74 records." |
|
Opt |
FALSE
(if not specified) |
|
supportsTriggerResourceControl
|
Indicates
whether the database server supports trigger resource control requests.
Possible values are TRUE (supports) or FALSE (does not support).
|
Opt |
TRUE
(if not specified) |
timeTheSocketConnect
(beginning with version 4.1.0) |
Indicates whether to invoke a 10,000 millisecond timer to time the
connection on the call to newSocket(). For rare situations where a
remote server may not respond quickly to failed connection attempts.
Possible values are TRUE (invoke the timer) or FALSE (do not invoke
the timer). |
Opt |
FALSE
(if not specified) |
|
useDefaultResultsetName
|
Indicates
that the database server supports only the name "default" for a
result set. Possible values are TRUE (use "default" as result set
name) or FALSE (allows named result sets).
|
Opt |
FALSE
(if not specified) |
|
useElementSetNames
|
Indicates
if the database supports named element sets. Possible values are
TRUE (supports named element sets) or FALSE (does not support named
element sets).
|
Opt |
TRUE
(if not specified) |
|
useReferenceIds
|
Specifies
whether to include Z39.50 reference ids in transactions with the
database server. Possible values are TRUE (include reference ids)
or FALSE (do not include reference ids).
|
Opt |
TRUE
(if not specified) |
|
useSortAttributesField
|
Specifies
the sortkey format to use for sort requests sent to the database
server. Possible values are TRUE (use sort attributes) or FALSE
(use sort fields).
|
Opt |
FALSE
(if not specified) |