]> git.evergreen-ils.org Git - Evergreen.git/blob - docs/modules/circulation/pages/circulation_patron_records_web_client.adoc
693d180199f02ed6864dd7e10c13e66ea1b907c0
[Evergreen.git] / docs / modules / circulation / pages / circulation_patron_records_web_client.adoc
1 = Circulation - Patron Record = 
2 :toc:
3
4 [[searching_patrons]] 
5 == Searching Patrons ==
6
7 indexterm:[patrons, searching for]
8
9 To search for a patron, select _Search -> Search for Patrons_ from the menu bar.
10
11 The Patron Search screen will display. It will contain options to search on the 
12 following fields:
13
14 * Last Name 
15 * First Name 
16 * Middle Name 
17
18 image::media/circulation_patron_records-1a_web_client.png[circulation_patron_records 1a]
19
20
21 Next to the _Clear Form_ button there is a button with an arrow pointing down that will display the following additional search fields:
22    
23 * Barcode 
24 * Alias 
25 * Username
26 * Email 
27 * Identification
28 * database ID
29 * Phone
30 * Street 1 
31 * Street 2 
32 * City 
33 * State 
34 * Postal Code
35 * Profile Group
36 * Home Library 
37 * DOB (date of birth) year
38 * DOB month
39 * DOB day
40
41 To include patrons marked ``inactive'', click on the _Include Inactive?_ checkbox.
42
43
44 image::media/circulation_patron_records-1b_web_client.png[circulation_patron_records 1b]
45
46 .Tips for searching 
47 [TIP] 
48 =================== 
49 * Search one field or combine fields for more precise results.  
50 * Truncate search terms for more search results.
51 * Search ignores punctuation such as diacritics, apostrophes, hyphens and commas.
52 * Searching by Date of Birth: Year searches are "contains" searches. E.g. year
53   "15" matches 2015, 1915, 1599, etc. For exact matches use the full 4-digit
54   year. Day and month values are exact matches. E.g. month "1" (or "01") matches
55   January, "12" matches December.
56 ===================
57
58 Once you have located the desired patron, click on the entry row for this patron in
59 the results screen.  A summary for this patron will display on the left hand side.  
60
61 image::media/circulation_patron_records-2_web_client.png[circulation_patron_records 2]
62
63 The _Patron Search_ button on the upper right may be used to resume searching for patrons.
64
65 == Retrieve Recent Patrons ==
66
67 indexterm:[patrons, retrieving recent]
68
69 === Setting up Retrieve Recent Patrons ===
70
71 * This feature must be configured in the _Library Settings Editor_
72 (_Administration -> Local Administration -> Library Settings Editor_). The
73 library setting is called "Number of Retrievable Recent Patrons" and is located
74 in the Circulation settings group.
75 ** A value of zero (0) means no recent patrons can be retrieved.
76 ** A value greater than 1 means staff will be able to retrieve multiple recent
77 patrons via a new _Circulation -> Retrieve Recent Patrons_ menu entry.
78 ** The default value is 1 for backwards compatibility. (The _Circulation ->
79 Retrieve Last Patron_ menu entry will be available.)
80
81 === Retrieving Recent Patrons ===
82 * Once the library setting has been configured to a number greater than 1, the
83 option Retrieve Recent Patrons will appear below the Retrieve Last patron
84 option in the Circulation drop-down from the Menu Bar (_Circulation ->
85 Retrieve Recent Patrons_).
86
87 * When selected, a grid will appear listing patrons accessed by that workstation
88 in the current session. The length of the list will be limited by the value
89 configured in the _Library Settings Editor_. If no patrons have been accessed,
90 the grid will display "No Items To Display."
91
92
93 == Registering New Patrons == 
94
95 indexterm:[patrons, registering]
96
97 To register a new patron, select _Circulation -> Register Patron_ from the menu bar. The Patron
98 Registration form will display. 
99
100 image::media/circulation_patron_records-4.JPG[Patron registration form]
101
102 Mandatory fields display in yellow.
103
104 image::media/circulation_patron_records-5.JPG[circulation_patron_records 5]
105
106 The _Show: Required Fields_ and _Show: Suggested Fields_ links may be used to limit
107 the options on this page.
108
109 image::media/circulation_patron_records-6.JPG[circulation_patron_records 6]
110
111 When finished entering the necessary information, select _Save_ to save the new
112 patron record or _Save & Clone_ to register a patron with the same address.
113 When _Save & Clone_ is selected, the address information is copied into the
114 resulting patron registration screen.  It is linked to the original patron.
115 Address information may only be edited through the original record.
116
117 image::media/circulation_patron_records-8.JPG[circulation_patron_records 8]
118
119 [TIP]
120 ============================================================================
121 * Requested fields may be configured in the _Library Settings Editor_
122 (_Administration -> Local Administration -> Library Settings Editor_).
123 * Statistical categories may be created for information tracked by your library 
124 that is not in the default patron record.
125 * These may be configured in the _Statistical Categories Editor_
126 (_Administration -> Local Administration -> Statistical Categories Editor_).
127 * Staff accounts may also function as patron accounts.
128 * You must select a _Main (Profile) Permission Group_ before the _Update Expire
129 Date_ button will work, since the permission group determines the expiration date.
130 ============================================================================
131
132 === Email field ===
133
134 indexterm:[patrons,email addresses]
135 indexterm:[email]
136
137 It's possible for administrators to set up the email field to allow or disallow
138 multiple email addresses for a single patron (usually separated by a comma).
139 If you'd like to make changes to whether multiple email addresses
140 are allowed here or not, ask your system administrator to change the
141 `ui.patron.edit.au.email.regex` library setting.
142
143
144 == Patron Self-Registration ==
145 *Abstract*
146
147 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.  
148
149 *Patron Self-Registration*
150
151 . In the OPAC, click on the link to *Request Library Card*
152
153 . Fill out the self-registration form to request a library card, and click *Submit Registration*.
154
155 . Patrons will see a confirmation message: “Registration successful!  Please see library staff to complete your registration.”
156
157 image::media/patron_self_registration2.jpg[Patron Self-Registration form]
158
159 *Managing Pending Patrons*
160
161 . In the staff client select *Circulation* -> *Pending Patrons*.
162
163 . 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.
164
165 . 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. 
166
167 . Fill in the necessary patron information for your library, and click *Save* to create the permanent patron account.
168
169
170 [[updating_patron_information]] 
171 == Updating Patron Information ==
172
173 indexterm:[patrons, updating]
174
175 Retrieve the patron record as described in the section
176 <<searching_patrons,Searching Patrons>>.
177
178 Click on _Edit_ from the options that display at the top of the patron record. 
179
180 image::media/circulation_patron_records-9_web_client.png[Patron edit with summary display]
181
182 Edit information as required.  When finished, select _Save_.  
183
184 After selecting _Save_, the page will refresh.  The edited information will be
185 reflected in the patron summary pane.
186
187 [TIP]
188 =======
189 * To quickly renew an expired patron, click the _Update Expire Date_ button.
190 You will need a _Main (Profile) Permission Group_ selected for this to work,
191 since the permission group determines the expiration date.
192 =======
193
194
195 == Renewing Library Cards ==
196
197 indexterm:[library cards, renewing]
198
199 Expired patron accounts when initially retrieved – an alert
200 stating that the ``Patron account is EXPIRED.''
201
202 image::media/circulation_patron_records-11_web_client.png[circulation_patron_records 11]
203
204 Open the patron record in edit mode as described in the section
205 <<updating_patron_information,Updating Patron Information>>.
206
207 Navigate to the information field labeled _Privilege Expiration Date_.  Enter a
208 new date in this box.  Or click the calendar icon, and a calendar widget
209 will display to help you easily navigate to the desired date.
210
211 image::media/circulation_patron_records-12.JPG[circulation_patron_records 12]
212
213 Select the date using the calendar widget or key the date in manually.  Click
214 the _Save_ button.  The screen will refresh and the ``expired'' alerts on the
215 account will be removed. 
216
217
218 == Lost Library Cards ==
219
220 indexterm:[library cards, replacing]
221
222 Retrieve the patron record as described in the section
223 <<searching_patrons,Searching Patrons>>. 
224
225 Open the patron record in edit mode as described in the section
226 <<updating_patron_information,Updating Patron Information>>.
227  
228 Next to the _Barcode_ field, select the _Replace Barcode_ button.
229
230 image::media/circulation_patron_records_13.JPG[circulation_patron_records 13]
231
232 This will clear the barcode field.  Enter a new barcode and _Save_ the record.
233 The screen will refresh and the new barcode will display in the patron summary
234 pane.  
235
236 If a patron’s barcode is mistakenly replaced, the old barcode may be reinstated.
237 Retrieve the patron record as described in the section
238 <<searching_patrons,Searching Patrons>>. Open the patron record in
239 edit mode as described in the section <<updating_patron_information,Updating Patron Information>>.
240
241 Select the _See All_ button next to the _Replace Barcode_ button.  This will
242 display the current and past barcodes associated with this account. 
243
244 image::media/circulation_patron_records_14.JPG[circulation_patron_records 14]
245
246 Check the box(es) for all barcodes that should be ``active'' for the patron.  An
247 ``active'' barcode may be used for circulation transactions.  A patron may have
248 more than one ``active'' barcode.  Only one barcode may be designated
249 ``primary.'' The ``primary'' barcode displays in the patron’s summary
250 information in the _Library Card_ field. 
251
252 Once you have modified the patron barcode(s), _Save_ the patron record.  If you
253 modified the ``primary'' barcode, the new primary barcode will display in the
254 patron summary screen. 
255
256 == Resetting Patron's Password ==
257
258 indexterm:[patrons, passwords]
259
260 A patron’s password may be reset from the OPAC or through the staff client.  To
261 reset the password from the staff client, retrieve the patron record as
262 described in the section <<searching_patrons,Searching Patrons>>. 
263
264 Open the patron record in edit mode as described in the section
265 <<updating_patron_information,Updating Patron Information>>.
266
267 Select the _Generate Password_ button next to the _Password_ field.
268
269 image::media/circulation_patron_records_15.JPG[circulation_patron_records 15]
270
271 NOTE: The existing password is not displayed in patron records for security
272 reasons.
273
274 A new number will populate the _Password_ text box.
275 Make note of the new password and _Save_ the patron record.  The screen will
276 refresh and the new password will be suppressed from view.   
277
278
279 == Barring a Patron ==
280
281 indexterm:[patrons, barring]
282
283 A patron may be barred from circulation activities.  To bar a patron, retrieve
284 the patron record as described in the section
285 <<searching_patrons,Searching Patrons>>. 
286
287 Open the patron record in edit mode as described in the section 
288 <<updating_patron_information,Updating Patron Information>>.
289
290 Check the box for _Barred_ in the patron account. 
291
292 image::media/circulation_patron_records-16.JPG[circulation_patron_records 16]
293
294 _Save_ the user.  The screen will refresh.  
295
296 NOTE: Barring a patron from one library bars that patron from all consortium
297 member libraries. 
298
299 To unbar a patron, uncheck the Barred checkbox.
300
301
302 == Barred vs. Blocked ==
303
304 indexterm:[patrons, barring]
305
306 *Barred*: Stops patrons from using their library cards; alerts the staff that
307 the patron is banned/barred from the library. The ``check-out'' functionality is
308 disabled for barred patrons (NO option to override – the checkout window is
309 unusable and the bar must be removed from the account before the patron is able
310 to checkout items).  These patrons may still log in to the OPAC to view their
311 accounts.
312
313 indexterm:[patrons, blocking]
314
315 *Blocked*: Often, these are system-generated blocks on patron accounts.  
316
317 Some examples:
318
319 * Patron exceeds fine threshold 
320 * Patron exceeds max checked out item threshold
321
322 A notice appears when a staff person tries to checkout an item to blocked
323 patrons, but staff may be given permissions to override blocks.
324
325
326 == Staff-Generated Messages ==
327
328 [[staff_generated_messages]]
329 indexterm:[patrons, messages]
330
331 There are several types of messages available for staff to leave notes on patron records.
332
333 *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.)
334
335 *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.)
336
337 *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.)
338
339 == Patron Alerts ==
340
341 [[circulation_patron_alerts]]
342 indexterm:[patrons, Alerts]
343     
344 When an account has an alert on it, a Stop sign is displayed when the record is
345 retrieved.
346
347 image::media/circulation_patron_records-18_web_client.png[circulation_patron_records 18]
348
349 Navigating to an area of the patron record using the navigation buttons at the
350 top of the record (for example, Edit or Bills) will clear the message from view.
351
352 If you wish to view these alerts after they are cleared from view, they may be
353 retrieved.  Use the Other menu to select _Display Alert_ and _Messages_.
354
355 image::media/circulation_patron_records-19_web_client.png[circulation_patron_records 19]
356
357 There are two types of Patron Alerts:
358
359 *System-generated alerts*: Once the cause is resolved (e.g. patron's account has
360 been renewed), the message will disappear automatically.
361
362 *Staff-generated alerts*: Must be added and removed manually. 
363
364 To add an alert to a patron account, retrieve the patron record as described 
365 in the section <<searching_patrons,Searching Patrons>>. 
366
367 Open the patron record in edit mode as described in the section 
368 <<updating_patron_information,Updating Patron Information>>.
369
370 Enter the alert text in the Alert Message field.
371
372 image::media/circulation_patron_records-20.png[circulation_patron_records 20]
373
374 _Save_ the record. The screen will refresh and the alert will display.
375
376 To remove the alert, retrieve the patron record as described in the section
377 <<searching_patrons,Searching Patrons>>. 
378
379 Open the patron record in edit mode as described in the section 
380 <<updating_patron_information,Updating Patron Information>>.
381
382 Delete the alert text in the _Alert Message_ field. 
383
384 _Save_ the record.  
385
386 The screen will refresh and the indicators for the alert will be removed from 
387 the account. 
388
389 == Patron Notes ==
390
391 [[circulation_patron_notes]]
392 indexterm:[patrons, Notes]
393
394 Notes are strictly communicative and may be made visible to the patron via their
395 account on the OPAC.  In the OPAC, these notes display on the account summary
396 screen in the OPAC.
397
398 image::media/circulation_patron_records-23_web_client.png[circulation_patron_records 23]
399
400 To insert or remove a note, retrieve the patron record as described in the
401 section  <<searching_patrons,Searching Patrons>>. 
402
403 Open the patron record in edit mode as described in the section
404 <<updating_patron_information,Updating Patron Information>>.
405
406 Use the Other menu to navigate to _Notes_.
407
408 image::media/circulation_patron_records-24_web_client.png[circulation_patron_records 24]
409
410 Select the _Add New Note_ button. A _Create a new note_ window displays.  
411
412 [TIP] 
413 ================================================ 
414 Your system administrator can add a box in the _Add Note_ window for staff initials and
415 require those initials to be entered.  They can do so using the "Require staff initials..."
416 settings in the Library Settings Editor.
417 ================================================ 
418
419 Enter note information. 
420
421 Select the check box for _Patron Visible_ to display the note in the OPAC. 
422
423 image::media/circulation_patron_records-25_web_client.png[circulation_patron_records 25]
424
425 Select _OK_ to save the note to the patron account.  
426
427 To delete a note, go to _Other -> Notes_ and use the _Delete_ button
428 on the right of each note.
429
430 image::media/circulation_patron_records-26_web_client.png[circulation_patron_records 26]
431
432 == Staff-Generated Penalties/Messages ==
433
434 [[staff_generated_penalties_web_client]]
435 To access this feature, use the _Messages_ button in the patron record.
436
437 image::media/staff-penalties-1_web_client.png[Messages screen]
438
439 === Add a Message ===
440
441 Click *Apply Penalty/Message* to begin the process of adding a message to the patron.
442
443 image::media/staff-penalties-2_web_client.png[Apply Penalty Dialog Box]
444
445 There are three options: Notes, Alerts, Blocks
446
447 * *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.)
448
449 * *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_.
450
451 * *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.
452
453 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*
454
455 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.
456
457 image::media/staff-penalties-3_web_client.png[[Messages on a record]
458
459 === Modify a Message ===
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 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 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.
488
489 image::media/staff-penalties-4_web_client.png[[Actions menu]
490
491 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.
492
493
494 == User Buckets ==
495
496 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:
497
498 * Home Library
499 * Profile Group
500 * Network Access Level
501 * Barred flag
502 * Active flag
503 * Juvenile flag
504 * Privilege Expiration Date
505 * Statistical Categories
506
507 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.
508
509 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.
510
511 === Create a User Bucket ===
512
513 *To add users to a bucket via the Patron Search screen:*
514
515 . Go to *Search->Search for Patrons*.
516 . 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.
517 . Click *Add to Bucket* and select an existing bucket from the drop down menu or click *New Bucket* to create a new user bucket.
518 .. 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*.
519 . 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]"_.
520
521 image::media/userbucket1.PNG[]
522
523 image::media/userbucket2.PNG[]
524
525 *To add users to a bucket by scanning user barcodes in the User Bucket interface:*
526
527 . Go to *Circulation->User Buckets* and select the *Pending Users* tab at the top of the screen.
528 . Click on *Buckets* and select an existing bucket from the drop down menu or click *New Bucket* to create a new user bucket.
529 .. 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*.
530 .. 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.
531 . 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.
532 . 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.
533 . 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.
534
535 image::media/userbucket3.PNG[]
536
537 *To add users to a bucket by uploading a file of user barcodes:*
538
539 . Go to *Circulation->User Buckets* and select the *Pending Users* tab at the top of the screen.
540 . Click on *Buckets* and select an existing bucket from the drop down menu or click *New Bucket* to create a new user bucket.
541 .. 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*.
542 .. 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.
543 . In the Pending Users tab, click *Choose File* and select the file of barcodes to be uploaded.
544 .. The file that is uploaded must be a .txt file that contains a single barcode per row.
545 . The user accounts will automatically appear in the list of Pending Users.
546 . 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.
547 . 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.
548
549 === Batch Edit All Users ===
550
551 To batch edit all users in a user bucket:
552
553 . Go to *Circulation->User Buckets* and select the *Bucket View* tab.
554 . Click *Buckets* and select the bucket you want to modify from the list of existing buckets.
555 .. After selecting a bucket, the Name, Description, number of items, and creation date of the bucket will appear at the top of the screen.
556 . 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.
557 . Assign a _Name for edit set_.  This name will allow staff to identify the batch edit for future verification or rollbacks.
558 . Set the values that you want to modify.  The following fields can be modified in batch:
559
560 * Home Library
561 * Profile Group
562 * Network Access Level
563 * Barred flag
564 * Active flag
565 * Juvenile flag
566 * Privilege Expiration Date
567
568 . Click *Apply Changes*.  The modification(s) will be applied in batch.
569
570 image::media/userbucket4.PNG[]
571
572 === Batch Modify Statistical Categories ===
573
574 To batch modify statistical categories for all users in a bucket:
575
576 . Go to *Circulation->User Buckets* and select the *Bucket View* tab.
577 . Click *Buckets* and select the bucket you want to modify from the list of existing buckets.
578 .. After selecting a bucket, the Name, Description, number of items, and creation date of the bucket will appear at the top of the screen.
579 . 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:
580 .. To leave the stat cat value unchanged in the patron accounts.
581 .. To select a new stat cat value for the patron accounts.
582 .. Check the box next to Remove to delete the current stat cat value from the patron accounts.
583 . Click *Apply Changes*.  The stat cat modification(s) will be applied in batch.
584
585 image::media/userbucket12.PNG[]
586
587 === Batch Delete Users ===
588
589 To batch delete users in a bucket:
590 . Go to *Circulation->User Buckets* and select the *Bucket View* tab.
591 . Click on *Buckets* and select the bucket you want to modify from the list of existing buckets.
592 .. After selecting a bucket, the Name, Description, number of items, and creation date of the bucket will appear at the top of the screen.
593 . Verify the list of users in the bucket and click *Delete all users*. A dialog box called _Delete all users_ will appear.
594 . Assign a _Name for delete set_.  This name will allow staff to identify the batch deletion for future verification or rollbacks.
595 . Click *Apply Changes*.  All users in the bucket will be marked as deleted.
596
597 NOTE: Batch deleting patrons from a user bucket does not use the Purge User functionality, but instead marks the users as deleted.
598
599 image::media/userbucket7.PNG[]
600
601 === View Batch Changes ===
602
603 . 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.
604 . Click *Buckets* to select an existing bucket.
605 . 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.
606 . Click *OK* to close the dialog box.
607
608 image::media/userbucket8.PNG[]
609
610 === Roll Back Batch Changes ===
611
612 . Batch Changes and Batch Deletions can be rolled back or reversed by going to *Circulation->User Buckets* and selecting the *Bucket View* tab.
613 . Click *Buckets* to select an existing bucket.
614 . 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_.
615
616 NOTE: Batch statistical category changes cannot be rolled back.
617
618 image::media/userbucket10.png[]
619
620 image::media/userbucket9.PNG[]
621
622 === Sharing Buckets ===
623 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.
624
625 image::media/userbucket11.PNG[]
626
627 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.
628
629 === Permissions ===
630
631 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.
632
633 Permissions for Batch Edits:
634
635 * 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.
636 * To make a batch changes to Profile Group, staff accounts must have the appropriate group application permissions for the profile groups.
637 * To make batch changes to the Home Library, staff accounts must have the UPDATE_USER permission at both the old and new Home Library.
638 * To make batch changes to the Barred Flag, staff accounts must have the appropriate BAR_PATRON or UNBAR_PATRON permission.
639
640 Permissions for Batch Deletion:
641
642 * 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.
643