]> git.evergreen-ils.org Git - working/Evergreen.git/blob - docs/admin_initial_setup/borrowing_items.txt
Docs 2.6: Lost Item Billing Min/Max Price Settings
[working/Evergreen.git] / docs / admin_initial_setup / borrowing_items.txt
1 Borrowing items: who, what, for how long
2 ========================================
3
4 Circulation policies pull together user, library, and item data to determine how
5 library materials circulate, such as: which patrons, from what libraries can
6 borrow what types of materials, for how long, and with what overdue fines. 
7
8 Individual elements of the circulation policies are configured using specific
9 interfaces, and should be configured prior to setting up the circulation 
10 policies.  
11
12 Data elements that affect your circulation policies
13 ---------------------------------------------------
14
15 There are a few data elements which must be considered when setting up your
16 circulation policies. 
17
18 Copy data
19 ~~~~~~~~~
20
21 Several fields set via the copy editor are commonly used to affect the
22 circulation of an item.
23
24 * *Circulation modifier* - Circulation modifiers are fields used to control
25 circulation policies on specific groups of items. They can be added to copies
26 during the cataloging process. New circulation modifiers can be created in the
27 staff client by navigating to *Admin > Server Administration > Circulation
28 Modifiers*.
29 * *Circulate?* flag - The circulate? flag in the copy editor can be set to False
30 to disallow an item from circulating.
31 * *Reference?* flag - The reference? flag in the copy editor can also be used as
32 a data element in circulation policies.
33
34 Copy Locations
35 ~~~~~~~~~~~~~~
36
37 * To get to the Copy Locations Editor, navigate to *Admin > Local Administration
38   > Copy Locations Editor*. 
39 * When setting up copy locations for your library you can set an entire copy
40 location to allow or disallow circulation.
41
42 image::media/copy_locations_circulate.png[]
43
44 * Copy locations can also be used as a data element in circulation policies. 
45
46 User Permission Group
47 ~~~~~~~~~~~~~~~~~~~~~
48
49 * The user permission group is also commonly used as a data element in
50 circulation policies. 
51 * Other user data that can be used for circulation policies include the
52 *juvenile* flag in the user record.
53
54 Circulation Rules
55 -----------------
56
57 *Loan duration* describes the length of time for a checkout. You can also
58 identify the maximum renewals that can be placed on an item.
59
60 You can find Circulation Duration Rules by navigating to *Admin > Server
61 Administration > Circulation Duration Rules*. 
62
63 image::media/circ_duration_rules.jpg[]
64
65 *Recurring fine* describes the amount assessed for daily and hourly fines as
66 well as fines set for other regular intervals. You can also identify any grace
67 periods that should be applied before the fine starts accruing.
68
69 You can find Recurring Fine Rules by navigating to *Admin > Server
70 Administration > Circulation Recurring Fine Rules*.
71
72 image::media/circ_recurring_fine_rules.jpg[]
73
74 *Max fine* describes the maximum amount of fines that will be assessed for a
75 specific circulation. Set the *Use Percent* field to True if the maximum fine
76 should be a percentage of the item's price.
77
78 You can find Circ Max Fine Rules by navigating to *Admin > Server
79 Administration > Circulation Max Fine Rules*.
80
81 image::media/circ_max_fine_rules.jpg[]
82
83 These rules generally cause the most variation between organizational units.
84
85 Loan duration and recurring fine rate are designed with 3 levels: short, normal,
86 and extended loan duration, and low, normal, and high recurring fine rate. These
87 values are applied to specific items, when copy records are created. 
88
89 When naming these rules, give them a name that clearly identifies what the rule
90 does. This will make it easier to select the correct rule when creating your
91 circ policies.
92
93 Circulation Limit Sets
94 ~~~~~~~~~~~~~~~~~~~~~~
95
96 Circulation Limit Sets allow you to limit the maximum number of copies for
97 different types of materials that a patron can check out at one time. Evergreen
98 supports creating these limits based on circulation modifiers, copy locations,
99 or circ limit groups, which allow you to create limits based on MARC data.
100 The below instructions will allow you to create limits based on circulation
101 modifiers.
102
103 * Configure the circulation limit sets by selecting *Admin > Local
104 Administration > Circulation Limit Sets*.
105 * *Items Out* -  the maximum number of items circulated to a patron at the same
106 time.
107 * *Depth* - Enter the Min Depth, or the minimum depth, in the org tree that
108 Evergreen will consider as valid circulation libraries for counting items out.
109 The min depth is based on org unit type depths. For example, if you want the
110 items in all of the circulating libraries in your consortium to be eligible for
111 restriction by this limit set when it is applied to a circulation policy, then
112 enter a zero (0) in this field. 
113 * *Global* - Check the box adjacent to Global Flag if you want all of the org
114 units in your consortium to be restricted by this limit set when it is applied
115 to a circulation policy. Otherwise, Evergreen will only apply the limit to the
116 direct ancestors and descendants of the owning library.
117 * *Linked Limit Groups* - add any circulation modifiers, copy locations, or circ
118 limit groups that should be part of this limit set.
119
120 *Example*
121 Your library (BR1) allows patrons to check out up to 5 videos at one time. This
122 checkout limit should apply when your library's videos are checked out at any
123 library in the consortium. Items with DVD, BLURAY, and VHS circ modifiers should
124 be included in this maximum checkout count. 
125
126 To create this limit set, you would add 5 to the *Items Out* field, 0 to the
127 *Depth* field and select the *Global Flag*. Add the DVD, BLURAY and VHS circ
128 modifiers to the limit set.
129
130 Creating Circulation Policies
131 -----------------------------
132
133 Once you have identified your data elements that will drive circulation policies
134 and have created your circulation rules, you are ready to begin creating your
135 circulation policies. 
136
137 If you are managing a small number of rules, you can create and manage
138 circulation policies in the staff client via *Admin > Local Administration >
139 Circulation Policies*. However, if you are managing a large number of policies,
140 it is easier to create and locate rules directly in the database by updating
141 *config.circ_matrix_matchpoint*.
142
143 The *config.circ_matrix_matchpoint* table is central to the configuration of
144 circulation parameters. It collects the main set of data used to determine what
145 rules apply to any given circulation. It is useful for us to think of their
146 columns in terms of 'match' columns, those that are used to match the
147 particulars of a given circulation transaction, and 'result' columns, those that
148 return the various parameters that are applied to the matching transaction.
149
150 * Circulation policies by checkout library or owning library?
151    - If your policies should follow the rules of the library that checks out the
152 item, select the checkout library as the *Org Unit(org_unit)*.
153    - If your policies should follow the rules of the library that owns the item,
154 select the consortium as the *Org Unit (org_unit)* and select the owning library
155 as the *Copy Circ Lib (copy_circ_lib)*.
156 * Renewal policies can be created by setting *Renewals? (is_renewal)* to True.
157 * You can apply the duration rules, recurring fine rules, maximum fine rules,
158 and circulation sets created in the above sets when creating the circulation
159 policy.
160
161 Best practices for creating policies
162 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
163
164 * Start by replacing the default consortium-level circ policy with one that
165 contains a majority of your libraries' duration, recurring fine, and max fine
166 rules. This first rule will serve as a default for all materials and permission
167 groups. 
168 * If many libraries in your consortium have rules that differ from the default
169 for particular materials or people, set a consortium-wide policy for that circ
170 modifier or that permission group.
171 * After setting these consortium defaults, if a library has a circulation rule
172 that differs from the default, you can then create a rule for that library. You
173 only need to change the parameters that are different from the default
174 parameters. The rule will inherit the values for the other parameters from that
175 default consortium rule.
176 * Try to avoid unnecessary repetition.
177 * Try to get as much agreement as possible among the libraries in your
178 consortium.
179
180 *Example 1*
181
182 image::media/circ_example1.png[]
183  
184 In this example, the consortium has decided on a 21_day_2_renew loan rule for
185 general materials, i.e. books, etc. Most members do not charge overdue fines.
186 System 1 charges 25 cents per day to a maximum of $3.00, but otherwise uses the
187 default circulation duration. 
188
189 *Example 2*
190
191 image::media/circ_example2.png[]
192
193 This example includes a basic set of fields and creates a situation where items
194 with a circ modifier of "book" or "music" can be checked out, but "dvd" items
195 will not circulate. The associated rules would apply during checkouts. 
196
197 *Example 3*
198
199 image::media/circ_example3.png[]
200
201 This example builds on the earlier example and adds some more complicated
202 options.
203
204 It is still true that "book" and "music" items can be checked out, while "dvd"
205 is not circulated. However, now we have added new rules that state that "Adult"
206 patrons of "SYS1" can circulate "dvd" items.
207
208 Settings Relevant to Circulation
209 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
210
211 The following circulation settings, available via *Admin > Local Administration
212 > Library Settings Editor*, can also affect your circulation duration, renewals
213 and fine policy.
214
215 * *Auto-Extend Grace Periods* - When enabled, grace periods will auto-extend.
216 By default this will be only when they are a full day or more and end on a
217 closed date, though other options can alter this. 
218 * *Auto-Extending Grace Periods extend for all closed dates* - If enabled and
219 Grace Periods auto-extending is turned on, grace periods will extend past all
220 closed dates they intersect, within hard-coded limits. 
221 * *Auto-Extending Grace Periods include trailing closed dates* - If enabled and
222 Grace Periods auto-extending is turned on, grace periods will include closed
223 dates that directly follow the last day of the grace period.
224 * *Checkout auto renew age* - When an item has been checked out for at least
225 this amount of time, an attempt to check out the item to the patron that it is
226 already checked out to will simply renew the circulation. 
227 * *Cap Max Fine at Item Price* - This prevents the system from charging more
228 than the item price in overdue fines.
229 * *Lost Item Billing: New Min/Max Price Settings* - Patrons will be billed
230 at least the Min Price and at most the Max price, even if the item's price
231 is outside that range. To set a fixed price for all lost items, set min and
232 max to the same amount.
233 * *Charge fines on overdue circulations when closed* - Normally, fines are not
234 charged when a library is closed. When set to True, fines will be charged during
235 scheduled closings and normal weekly closed days.