Customized XSL letter templates for Ex Libris Alma, forked from cuny-libraries/alma-letters
Alma-letters is a command-line tool to sync letters between your local files and Alma via the Configuration API. It can also serve as the repository for your institutions Alma letter templates.
pipx install .Important: After first cloning this repository, delete the contents of the letters and components subfolders, or you risk overwriting your templates with UCSC's.
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
Download letter templates from Alma:
alma-letters pull --env sandbox
alma-letters pull --env productionUpload all templates to Alma:
alma-letters push --env sandbox # Test in sandbox first
alma-letters push --env production # Requires confirmationUpload a single template to Alma:
alma-letters push --env ENV --letter CODE # With any valid letter code
alma-letters push --env ENV --component CODE # With and valid component code
# Example: alma-letters push --env production --letter SavedSearchesLetterView 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.
If you do not define the list of templates to download, the tool will default to downloading templates that are both enabled and customized.
| 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 |
- University of Oslo Alma Letters — Reference implementation
- Alma User Discussion List