Merge branch 'master' of git.evergreen-ils.org:Evergreen-DocBook into doc_consolidati...
[working/Evergreen.git] / admin / hold_driven_recalls.txt
1 Hold-driven recalls
2 ===================
3
4 indexterm:[hold-driven recalls]
5 indexterm:[circulation, recalls, hold-driven]
6
7 _Added in Evergreen 2.1_
8
9 In academic libraries, it is common for groups like faculty and graduate
10 students to have extended loan periods (for example, 120 days), while
11 others have more common loan periods such as 3 weeks. In these environments,
12 it is desirable to have a hold placed on an item that has been loaned out
13 for an extended period to trigger a 'recall', which:
14
15   . Truncates the loan period
16   . Sets the remaining available renewals to 0
17   . 'Optionally': Changes the fines associated with overdues for the new due
18     date
19   . 'Optionally': Notifies the current patron of the recall, including the
20     new due date and fine level
21
22 Enabling hold-driven recalls
23 ----------------------------
24
25 By default, holds do not trigger recalls. To enable hold-driven recalls
26 of circulating items, library settings must be changed as follows:
27
28   . Click *Admin* -> *Local Administration* -> *Library Settings Editor.*
29   . Set the *Recalls: Circulation duration that triggers a recall
30     (recall threshold)* setting. The recall threshold is specified as an
31     interval (for example, "21 days"); any items with a loan duration of
32     less that this interval are not considered for a recall.
33   . Set the *Recalls: Truncated loan period (return interval)* setting.
34     The return interval is specified as an interval (for example, "7 days").
35     The due date on the recalled item is changed to be the greater of either
36     the recall threshold or the return interval.
37   . 'Optionally': Set the *Recalls: An array of fine amount, fine interval,
38     and maximum fine* setting. If set, this applies the specified fine rules
39     to the current circulation period for the recalled item.
40
41 When a hold is placed and no available copies are found by the hold targeter,
42 the recall logic checks to see if the recall threshold and return interval
43 settings are set; if so, then the hold targeter checks the currently
44 checked-out copies to determine if any of the currently circulating items at
45 the designated pickup library have a loan duration longer than the recall
46 threshold. If so, then the eligible item with the due date nearest to the
47 current date is recalled.
48
49 Editing the item recall notification email template
50 ---------------------------------------------------
51 The template for the item recall notification email is contained in the
52 'Item Recall Email Notice' template, found under *Admin* -> *Local
53 Administration* -> *Notifications / Action Triggers*.