ILLiad Alma NCIP Integration System Addon

ALMA NCIP Integration

2.0.2

Atlas Systems

The Alma NCIP Integration system addon allows for integration between ILLiad and Alma using NCIP. This addon uses NCIP v2 calls to the Alma NCIP responder.

LendingEnabled

true

Boolean

Determines whether lending requests are enabled for NCIP Integration.

BorrowingEnabled

true

Boolean

Determines whether borrowing requests are enabled for NCIP Integration.

BorrowingMultiBarcodeEnabled

true

Boolean

Determines whether borrowing requests Barcode fields support Multiple Barcodes.

ErrorQueueBorrowing

NCIP Errors

String

Defines the name of the queue to which borrowing transactions will be routed if there is an error in processing.

ErrorQueueLending

NCIP Errors

String

Defines the name of the queue to which lending transactions will be routed if there is an error in processing.

BorrowingCheckedInFromLibraryRouting

Request in Processing

String

Comma separated list of statuses a request is routed to after successfully checking an item in from the lending library and checking the items out to the customer via NCIP.

NCIPResponderURL

https://na03.alma.exlibrisgroup.com/view/NCIPServlet

String

URL for the NCIP Server Responder.

ApplicationProfileType

ILL

String

The mapping for the NCIP ApplicationProfileType. This can be a tag or static value. If you would like a different library type for LibraryUseOnly, use "{Custom:GetApplicationProfileType}".

BorrowingUserIdentifier

{TableField:User.Username}

String

The mapping for the NCIP user identifier sent for borrowing requests. This can be a tag or static value.

LendingUserIdentifier

{TableField:User.Username}

String

The mapping for the NCIP user identifier sent for lending requests. This can be a tag or static value.

FromAgencyId

String

Generic From Agency ID string to use in NCIP calls.

ToAgencyId

String

Generic TO Agency ID string to use in NCIP calls.

UseRequestIdentifierPrefix

false

Boolean

Determines whether request identifier prefixes are used.

RequestIdentifierPrefix

String

Prefix for RequestIdentifier. This should include any separating punctuation such as hyphens or colons. If UseRequestIdentifierPrefix is set to true and this setting is left blank, the values returned by DataMapping.Handlers.RequestIdentifier based on whether or not the item is library use only will be used.

ItemBarcodeField

String

Defines the transaction field in which the item barcode will be stored.

HistoryEntryAcceptItemSuccess

NCIP: Temporary Item created ({barcode})

String

The history entry made when the AcceptItem NCIP call is completed successfully. Leave blank for no history entry.

HistoryEntryCheckOutItemSuccess

NCIP: Item checked out ({barcode})

String

The history entry made when the CheckOutItem NCIP call is completed successfully. Leave blank for no history entry.

HistoryEntryCheckInItemSuccess

NCIP: Item checked in ({barcode})

String

The history entry made when the CheckInItem NCIP call is completed successfully. Leave blank for no history entry.

MultipleBarcodeDelimiter

" "

String

The delimiter that is used to separate multiple barcodes.

PickupLocationField

{TableField:User.NVTGC}

String

The mapping for the pickup location field.

PickupLocationMappings

String

A comma-delimited list of mappings (i.e., a=b,c=d) which will be used when mapping to PickupLocations from a particular field. Please note that Alma pickup locations are case sensitive, so make sure the pickup location value on the right side of the equal sign is cased correctly.