LP 1169193 long-overdue release notes
[working/Evergreen.git] / docs / RELEASE_NOTES_NEXT / Circulation / long-overdue.txt
1 Long Overdue Circulations Management
2 ====================================
3
4 This is a two-part feature, which covers marking circulations as long
5 overdue via automated processing and check-in of long overdue circulations.
6
7 Marking Circulations Long Overdue
8 ---------------------------------
9
10 A new Action/Trigger reactor (MarkItemLongOverdue) and sample event 
11 definition (6 Month Overdue Mark Long-Overdue) are included for 
12 marking circulations and their associated copies as long overdue.  New org
13 unit settings determine whether the item price and/or a processing fee is
14 applied.  
15
16 A secondary Action/Trigger hook (longoverdue.auto) and sample event 
17 definition (6 Month Long Overdue Notice) are added so that (email, etc.) 
18 notifications can be sent when a circulation is marked long overdue via
19 this new automated process.
20
21 Also included is a new Action/Trigger validator PatronNotInCollections, which
22 can be used to prevent long overdue processing (or any circ-based event 
23 definition) for patrons that are in collections processing at (or above) the 
24 circulating library.
25
26 New Org Unit Settings
27 ~~~~~~~~~~~~~~~~~~~~~
28
29  * Long-Overdue Materials Processing Fee
30  * Void Overdue Fines When Items are Marked Long-Overdue
31  * Leave transaction open when long overdue balance equals zero
32
33 A combination of 'Charge lost on zero' and 'Default Item Price' are used to
34 determine the amount to charge for the item price when a circulation is 
35 marked as long overdue.
36
37 New Billing Types
38 ~~~~~~~~~~~~~~~~~
39
40  * Long-Overdue Materials
41  * Long-Overdue Materials Processing Fee
42
43 New Permissions
44 ~~~~~~~~~~~~~~~
45
46  * SET_CIRC_LONG_OVERDUE
47
48 New Copy Status
49 ~~~~~~~~~~~~~~~
50
51  * Long Overdue
52
53 Check-in of Long Overdue Circulations
54 -------------------------------------
55
56 Check-in of long overdue items may result in any of the following actions, 
57 depending on configuration.
58
59  * Void the copy price billing 
60  * Void the long-overdue processing fee billing 
61  * Reinstate voided overdue fines 
62
63 The process is practically identical to Lost processing.  However, one
64 difference between Lost and Long Overdue check-in is that the window
65 of time during which a long overdue item may be returned may be based on the
66 due date (like Lost) or the last billing activity date (last payment, last 
67 billing).  This is controlled with the "Long-Overdue Check-In Interval Uses 
68 Last Activity Date" org unit setting.
69
70 New Org Unit Settings
71 ~~~~~~~~~~~~~~~~~~~~~
72
73  * Long-Overdue Items Usable on Checkin
74  * Long-Overdue Max Return Interval
75  * Restore Overdues on Long-Overdue Item Return
76  * Void Long-Overdue Item Billing When Returned
77  * Void Processing Fee on Long-Overdue Item Return
78  * Long-Overdue Check-In Interval Uses Last Activity Date
79
80 New Permissions
81 ~~~~~~~~~~~~~~~
82
83  * COPY_STATUS_LONGOVERDUE.override
84
85 Upgrade Notes
86 -------------
87
88 If you are using a custom version of the 
89 '/openils/conf/action_trigger_filters.json.example' file, you will need to 
90 merge the changes made by this feature into your file.  The change in 
91 question alters the 'checkout.due' hook such that LONGOVERDUE circulations 
92 are no longer treated as regular overdue items.