|
IllService.ini
Configuration File
Contents
Introduction
Sections in IllService.ini
Variables in Each Section of IllService.ini
[ILLServer]
[IllInfo]
[EmailInfo]
[LibraryDeliveryInfo]
[LibraryBillingInfo]
IllService.ini Example
Introduction
This document
describes the contents of the IllService.ini file.
In SiteSearch
4.1.1 and earlier, you need to edit the IllService.ini file as part
of configuring WebZ to generate Interlibrary Loan (ILL) requests. Some
sections in this file pertain to WebZ's interaction
with the OCLC ILL Direct Request Service, other sections pertain to
WebZ's ability to route ILL requests to a
specified e-mail address and still other sections pertain to both
ILL methods. This document uses ISOILL and EMAIL, respectively, as shorthand
terms for the two ILL methods.
You select an ILL method for every database for which you want to enable WebZ to generate ILL requests submitted by patrons.
You can find IllService.ini
in the <WebZRoot>/ini/servers directory, where <WebZ_root>
is the directory where you have installed SiteSearch.
Beginning with
SiteSearch 4.1.2, there are ILL server configuration files specific
to the three supported ILL service
types. See ILL Server Configuration Files
for more information.
Sections in IllService.ini
|
Section
|
Description
|
Applicable
to
|
|
[ILLServer]
|
Defines
the way that WebZ routes patron requests to the OCLC ILL Direct
Request Service.
|
ISOILL
|
|
[IllInfo]
|
Defines
general default ILL information like reauthorization limit, copyright
compliance, notes, and a need before date.
|
ISOILL
EMAIL
|
|
[EmailInfo]
|
Defines
the source, destination, subject line, and first line of e-mail
messages that contain ILL requests.
|
EMAIL
|
[MIMEEmailInfo]
(beginning with SiteSearch 4.1.1) |
Reserved
for future use. |
N/A at present |
|
[LibraryDeliveryInfo]
|
Defines
the name, address, and communication methods for the library where
the materials requested in ILL requests should be delivered.
|
ISOILL
EMAIL
|
|
[LibraryBillingInfo]
|
Defines
the name, address, and billing method for the library charged for
ILL requests.
|
ISOILL
EMAIL
|
Return
to Contents
Variables in Each Section of IllService.ini
See the IllService.ini Example in this document for default values for each variable.
[ILLServer]
This section applies only to ISOILL requests.
| Note: |
The only
variables in this section that you must specify in IllService.ini
are the hostname and port. The remaining variables allow you to
provide values that apply to all ISOILL requests. 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 OCLC ILL Direct Request.
|
|
Variable
|
Definition
|
|
hostname
|
Name of
the ILL server at OCLC. See the note for the port variable.
|
|
port
|
Name of
the port you intend to use at the server specified in the hostname
variable.
| Note: |
IllService.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) |
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
|
Your OCLC
ILL symbol. 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
|
The 9-digit
authorization code that grants access to the ILL server. The default
value (100-091-178) applies to ACQ.
|
|
password
|
The OCLC
ILL password that grants access to the ILL server. The default value
(test) applies to ACQ.
|
|
changeSendTo
|
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).
If changeSendTo
= true, ILL Direct Request supplies potential lenders for the request,
based on the lenders in the Custom Holdings path you have established
with OCLC DirectRequest for the profile that matches this request.
If changeSendTo
= 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.
|
|
OrderPreference
|
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.
If orderPreference
= ordered, ILL DirectRequest 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.
If orderPreference
= 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.
|
|
OclcIllServiceType
|
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.
|
|
Source
|
Indicates
the database where the ILL request originated. The default value
is SiteSearch-4.1.0. A formatting
rule (ORG.oclc.fmts.rules.AddILLDatabaseName)
referenced by the database's isoill formatting
configuration file, or 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
|
Lists the
names of your ILL partners. This variable is optional.
|
Return
to Contents
[IllInfo]
This section applies to both ISOILL and EMAIL ILL requests.
| Note: |
(1) Unless otherwise indicated, all variables in this section are optional.
(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 reauthoLimit and requesterNote variables
when WebZ submits ILL requests to OCLC ILL Direct Request.
|
|
Variable
|
Definition
|
|
DefaultService
|
For blank ILL forms filled out online by patrons. This variable uses the values you set to route the form. Possible values are EMAIL or ISOILL.
| Note: |
You should only use the DefaultService variable for the resource sharing style (rssStyle.ini). Comment out this variable if you are not using the resource sharing style.
|
|
|
reauthoLimit
|
Number of ILL requests a user can make before she/he has to reauthorize.
A value of 0 means that the user can make unlimited requests without reauthorizing.
|
|
CopyrightCompliance
|
Defines
whether your library adheres to standard copyright policy.
Beginning
with SiteSearch 4.1.1, possible values are US:CCL, US:CCG, or blank.
- US:CCL
- if you conform to U.S. copyright law
- US:CCG
- if you conform to copyright guidelines
- blank
(no data) - if you use another method of ensuring copyright compliance
For other
SiteSearch versions,
possible values are CCL, CCG, or blank.
- CCL -
if you conform to U.S. copyright law
- CCG -
if you conform to copyright guidelines
- blank
(no data) - if you use another method of ensuring copyright compliance
|
|
NeedBeforeDate
|
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: |
This field is optional. OCLC recommends that you leave it blank. For ISOILL requests, if there is no value in IllServer.ini and the patron does not enter a Need Before Date on the ILL form, the Need Before Date comes your ILL Constant Data or defaults to 30 days from the current date.
|
|
|
RequesterNote
|
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]
This section applies to EMAIL ILL requests.
| Note: |
Unless otherwise indicated, all variables in this section are required.
|
|
Variable
|
Definition
|
|
EmailAddress
|
Destination e-mail address for ILL requests originating from databases configured to process ILL requests by e-mail.
|
|
server
|
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
|
|
from
|
Address to use in the "From" line of the e-mail message.
|
|
subject
|
Subject line in the e-mail message containing the ILL request. This variable is optional.
| 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
|
First line in the body of the e-mail message that contains the ILL request. This variable is optional.
|
Return
to Contents
[LibraryDeliveryInfo]
This section applies to both ISOILL and EMAIL ILL requests. For ISOILL requests, ILL Direct Request maps this information to the OCLC ILL :SHIPTO: field.
| Note: |
(1) Unless otherwise indicated, all variables in this section are optional. 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 to OCLC ILL Direct Request.
|
|
Variable
|
Definition
|
|
Name
|
Name of the library where materials requested in ILL requests should be delivered (the "borrowing library").
|
|
ExtendedAddress
|
Optional second line for the library name, such as a department name.
|
|
Address
|
Street address of the borrowing library.
|
|
POBox
|
Post office box of the borrowing library.
|
|
City
|
City of the borrowing library.
|
|
Region
|
Region (state, province, etc.) of the borrowing library.
|
|
Zip
|
Zip or postal code of the borrowing library.
|
|
Country
|
Country of the borrowing library.
|
|
Fax
|
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.
|
|
Email
|
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
|
Delivery method for sending borrowed materials to the library. Possible values are MAIL, EMAIL, or LIBRARY RATE (use LIBRARY RATE if you receive the postage discount from the U.S. Postal Service for shipping materials) here.
|
|
ElectronicService
|
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]
This section applies to both ISOILL and EMAIL ILL requests. For ISOILL requests, ILL Direct Request maps this information to the OCLC ILL :BILLTO: field.
| Note: |
(1) Unless otherwise indicated, all variables in this section are optional. 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
|
Name of the borrowing library that should be billed for the requested material.
|
|
ExtendedAddress
|
Optional second line for the library name, such as a department name.
|
|
Address
|
Street address of the borrowing library's billing address.
|
|
POBox
|
Post office box of the borrowing library's billing address.
|
|
City
|
City of the borrowing library's billing address.
|
|
Region
|
Region (state, province, etc.) of the borrowing library's billing address.
|
|
Zip
|
Zip code or postal of the borrowing library's billing address.
|
|
Country
|
Country of the borrowing library's billing address.
|
|
AccountNumber
|
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
|
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
|
Defines the type of currency you are using to make the transaction.
|
Return
to Contents
IllService.ini Example
This example shows
IllService.ini as it appears right after installation in SiteSearch 4.1.1.
[ILLServer]
# Host and port for testing
hostname = testenv.oclc.org
port = 5771
responderId =
# Host and port for production
#hostname = isoill.oclc.org
#port = 499
# Change to your own symbol, autho, and password
instSym = ACQ
autho = 100-091-178
password = test
# ILL DIRECT REQUEST profile flags
# changeSendTo (true or false)
# orderPreference (ORDERED or UNORDERED)
# OclcIllServiceType (directToReview, directToProfile, directToLender)
changeSendTo = false
orderPreference = UNORDERED
OclcIllServiceType = directToReview
# Formatting classes change Source to database name
Source = SS-4.0.1
Affiliations = Name your ILL partners here.
[IllInfo]
DefaultService = EMAIL
reauthoLimit = 0
CopyrightCompliance= US:CCG
NeedBeforeDate =
RequesterNote = This is a test.
[EmailInfo]
EmailAddress = yourill@yourhost.edu
server = yourhost.edu
from = ILLEmail@yourhost.edu
subject = RSS ILL Request
message = This message was generated by ILLEmail.
[MIMEEmailInfo]
# Used when IllService=ILLMIME
# Change these to reflect your email address & SMTP server
#What office is supposed to receive ISO-10161 ILL emails?
MEmailAddress = ILLdepartment@yourlibrary.org
#What is your mail server? Probably same as the one above
Mserver = Mailserver.your.library.org
#What is your canned return address?
Mfrom = ILLEMAIL@yourlibrary.org
#DO NOT CHANGE THE SUBJECT LINE : required by the IPIG standard
Msubject = ISO-10161-ILL-1
#Sender (may be the same as the canned return address)
Msender = whosentthemessage@here.edu
#Replyto address - (may be the same as the canned return address)
Mreplyto = replyaddress@here.edu
[LibraryDeliveryInfo]
# This information is for the OCLC ILL :SHIPTO: field
Name = Dallas Suburban
ExtendedAddress = Shipping and Receiving
Address = 1 Suburb Street
POBox =
City = Dallas
Region = TX
Zip = 39393
Country = US
Fax =
EMail = suburb@dallas.edu
Service = Mail
# FAX or EMAIL
ElectronicService =
[LibraryBillingInfo]
# This information is for the OCLC ILL :BILLTO: field
Name = Dallas Public Library
ExtendedAddress = Billing Department
Address = 1 Main Street
POBox =
City = Dallas
Region = TX
Zip = 39393
Country = US
AccountNumber =
MaxCostForItem =
CurrencyCode = USD
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
|