VDX-CircILL-LendingAgencyProfile
From VDXipedia
VDX Circ/ILL Lending Agency Application Profile
© Fretwell-Downing Informatics Ltd 2005.
Introduction
This profile, referred to as the VDX Circ/ILL Lending Agency Application Profile is designed to provide a description of ILL to Circulation Application messaging where the Lending ILL application is VDX V3.0 or higher.
The base standard that enables this communication is NCIP. This profile is based on that protocol, as well as the supporting NCIP implementation Profile 1. This profile is a subset of the NCIP CILL-2 Lending Agency Application Profile.
Profile Contraints
In this profile, all messaging is initiated by the VDX application. The associated circulation application always acts as an NCIP responder.
Description of Application Area
This profile represents a subset of the NCIP CILL-2 Profile used to describe a Borrowing VDX ILL application's interactions with one or more associated circulation applications.
Scope
Standard interlibrary loan transactions involve two partners: a borrower and a lender. This profile deals only with the lending agency's requirements for the interaction between its VDX application and an associated circulation application.
This profile allows for the following Circ/ILL interactions:
- The ILL application can place a hold against a requested item in the circulation application,
- The ILL application can cancel the hold placed against a requested item.
- The ILL application can checkout an item (For ILL) to a requesting library
- The ILL application can ask the circulation application to renew an Interlibrary Loan
- The ILL application can checkin an item that was loaned for ILL.
This profile does not allow for circulation initiated ILL recalls or overdues to be passed to the borrowing agency via ISO-ILL.
References
- NISO Z39.83-2002, NISO Circulation Interchange Protocol
- Implementation Profile 1, a Profile of the NISO Circulation Interchange Protocol
- ISO 10160:1997, Information and Documentation - Open Systems Interconnection - Interlibrary Loan Application Service Definition
- ISO 10161-1:1997, Information and Documentation - Open Systems Interconnection - Interlibrary Loan Application Protocol Specification
- Interlibrary Loan Protocol Implementors Group. IPIG Profile for the ISO ILL Protocol, Version 2, 10 April 2001
- NCIP Circulation/Interlibrary Loan Interaction: Lending Agency Application Profile
- VDX CILL-1 NCIP application profile.
Definitions
To clarify the difference between similar but not identical terminology used in this profile and the ISO ILL Protocol, the terms "Borrower" and "Borrowing" are used in preference to the NCIP term of "Requester" or the ISO ILL term of "Requester." Likewise, the terms "Lender" and "Lending" are used in preference to the NCIP term of "Responder" or the ISO ILL term of "Responder."
| Borrower | The agency that makes use of the ILL and circulation applications to facilitate the management and circulation to its users of items obtained via ILL. |
| Borrowing Agency | See Borrower. |
| Circulation Application | The application that manages the circulation of items. |
| ILL Application | The application that manages the exchange of Interlibrary Loan messages between the borrower and the lender. |
| Item | An item received from a lender in response to an ILL request made by the borrower. |
| Lender | The agency that supplies an item in response an ILL request and manages the circulation of that item. |
| Lending Agency | See Lender. |
| Request | A request for a loan, copy, or other service initiated by the borrowing agency and answered by the lending agency. |
| User | A user at the borrowing agency who places an ILL request |
Conformance
An application that claims conformance to a role SHALL, while operating according to this profile conform to the NISO Circulation Interchange Protocol and the Implementation Profile 1.
Profile Specification
Profile Description
VDX implements a subset of the full NCIP CILL-2 Lending Agency Application Profile, based on the minimum interactions necessary to enable an ILL application to inform its local circulation application of ILL activity associated with a circulatable item.
- Reserve the requested item for use by the ILL department
- Tell the circulation application that the request has been cancelled.
- Tell the circulation application that the requested item has been issued to the borrowing agency for Interlibrary Loan.
- Ask the circulation application for a renewal of the item issued for Interlibrary Loan.
- Tell the circulation application that the loaned item has been returned to the Lending agency.
The primary assumption of this profile is that the Interlibrary Loan and circulation applications each play long-standing, well-understood roles in the ILL environment. This profile describes a specific implementation of the NISO Circulation Interchange Protocol that supports this traditional division of labour. The ILL application is responsible for responding to ILL requests and related messages to external sources, receiving responses from those external sources, and communicating appropriate messages to its local circulation application. The circulation application is responsible for the determination of and adherence to the local circulation policy.
Participating Applications
Two applications are assumed in this profile: the Interlibrary Loan application and the circulation application.
The Interlibrary Loan application operates on behalf of the lending agency. This application manages ILL requests, including the setting of ILL lending fees, transmitting overdue notices to the borrowing agency's Interlibrary Loan application, etc.
The circulation application also operates on behalf of the lending agency. It manages the loan of local Items to the borrowing agency via the ILL application.
Business Rules
The Interlibrary Loan application defines and applies its business rules regarding ILL requests, including determining whether an ILL request should be filled, the amount of the fee for filling the request, etc.
Transfer of control moves to the circulation application at the point at which the Item is ready to be checked out. The circulation application defines and applies its business rules regarding the circulation of items to users. Depending on local policy, the item may be checked out to the lending agency's ILL department or the library that initiated the ILL request. These rules may include setting the period for the loan, determining use restrictions, permitting renewals, etc. In this profile, it is the ILL staff who are responsible for shipment and receipt of the Item.
The Circulation application is also responsible for determining whether a renewal of the loaned item is possible or not, and if it is, what the new due date should be.
Management of User and Staff User Interaction
The Interlibrary Loan application manages the Interlibrary Loan staff user interface.
The circulation application manages the circulation staff user interface.
Required Components
Required and Optional Services
The following table lists required and optional services, messages, and responses required by this profile. NCIP services not listed are not used by this profile.
| Service | Required (R) or Optional (O) |
| Request Item | R |
| Cancel Request Item | R |
| Checkout Item | R |
| Renew Item | R |
| Checkin Item | R |
Required and Conditionally Required Data Elements
The following table defines those Messages/Data Elements that are Optional in the NCIP Protocol or the Implementation Profile 1, but are Mandatory or Conditional in this profile.
| Message | Profile Required Elements | Conditions |
| Request Item | Unique Request Id | Always Present.
This is ILL application's identifier for this ILL request. |
| Request Item | Unique Item Id | Conditionally present for Item level holds. This is the visible barcode on the requested item. |
| Request Item | BibliographicRecordId | Always present.
This is the local system number for the bibliographic identified by the ILL application. This will include the UniqueAgencyID which should match the ToAgencyId used in the header for this message. |
| Request Item | Unique User Id | Always Present
This is either the a pseudo-patron that represents the lending agency's ILL dept, or this is a pseudo-patron that represents the borrowing library. |
| Request Item | Request Type | = One of:
-- Loan -- Non-Returnable Copy based on ILL Service Type |
| Request Item | Request Scope Type | = 'Item' or 'Title' depending upon whether the ILL application has been able to identify an individual item record for this title. |
| Request Item | Need Before Date | = ILL Expiry Date |
| Request Item Response | Unique Request Id | Circ's unique request id for this hold |
| Cancel Request Item | Mandated Action | Always Present - the Requester has cancelled their request - we don't want to argue with the circ application about this. |
| Cancel Request Item | Unique Request Id | Always Present |
| Cancel Request Item | Unique User Id | Always Present
This is the a pseudo-user-id representing either the lending ILL dept, or the borrowing library. |
| Renew Item | Unique Item Id | Always Present |
| Renew Item | Unique User Id | Always Present
This is the a pseudo-user-id representing either the lending ILL dept, or the borrowing library. |
| Renew Item | Desired Due Date? | If present in ILL Renew Request |
| Renew Item Response | Date Due | Always Present |
| Checkout Item | Unique Request Id | Always Present |
| Checkout Item | Unique Item id | Always Present |
| Checkout Item | Unique User Id | Always Present |
| Checkout Item Response | Date Due | Always Present |
| Checkin Item | Unique Item Id | Always Present |
Enumerated Types
All enumerated types used in this profile must conform to the enumerated types listed in the document "NCIP IMP 1".
The only exceptions are the schemes for SystemId and AgencyID which will local to each implementation.
Event Table
| Triggering Event and Event Location | Initiating Application | Service Initiated | Responding Application | Message Constraints |
| ILL agrees to process the ILL request. | ILL | Request Item | Circulation |
|
| ILL receives a 'Conditional-Response = No' message | ILL | Cancel Request Item | Circulation | |
| ILL receives a Cancel Request message | ILL | Cancel Request Item | Circulation | |
| ILL ships the item to the requester | ILL | Check Out Item | Circulation | |
| ILL receives a renewal request from the Borrower. | ILL | Renew Item | Circulation | |
| ILL receives the Item from the Borrower. | ILL | Check In Item | Circulation |
NOTE: There is no action associated with request expiry because when VDX places a hold on the circulating item, it also sends an ILL-Will-Supply message which turns off the automatic expiry timer.
Lookup Service Table
There are no lookup services used by this profile
Transport Protocol
The circulation application SHALL support one of the following transport protocols:
- Direct Transmission over TCP/IP
- HTTPS
The Interlibrary Loan application SHALL support both of the following transport protocols:
- Direct Transmission over TCP/IP
- HTTPS
The ILL application SHALL be configurable to employ one of the supported transport protocols when connecting to a given circulation system.
Security And Privacy
All user authentication and authorization is considered out of scope for this profile.
This profile assumes that the ILL and circulation applications whose interactions are described in this profile trust each other. Where the two applications are managed by a single agency, trust may be implicit and a minimum exchange of information may be required to enable the applications to communicate. Situations may arise, however, in which the two applications are not managed by the same agency even though a single agency's staff interact with both the ILL application and the circulation application. In this case preliminary exchange of information will need to be used to allow each application to authenticate and authorize the other. This exchange will require a priori bilateral agreement between the communicating applications and, thus, is out of scope for this profile
Registration of Schemes Used in the Profile
For information about maintenance and registration activities see Appendix G, Designation of Maintenance and Registration Agency, in the NCIP standard.
Guidelines for Implementors
The following guidelines do not represent behavior required by this profile. They are offered only as recommended behavior for implementations with ILL applications that comply with the ISO ILL Protocol and the IPIG Profile for the ISO ILL Protocol.
N/A
