1e4e47ffecdb09511a459ee7e92f3d5fb5426c48
[working/Evergreen.git] / docs / circulation / circulation_patron_records_web_client.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 _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 <<circulation_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 <<circulation_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 <<circulation_searching_patrons,Searching Patrons>>. Open the patron record in
204 edit mode as described in the section <<updating_patron_information,Updating
205 Patron Information>>.
206
207 Select the _See All_ button next to the _Replace Barcode_ button.  This will
208 display the current and past barcodes associated with this account. 
209
210 image::media/circulation_patron_records-14.png[circulation_patron_records 14]
211
212 Check the box(es) for all barcodes that should be ``active'' for the patron.  An
213 ``active'' barcode may be used for circulation transactions.  A patron may have
214 more than one ``active'' barcode.  Only one barcode may be designated
215 ``primary.'' The ``primary'' barcode displays in the patron’s summary
216 information in the _Library Card_ field. 
217
218 Once you have modified the patron barcode(s), _Save_ the patron record.  If you
219 modified the ``primary'' barcode, the new primary barcode will display in the
220 patron summary screen. 
221
222 Resetting Patron's Password 
223 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
224
225 indexterm:[patrons, passwords]
226
227 A patron’s password may be reset from the OPAC or through the staff client.  To
228 reset the password from the staff client, retrieve the patron record as
229 described in the section <<circulation_searching_patrons,Searching Patrons>>. 
230
231 Open the patron record in edit mode as described in the section
232 <<updating_patron_information,Updating Patron Information>>.
233
234 Select the _Reset Password_ button next to the _Password_ field.  
235
236 image::media/circulation_patron_records-15.png[circulation_patron_records 15]
237
238 NOTE: The existing password is not displayed in patron records for security
239 reasons.
240
241 A new number will populate the _Password_ and _Verify Password_ text boxes.
242 Make note of the new password and _Save_ the patron record.  The screen will
243 refresh and the new password will be suppressed from view.   
244
245
246 [TIP]
247 =======================
248 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.
249
250 Connect to your Evergreen database using _psql_ or similar tool, and retreive and verify your admin username:
251
252 [source, sql]
253 ------------------------------------------------------------------------------
254 psql -U <user-name> -h <hostname> -d <database>
255
256 SELECT id, usrname, passwd from actor.usr where usrname = 'admin';
257 ------------------------------------------------------------------------------
258
259 If you do not remember the username that you set, search for it in the _actor.usr_ table, and then reset the password.
260
261 [source, sql]
262 ------------------------------------------------------------------------------
263 UPDATE actor.usr SET passwd = <password> WHERE id=<id of row to be updated>;
264 ------------------------------------------------------------------------------
265
266 The new password will automatically be hashed. 
267
268 =======================
269
270
271 Barring a Patron 
272 ~~~~~~~~~~~~~~~~
273
274 indexterm:[patrons, barring]
275
276 A patron may be barred from circulation activities.  To bar a patron, retrieve
277 the patron record as described in the section
278 <<circulation_searching_patrons,Searching Patrons>>. 
279
280 Open the patron record in edit mode as described in the section 
281 <<updating_patron_information,Updating Patron Information>>.
282
283 Check the box for _Barred_ in the patron account. 
284
285 image::media/circulation_patron_records-16.png[circulation_patron_records 16]
286
287 _Save_ the user.  The screen will refresh.  
288
289 NOTE: Barring a patron from one library bars that patron from all consortium
290 member libraries. 
291
292 To unbar a patron, uncheck the Barred checkbox.
293
294
295 Barred vs. Blocked 
296 ~~~~~~~~~~~~~~~~~~
297
298 indexterm:[patrons, barring]
299
300 *Barred*: Stops patrons from using their library cards; alerts the staff that
301 the patron is banned/barred from the library. The ``check-out'' functionality is
302 disabled for barred patrons (NO option to override – the checkout window is
303 unusable and the bar must be removed from the account before the patron is able
304 to checkout items).  These patrons may still log in to the OPAC to view their
305 accounts.
306
307 indexterm:[patrons, blocking]
308
309 *Blocked*: Often, these are system-generated blocks on patron accounts.  
310
311 Some examples:
312
313 * Patron exceeds fine threshold 
314 * Patron exceeds max checked out item threshold
315
316 A notice appears when a staff person tries to checkout an item to blocked
317 patrons, but staff may be given permissions to override blocks.
318
319
320 Staff-Generated Messages
321 ~~~~~~~~~~~~~~~~~~~~~~~~
322
323 [[staff_generated_messages]]
324 indexterm:[patrons, messages]
325
326 There are several types of messages available for staff to leave notes on patron records.
327
328 *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.)
329
330 *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.)
331
332 *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,Staff-Generated Penalties/Messages>> for more.)
333
334 Patron Alerts 
335 ~~~~~~~~~~~~~~
336
337 [[circulation_patron_alerts]]
338 indexterm:[patrons, Alerts]
339     
340 When an account has an alert on it, a Stop sign is displayed when the record is
341 retrieved.
342
343 image::media/circulation_patron_records-18_web_client.png[circulation_patron_records 18]
344
345 Navigating to an area of the patron record using the navigation buttons at the
346 top of the record (for example, Edit or Bills) will clear the message from view.
347
348 If you wish to view these alerts after they are cleared from view, they may be
349 retrieved.  Use the Other menu to select _Display Alert_ and _Messages_.
350
351 image::media/circulation_patron_records-19_web_client.png[circulation_patron_records 19]
352
353 There are two types of Patron Alerts:
354
355 *System-generated alerts*: Once the cause is resolved (e.g. patron's account has
356 been renewed), the message will disappear automatically.
357
358 *Staff-generated alerts*: Must be added and removed manually. 
359
360 To add an alert to a patron account, retrieve the patron record as described 
361 in the section <<circulation_searching_patrons,Searching Patrons>>. 
362
363 Open the patron record in edit mode as described in the section 
364 <<updating_patron_information,Updating Patron Information>>.
365
366 Enter the alert text in the Alert Message field.
367
368 image::media/circulation_patron_records-20.png[circulation_patron_records 20]
369
370 _Save_ the record. The screen will refresh and the alert will display.
371
372 To remove the alert, retrieve the patron record as described in the section
373 <<circulation_searching_patrons,Searching Patrons>>. 
374
375 Open the patron record in edit mode as described in the section 
376 <<updating_patron_information,Updating Patron Information>>.
377
378 Delete the alert text in the _Alert Message_ field. 
379
380 _Save_ the record.  
381
382 The screen will refresh and the indicators for the alert will be removed from 
383 the account. 
384
385 Patron Notes 
386 ~~~~~~~~~~~~
387
388 Notes are strictly communicative and may be made visible to the patron via their
389 account on the OPAC.  In the OPAC, these notes display on the account summary
390 screen in the OPAC.
391
392 image::media/circulation_patron_records-23_web_client.png[circulation_patron_records 23]
393
394 To insert or remove a note, retrieve the patron record as described in the
395 section  <<circulation_searching_patrons,Searching Patrons>>. 
396
397 Open the patron record in edit mode as described in the section
398 <<updating_patron_information,Updating Patron Information>>.
399
400 Use the Other menu to navigate to _Notes_.
401
402 image::media/circulation_patron_records-24_web_client.png[circulation_patron_records 24]
403
404 Select the _Add New Note_ button. An _Add Note_ window displays.  
405
406
407