docs/admin/lsa-barcode_completion.adoc

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