Docs: create autorenewals documentation
[working/Evergreen.git] / docs / admin / autorenewals.adoc
1 Autorenewals in Evergreen
2 -------------------------
3
4 Introduction
5 ~~~~~~~~~~~~
6
7 Circulation policies in Evergreen can now be configured to automatically renew items checked out on patron accounts.  Circulations will be renewed automatically and patrons will not need to log in to their OPAC accounts or ask library staff to renew materials. 
8
9 Autorenewals are set in the Circulation Duration Rules, which allows this feature to be applied to selected circulation policies.  Effectively, this makes autorenewals configurable by patron group, organizational unit or library, and circulation modifier.
10
11 Configure Autorenewals
12 ~~~~~~~~~~~~~~~~~~~~~~
13
14 Autorenewals are configured in *Administration -> Server Administration -> Circulation Duration Rules*.  
15
16 Enter the number of automatic renewals allowed in the new field called _max_auto_renewals_.  The field called _max_renewals_ will still set the maximum number of manual renewals, whether staff or patron initiated.  Typically, the _max_renewals_ value will be greater than _max_auto_renewals_, so that even if no more autorenewals are allowed, a patron may still renew via the OPAC.
17
18 image::media/autorenew_circdur.PNG[Autorenewals in Circulation Duration Rules]
19
20 The Circulation Duration Rule can then be applied to specific circulation policies (*Administration -> Local Administration -> Circulation Policies*) to implement autorenewals in Evergreen.
21
22 Autorenewal Notices and Action Triggers
23 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24
25 Two new action triggers have been added to Evergreen for use with autorenewals.  They can be found and configured in *Administration -> Local Administration -> Notifications/Action Triggers*.
26
27 * Autorenew
28 - Uses the checkout.due hook to automatically renew circulations before they are due.
29 - Autorenewals will not occur if the item has holds, exceeds the maximum number of autorenewals allowed, or if the patron has been blocked from renewing items.
30
31 * AutorenewNotify
32 - Email notification to inform patrons when their materials are automatically renewed or, if they are not automatically renewed due to meeting one of the criteria listed above.
33 - This notice can also be configured as an SMS notification.
34 - This notice does not change or interact with the Courtesy Notice (Pre-due Notice) that is also available in Evergreen.  Libraries should evaluate whether they want to use both Courtesy Notices and Autorenewal notices.
35
36 Sample of successful autorenewal notification:
37
38 image::media/autorenew_renewnotice.PNG[Notification of Successful Autorenewal]
39
40 Sample of blocked autorewal notification:
41
42 image::media/autorenew_norenewnotice.PNG[Notification of Blocked Autorenewal]
43
44 Autorenewals in Patron Accounts
45 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46
47 A new column called _AutoRenewalsRemaining_ indicates how many autorenewals are available for a transaction.
48
49 image::media/autorenew_itemsout.PNG[Autorenewals Remaining in Patron Items Out]