]> git.evergreen-ils.org Git - Evergreen.git/blob - docs/circulation/circulation_patron_records_web_client.adoc
Docs: Update circulation_patron_records_web_client.adoc
[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 * Search ignores punctuation such as diacritics, apostrophes, hyphens and commas.
50 ===================
51
52 Once you have located the desired patron, click on the entry row for this patron in
53 the results screen.  A summary for this patron will display on the left hand side.  
54
55 image::media/circulation_patron_records-2_web_client.png[circulation_patron_records 2]
56
57 The _Patron Search_ button on the upper right may be used to resume searching for patrons.
58
59 Retrieve Recent Patrons
60 ~~~~~~~~~~~~~~~~~~~~~~~
61
62 indexterm:[patrons, retrieving recent]
63
64 Setting up Retrieve Recent Patrons
65 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
66
67 * This feature must be configured in the _Library Settings Editor_
68 (_Administration -> Local Administration -> Library Settings Editor_). The
69 library setting is called "Number of Retrievable Recent Patrons" and is located
70 in the Circulation settings group.
71 ** A value of zero (0) means no recent patrons can be retrieved.
72 ** A value greater than 1 means staff will be able to retrieve multiple recent
73 patrons via a new _Circulation -> Retrieve Recent Patrons_ menu entry.
74 ** The default value is 1 for backwards compatibility. (The _Circulation ->
75 Retrieve Last Patron_ menu entry will be available.)
76
77 Retrieving Recent Patrons
78 ^^^^^^^^^^^^^^^^^^^^^^^^^
79 * Once the library setting has been configured to a number greater than 1, the
80 option Retrieve Recent Patrons will appear below the Retrieve Last patron
81 option in the Circulation drop-down from the Menu Bar (_Circulation ->
82 Retrieve Recent Patrons_).
83
84 * When selected, a grid will appear listing patrons accessed by that workstation
85 in the current session. The length of the list will be limited by the value
86 configured in the _Library Settings Editor_. If no patrons have been accessed,
87 the grid will display "No Items To Display."
88
89
90 Registering New Patrons 
91 ~~~~~~~~~~~~~~~~~~~~~~~
92
93 indexterm:[patrons, registering]
94
95 To register a new patron, select _Circulation -> Register Patron_ from the menu bar. The Patron
96 Registration form will display. 
97
98 image::media/circulation_patron_records-4.JPG[Patron registration form]
99
100 Mandatory fields display in yellow.
101
102 image::media/circulation_patron_records-5.JPG[circulation_patron_records 5]
103
104 The _Show: Required Fields_ and _Show: Suggested Fields_ links may be used to limit
105 the options on this page.
106
107 image::media/circulation_patron_records-6.JPG[circulation_patron_records 6]
108
109 When finished entering the necessary information, select _Save_ to save the new
110 patron record or _Save & Clone_ to register a patron with the same address.
111 When _Save & Clone_ is selected, the address information is copied into the
112 resulting patron registration screen.  It is linked to the original patron.
113 Address information may only be edited through the original record.
114
115 image::media/circulation_patron_records-8.JPG[circulation_patron_records 8]
116
117 [TIP]
118 ============================================================================
119 * Requested fields may be configured in the _Library Settings Editor_
120 (_Administration -> Local Administration -> Library Settings Editor_).
121 * Statistical categories may be created for information tracked by your library 
122 that is not in the default patron record.
123 * These may be configured in the _Statistical Categories Editor_
124 (_Administration -> Local Administration -> Statistical Categories Editor_).
125 * Staff accounts may also function as patron accounts.
126 * You must select a _Main (Profile) Permission Group_ before the _Update Expire
127 Date_ button will work, since the permission group determines the expiration date.
128 ============================================================================
129
130
131 Patron Self-Registration
132 ~~~~~~~~~~~~~~~~~~~~~~~~
133 *Abstract*
134
135 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.  
136
137 *Patron Self-Registration*
138
139 . In the OPAC, click on the link to *Request Library Card*
140
141 . Fill out the self-registration form to request a library card, and click *Submit Registration*.
142
143 . Patrons will see a confirmation message: “Registration successful!  Please see library staff to complete your registration.”
144
145 image::media/patron_self_registration2.jpg[Patron Self-Registration form]
146
147 *Managing Pending Patrons*
148
149 . In the staff client select *Circulation* -> *Pending Patrons*.
150
151 . 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.
152
153 . 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. 
154
155 . Fill in the necessary patron information for your library, and click *Save* to create the permanent patron account.
156
157
158 [[updating_patron_information]] 
159 Updating Patron Information
160 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
161
162 indexterm:[patrons, updating]
163
164 Retrieve the patron record as described in the section
165 <<searching_patrons,Searching Patrons>>.
166
167 Click on _Edit_ from the options that display at the top of the patron record. 
168
169 image::media/circulation_patron_records-9_web_client.png[Patron edit with summary display]
170
171 Edit information as required.  When finished, select _Save_.  
172
173 After selecting _Save_, the page will refresh.  The edited information will be
174 reflected in the patron summary pane.
175
176 [TIP]
177 =======
178 * To quickly renew an expired patron, click the _Update Expire Date_ button.
179 You will need a _Main (Profile) Permission Group_ selected for this to work,
180 since the permission group determines the expiration date.
181 =======
182
183
184 Renewing Library Cards 
185 ~~~~~~~~~~~~~~~~~~~~~~
186
187 indexterm:[library cards, renewing]
188
189 Expired patron accounts when initially retrieved – an alert
190 stating that the ``Patron account is EXPIRED.''
191
192 image::media/circulation_patron_records-11_web_client.png[circulation_patron_records 11]
193
194 Open the patron record in edit mode as described in the section
195 <<updating_patron_information,Updating Patron Information>>.
196
197 Navigate to the information field labeled _Privilege Expiration Date_.  Enter a
198 new date in this box.  Or click the calendar icon, and a calendar widget
199 will display to help you easily navigate to the desired date.
200
201 image::media/circulation_patron_records-12.JPG[circulation_patron_records 12]
202
203 Select the date using the calendar widget or key the date in manually.  Click
204 the _Save_ button.  The screen will refresh and the ``expired'' alerts on the
205 account will be removed. 
206
207
208 Lost Library Cards 
209 ~~~~~~~~~~~~~~~~~~
210
211 indexterm:[library cards, replacing]
212
213 Retrieve the patron record as described in the section
214 <<searching_patrons,Searching Patrons>>. 
215
216 Open the patron record in edit mode as described in the section
217 <<updating_patron_information,Updating Patron Information>>.
218  
219 Next to the _Barcode_ field, select the _Replace Barcode_ button.
220
221 image::media/circulation_patron_records_13.JPG[circulation_patron_records 13]
222
223 This will clear the barcode field.  Enter a new barcode and _Save_ the record.
224 The screen will refresh and the new barcode will display in the patron summary
225 pane.  
226
227 If a patron’s barcode is mistakenly replaced, the old barcode may be reinstated.
228 Retrieve the patron record as described in the section
229 <<searching_patrons,Searching Patrons>>. Open the patron record in
230 edit mode as described in the section <<updating_patron_information,Updating Patron Information>>.
231
232 Select the _See All_ button next to the _Replace Barcode_ button.  This will
233 display the current and past barcodes associated with this account. 
234
235 image::media/circulation_patron_records_14.JPG[circulation_patron_records 14]
236
237 Check the box(es) for all barcodes that should be ``active'' for the patron.  An
238 ``active'' barcode may be used for circulation transactions.  A patron may have
239 more than one ``active'' barcode.  Only one barcode may be designated
240 ``primary.'' The ``primary'' barcode displays in the patron’s summary
241 information in the _Library Card_ field. 
242
243 Once you have modified the patron barcode(s), _Save_ the patron record.  If you
244 modified the ``primary'' barcode, the new primary barcode will display in the
245 patron summary screen. 
246
247 Resetting Patron's Password 
248 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
249
250 indexterm:[patrons, passwords]
251
252 A patron’s password may be reset from the OPAC or through the staff client.  To
253 reset the password from the staff client, retrieve the patron record as
254 described in the section <<searching_patrons,Searching Patrons>>. 
255
256 Open the patron record in edit mode as described in the section
257 <<updating_patron_information,Updating Patron Information>>.
258
259 Select the _Generate Password_ button next to the _Password_ field.
260
261 image::media/circulation_patron_records_15.JPG[circulation_patron_records 15]
262
263 NOTE: The existing password is not displayed in patron records for security
264 reasons.
265
266 A new number will populate the _Password_ text box.
267 Make note of the new password and _Save_ the patron record.  The screen will
268 refresh and the new password will be suppressed from view.   
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 <<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.JPG[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_web_client,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 <<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 <<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 [[circulation_patron_notes]]
389 indexterm:[patrons, Notes]
390
391 Notes are strictly communicative and may be made visible to the patron via their
392 account on the OPAC.  In the OPAC, these notes display on the account summary
393 screen in the OPAC.
394
395 image::media/circulation_patron_records-23_web_client.png[circulation_patron_records 23]
396
397 To insert or remove a note, retrieve the patron record as described in the
398 section  <<searching_patrons,Searching Patrons>>. 
399
400 Open the patron record in edit mode as described in the section
401 <<updating_patron_information,Updating Patron Information>>.
402
403 Use the Other menu to navigate to _Notes_.
404
405 image::media/circulation_patron_records-24_web_client.png[circulation_patron_records 24]
406
407 Select the _Add New Note_ button. A _Create a new note_ window displays.  
408
409 [TIP] 
410 ================================================ 
411 Your system administrator can add a box in the _Add Note_ window for staff initials and
412 require those initials to be entered.  They can do so using the "Require staff initials..."
413 settings in the Library Settings Editor.
414 ================================================ 
415
416 Enter note information. 
417
418 Select the check box for _Patron Visible_ to display the note in the OPAC. 
419
420 image::media/circulation_patron_records-25_web_client.png[circulation_patron_records 25]
421
422 Select _OK_ to save the note to the patron account.  
423
424 To delete a note, go to _Other -> Notes_ and use the _Delete_ button
425 on the right of each note.
426
427 image::media/circulation_patron_records-26_web_client.png[circulation_patron_records 26]
428
429 Staff-Generated Penalties/Messages
430 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
431
432 [[staff_generated_penalties_web_client]]
433 To access this feature, use the _Messages_ button in the patron record.
434
435 image::media/staff-penalties-1_web_client.png[Messages screen]
436
437 Add a Message
438 ^^^^^^^^^^^^^
439
440 Click *Apply Penalty/Message* to begin the process of adding a message to the patron.
441
442 image::media/staff-penalties-2_web_client.png[Apply Penalty Dialog Box]
443
444 There are three options: Notes, Alerts, Blocks
445
446 * *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.)
447
448 * *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_.
449
450 * *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.
451
452 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*
453
454 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.
455
456 image::media/staff-penalties-3_web_client.png[[Messages on a record]
457
458 Modify a Message
459 ^^^^^^^^^^^^^^^^
460
461 Messages can be edited by staff after they are created. 
462
463 image::media/staff-penalties-4_web_client.png[[Actions menu]
464
465 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.
466
467 image::media/staff-penalties-5_web_client.png[Modify penalty dialog box]
468
469 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.
470
471 image::media/staff-penalties-6_web_client.png[Modified message in the list]
472
473 Archive a Message
474 ^^^^^^^^^^^^^^^^^
475
476 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.
477
478 image::media/staff-penalties-4_web_client.png[[Actions menu]
479
480 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.
481
482 image::media/staff-penalties-7_web_client.png[Archived messages]
483
484 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*.
485
486 Remove a Message
487 ^^^^^^^^^^^^^^^^
488
489 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.
490
491 image::media/staff-penalties-4_web_client.png[[Actions menu]
492
493 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.
494
495
496 User Buckets
497 ~~~~~~~~~~~~
498
499 User Buckets allow staff to batch delete and make batch modifications to user accounts in Evergreen. Batch modifications can be made to selected fields in the patron account:
500
501 * Home Library
502 * Profile Group
503 * Network Access Level
504 * Barred flag
505 * Active flag
506 * Juvenile flag
507 * Privilege Expiration Date
508 * Statistical Categories
509
510 Batch modifications and deletions can be rolled back or reversed, with the exception of batch changes to statistical categories.  Batch changes made in User Buckets will not activate any Action/Trigger event definitions that would normally be activated when editing an individual account.
511
512 User accounts can be added to User Buckets by scanning individual user barcodes or by uploading a file of user barcodes directly in the User Bucket interface.  They can also be added to a User Bucket from the Patron Search screen.  Batch changes and batch edit sets are tied to the User Bucket itself, not to the login of the bucket owner.
513
514 Create a User Bucket
515 ^^^^^^^^^^^^^^^^^^^^
516 *To add users to a bucket via the Patron Search screen:*
517
518 . Go to *Search->Search for Patrons*.
519 . Enter your search and select the users you want to add to the user bucket by checking the box next to each user row.  You can also hold down the CTRL or SHIFT on your keyboard and select multiple users.
520 . Click *Add to Bucket* and select an existing bucket from the drop down menu or click *New Bucket* to create a new user bucket.
521 .. If creating a new user bucket, a dialog box called _Create Bucket_ will appear where you can enter a bucket _Name_ and _Description_ and indicate if the bucket is _Staff Shareable?_.  Click *Create Bucket*.
522 . After adding users to a bucket, an update will appear at the bottom-right hand corner of the screen that says _"Successfully added # users to bucket [Name]"_.
523
524 image::media/userbucket1.PNG[]
525
526 image::media/userbucket2.PNG[]
527
528 *To add users to a bucket by scanning user barcodes in the User Bucket interface:*
529
530 . Go to *Circulation->User Buckets* and select the *Pending Users* tab at the top of the screen.
531 . Click on *Buckets* and select an existing bucket from the drop down menu or click *New Bucket* to create a new user bucket.
532 .. If creating a new user bucket, a dialog box called _Create Bucket_ will appear where you can enter a bucket _Name_ and _Description_ and indicate if the bucket is _Staff Shareable?_.  Click *Create Bucket*.
533 .. After selecting or creating a bucket, the Name, Description, number of items, and creation date of the bucket will appear above the _Scan Card_ field.
534 . Scan in the barcodes of the users that you want to add to the selected bucket into the _Scan Card_ field.  Each user account will be added to the Pending Users tab.  Hit ENTER on your keyboard after manually typing in a barcode to add it to the list of Pending Users.
535 . Select the user accounts that you want to add to the bucket by checking the box next to each user row or by using the CTRL or SHIFT key on your keyboard to select multiple users.
536 . Go to *Actions->Add To Bucket* or right-click on a selected user account to view the _Actions_ menu and select *Add To Bucket*.  The user accounts will move to the Bucket View tab and are now in the selected User Bucket.
537
538 image::media/userbucket3.PNG[]
539
540 *To add users to a bucket by uploading a file of user barcodes:*
541
542 . Go to *Circulation->User Buckets* and select the *Pending Users* tab at the top of the screen.
543 . Click on *Buckets* and select an existing bucket from the drop down menu or click *New Bucket* to create a new user bucket.
544 .. If creating a new user bucket, a dialog box called _Create Bucket_ will appear where you can enter a bucket _Name_ and _Description_ and indicate if the bucket is _Staff Shareable?_.  Click *Create Bucket*.
545 .. After selecting or creating a bucket, the Name, Description, number of items, and creation date of the bucket will appear above the Scan Card field.
546 . In the Pending Users tab, click *Choose File* and select the file of barcodes to be uploaded.
547 .. The file that is uploaded must be a .txt file that contains a single barcode per row.
548 . The user accounts will automatically appear in the list of Pending Users.
549 . Select the user accounts that you want to add to the bucket by checking the box next to each user row or by using the CTRL or SHIFT key on your keyboard to select multiple users.
550 . Go to *Actions->Add To Bucket* or right-click on a selected user account to view the _Actions_ menu and select *Add To Bucket*.  The user accounts will move to the Bucket View tab and are now in the selected User Bucket.
551
552 Batch Edit All Users
553 ^^^^^^^^^^^^^^^^^^^^
554 To batch edit all users in a user bucket:
555
556 . Go to *Circulation->User Buckets* and select the *Bucket View* tab.
557 . Click *Buckets* and select the bucket you want to modify from the list of existing buckets.
558 .. After selecting a bucket, the Name, Description, number of items, and creation date of the bucket will appear at the top of the screen.
559 . Verify the list of users in the bucket and click *Batch edit all users*. A dialog box called _Update all users_ will appear where you can select the batch modifications to be made to the user accounts.
560 . Assign a _Name for edit set_.  This name will allow staff to identify the batch edit for future verification or rollbacks.
561 . Set the values that you want to modify.  The following fields can be modified in batch:
562
563 * Home Library
564 * Profile Group
565 * Network Access Level
566 * Barred flag
567 * Active flag
568 * Juvenile flag
569 * Privilege Expiration Date
570
571 . Click *Apply Changes*.  The modification(s) will be applied in batch.
572
573 image::media/userbucket4.PNG[]
574
575 Batch Modify Statistical Categories
576 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
577 To batch modify statistical categories for all users in a bucket:
578
579 . Go to *Circulation->User Buckets* and select the *Bucket View* tab.
580 . Click *Buckets* and select the bucket you want to modify from the list of existing buckets.
581 .. After selecting a bucket, the Name, Description, number of items, and creation date of the bucket will appear at the top of the screen.
582 . Verify the list of users in the bucket and click *Batch modify statistical categories*. A dialog box called _Update statistical categories_ will appear where you can select the batch modifications to be made to the user accounts.  The existing patron statistical categories will be listed and staff can choose:
583 .. To leave the stat cat value unchanged in the patron accounts.
584 .. To select a new stat cat value for the patron accounts.
585 .. Check the box next to Remove to delete the current stat cat value from the patron accounts.
586 . Click *Apply Changes*.  The stat cat modification(s) will be applied in batch.
587
588 image::media/userbucket12.PNG[]
589
590 Batch Delete Users
591 ^^^^^^^^^^^^^^^^^^
592 To batch delete users in a bucket:
593 . Go to *Circulation->User Buckets* and select the *Bucket View* tab.
594 . Click on *Buckets* and select the bucket you want to modify from the list of existing buckets.
595 .. After selecting a bucket, the Name, Description, number of items, and creation date of the bucket will appear at the top of the screen.
596 . Verify the list of users in the bucket and click *Delete all users*. A dialog box called _Delete all users_ will appear.
597 . Assign a _Name for delete set_.  This name will allow staff to identify the batch deletion for future verification or rollbacks.
598 . Click *Apply Changes*.  All users in the bucket will be marked as deleted.
599
600 NOTE: Batch deleting patrons from a user bucket does not use the Purge User functionality, but instead marks the users as deleted.
601
602 image::media/userbucket7.PNG[]
603
604 View Batch Changes
605 ^^^^^^^^^^^^^^^^^^
606
607 . The batch changes that have been made to User Buckets can be viewed by going to *Circulation->User Buckets* and selecting the *Bucket View* tab.
608 . Click *Buckets* to select an existing bucket.
609 . Click *View batch changes*.  A dialog box will appear that lists the _Name_, date _Completed_, and date _Rolled back_ of any batch changes made to the bucket.  There is also an option to _Delete_ a batch change.  This will remove this batch change from the list of actions that can be rolled back.  It will not delete or reverse the batch change.
610 . Click *OK* to close the dialog box.
611
612 image::media/userbucket8.PNG[]
613
614 Roll Back Batch Changes
615 ^^^^^^^^^^^^^^^^^^^^^^^
616
617 . Batch Changes and Batch Deletions can be rolled back or reversed by going to *Circulation->User Buckets* and selecting the *Bucket View* tab.
618 . Click *Buckets* to select an existing bucket.
619 . Click *Roll back batch edit*.  A dialog box will appear that contains a drop down menu that lists all batch edits that can be rolled back.  Select the batch edit to roll back and click *Roll Back Changes*.  The batch change will be reversed and the roll back is recorded under _View batch changes_.
620
621 NOTE: Batch statistical category changes cannot be rolled back.
622
623 image::media/userbucket10.png[]
624
625 image::media/userbucket9.PNG[]
626
627 Sharing Buckets
628 ^^^^^^^^^^^^^^^
629 If a User Bucket has been made Staff Shareable, it can be retrieved via bucket ID by another staff account.  The ID for each bucket can be found at the end of the URL for the bucket.  For example, in the screenshot below, the bucket ID is 32.
630
631 image::media/userbucket11.PNG[]
632
633 A shared bucket can be retrieved by going to *Circulation->User Buckets* and selecting the *Bucket View* tab.  Next, click *Buckets* and select *Shared Bucket*.  A dialog box called _Load Shared Bucket by Bucket ID_ will appear.  Enter the ID of the bucket you wish to retrieve and click *Load Bucket*.  The shared bucket will load in the Bucket View tab.
634
635 Permissions
636 ^^^^^^^^^^^
637 All permissions must be granted at the organizational unit that the workstation is registered to or higher and are checked against the users' Home Library at when a batch modification or deletion is executed.
638
639 Permissions for Batch Edits:
640
641 * To batch edit a user bucket, staff accounts must have the VIEW_USER, UPDATE_USER, and CONTAINER_BATCH_UPDATE permissions for all users in the bucket.
642 * To make a batch changes to Profile Group, staff accounts must have the appropriate group application permissions for the profile groups.
643 * To make batch changes to the Home Library, staff accounts must have the UPDATE_USER permission at both the old and new Home Library.
644 * To make batch changes to the Barred Flag, staff accounts must have the appropriate BAR_PATRON or UNBAR_PATRON permission.
645
646 Permissions for Batch Deletion:
647
648 * To batch delete users in a user bucket, staff accounts must have the UPDATE_USER and DELETE_USER permissions for all users in the bucket.
649