Differences

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

--- configuration:ils:alma [2018/07/10 08:20] – [In Alma (Webhooks)] mbirkner
+++ configuration:ils:alma [2020/09/22 14:18] (current) – demiankatz
@@ 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 130: / Line 144: @@
 ==== [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.
@@ Line 161: / Line 178: @@
 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 ''[Authentication]'' section in [[https://github.com/vufind-org/vufind/blob/master/config/vufind/config.ini|config.ini]]. [[https://developers.exlibrisgroup.com/alma/integrations/user-management/authentication/inst_idp|Alma can also make use of these IdP]]. So if you have one of the supported IdP, everything should be fine for you.
+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 ''[Authentication]'' section in [[https://github.com/vufind-org/vufind/blob/dev/config/vufind/config.ini|config.ini]]. [[https://developers.exlibrisgroup.com/alma/integrations/user-management/authentication/inst_idp|Alma can also make use of these IdP]]. So if you have one of the supported IdP, everything should be fine for you.
 But there is a problem if you do not have such an IdP. VuFind would offer the possibility to use the ''ILS'' authentication option. The ''ILS'' options would authenticate a user directly against the ILS (Alma) so that he is able to log in to his account in the ILS (Alma) via VuFind. But that option requires that the user's password is saved on the ILS side. ExLibris announced - due to a security certificate that they want to implement - that saving passwords in Alma will not be possible in the (near?) future. For that reason, a new authentication option was introduced: the ''AlmaDatabase'' option.
@@ Line 183: / Line 200: @@
 === 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://github.com/vufind-org/vufind/blob/master/config/vufind/permissions.ini|permissions.ini]] file. There, you have to allow the IP address of your Alma system to communicate with VuFind. To find out this IP address, go to [[https://knowledge.exlibrisgroup.com/Alma/Implementation_and_Migration/Implementation_Guides/03Technical_Requirements_for_Alma_and_Discovery_Implementation#Alma_Platform_IP_Range|this site on the ExLibris knowledge center]] or enter the URL to your Alma system to a service like [[https://www.site24x7.com/find-ip-address-of-web-site.html|this one]]. Here is an example of an entry in the ''permissions.ini'' file to allow webhook access. Replace the ''ipRange[]'' setting with the IP address of your Alma system:
+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://github.com/vufind-org/vufind/blob/dev/config/vufind/permissions.ini|permissions.ini]] file. There, you have to allow the IP address of your Alma system to communicate with VuFind. To find out this IP address, go to [[https://knowledge.exlibrisgroup.com/Alma/Implementation_and_Migration/Implementation_Guides/03Technical_Requirements_for_Alma_and_Discovery_Implementation#Alma_Platform_IP_Range|this site on the ExLibris knowledge center]] or enter the URL to your Alma system to a service like [[https://www.site24x7.com/find-ip-address-of-web-site.html|this one]]. Here is an example of an entry in the ''permissions.ini'' file to allow webhook access. Replace the ''ipRange[]'' setting with the IP address of your Alma system:
 <code>
@@ Line 202: / Line 219: @@
     * Check ''Users''
     * Select ''User Groups'' for which an account in VuFind should be created (probably all of them)
 ---- struct data ----
+properties.Page Owner :
 ----