docs/admin/floating_groups.adoc

   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
  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
  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
  23 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.
  24
  25 Stop Depth
  26 ~~~~~~~~~~
  27
  28 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.
  29
  30 Max Depth
  31 ~~~~~~~~~
  32
  33 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.
  34
  35 Exclude
  36
  37 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.
  38
  39 Examples
  40 --------
  41
  42 Float Everywhere
  43 ~~~~~~~~~~~~~~~~
  44
  45 This is a default floating rule to emulate the previous floating behavior for new installs and upgrades.
  46
  47 One member:
  48
  49 * Org Unit: CONS
  50 * Stop Depth: 0
  51 * Max Depth: Unset
  52 * Exclude: Off
  53
  54 Float Within System
  55 ~~~~~~~~~~~~~~~~~~~
  56
  57 This would permit a copy to float anywhere within a system, but would return to the system if it was returned elsewhere.
  58
  59 One member:
  60
  61 * Org Unit: CONS
  62 * Stop Depth: 1
  63 * Max Depth: Unset
  64 * Exclude: Off
  65
  66 Float To All Branches
  67 ~~~~~~~~~~~~~~~~~~~~~
  68
  69 This would permit a copy to float to any branch, but not to sublibraries or bookmobiles.
  70
  71 One member:
  72
  73 * Org Unit: CONS
  74 * Stop Depth: 0
  75 * Max Depth: 2
  76 * Exclude: Off
  77
  78 Float To All Branches Within System
  79 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  80
  81 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.
  82
  83 One member:
  84
  85 * Org Unit: CONS
  86 * Stop Depth: 1
  87 * Max Depth: 2
  88 * Exclude: Off
  89
  90 Float Between BR1 and BR3
  91 ~~~~~~~~~~~~~~~~~~~~~~~~~
  92
  93 This would permit a copy to float between BR1 and BR3 specifically, excluding sublibraries and bookmobiles.
  94
  95 It would consist of two members, identical other than the org unit:
  96
  97 * Org Unit: BR1 / BR3
  98 * Stop Depth: 0
  99 * Max Depth: 2
 100 * Exclude: Off
 101
 102 Float Everywhere Except BM1
 103 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 104
 105 This would allow an item to float anywhere except for BM1. It accomplishes this with two members.
 106
 107 The first includes all org units, just like Float Everywhere:
 108
 109 * Org Unit: CONS
 110 * Stop Depth: 0
 111 * Max Depth: Unset
 112 * Exclude: Off
 113
 114 The second excludes BM1:
 115
 116 * Org Unit: BM1
 117 * Stop Depth: 0
 118 * Max Depth: Unset
 119 * Exclude: On
 120
 121 That works because excludes are applied first.
 122
 123 Float into, but not out of, BR2
 124 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 125
 126 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*.
 127
 128 One member:
 129
 130 * Org Unit: BR2
 131 * Stop Depth: 0
 132 * Max Depth: Unset
 133 * Exclude: Off