Docs: adding section about circulating items in the Web client
[Evergreen.git] / docs / circulation / circulating_items_web_client.txt
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 Due Dates
43 ^^^^^^^^^
44
45 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.
46
47 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.
48
49 image::media/specify_due_date1_web_client.png[]
50
51
52 Check In
53 ~~~~~~~~
54
55 Regular check in
56 ^^^^^^^^^^^^^^^^
57
58 1) To check in an item click *Check In Items* from the Circulation and Patrons toolbar, or select *Circulation* -> *Check In*.
59
60 image::media/check_in_menu_web_client.png[]
61
62 2) Scan item barcode or enter manually and click *Submit*.
63
64 image::media/checkin_barcode_web_client.png[]
65  
66 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.
67
68 image::media/overdue_checkin_web_client.png[]
69
70 Backdated check in
71 ^^^^^^^^^^^^^^^^^^
72
73 This is useful for clearing a book drop.
74
75 1) To change effective check-in date, select *Circulation* -> *Check In Items*. In *Effective Date* field enter the date in yyyy-mm-dd format.
76
77 image::media/backdate_checkin_web_client.png[]
78
79 2) The new effective date is now displayed in the red bar above the Barcode field.
80
81 image::media/backdate_red_web_client.png[]
82
83 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.
84  
85 Backdate Post-Checkin
86 ^^^^^^^^^^^^^^^^^^^^^
87
88 After an item has been checked in, you may use the Backdate Post-Checkin function to backdate the check-in date.
89
90 1) Select the item on the Check In screen, click *Actions* -> *Backdate Post-Checkin*.
91
92 image::media/backdate_post_checkin_web_client.png[]
93
94 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.
95
96 image::media/backdate_post_date_web_client.png[]
97
98 [TIP]
99 Checkin Modifiers
100 ===================================================
101 At the right bottom corner there is a *Checkin Modifiers* pop-up list. The options are:
102
103 -Ignore Pre-cat Items: no prompt when checking in a pre-cat item. Item will be routed to Cataloguing with Cataloguing status.
104
105 -Supress Holds and Transit: item will not be used to fill holds or sent in transit. Item has Reshelving status.
106
107 -Amnesty Mode/Forgive Fines: overdue fines will be voided if already created or not be inserted if not yet created (e.g. hourly loans).
108
109 -Auto-Print Hold and Transit Slips: slips will be automatically printed without prompt for confirmation.
110
111 -Clear Holds Shelf. Checking in hold-shelf-expired items will clear the items from the hold shelf (holds to be cancelled).
112
113 -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.
114
115 -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.
116
117 -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.
118
119
120 These options may be selected simultaneously. The selected option is displayed in the header area.
121
122 image::media/checkin_options_web_client.png[]
123
124 ====================================================
125   
126 Renewal and Editing the Item's Due Date
127 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
128
129 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.
130
131 Renewing via a Patron's Account
132 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
133
134 1) Retrieve the patron record and go to the *Items Out* screen.
135
136 image::media/items_out_click_web_client.png[]
137
138 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.
139
140 image::media/renew_action_web_client.png[]
141
142 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*.
143
144 image::media/renew_specific_date_web_client.png[]
145  
146
147 Renewing by Item Barcode
148 ^^^^^^^^^^^^^^^^^^^^^^^^
149 1) To renew items by barcode, select *Circulation* -> *Renew Items*.
150
151 2) Scan or manually entire the item barcode.
152
153 image::media/renew_item_web_client.png[]
154
155 3) If you want to specify the due date, click *Specific Due Date* and enter a new due date in yyyy-mm-dd format.
156
157 image::media/renew_item_calendar_web_client.png[]
158
159 Editing Due Date
160 ^^^^^^^^^^^^^^^^
161
162 1) Retrieve the patron record and go to the *Items Out* screen.
163
164 2) Select the item you want to renew. Click on *Actions* -> *Edit Due Date*.
165
166 image::media/edit_due_date_action_web_client.png[]
167
168 3) Enter a new due date in yyyy-mm-dd format in the pop-up window, then click *OK*.
169
170 [NOTE]
171 Editing a due date is not included in the renewal count.
172
173 Marking Items Lost and Claimed Returned
174 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
175
176 Lost Items
177 ^^^^^^^^^^
178 1) To mark items Lost, retrieve patron record and click *Items Out*.
179
180 2) Select the item. Click on *Actions* -> *Mark Lost (by Patron)*.
181
182 image::media/mark_lost_web_client.png[]
183
184 3) The lost item now displays as lost in the *Items Checked Out* section of the patron record.
185
186 image::media/lost_section_web_client.png[]
187
188 4) The lost item also adds to the count of *Lost* items in the patron summary on the left (or top) of the screen. 
189
190 image::media/patron_summary_checkouts_web_client.png[]
191
192 [NOTE]
193 Lost Item Billing
194 ========================
195 - 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.
196 - 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. 
197 - 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.
198 ==========================
199
200 Refunds for Lost Items
201 ^^^^^^^^^^^^^^^^^^^^^^^
202
203 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.
204
205 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.
206
207 Claimed Returned Items
208 ^^^^^^^^^^^^^^^^^^^^^^^
209
210 1) To mark an item Claimed Returned, retrieve the patron record and go to the *Items Out* screen.
211
212 2) Select the item, then select *Actions* -> *Mark Claimed Returned* from the dropdown menu.
213
214 image::media/mark_claims_returned_web_client.png[]
215
216 3) Enter date in yyyy-mm-dd format and click *Submit*.
217
218 image::media/claimed_date_web_client.png[]
219
220 4) The Claimed Returned item now displays in the *Other/Special Circulations* section of the patron record.
221
222 image::media/cr_section_web_client.png[]
223
224 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. 
225
226 image::media/patron_summary_checkouts_web_client.png[]
227
228 [NOTE]
229 More on Claimed Returned Items
230 ====================================
231 - The date entered for a Claimed Returned item establishes the fine. If the date given has passed, bills will be adjusted accordingly.
232 - 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.
233 - 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.
234 ====================================
235
236 In-house Use
237 ~~~~~~~~~~~~
238 1) To record in-house use, select *Circulation* -> *Record In-House Use*.
239
240 image::media/record_in_house_action_web_client.png[]
241  
242 2) To record in-house use for cataloged items, enter number of uses, scan barcode or type barcode and click *Submit*.
243
244 image::media/in_house_use_web_client.png[]
245
246 [NOTE] 
247 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.
248
249 [[itemstatus_web_client]]
250 Item Status
251 ~~~~~~~~~~~
252
253 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.
254
255 Checking item status
256 ^^^^^^^^^^^^^^^^^^^^
257
258 1) To check the status of an item, select *Search* -> *Search for copies by Barcode*.
259
260 image::media/item_status_menu_web_client.png[]
261
262 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.
263
264 image::media/item_status_barcode_web_client.png[]
265
266 3) Click the *Detail View* button and the item summary and circulation history will be displayed.
267
268 image::media/item_status_altview_web_client.png[]
269
270 4) Click *List View* to go back.
271
272 image::media/item_status_list_view_web_client.png[]
273
274 [NOTE]
275 If the item's status is "Available", the displayed due date refers to the previous circulation's due date.
276
277 [TIP]
278 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.
279
280 Viewing past circulations
281 ^^^^^^^^^^^^^^^^^^^^^^^^^^
282 1) To view past circulations, retrieve the item on the *Item Status* screen as described above.
283
284 2) Select *Detail view*.
285
286 image::media/last_few_circs_action_web_client.png[]
287
288 3) Choose *Recent Circ History*.  The item’s recent circulation history is displayed.
289
290 image::media/last_few_circs_display_web_client.png[]
291
292 4) To retrieve the patron(s) of the last circulations, click on the name of the patron.  The patron record will be displayed.
293
294 [TIP]
295 The number of items that displays in the circulation history can be set in Local *Administration* -> *Library Settings Editor*.
296
297 [NOTE]
298 You can also retrieve the past circulations on the patron's Items Out screen and from the Check In screen.
299
300 Marking items damaged or missing and other functions
301 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
302 1) To mark items damaged or missing, retrieve the item on the *Item Status* screen.
303
304 2) Select the item. Click on *Actions for Selected Items* -> *Mark Item Damaged* or *Mark Item Missing*.
305
306 image::media/mark_missing_damaged_web_client.png[]
307
308 [NOTE]
309 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. 
310
311 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.
312
313 Item alerts
314 ^^^^^^^^^^^
315
316 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.
317 1) Retrieve record on *Item Status* screen.
318
319 2) Once item is displayed, highlight it and select *Actions for Selected Items* -> *Edit Item Attributes*.
320
321 3) The item record is displayed in the *Copy Editor*.
322
323 image::media/copy_edit_alert_web_client.png[]
324
325 4) Click *Alert Message* in the *Miscellaneous* column. The background color of the box changes. Type in the message then click *Apply*. 
326
327 image::media/copy_alert_message_web_client.png[]
328
329 5) Click *Modify Copies*, then confirm the action.
330
331
332 Mark an Item Long Overdue
333 ~~~~~~~~~~~~~~~~~~~~~~~~~
334
335 *Marking an item Long Overdue*
336
337 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:
338
339 . The item will go into the status of “Long Overdue” 
340
341 . The item will be moved to the “Lost, Claimed Returned, Long Overdue, Has Unpaid Billings” section of the Items Out screen in the patron’s account
342
343 . The accrual of overdue fines will be stopped
344
345 Optionally the patron can be billed for the item price, a long overdue processing fee, and any overdue fines can be voided from the account.  Patrons can also be sent a notification that the item was marked long overdue.
346  
347 image::media/long_overdue1.JPG[Patron Account-Long Overdue]
348
349
350 *Checking in a Long Overdue item*
351
352 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.
353  
354 image::media/long_overdue2.JPG[Long Overdue Checkin]
355  
356 *Notification/Action Triggers*
357
358 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.
359
360 * Sample Triggers
361
362 ** 6 Month Auto Mark Long-Overdue—will mark an item long overdue after the configured period of time
363
364 ** 6 Month Long Overdue Notice—will send patron notification that an item has been marked long overdue on their account
365
366 *Library Settings* 
367
368 The following Library Settings enable you to set preferences related to long overdue items:
369
370 * *Circulation: Long-Overdue Check-In Interval Uses Last Activity Date* —Use the long-overdue last-activity date instead of the due_date to determine whether the item has been checked out too long to perform long-overdue check-in processing. If set, the system will first check the last payment time, followed by the last billing time, followed by the due date. See also circ.max_accept_return_of_longoverdue 
371
372 * *Circulation: Long-Overdue Items Usable on Checkin* —Long-overdue items are usable on checkin instead of going "home" first
373
374 * *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 
375
376 * *Circulation: Restore Overdues on Long-Overdue Item Return*
377
378 * *Circulation: Void Long-Overdue item Billing When Returned*
379
380 * *Circulation: Void Processing Fee on Long-Overdue Item Return*
381
382 * *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
383
384 * *Finances: Long-Overdue Materials Processing Fee*
385
386 * *Finances: Void Overdue Fines When Items are Marked Long-Overdue*
387
388 *Permissions to use this Feature*
389
390 The following permissions are related to this feature:
391
392 * COPY_STATUS_LONGOVERDUE.override
393
394 ** Allows the user to check-in long-overdue items thus removing the long-overdue status on the item
395
396
397