ILLiad ALMA NCIP Borrowing Client System Addon

Atlas and OCLC do not support default addons or user-created addons.

If you need assistance with using, troubleshooting, or writing addons, please contact Atlas Systems for a custom services quote.

NameAlma NCIP Borrowing Client
Version3.2
AuthorBill Jones, SUNY Geneseo and Tim Jackson, SUNY SLSS
DescriptionThis system level addon allows for ILLiad to communicate with Alma via NCIP protocol.

Download

ILLiad_Alma_NCIP_Borrowing_v3.2.zip


This addon is available for developers to modify and extend. Developers are encouraged to submit changes to this addon by forking the git repository from GitHub and creating a pull request.

Configuration

Addon settings are configured in the Manage Addons form.

NameDefaultTypeDescription
NCIP_Responder
_URL
String

Replace "xxx" with your institution's three letter Alma code. If SUNY, replace "xxx" with "suny-zzz", and replace zzz with your institution's three letter Alma code.

ILLiad_field_to_get_external_identifierTransactionNumberStringThis field will be used as the External Identifier in Alma (the transaction number will be used if this field is empty)
ILLiad_field_to_get_barcodeTransactionNumberStringThis field will be used as the item barcode in Alma (the transaction number will be used if this field is empty)
acceptItem_from_
uniqueAgency_
value
01SUNY_XXXStringReplace "XXX" with your institution's three letter Alma code. If SUNY, replace "XXX" with "01SUNY_ZZZ", and replace ZZZ with your institution's three letter Alma code.
ApplicationProfile
Type
ILLStringInput the Resource Sharing Partner
code used in Alma.
BorrowingAccept
ItemFailQueue
NCIP Error:
BorrowingAccept
Item Failed
StringThis designates the name of the
queue a Borrowing Transaction will
be moved to if the BorrowingAccept
Item function fails.
BorrowingCheck
InItemFailQueue
NCIP Error:
BorrowingCheck
InItem Failed
StringThis designates the name of the queue
a Borrowing Transaction will be moved
to if the BorrowingCheckInItem function
fails.
EnablePatron
BorrowingReturns
trueBooleanWhen this setting is enabled, patron
returns will go through ILLiad and a
message is sent to Alma. When this
setting is disabled, patron returns will
go through ILLiad and will need to also
be returned through Alma.
Use_PrefixesfalseBooleanDetermines whether or not you want to
change prefixes of a transaction based
on specific criteria (below).
Prefix_for_Library
UseOnly
LU-StringThis setting allows you to change the
prefix of a transaction that is marked
LibraryUseOnly Yes.
Prefix_for_
Renewables
Allowed
TN-StringThis setting allows you to change the
prefix of a transaction that is marked
RenewalsAllowed Yes.
Prefix_for_Library
UseOnly_and_
RenewablesAllowed
LU-StringThis setting allows you to change the
prefix of a transaction that is marked
both LibraryUseOnly and Renewals
Allowed Yes.