Documentation: Fix various issues causing errors during processing.
[working/Evergreen.git] / docs / circulation / circulation_patron_records.txt
1 Circulation - Patron Record
2 ---------------------------
3
4 [[circulation_searching_patrons]]
5 Searching Patrons
6 ~~~~~~~~~~~~~~~~~
7
8 indexterm:[patrons, searching for]
9
10 To search for a patron, select the Patron Search option from the toolbar, _Search -> Search for Patrons_ from the menu bar, or *F4*.
11
12 The Patron Search screen will display.  The orientation of the search pane may be vertical or horizontal, depending on your library’s configuration.  It will contain options to search on the following fields:
13
14 * Last Name
15 * First Name
16 * Middle Name
17 * Alias
18 * Address 1
19 * Address 2
20 * City
21 * Zip
22 * Phone
23 * Email
24 * State
25 * Barcode
26 * OPAC Login
27 * ID
28
29 Use the options above the search fields to include patrons marked ``inactive'' in your search results or to limit results to patrons in a specific library branch or in a specific permission group.
30
31 image::media/circulation_patron_records-1.png[circulation_patron_records 1]
32
33 .Tips for searching
34 [TIP]
35 =================== 
36 * Search one field or combine fields for more precise results.
37 * Truncate search terms for more search results.
38 ===================
39
40 Once you have located the desired patron, highlight the entry for this patron in the results screen.  A summary for this patron will display in place of the search fields.  
41
42 image::media/circulation_patron_records-2.png[circulation_patron_records 2]
43
44 Use the _Retrieve Patron_ button to retrieve the patron for circulation or editing.
45
46 image::media/circulation_patron_records-3.png[circulation_patron_records 3]
47
48 The _Search Form_ button may be used to resume searching for patrons.
49
50 Registering New Patrons
51 ~~~~~~~~~~~~~~~~~~~~~~~
52
53 indexterm:[patrons, registering]
54
55 To register a new patron, select _Patron Registration_ from the toolbar, _Circulation -> Register Patron_ from the menu bar, or *shift + F1*. The Patron Registration form will display. 
56
57 image::media/circulation_patron_records-4.png[circulation_patron_records 4]
58
59 Mandatory fields display in yellow.
60
61 image::media/circulation_patron_records-5.png[circulation_patron_records 5]
62
63 The _Show Only Required Fields_ and _Show Suggested Fields_ may be used to limit the options on this page.
64
65 image::media/circulation_patron_records-6.png[circulation_patron_records 6]
66
67 When one of these options is selected, it is possible switch to the other limited view or to revert to the original view by selecting _Show All Fields_. 
68
69 image::media/circulation_patron_records-7.png[circulation_patron_records 7]
70
71 When finished entering the necessary information, select _Save_ to save the new patron record or _Save & Clone_ to register a patron with the same address.  When _Save & Clone_ is selected, the address information is copied into the resulting patron registration screen.  It is linked to the original patron.  Address information may only be edited through the original record.
72
73 image::media/circulation_patron_records-8.png[circulation_patron_records 8]
74
75 [TIP]
76 ================================================================================
77 * Requested fields may be configured in the _Library Settings Editor_ (_Admin ->
78 * Local Admin -> Library Settings Editor_).  
79 * Statistical categories may be created for information tracked by your library
80 * that is not in the default patron record.  These may be configured in the
81 * _Statistical Categories Editor_ (_Admin -> Local Admin -> Statistical Categories Editor_).  
82 * Staff accounts may also function as patron accounts.
83 ===========================================================================================
84
85 [[updating_patron_information]]
86 Updating Patron Information
87 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
88
89 indexterm:[patrons, updating]
90
91 Retrieve the patron record as described in the section <<circulation_searching_patrons,Searching Patrons>>.
92
93 Select _Edit_ from the options that display at the top of the patron record. 
94
95 image::media/circulation_patron_records-9.png[circulation_patron_records 9]
96
97 Edit information as required.  When finished, select _Save_.  If you attempt to close out of the patron account before the information is received, an alert will display.
98
99 image::media/circulation_patron_records-10.png[circulation_patron_records 10]
100
101 Select _OK_ to continue or _Cancel_ to return to the editing form.
102
103 After selecting _Save_, the page will refresh.  The edited information will be reflected in the patron summary pane.
104
105 NOTE: If collapsed, you will need to manually ``un-collapse'' this pane. 
106
107 Renewing Library Cards
108 ~~~~~~~~~~~~~~~~~~~~~~
109
110 indexterm:[library cards, renewing]
111
112 Expired patron accounts display with a black box around the patron’s name, a note that the patron is expired, and – when initially retrieved – an alert stating that the ``Patron account is EXPIRED.''
113
114 image::media/circulation_patron_records-11.png[circulation_patron_records 11]
115
116 Open the patron record in edit mode as described in the section <<updating_patron_information,Updating Patron Information>>.
117
118 Navigate to the information field labeled _Privilege Expiration Date_. 
119 Enter a new date in this box.  When you place your cursor in the _Patron Expiration Date box_, a calendar widget will display to help you easily navigate to the desired date. 
120
121 image::media/circulation_patron_records-12.png[circulation_patron_records 12]
122
123 Select the date using the calendar widget or key the date in manually.  Click the _Save_ button.  The screen will refresh and the ``expired'' alerts on the account will be removed. 
124
125 Lost Library Cards
126 ~~~~~~~~~~~~~~~~~~
127
128 indexterm:[library cards, replacing]
129
130 Retrieve the patron record as described in the section <<circulation_searching_patrons,Searching Patrons>>. 
131
132 Open the patron record in edit mode as described in the section <<updating_patron_information,Updating Patron Information>>.
133  
134 Next to the _Barcode_ field, select the _Replace Barcode_ button.
135
136 image::media/circulation_patron_records-13.png[circulation_patron_records 13]
137
138 This will clear the barcode field.  Enter a new barcode and _Save_ the record.  The screen will refresh and the new barcode will display in the patron summary pane.  
139
140 If a patron’s barcode is mistakenly replaced, the old barcode may be reinstated.  Retrieve the patron record as described in the section <<circulation_searching_patrons,Searching Patrons>>. Open the patron record in edit mode as described in the section <<updating_patron_information,Updating Patron Information>>.
141
142 Select the _See All_ button next to the _Replace Barcode_ button.  This will display the current and past barcodes associated with this account. 
143
144 image::media/circulation_patron_records-14.png[circulation_patron_records 14]
145
146 Check the box(es) for all barcodes that should be ``active'' for the patron.  An ``active'' barcode may be used for circulation transactions.  A patron may have more than one ``active'' barcode.  Only one barcode may be designated ``primary.'' The ``primary'' barcode displays in the patron’s summary information in the _Library Card_ field. 
147
148 Once you have modified the patron barcode(s), _Save_ the patron record.  If you modified the ``primary'' barcode, the new primary barcode will display in the patron summary screen. 
149
150 Resetting Patron's Password
151 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
152
153 indexterm:[patrons, passwords]
154
155 A patron’s password may be reset from the OPAC or through the staff client.  To reset the password from the staff client, retrieve the patron record as described in the section <<circulation_searching_patrons,Searching Patrons>>. 
156
157 Open the patron record in edit mode as described in the section <<updating_patron_information,Updating Patron Information>>.
158
159 Select the _Reset Password_ button next to the _Password_ field.  
160
161 image::media/circulation_patron_records-15.png[circulation_patron_records 15]
162
163 NOTE: The existing password is not displayed in patron records for security reasons.
164
165 A new number will populate the _Password_ and _Verify Password_ text boxes.  Make note of the new password and _Save_ the patron record.  The screen will refresh and the new password will be suppressed from view.   
166
167 Barring a Patron
168 ~~~~~~~~~~~~~~~~
169
170 indexterm:[patrons, barring]
171
172 A patron may be barred from circulation activities.  To bar a patron, retrieve the patron record as described in the section <<circulation_searching_patrons,Searching Patrons>>. Open the patron record in edit mode as described in the section <<updating_patron_information,Updating Patron Information>>.
173
174 Check the box for _Barred_ in the patron account. 
175
176 image::media/circulation_patron_records-16.png[circulation_patron_records 16]
177
178 _Save_ the user.  The screen will refresh.  The patron account will now display an alert stating that the patron account is *BARRED*.  Additionally a red box and note will indicate the patron’s barred status. 
179
180 image::media/circulation_patron_records-17.png[circulation_patron_records 17]
181
182 NOTE: Barring a patron from one library bars that patron from all consortium member libraries. 
183
184 To unbar a patron, uncheck the Barred checkbox.
185
186 Barred vs. Blocked
187 ~~~~~~~~~~~~~~~~~~
188
189 indexterm:[patrons, barring]
190
191 *Barred*: Stops patrons from using their library cards; alerts the staff that the patron is banned/barred from the library. The ``check-out'' functionality is disabled for barred patrons (NO option to override – the checkout window is unusable and the bar must be removed from the account before the patron is able to checkout items).  These patrons may still log in to the OPAC to view their accounts.
192
193 indexterm:[patrons, blocking]
194
195 *Blocked*: Often, these are system-generated blocks on patron accounts.  
196
197 Some examples:
198
199 * Patron exceeds fine threshold
200 * Patron exceeds max checked out item threshold
201
202 A notice appears when a staff person tries to checkout an item to blocked patrons, but staff may be given permissions to override blocks.
203
204 Patron Alerts
205 ~~~~~~~~~~~~~~
206
207 indexterm:[patrons, Alerts]
208     
209 When an account has an alert on it, a Stop sign is displayed when the record is retrieved.
210
211 image::media/circulation_patron_records-18.png[circulation_patron_records 18]
212
213 Navigating to an area of the patron record using the navigation buttons at the top of the record (for example, Edit or Bills) will clear the message from view.
214
215 If you wish to view these alerts after they are cleared from view, they may be retrieved.  Use the Other menu to select _Display Alert_ and _Messages_.
216
217 image::media/circulation_patron_records-19.png[circulation_patron_records 19]
218
219 There are two types of Patron Alerts:
220
221 *System-generated alerts*: Once the cause is resolved (e.g. patron's account has been renewed), the message will disappear automatically.
222
223 *Staff-generated alerts*: Must be added and removed manually. To add an alert to a patron account, retrieve the patron record as described in the section <<circulation_searching_patrons,Searching Patrons>>. Open the patron record in edit mode as described in the section <<updating_patron_information,Updating Patron Information>>.
224
225 Enter the alert text in the Alert Message field.
226
227 image::media/circulation_patron_records-20.png[circulation_patron_records 20]
228
229 _Save_ the record. The screen will refresh and the alert will display.  Additionally, the patron name will be highlighted in yellow and a note will indicate that there is an alert on the account. 
230
231 image::media/circulation_patron_records-21.png[circulation_patron_records 21]
232
233 To remove the alert, retrieve the patron record as described in the section <<circulation_searching_patrons,Searching Patrons>>. Open the patron record in edit mode as described in the section <<updating_patron_information,Updating Patron Information>>.
234
235 Delete the alert text in the _Alert Message_ field. _Save_ the record.  The screen will refresh and the indicators for the alert will be removed from the account. 
236
237 Patron Notes
238 ~~~~~~~~~~~~
239
240 indexterm:[patrons, notes]
241
242 When a patron account contains a note, a _See Notes_ message appears beneath the patron’s name in the patron summary pane. 
243
244 image::media/circulation_patron_records-22.png[circulation_patron_records 22]
245
246 Notes are strictly communicative and may be made visible to the patron via their account on the OPAC.  In the JSPAC, these notes display on the account summary screen in the OPAC.
247
248 image::media/circulation_patron_records-23.png[circulation_patron_records 23]
249
250 To insert or remove a note, retrieve the patron record as described in the section  <<circulation_searching_patrons,Searching Patrons>>. Open the patron record in edit mode as described in the section <<updating_patron_information,Updating Patron Information>>.
251
252 Use the Other menu to navigate to _Notes_.
253
254 image::media/circulation_patron_records-24.png[circulation_patron_records 24]
255
256 Select the _Add New Note_ button. An _Add Note_ window displays.  
257
258 Enter note information. 
259
260 Select the check box for _Patron Visible_ to display the note in the OPAC. 
261
262 image::media/circulation_patron_records-25.png[circulation_patron_records 25]
263
264 Select _Add Note_ to save the note to the patron account.  
265
266 To delete a note, go to _Other -> Notes_ and use the _Delete This Note_ button under each note.
267
268 image::media/circulation_patron_records-26.png[circulation_patron_records 26]
269
270 An alert will display.  Click _Yes_ to delete the note or No to retain the note.  A confirmation box will display; click _OK_.
271
272 Merging Patron Records
273 ~~~~~~~~~~~~~~~~~~~~~~
274
275 indexterm:[patrons, merging]
276
277 When patron records are erroneously duplicated, they may be merged into one record.  As described in the section <<circulation_searching_patrons,Searching Patrons>>, search for the term(s) shared by the two records. 
278
279 Select the two records to merge by pressing down the CTRL key and clicking each record. 
280
281 Click the _Merge Patrons_ button next to the _Search Form_ and _Retrieve Patron_ buttons on the top of the screen.
282
283 image::media/circulation_patron_records-27.png[circulation_patron_records 27]
284
285 A Record Merging window will display.  Compare the two records.  Select the record you want to keep by checking the radio button _Lead Record_ next to the appropriate record. 
286
287 image::media/circulation_patron_records-28.png[circulation_patron_records 28]
288
289 After making your selection, click the _Merge_ button.  The screen will refresh.  Only one of the two patron names will display.
290
291 NOTE: Once two records have been merged, the notes, bills, holds and outstanding items under the non-lead record are brought to the lead record. Staff-inserted alert messages are not transferred from the non-lead record; lead record alerts are retained.
292
293 Patron records may also be merged from the _Patron Group_ screen
294 Retrieve one of the two patron records you want to merge.  Go to _Other -> Group Member Details_.
295
296 image::media/circulation_patron_records-29.png[circulation_patron_records 29]
297
298 The patron records are displayed as group members. If both patron records are not already displayed on this screen, click _Choose an Action -> Move another patron to this patron group_.
299
300 image::media/circulation_patron_records-30.png[circulation_patron_records 30]
301
302 At the prompt, scan or type the patron's barcode. Click _OK_. Confirm the move by clicking the _Move_ button on top of the screen. 
303
304 image::media/circulation_patron_records-31.png[circulation_patron_records 31]
305
306 Click _OK_ on the confirmation pop-up window.
307
308 Both records are displayed as group members. 
309
310 Select both records by pressing *CTRL* key and clicking each record. 
311
312 Click _Choose an Action -> Merge Selected Patrons_. The merging records window pops up. 
313
314 Choose the lead record and continue to merge records as described in the above.
315
316 NOTE: The merged record will still show under group members. Both members point to the same patron record.
317
318 [[bills_and_payments]]
319 Bills and Payments
320 ~~~~~~~~~~~~~~~~~~
321
322 When a patron account has bills attached to it, a note displays under the patron name in the patron summary panel.  
323
324 image::media/circulation_patron_bills-1.png[circulation_patron_bills 1]
325
326 To view more information about the patron’s bills, or to make payments on or edit the bills, click on the Bills button from the patron account screen. 
327
328 image::media/circulation_patron_bills-2.png[circulation_patron_bills 2]
329
330
331 [[circ_vs_grocery]]
332 *Circulation bills*: system-generated (overdue fines, lost item cost, processing fees, etc.).
333
334 * Overdue fines are added daily once an item is overdue. 
335 * When an item is marked as lost, bills may be automatically generated to cover the item's cost and a processing fee, according to library policy.
336
337 *Grocery bills*: staff-applied to patron accounts.
338 * One default grocery bill, Misc, exists in an unmodified Evergreen installation.
339 * Additional grocery bills may be configured through the Admin settings.  Admin -> Server Administration -> Billing Types.
340
341 To view more information about a bill, highlight the bill and right-click or use the _Actions for Selected Transactions_ menu to select _Full Details_.
342
343 image::media/circulation_patron_bills-3.png[circulation_patron_bills 3]
344
345 A window will display additional information about the bill, including a record of any payments that have been made on the bill.
346
347 image::media/circulation_patron_bills-4.png[circulation_patron_bills 4] 
348
349 From the _Full Details_ screen, portions of the bill may be voided (e.g. an erroneous daily overdue charge) by using the _Void selected billings_ button.  Notes may be added to payments or line items by using the _Edit note_ button.
350
351 image::media/circulation_patron_bills-5.png[circulation_patron_bills 5]
352
353 [[making_payments]]
354 Making Payments
355 ^^^^^^^^^^^^^^^
356
357 To collect payments, retrieve the patron record.  Navigate to the _Bills_ screen as described in <<bills_and_payments,Bills and Payments>>.
358
359 When bills are paid, the money applied starts at the top of the list of bills. To pay specific bills, uncheck the bills that you do not wish to pay at this time. The amount displayed in _Total Checked:_ will change to reflect the appropriate amount.
360
361 image::media/circulation_patron_bills-6.png[circulation_patron_bills 6]
362
363 NOTE: the presence of the _Uncheck All_ and _Check All_ options below the list of bills.
364
365 image::media/circulation_patron_bills-7.png[circulation_patron_bills 7]
366
367 When you are ready to make a payment, select a payment type from the dropdown menu in the _Pay Bill_ portion of the screen.
368
369 image::media/circulation_patron_bills-8.png[circulation_patron_bills 8]
370
371 Enter the amount of payment in the _Payment received_ field.  If you would like to add a note to the payment, check the box for _Annotate Payment_.  Click _Apply Payment!_ to make the payment.  If you have selected _Annotate Payment_, a box will display for the annotation.  
372
373 The screen will refresh to display the updated bill information for the patron.  If change is due, the bottom portion of the screen, _Change Due Upon Payment:_ will briefly reflect the amount due to the patron.  
374
375 TIP: if you need more time to review the amount due, click outside the _Payment Received_ box before selecting _Apply Payment!_ This will cause the screen to refresh and display the amount due.
376
377 It is possible to convert change due to a patron credit by selecting the _Convert Change to Patron Credit_ checkbox.
378
379 image::media/circulation_patron_bills-9.png[circulation_patron_bills 9]
380
381 [TIP]
382 ================================================ 
383 * Items marked with red are still checked out. It is possible for a patron to pay a bill while the item is still out and accruing fines.
384 * When Check is selected as the payment type, it is not necessary to select _Annotate Payment_, as a box for the check number and a note displays automatically.
385 ================================================
386
387 Void vs. Forgive
388 ^^^^^^^^^^^^^^^^
389  
390 Void clears all history of the bill, while forgive retains the history. 
391
392 Forgiving Bills
393 ^^^^^^^^^^^^^^^
394  
395 Choose forgive as the payment type as described in the section <<making_payments,Making Payments>>. 
396
397 Enter the amount to be forgiven.  Choose _Annotate Payment_ as required by local policy.
398
399 Apply Payment.  Annotate, if prompted.
400
401 The screen will refresh to display the payment.
402
403
404 Voiding Bills
405 ^^^^^^^^^^^^^
406
407 Bills under one transaction are grouped in one bill line. Bills may be voided in part or in whole.
408
409 *To void the full billing amount:* 
410
411 Select the bill(s) to be voided from the list in the patron account.  
412
413 Right click or use the _Actions for Selected Transactions_ menu to select _Void All Billings_.
414
415 image::media/circulation_patron_bills-10.png[circulation_patron_bills 10]
416
417 Confirm the action.
418
419 *To void a partial amount:*
420
421 Select a billing and choose Full Details for the transaction, as described in the section <circ_vs_grocery,Circulation vs. Grocery Bills>>
422
423 The bill details screen displays.
424
425 Select the specific bill to void.
426
427 Void Selected Billings and confirm the action.
428
429 image::media/circulation_patron_bills-11.png[circulation_patron_bills 11]
430
431 Adding New ``Grocery'' Bills
432 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
433
434 A grocery bill can be added as a new bill or to an existing bill.
435
436 *To add a as a new bill:*
437
438 . Retrieve the patron record. 
439 . Navigate to the Bills screen. 
440 . Click the _Bill Patron_ button above the list of current bills.
441 +
442 image::media/circulation_patron_bills-12.png[circulation_patron_bills 12]
443 +
444 . Choose appropriate _Billing Type_ from the drop down menu. (``Grocery'' is the only available transaction type.)
445 . Enter the Amount and Note (as required).
446 . _Submit this Bill_ and confirm this action.
447
448 image::media/circulation_patron_bills-13.png[circulation_patron_bills 13]
449
450 *To add bill to an existing bill line:*
451
452 . Retrieve the patron record.
453 . Navigate to the Bills screen.
454 . Highlight the desired bill.
455 . Use the _Actions for Selected Transactions_ to select _Add Billing_.  Confirm this action.
456 . Follow steps 4 through 6 above.  There is no confirmation message after clicking _Submit this Bill_.
457 . The _Money Summary_ will adjust accordingly.
458
459 Bill History
460 ~~~~~~~~~~~~
461
462 *To view a patron’s bill history:*
463
464 . Retrieve the patron record.
465 . From the _Bills_ screen, click _History_.
466 . A _Bill History_ screen with two tabs will display.  One for _Transactions_ and one for _Payments_.
467 +
468 image::media/circulation_patron_bills-14.png[circulation_patron_bills 14]
469 +
470 . For more information about a specific billing, select the bill and click _Full Details_. A screen detailing item information, billings, and payments will display.
471
472 image::media/circulation_patron_bills-15.png[circulation_patron_bills 15]
473
474 Items may be deleted from the catalog even if a charge for that item is still attached to the patron's record.  The charge will remain on the patron's account after the deletion.
475
476
477