Name

Version

Author

Description

ILLiad IDS NCIP Client Addon1.3.6Bill Jones, IDS ProjectThis system level addon allows for ILLiad to communicate with Aleph via NCIP protocol.

Download

Download zip file: IDS_NCIP_Client.zip

Configuration

Addon settings are configured in the Manage Addons form.

Setting Name

Default Value

Type

Description

NCIP_Responder_URL

https://[your URL]/ncip

String

This setting value is the address for the NCIP Responder URL.

BorrowingAcceptItemFailQueue

NCIP Error: BorrowingAcceptItem Failed

String

This setting designates the name of the queue a Borrowing Transaction will be moved to when BorrowingAcceptItem fails.

BorrowingCheckInItemFailQueue

NCIP Error: BorrowingCheckInItem Failed

String

This setting designates the name of the queue a Borrowing Transaction will be moved to when BorrowingCheckInItem fails.

LendingCheckOutItemFailQueue

NCIP Error: LendingCheckOutItem Failed

String

This setting designates the name of the queue a Lending Transaction will be moved to when CheckOutItem fails.

LendingCheckInItemFailQueue

NCIP Error: LendingCheckInItem Failed

String

This setting designates the name of the queue a Lending Transaction will be moved to when CheckInItem fails.

EnablePatronBorrowingReturns

true

Boolean

When this setting is enabled, patron returns will go through ILLiad and a message is sent to Aleph. When this setting is disabled, patron returns will go through Aleph and will need to also be returned through ILLiad.

Use_Lender_String

true

Boolean

This setting allows the user to indicate that they would like to use the OCLC Symbol to signify the borrowing library within Aleph.

Borrower_Prepend_String

ILL-

String

This setting allows the user to set the prepended value to the OCLC Symbol for the borrower.

Use_ILL_for_library

false

Boolean

This setting allows the user to indicate that they would like to use "ILL" to signify all borrowing libraries within Aleph.

BlanketName_for_Borrowing_Libraries

 

String

This setting allows the user to set a name that represents all Borrowing Libraries. This name is used in the LendingCheckOutItem call.

Use_Prefixes

true

Boolean

Determines whether or not you wantt to change prefixes of a transaction based on specific criteria (below).

Prefix_for_LibraryUseOnly

LU-

String

This setting allows you to change the prefix of a transaction that is marked LibraryUseOnly Yes.

Prefix_for_RenewablesAllowed

TN-

String

This setting allows you to change the prefix of a transaction that is marked RenewalsAllowed Yes.

Prefix_for_LibraryUseOnly_and_RenewablesAllowed

LU-

String

This setting allows you to change the prefix of a transaction that is marked both LibraryUseOnly and RenewalsAllowed Yes.

acceptItem_from_uniqueAgency_scheme

 

String

For AcceptItem XML: This setting value allows you to choose the from-uniqueAgency-scheme URL value.

acceptItem_from_uniqueAgency_value

BD

String

For AcceptItem XML: This setting value allows you to choose the from-uniqueAgency-value value (ex. 'BD').

acceptItem_to_uniqueAgency_scheme

 

String

For AcceptItem XML: This setting value allows you to choose the to-uniqueAgency-scheme URL value.

acceptItem_uniqueRequest_agency_scheme

 

String

For AcceptItem XML: This setting value allows you to choose the uniqueRequest-agency-scheme URL value.

acceptItem_uniqueRequest_agency_value

BD

String

For AcceptItem XML: This setting value allows you to choose the uniqueRequest-agency-value value (ex. 'BD').

acceptItem_reqActiontype_scheme

http://www.niso.org/ncip/v1_0/imp1/schemes/requestedactiontype/requestedactiontype.scm

String

For AcceptItem XML: This setting value allows you to choose the requestActionType-scheme URL value.

acceptItem_reqActiontype_value

Hold for Pickup

String

For AcceptItem XML: This setting value allows you to choose the requestActionType-value value (ex. 'Hold for Pickup').

acceptItem_uniqueUser_agency_scheme

 

String

For AcceptItem XML: This setting value allows you to choose the uniqueUser-agency-scheme URL value.

acceptItem_uniqueUser_agency_value

RLS

String

For AcceptItem XML: This setting value allows you to choose the uniqueUser-agency-value value (ex. 'ILL').

acceptItem_uniqueItem_agency_scheme

 

String

For AcceptItem XML: This setting value allows you to choose the uniqueUser-agency-scheme URL value.

acceptItem_uniqueItem_agency_value

BD

String

For AcceptItem XML: This setting value allows you to choose the uniqueUser-agency-value value (ex. 'BD').

acceptItem_Transaction_Prefix

TN-

String

For AcceptItem XML: This setting value allows you to choose a prefix that appears before the Transaction Number.

checkInItem_from_uniqueAgency_scheme

 

String

For CheckInItem XML: This setting value allows you to choose the from-uniqueAgency-scheme URL value.

checkInItem_from_uniqueAgency_value

BD

String

For CheckInItem XML: This setting value allows you to choose the from-uniqueAgency-value value (ex. 'BD').

checkInItem_to_uniqueAgency_scheme

 

String

For CheckInItem XML: This setting value allows you to choose the to-uniqueAgency-scheme URL value.

checkInItem_to_uniqueAgency_value

RLS

String

For CheckInItem XML: This setting value allows you to choose the to-uniqueAgency-value value (ex. 'RLS').

checkInItem_uniqueItem_agency_scheme

 

String

For CheckInItem XML: This setting value allows you to choose the uniqueItem-agency-scheme.

checkInItem_uniqueItem_agency_value

RLS

String

For CheckInItem XML: This setting value allows you to choose the uniqueItem-agency-value (ex. 'RLS').

checkInItem_Transaction_Prefix

TN-

String

For CheckInItem XML: This setting value allows you to choose a prefix that appears before the Transaction Number or Reference Number.

checkOutItem_from_uniqueAgency_scheme

 

String

For CheckOutItem XML: This setting value allows you to choose the from-uniqueAgency-scheme URL value.

checkOutItem_from_uniqueAgency_value

BD

String

For CheckOutItem XML: This setting value allows you to choose the from-uniqueAgency-value value (ex. 'BD').

checkOutItem_to_uniqueAgency_scheme

 

String

For CheckOutItem XML: This setting value allows you to choose the to-uniqueAgency-scheme URL value.

checkOutItem_to_uniqueAgency_value

RLS

String

For CheckOutItem XML: This setting value allows you to choose the to-uniqueAgency-value value (ex. 'RLS').

checkOutItem_uniqueUser_agency_scheme

 

String

For CheckOutItem XML: This setting value allows you to choose the uniqueUser-agency-scheme URL value.

checkOutItem_uniqueUser_agency_value

RLS

String

For CheckOutItem XML: This setting value allows you to choose the uniqueUser-agency-value value (ex. 'RLS').

checkOutItem_uniqueItem_agency_scheme

 

String

For CheckOutItem XML: This setting value allows you to choose the uniqueItem-agency-scheme URL value.

checkOutItem_uniqueItem_agency_value

RLS

String

For CheckOutItem XML: This setting value allows you to choose the uniqueItem-agency-value value (ex. 'RLS').

checkOutItem_uniqueRequest_agency_scheme

 

String

For CheckOutItem XML: This setting value allows you to choose the uniqueRequest-agency-scheme URL value.

checkOutItem_uniqueRequest_agency_value

BD

String

For CheckOutItem XML: This setting value allows you to choose the uniqueRequest-agency-value value (ex. 'BD').

checkOutItem_RequestIdentifierValue_Prefix

TN-

String

For CheckOutItem XML: This setting value allows you to choose a prefix that appears before the Transaction Number.