Search

 

Home

 

Download Addons

Creating Addons

Troubleshooting

 

Contents

 

ILLiad ALMA NCIP Client Addon

NameAlma NCIP Client
Version2.0
AuthorTom McNulty, VCU Libraries
DescriptionThis system level addon allows for ILLiad to communicate with Alma via NCIP protocol.

Download

Download zip file: alma_ncip.zip

Configuration

Addon settings are configured in the Manage Addons form.

NameDefaultTypeDescription
NCIP_Responder
_URL
https://alma.exlibris
group.
com/view/
NCIPServlet
String

This setting value is the address for
the NCIP Responder URL. For Alma
this will always be https://alma.
exlibrisgroup.com/view/NCIPServlet 
unless you are testing on a sandbox
version of Alma.

acceptItem_from_
uniqueAgency_
value
01XXX_INSTStringThis is your institutional Alma Code.
ApplicationProfile
Type
XXXStringInput 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.
LendingCheckOut
ItemFailQueue
NCIP Error:
LendingCheck
OutItem Failed
StringThis designates the name of the queue
a Lending Transaction will be moved to
if the CheckOutItem function fails.
LendingCheckIn
ItemFailQueue
NCIP Error:
LendingCheck
InItem Failed
StringThis designates the name of the queue
a Lending Transaction will be moved to
if the CheckInItem function fails.
EnablePatron
BorrowingReturns
falseBooleanWhen 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.