Docs 2.5: Fix floating groups heading level (2nd try)
[working/Evergreen.git] / docs / admin / floating_groups.txt
1 Floating Groups
2 ===============
3
4 Before floating groups copies could float or not. If they floated then they floated everywhere, with no restrictions.
5
6 After floating groups where a copy will float is defined by what group it has been assigned to.
7
8 == Floating Groups
9
10 Each floating group comes with a name and a manual flag, plus zero or more group members. The name is used solely for selection and display purposes.
11
12 The manual flag dictates whether or not the "Manual Floating Active" checkin modifier needs to be active for a copy to float. This allows for greater control over when items float. It also prevents automated checkins via SIP2 from triggering floats.
13
14 == Floating Group Members
15
16 Each member of a floating group references an org unit and has a stop depth, an optional max depth, and an exclude flag.
17
18 === Org Unit
19
20 The org unit and all descendants are included, unless max depth is set, in which case the tree is cut off at the max depth.
21
22 === Stop Depth
23
24 The stop depth is the highest point from the current copy circ library to the checkin library for the item that will be traversed. If the item has to go higher than the stop depth on the tree the member rule in question is ignored.
25
26 === Max Depth
27
28 As mentioned with the org unit, the max depth is the furthest down on the tree from the org unit that gets included. This is based on the entire tree, not just off of the org unit. So in the default tree a max depth of 1 will stop at the system level no matter if org unit is set to CONS or SYS1.
29
30 === Exclude
31
32 Exclude, if set, causes floating to not happen for the member. Excludes always take priority, so you can remove an org unit from floating without having to worry about other rules overriding it.
33
34 == Examples
35
36 === Float Everywhere
37
38 This is a default floating rule to emulate the previous floating behavior for new installs and upgrades.
39
40 One member:
41
42 * Org Unit: CONS
43 * Stop Depth: 0
44 * Max Depth: Unset
45 * Exclude: Off
46
47 === Float Within System
48
49 This would permit a copy to float anywhere within a system, but would return to the system if it was returned elsewhere.
50
51 One member:
52
53 * Org Unit: CONS
54 * Stop Depth: 1
55 * Max Depth: Unset
56 * Exclude: Off
57
58 === Float To All Branches
59
60 This would permit a copy to float to any branch, but not to sublibraries or bookmobiles.
61
62 One member:
63
64 * Org Unit: CONS
65 * Stop Depth: 0
66 * Max Depth: 2
67 * Exclude: Off
68
69 === Float To All Branches Within System
70
71 This would permit a copy to float to any branch in a system, but not to sublibraries or bookmobiles, and returning to the system if returned elsewhere.
72
73 One member:
74
75 * Org Unit: CONS
76 * Stop Depth: 1
77 * Max Depth: 2
78 * Exclude: Off
79
80 === Float Between BR1 and BR3
81
82 This would permit a copy to float between BR1 and BR3 specifically, excluding sublibraries and bookmobiles.
83
84 It would consist of two members, identical other than the org unit:
85
86 * Org Unit: BR1 / BR3
87 * Stop Depth: 0
88 * Max Depth: 2
89 * Exclude: Off
90
91 === Float Everywhere Except BM1
92
93 This would allow an item to float anywhere except for BM1. It accomplishes this with two members.
94
95 The first includes all org units, just like Float Everywhere:
96
97 * Org Unit: CONS
98 * Stop Depth: 0
99 * Max Depth: Unset
100 * Exclude: Off
101
102 The second excludes BM1:
103
104 * Org Unit: BM1
105 * Stop Depth: 0
106 * Max Depth: Unset
107 * Exclude: On
108
109 That works because excludes are applied first.
110
111 === Float into, but not out of, BR2
112
113 This would allow an item to float into BR2, but once there it would never leave. Why you would want to allow items to float to but not from a single library I dunno, but here it is. This takes advantage of the fact that the rules say where we can float *to*, but outside of stop depth don't care where we are floating *from*.
114
115 One member:
116
117 * Org Unit: BR2
118 * Stop Depth: 0
119 * Max Depth: Unset
120 * Exclude: Off