About Features Downloads Getting Started Documentation Events Support GitHub

Site Tools


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.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
configuration:ils:alma [2018/07/06 13:46]
demiankatz
configuration:ils:alma [2019/04/01 17:18]
demiankatz [[Requestable]]
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. 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 ===== ===== 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] ==== ==== [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 ''[FulfillmentUnits]'' section above. 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 ''[FulfillmentUnits]'' section above.
  
Line 151: Line 168:
 </code> </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 ===== ===== Authentication =====
 This section provides some notes on authenticating VuFind users against Alma. This section provides some notes on authenticating VuFind users against Alma.
Line 190: Line 214:
  
   * Webhook listener URL: ''YOUR_VUFIND_URL/Alma/Webhook''   * 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''   * Message type: ''JSON''
   * Subscriptions:   * Subscriptions:
     * Check ''Users''     * Check ''Users''
     * Select ''User Groups'' for which an account in VuFind should be created (probably all of them)     * Select ''User Groups'' for which an account in VuFind should be created (probably all of them)
 +
 +
 +
 ---- struct data ---- ---- struct data ----
 ---- ----
  
configuration/ils/alma.txt · Last modified: 2020/09/22 14:18 by demiankatz