Alma License Lookup & E-Lending Addon

Automates Alma license terms for ILLiad Lending requests.

Type: Server Addon

Overview

This addon automates the checking of Alma license terms for ILLiad Lending requests. It polls one or more queues (comma separted), queries the Primo/Alma APIs to determine if the requested item is held electronically, and checks the associated license terms for Interlibrary Loan permissions.

Based on the result, the request is automatically routed to a Success, Deny, or Not Found queue if auto-routing on and custom queues of your choice. Additionally, licensing information will be added to a note in request. If auto-routing is off, note will just be added. To re-run a check against a TN, you must delete previous notes added.

Features

• Search Configuration: Configure Title, OCLC, ISSN, and in what order for search.
• License Validation: Checks Alma license terms for specific permissions (ILLELEC, ILLSET, ILLPRINTFAX, INTLILL) set to PERMITTED.
• Direct SQL: Uses optimized SQL queries to read transaction data without loading heavy ILLiad objects.

Prerequisites

• ILLiad 9.x or higher.
• Ex Libris Alma/Primo environment.
• API Keys for:
  • Primo Search API
  • Alma Bibs & Electronic API

Installation

1. Ensure you have the three required files:
   • Main.lua
   • Config.xml
   • JsonParser.lua
2. Compress these files into a .zip archive.
3. Open the ILLiad Customization Manager.
4. Navigate to Server Addons.
5. Click New, select your .zip file, and upload.
6. Enable the addon and configure the settings below.

Configuration Settings

API Settings

• BaseUrl: Your regional API URL (e.g., https://api-na.hosted.exlibrisgroup.com).
• PrimoApiKey: API key with permissions for Primo Search.
• AlmaApiKey: API key with permissions for Alma Bibs (Read) and Acquisitions (Read).

Primo Context

These values control where the addon searches within your catalog.

• PrimoInst: Institution Code.
• PrimoVid: View ID.
• PrimoTab: Search Tab.
• PrimoScope: Search Scope.
• SearchOptions: Comma-separated list of search types: OCLC, ISSN, TITLE. Will search by order. If Article Request, Title uses ArticleTitle.

Queue Management

• ProcessQueue: The queue(s) the addon monitors (e.g., Awaiting Lending Request Processing).
• If AutoRouting on:
• SuccessQueue: Where to route items if a license permits lending.
• DenyQueue: Where to route items if the license forbids lending.
• NotFoundQueue: Where to route items if no match is found in Primo.

Technical Notes

• Dependency: Requires JsonParser.lua in the root directory to handle API responses.
• Logging: Logs are written to the ILLiad System Manager log. Look for the logger name AtlasSystems.Addons.AlmaLicenseCheck.