4 indexterm:[Barcode Completion,Lazy Circ]
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. This feature was also
9 known as *Lazy Circ* at one point.
11 This feature can also be used if there is a difference between what the
12 barcode scanner outputs and what is stored in the database, as long as the
13 barcode that is stored has more characters then what the scanner is
14 outputting. Barcode Completion is additive only, you cannot use it match a
15 stored barcode that has less characters than what is entered. For example, if
16 your barcode scanners previously output *a123123b* and now exclude the prefix
17 and suffix, you could match both formats using Barcode Completion rules.
19 Because this feature adds an extra database search for each enabled rule to
20 the process of looking up a barcode, it can add extra delays to the check-out
21 process. Please test in your environment before using in production.
23 *Released:* 2.2 - June 2012
25 Scoping and Permissions
26 ~~~~~~~~~~~~~~~~~~~~~~~
28 *Local Administrator* permission is needed to access the admin interface of the
29 Barcode Completion feature.
31 Each rule requires an owner org unit, which is how scoping of the rules is
32 handled. Rules are applied for staff users with the same org unit or
33 descendants of that org unit.
39 The admin interface for Barcode Completion is located under *Admin*
40 -> *Local Administration* -> *Barcode Completion*.
42 image::media/lsa-barcode_completion_admin.png[Barcode Completion Admin]
44 The barcode completion functionality is available at the following interfaces.
46 .For Actors (Users) Barcodes
47 * Lookup Patron by Barcode/Check Out.
48 * Optionally during check out if library setting "Load patron from Checkout"
49 is set. (Automatically detects if an actor/user barcode is scanned during
50 check out, and starts a new check out session using that user.)
51 * OPAC's Staff Client Place Hold.
53 .For Assets (Copy) Barcodes
56 * Item Status / Search for copies by Barcode / Show Item Status by Barcode.
58 NOTE: Barcode Completion does not work in the
59 *Search for Patron [by Name]* interface.
61 image::media/lsa-barcode_completion_accesspoints.png[Barcode Completion Access Points]
66 If multiple barcodes are matched, say if you have both "123" and "00000123"
67 as valid barcodes, you will receive a list of all the barcodes that match all
68 the rules that you have configured. It doesn't stop after the first rule
69 that matches, or after the first valid barcode is found.
71 image::media/lsa-barcode_completion_multiple.png[Barcode Completion Multiple Matches]
73 Barcode Completion Data Fields
74 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
76 The following data fields can be set for each Barcode Completion rule.
78 .Barcode Completion Fields
80 |*Active* | Check to indicate entry is active. *Required*
81 |*Owner* | Setting applies to this Org Unit and to all children. *Required*
82 |*Prefix* | Sequence that appears at the beginning of barcode.
83 |*Suffix* | Sequence that appears at the end of barcode.
84 |*Length* | Total length of barcode.
85 |*Padding* | Character that pads out non-unique characters in the barcode.
86 |*Padding At End* | Check if the padding starts at the end of the barcode.
87 |*Applies to Items*| Check if entry applies to item barcodes.
88 |*Applies to Users*| Check if entry applies to user barcodes.
94 Length and Padding are related, you cannot use one without the other. If a barcode
95 has to be a certain length, then it needs to be able to be padded out to that length.
96 If a barcode has padding, then we need to know the max length that we need to pad out
97 to. If length is set to blank or zero, or padding is left blank then they are both
101 .Applies to Items/Users
102 One or both of these options must be checked for the rule to have any effect.
104 image::media/lsa-barcode_completion_fields.png[Barcode Completion Data Fields]
106 Create, Update, Filter, Delete/Disable Rules
107 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
109 image::media/lsa-barcode_completion_admin.png[Barcode Completion Admin]
111 In the Barcode Completion admin interface at *Admin* -> *Local Administration*
112 -> *Barcode Completion* you can create, update and disable rules.
116 To create a new rule click on the *New* button in the upper right corner.
117 When you are are done with editing the new rule click the *Save* button. If
118 you want to cancel the new rule creation click the *Cancel* button.
122 To edit a rule double click on the rule in the main list.
126 It may be useful to filter the rules list if there are a large number of
127 rules. Click on the *filter* link to bring up the *Filter Results* dialog
128 box. You can filter on any of the data fields and you can setup multiple
129 filter rules. Click *Apply* to enable the filter rules, only the rows that match
130 will now be displayed.
132 To clear out the filter rules, delete all of the filter rules by clicking the
133 *X* next to each rule, and then click *Apply*.
137 It isn't possible to delete a rule from the database from the admin interface.
138 If a rule is no longer needed set *Active* to "False" to disable it. To keep
139 the number of rules down, reuse inactive rules when creating new rules.
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.
147 Barcode With Prefix and Padding
148 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
150 Barcode: *4545000123*
152 To match this 10 character barcode by only typing in *123* we need the
156 * *Owner* - Set to your org unit.
157 * *Prefix* - 4545 - This is the prefix that the barcode starts with.
158 * *Length* - 10 - Total length of the barcode.
159 * *Padding* - 0 - Zeros will be used to pad out non significant parts of the barcode.
160 * *Applies to Items* and/or *Applies to Users* - Checked
162 The system takes the *123* that you entered and adds the prefix to the beginning
163 of it. Then adds zeros between the prefix and your number to pad it out to
164 10 characters. Then it searches the database for that barcode.
169 Barcode: *123000book*
171 To match this 10 character barcode by only typing in *123* we need the
175 * *Owner* - Set to your org unit.
176 * *Suffix* - book - This is the suffix that the barcode ends with.
177 * *Length* - 10 - Total length of the barcode.
178 * *Padding* - 0 - Zeros will be used to pad out non significant parts of the barcode.
179 * *Padding at End* - Checked
180 * *Applies to Items* and/or *Applies to Users* - Checked
182 The system takes the *123* that you entered and adds the suffix to the end of it.
183 Then adds zeros between your number and the suffix to pad it out to 10
184 characters. Then it searches the database for that barcode.
186 Barcode With Left Padding
187 ^^^^^^^^^^^^^^^^^^^^^^^^^
189 Barcode: *0000000123*
191 To match this 10 character barcode by only typing in *123* we need the
195 * *Owner* - Set to your org unit.
196 * *Length* - 10 - Total length of the barcode.
197 * *Padding* - 0 - Zeros will be used to pad out non significant parts of the barcode.
198 * *Applies to Items* and/or *Applies to Users* - Checked
200 The system takes the *123* that you entered, then adds zeros between your
201 number and the left to pad it out to 10 characters. Then it searches the
202 database for that barcode.
204 Barcode With Right Padding
205 ^^^^^^^^^^^^^^^^^^^^^^^^^^
207 Barcode: *1230000000*
209 To match this 10 character barcode by only typing in *123* we need the
213 * *Owner* - Set to your org unit.
214 * *Length* - 10 - Total length of the barcode.
215 * *Padding* - 0 - Zeros will be used to pad out non significant parts of the barcode.
216 * *Padding at End* - Checked
217 * *Applies to Items* and/or *Applies to Users* - Checked
219 The system takes the *123* that you entered, then adds zeros between your
220 number and the right to pad it out to 10 characters. Then it searches the
221 database for that barcode.
223 Barcode of any Length with Prefix and Suffix
224 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
228 To match this 5 character barcode by only typing in *123* we need the
229 following settings. This use of Barcode Completion doesn't save many
230 keystrokes, but it does allow you to handle the case where your barcode
231 scanners at one point were set to output a prefix and suffix which was stored
232 in the database. Now your barcode scanners no longer include the prefix and suffix.
233 These settings will simply add the prefix and suffix to any barcode entered and
237 * *Owner* - Set to your org unit.
238 * *Length/Padding* - 0/null - Set the length to 0 and/or leave the padding blank.
239 * *Prefix* - a - This is the prefix that the barcode starts with.
240 * *Suffix* - b - This is the suffix that the barcode starts with.
241 * *Applies to Items* and/or *Applies to Users* - Checked
243 The system takes the *123* that you entered, then adds the prefix and suffix
244 specified. Then it searches the database for that barcode. Because no length
245 or padding was entered, this rule will add the prefix and suffix to any
246 barcode that is entered and then search for that valid barcode.
252 To test this feature, setup the rules that you want, then setup items/users
253 with barcodes that should match. Then try scanning the short version of
254 those barcodes in the various supported access points.