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