|
Database
Configuration Files - Sections and Variables
Contents
Introduction
Document Conventions
Sections in a Database Configuration File
Variables in Each Section of a Database Configuration
File
[database]
[ExtendedServices]
[ExtendedServicesDbUpdate]
[templates]
[ttemplate_definition]
[Formats]
[TermFinder]
[attributes]
[attribute definition]
[index definition]
[sort]
[sort key definition]
[dedup]
[dedup key definition]
[IndexLists]
Introduction
A database
configuration file contains the information needed by WebZ or Database
Builder's Record Builder application
to interact with a particular database. Each database must have a configuration
file.
A database configuration
file is a text file comprised of sections and variables. Sections are
denoted with [section labels] enclosed in square brackets. Each section
contains variables that define particular aspects of the database configuration.
The variables that appear in the individual sections depend on the type
of database being defined, such as the database indexes available for
searching, sort capability, and so on. Variables within a section can
appear in any order.
This document is
a comprehensive reference to the sections and variables in a database
configuration file. It includes all possible sections and variables even
though not every database configuration file contains all of them.
Because of its comprehensiveness,
this is a long document. If you are using Netscape as your Web browser,
you can use the Print Preview feature (select File > Print Preview
from the browser menu) to get an idea of where page breaks will occur
when you try to print it. Then click the Print button and enter a print
range on the Print dialog box to print only the pages you want.
For general information
about database configuration files and the types of database configuration
files, see About Database Configuration Files.
Return
to Contents
Document
Conventions
General Conventions
- <WebZ_root>
is the location of your WebZ environment.
- 4.0.x
refers to any SiteSearch 4 version prior to 4.1.0; that is, 4.0.0, 4.0.0a,
4.0.1, or 4.0.2.
- Section or
variable titles in italics, such as [attribute_definition], denote
section titles that you name yourself and that will vary.
Database Type
Abbreviations
Abbreviations
used to denote the various types of database configuration files are:
Required and Optional
Sections for Each Database Type
This document contains
a description of each section in database configuration files. For each
section, the applicable database types are indicated in the section title
by the abbreviations shown above. A section can be either optional, required,
or not applicable for a particular database type, as shown in the following
examples:
| Example |
Explanation |
| [database]
Section – Required for: ALL |
The [database]
section is required for all database types |
| [dedup]
Section –
Optional for:
GRP, LOC,
LOG, REM |
The [dedup]
section is optional for group (GRP), local (LOC), logical (LOG), and
remote (REM) databases. It does not apply to any other database types. |
| [dedup
key definition] Section
–
Required for GRP, LOC, LOG, REM if [dedup] section exists |
The [dedup
key definition] section is only required if the database configuration
file contains a [dedup] section, which is itself optional. |
Required and Optional
Variables for Each Database Type
After any information
that applies to the section as a whole, there is a table that lists every
possible variable in the section. Even though a section is required or
optional for a database type, not all the variables in the section may
be relevant for that database type. For example, the [database] section
is required for all database types, but not all the variables are required
for each database type, nor do they even apply to all database types.
Similarly, an optional section may have some variables that are required
if you include the section in the database configuration file.
The table that lists
the variables in a section has two columns –
Variable and Description.
The Variable column
includes the variable name, an indication of whether the variable is optional
or required, and the database types to which the variable applies, like
these examples:
| Example |
Explanation |
| longname |
Required
for: ALL |
|
The longname variable is required for all database types. |
| ServerName
|
Required
for: GRP, REM |
|
The
ServerName variable is required for group (GRP) and remote (REM) databases.
It is not optional for the other database types; it is does not even
apply to any other database types |
| HoldingsDbName
|
Optional
for: LOC, LOG, REM |
|
The
HoldingsDbName variable is optional for local (LOC), logical (LOG),
and remote (REM) databases. It does not apply to other database types. |
The Description column
provides a definition of the variable and notes that pertain to the variable's
use. If applicable, it includes a list of allowable values for the variable.
One of these variables may be a default value.
Default Values
A number of optional
variables have a default value that takes effect if you do not specify
another value for the variable. In a list of allowable values, the default
is denoted like this:
| TRUE |
|
Supports sort. |
| FALSE |
|
Does not support
sort. (Default) |
If there is not a
specific list of allowable values, the default is denoted like this:
Default:
200
Return
to Contents
Sections
in a Database Configuration File
The following
table lists all possible sections that a database configuration file may
contain. In addition to describing each section, it indicates the database
types to which a section applies and whether the section is optional or
required. The links in the Section column are shortcuts to the reference
information for a particular section.
|
Section
|
Description
|
|
|
Provides information
about the database and its capabilities and features, such as its
name, its record syntax, the Java class that interacts with it, and
whether it supports sorting, browsing, and full text records. |
|
|
Defines the
Java class used to apply online database updates made through the
Record Builder interface to
a local database. |
|
Section
|
Description
|
|
|
Provides information
related to performing online database updates, such as the location
of the database's journal files and the file that contains the database's
starting record identifier. |
[templates]
(beginning with version 4.1.0) |
Required
for: RBD |
|
Lists all data
entry templates defined for the database. |
|
|
Describes a
template defined in the [templates] section.
|
| [Formats]
|
Required
for:
HLD, LOC, LOG, RBD, REM, THS |
|
Lists each format
used to display data from the database and its associated formatting
configuration file or formatting class. |
[TermFinder]
(beginning with version 4.1.0) |
Optional
for: LOC, LOG, REM
Required for: THS |
|
Provides information
about configuring term finder searches of the database for vocabulary-assisted
searching. |
|
|
Declares attribute
types available for the database. |
|
|
Defines the
names and attributes of the indexes belonging to an attribute type
specified in the [attributes] section. |
|
|
Defines an index
defined in the [attribute_definition]
section, including the
index's name, abbreviation, use, structure, and other relevant information,
such as whether the index supports range searches. |
|
|
Specifies how
to sort the records retrieved as the result of a database search.
|
|
|
Defines a sort
key used to sort database records, which you specify in the [sort]
section. |
|
Section
|
Description
|
| [dedup] |
Optional
for: GRP,
LOC, LOG, REM |
|
Contains information
needed to implement de-duplication
for a group database or within an individual database in compliance
with Z39.50-1995
Amendment 2: Z39.50 Duplicate Detection Service. |
|
|
Defines a de-duplication
key used to de-duplicate database records, which you specify in the
[dedup] section. |
|
|
Defines database-specific
sets of indexes for display in the WebZ or Record Builder interface. |
Return
to Contents
Variables
in Each Section of a Database Configuration File
[database]
Section – Required for: ALL
The [database] section
provides information about the database and its capabilities and features,
including its name, its record syntax, the Java class that interacts with
it, and whether it supports sorting, browsing, and full text records.
More than any other section, it has many variables that pertain only to
specific database types.
|
Variable
|
Description
|
| ZBaseDbType |
Required
for:
HLD, LOC, LOG, RBD, REM, THS |
|
Defines
the Java class used for interacting with a database. The class used
depends on the type of database you are defining, as follows:
ORG.oclc.db.DbRemoteZ
(remote databases, including remote thesaurus and holdings databases)
ORG.oclc.db.DbNewton
(local databases, including Record Builder databases and local thesaurus
and holdings databases)
ORG.oclc.db.DbMerge (logical databases)
|
|
|
The name
the WebZ system or the Record
Builder application uses to identify the database. May contain
up to 256 alphanumeric characters, case insensitive, without spaces.
| Examples: |
WCAT
localOLUC
RSC_terra
|
| Note: |
Beginning
with version 4.1.2, the WebZ OBI and the Record Builder interface
sort the list of databases on the database list screen by
Longname. In previous versions, the
sort occurs on the DbName variable rather than Longname.
|
|
|
Variable
|
Description
|
|
|
Name of
the database as it appears in the WebZ or Record Builder interface,
as applicable. May contain up to 256 alphanumeric characters, case
insensitive.
| Examples: |
Local
Worldcat
ABII/Inform
Pro CD Biz
|
| Note: |
Beginning
with version 4.1.2, the WebZ OBI and the Record Builder interface
sort the list of databases on the database list screen by
Longname. In previous versions, the sort occurs on the DbName
variable rather than Longname.
|
|
| remoteZDbName |
Required
for: REM |
|
The name
the remote Z39.50 server uses to identify the database.
| Notes: |
(1)
If you do not know the name of the remote database, check
with the database provider.
|
| (2)
The value of remoteZDbName does not have to match the value
of dbname. |
|
| recordSyntax |
Required
for: ALL |
|
Format of
records returned from a search against this database. Allowable
values are: BER, GRS, MARC, NOTIS_OPAC, OPAC, TEXT (which you should
use for all text-based record formats, such as SUTRS),
UNIMARC, UKMARC, and beginning with version 4.1.0, NORMARC.
| Notes: |
If
you specify an invalid record format, the record format defaults
to MARC..
|
|
| remoteZRecordSyntax |
Optional
for: REM |
|
Syntax used
to return records from the remote server. Allowable values are BER
and MARC. The value of remoteZRecordSyntax can differ from from
recordSyntax. The Z39.50 formatting
classes can convert records from the format specified by recordSyntax
to the format specified by remoteZRecordSyntax in order to return
records to the client (JaSSI).
|
| ServerName |
Required
for: GRP, REM |
|
Name the
WebZ system uses to identify the database's remote server.
|
| ServerIniFile |
Required
for: REM |
|
Path and
name of the database server configuration
file for the remote Z39.50 database server.
| Example: |
servers/FirstSearch.ini
|
| Note: |
By
default, the specified path is relative to the value of the
IniFileRoot variable
in JaSSIServer.ini, which is typically the <WebZ_root>/ini
directory. You can also specify an absolute path.
|
|
|
RemoteZBriefESN
RemoteZFullESN
RemoteZFullTextESN
(beginning
with version 4.1.0)
|
Optional
for: REM |
|
Remappping
for the incoming ElementSetName on a present request to an element
set name specific to the target database.
The value for
any of these variables is a string that represents the database-specific
element set name for brief, full, or full text records, respectively.
|
|
Variable
|
Description
|
hedr
hdir
post
pdir
indx |
Required
for: LOC, RBD |
|
Location
of the physical database files
of a local database created with Database Builder or its Record
Builder application.
|
|
|
Specifies
the physical databases (or "parts") that make up a logical database.
The value of this variable is a list of database configuration files
(separated by spaces) of the databases that make up the logical
database.
| Example: |
parts
= dbs/localDb1.ini dbs/localDb2.ini dbs/localDb3.ini
|
|
| DefaultDbGroupDefinition |
Required
for: GRP |
|
Indicates
whether the group database is the default group database in the
WebZ interface. Possible values are:
| TRUE |
|
This
is the default
group database. |
| FALSE |
|
This
is NOT the default group database. |
| Note: |
If
you have more than one group database, only one of the group
databases can have DefaultDbGroupDefinition=TRUE.
|
|
|
|
Indicates
that sort capability for this database appears in the WebZ or Record
Builder interface. Possible values are:
| TRUE |
|
Supports
sort. |
| FALSE |
|
Does
not support sort. (Default) |
If SupportsSort
= TRUE, the database configuration file must include a [sort]
section.
| Note: |
Do
not confuse this variable with the supportsSort
variable in a database server
configuration file. The SupportsSort variable here indicates
whether you want to allow users (patrons or staff) to specify
sort criteria from the WebZ or Record Builder interface. The
supportsSort variable in a database server configuration file
indicates whether a particular database server can support
sorting.
Even
if the database server hosting a particular database does
not support sorting, it is still possible for you to provide
sort capability to users by setting the localsort
variable to TRUE in the [sort] section
of its database configuration file. This directs ZBase to
sort result sets locally.
|
|
| supportsScan |
Optional
for: LOC, LOG, REM |
|
Indicates
whether the the database allows patrons to scan (browse) a result
set. Possible values are:
| TRUE |
|
Supports
scan. |
FALSE
|
|
Does
not support scan. (Default) |
If you do not
specify a value for this variable, the value for the SupportsScan
variable in the database server configuration file for the server
hosting this database applies to the database.
|
|
Variable
|
Description
|
|
|
Indicates
whether the database contains full text records. Allowable values
are:
| TRUE |
|
Contains
full text records. |
FALSE
|
|
Does
not contain full text records. (Default) |
| Notes: |
(1)
If FullText = TRUE, you must include the FullTextRecordSyntax
variable and a fulltext variable in the [Formats]
section.
|
| (2)
If FullText=TRUE a Full Text button appears on the full record
screen in the WebZ OBI (<WebZ_root>/htdocs/obiv1/html/full.html
or nffull.html in the OBI, version 1). |
|
|
|
Format of
full text records returned from a search against this database.
Allowable values are: MARC, BER, SUTRS, NOTIS_OPAC, OPAC, GRS, UNIMARC,
UKMARC, MARC, and beginning with version 4.1.0, NORMARC.
|
| HoldingsDbName |
Optional
for:
LOC, LOG, REM |
|
Name of
the database that contains holdings information for the database
you are defining.
| Note: |
If
HoldingsDbName = TRUE, you must have a separate database configuration
file for the holdings database. The configuration file for
for the holdings database must include formats for displaying
records from the holdings database.
|
|
| HideInMenus |
Optional
for:
HLD, LOC, LOG, REM, THS |
|
Determines
whether the database's name appears on the database list screen
in the WebZ interface (<WebZ_root>/htdocs/obiv1/html/dblist.html
or nfdblist.html in the OBI, version 1). Allowable values are:
| TRUE |
|
Does
not appear on the database list (hide it on the menu). |
| FALSE |
|
Appears
on the database list. (Default) |
| Notes: |
(1)
If the database belongs to a topic area (such as General or
Human Affairs in the WebZ OBI, version 1) and this variable
is set to TRUE, the database does not appear in the list of
databases but WILL appear in the list of databases in a search
of the topic area to which it belongs.
|
| (2) Set
HideInMenus=TRUE for thesaurus and holdings databases. |
|
| IllService |
Optional
for: LOC,
LOG, REM |
|
Interlibrary
loan (ILL) service available for the database. In SiteSearch
4.1.2, IllService has these possible values:
| Profiled |
|
Use
ILL profiling for this database. In ILL profiling, you can
specify the ILL service to use for ILL requests for items
from this database on a per-institution basis. |
| ILL_Service_
Name |
|
Use
the ILL service indicated. The ILL_Service_Name must
match the ILL service's name in brackets at the top of its
ILL server configuration file. |
| NONE |
|
No ILL
service available. (Default) |
In SiteSearch
4.1.1 and earlier versions, IllService has three allowable values:
| Note: |
If IllService
is not NONE, WebZ adds a button for submitting an ILL request
to the full record screen in the WebZ
OBI (<WebZ_root>/htdocs/obiv1/html/full.html
or nffull.html in the OBI, version 1).
|
|
|
Variable
|
Description
|
ThesaurusDBName
(beginning with version 4.1.0) |
Optional
for: LOC, LOG, REM |
|
Name
of the thesaurus database associated with this database. The value
of ThesaurusDBName must match the dbName variable
specified for the thesaurus database in the thesaurus
database's configuration file. |
ComponentPostings
(beginning with version 4.1.0) |
Optional
for: LOC, LOG, REM, THS |
|
Indicates whether
the database can return a component postings value (the number of
records that satisfy each part of a query). For example, with a
database that supports component postings you could submit a query
for dog OR house and obtain the number of records that contain "dog"
and the number of records that contain "house". Allowable
values are:
| TRUE |
|
Supports
component postings. |
FALSE
|
|
Does
not support component postings. (Default) |
| Note: |
The
WebZ OBI, version 1, demonstrates the use of component postings
with thesaurus trees used for vocabulary-assisted
searching. Component postings are proprietary to OCLC;
only local databases created with Open SiteSearch Database
Builder and FirstSearch databases support this feature at
this time.
|
|
| TermExpansionMax
|
Optional
for: LOC |
|
Indicates
the maximum number of terms returned in queries that include truncation
operators (wildcard characters) or ranges (except for ranges on
restrictor values).
Default:
50.
| Note: |
Setting
this variable too high may affect performance. Select a value
for this variable that provides flexibility for your patrons
but does not appreciably slow response time.
|
|
Return
to Contents
[ExtendedServices] Section (beginning with SiteSearch 4.1.0) –
Required by: RBD
This section applies
only to Record Builder (RBD) databases. It provides the information necessary
to perform an online update of the database (adding, deleting, or modifying
records) through the Record Builder interface.
|
Variable
|
Description
|
| 1.2.840.10003.9.5
|
Required
for: RBD |
|
The variable
name is the Z39.50 object identifier for an Extended Services request
handler, as described in ANSI/NISO
Z39.50-1995,
Appendix 8, EXT: Extended Services Defined by this Standard.
The value of this variable is the name of the Java class that applies
to online database updates made through the Record Builder interface
to the database. Allowable values are:
Do not modify
the name or value of this variable.
|
Return
to Contents
[ExtendedServicesDbUpdate] Section (beginning with SiteSearch 4.1.0)
– Required for: RBD
This section applies
only to Record Builder (RBD) databases. It provides the information necessary
to perform an online update of the database (adding, deleting, or modifying
records) through the Record Builder interface.
|
Variable
|
Description
|
|
|
Directory where
database executables for updating the database are stored. This is
generally <WebZ_root>/dbbuilder/bin. |
|
|
Directory where
log files (such as error logs) for this database are stored. This
is generally the journal subdirectory under the database's top-level
directory, such as <WebZ_root>/dbbuilder/dbs/database_dir/logs,
where database_dir is the database's top-level directory. |
| JournalUpdateDir
|
Required
for: RBD |
|
Directory where
journal files for this database are stored. This is generally the
logs subdirectory under the database's top-level directory, such as
<WebZ_root>/dbbuilder/dbs/database_dir/journal,
where database_dir is the database's top-level directory. |
| databasepercentfull
|
Required
for: RBD |
|
Percentage
of database capacity after which users can no longer add records
to the database.
Default:
95
|
| LockServerName
|
Required
for: RBD |
|
Name of the
Lock Server. Do not edit or remove this variable. |
| recordIdTag
|
Required
for: RBD |
|
BER tag path
of the field that stores the database's unique record identifiers
(accession numbers). |
| recordIdFile
|
Required
for: RBD |
|
Name and location
of the file that contains an integer to use as the next unique identifier
for database records added with Record Builder. The file's name
is recordid.txt and generally resides in the database's "home"
directory, such as <WebZ_root>/dbbuilder/dbs/database_dir/recordid.txt.
This is useful
if you load data into a database in batch mode with Database Builder,
and then subsequently add new records with Record Builder. Even
if you are adding records to a new database with Record Builder,
there must be a recordid.txt file containing the database's starting
identifier.
|
|
Variable
|
Description
|
| recordIdClass
|
Required
for: RBD |
|
Name of the
Java class that reads the recordid.txt file to determine unique identifier
for records added to the database. Do not edit or remove this variable. |
Return
to Contents
[templates] Section (beginning with SiteSearch 4.1.0) – Required
for: RBD
This section lists
all template files available for viewing, editing, or deleting data from
the database through the Record Builder interface. Each database has a
default template that provides the ability to edit every field in the
database. Other templates (or workforms) contain a subset of the fields
available in the default template.
|
Variable
|
Description
|
| template*
|
Required
for: RBD |
|
Name of a template.
By convention, template names begin with a lower-case "t".
Names can be up to 256 alphanumeric characters, but can include
no spaces.
| Note: |
You should
always have one default template with the name tDefault. Additional
templates are optional.
|
For every template
variable in this section, there must be a corresponding template
definition section ([ttemplate_definition])
with the same name.
|
Return
to Contents
[ttemplate_definition] Section (beginning with SiteSearch 4.1.0)
– Required for: RBD
This section provides
information about a database template associated with a Record Builder
database. A template allows Record Builder users to add, modify, or delete
data in the database.
|
Variable
|
Description
|
|
|
Identifier for
the template used by the system. The value of the name variable must
begin with the letters "template", such as "templateDefault"or
"templateClipping". |
| longname
|
Required
for: RBD |
|
Name of the
template as you want it to appear on the Record Builder interface. |
| template
|
Required
for: RBD |
|
Name and location
of the XML template file. Template files have an .xml extension and
normally reside in <WebZ_root>/dbbuilder/dbs/database_dir. |
fieldxml
(beginning with version 4.1.1) |
Required
for: RBD
(if a DC(2) database) |
|
Name and
location of the XML file that contains information about the schemes
and modifiers for the elements in the template. The file should have
an .xml extension and normally resides in <WebZ_root>/dbbuilder/dbs/database_dir.
|
| tagfile
|
Required
for: RBD |
|
Name and location
of the .dtd (data tag definition) file that pertains to the database.
The location is normally <WebZ_root>/dbbuilder/dbs/database_dir. |
|
|
Flag that indicates
whether the data to be added to the database using this template
is in MARC format. Values are:
| TRUE |
|
Data
is in MARC format. |
FALSE
|
|
Data
is not in MARC format. (Default) |
|
|
constantxml
(beginning with version 4.1.2)
|
Optional
for: RBD |
|
Name and location
of the XML constant data file.
Constant data files have an .xml extension and normally reside in
<WebZ_root>/dbbuilder/dbs/database_dir. |
ApplyConstantData
(beginning
with version 4.1.2) |
Optional
for: RBD |
|
Flag that indicates
how Record Builder should apply constant data (if defined in the
file specified for the constantxml variable) for the database. Values
are:
| AUTO |
|
Automatically
add constant data when displaying a workform (Edit
Record screen) to create a new record.
|
MANUAL
|
|
Add
constant data when metadata specialist selects Apply constant
data from the Available
actions list on the Edit Record screen. (Default) |
|
Return
to Contents
[Formats] Section
The [Formats]
section defines the formatting classes that format records returned from
a search against this database, and/or the formatting
configuration files that refer to display specifications for formatting
records. The formatting configuration files are one aspect of rules-based
formatting, which is new beginning with SiteSearch 4.1.0. The [Formats]
section variables may refer to display formats
and/or and Z39.50 formatting classes.
Display
Formats
You can use display
formatting classes or formatting configuration
files to format records for display in the WebZ or Record Builder
interfaces. For each record type you wish to display in the interface,
such as full records, brief records, bookmarked records, and so on, you
must define a Java class to perform the formatting, or, beginning with
version 4.1.0, a formatting display
specification in a formatting configuration file.
The variables
listed here are those recognized by the Java classes included with the
WebZ OBI, version 1, the WebZ OBI, version 0, and the Record Builder interface,
version 0, and are designed for use in the WebZ OBI and/or the Record
Builder interface. The display formats listed here are those included
You are free to add variables that represent formats not included in this
list. The table indicates the variable name, whether there is a display
specification and/or a formatting class for this type of data, and a description
of the record type formatted.
|
Variable
|
Formatting
|
Record
Type Formatted
|
|
Display
Spec.
|
Class |
| bookmark |
Optional
for: LOC, LOG, REM |
|
x |
x |
Bookmarked
brief records.
|
| bookmarkDups
|
Optional
for: LOC, LOG, REM |
|
x |
|
Bookmarked de-duplicated
records. |
| bookmarkfull |
Optional
for: LOC, LOG, REM |
|
x |
x |
Bookmarked full records.
|
| bookmarkfullFT |
Optional
for: LOC, LOG, REM |
|
x |
|
Bookmarked full-text
records. |
|
Variable
|
Formatting
|
Record
Type Formatted
|
|
Display
Spec.
|
Class |
| bookmarkFT |
Optional
for: LOC, LOG, REM |
|
x |
|
Brief format
of a full-text record in the bookmark section of the screen. |
| brief |
Optional
for: LOC, LOG, REM, RBD |
|
x |
x |
Brief
records in a frames-based interface.
|
| briefduplicates
|
Optional
for: LOC, LOG, REM |
|
x |
|
Brief de-duplicated
records. |
| briefnf |
Optional
for: LOC, LOG, REM, RBD |
|
x |
|
Brief records
in no-frames interface. |
| dump |
Optional
for: LOC, LOG, REM, RBD |
|
|
x |
Record
dump.
| Note: |
A
record dump displays the BER tag structure of a record and
is very useful for debugging and troubleshooting record formatting
in the WebZ and Record Builder interfaces.
|
|
| duplicates
|
Optional
for: LOC, LOG, REM |
|
x |
|
Full de-duplicated
records. |
| full
|
Optional
for: LOC, LOG, REM, RBD |
|
x |
x |
Full
records in frames-based interface.
|
| fullnf
|
Optional
for: LOC, LOG, REM, RBD |
|
x |
|
Full records
in no-frames interface. |
|
Variable
</ | |