Customized XSL letter templates for Ex Libris Alma, forked from cuny-libraries/alma-letters
This repository includes a command-line tool to sync letters between your local files and Alma via the Configuration API.
pipx install .Create a .env file from the template:
cp .env.example .envAdd your API keys (read/write access to Configuration API required):
ALMA_API_KEY_SANDBOX=your_sandbox_key
ALMA_API_KEY_PRODUCTION=your_production_key
ALMA_REGION=na
Available regions: na, eu, ap, aps, ca, cn
Export letters from Alma:
alma-lettersPush changes to Alma:
alma-letters push --env sandbox # Test in sandbox first
alma-letters push --env production # Requires confirmationView available letters:
alma-letters --debugletters.txt— Letter codes to sync (one per line)components.txt— Component codes to sync (one per line)
Lines starting with # are comments.
| Letter Code | Letter Name |
|---|---|
| Borrowing Activity Letter | FulUserBorrowingActivityLetter |
| Courtesy Letter | FulUserLoansCourtesyLetter |
| Loan Receipt Letter | FulLoanReceiptLetter |
| Loan Status Notice | FulItemChangeDueDateLetter |
| On Hold Shelf Letter | FulPlaceOnHoldShelfLetter |
| On Hold Shelf Reminder Letter | FulOnHoldShelfReminderLetter |
| Overdue Notice Letter | FulUserOverdueNoticeLetter |
| Return Receipt Letter | FulReturnReceiptLetter |
To get the letter code in Alma, navigate to Configuration > General > Letters Configuration. Then find the letter and click on its title to open the edit screen. Now click on the Letter Examples button near the top of the modal window. If the list only includes "DefaultLetter.xml", then click the Add from system letters button and pick from any option you see. The name of the example in the list (other than DefaultLetter.xml) is the Alma system code for the letter.
- University of Oslo Alma Letters — Reference implementation
- Alma User Discussion List