docs/floating_groups.txt

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