About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

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 revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
configuration:ils:alma [2018/07/06 13:46] demiankatzconfiguration:ils:alma [2018/07/10 10:55] – [Features] mbirkner
Line 151: Line 151:
 </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 197:
  
   * 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)
 +
 +
 +===== 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
 +
 +
 ---- struct data ---- ---- struct data ----
 ---- ----
  
configuration/ils/alma.txt · Last modified: 2024/02/14 19:08 by demiankatz