Skip to main content
OCLC Support

ILS SIP2 Circulation

  1. Last updated
  2. Save as PDF
Learn how ILS SIP2 Circulation connects with your integrated library system.

Overview

If ILS SIP2 Circulation is enabled, the following connections will be made with your integrated library system:

  • When adding an item to either a Museum or Thing record, the Item Number will be validated to verify that the item exists in the ILS
  • Under Reservations, marking an upcoming reservation as Checked Out or Checked In will trigger a check out/in by passing the patron’s account number (associated with the reservation) and the item ID barcode.

 Note: This feature only verifies that an item exists in your ILS and can trigger a check out/in command. It cannot synchronize or modify your existing ILS records or loan rules.

Loan period discrepancies

In some cases, a loan period discrepancy can occur between MuseumKey/LendingKey and an ILS. For example, a three-day loan period in MuseumKey with a pickup date of Monday would be due on Wednesday. However, an ILS may skip the first day and result in a Monday check out being due on Thursday. In another instance, a patron may pick up the reservation on Tuesday, knowing that it is still due on Wednesday.

After choosing the best loan period to ensure that the due dates correlate between the two systems, you may need to periodically modify the due date of a reservation either in your ILS or in MuseumKey (under Reservations > Modify).

Notifications

When a reservation is successfully checked out/in, you will see the following message:

  • The reservation has been checked out successfully.
  • The reservation has been checked in successfully.

When a reservation a checked out/in fails, you will see the following message:

  • Item could not be checked out.

This message will be followed by an additional message that is generated and sent directly from your ILS. MuseumKey/LendingKey has no control over these messages, which often need to be resolved with the ILS.

The following is a list of common error responses generated by the ILS upon failur

Message Description
Item could not be checked out. Check out/in transactions must be allowed across the SIP port without requiring a PIN.
Cannot locate item record. Please try again or see a staff member for assistance. The item ID barcode for the item being checked out does not exist or has been removed from the ILS.
Item has blocks. Blocked by material type The item type cannot be checked out/in. Adjust loan rules accordingly.
Patron is not allowed to check out the selected item The patron type cannot be checked out/in this type of item. Adjust loan rules accordingly.
Renewals not permitted The item may have already been checked out directly in your ILS client software and the check out command is being registered as a renewal. Check the item back in and try again.
Material status is INTRANSIT. See Librarian The item status cannot be circulated while in transit. Adjust loan rules accordingly.
Please see a librarian for assistance Generic message when a check out/in action fails. Check with your system administrator.
Item ID must match exactly The item ID barcode for the item being checked out does not match and should be modified.
Invalid PIN for station user
Or
Invalid PIN entered, Please try again or see a staff member for assistance.		 Check out/in transactions must be allowed across the SIP port without requiring a PIN.