VDX-CircILL-BorrowingAgencyProfile
From VDXipedia
VDX Circ/ILL Borrowing Agency Application Profile
© Fretwell-Downing Informatics Ltd 2005.
Introduction
This profile, referred to as the VDX Circ/ILL Borrowing Agency Application Profile is designed to provide a description of ILL to Circulation Application messaging where the Borrowing 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-1 Borrowing Agency Application Profile.
Profile Constraints
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-1 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 borrowing agency's requirements for the interaction between its VDX application and an associated circulation application.
Both the circulation and Interlibrary Loan applications deal with users from their own agency.
This profile allows for the following Circ/ILL interactions:
* ILL application hands over received item for circulation to patron
* ILL application informs circulation application that the loaned item has been renewed
* ILL application informs circulation that the loaned item has been returned to the lending agency
* ILL application asks circulation application for circulation status of loaned item.
This profile assumes that there is no circulation interaction prior to the receipt of the requested item by the ILL application. At the point of 'Receiving' the item, the ILL application hands the item over to the circulation application for circulation to the patron via the NCIP Accept Item message.
At the point at which a loaned item is returned to the Lender, the ILL application 'checks in' the item with the circulation system - which is the trigger for the circulation system to dispose of any temporary records it may have created In order to circulate the item.
This profile also allows the ILL application to tell the circulation system that the Interlibrary Loan has been renewed - passing the updated due date to the circulation application via the NCIP Renew Item message.
This profile does not allow for circulation initiated ILL renewals or for the passing on of ILL Recalls from the ILL application to the circulation application.
This profile does not cover how users initiate ILL requests. All user authentication and authorization is considered out of scope for this profile.
References
- Implementation Profile 1, a Profile of the NISO Circulation Interchange Protocol
- NISO Z39.83-2002, 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: Borrowing Agency Application Profile
- VDX CILL-2 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-1 Borrowing Agency Application Profile, based on the minimum interactions necessary to enable a circulation system to circulate a ILL item. These mimimum interactions are:
* Handover a received Interlibrary Loan item from the ILL application to the circulation application for circulation to the patron.
* Tell the circulation application that the loaned item has been renewed - and give the circulation application the new due-date.
* Tell the circulation application that the item has been returned to the ILL application for return to the Lender. This is the trigger for the circulation system to clean up any temporary records it might have created in order to support the circulation of the loaned item.
* The ILL application may wish to query the circulation application regarding the current circulation status of the loaned item.
The primary assumption of this profile is that the Interlibrary Loand 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 sending 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. Although this profile assumes that the Interlibrary Loan application is VDX V3.0, it does not preclude its application to other Interlibrary Loan applications that do not need to implement the full NCIP CILL-1 application profile.
The Interlibrary Loan application operates on behalf of the borrowing agency. This application manages ILL requests, including setting of fees charged to local users, transmitting recall notices to the patron etc.
The circulation application also operates on behalf of the borrowing agency. It manages the loan of items obtained from external sources, including communicating with the user, determining if a borrowed item is overdue, collecting overdue fines and ILL fees, etc.
Business Rules
The ILL application defines and applies business rules regarding interlibrary loan requests, including the management of user notices and charges related to these requests, up to the point items are received.
The transfer of control moves from ILL to circulation when the requested item has arrived at the borrowing agency's ILL office and the ILL application sends the NCIP Accept Item message to the circulation application. The circulation application defines and applies business rules regarding the circulation of ILL items to users, including the management of user notices and charges related to the circulation of ILL items up to the point loaned items are returned to ILL or copied items are given or transferred to the user.
However, the borrowing ILL application is still responsible for the the negotiation of ILL renewals with the lender, and informs the borrowing circulation application of a successful renewal by sending it an NCIP Renew Item message with the Mandated Action flag set to TRUE.
The transfer of control moves back to ILL when the ILL system returns a loaned item to the Lender. At this point ILL sends an NCIP CheckIn Item message to the circulation application. This causes the circulation application to close any outstanding circulation transaction for the loaned item.
Management of User and Staff User Interaction
The ILL application manages the Interlibrary Loan staff user interactions, and provides a User Interface through which users can track their ILL requests and request the renewal of items obtained via ILL.
The circulation application manages the circulation staff user interactions.
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) |
| Accept Item | R |
| Check In Item | R |
| Renew Item | R |
| Lookup Item | R |
Required and Conditionally Required Data Elements
The following table defines the Message/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 |
| Accept Item | Unique User Id | Circulation needs to know the User to whom this item is to be circulated. |
| Accept Item | Bibliographic Description | Circulation may choose to create a temporarybibliographic record to describe the loaned item so ILL must include all known bibliographic details. |
| Accept Item | Date for Return | If the item is a loan and the due date is known.
|
| Accept Item | Indeterminate Loan Period Flag | If the item is a loan but the due date is not defined |
| Accept Item | Non-Returnable Flag | If the item is a non-returnable copy. |
| Accept Item | Item Use Restriction Type | Mapped from ISO ILL Shipped-Conditions:
-- Library use only -- no reproduction -- client signature required -- supervision required |
| Accept Item | Requested Action Type | = "Circulate" |
| Accept Item Response | Unique Item Id | Circulation must respond with the item Id it has assigned to the accepted item for tracking purposes. |
| Lookup Item | Unique Item Id | Always Present |
| Lookup Item Response | Circulation Status | Always Present |
| Renew Item | Unique Item Id | Always present |
| Renew Item | Mandated Action Flag | This is not a request, it is a command, since the ILL system has already negotiated the renewal of the loaned item with the supplier.
We can't use the Item Renewed Notification because notifications carry no implied action on behalf of the recipient, and we want the Circulation application to renew the loan to the borrower. |
| Renew item | Desired Date for Return | Always present |
| CheckIn Item | Unique Item Id | Always present |
| Checkin Item | Mandated Action Flag | The item has already been checked in to the ILL dept, so the ILL Application needs to inform the circulation application that this event has occurred.
The ILL application will check whether the circulation system already knows about the checkin by peforming an NCIP lookupItem action prior to attempting the CheckinItem action. If the circulation system already knows about the check-in, the ILL application will not send the Checkin Item message. |
Enumerated Types
All enumerated types used in this profile should conform to the enumerated types listed in the "NCIP IMP 1" document.
The only exception to this rule are the schemes used for System and Agency identifiers which will be locally defined for each implementation.
| Scheme Name | Value | Definition |
Event Table
| Triggering Event and Event Location | Initiating Application | Service Initiated | Responding Application | Message Constraints |
| ILL Receives the requested item. | ILL | Accept Item | Circulation | Set Date For Return to a date calculated by ILL on the basis of the date it is due back at the lending library and any other conditions imposed by the Lender on the use of the item.
This hands over management of the item to circulation. Circulation responds by returning the original Request Id and the Item Id it has assigned to the "accepted" item. |
| ILL receives a positifve renewal response from the Lender. | ILL | Renew Item | Circulation | Set a new value for Date For Return. |
| ILL Displays the status of current request | ILL | Lookup Item | Circulation | ILL Requester looks up status of accepted item in the Circulation System.
Gets back the current circulation status. |
| ILL Returns the loaned item to the Lender | ILL | Lookup Item | Circulation | ILL requester looks up status of accepted item in the circulation system in order to determine whether the circulation application needs to be informed that the loaned item has been returned to the library by the borrower
Gets back the current circulation status |
| ILL Returns the loaned item to the Lender | ILL | Check In Item | Circulation | If the circulation application does not yet know that the item has been checked-in then ILL informs Circulation that the item has been returned to the ILL department.
Circulation may now close the transaction for the accepted item as it sees fit. |
Lookup Service Table
In order to initiate specific NCIP services, one application may need to obtain information from another application. The table below lists services that may be used to obtain that information. The first column lists the application that provides the information. The second column lists the service executed. The third column lists the identifiers that are optional within NCIP, but are required for this profile. The fourth column lists the data returned.
| Lookup Service | Responding Application | Required Unique Ids | Required Response Data Elements |
| Lookup Item | Circulation | Unique Item Id | ItemOptionalFields->CirculationStatus |
Lookup Item can be used by the ILL application to determine the current status of an accepted item.
Transport Protocol
The circulation application SHALL support one of the following transport protocols:
- Direct Transmission over TCP/IP
- HTTPS
The ILL 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
A user is authenticated/authorized when logging into the ILL or circulation user applications, which is out of scope of this profile. By the time the circulation application asks the ILL application for a list of requests for a given user, this profile assumes this request is taking place between two known and trusted systems and that the user making the request is authorized to do so.
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 a 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 those implementations in which the ILL applications are in compliance with the ISO ILL Protocol and the IPIG Profile for the ISO ILL Protocol.
N/A
