Alma Borrowing Request Sender Server Addon

1.26

Bill Jones, SUNY Geneseo; Tim Jackson, SUNY SLSS; and Angela Persico, University at Albany

This Server addon allows ILLiad to send an Interlibrary Loan Borrowing request to Alma via the Alma Users API.

AddonWorkerName

HoldAndBorrowing

String

This is the name you give the Addon for the rerun checker. If you are using more than one Addon, give each Addon a different name.

AlmaBaseURL

https://api-na.hosted.exlibrisgroup.com/almaws/v1

String

This setting value is the base URL for Alma API. It is your Alma API server,i.e., https://api-na.hosted.exlibrisgroup.com/almaws/v1.

AlmaInstitutionCode

String

This is your institutional Alma Code. Example: 01SUNY_GEN

FullAlmaURL

String

This is your Full Alma URL. Example: https://suny-gen.alma.exlibrisgroup.com

AlmaUsersAPIKey

String

Input your Alma Users API Key (Read and Write access needed).

AlmaBibsAPIKey

String

Input your Alma Bibs API Key (Read access needed).

SRULookupUsername

String

This is the username for your SRU Lookup. Leave blank if you do not use a username and password.

SRULookupPassword

String

This is the password for your SRU Lookup. Leave blank if you do not use a username and password.

EnableSendingBorrowingRequests

String

This setting determines if you want to enable sending Borrowing Requests to Alma.

EnableSendingHoldRequests

Boolean

This setting determines if you want to enable sending Hold Requests to Alma.

PreferElectronicOverPrintForHoldRequests

Boolean

This setting determines if you want to use electronic items for Hold request fulfillment before using physical print items.

ItemSearchQueue

Alma RS Test

String

The queue the Addon will monitor to process new Borrowing requests.

ItemSuccessQueue

Alma RS Success

String

The queue a Transaction will be moved to if the Borrowing Request is submitted to Alma successfully.

ItemFailQueue

Alma RS Failure

String

The queue a Transaction will be moved to if the Borrowing Request Alma API call fails.

ItemInExcludedLocationNeedsReviewQueue

Needs Review Item in Excluded Location

String

The queue a Transaction will be moved to for review if the requested item is in and Excluded Location as listed in the excludedlocations.txt file.

ItemSuccessHoldRequestQueue

Alma Hold Success

String

The queue a Transaction will be moved to if the Hold Request is submitted to Alma successfully.

ItemFailHoldRequestQueue

Alma Hold Failure

String

The queue a Transaction will be moved to if the Hold Request Alma API call fails.

NoISBNandNoOCLCNumberReviewQueue

Awaiting ISBN Lookup

String

The queue a Transaction will be moved to moved to for review if the transaction is lacking both and ISBN and an OCLC Number.

ElectronicItemSuccessQueue

Alma Electronic Item Found Success

String

The queue a Transaction will be moved to if a local electronic item is found for the matching ISBN or OCLC Number.

ILLiadFieldforElectronicItemURL

Location

String

The name of the Transaction field you would like to use to store the URL for the found owned Electronic item (if URL is available)

FieldtoUseForUserNameFromUsersTable

Username

String

The name of the field in the ILLiad Users Table you want to use for the username to send to Alma during an API call.

ILLiadFieldToStorePIDs

ItemInfo3

String

The name of the ILLiad field that will be used to store multiple PIDs (Item IDs) to place item level holds in Alma.

MultiVolumeRewiewQueue

MultiVolume Review

String

This is the name of the ILLiad queue used to route transactions that are multivolume and need review.

PrimoPermalinkPrefix

String

This is the Primo permalink prefix. To get the permalink prefix, please open an eBook, click the Permalink button, and then copy the permalink, including the word 'alma' at the end of the permalink URL. Please do not include the individual MMSID for this configuration value (example: https://glocat.geneseo.edu/permalink/01SUNY_GEN/1q0kkbr/alma).

UltimateDebug

false

Boolean

This setting determines if you want detailed notes containing the Alma API URL and XML message for placing a hold request in the ILLiad transaction notes.