Docs reorg: adding a circulation manual
[working/Evergreen.git] / docs / circulation / circulation_patron_records_web_client.adoc
1 Circulation - Patron Record 
2 ---------------------------
3
4 [[searching_patrons]] 
5 Searching Patrons 
6 ~~~~~~~~~~~~~~~~~
7
8 indexterm:[patrons, searching for]
9
10 To search for a patron, select _Search -> Search for Patrons_ from the menu bar.
11
12 The Patron Search screen will display. It will contain options to search on the 
13 following fields:
14
15 * Last Name 
16 * First Name 
17 * Middle Name 
18
19 image::media/circulation_patron_records-1a_web_client.png[circulation_patron_records 1a]
20
21
22 Next to the _Clear Form_ button there is a button with an arrow pointing down that will display the following additional search fields:
23    
24 * Barcode 
25 * Alias 
26 * Username
27 * Email 
28 * Identification
29 * database ID
30 * Phone
31 * Street 1 
32 * Street 2 
33 * City 
34 * State 
35 * Postal Code
36 * Profile Group
37 * Home Library 
38
39 You patrons searches may also include patrons marked ``inactive'' if you click on the _Include Inactive?_ checkbox.
40
41
42 image::media/circulation_patron_records-1b_web_client.png[circulation_patron_records 1b]
43
44 .Tips for searching 
45 [TIP] 
46 =================== 
47 * Search one field or combine fields for more precise results.  
48 * Truncate search terms for more search results.
49 ===================
50
51 Once you have located the desired patron, click on the entry row for this patron in
52 the results screen.  A summary for this patron will display on the left hand side.  
53
54 image::media/circulation_patron_records-2_web_client.png[circulation_patron_records 2]
55
56 The _Patron Search_ button on the upper right may be used to resume searching for patrons.
57
58 Registering New Patrons 
59 ~~~~~~~~~~~~~~~~~~~~~~~
60
61 indexterm:[patrons, registering]
62
63 To register a new patron, select _Circulation -> Register Patron_ from the menu bar. The Patron
64 Registration form will display. 
65
66 image::media/circulation_patron_records-4.png[Patron registration form]
67
68 Mandatory fields display in yellow.
69
70 image::media/circulation_patron_records-5.png[circulation_patron_records 5]
71
72 The _Show Only Required Fields_ and _Show Suggested Fields_ may be used to limit
73 the options on this page.
74
75 image::media/circulation_patron_records-6.png[circulation_patron_records 6]
76
77 When one of these options is selected, it is possible switch to the other
78 limited view or to revert to the original view by selecting _Show All Fields_. 
79
80 image::media/circulation_patron_records-7.png[circulation_patron_records 7]
81
82 When finished entering the necessary information, select _Save_ to save the new
83 patron record or _Save & Clone_ to register a patron with the same address.
84 When _Save & Clone_ is selected, the address information is copied into the
85 resulting patron registration screen.  It is linked to the original patron.
86 Address information may only be edited through the original record.
87
88 image::media/circulation_patron_records-8.png[circulation_patron_records 8]
89
90 [TIP]
91 ============================================================================
92 * Requested fields may be configured in the _Library Settings Editor_ (_Admin ->
93  Local Admin -> Library Settings Editor_).  
94 * Statistical categories may be created for information tracked by your library 
95 that is not in the default patron record.  
96 * These may be configured in the _Statistical Categories Editor_ (_Admin -> 
97 Local Admin -> Statistical Categories Editor_).  
98 * Staff accounts may also function as patron accounts.
99 * You must select a _Main (Profile) Permission Group_ before the _Update Expire
100 Date_ button will work, since the permission group determines the expiration date.
101 ============================================================================
102
103
104 Patron Self-Registration
105 ~~~~~~~~~~~~~~~~~~~~~~~~
106 *Abstract*
107
108 Patron Self-Registration allows patrons to initiate registration for a library account through the OPAC.  Patrons can fill out a web-based form with basic information that will be stored as a “pending patron” in Evergreen.  Library staff can review pending patrons in the staff-client and use the pre-loaded account information to create a full patron account.  Pending patron accounts that are not approved within a configurable amount of time will be automatically deleted.  
109
110 *Patron Self-Registration*
111
112 . In the OPAC, click on the link to *Request Library Card*
113
114 . Fill out the self-registration form to request a library card, and click *Submit Registration*.
115
116 . Patrons will see a confirmation message: “Registration successful!  Please see library staff to complete your registration.”
117
118 image::media/patron_self_registration2.jpg[Patron Self-Registration form]
119
120 *Managing Pending Patrons*
121
122 . In the staff client select *Circulation* -> *Pending Patrons*.
123
124 . Select the patron you would like to review.  In this screen you have the option to *Load* the pending patron information to create a permanent library account.
125
126 . To create a permanent library account for the patron, click on the patron’s row, click on the *Load Patron* button at the top of the screen.  This will load the patron self-registration information into the main *Patron Registration* form. 
127
128 . Fill in the necessary patron information for your library, and click *Save* to create the permanent patron account.
129
130
131 [[updating_patron_information]] 
132 Updating Patron Information
133 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
134
135 indexterm:[patrons, updating]
136
137 Retrieve the patron record as described in the section
138 <<searching_patrons,Searching Patrons>>.
139
140 Click on _Edit_ from the options that display at the top of the patron record. 
141
142 image::media/circulation_patron_records-9_web_client.png[Patron edit with summary display]
143
144 Edit information as required.  When finished, select _Save_.  
145
146 After selecting _Save_, the page will refresh.  The edited information will be
147 reflected in the patron summary pane.
148
149 [TIP]
150 =======
151 * To quickly renew an expired patron, click the _Update Expire Date_ button.
152 You will need a _Main (Profile) Permission Group_ selected for this to work,
153 since the permission group determines the expiration date.
154 =======
155
156
157 Renewing Library Cards 
158 ~~~~~~~~~~~~~~~~~~~~~~
159
160 indexterm:[library cards, renewing]
161
162 Expired patron accounts when initially retrieved – an alert
163 stating that the ``Patron account is EXPIRED.''
164
165 image::media/circulation_patron_records-11_web_client.png[circulation_patron_records 11]
166
167 Open the patron record in edit mode as described in the section
168 <<updating_patron_information,Updating Patron Information>>.
169
170 Navigate to the information field labeled _Privilege Expiration Date_.  Enter a
171 new date in this box.  When you place your cursor in the _Patron Expiration Date
172 box_, a calendar widget will display to help you easily navigate to the desired
173 date. 
174
175 image::media/circulation_patron_records-12.png[circulation_patron_records 12]
176
177 Select the date using the calendar widget or key the date in manually.  Click
178 the _Save_ button.  The screen will refresh and the ``expired'' alerts on the
179 account will be removed. 
180
181
182 Lost Library Cards 
183 ~~~~~~~~~~~~~~~~~~
184
185 indexterm:[library cards, replacing]
186
187 Retrieve the patron record as described in the section
188 <<searching_patrons,Searching Patrons>>. 
189
190 Open the patron record in edit mode as described in the section
191 <<updating_patron_information,Updating Patron Information>>.
192  
193 Next to the _Barcode_ field, select the _Replace Barcode_ button.
194
195 image::media/circulation_patron_records-13.png[circulation_patron_records 13]
196
197 This will clear the barcode field.  Enter a new barcode and _Save_ the record.
198 The screen will refresh and the new barcode will display in the patron summary
199 pane.  
200
201 If a patron’s barcode is mistakenly replaced, the old barcode may be reinstated.
202 Retrieve the patron record as described in the section
203 <<searching_patrons,Searching Patrons>>. Open the patron record in
204 edit mode as described in the section <<updating_patron_information,Updating Patron Information>>.
205
206 Select the _See All_ button next to the _Replace Barcode_ button.  This will
207 display the current and past barcodes associated with this account. 
208
209 image::media/circulation_patron_records-14.png[circulation_patron_records 14]
210
211 Check the box(es) for all barcodes that should be ``active'' for the patron.  An
212 ``active'' barcode may be used for circulation transactions.  A patron may have
213 more than one ``active'' barcode.  Only one barcode may be designated
214 ``primary.'' The ``primary'' barcode displays in the patron’s summary
215 information in the _Library Card_ field. 
216
217 Once you have modified the patron barcode(s), _Save_ the patron record.  If you
218 modified the ``primary'' barcode, the new primary barcode will display in the
219 patron summary screen. 
220
221 Resetting Patron's Password 
222 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
223
224 indexterm:[patrons, passwords]
225
226 A patron’s password may be reset from the OPAC or through the staff client.  To
227 reset the password from the staff client, retrieve the patron record as
228 described in the section <<searching_patrons,Searching Patrons>>. 
229
230 Open the patron record in edit mode as described in the section
231 <<updating_patron_information,Updating Patron Information>>.
232
233 Select the _Reset Password_ button next to the _Password_ field.  
234
235 image::media/circulation_patron_records-15.png[circulation_patron_records 15]
236
237 NOTE: The existing password is not displayed in patron records for security
238 reasons.
239
240 A new number will populate the _Password_ and _Verify Password_ text boxes.
241 Make note of the new password and _Save_ the patron record.  The screen will
242 refresh and the new password will be suppressed from view.   
243
244
245 [TIP]
246 =======================
247 If you need to change a patron or staff account password without using the staff client, here is how you can reset it with SQL.
248
249 Connect to your Evergreen database using _psql_ or similar tool, and retreive and verify your admin username:
250
251 [source, sql]
252 ------------------------------------------------------------------------------
253 psql -U <user-name> -h <hostname> -d <database>
254
255 SELECT id, usrname, passwd from actor.usr where usrname = 'admin';
256 ------------------------------------------------------------------------------
257
258 If you do not remember the username that you set, search for it in the _actor.usr_ table, and then reset the password.
259
260 [source, sql]
261 ------------------------------------------------------------------------------
262 UPDATE actor.usr SET passwd = <password> WHERE id=<id of row to be updated>;
263 ------------------------------------------------------------------------------
264
265 The new password will automatically be hashed. 
266
267 =======================
268
269
270 Barring a Patron 
271 ~~~~~~~~~~~~~~~~
272
273 indexterm:[patrons, barring]
274
275 A patron may be barred from circulation activities.  To bar a patron, retrieve
276 the patron record as described in the section
277 <<searching_patrons,Searching Patrons>>. 
278
279 Open the patron record in edit mode as described in the section 
280 <<updating_patron_information,Updating Patron Information>>.
281
282 Check the box for _Barred_ in the patron account. 
283
284 image::media/circulation_patron_records-16.png[circulation_patron_records 16]
285
286 _Save_ the user.  The screen will refresh.  
287
288 NOTE: Barring a patron from one library bars that patron from all consortium
289 member libraries. 
290
291 To unbar a patron, uncheck the Barred checkbox.
292
293
294 Barred vs. Blocked 
295 ~~~~~~~~~~~~~~~~~~
296
297 indexterm:[patrons, barring]
298
299 *Barred*: Stops patrons from using their library cards; alerts the staff that
300 the patron is banned/barred from the library. The ``check-out'' functionality is
301 disabled for barred patrons (NO option to override – the checkout window is
302 unusable and the bar must be removed from the account before the patron is able
303 to checkout items).  These patrons may still log in to the OPAC to view their
304 accounts.
305
306 indexterm:[patrons, blocking]
307
308 *Blocked*: Often, these are system-generated blocks on patron accounts.  
309
310 Some examples:
311
312 * Patron exceeds fine threshold 
313 * Patron exceeds max checked out item threshold
314
315 A notice appears when a staff person tries to checkout an item to blocked
316 patrons, but staff may be given permissions to override blocks.
317
318
319 Staff-Generated Messages
320 ~~~~~~~~~~~~~~~~~~~~~~~~
321
322 [[staff_generated_messages]]
323 indexterm:[patrons, messages]
324
325 There are several types of messages available for staff to leave notes on patron records.
326
327 *Patron Notes*: These notes are added via _Other_ -> _Notes_ in the patron record. These notes can be viewable by staff only or shared with the patron. Staff initials can be required. (See the section <<circulation_patron_notes,Patron Notes>> for more.)
328
329 *Patron Alerts*: This type of alert is added via _Edit_ button in the patron record. There is currently no way to require staff initials for this type of alert. (See the section <<circulation_patron_alerts,Patron Alerts>> for more.)
330
331 *Staff-Generated Penalties/Messages*: These messages are added via the _Messages_ button in the patron record. They can be a note, alert or block. Staff initials can be required. (See the section <<staff_generated_penalties_web_client,Staff-Generated Penalties/Messages>> for more.)
332
333 Patron Alerts 
334 ~~~~~~~~~~~~~~
335
336 [[circulation_patron_alerts]]
337 indexterm:[patrons, Alerts]
338     
339 When an account has an alert on it, a Stop sign is displayed when the record is
340 retrieved.
341
342 image::media/circulation_patron_records-18_web_client.png[circulation_patron_records 18]
343
344 Navigating to an area of the patron record using the navigation buttons at the
345 top of the record (for example, Edit or Bills) will clear the message from view.
346
347 If you wish to view these alerts after they are cleared from view, they may be
348 retrieved.  Use the Other menu to select _Display Alert_ and _Messages_.
349
350 image::media/circulation_patron_records-19_web_client.png[circulation_patron_records 19]
351
352 There are two types of Patron Alerts:
353
354 *System-generated alerts*: Once the cause is resolved (e.g. patron's account has
355 been renewed), the message will disappear automatically.
356
357 *Staff-generated alerts*: Must be added and removed manually. 
358
359 To add an alert to a patron account, retrieve the patron record as described 
360 in the section <<searching_patrons,Searching Patrons>>. 
361
362 Open the patron record in edit mode as described in the section 
363 <<updating_patron_information,Updating Patron Information>>.
364
365 Enter the alert text in the Alert Message field.
366
367 image::media/circulation_patron_records-20.png[circulation_patron_records 20]
368
369 _Save_ the record. The screen will refresh and the alert will display.
370
371 To remove the alert, retrieve the patron record as described in the section
372 <<searching_patrons,Searching Patrons>>. 
373
374 Open the patron record in edit mode as described in the section 
375 <<updating_patron_information,Updating Patron Information>>.
376
377 Delete the alert text in the _Alert Message_ field. 
378
379 _Save_ the record.  
380
381 The screen will refresh and the indicators for the alert will be removed from 
382 the account. 
383
384 Patron Notes 
385 ~~~~~~~~~~~~
386
387 [[circulation_patron_notes]]
388 indexterm:[patrons, Notes]
389
390 Notes are strictly communicative and may be made visible to the patron via their
391 account on the OPAC.  In the OPAC, these notes display on the account summary
392 screen in the OPAC.
393
394 image::media/circulation_patron_records-23_web_client.png[circulation_patron_records 23]
395
396 To insert or remove a note, retrieve the patron record as described in the
397 section  <<searching_patrons,Searching Patrons>>. 
398
399 Open the patron record in edit mode as described in the section
400 <<updating_patron_information,Updating Patron Information>>.
401
402 Use the Other menu to navigate to _Notes_.
403
404 image::media/circulation_patron_records-24_web_client.png[circulation_patron_records 24]
405
406 Select the _Add New Note_ button. A _Create a new note_ window displays.  
407
408 [TIP] 
409 ================================================ 
410 Your system administrator can add a box in the _Add Note_ window for staff initials and
411 require those initials to be entered.  They can do so using the "Require staff initials..."
412 settings in the Library Settings Editor.
413 ================================================ 
414
415 Enter note information. 
416
417 Select the check box for _Patron Visible_ to display the note in the OPAC. 
418
419 image::media/circulation_patron_records-25_web_client.png[circulation_patron_records 25]
420
421 Select _OK_ to save the note to the patron account.  
422
423 To delete a note, go to _Other -> Notes_ and use the _Delete_ button
424 on the right of each note.
425
426 image::media/circulation_patron_records-26_web_client.png[circulation_patron_records 26]
427
428 Staff-Generated Penalties/Messages
429 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
430
431 [[staff_generated_penalties_web_client]]
432 To access this feature, use the _Messages_ button in the patron record.
433
434 image::media/staff-penalties-1_web_client.png[Messages screen]
435
436 Add a Message
437 ^^^^^^^^^^^^^
438
439 Click *Apply Penalty/Message* to begin the process of adding a message to the patron.
440
441 image::media/staff-penalties-2_web_client.png[Apply Penalty Dialog Box]
442
443 There are three options: Notes, Alerts, Blocks
444
445 * *Note*: This will create a non-blocking, non-alerting note visible to staff. Staff can view the message by clicking the _Messages_ button on the patron record.  (Notes created in this fashion will not display via _Other_ -> _Notes_, and cannot be shared with the patron. See the <<circulation_patron_notes,Patron Notes>> section for notes which can be shared with the patron.)
446
447 * *Alert*: This will create a non-blocking alert which appears when the patron record is first retrieved.  The alert will cause the patron name to display in red, rather than black, text. Alerts may be viewed by clicking the _Messages_ button on the patron record or by selecting _Other_ -> _Display Alerts and Messages_.
448
449 * *Block*: This will create a blocking alert which appears when the patron record is first retrieved, and which behaves much as the non-blocking alert described previously. The patron will be also blocked from circulation, holds and renewals until the block is cleared by staff.
450
451 After selecting the type of message to create, enter the message body into the box. If Staff Initials are required, they must be entered into the _Initials_ box before the message can be added.  Otherwise, fill in the optional _Initials_ box and click *OK*
452
453 The message should now be visible in the _Staff-Generated Penalties/Messages_ list. If a blocking or non-blocking alert, the message will also display immediately when the patron record is retrieved.
454
455 image::media/staff-penalties-3_web_client.png[[Messages on a record]
456
457 Modify a Message
458 ^^^^^^^^^^^^^^^^
459
460 Messages can be edited by staff after they are created. 
461
462 image::media/staff-penalties-4_web_client.png[[Actions menu]
463
464 Click to select the message to be modified, then click _Actions_ -> _Modify Penalty/Message_. This menu can also be accessed by right-clicking in the message area.
465
466 image::media/staff-penalties-5_web_client.png[Modify penalty dialog box]
467
468 To change the type of message, click on *Note*, *Alert*, *Block* to select the new type. Edit or add new text in the message body.  Enter Staff Initials into the _Initials_ box (may be required.) and click *OK* to submit the alterations.
469
470 image::media/staff-penalties-6_web_client.png[Modified message in the list]
471
472 Archive a Message
473 ^^^^^^^^^^^^^^^^^
474
475 Messages which are no longer current can be archived by staff. This action will remove any alerts or blocks associated with the message, but retains the information contained there for future reference.
476
477 image::media/staff-penalties-4_web_client.png[[Actions menu]
478
479 Click to select the message to be archived, then click _Actions_ -> _Archive Penalty/Message_. This menu can also be accessed by right-clicking in the message area.
480
481 image::media/staff-penalties-7_web_client.png[Archived messages]
482
483 Archived messages will be shown in the section labelled _Archived Penalties/Messages_. To view messages, click *Retrieve Archived Penalties*. By default, messages archived within the past year will be retrieved. To retrieve messages from earlier dates, change the start date to the desired date before clicking *Retrieve Archived Penalties*.
484
485 Remove a Message
486 ^^^^^^^^^^^^^^^^
487
488 Messages which are no longer current can be removed by staff.  This action removes any alerts or blocks associated with the message and deletes the information from the system.
489
490 image::media/staff-penalties-4_web_client.png[[Actions menu]
491
492 Click to select the message to be removed, then click _Actions_ -> _Remove Penalty/Message_. This menu can also be accessed by right-clicking in the message area.
493
494