|
ILL Server
Configuration Files
Contents
Introduction
Document Conventions
Sections in ILL Server Configuration Files
Variables in Each Section of ILL Server Configuration
Files
[ILL_server_name]
[IllInfo]
[EmailInfo]
[MIMEEmailInfo]
[LibraryDeliveryInfo]
[LibraryBillingInfo]
Introduction
An ILL server
configuration file contains information needed to route requests to a
particular interlibrary loan (ILL) service, including its ILL service
type, destination, autho and password (if required), billing and shipping
information, and other ILL-related variables.
SiteSearch
4.1.2 and higher ships with several generic and vendor-specific ILL
server configuration files, corresponding to the three supported ILL
service types:
|
Service
Type
|
Configuration
Files
|
Use
|
| ISOILL |
OclcISOILL.ini
MnScuISOILL.ini PigasusISOILL.ini
TlcISOILL.ini |
Vendor-specific
ILL server configuration files for sending BER-encoded ILL requests
to IPIG-compliant
ILL systems. |
| EMAIL |
EmailILL.ini
|
Generic
ILL server configuration file for routing an ILL request to an e-mail
address. |
| MIME_EMAIL |
MimeEMailILL.ini
|
Generic
ILL server configuration file for sending an ILL request as a multi-part
MIME attachment to an e-mail message. |
MnScuMimeEmailILL.ini
RlgMimeEMailILL.ini
|
Vendor-specific
ILL server configuration files for sending ILL requests to IPIG-compliant
ILL systems as multi-part MIME attachments. |
In SiteSearch
4.1.1 and previous versions, there is one ILL server configuration
file, IllService.ini. See IllService.ini Configuration
File for information about this file.
Document
Conventions
General
Conventions
- <WebZ_root>
is the location of your WebZ environment.
Required and Optional
Sections for Each ILL Service Type
This document contains
a description of each section in ILL server configuration files. For each
section, the applicable ILL server types are indicated in the section
title by ILL service type. A section can be either
optional, required, or not applicable for a particular ILL service type,
as shown in the following examples:
| Example |
Explanation |
| [ILL_server_name]
Section – Required for: ALL |
The [ILL_server_name]
section is required for all ILL service types |
| [EMailInfo]
Section –
Required for:
EMAIL |
The [EMailInfo]
section is required for the EMAIL ILL service type. It does not apply
to the other ILL service types. |
Required and Optional
Variables for Each ILL Service 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 an ILL service type, not all the variables in the section
may be relevant for that ILL service type. For example, the [ILL_server_name]
section is required for all ILL service 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 ILL service 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 ILL service types to which the variable applies,
like these examples:
| Variable |
Description |
| serviceType |
Required
for: ALL |
|
The serviceType variable is required for all ILL service types. |
| subject |
Optional
for: EMAIL |
|
The
subject variable is optional only for the EMAIL service type. It does
not apply to other ILL service types. |
| instSym |
Required
for: ISOILL (OCLC Direct Request only)
Optional for: Other ISOILL |
|
The
instSym variable is required only for OCLC Direct Request. It is optional
for other supported ILL services
of the ISOILL service type. It does not apply to other ILL service
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.
Return
to Contents
Sections
in ILL Server Configuration Files
|
Section
|
Description
|
Applicable
to
|
|
[ILL_server_name]
|
Defines
the ILL service type and provides additional information for routing
ILL requests, particularly for the ISOILL service type.
|
ALL
|
|
[IllInfo]
|
Defines
general default ILL information like reauthorization limit, copyright
compliance, notes, and a need before date.
|
ALL
|
|
[EmailInfo]
|
Defines
the source, destination, subject line, and first line of e-mail
messages that contain ILL requests.
|
EMAIL
|
| [MIMEEmailInfo]
|
Defines the
source, destination, subject line, sender and reply to address for
e-mail messages that contain ILL requests as multi-part MIME attachments. |
MIME_EMAIL |
|
[LibraryDeliveryInfo]
|
Defines
the name, address, and communication methods for the library where
the materials requested in ILL requests should be delivered.
|
ALL
|
|
[LibraryBillingInfo]
|
Defines
the name, address, and billing method for the library charged for
ILL requests.
|
ALL
|
Return
to Contents
Variables
in Each Section of ILL Server Configuration Files
[ILL_Server_Name] – Required
for: ALL
| Note: |
If you
use WebZ's Access component (which
includes the accessdb database or
your own patron authorization database) to control patron authorization
to WebZ, institution-specific information in accessdb or your database
overrides the data from the InstSym, autho, and password variables
when WebZ submits ILL requests to an ILL service of the ISOILL service
type.
|
|
Variable
|
Definition
|
| serviceType |
Required
for: ALL |
|
ILL service
type for this ILL server. Possible values are:
|
| hostname |
Required
for: ISOILL |
|
Name of
the server that the ILL service uses to receive and process ILL
requests.
|
|
port
| |
Required
for: ISOILL (OCLC Direct Request only)
Optional for: Other ISOILL |
|
Name of
the port you intend to use at the server specified in the hostname
variable.
| Note: |
The
ILL server configuration file for OCLC ILL Direct Request
(OclcISOILL.ini) has two sets of hostname and port variables
after installation. The first set of variables refers to the
hostname and port for the OCLC ILL Direct Request test server.
The second set of variables applies to the OCLC ILL Direct
Request production server. Comment out the section that you
do not want to use.
|
|
responderId
(beginning with SiteSearch 4.1.1) |
Optional
for: ISOILL
MIME_EMAIL |
|
The ID symbol
possibly needed for an IPIG-compliant
ILL system other than OCLC ILL Direct Request. Leave this variable
blank for OCLC ILL Direct Request. |
| instSym |
Required
for: ISOILL (OCLC Direct Request only)
Optional for: Other ISOILL |
|
Identifier,
such as your OCLC ILL symbol, that identifies your institution to
the ILL service. In OclcISOILL.ini, the default value, ACQ, applies
to a test account that you can use for sending requests to the OCLC
ILL Direct Request test server to test
WebZ's interaction with OCLC ILL Direct Request.
|
| autho |
Required
for: ISOILL (OCLC Direct Request only)
Optional for: Other ISOILL |
|
Authorization
code that grants access to your institution's account at the ILL
service. For OclcISOILL.ini, the default value (100-091-178) applies
to the ACQ institution symbol.
|
| password |
Required
for: ISOILL |
|
The password
that grants access to the ILL service. For OclcISOILL.ini, the default
value (test) applies to ACQ.
|
| defaultService |
Required
for: ALL (if using the resource sharing style)L |
|
Indicates
whether this is the default ILL server to use when a patron requests
a blank ILL form. This variable only applies to the resource sharing
style (rssStyle.ini).
| TRUE |
|
Use
this ILL server to process an ILL request when a patron
completes a blank ILL form.
Only
one ILL server configuration file can have this variable
set to TRUE.
|
| FALSE |
|
Do
not use this ILL server to process an ILL request when a
patron completes a blank ILL form.
|
|
| timeTheSocketConnect |
Required
for: ISOILL |
|
Indicates whether
to invoke a 10,000 millisecond timer to time the connection on the
call to newSocket(). For situations where a remote server may not
respond quickly to failed connection attempts. Possible values are:
| TRUE |
|
Invoke
the timer. |
| FALSE |
|
Do
not invoke the timer. (DEFAULT)
|
|
| changeSendTo |
Required
for: ISOILL (OCLC ILL Direct Request only) |
|
Controls
the value of the permissionToChangeSendList variable in the ISO-10161
ILL Request sent to OCLC if you are using the ILL Direct Request
Direct-to-Profile option (see OclcIllServiceType).
Possible values are:
| TRUE |
|
ILL
Direct Request supplies potential lenders for the request,
based on the lenders in the Custom Holdings path you have
established with OCLC Direct Request for the profile that
matches this request.
|
| FALSE |
|
ILL
Direct Request does not try to supply lenders from the Custom
Holdings path for the profile that matches this request.
If
the request contains no potential lenders, OCLC supplies
potential lenders from the Custom Holdings path for the
profile that matches this request regardless of the value
of the changeSendTo variable.
|
For more
information on the permissionToChangeSendToList, see the Direct-to-Profile
section in the OCLC
ILL Direct Request Service Planning Guide.
|
|
|
Sets the
preference code in the ISO-10161
ILL Request if you are using the Direct-to-Profile or Direct-to-Lender
options. The preference code allows you to indicate whether ILL
Direct Request can change the order of the lender symbols you include
in a request. Possible values are:
| ordered |
|
ILL
Direct Request stops adding lenders to to the ILL request
when it encounters an invalid OCLC symbol in the list of lenders
provided with the ILL request. |
| unordered |
|
ILL
Direct Request skips over an invalid lender and continues
to validate lender symbols.
|
For more
information about the preference code, see the OCLC
ILL Direct Request Service Planning Guide.
|
|
|
Indicates
your OCLC ILL Direct Request processing option, which must be one
of the following:
| directToReview |
|
Direct-to-Review
File option, where OCLC sends all ILL requests to your
OCLC ILL Review File for processing by your staff. |
| directToProfile |
|
Direct-to-Profile
option, which matches the patron's request against profiles
that you have set up for OCLC ILL Direct Request. Based
on the matches between the request and a profile, OCLC may
send the request to your ILL Review File for staff processing,
or may send the request to the first potential lender.
|
| directToLender |
|
Direct-to-Lender
option, where OCLC forwards patron requests through OCLC ILL
to the first potential lender without any review by your staff.
|
For more
information on the processing options, see WebZ
and OCLC ILL Direct Request or the OCLC
ILL Direct Request Service Planning Guide.
|
|
|
Indicates
the database where the ILL request originated. Beginning with SiteSearch
4.1.2a, a formatting
rule (ORG.oclc.fmts.rules.AddILLDatabaseName)
referenced by the database's isoill formatting
configuration file, the isoill formatting class defined for
the database, ORG.oclc.fmts.obi.MarcArticleISOILLFmt,
ORG.oclc.fmts.obi.MarcISOILLFmt,
or a custom or server-specific formatting rule or class, changes
the source to the database name when WebZ processes ILL requests.
|
| Affiliations |
Optional
for: ALL |
|
Lists the
names of your ILL partners.
|
Return
to Contents
[IllInfo] – Optional
for ALL
| Note: |
If you
use WebZ's Access component (which
includes the accessdb database or
your own patron authorization database) to control patron authorization
to WebZ, institution-specific information in accessdb or your database
overrides the data from the reauthoLimit and requesterNote variables
when WebZ submits ILL requests to an e-mail address.
|
|
Variable
|
Definition
|
| reauthoLimit |
Optional
for: ALL |
|
Number of
ILL requests a patron can make before she/he has to reauthorize.
A value
of 0 (the default) means that a patron can make unlimited requests
without reauthorizing.
|
| CopyrightCompliance |
Optional
for: ALL |
|
Defines
whether a particular ILL request adheres to standard copyright policy.
Possible values are:
|
SiteSearch
4.1.1 and higher
|
|
SiteSearch
4.1.0 and prior versions
|
|
Description
|
| US:CCL |
|
CCL |
|
You
conform to U.S. copyright law. |
| US:CCG |
|
CCG |
|
You
conform to copyright guidelines.
|
| blank
(no data) |
|
blank
(no data) |
|
You
use another method of ensuring copyright compliance. (RECOMMENDED) |
|
| NeedBeforeDate |
Required
for: ISOILL (MnSCUISOILL only)
Optional for: ALL others |
|
The date
after which the material is of no use to the patron, in the format
YYYYMMDD, where YYYY is a four-digit year, MM is the month, and
DD is the day. Use trailing zeros for months and days less than
10.
Example:
NeedBeforeDate =YYYYMMDD
| Note: |
OCLC
recommends that you leave this field blank for OCLC ILL Direct
Request. If there is no value in in this field and the patron
does not enter a Need Before Date on the ILL form, OCLC ILL
Direct Request uses the Need Before Date specified in your
ILL Constant Data or sets the need before date to 30 days
after the current date.
|
|
| requesterNote |
Optional
for: ALL |
|
General
note that appears in all requests. You can use this for any purpose
you wish. For example, if you are testing your WebZ ILL capabilities,
you could use this field to indicate that this is a test ILL request
rather than an actual request from a patron.
|
Return
to Contents
[EmailInfo]
– Required for: EMAIL
|
Variable
|
Definition
|
| EmailAddress |
Required
for: EMAIL |
|
Destination
e-mail address for ILL requests originating from databases configured
to process ILL requests from this ILL server.
|
| server |
Required
for: EMAIL |
|
Name of
the SMTP (Simple Mail Transfer Protocol) server that handles e-mail
requests from your SiteSearch system. This is often, but not always,
the same host machine (server) where you have installed SiteSearch.
Possible values are the name or Internet Protocol (IP) address of
the server, localhost, or blank (no value):
- name
or IP address of the mail server - if your mail server resides
on a different host than SiteSearch
| Examples: |
server=oa1-server.dev.oclc.org
server=125.6.18.32 |
- localhost
or blank (no value) - if your mail server resides on the same
host as SiteSearch
|
|
|
Address
to use in the "From" line of the e-mail message.
|
| subject |
Optional
for: EMAIL |
|
Subject
line in the e-mail message containing the ILL request.
| Note: |
Your
e-mail program may be able to filter e-mail messages into
specific folders. If so, you may benefit from entering a subject
that your e-mail software can easily send to a specific folder.
|
|
| message |
Optional
for: EMAIL |
|
First line
in the body of the e-mail message that contains the ILL request.
|
Return
to Contents
[MIMEEmailInfo]
– Required for: MIME_EMAIL
|
Variable
|
Definition
|
| MEmailAddress |
Required
for: MIME_EMAIL |
|
Destination
e-mail address for ILL requests originating from databases configured
to process ILL requests from this ILL server.
|
| Mfrom |
Required
for: MIME_EMAIL |
|
Address
to use in the "From" line of the e-mail message.
|
| Msubject
|
Required
for: MIME_EMAIL |
|
Subject
line in the e-mail message containing the ILL request. The value
required by the IPIG profile is ISO-10161-ILL-1. DO NOT delete or
change this value.
|
| Msender
|
Required
for: MIME_EMAIL |
|
Sender of
the e-mail message in the form of an e-mail address. This may be
the same as the value for the MEmailAddress
variable.
|
| Mreplyto
|
Required
for: MIME_EMAIL |
|
E-mail address
to send a response to the ILL request. This may be the same as the
value for the MEmailAddress variable. |
Return
to Contents
[LibraryDeliveryInfo]
– Optional for: ALL
For ISOILL requests
sent to OCLC ILL Direct Request, ILL Direct Request maps this information
to the OCLC ILL :SHIPTO: field.
| Note: |
(1) Remove
the default data for any variables that do not apply to your site.
(2) If you use WebZ's Access component
(which includes the accessdb database
or your own patron authorization database) to control patron authorization
to WebZ, institution-specific information in accessdb or your database
overrides the data from every variable in this section (except ElectronicService
or Service) when WebZ submits ILL requests an to an ILL service.
|
|
Variable
|
Definition
|
|
|
Name of
the library where materials requested in ILL requests should be
delivered (the "borrowing library").
|
| ExtendedAddress |
Optional
for: ALL |
|
Optional
second line for the library name, such as a department name.
|
| Address
|
Optional
for: ALL |
|
Street address
of the borrowing library.
|
|
|
Post office
box of the borrowing library.
|
|
|
City of
the borrowing library.
|
|
|
Region (state,
province, etc.) of the borrowing library.
|
|
|
Zip or postal
code of the borrowing library.
|
| Country |
Optional
for: ALL |
|
Country
of the borrowing library.
|
|
|
Fax number
of the borrowing library. If you set the value of the ElectronicService
variable to FAX, enter the fax number (including area code) where
electronic copies of materials should be sent.
|
|
|
E-mail address
at the borrowing library. If you set the value of the ElectronicService
variable to EMAIL, enter the e-mail address for sending electronic
copies of requested material here.
|
| Service
|
Optional
for: ALL |
|
Delivery
method for sending borrowed materials to the library. Possible values
are:
| MAIL |
|
Send using
U.S. first class mail. |
| EMAIL |
|
Send in
an e-mail message. |
| LIBRARY
RATE |
|
Send
using the Library Rate postage discount from the U.S. Postal
Service for shipping materials |
|
|
|
Indicates
whether to send copies of requested materials by fax (FAX) or by
e-mail (EMAIL).
| Note: |
Make
sure that you provide the appropriate destination e-mail address
and/or a fax number in the Fax or Email
variables.
|
|
[LibraryBillingInfo]
– Optional for: ALL
For ISOILL requests
sent to OCLC ILL Direct Request, ILL Direct Request maps this information
to the OCLC ILL :BILLTO: field.
| Note: |
(1) Remove
the default data for any variables that do not apply to your site.
(2) If you use WebZ's Access component
(which includes the accessdb database
or your own patron authorization database) to control patron authorization
to WebZ, institution-specific information in accessdb or your database
overrides the data from the variables in this section when WebZ
submits ILL requests to OCLC ILL Direct Request.
|
|
Variable
|
Definition
|
|
|
Name of
the borrowing library that should be billed for the requested material.
|
| ExtendedAddress
|
Optional
for: ALL |
|
Optional
second line for the library name, such as a department name.
|
| Address |
Optional
for: ALL |
|
Street address
of the borrowing library's billing address.
|
|
|
Post office
box of the borrowing library's billing address.
|
|
|
City of
the borrowing library's billing address.
|
|
|
Region (state,
province, etc.) of the borrowing library's billing address.
|
|
|
Zip code
or postal of the borrowing library's billing address.
|
| Country |
Optional
for: ALL |
|
Country
of the borrowing library's billing address.
|
| AccountNumber |
Optional
for: ALL |
|
Billing
account number for the borrowing library.
This can
be any account number you use for this purpose, such as a credit
card number.
|
| MaxCostForItem |
Optional
for: ALL
|
|
Maximum
cost the borrowing library will pay for the requested material.
| Note: |
If
you enter a value for this variable, you must specify the
type of currency by providing a value for CurrencyCode.
|
|
| CurrencyCode |
Optional
for: ALL
Required if: MaxCostForItem contains a value |
|
Defines
the type of currency you are using to make the transaction.
|
Return
to Contents
See Also
WebZ
and Interlibrary Loan
ILL Configuration Files
WebZ and E-Mail ILL Requests
WebZ and OCLC ILL Direct Request
Access Component Overview
accessdb Database
|