FAQ

My library wants to use CUNY Login for ILLiad authentication. How do we make that happen?

This article is written for those who wish to:

  1. Switch authentication from "manual" (where your patrons create their own usernames) to your EZproxy server (using Shibboleth/SAML), and
  2. Use the CUNY EMPLID as the unique identifier for each user in ILLiad (allowing ILLiad, EZproxy, Shibboleth, and Alma to all use the same identifier to refer to the same patron).

This article assumes your EZproxy server is hosted by OLS. If you host your own EZproxy server, you can still use the information below but you will need to make adjustments as necessary. You can open a ticket with OLS if you want to talk through the local implementation process.

To get started:

  1. Prepare a spreadsheet of all ILLiad users (that includes their current ILLiad username and their EMPLID) and share it with OCLC via a support ticket with the vendor.
  2. Open a ticket with OLS so we can add a stanza for ILLiad to the EZproxy configuration file.
  3. Work with OCLC to:
    1. Configure RemoteAuth: https://support.atlas-sys.com/hc/en-us/articles/360011912013-RemoteAuth-Customizing-Settings
    2. Configure, if necessary, RemoteAuthValidation Table: https://support.atlas-sys.com/hc/en-us/articles/360037463394-Authentication-Enhancements
    3. Plan a time for the user database update.
  4. Add a message to the library and/or ILLiad site about the upcoming change to the authentication method.
  5. At the scheduled cutover:
    1. OCLC will back up the ILLiad user records prior to loading users with their EMPLID in the ILLiad "Username" field. (The ILLiad "lending user" is exempt from this. OCLC is aware but it doesn't hurt to remind them.)
    2. You will test your access through EZproxy with proxied URL: https://[campus].ezproxy.cuny.edu/login?auth=shibboleth&url=https://[campus].illiad.oclc.org/illiad/illiad.dll (OLS recommends having multiple people on standby to help with testing.)
    3. You will change the ILLiad links on your website, LibGuides, etc.
Timeline

Since this is a library-directed project, you set the timeline.

The most time-consuming process is cleaning up your ILLiad patron database (e.g., purging expired accounts) and looking up EMPLIDs for active ILLiad users. After that part is complete, the process is only limited by the involved parties' calendars. The cutover process itself takes less than 1 hour.

ILLiad User Registration

Note that your ILLiad user database will not change. You will continue to manage it as you have before. Users who do not have accounts will need to sign into ILLiad but will be prompted with the usual ILLiad registration form in order to take advantage of interlibrary lending services at your library.

Alma/ILLiad Integration

Once this process is complete, you are one step closer to integrating ILLiad with Alma, which will allow you to:

  • Set up ILLiad as the resource sharing partner of last resort, ensuring that requests not fillable within the CUNY Libraries will automatically be assigned to ILLiad
  • Create temporary item records in Alma for items received from other libraries in ILLiad, allowing you to circulate ILLiad items in Alma and your users to see and renew their ILLiad items in OneSearch
  • Automatically move items being loaned to other libraries (via ILLiad) to Alma's temporary lending location, eliminating the need for staff to manually check those items out in Alma

Metadata


Answered By:
Alevtina Verbovetskaya
Last Updated:
2023-05-30
Views:
344

Welcome

How can we help?

In order to submit this request for assistance, please first login by clicking the button below.
Login

The Systems Librarians in the Office of Library Services (OLS) are here to support CUNY libraries with:

  • Alma & Primo VE system support
  • EZproxy access and configuration
  • Documentation and best practices
  • Workflow optimization
  • Committee and working group support

Before submitting a ticket, please check our Knowledge Base for existing solutions to common questions. If you don't find what you need, fill out this form and we'll be glad to help!


Priority *
Fields marked with * are required.