Revert "LP#1332651 do not strip internal spaces in barcode"
[working/Evergreen.git] / docs / circulation / user_buckets.adoc
1 User buckets
2 ============
3
4 Introduction
5 ------------
6 indexterm:[patron buckets]
7 indexterm:[patrons, batch operations]
8
9 You can select and group a set of users into a User Bucket.
10 You can add users to a User Bucket from the Patron Search
11 interface or directly from the User Bucket interface by user barcode.
12 It is also possible to add users to a User
13 Bucket by uploading a text file that contains a list of user barcodes.
14
15 From this interface it is possible to perform a set of specific batch update
16 operations on the group of users you have identified.
17
18 Editing users
19 -------------
20 indexterm:[batch edit, patrons]
21
22 You can change the following fields in batch:
23
24  * Active flag
25  * Primary Permission Group (group application permissions consulted)
26  * Juvenile flag
27  * Home Library (if you have the UPDATE_USER permission for both the original and destination libraries)
28  * Privilege Expiration Date
29  * Barred flag (if you have the BAR_PATRON permission)
30  * Internet Access Level
31
32 NOTE: You will need the UPDATE_USER permission.
33
34 Each change set requires a name. Buckets may have multiple change sets. All
35 users in the Bucket at the time of processing are updated when the change
36 set is processed, and change sets are processed immediately upon successful
37 creation. The interface delivers progress information regarding the
38 processing stage and percent of completion.
39
40 While processing the users, the original value for each field edited is
41 recorded for potential future rollback. Users can examine the success and
42 failure of applied change sets.
43
44 The user will be able to rollback the entire change set, but not parts thereof.
45 The rollback will affect only those users that were successfully updated by the
46 original change set and may be different from the current set of users in the
47 Bucket. Users can manually discard change sets, removing them from the
48 interface but preventing future rollback.
49
50 As a batch process, rather than a direct edit, this mechanism explicitly skips
51 processing of Action/Trigger event definitions for user update, so users will
52 not receive any notifications that they might otherwise receive when their accounts
53 are edited.
54
55 Deleting users
56 --------------
57 indexterm:[batch delete, patrons]
58
59 You may also delete users as a batch.
60
61 NOTE: You will need the UPDATE_USER and DELETE_USER permissions.
62
63 Each delete set requires a name. Buckets may have multiple delete sets. All
64 users in the Bucket at the time of processing are marked as deleted when
65 the delete set is processed. The interface delivers progress information
66 regarding the processing stage and percent of completion.
67
68 While processing the users, the original value for the "deleted" field will be
69 recorded for potential future rollback. Users are able to examine the
70 success and failure of applied delete sets in the same interface used for the
71 above described change sets.
72
73 As a batch process, rather than a direct edit, this mechanism explicitly skips
74 processing of Action/Trigger event definitions for user deletion.
75
76 This mechanism does not completely purge the user from the database.  User data
77 will still be available to system administrators with database access.
78
79 Editing Statistical Category Entries
80 ------------------------------------
81
82 All users in the bucket can have their Statistical Category Entries
83 modified. Unlike user data field updates, modification of Statistical
84 Category Entries is permanent and cannot be rolled back. No named change
85 sets are required. The interface will deliver progress information regarding
86 the processing stage and percent of completion.
87
88 As a batch process, rather than a direct edit, this mechanism explicitly skips
89 processing of Action/Trigger event definitions for user update.
90