Tech Blog

Automatically Creating ILLiad Borrowing Requests From Alma

Alma and ILLiad may be integrated so that borrowing requests get automatically “pushed” from Alma into ILLiad, where they continue their lifecycle as ILLiad requests.
Together with the NCIP based integration, this creates a full Alma/ILLiad workflow such that:
  1. A borrowing request is created in Alma, via Primo or through any other discovery interface.
  2. Alma attempts to fulfill the request through its configured rota, sending the request to the next potential lender with each reject that is received from the rota member
  3. If none of the rota members have been able to supply the request, the request gets automatically “pushed” into ILLiad. A borrowing request is automatically created in ILLiad, using metadata and request information supplied by Alma
  4. The request continues its lifecycle in ILLiad
  5. When an item is received in ILLiad, an automatic update happens in Alma based on the NCIP message
  6. When the item is shipped back to the lender via ILLiad, an automatic update happens in Alma based on the NCIP message
Achieving this full end to end Alma/ILLiad lifecycle can be done by configuring the ILLiad Partner record:
In the Parameters tab, configure the email address from which ILLiad will grab the email.
Leave the ‘close Request When Exported’ option unticked if you’d like to continue receiving updates from ILLiad via NCIP.
The email that Alma generates includes all of the request’s data, as in the below example:
Lastly, you need to configure ILLiad to:
  1. Use the email address you configured
  2. Map the fields in the email (OCLC Number, Place of Publication, Journal Title etc.) to the proper fields in ILLiad
Pay special attention to map the External ID to a field that the ILLiad NCIP add-on then uses to communicate with Alma. You must have ILLiad use this field if you’d like the subsequent Acceptitem message to properly hook up to the same request.
Below is a list of the Alma generated field names:
For books:
  • Author
  • Title
  • Edition
  • ISBN/ISSN
  • LCCN
  • OCLC Number
  • Place of Publication
  • Publisher
  • Series Title Number
  • Publication Date
  • Call Number
  • Note
  • Volume
  • Part
  • Chapter
  • Pages
  • Source
  • Specific Edition Only – values are true/false
  • Requester – the requesting patron ID
  • Requested Format
  • Requested Media – values are true/false
  • Allow Other Format – values are true/false
  • Preferred Send Method
  • Date Needed By – in yyyy-mm-dd format
  • Requested Pickup location
  • For Reading-Room Use Only – values are true/false
  • Shipping Cost
  • Willing to Pay – values are true/false
  • Agree to Copyright terms – values are true/false
  • Needs Patron Information – values are true/false
  • Request Note
  • Maximum Fee
  • External ID
  • Institution
For articles:
  • Author
  • Title
  • ISBN/ISSN
  • LCCN
  • OCLC Number
  • Place of Publication
  • Publisher
  • Series Title Number
  • Publication Date
  • Note
  • Issue
  • Volume
  • Chapter
  • Pages
  • Journal Title
  • Author of Article
  • DOI
  • PMID
  • Source
  • Start Page
  • End Page
  • Specific Edition Only – values are true/false
  • Requester – the requesting patron ID
  • Requested Format
  • Requested Media
  • Allow Other Format – the requesting patron ID
  • Preferred Send Method
  • Date Needed By – in yyyy-mm-dd format
  • Requested Pickup location
  • For Reading-Room Use Only – values are true/false
  • Shipping Cost
  • Willing to Pay – values are true/false
  • Agree to Copyright terms – values are true/false
  • Needs Patron Information – values are true/false
  • Request Note
  • Maximum Fee
  • External ID
  • Institution

Leave a Reply