Configure scan engine settings
Last updated July 26th, 2023
Scan engine settings define the core Knox Capture behavior, such as how barcodes are scanned, and what happens with the data after each scan. The following settings are available:
Choose the barcode symbologies the scanner should recognize. For example, Code 39, and QR code. Available barcode types:
- Numeric-only (1D) — Codabar, EAN13, EAN8, Interleaved 2 of 5, UPCA, UPCE
- Alphanumeric (1D) — Code 128, Code 39, Code 93
- 2D — Data Matrix, PDF417, QR
Every barcode except Codabar and Code 93 is enabled by default.
Use scan settings to define how barcodes are scanned, selected, and parsed before Knox Capture sends them to a target business application.
Sets the primary capture mode for scanning. Available options:
- Single scan (default) — Scans and parses one barcode at a time.
- Multi scan — Detects multiple barcodes in the scan area at the same time.
Single scan preferences
Sets the way a user selects barcodes when interacting with the camera scanning UI in Single scan mode. Available options:
- Automatic (default) — Captures the first-detected barcode without additional user input.
- Aim and scan — Requires the user to aim the camera at a barcode and tap the Scan button to capture barcode data.
Toggle On to allow device users to scan several barcodes in sequence — and have each scan be registered as a single event — without having to press the camera trigger button between each scan.
Device users will see a Scan button in the camera preview window when they trigger a barcode scan. Device users can simply tap Scan each time they want to capture a new barcode. As each barcode is scanned, a counter in the top-left corner of the preview window gets updated. Once the user is finished scanning, they can click Done to close the camera preview window and return to the business app.
By default, this option is toggled Off.
Multi scan preferences
Sets the way a user selects barcodes when interacting with the camera scanning UI in Multi scan mode. Available options:
- Automatic (default) — Allows the user to scan multiple barcodes without having to press a Scan button.
- Batch — Lets the user scan multiple barcodes in a single camera frame using the Scan button.
- Aim and scan — Requires the user to aim the camera at a set of barcodes and tap the Scan button to capture the barcodes, one at a time.
- Tap to select — Lets a user aim the camera at multiple barcodes, freeze the scanning overlay, tap to select barcodes, and tap the Scan button to capture data from the selected barcodes.
Scan session limit
This defines the number of barcodes a user must scan before the camera preview window closes. A counter in the top-left corner of the preview window gets updated after each scan. Once the user has scanned the set number of barcodes, the camera preview window closes and the user returns to the business app. Users can exit the camera preview window at any time by tapping Done, regardless of the number of barcodes captured.
You can set any integer value. By default, this value is set to 0 to indicate infinite scans.
Beep after scan
Emits a beep sound after each barcode scan. This is toggled On by default.
Vibrate after scan
Vibrates the device after each barcode scan. This is toggled On by default.
Customize camera hardware and scanning UI options using the following settings:
Select the device camera — Front or Back — used for scanning. Set to Back camera by default.
Set whether to show a UI button in the camera preview window that allows users to turn the device flashlight on and off. Toggled On by default.
Set the factor by which the camera focus zooms in when scanning, from 1.0 (no zoom) to 4.0 (fully zoomed in). Set to 1.0 by default.
Refer to the following settings to change the camera UI overlay displaying around recognized barcodes when scanning:
Set the color inside the box highlighting a recognized barcode, represented as ARGB in HEX format. Set to 00000000 (transparent) by default.
Set the border color of the box highlighting the recognized barcode, represented as ARGB in HEX format. Set to FF1C7980 by default.
Set the border width of the box highlighting the recognized barcode in pixels. Set to 3 pixels by default.
Use the following settings to conditionally validate barcodes and highlight rejected barcodes:
Set a regular expression (regex) used to filter scanned barcodes. Only barcodes that match the provided regular expression will be accepted. Refer to this reference for details on crafting an expression. By default, no regex is set.
Highlight rejected code
Toggle on to enable an overlay in the camera preview window that appears around rejected codes. A Custom validation value must be set to enable this setting. This is toggled Off by default.
The visual cue is the viewfinder overlay centered in the camera scanning UI that focuses the user’s attention on a barcode. The size of the visual cue is the same size as of the actual scan area.
View finder selection
Define the shape of the visual cue that appears on or around an in-focus barcode:
- Rectangular (default) — Draws a rectangle around detected barcodes.
- Laser — Overlays a horizontal “laser” line over detected barcodes.
Rectangular viewfinder width
Set the width of the rectangular viewfinder, specified in screen width percentage. Only active if View finder selection is set to Rectangular. Available values are 0% to 100%. Default value is 90%.
Rectangular viewfinder height
Set the height of the rectangular viewfinder specified in screen height percentage. Only active if View finder selection is set to Rectangular. Available values are 0% to 100%. Default value is 40%.
Is this page helpful?
Thank you for your feedback!