Differences

This shows you the differences between two versions of the page.

--- configuration:ils:alma [2018/07/06 13:46] – demiankatz
+++ configuration:ils:alma [2018/07/10 10:56] – mbirkner
@@ Line 5: / Line 5: @@
 This is the documentation for the Alma driver. It connects VuFind to the ILS [[https://www.exlibrisgroup.com/products/alma-library-services-platform/|Alma]] from ExLibris.
-The driver is configured in ''$VUFIND_HOME/config/vufind/Alma.ini''. Please be aware that you should copy this file to the ''local'' folder of your VuFind installation: ''$VUFIND_LOCAL_DIR/config/vufind/Alma.ini'' and make changes only there.
+===== 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 =====
-Below you will find information about the settings that can be customized in ''Alma.ini''.
+The driver is configured in ''$VUFIND_HOME/config/vufind/Alma.ini''. Please be aware that you should copy this file to the ''local'' folder of your VuFind installation: ''$VUFIND_LOCAL_DIR/config/vufind/Alma.ini'' and make changes only there. Below you will find information about the settings that can be customized in ''Alma.ini''.
 ==== [Catalog] ====
@@ Line 151: / Line 165: @@
 </code>
+==== [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:ils:alma#in_alma_webhooks|documentation on creating new user accounts in Alma below]].
+=== secret ===
+This must be exactly the same value as the one that you type into the "Secret" field at the webhook configuration page in Alma.
+Example:<code>secret = YOUR_WEBHOOK_SECRET_FROM_ALMA</code>
 ===== Authentication =====
 This section provides some notes on authenticating VuFind users against Alma.
@@ Line 190: / Line 211: @@
   * Webhook listener URL: ''YOUR_VUFIND_URL/Alma/Webhook''
-  * Secret: ''ENTER_RANDOM_ALPHANUMERIC_STRING_HERE''
+  * Secret: ''ENTER_RANDOM_ALPHANUMERIC_STRING_HERE'' [same value must be added to ''Alma.ini'']
   * Message type: ''JSON''
   * Subscriptions:
     * Check ''Users''
     * Select ''User Groups'' for which an account in VuFind should be created (probably all of them)
 ---- struct data ----
 ----