Configuring WebZ to Use OCLC ILL Direct Request

Main -> Documentation -> WebZ System Administration ->Working with WebZ -> WebZ and Interlibrary Loan -> WebZ and OCLC Direct Request -> Configuring WebZ to Use OCLC ILL Direct Request

Configuring WebZ to Use OCLC ILL Direct Request

Contents

Introduction
Information Needed for This Procedure
Step-by-Step Procedure

Introduction

This document describes how to configure WebZ to send patron-generated ILL requests to the OCLC ILL Direct Request Service for databases for which you wish to route ILL requests in this manner.

Review WebZ and OCLC ILL Direct Request before you start this procedure.

Note:

While configuring some databases to route ILL requests to the OCLC ILL Direct Request Service, you can also route ILL requests from other databases to a specified e-mail address. See WebZ and E-Mail ILL Requests for more information.

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.

Information Needed for This Procedure

Before you start this procedure, make sure that you know the following:

Databases for which you wish to enable ILL requests to OCLC ILL Direct Request and the names of their database configuration files
The ILL Direct Request environment (test or production) to which you want to route ILL requests
Your OCLC symbol, ILL authorization, and ILL password, if you are ready to route ILL requests to the OCLC ILL Direct Request production environment or to use your OCLC ILL account in the test environment
The OCLC ILL Direct Request processing option (Direct-to-Review File, Direct-to-Profile, or Direct-to-Lender) you are using
If you are using the Direct-to-Profile or Direct-to-Lender option, whether you want ILL Direct Request to change the order of lender symbols in ILL requests submitted by WebZ
If you are using the Direct-to-Profile option, whether you want ILL Direct Request to supply potential lenders for ILL requests from the Custom Holdings paths you have set up with ILL Direct Request, in addition to those WebZ submits with ILL requests
Whether you use the resource sharing interface style (rssStyle) or have customized your WebZ interface to allow patrons to display a blank ILL form
Whether you want patrons to reauthenticate periodically if they submit multiple ILL requests during a single session
ILL shipping and billing information for your site
Method you wish to use (e-mail or fax) for receiving copies of resources

Step-by-Step Procedure

Follow these steps to route ILL requests to OCLC ILL Direct Request for selected databases.

Editing Database Configuration Files

1. Use a text editor to open the database configuration file for the first database for which you want to enable ILL requests to ILL Direct Request. You can find the database files in the <WebZ_root>/ini/dbs directory, where <WebZ_root> is the directory where you have installed SiteSearch.

2 Set the IllService variable (in the [database] section) of the file to ISOILL.

3. Set the isoill variable (in the [Formats] section) refer to the desired formatting configuration file or formatting class):

Version 4.1.0:
- Use the <WebZ_root>/ini/format/obiv1/MarcCatalogILLFormat.ini formatting configuration file for catalog databases.
- Use the <WebZ_root>/ini/format/obiv1/MarcArticleILLFormat.ini formatting configuration file for citation databases.
- Use a server-specific formatting configuration file, such as <WebZ_root>/ini/format/obiv1/NotisILLFormat.ini.
  OR
- Provide your own formatting configuration file.
  OR
- Use a formatting class, as described for Version 4.0.x.
Version 4.0.x:

Use the MarcISOILLFmt class for catalog databases.
Use the MarcArticleISOILLFmt class for citation databases.
Use a server-specific formatting class, such as ORG.oclc.fmts.obi.NotisISOILLFmt.
OR
Provide your own formatting class.

4. Save and close the database configuration file.

5. Repeat steps 1-4 for any other databases you want to configure to route ILL requests to ILL Direct Request.

Editing IllService.ini

Note:

You enter default data that applies to all ILL requests in IllService.ini. 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 IllService.ini when WebZ submits ILL requests to OCLC ILL Direct Request. This applies to the following variables:

instSym, autho, and password (see step 7)
reauthoLimit (see step 14)
requesterNote (see step 17)
library delivery information, except for Service and Electronic Service (see step 18)
library billing information (see step 21)

6. Use a text editor to open the IllService.ini file. You can find it in the <WebZRoot>/ini/servers directory.

7. To which environment at OCLC do you want to send your ILL requests?

The test environment. Set the first five variables in the [ILLServer] section as follows:

hostname = testenv.oclc.org (comment out the other hostname line)
port = 5771 (comment out the other port line)

For the test account:
instSym = ACQ
autho = 100-091-178
password = test

For your account:
instSym = your three-character OCLC symbol
autho = your OCLC ILL authorization
password = your OCLC ILL password

The production environment. Set the first five variables in the [ILLServer] section as follows:

hostname = isoill.oclc.org (comment out the other hostname line)
port = 499 (comment out the other port line)
instSym = your three-character OCLC symbol
autho = your OCLC ILL authorization
password = your OCLC ILL password

8. Specify the ILL Direct Request processing option you are using, as follows:

Direct-to-Profile. Set OclcIllService Type to directToProfile. Go to step 9.
Direct-to-Lender. Set OclcIllService Type to directToLender. Go to step 10.
Direct-to-Review File. Set OclcIllService Type to directToReview. Go to step 11.

9. Do you want ILL Direct Request to supply potential lenders for ILL requests from the Custom Holdings paths you have set up with ILL Direct Request, in addition to those WebZ submits with ILL requests?

Yes. Set changeSendTo to true.
No. Set changeSendTo to false.

10. Do you want ILL Direct Request to change the order of lender symbols submitted by WebZ in ILL requests?

Yes. Set orderPreference to UNORDERED.
No. Set orderPreference to ORDERED.

11. Go to the [IllInfo] section of IllService.ini.

12. Are you using the Resource Sharing interface style (rssStyle.ini) or have you customized your WebZ interface by adding an option that allows your patrons to obtain a blank ILL form?

Yes. Go to step 13.
No. Go to step 14.

13. Edit the DefaultService variable to indicate which method WebZ should use to process ILL requests that patrons initiate by requesting a blank ILL form:

To use the e-mail method, set DefaultService to EMAIL.
To send the request to OCLC ILL Direct Request, set DefaultService to ISOILL.

14. Set the reauthoLimit variable to specify the number of ILL requests a patron can make before having to reauthenticate.

To allow patrons to submit an unlimited number of requests without reauthenticating, set reauthoLimit to 0.
To require patrons to reauthenticate after a certain number of requests, set reauthoLimit to the specified number of requests.

15. If you wish, provide a default value for the method your library uses to comply with copyright policy in the CopyrightCompliance field:

To indicate conformance to U.S. copyright law, use CCL.
To indicate conformance to copyright guidelines, use CCG.
If neither of the above methods applies, leave this variable blank.

16. Although OCLC recommends that you leave the NeedBeforeDate variable blank, you can enter a date after which the resource is of no use to the patron. The date format for this variable is YYYYMMDD, where YYYY is the year, MM is the month, and DD is the date.

Note:

This date becomes the default date on the ILL form that patrons complete. Because patrons may forget to edit this field, OCLC recommends that you leave this 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 from your ILL Constant Data or defaults to 30 days from the current date.

17. To include a note that appears in all ILL requests, add the note in the RequesterNote variable.

18. Use the variables in the [LibraryDeliveryInfo] section to provide information about the delivery address and delivery methods for all ILL requests.

Most of these variables should be self-explanatory, except for those described in steps 18 and 19. For more information about other variables in this section, see the [LibraryDeliveryInfo] section of the IllService.ini configuration file.

Note:

(1) If you use OCLC ILL Constant Data to specify library delivery information, leave the variables blank for which constant data exists.

(2) Remove existing data from any of the variables that do not apply to your site. For example, if you don't need to use the ExtendedAddress variable, delete the data for this variable.

19. How do you want lender libraries to send electronic copies of materials to you?

By e-mail. Enter EMAIL as the value for the ElectronicService variable. Make sure you provide the e-mail address for sending copies in the Email variable.
By fax. Enter FAX as the value for the ElectronicService variable. Make sure you provide the fax number for sending copies in the Fax variable.

20. How do you want lender libraries to send hard copies and/or borrowed materials to you?

Via U.S. mail. Enter MAIL as the value for the Service variable.
Via the U.S. Postal Service's library rate. Enter LIBRARY RATE as the value for the Service variable.

21. Use the variables in the [LibraryBillingInfo] section to provide information about how to bill you for ILL requests.

Most of these variables should be self-explanatory.For more information about other variables in this section, see the [LibraryBillingInfo] section of the IllService.ini configuration file.

Note:

1) If you use OCLC ILL Constant Data to specify library billing information, leave the variables blank for which constant data exists.

(2) Remove existing data from any of the variables that do not apply to your site. For example, if you don't need to use the ExtendedAddress variable, delete the data for this variable.

(3) If you enter a value for MaxCostforItem, you must also enter a value for CurrencyCode.

22. Save and close IllService.ini.

Creating Location Configuration Files

23. Are you using the Direct-to-Lender or Direct-to-Profile option?

Yes. Set up location configuration files for each database configured to route requests to OCLC ILL Direct Request and add references to these files in locations.ini. See the procedure, Adding or Disabling Lender Locations, for step-by-step instructions.
No. Go to step 24.

Testing WebZ's Communication with ILL Direct Request

24. Test your capability to route ILL requests to OCLC ILL Direct Request, using the procedure described in Testing ILL Services.

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

Last Modified: