Docs: Updated checkin modifiers
[working/Evergreen.git] / docs / circulation / circulating_items_web_client.adoc
1 Circulating Items
2 -----------------
3
4 Check Out
5 ~~~~~~~~~~
6
7 Regular Items
8 ^^^^^^^^^^^^^
9
10 1) To check out an item click *Check Out Items* from the Circulation and Patrons toolbar, or select *Circulation* -> *Check Out*.
11
12 image::media/checkout_menu_web_client.png[]
13
14 2) Scan or enter patron's barcode and click *Submit* if entering barcode manually. If scanning, number is submitted automatically.
15
16 image::media/retrieve_patron_web_client.png[]
17
18 3) Scan or enter item barcode manually, clicking *Submit* if manual.
19
20 image::media/checkout_item_barcode_web_client.png[] 
21
22 4) Due date is now displayed.
23
24 image::media/due_date_display_web_client.png[]
25  
26 5) When all items are scanned, click the *Done* button to generate slip receipt or to exit patron record if not printing slip receipts. 
27
28 Pre-cataloged Items
29 ^^^^^^^^^^^^^^^^^^^
30
31 1) Go to patron's *Check Out* screen by clicking *Circulation* -> *Check Out Items*.
32
33 2) Scan the item barcode.
34
35 3) At prompt, enter the required information click *Precat Checkout*. 
36
37 image::media/precat_web_client.png[]
38  
39 [TIP]
40 On check-in, Evergreen will prompt staff to re-route the item to cataloging.
41
42 [NOTE]
43 This screen does not respond to the enter key or carriage return provided
44 by a barcode scanner when the cursor is in the ISBN field.  This behavior
45 prevents pre-cataloged items from being checked out before you are done
46 entering all the desired information.
47
48 Due Dates
49 ^^^^^^^^^
50
51 Circulation periods are pre-set. When items are checked out, due dates are automatically calculated and inserted into circulation records if the *Specific Due Date* checkbox is not selected on the Check Out screen. The *Specific Due Date* checkbox allows you to set a different due date to override the pre-set loan period.
52
53 Before you scan the item, select the *Specific Due Date* checkbox. Enter the date in yyyy-mm-dd format. This date applies to all items until you change the date, de-select the *Specific Due Date* checkbox, or quit the patron record.
54
55 image::media/specify_due_date1_web_client.png[]
56
57
58 Email Checkout Receipts
59 ^^^^^^^^^^^^^^^^^^^^^^^
60
61 This feature allows patrons to receive checkout receipts through email at the circulation desk and in the Evergreen self-checkout interface.  Patrons need to opt in to receive email receipts by default and must have an email address associated with their account.  Opt in can be staff mediated at the time of account creation or in existing accounts.  Patrons can also opt in directly in their OPAC account or through patron self-registration.  This feature does not affect the behavior of checkouts from SIP2 devices.
62
63 Staff Client Check Out
64 ++++++++++++++++++++++
65
66 When a patron has opted to receive email checkout receipts by default, an envelope icon representing email will appear next to the receipt options in the Check Out screen.  A printer icon representing a physical receipt appears if the patron has not opted in to the default email receipts.
67
68 image::media/ereceipts5_web_client.PNG[]
69
70 Staff can click *Quick Receipt* and the default checkout receipt option will be triggered—an email will be sent or the receipt will print out.  The Quick Receipt option allows staff to stay in the patron account after completing the transaction.  Alternatively, staff can click *Done* to trigger the default checkout receipt and close out the patron account.  By clicking on the arrow next to the Quick Receipt or Done buttons, staff can select which receipt option to use, regardless of the selected default.  The email receipt option will be disabled if the patron account does not have an email address.
71
72 Self Checkout
73 +++++++++++++
74
75 In the Self Checkout interface, patrons will have the option to select a print or email checkout receipt, or no receipt.  The radio button for the patron's default receipt option will be selected automatically in the interface.  Patrons can select a different receipt option if desired.  The email receipt radio button will be disabled if there is no email address associated with the patron's account.
76
77 image::media/ereceipts6_web_client.PNG[]
78
79 Opt In
80 ++++++
81
82 *Staff Mediated Opt In At Registration*
83
84 Patrons can be opted in to receive email checkout receipts by default by library staff upon the creation of their library account.  Within the patron registration form, there is a new option below the Email Address field to select _Email checkout receipts by default?_.  Select this option if the patron wants email checkout receipts to be their default.  Save any changes.
85
86 image::media/ereceipts1_web_client.PNG[]
87
88 *Staff Mediated Opt In After Registration*
89
90 Staff can also select email checkout receipts as the default option in a patron account after initial registration.  Within the patron account go to *Edit* and select _Email checkout receipts by default?_.  Make sure the patron also has an email address associated with their account.  Save any changes.
91
92 image::media/ereceipts2_web_client.PNG[]
93
94 *Patron Opt In – Self-Registration Form*
95
96 If your library offers patrons the ability to request a library card through the patron self-registration form, they can select email checkout receipts by default in the initial self-registration form:
97
98 image::media/ereceipts3_web_client.PNG[]
99
100 *Patron Opt In - OPAC Account*
101
102 Patrons can also opt in to receive email checkout receipts by default directly in their OPAC account.  After logging in, patrons can go to *Account Preferences->Notification Preferences* and enable _Email checkout receipts by default?_ and click *Save*.
103
104 image::media/ereceipts4_web_client.PNG[]
105
106
107 Email Checkout Receipt Configuration
108 ++++++++++++++++++++++++++++++++++++
109
110 Email checkout receipts will be sent out through a Notifications/Action Trigger called Email Checkout Receipt.  The email template and action trigger can be customized by going to *Administration->Local Administration->Notifications/Action Trigger->Email Checkout Receipt*.
111
112
113 Check In
114 ~~~~~~~~
115
116 Regular check in
117 ^^^^^^^^^^^^^^^^
118
119 1) To check in an item click *Check In Items* from the Circulation and Patrons toolbar, or select *Circulation* -> *Check In*.
120
121 image::media/check_in_menu_web_client.png[]
122
123 2) Scan item barcode or enter manually and click *Submit*.
124
125 image::media/checkin_barcode_web_client.png[]
126  
127 3) If there is an overdue fine associated with the checkin, an alert will appear at the top of the screen with a fine tally for the current checkin session. To immediately handle fine payment, click the alert to jump to the patron's bill record.
128
129 image::media/overdue_checkin_web_client.png[]
130
131 Backdated check in
132 ^^^^^^^^^^^^^^^^^^
133
134 This is useful for clearing a book drop.
135
136 1) To change effective check-in date, select *Circulation* -> *Check In Items*. In *Effective Date* field enter the date in yyyy-mm-dd format.
137
138 image::media/backdate_checkin_web_client.png[]
139
140 2) The new effective date is now displayed in the red bar above the Barcode field.
141
142 image::media/backdate_red_web_client.png[]
143
144 3) Move the cursor to the *Barcode* field. Scan the items. When finishing backdated check-in, change the *Effective Date* back to today's date.
145  
146 Backdate Post-Checkin
147 ^^^^^^^^^^^^^^^^^^^^^
148
149 After an item has been checked in, you may use the Backdate Post-Checkin function to backdate the check-in date.
150
151 1) Select the item on the Check In screen, click *Actions* -> *Backdate Post-Checkin*.
152
153 image::media/backdate_post_checkin_web_client.png[]
154
155 2) In *Effective Date* field enter the date in yyyy-mm-dd format.  The check-in date will be adjusted according to the new effective check-in date.
156
157 image::media/backdate_post_date_web_client.png[]
158
159 [TIP]
160 Checkin Modifiers
161 ===================================================
162 At the right bottom corner there is a *Checkin Modifiers* pop-up list. The options are:
163
164 -Ignore Pre-cat Items: no prompt when checking in a pre-cat item. Item will be routed to Cataloguing with Cataloguing status.
165
166 -Suppress Holds and Transit: item will not be used to fill holds or sent in transit. Item has Reshelving status.
167
168 -Amnesty Mode/Forgive Fines: overdue fines will be voided if already created or not be inserted if not yet created (e.g. hourly loans).
169
170 -Auto-Print Hold and Transit Slips: slips will be automatically printed without prompt for confirmation.
171
172 -Clear Holds Shelf. Checking in hold-shelf-expired items will clear the items from the hold shelf (holds to be cancelled).
173
174 -Retarget Local Holds. When checking in in process items that are owned by the library, attempt to find a local hold to retarget. This is intended to help with proper targeting of newly-catalogued items.
175
176 -Retarget All Statuses. Similar to Retarget Local Holds, this modifier will attempt to find a local hold to retarget, regardless of the status of the item being checked in. This modifier must be used in conjunction with the Retarget Local Holds modifier.
177
178 -Capture Local Holds as Transits. With this checkin modifier, any local holds will be given an in transit status instead of on holds shelf. The intent is to stop the system from sending holds notifications before the item is ready to be placed on the holds shelf and item will have a status of in-transit until checked in again. If you wish to simply delay notification and allow time for staff to process item to holds shelf, you may wish to use the Hold Shelf Status Delay setting in Library Settings Editor instead. See Local Administration section for more information.
179
180 -Manual Floating Active. Floating Groups must be configured for this modifier to function. The manual flag in Floating Groups dictates whether or not the "Manual Floating Active" checkin modifier needs to be active for a copy to float. This allows for greater control over when items float. 
181
182 -Update Inventory. When this checkin modifier is selected, scanned barcodes will have the current date/time added as the inventory date while the item is checked in. 
183
184 These options may be selected simultaneously. The selected option is displayed in the header area.
185
186 image::media/checkinmodifiers-with-inventory2.png[Web client check-in modifiers]
187
188 ===================================================
189   
190 Renewal and Editing the Item's Due Date
191 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
192
193 Checked-out items can be renewed if your library's policy allows it. The new due date is calculated from the renewal date. Existing loans can also be extended to a specific date by editing the due date or renewing with a specific due date.
194
195 Renewing via a Patron's Account
196 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
197
198 1) Retrieve the patron record and go to the *Items Out* screen.
199
200 image::media/items_out_click_web_client.png[]
201
202 2) Select the item you want to renew. Click on *Actions* -> *Renew*. If you want to renew all items in the account, click *Renew All* instead.
203
204 image::media/renew_action_web_client.png[]
205
206 3) If you want to specify the due date, click *Renew with Specific Due Date*. You will be prompted to select a due date. Once done, click *Apply*.
207
208 //image::media/renew_specific_date_web_client.png[]
209  
210
211 Renewing by Item Barcode
212 ^^^^^^^^^^^^^^^^^^^^^^^^
213 1) To renew items by barcode, select *Circulation* -> *Renew Items*.
214
215 2) Scan or manually entire the item barcode.
216
217 image::media/renew_item_web_client.png[]
218
219 3) If you want to specify the due date, click *Specific Due Date* and enter a new due date in yyyy-mm-dd format.
220
221 image::media/renew_item_calendar_web_client.png[]
222
223 Editing Due Date
224 ^^^^^^^^^^^^^^^^
225
226 1) Retrieve the patron record and go to the *Items Out* screen.
227
228 2) Select the item you want to renew. Click on *Actions* -> *Edit Due Date*.
229
230 image::media/edit_due_date_action_web_client.png[]
231
232 3) Enter a new due date in yyyy-mm-dd format in the pop-up window, then click *OK*.
233
234 [NOTE]
235 Editing a due date is not included in the renewal count.
236
237 Marking Items Lost and Claimed Returned
238 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
239
240 Lost Items
241 ^^^^^^^^^^
242 1) To mark items Lost, retrieve patron record and click *Items Out*.
243
244 2) Select the item. Click on *Actions* -> *Mark Lost (by Patron)*.
245
246 image::media/mark_lost_web_client.png[]
247
248 3) The lost item now displays as lost in the *Items Checked Out* section of the patron record.
249
250 image::media/lost_section_web_client.png[]
251
252 4) The lost item also adds to the count of *Lost* items in the patron summary on the left (or top) of the screen. 
253
254 image::media/patron_summary_checkouts_web_client.png[]
255
256 [NOTE]
257 Lost Item Billing
258 ========================
259 - Marking an item Lost will automatically bill the patron the replacement cost of the item as recorded in the price field in the item record, and a processing fee as determined by your local policy. If the lost item has overdue charges, the overdue charges may be voided or retained based on local policy.
260 - A lost-then-returned item will disappear from the Items Out screen only when all bills linked to this particular circulation have been resolved. Bills may include replacement charges, processing fees, and manual charges added to the existing bills. 
261 - The replacement fee and processing fee for lost-then-returned items may be voided if set by local policy. Overdue fines may be reinstated on lost-then-returned items if set by local policy.
262 ========================
263
264 Refunds for Lost Items
265 ^^^^^^^^^^^^^^^^^^^^^^^
266
267 If an item is returned after a lost bill has been paid and the library's policy is to void the replacement fee for lost-then-returned items, there will be a negative balance in the bill. A refund needs to be made to close the bill and the circulation record. Once the outstanding amount has been refunded, the bill and circulation record will be closed and the item will disappear from the Items Out screen.
268
269 If you need to balance a bill with a negative amount, you need to add two dummy bills to the existing bills. The first one can be of any amount (e.g. $0.01), while the second should be of the absolute value of the negative amount. Then you need to void the first dummy bill. The reason for using a dummy bill is that Evergreen will check and close the circulation record only when payment is applied or bills are voided.
270
271 Claimed Returned Items
272 ^^^^^^^^^^^^^^^^^^^^^^^
273
274 1) To mark an item Claimed Returned, retrieve the patron record and go to the *Items Out* screen.
275
276 2) Select the item, then select *Actions* -> *Mark Claimed Returned* from the dropdown menu.
277
278 image::media/mark_claims_returned_web_client.png[]
279
280 3) Enter date in yyyy-mm-dd format and click *Submit*.
281
282 image::media/claimed_date_web_client.png[]
283
284 4) The Claimed Returned item now displays in the *Other/Special Circulations* section of the patron record.
285
286 image::media/cr_section_web_client.png[]
287
288 5) The Claimed Returned item adds to the count of items that are Claimed Returned in the patron summary on the left (or top) of the screen. It also adds to the total *Other/Special Circulations* that is displayed when editing the patron's record. 
289
290 image::media/patron_summary_checkouts_web_client.png[]
291
292 [NOTE]
293 More on Claimed Returned Items
294 ====================================
295 - The date entered for a Claimed Returned item establishes the fine. If the date given has passed, bills will be adjusted accordingly.
296 - When a Claimed Returned item is returned, if there is an outstanding bill associated with it, the item will not disappear from the *Items Out* screen. It will disappear when the outstanding bills are resolved.
297 - When an item is marked Claimed Returned, the value in *Claims-returned Count* field in the patron record is automatically increased. Staff can manually adjust this count by editing the patron record.
298 ====================================
299
300 In-house Use (F6)
301 ~~~~~~~~~~~~~~~~~
302 1) To record in-house use, select *Circulation* -> *Record-In House Use*, click *Check Out* -> *Record In-House Use* on the circulation toolbar , or press *F6*. 
303  
304 image::media/record_in_house_action_web_client.png[]
305  
306 2) To record in-house use for cataloged items, enter number of uses, scan 
307  barcode or type barcode and click *Submit*.
308  
309 image::media/in_house_use_web_client.png[]
310  
311 [NOTE]
312 ====================================
313 There are two independent library settings that will allow copy alerts to display when scanned in In-house Use:
314 *Display copy alert for in-house-use* set to true will cause an alert message to appear, if it has one, when recording in-house-use for the copy.
315 *Display copy location check in alert for in-house-use* set to true will cause an alert message indicating that the item needs to be routed to its location if the location has check in alert set to true.
316 ====================================
317  
318 3) To record in-house use for non-cataloged items, enter number of uses, choose non-cataloged type from drop-down menu, and click *Submit*.
319
320 image::media/in_house_use_non_cat.png[]
321  
322 [NOTE] 
323 The statistics of in-house use are separated from circulation statistics. The in-house use count of cataloged items is not included in the items' total use count.
324
325 [[itemstatus_web_client]]
326 Item Status
327 ~~~~~~~~~~~
328
329 The Item Status screen is very useful. Many actions can be taken by either circulation staff or catalogers on this screen. Here we will cover some circulation-related functions, namely checking item status, viewing past circulations, inserting item alert messages, marking items missing or damaged, etc.
330
331 Checking item status
332 ^^^^^^^^^^^^^^^^^^^^
333
334 1) To check the status of an item, select *Search* -> *Search for copies by Barcode*.
335
336 image::media/item_status_menu_web_client.png[]
337
338 2) Scan the barcode or type it and click *Submit*. The current status of the item is displayed with selected other fields. You can use the column picker to select more fields to view.
339
340 image::media/item_status_barcode_web_client.png[]
341
342 3) Click the *Detail View* button and the item summary and circulation history will be displayed.
343
344 image::media/item_status_altview_web_client.png[]
345
346 4) Click *List View* to go back.
347
348 image::media/item_status_list_view_web_client.png[]
349
350 [NOTE]
351 If the item's status is "Available", the displayed due date refers to the previous circulation's due date.
352
353 [TIP]
354 Upload From File allows you to load multiple items saved in a file on your local computer. The file contains a list of the barcodes in text format. To ensure smooth uploading and further processing on the items, it is recommended that the list contains no more than 100 items.
355
356 Viewing past circulations
357 ^^^^^^^^^^^^^^^^^^^^^^^^^^
358 1) To view past circulations, retrieve the item on the *Item Status* screen as described above.
359
360 2) Select *Detail view*.
361
362 image::media/last_few_circs_action_web_client.png[]
363
364 3) Choose *Recent Circ History*.  The item’s recent circulation history is displayed.
365
366 image::media/last_few_circs_display_web_client.png[]
367
368 4) To retrieve the patron(s) of the last circulations, click on the name of the patron.  The patron record will be displayed.
369
370 [TIP]
371 The number of items that displays in the circulation history can be set in Local *Administration* -> *Library Settings Editor*.
372
373 [NOTE]
374 You can also retrieve the past circulations on the patron's Items Out screen and from the Check In screen.
375
376 Marking items damaged or missing and other functions
377 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
378 1) To mark items damaged or missing, retrieve the item on the *Item Status* screen.
379
380 2) Select the item. Click on *Actions for Selected Items* -> *Mark Item Damaged* or *Mark Item Missing*.
381
382 // image::media/mark_missing_damaged_web_client.png[]
383
384 [NOTE]
385 Depending on the library's policy, when marking an item damaged, bills (cost and/or processing fee) may be inserted into the last borrower's account. 
386
387 3) Following the above procedure, you can check in and renew items by using the *Check in Items* and *Renew Items* on the dropdown menu.
388
389 Item alerts
390 ^^^^^^^^^^^
391
392 The *Edit Item Attributes* function on the *Actions for Selected Items* dropdown list allows you to edit item records. Here, we will show you how to insert item alert messages by this function. See cataloging instructions for more information on item editing.
393 1) Retrieve record on *Item Status* screen.
394
395 2) Once item is displayed, highlight it and select *Actions for Selected Items* -> *Edit Item Attributes*.
396
397 3) The item record is displayed in the *Copy Editor*.
398
399 //image::media/copy_edit_alert_web_client.png[]
400
401 4) Click *Alert Message* in the *Miscellaneous* column. The background color of the box changes. Type in the message then click *Apply*. 
402
403 //image::media/copy_alert_message_web_client.png[]
404
405 5) Click *Modify Copies*, then confirm the action.
406
407
408 Long Overdue Items
409 ~~~~~~~~~~~~~~~~~~
410
411 *Items Marked Long Overdue*
412
413 Once an item has been overdue for a configurable amount of time, Evergreen will mark the item long overdue in the borrowing patron’s account.  This will be done automatically through a Notification/Action Trigger.   When the item is marked long overdue, several actions will take place:
414
415 . The item will go into the status of “Long Overdue” 
416
417 . The accrual of overdue fines will be stopped
418
419 Optionally the patron can be billed for the item price, a long overdue
420 processing fee, and any overdue fines can be voided from the account.  Patrons
421 can also be sent a notification that the item was marked long overdue. And
422 long-overdue items can be included on the "Items Checked Out" or "Other/Special
423 Circulations" tabs of the "Items Out" view of a patron's record. These are all
424 controlled by <<longoverdue_library_settings,library settings>>.
425  
426 image::media/long_overdue1.png[Patron Account-Long Overdue]
427
428
429 *Checking in a Long Overdue item*
430
431 If an item that has been marked long overdue is checked in, an alert will appear on the screen informing the staff member that the item was long overdue.  Once checked in, the item will go into the status of “In process”.  Optionally, the item price and long overdue processing fee can be voided and overdue fines can be reinstated on the patron’s account.  If the item is checked in at a library other than its home library, a library setting controls whether the item can immediately fill a hold or circulate, or if it needs to be sent to its home library for processing.
432  
433 image::media/long_overdue2.png[Long Overdue Checkin]
434  
435 *Notification/Action Triggers*
436
437 Evergreen has two sample Notification/Action Triggers that are related to marking items long overdue.  The sample triggers are configured for 6 months.  These triggers can be configured for any amount of time according to library policy and will need to be activated for use.
438
439 * Sample Triggers
440
441 ** 6 Month Auto Mark Long-Overdue—will mark an item long overdue after the configured period of time
442
443 ** 6 Month Long Overdue Notice—will send patron notification that an item has been marked long overdue on their account
444
445 [[longoverdue_library_settings]]
446 *Library Settings* 
447
448 The following Library Settings enable you to set preferences related to long overdue items:
449
450 * *Circulation: Long-Overdue Check-In Interval Uses Last Activity Date* —Use the
451   long-overdue last-activity date instead of the due_date to determine whether
452   the item has been checked out too long to perform long-overdue check-in
453   processing. If set, the system will first check the last payment time,
454   followed by the last billing time, followed by the due date. See also the
455   "Long-Overdue Max Return Interval" setting.
456
457 * *Circulation: Long-Overdue Items Usable on Checkin* —Long-overdue items are usable on checkin instead of going "home" first
458
459 * *Circulation: Long-Overdue Max Return Interval* —Long-overdue check-in processing (voiding fees, re-instating overdues, etc.) will not take place for items that have been overdue for (or have last activity older than) this amount of time 
460
461 * *Circulation: Restore Overdues on Long-Overdue Item Return*
462
463 * *Circulation: Void Long-Overdue item Billing When Returned*
464
465 * *Circulation: Void Processing Fee on Long-Overdue Item Return*
466
467 * *Finances: Leave transaction open when long overdue balance equals zero* —Leave transaction open when long-overdue balance equals zero. This leaves the lost copy on the patron record when it is paid
468
469 * *Finances: Long-Overdue Materials Processing Fee*
470
471 * *Finances: Void Overdue Fines When Items are Marked Long-Overdue*
472
473 * *GUI: Items Out Long-Overdue display setting*
474
475 [TIP]
476 Learn more about these settings in the chapter about the
477 Library Settings Editor.
478
479 *Permissions to use this Feature*
480
481 The following permissions are related to this feature:
482
483 * COPY_STATUS_LONG_OVERDUE.override
484
485 ** Allows the user to check-in long-overdue items thus removing the long-overdue status on the item
486
487
488