Specifies how to sort the records retrieved as the result of a database search.

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.

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.

The name the remote Z39.50 server uses to identify the database.

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.

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).

Name the WebZ system uses to identify the database's remote server.

Path and name of the database server configuration file for the remote Z39.50 database server.

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.

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.

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.

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.

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.

Indicates whether the database contains full text records. Allowable values are:

TRUE		Contains full text records.
FALSE		Does not contain full text records. (Default)

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.

Name of the database that contains holdings information for the database you are defining.

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)

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:

ISOILL		Send ILL requests electronically to OCLC's ILL Direct Request Service.
EMAIL		E-mail ILL requests to a designated e-mail address.
NONE		No ILL service available. (Default)

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)

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.

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:

ORG.oclc.util.BatchNewtonUpdate		(for UNIX systems)
ORG. oclc.util.BatchNewtonUpdateforNT		(for Windows NT systems)

Do not modify the name or value of this variable.

Percentage of database capacity after which users can no longer add records to the database.

Default: 95

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.

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.

For every template variable in this section, there must be a corresponding template definition section ([ttemplate_definition]) with the same name.

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)

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)

Bookmarked brief records.

Bookmarked full records.

Brief records in a frames-based interface.

Record dump.

Full records in frames-based interface.

Full text records.

Holdings records.

Bibliographic information for interlibrary loan (ILL) requests.

Multiple full records on results page in frames-based interface

This variable is similar to the full variable, but the class or display specification referenced by multifull allows the WebZ interface to display more than one full record on a results page as a result of an advanced search.

Brief records in BER format.

Brief records in MARC format.

Brief records in SUTRS format.

Full records in SUTRS format.

Full records in MARC format.

Full or brief OPAC Record Syntax Records, respectively.

ORG.oclc.fmts.zbase.ExampleOPACFmt is an example class that demonstrates how to create OPAC Record Syntax Records.

See ANSI/NISO Z39.50-1995, Appendix 5, REC: Record Syntaxes for more information about OPAC Record Syntax Records.

Name of the index to use to search the database using term(s) from the term list display. This must be an index defined in the [index definition] section of the database configuration file.

Default: The database's default index.

Number of records to retrieve from the database to create a term list when WebZ generates the term list from a term finder search of the database rather than a thesaurus database.

Default: 20

Name of the index to use to conduct a term finder search of the database. This must be an index defined in the [index definition] section of the database configuration file.

Default: the database's default index.

Indicates whether the term finder search should be an adjacency search of the TermFinderSearchIndex. Allowable values are:

TRUE		Term finder search should be an adjacency search.
FALSE		Term finder search should NOT be an adjacency search. (Default)

Set this flag to true if the TermFinderSearchIndex is a "words-type" search and the remote server does not support "with" syntax in searches.

Attribute types (BIB1, EXP1, etc.) available for this database. Specify multiple types as type1, type2, type3, and so on, or beginning with SiteSearch 4.0.2, type*, type*, and so on. Attribute type names can be any combination of alphanumeric characters but can contain no spaces.

You must define at least one attribute type for a database.

Z39.50 attribute set used by the indexes in the database. Possible values are BIB1 (Default), EXP1, EXT1, CCL1, GILS, and STAS.

Name of the query normalization (filter) class used to manipulate patrons' search terms to better match specific database indexes.

Default: ORG.oclc.qnorm.NewtonDbBaseTermNormalizer.

The index searched if a search request does not contain an index.

Integer that specifies the default Boolean operator used in combined-term searches. Allowable values are:

Value		Operator
0		default. This is the default operator used by the target Z39.50 server. (Default)
1		and
2		with
3		near
4		or

Space-separated list of words ignored in any search request issued against the database. Typically, stopwords are words, such as "a", "an", and "the", that occur too frequently in the database to be of value as search terms.

Index identifier for an index that belongs to an attribute set. Specify multiple index identifiers as index1, index2, index3, and so on, or beginning with version 4.0.2, index*, index*, and so on. Index names can include any combination of alphanumeric characters but cannot contain any spaces.

The name of the index as it appears in the WebZ or Record Builder interface.

Name of the query normalization (filter) class used to manipulate patrons' search terms to better match this database indexes.

The filter class defined in the [attribute definition] section of this file applies to all of a database's indexes unless you specify a different filter class for a particular index in its [index definition] section.

Index abbreviation. Can be any combination of alphanumeric characters (64 characters maximum), with no spaces or other punctuation. Beginning with version 4.1.0, the value of the abb variable must be unique for each index for a given database.

Integer that indicates the use for the index. The integer is typically a use attribute (as defined by a well-known standard such as Z39.50, which is recommended).

Z39.50 structure attribute, an integer that indicates the structure of the index as defined by the Z39.50 standard. Commonly used values are:

Value		Structure
1		phrase
2		word
3		key
4		year
5		date
6		word list

Z39.50 relation attribute, an integer that specifies the relationship of the access point (left side of the relation) to the search term as qualified by the attributes (right side of the relation), e.g., Date-publication <= 1975. Commonly used values are:

Value	Relation
1	Less than
2	Less than or equal
3	Equal
4	Greater or equal
5	Greater than
6	Not equal

Z39.50 position attribute, an integer that specifies the location of the search term within the field or subfield in which it appears. Allowable values are:

Value		Position
1		First in field
2		First in subfield
3		Any position in field

Z39.50 truncation attribute, an integer that specifies whether one or more characters may be omitted in matching the search term in the target system at the position specified by the truncation attribute. Allowable values are:

Value		Truncation
1		Right truncation
2		Left truncation
3		Left and right truncation
100		Do not truncate
101		Process # in search term
102		RegExpr-1
103		RegExpr-2

Z39.50 completeness attribute, an integer that specifies whether the contents of the search term represent a complete or incomplete subfield or a complete field. Allowable values are:

Value		Completeness
1		incomplete subfield
2		complete subfield
3		complete field

Indicates whether a query against this index is stripped of punctuation prior to issuing the search. Allowable values are:

TRUE	Strip punctuation. (Default)
FALSE	Do not strip punctuation.

Indicates whether the index supports plural searches. Allowable values are:

TRUE	Supports plural searches
FALSE	Does not support plural searches. (Default)

If not specified, the value defined in the use variable is used.

Indicates whether the index is a restrictor index. A restrictor index is a special index that cannot be searched on its own. It can only be ANDed into a search query. For more information about restrictor indexes in local databases, refer to Restrictor Definitions. Possible values are:

TRUE	This is a restrictor index.
FALSE	This is not a restrictor index. (Default)

Indicates whether this index supports searches containing ranges of values. A typical use for this variable is for indexes that include dates. Allowable values are:

TRUE	Supports ranges.
FALSE	Does not support ranges. (Default)

Whole integer that defines the minimum range value allowed for indexes supporting search ranges.

Whole integer that defines the maximum range value allowed for indexes supporting search ranges.

Set of values that appear in a select list or as radio buttons in the WebZ interface. Specify multiple values as value1, value 2, value 3, and so on, or beginning with version 4.0.2, value*, value*, and so on.

The syntax for a value is DisplayText:SearchString, where DisplayText is the text that appears in the interface and SearchString is the parameter to include in a search.

You must define a set of values for the index to appear in the WebZ or Record Builder interface as a drop-down select list or as radio buttons.

Adds double quotes to the search term if necessary. Allowable values are:

TRUE		Add double quotes.
FALSE		Do not add double quotes. (Default)

Override the collapse list for the query normalization filter specified for the index or the database by specifying a customized collapse list of characters. If you use this variable, you must specify the entire collapse list for the filter, not just the additional characters.

Specify the character set for the search term if it is not the ASCII character set.

Indicates whether to discard a relation attribute contained in a query. This may be necessary if a remote server cannot handle the relation attribute. Allowable values are:

TRUE		Discard the relation attribute.
FALSE		Retain the relation attribute. (Default)

Indicates whether the remote server or the WebZ ZBase server (or the ZBaseRB server, in the case of a Record Builder database) sorts records returned by a search. Possible values are:

TRUE	ZBase performs the sort locally. (Default)
FALSE	Remote server performs the sort.

Characters and character combinations to ignore during a sort. The value for this variable is a comma-separated list of alphanumeric characters.

Syntax of records returned from a sort request. Allowable values are:

BER
MARC
SUTRS

Number of records a remote database server returns at one time in response to a present request (10 records at a time, 20 records at a time, etc.). Applicable only when ZBase sorts the records rather than the remote server (localsort=TRUE).

Maximum number of records to sort in response to a present request.

Maximum number of records to sort in response to a sort request that is piggy-backed in a query.

Sort key identifier. Defines the sort keys that are available to a database. Specify multiple sort key identifiers as key1, key 2, key3, etc., or beginning with version 4.0.2, as key*, key*, and so on. Sort key names can be any combination of alphanumeric characters and can contain no spaces.

Name of the sort key as it appears in the WebZ or Record Builder interface.

Use attribute or index ID of the index that the sort key uses to perform a sort. This value should match the use value of the index being sorted.

Complete BER tag path of the data field on which to sort. Specify multiple paths as parm1, parm2, parm3, and so on, or beginning with version 4.0.2, parm*, parm*, and so on.

Allowable formats for parm values are:

parm* = 700/1,4		(finds subfield 700/1 or 700/4)
parm* = 700/1-4		(finds subfields 7001/ through 700/4)
parm* = 700/*		(finds all subfields in field 700)

You can define only one field in a parm variable. For example, the following syntax is not valid:

parm* = 700/1, 740/1

Amount of data (in bytes) to retrieve from a parm field.

Default: All data in the field.

This variable is especially useful for pulling date information from date fields and is typically used in conjunction with dataoffset.

Beginning byte position (offset) from which to retrieve data in a parm field. The position defined by dataoffset is zero-based. For example, if dataoffset=4, the beginning byte position is 3 (that is, 0, 1, 2, 3).

Java class used to perform the sort. You can specify one of the sort keys in the ORG.oclc.zsorts package or write your own custom sort key.

Default: ORG.oclc.zsorts.DefaultSortKey

Integer that specifies the maximum number of records in a result that can be de-duplicated. Result sets that contain more than the maxdedupRecords value are not de-duplicated.

Default: 200

Integer or percentage that specifies the maximum number or percentage of duplicates associated with a representative record.

Default: 100%

Indicates whether to perform de-duplication on every result set with a result set count less than or equal to the value for maxDedupRecords. Allowable values are:

TRUE	ZBase performs the sort locally.
FALSE	Remote server performs the sort. (Default)

If AutomaticDedupOnEverySearch=FALSE, you can selectively de-duplicate results by including a widget (dedup=true) as a hidden input type in the relevant type HTML file. See Selectively De-Duplicating Results for more information.

Order in which to sort the duplicates for a single cluster record. Allowable values are:

DbNameOrder		By the order specified in the preferredDatabaseNames variable. (Default)
LargestRecordsFirst		Sort by record size, from largest to smallest.
SmallestRecordsFirst		Sort by record size, from smallest to largest.

List of databases that specifies the preferred order to display duplicates underneath a representative record. Insert a space (but no other punctuation) between each database's name.

Name of the de-duplication key.

Use attribute or index ID of the index that the de-duplication key uses to perform the de-duplication. This value should match the use value of the index being used for de-duplication.

Complete BER tag path of the data field on which to de-duplicate. Specify multiple paths as parm*, parm*, and so on.

Allowable formats for parm values are:

parm* = 700/1,4		(finds subfield 700/1 or 700/4)
parm* = 700/1-4		(finds subfields 7001/ through 700/4)
parm* = 700/*		(finds all subfields in field 700)

You can define only one field in a parm variable. For example, the following syntax is not valid:

parm* = 700/1, 740/1

Amount of data (in bytes) to retrieve from a parm field.

Default: All data in the field.

This variable is especially useful for pulling date information from date fields and is typically used in conjunction with dataoffset.

Beginning byte position (offset) from which to retrieve data in a parm field. The position defined by dataoffset is zero-based. For example, if dataoffset=4, the beginning byte position is 3 (that is, 0, 1, 2, 3).

Java class used to perform the de-duplication. You can specify one of the sort keys in the ORG.oclc.zsorts package or write your own custom sort key.

Default: ORG.oclc.zsorts.DefaultSortKey

Comma-separated list of indexes to be displayed by gadgets in the WebZ interface. A name can be any combination of alphanumeric characters but cannot contain spaces.

You can also use the following shorthand values with the name variable in place of a comma-separated list:

Value	Meaning
all	Include all indexes
words	Include all indexes except those in which structure=1 (phrases) or structure=6 (wordlist).
phrases	Include only indexes in which structure=1 (phrases) or structure=6 (wordlist)
allMinusRestrictors	Includes all indexes EXCEPT those in which restrictor=TRUE.

The index list names used in the WebZ OBI, version 1, are:

Name	Use
browse	Indexes that appear on the browse screen (<WebZ_root>/htdocs/obiv1/html/scansearch.html).
limits	Indexes that allow the user to limit a search against another index on the advanced search screen (<WebZ_root>/htdocs/obiv1/html/advancedsearch.html). The indexes in the list may be restrictors, but do not have to be.
long	Indexes that appear on the advanced search screen (<WebZ_root>/htdocs/obiv1/html/advancedsearch.html)
tabbar	Indexes that appear on the first three tabs in the tab bar on the basic search screen (<WebZ_root>/htdocs/obiv1/html/search.html).
short	Shortened list of indexes.

You are free to add or remove names from this list as you modify the WebZ OBI.

Record format for exporting records. The syntax should be the same format in which the record was originally created or imported into the database.

Record format for importing records to an existing local database. The record syntax must be the same format as the syntax of the target database. Failure to match the syntax between the imported record and the target database could harm the database.