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