| Page Properties | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
| Field | Data | Notes |
|---|---|---|
| User Identifier type | Primary Identifier | Recommending the Primary Identifier since this will be used for other services and third party integrations within Alma. However this can be another designated identifer defined in the user record. |
| Request pushing method | Open URL | |
| URL template | Campus specific Open URL | |
| Default library owner | Resource Sharing Library | |
| Request Item - Bibliographic record ID type | OCLC Number | |
| Request Item - Default location | Lending Resource Sharing Request | |
| Check-Out Item - Default location | Borrowing Resource Sharing Request | |
| Check-Out Item - Default item policy | Campus defined policy | |
| Accept Item - Default location |
Resource Sharing Library
This library must have both the Open Hours and Terms of Use tables completed in order for request to populate in Alma.
...
In order to integrate Illiad with Alma, the add-on must be installed in every Illiad client that will be processing borrowing and lending requests. The client configuration is provided by VCU on GitHub and will need to be modified to look for the lending partner setup in Alma. Our settings are as follows:
Installing the Add-On
(This install instructions assume installation on a Windows operating system. No info on Mac installations)
Create a new folder in your local machine's ILLiad\Addons directory (usually C:\Program Files (x86)\ILLiad\Addons\) and name it Alma-NCIP
...
Modify the following settings within the Illiad systems plug-in interface.
| Field Name | Input | Note |
|---|---|---|
| NCIP_Responder_URL | https://na01.alma.exlibrisgroup.com/view/NCIPServlet | |
| acceptItem_from_uniqueAgency_value | Institutional Alma Code | Supplied by ExLibris during migration. For a list of Institution Codes please click here. |
| ApplicationProfileType | e.g., ILLIAD | This is you institutions Resource Sharing Partner code from Alma |
| BorrowingAcceptItemFailQueue | Use default | This designates the name of the queue a Borrowing Transaction will be moved to if the BorrowingAcceptItem function fails |
| BorrowingCheckInItemFailQueue | Use default | This designates the name of the queue a Borrowing Transaction will be moved to if the BorrowingCheckInItem function fails |
| LendingCheckOutItemFailQueue | Use default | This designates the name of the queue a Lending Transaction will be moved to if the CheckOutItem function fails |
| LendingCheckInItemFailQueue | Use default | This designates the name of the queue a Lending Transaction will be moved to if the CheckInItem function fails |
| EnablePatronBorrowingReturns | When 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_Prefixes | Determines whether or not you want to change prefixes of a transaction based on specific criteria | |
| Prefix_for_LibraryUseOnly | Yes | This setting allows you to change the prefix of a transaction that is marked LibraryUseOnly |
| Prefix_for_RenewablesAllowed | Yes | This setting allows you to change the prefix of a transaction that is marked RenewalsAllowed |
| Prefix_for_LibraryUseOnly_and_RenewablesAllowed | Yes | This setting allows you to change the prefix of a transaction that is marked both LibraryUseOnly and RenewalsAllowed |
Then make sure the plug-in is activated in the ILLiad client. This is not automatic.
Once the Config.xml file is modified to reflect your Alma values, the Alma-NCIP folder, containing the config.xml, ALMA_NCIP_Client.lua and sublibraries.txt files, needs to be copied to the Add-On folder within the Illiad install location on your computer. After the files are copied, start Illiad and register the Add-on (see the documentation on activating an Add-On).
Notes: We had to use our Alma node address for the NCIP_Responder_URL. The VCU URL provided in the default config was to a generic Alma web services URL and did not work for us. You must provide your Alma Institution Code for the “acceptItem_from_uniqueAgency_value” and make sure the code you provide for “ApplicationProfileType” is the same code for your Resource Sharing Partner in Alma. Ours was “ILLIAD”. We also had to change the name of the Files->File value to ALMA_NCIP_Client.lua in order for it to match the actual file that is added on the Illiad client.
Action log
| Section | Point Person | Expected Completion Date | Last action taken | Next action required |
|---|---|---|---|---|
Articulate the need for the policy (background) |
| |||
Create a Policy Statement |
| |||
Identify and create best practice recommendations |
| |||
Where applicable, identify and write up procedures in Alma |
|
Tasks to be completed
- Type your task here, using "@" to assign to a user and "//" to select a due date