| Page Properties | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
| Field | Data | Notes |
|---|---|---|
| User Identifier type | Primary Identifier or Other Defined Identifier in Alma | 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 identifier in the user record. |
| Request pushing method | Open URL | |
| URL template | Campus specific Open URL | |
| Default library owner | Resource Sharing Library or Temp Location | |
| 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
If you have elected to use the Resource Sharing Library then you must configure both the Open Hours and Terms of Use tables for that library.
...
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 These install instructions assume you already have an installation of the ILLiad Client installed on a Microsoft Windows operating system. No info on Mac installationsworkstation.)
Create a new folder in your local machine's ILLiad\Addons directory (usually C:\Program Files (x86)\ILLiad\Addons\) and name it Alma-NCIP
Copy the three files - Config.xml, IDS_NCIP_Client.lua, and sublibraries.txt to the newly created directory.
You should manually modify the Config.xml file with the same information used in the plug-in interface. The screenshot below identifies these fields that need to be changed:
| Field Name | Data | Note |
|---|---|---|
| NCIP_Responder_URL | https://[your-Alma-Instance].alma.exlibrisgroup.com/view/NCIPServlet | Approximately located in Line 12 of the config.xml file |
acceptItem_from_uniqueAgency_value | Institutional Alma Code | Approximately located in Line 15 of the config.xml file |
ApplicationProfileType | e.g. |
...
| , ILLIAD | Approximately located in Line 18 of the config.xml file |
- Line 12 - NCIP_Responder_URL, enter
- acceptItem_from_uniqueAgency_value
- ApplicationProfileType
Alternate Instructions for alternate
Now, modify the following settings within the Illiad systems plug-in interface.
| Field Name | Data | Note |
|---|---|---|
| NCIP_Responder_URL | https://[your-Alma-Instance].alma.exlibrisgroup.com/view/NCIPServlet | Where Your-Alma-Instance can be determined by clicking on the HELP option in Alma's upper right corner. (e.g.na01,na03) |
| 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 your 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.
You may also need to manually modify the Config.xml file with the same information from the plug-in interface. The screenshot below identifies these fields that need to be changed:
- NCIP_Responder_URL
- acceptItem_from_uniqueAgency_value
- ApplicationProfileType
After all edits have been made to the file, restart Illiad and register the Add-on (see the documentation on activating an Add-On).
...