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