ILL Configuration Files

Main -> Documentation -> WebZ System Administration ->Working with WebZ -> WebZ and Interlibrary Loan (ILL) -> ILL Configuration Files

ILL Configuration Files

Contents

Introduction
Document Conventions
Files Specific to Interlibrary Loan
Other Configuration Files That Affect Interlibrary Loan Processing
ILL-Related Information in WebZ Configuration Files

Introduction

This document describes the configuration files that provide WebZ with the information necessary for handling Interlibrary Loan (ILL) requests and their relationship to one another.

Document Conventions

<WebZ_root> is the location of your WebZ environment.
Version 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.
Version 4.1.x refers to SiteSearch 4.1.1, 4.1.2, or 4.1.2a.

Files Specific to Interlibrary Loan

Three types of files pertain specifically to processing ILL requests:

ILL Server Configuration Files, including IllService.ini in SiteSearch 4.1.1 and previous versions
locations.ini
Location configuration files

Beginning with SiteSearch 4.1.2, you edit the ILL server configuration file(s) for the ILL services you use to submit ILL requests. With OCLC ILL Direct Request, sites using the Direct-to-Lender option (and possibly the Direct-to-Profile option) need to edit locations.ini and create individual location configuration files. For other ILL services, check with the vendor to see if you need to provide location information with ILL requests.

In SiteSearch 4.1.1 and earlier, you edit IllService.ini. Only sites using the Direct-to-Lender option (and possibly the Direct-to-Profile option) with OCLC ILL Direct Request need to edit locations.ini and create individual location configuration files.

Return to Contents

Other Configuration Files That Affect Interlibrary Loan Processing

The other files are general WebZ configuration files that have one or more ILL-related sections:

Return to Contents

ILL-Related Information in WebZ Configuration Files

The following diagram shows how the configuration files listed above provide information related to ILL that the OpServe loads into the JaSSI upon system startup or when it starts up a new JaSSI. This information then becomes available to WebZ when it processes ILL requests.

The discussion that follows the diagram explains how each configuration file provides ILL-related information. This diagram refers to ILL processing in SiteSearch 4.1.2 or higher, although the text that follows explains the differences in previous versions. The numbered items in the text refer to the numbers in the diagram.

ILL Configuration Files

JaSSIServer.ini refers to a number of initialization classes that run as part of the JaSSI startup process. Two of these classes handle configuration information related to ILL: ORG.oclc.jassi.ServerMngr and ORG.oclc.isoill.LocationsLoader.

ORG.oclc.jassi.ServerMngr reads the [ServerMngr] section of JaSSIServer.ini, which lists each external server. These servers each have their own section in JaSSIServer.ini.

Beginning with SiteSearch 4.1.2, there are one or more one ILL servers for each ILL service you are using. As shipped, the [ServerMngr] section contains three ILL servers, OclcISOILL, EmailILL, and MimeEmailILL, which are the generic servers for the three supported ILL service types: ISOILL, EMAIL, and MIME_EMAIL, respectively. The diagram includes one of these servers, OclcISOILL. You can also add servers for vendor-specific ILL services.

In SiteSearch 4.1.1 and previous versions, the ILLServer pertains to processing ILL requests.

The [ZBase] section refers to the ZBase .ini file, <WebZ_root>/ini/servers/ZBase.ini, and the initialization class, ORG.oclc.webz.ZServer. This class retrieves configuration information about ZBase from ZBase.ini for the JaSSI.

ZBase.ini includes the variable dbIniFile. dbIniFile specifies the location of the configuration file that contains information about the databases available in the system, databases.ini.

databases.ini refers to the database configuration files that contain specific information about each database. In the example shown, one of these files is Notis.ini.

Four variables in a database configuration file affect ILL processing:

The IllService variable in the [database] section indicates how to process ILL requests for the database. It has these possible values:

Beginning with SiteSearch 4.1.2:

ILL_server_name		Use the ILL server indicated by ILL_server_name.
PROFILED		Use ILL profiling. Find the ILL server indicated for the institution associated with the patron, as contained in the WebZ Access component database, accessdb, or a custom patron authorization database.
NONE		Do not allow any ILL requests from this database.

In SiteSearch 4.1.1 and earlier:

ISOILL		Send requests to OCLC ILL Direct Request.
EMAIL		Send requests to a specified e-mail address.
NONE		Do not allow any ILL requests from this database.

The isoill variable in the [Formats] section specifies the formatting configuration file (version 4.1.x) or formatting class (version 4.0.x) related to formatting the bibliographic record portion of ILL requests.

In SiteSearch 4.1.x, the WebZ Out-of-the-Box Interface (OBI), version 1, contains several formatting configuration files for this purpose:

<WebZ_root>/ini/format/obiv1/MarcArticleILLFormat.ini		(for citation databases)
<WebZ_root>/ini/format/obiv1/MarcCatalogILLFormat.ini		(for catalog databases)
<WebZ_root>/ini/format/obiv1/NotisILLFormat.ini		(an example of a server-specific formatting configuration file; see <WebZ_root>/ini/format/obiv1 for others)

Analogous formatting classes are ORG.oclc.fmts.obi.MarcArticleISOILLFmt for citation databases, ORC.oclc.fmts.obi.MarcISOILLFmt for catalog databases, and other server-specific formatting classes, such as ORG.oclc.fmts.obi.NotisISOILLFmt. SiteSearch 4.0.x versions use formatting classes instead of formatting configuration files. You can also use formatting classes in SiteSearch 4.1.x if you wish.

You can also create your own formatting rules (which are contained in the formatting configuration files) or formatting classes to format bibliographic records in ILL requests.

Beginning with SiteSearch 4.1.2, the illdbkey variable specifies the formatting configuration file for the optional ILL double check feature. This file (<WebZ_root>/ini/format/obiv1/ILLDoubleCheck.ini) contains the field to check in the search to see if the "home" database contains a desired item before letting a patron submit an ILL request.
Beginning with SiteSearch 4.1.2, the dblchkholdings variable specifies the formatting configuration file that contains the display specification for formatting the record on the double check display screen.

The [OclcISOILL] section refers to an ILL server configuration file, <WebZ_root>/ini/servers/OclcISOILL.ini, and initialization class, ORG.oclc.webz.ILLServer. Every other ILL server included in the [ServerMngr] section has its own section that refers to its ILL server configuration file and initialization class.

In SiteSearch 4.1.1 and earlier versions, there is an [ILLServer] section that refers to the same initialization class and its configuration file, IllService.ini.

ORG.oclc.webz.ILLServer reads the appropriate ILL server configuration file and adds information from this file to the JaSSI. If the destination is an ILL service that accepts BER-encoded requests (ISOILL service type), the file contains information necessary to connect the service. If the destination is an e-mail address (EMAIL service type) or an ILL service that accepts requests as MIME e-mail attachments (MIME_EMAIL service type), it contains information about the source, destination, and subject of e-mail requests. For all destinations, the file also includes ILL shipping and billing information.

When ORG.oclc.isoill.LocationsLoader runs, it collects information needed to translate the names of lender locations into their lender strings (the three-character OCLC symbols that identify potential lenders in an ILL request sent to OCLC ILL Direct Request or tje symbols required by other ILL services).

This class reads the [Locations] section of JaSSIServer.ini, which points to locations.ini. This configuration file lists the names of location configuration files. In the diagram, Notisloc.ini is an example of a location configuration file for a particular database. It contains the names of locations (libraries or branches) in the database and their OCLC symbols (or beginning with SiteSearch 4.1.2, the location symbols required by other ILL services).

ORG.oclc.gadgets.GadgetAndStyleLoader (not shown in the diagram) creates style tables for each style listed in the [InterfaceStyles] section of JaSSIServer.ini.

In the diagram, the .ini file frameGreenStyle.ini refers to the interface style files that contain configuration information for the default style. (These files collectively contain all the information stored in defaultStyle.ini in 4.0.x versions.) You can find these files in the <WebZ_root>/ini/interface/obiv1 directory. The diagram shows the sections of these files that pertain to displaying ILL forms in the WebZ interface:

File	Section	Relevance to ILL
fontsArial.ini	[fonts]	Font sizes for the text, labels, header, and copyright notice on the ILL request form.
colorsGreen.ini	[colors]	Colors for text and input boxes on ILL screens.
imagesGreen.ini	[images]	Image for Interlibrary Loan button on the full record display screen.
pagesFrame.ini	[pages]	HTML pages for the ILL form screen and the ILL confirmation screen.
pagesFrame.ini	[targets]	Frame to use to display ILL screens in a frames-based interface.
BaseStyle.ini	[defaults]	The generic name used to refer the patron on the ILL request form, such as "patron". Beginning with SiteSearch 4.1.2, the system-wide "home" library to use for ILL double check and whether to let the patron submit an ILL request for the item if the "home" library's catalog contains the item. Beginning with SiteSearch 4.1.2, whether to allow the patron to submit an ILL request for a item contained in the home library database. Beginning with SiteSearch 4.1.2, the ILL verbs to use for processing each of the supported ILL service types (ISOILL, EMAIL, and MIME_EMAIL).
	[ILLConfirm]	Gadget that formats information provided in an ILL request and displays it for the patron on the ILL confirmation screen.
	[messages]	Messages displayed after WebZ sends an ILL request, when WebZ cannot process an ILL request, when the patron is not authorized to submit an ILL request, when a patron must reauthorize to continue submitting ILL requests, a copyright notice, and a notice that a home library contains an item the patron wants to obtain through ILL.
	[anchors]	Anchors (with links to other pages) that appear on ILL screens.

ORG.oclc.gadgets.GadgetAndStyleLoader completes the style tables by reading the [InterfaceDisplayGadgets] section of JaSSIServer.ini and reads the configuration files containing information about each style's gadgets for displaying information on HTML pages.

In the OBI, version 1, frameDisplayGadgets.ini contains an [ISOILLRecordFmt] section. This section specifies the gadget (ORG.oclc.gadgets.IllForm) and formatting class (isoill) to use when formatting a bibliographic record on ILL screens. The fmt = isoill statement refers to the isoill formatting configuration file specified in the database configuration file's [Formats] section. In the diagram, this is <WebZ_root>/ini/format/obiv1/NotisILLFormat.ini, as shown in Notis.ini.

Similarly, the [DoubleCheck], [DoubleCheckHeader], and [DoubleCheckTrailer] sections specify the gadgets to use for formatting information on the ILL double check screen – the record held by a home library and the header and trailer sections of this screen, respectively.

Return to Contents

[Main][Documentation][Support][Technical Reference][Community][Glossary][Search]

Last Modified: