ca8f6e69a3378d6809e79ed6380ffa6cae81fae8
[working/Evergreen.git] / docs / admin / floating_groups.txt
1 :leveloffset: 1
2 Floating Groups
3 ===============
4
5 Before floating groups copies could float or not. If they floated then they floated everywhere, with no restrictions.
6
7 After floating groups where a copy will float is defined by what group it has been assigned to.
8
9 == Floating Groups
10
11 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.
12
13 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.
14
15 == Floating Group Members
16
17 Each member of a floating group references an org unit and has a stop depth, an optional max depth, and an exclude flag.
18
19 === Org Unit
20
21 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.
22
23 === Stop Depth
24
25 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.
26
27 === Max Depth
28
29 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.
30
31 === Exclude
32
33 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.
34
35 == Examples
36
37 === Float Everywhere
38
39 This is a default floating rule to emulate the previous floating behavior for new installs and upgrades.
40
41 One member:
42
43 * Org Unit: CONS
44 * Stop Depth: 0
45 * Max Depth: Unset
46 * Exclude: Off
47
48 === Float Within System
49
50 This would permit a copy to float anywhere within a system, but would return to the system if it was returned elsewhere.
51
52 One member:
53
54 * Org Unit: CONS
55 * Stop Depth: 1
56 * Max Depth: Unset
57 * Exclude: Off
58
59 === Float To All Branches
60
61 This would permit a copy to float to any branch, but not to sublibraries or bookmobiles.
62
63 One member:
64
65 * Org Unit: CONS
66 * Stop Depth: 0
67 * Max Depth: 2
68 * Exclude: Off
69
70 === Float To All Branches Within System
71
72 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.
73
74 One member:
75
76 * Org Unit: CONS
77 * Stop Depth: 1
78 * Max Depth: 2
79 * Exclude: Off
80
81 === Float Between BR1 and BR3
82
83 This would permit a copy to float between BR1 and BR3 specifically, excluding sublibraries and bookmobiles.
84
85 It would consist of two members, identical other than the org unit:
86
87 * Org Unit: BR1 / BR3
88 * Stop Depth: 0
89 * Max Depth: 2
90 * Exclude: Off
91
92 === Float Everywhere Except BM1
93
94 This would allow an item to float anywhere except for BM1. It accomplishes this with two members.
95
96 The first includes all org units, just like Float Everywhere:
97
98 * Org Unit: CONS
99 * Stop Depth: 0
100 * Max Depth: Unset
101 * Exclude: Off
102
103 The second excludes BM1:
104
105 * Org Unit: BM1
106 * Stop Depth: 0
107 * Max Depth: Unset
108 * Exclude: On
109
110 That works because excludes are applied first.
111
112 === Float into, but not out of, BR2
113
114 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*.
115
116 One member:
117
118 * Org Unit: BR2
119 * Stop Depth: 0
120 * Max Depth: Unset
121 * Exclude: Off 
122 :leveloffset: 0