| Page Properties | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
- In order for the ILLiad / Alma plugin to work, the ILLiad user account must contain a unique patron identifier that matches a unique Alma patron identifier (e.g Primary Identifier, University ID, Barcode, etc.)
For new user accounts created for Illiad, use the Primary identifier that is exported by PeopleSoft during the Patron Load as the unique account name for the borrower.
Alma Setup
Setup requires the creation of a Resource Sharing Partner and a Resource Sharing Library or a temporary location within an establised library if not using the Resource Sharing Library that comes with Alma.
...
| Field | Data | Notes |
|---|---|---|
| User Identifier type | Primary Identifier (default) or Other Defined Identifier in Alma (Barcode, University ID, etc) | Data from this field must match a unique patron identifier in ILLiad. The default in ILLiad is username. If the defaults cannot be applied to your campus then please view the additional instructions for alternate user identifiers here. |
| Request pushing method | Open URL | |
| URL template | Campus specific Open URL | According to Ex Libris, this is not mandatory. Reference ERM Functional Call from 4/6 |
| 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.
...
| 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 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 | Approximately located in Line 15 of the config.xml file |
ApplicationProfileType | e.g., ILLIAD | Approximately located in Line 18 of the config.xml file It is case sensitive. The code's case must match exactly what you have listed for the Alma Resource Sharing Partner |
- Line 12 - NCIP_Responder_URL, enter
- acceptItem_from_uniqueAgency_value
- ApplicationProfileType
...
| 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 your institutions Resource Sharing Partner code from Alma. It is case sensitive. The code's case must match exactly what you have listed for the Alma Resource Sharing Partner. |
| 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.
After all edits have been made to the file, restart Illiad and register the Add-on (see the documentation on activating an Add-On).
Distributing the add-on to multiple ILLiad clients
Atlas provides documentation for configuring ILLiad so that add-on files can be shared by multiple clients:
https://prometheus.atlas-sys.com/display/ILLiadAddons/Distributing+Addons
The add-on can be distributed to all clients and de-activated for those clients that are not using it.
During testing at SLO, the NCIP plugin was deployed once from the server, with its config, and is auto-activated in the everyone's ILLiad client, but it was discovered that the ILLiad client needed to be run once as Administrator in order to write the updated add-on from server share into Program Files (x86)\ILLiad\Addons. (Thanks to Mike Price at SLO for sharing this troubleshooting tip!).
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 |
| |||
Update Response Server URL instruction add new screen shot |
| |||
| Added documentation for distributing add-on to multiple clients | Lauren Magnuson (Unlicensed) |
|