Warning: This page has not been updated in over over a year and may be outdated or deprecated.
configuration:ils:alma
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
configuration:ils:alma [2018/07/10 08:03] – [[Requestable]] mbirkner | configuration:ils:alma [2020/09/22 14:18] – demiankatz | ||
---|---|---|---|
Line 5: | Line 5: | ||
This is the documentation for the Alma driver. It connects VuFind to the ILS [[https:// | This is the documentation for the Alma driver. It connects VuFind to the ILS [[https:// | ||
- | The driver | + | ===== Features ===== |
+ | |||
+ | An unordered list of features implemented to the Alma driver: | ||
+ | |||
+ | * Create new user account | ||
+ | * Log in to user account and show details | ||
+ | * Place hold requests | ||
+ | * Show current hold / ILL / storage retreival requests | ||
+ | * Cancel hold requests | ||
+ | * Show current loans | ||
+ | * Renew loans | ||
+ | * Show account blocks | ||
+ | * Show fines/fees | ||
+ | |||
===== Alma.ini ===== | ===== Alma.ini ===== | ||
- | Below you will find information about the settings that can be customized in '' | + | The driver is configured in '' |
==== [Catalog] ==== | ==== [Catalog] ==== | ||
Line 130: | Line 144: | ||
==== [Requestable] ==== | ==== [Requestable] ==== | ||
+ | |||
+ | :!: // This section only applies prior to VuFind 6.0; starting with VuFind 6.0, the ILS driver automatically determines which requests are legal, rendering this configuration unnecessary. // | ||
+ | |||
Here you can specify which user group is allowed to place hold requests on which Fulfillment Unit. For more details on the concept of Fulfillment Units, see the description for the '' | Here you can specify which user group is allowed to place hold requests on which Fulfillment Unit. For more details on the concept of Fulfillment Units, see the description for the '' | ||
Line 152: | Line 169: | ||
==== [Webhook] ==== | ==== [Webhook] ==== | ||
+ | Webhooks are used by Alma for communicating with VuFind. They are sending messages from Alma to VuFind where they can be processed. To use webhooks, they have to be activated in Alma. Also, you have to give them permissions in permissions.ini on the VuFind side. For more details on webhooks, see also the [[configuration: | ||
+ | === secret === | ||
+ | This must be exactly the same value as the one that you type into the " | ||
+ | Example:< | ||
===== Authentication ===== | ===== Authentication ===== | ||
This section provides some notes on authenticating VuFind users against Alma. | This section provides some notes on authenticating VuFind users against Alma. | ||
- | If a user wants to log in to his account in VuFind, you have multiple choices as to how that can be done. For example, there are identity providers (IdP) like SAML, Shibboleth, LDAP, etc. you can use (see '' | + | If a user wants to log in to his account in VuFind, you have multiple choices as to how that can be done. For example, there are identity providers (IdP) like SAML, Shibboleth, LDAP, etc. you can use (see '' |
But there is a problem if you do not have such an IdP. VuFind would offer the possibility to use the '' | But there is a problem if you do not have such an IdP. VuFind would offer the possibility to use the '' | ||
Line 179: | Line 200: | ||
=== Provide access for webhook to VuFind === | === Provide access for webhook to VuFind === | ||
- | On the VuFind side, the webhook receiving code is activated by default. For security reasons, the access is restricted. You can provide the access to it via the [[https:// | + | On the VuFind side, the webhook receiving code is activated by default. For security reasons, the access is restricted. You can provide the access to it via the [[https:// |
< | < | ||
Line 193: | Line 214: | ||
* Webhook listener URL: '' | * Webhook listener URL: '' | ||
- | * Secret: '' | + | * Secret: '' |
* Message type: '' | * Message type: '' | ||
* Subscriptions: | * Subscriptions: | ||
* Check '' | * Check '' | ||
* Select '' | * Select '' | ||
+ | |||
+ | |||
+ | |||
---- struct data ---- | ---- struct data ---- | ||
---- | ---- | ||
configuration/ils/alma.txt · Last modified: 2024/02/14 19:08 by demiankatz