docs/modules/admin/pages/lsa-barcode_completion.adoc

   1 = Barcode Completion =
   2 :toc:
   3
   4 indexterm:[Barcode Completion,Lazy Circ]
   5
   6 The Barcode Completion feature gives users the ability to only enter the
   7 unique part of patron and item barcodes.  This can significantly reduce the
   8 amount of typing required for manual barcode input.
   9
  10 This feature can also be used if there is a difference between what the
  11 barcode scanner outputs and what is stored in the database, as long as the
  12 barcode that is stored has more characters then what the scanner is
  13 outputting. Barcode Completion is additive only; you cannot use it to match a
  14 stored barcode that has less characters than what is entered. For example, if
  15 your barcode scanners previously output *a123123b* and now exclude the prefix
  16 and suffix, you could match both formats using Barcode Completion rules.
  17
  18 Because this feature adds an extra database search for each enabled rule to
  19 the process of looking up a barcode, it can add extra delays to the check-out
  20 process.  Please test in your environment before using in production.
  21
  22 == Scoping and Permissions ==
  23
  24 *Local Administrator* permission is needed to access the admin interface of the
  25 Barcode Completion feature.
  26
  27 Each rule requires an owner org unit, which is how scoping of the rules is
  28 handled.  Rules are applied for staff users with the same org unit or
  29 descendants of that org unit.
  30
  31
  32 == Access Points ==
  33
  34 The admin interface for Barcode Completion is located under *Administration*
  35 -> *Local Administration* -> *Barcode Completion*.
  36
  37 image::media/lsa-barcode_completion_admin.png[Barcode Completion Admin List]
  38
  39 The barcode completion functionality is available at the following interfaces.
  40
  41 === Check Out Step 1: Lookup Patron by Barcode ===
  42
  43 image::media/Barcode_Checkout_Patron_Barcode.png[Patron Barcode Lookup for Checking Out]
  44
  45 === Check Out Step 2: Scanning Item Barcodes ===
  46
  47 image::media/Barcode_Checkout_Item_Barcode.png[Item Barcode at Check Out]
  48
  49 === Staff Client Place Hold from Catalog ===
  50
  51 image::media/Barcode_OPAC_Staff_Place_Hold.png[Patron Barcode Lookup for Staff Placing Hold]
  52
  53 === Check In ===
  54
  55 image::media/Barcode_Check_In.png[Item Barcode at Check In]
  56
  57 === Item Status ===
  58
  59 image::media/Barcode_Item_Status.png[Item Barcode at Item Status screen]
  60
  61
  62 NOTE: Barcode completion is also available during check out if library
  63 setting "Load patron from Checkout" is set.
  64 (Automatically detects if an actor/user barcode is scanned during
  65 check out, and starts a new check out session using that user.)
  66
  67 NOTE: Barcode Completion does not work in the
  68  *Search for Patron [by Name]* interface.
  69
  70
  71 == Multiple Matches ==
  72
  73 If multiple barcodes are matched, say if you have both "123" and "00000123"
  74 as valid barcodes, you will receive a list of all the barcodes that match all
  75 the rules that you have configured.  It doesn't stop after the first rule
  76 that matches, or after the first valid barcode is found.
  77
  78 image::media/lsa-barcode_completion_multiple.png[Barcode Completion Multiple Matches]
  79
  80 == Barcode Completion Data Fields ==
  81
  82 The following data fields can be set for each Barcode Completion rule.
  83
  84 .Barcode Completion Fields
  85 |=======
  86 |*Active*          | Check to indicate entry is active. *Required*
  87 |*Owner*           | Setting applies to this Org Unit and to all children. *Required*
  88 |*Prefix*          | Sequence that appears at the beginning of barcode.
  89 |*Suffix*          | Sequence that appears at the end of barcode.
  90 |*Length*          | Total length of barcode.
  91 |*Padding*         | Character that pads out non-unique characters in the barcode.
  92 |*Padding At End*  | Check if the padding starts at the end of the barcode.
  93 |*Applies to Items*| Check if entry applies to item barcodes.
  94 |*Applies to Users*| Check if entry applies to user barcodes.
  95 |=======
  96
  97
  98 .Length and Padding
  99
 100 Length and Padding are related, you cannot use one without the other.  If a barcode
 101 has to be a certain length, then it needs to be able to be padded out to that length.
 102 If a barcode has padding, then we need to know the max length that we need to pad out
 103 to.  If length is set to blank or zero, or padding is left blank then they are both
 104 ignored.
 105
 106
 107 .Applies to Items/Users
 108 One or both of these options must be checked for the rule to have any effect.
 109
 110 image::media/lsa-barcode_completion_fields.png[Barcode Completion Data Fields]
 111
 112 == Create, Update, Filter, Delete/Disable Rules ==
 113
 114 image::media/lsa-barcode_completion_admin.png[Barcode Completion Admin]
 115
 116 In the Barcode Completion admin interface at *Administration* -> *Local Administration*
 117 -> *Barcode Completion* you can create, update and disable rules.
 118
 119 === Create Rules ===
 120 To create a new rule click on the *New* button in the upper right corner.
 121 When you are are done with editing the new rule click the *Save* button.  If
 122 you want to cancel the new rule creation click the *Cancel* button.
 123
 124 === Update Rules ===
 125 To edit a rule double click on the rule in the main list.
 126
 127 === Filter Rules ===
 128 It may be useful to filter the rules list if there are a large number of
 129 rules.  Click on the *filter* link to bring up the *Filter Results* dialog
 130 box.  You can filter on any of the data fields and you can setup multiple
 131 filter rules.  Click *Apply* to enable the filter rules, only the rows that match
 132 will now be displayed.
 133
 134 To clear out the filter rules, delete all of the filter rules by clicking the
 135 *X* next to each rule, and then click *Apply*.
 136
 137 === Delete/Disable Rules ===
 138 It isn't possible to delete a rule from the database from the admin interface.
 139 If a rule is no longer needed set *Active* to "False" to disable it.  To keep
 140 the number of rules down, reuse inactive rules when creating new rules.
 141
 142 == Examples ==
 143
 144 In all these examples, the unique part of the barcode is *123*.  So that is
 145 all that users will need to type to match the full barcode.
 146
 147 === Barcode With Prefix and Padding ===
 148
 149 Barcode: *4545000123*
 150
 151 To match this 10 character barcode by only typing in *123* we need the
 152 following settings.
 153
 154  * *Active* - Checked
 155  * *Owner* - Set to your org unit.
 156  * *Prefix* - 4545 - This is the prefix that the barcode starts with.
 157  * *Length* - 10 - Total length of the barcode.
 158  * *Padding* - 0 - Zeros will be used to pad out non significant parts of the barcode.
 159  * *Applies to Items* and/or *Applies to Users* - Checked
 160
 161 The system takes the *123* that you entered and adds the prefix to the beginning
 162 of it.  Then adds zeros between the prefix and your number to pad it out to
 163 10 characters.  Then it searches the database for that barcode.
 164
 165 === Barcode With Suffix ===
 166
 167 Barcode: *123000book*
 168
 169 To match this 10 character barcode by only typing in *123* we need the
 170 following settings.
 171
 172  * *Active* - Checked
 173  * *Owner* - Set to your org unit.
 174  * *Suffix* - book - This is the suffix that the barcode ends with.
 175  * *Length* - 10 - Total length of the barcode.
 176  * *Padding* - 0 - Zeros will be used to pad out non significant parts of the barcode.
 177  * *Padding at End* - Checked
 178  * *Applies to Items* and/or *Applies to Users* - Checked
 179
 180 The system takes the *123* that you entered and adds the suffix to the end of it.
 181 Then adds zeros between your number and the suffix to pad it out to 10
 182 characters.  Then it searches the database for that barcode.
 183
 184 === Barcode With Left Padding ===
 185
 186 Barcode: *0000000123*
 187
 188 To match this 10 character barcode by only typing in *123* we need the
 189 following settings.
 190
 191  * *Active* - Checked
 192  * *Owner* - Set to your org unit.
 193  * *Length* - 10 - Total length of the barcode.
 194  * *Padding* - 0 - Zeros will be used to pad out non significant parts of the barcode.
 195  * *Applies to Items* and/or *Applies to Users* - Checked
 196
 197 The system takes the *123* that you entered, then adds zeros between your
 198 number and the left to pad it out to 10 characters.  Then it searches the
 199 database for that barcode.
 200
 201 === Barcode With Right Padding ===
 202
 203 Barcode: *1230000000*
 204
 205 To match this 10 character barcode by only typing in *123* we need the
 206 following settings.
 207
 208  * *Active* - Checked
 209  * *Owner* - Set to your org unit.
 210  * *Length* - 10 - Total length of the barcode.
 211  * *Padding* - 0 - Zeros will be used to pad out non significant parts of the barcode.
 212  * *Padding at End* - Checked
 213  * *Applies to Items* and/or *Applies to Users* - Checked
 214
 215 The system takes the *123* that you entered, then adds zeros between your
 216 number and the right to pad it out to 10 characters.  Then it searches the
 217 database for that barcode.
 218
 219 === Barcode of any Length with Prefix and Suffix ===
 220
 221 Barcode: *a123b*
 222
 223 To match this 5 character barcode by only typing in *123* we need the
 224 following settings.  This use of Barcode Completion doesn't save many
 225 keystrokes, but it does allow you to handle the case where your barcode
 226 scanners at one point were set to output a prefix and suffix which was stored
 227 in the database.  Now your barcode scanners no longer include the prefix and suffix.
 228 These settings will simply add the prefix and suffix to any barcode entered and
 229 search for that.
 230
 231  * *Active* - Checked
 232  * *Owner* - Set to your org unit.
 233  * *Length/Padding* - 0/null - Set the length to 0 and/or leave the padding blank.
 234  * *Prefix* - a - This is the prefix that the barcode starts with.
 235  * *Suffix* - b - This is the suffix that the barcode starts with.
 236  * *Applies to Items* and/or *Applies to Users* - Checked
 237
 238 The system takes the *123* that you entered, then adds the prefix and suffix
 239 specified.  Then it searches the database for that barcode.  Because no length
 240 or padding was entered, this rule will add the prefix and suffix to any
 241 barcode that is entered and then search for that valid barcode.
 242
 243
 244 == Testing ==
 245
 246 To test this feature, setup the rules that you want, then setup items/users
 247 with barcodes that should match.  Then try scanning the short version of
 248 those barcodes in the various supported access points.