Back to top
Home / Knox Capture / How-to-guides /

Configure scan engine settings

Last updated December 13th, 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:

Barcode types

Choose the barcode symbologies the scanner should recognize. For example, Code 39, and QR code. Available barcode types:

Type Options
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.

Scanning settings

Use scan settings to define how barcodes are scanned, selected, and parsed before Knox Capture sends them to a target business application.

Scan mode

Sets the primary capture mode for scanning. Available options:

Setting Option
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:

Setting Options
Barcode selection
  • 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.
Continuous scanning
  • Off (default)
  • On — 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.1

1 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.

Multi scan preferences

Sets the way a user selects barcodes when interacting with the camera scanning UI in Multi scan mode. Available options:

Setting Options
Barcode selection
  • 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.

Camera settings

Customize camera hardware and scanning UI options using the following settings:

Setting Options
Default Camera
  • Back (default)
  • Front
Flashlight
  • Off (default) — When a scan is triggered, the flashlight is turned off. A flashlight button is provided in the preview, and the button is off.
  • On — When a scan is triggered, the flashlight is automatically turned on. A flashlight button is provided in the preview, and the button is on.
  • Auto2 — When a scan is triggered, the device automatically monitors the light level to turn the flashlights ON and OFF. A flashlight button is not provided in the preview.
Zoom factor Any value from 1.0 (no zoom) to 4.0 (fully zoomed in). Default value is 1.0.

2 Flashlight Auto is not available in Knox Capture: Scandit Edition.

Barcode highlighting

Refer to the following settings to change the camera UI overlay displaying around recognized barcodes when scanning:

Setting Description
Fill color Set the color inside the box highlighting a recognized barcode, represented as ARGB in HEX format. Set to 00000000 (transparent) by default.
Stroke color Set the border color of the box highlighting the recognized barcode, represented as ARGB in HEX format. Set to FF1C7980 by default.
Stroke width Set the border width of the box highlighting the recognized barcode in pixels. Set to 3 pixels by default.

Advanced settings

Extended barcode type settings

Use these settings to configure each barcode type used in a Knox Capture profile. Access these settings by tapping Advanced settings near the bottom of the scan engine settings menu, then tap Extended barcode type settings to display a list of all barcode types. Tap a barcode type to view the available extended barcode type settings. The following table describes the possible settings that may appear:

Setting Options
Inverted color recognition (all barcode types)
  • Off (default)
  • On
Return as UPCA (only available for UPCE)
  • Off (default)
  • On

Barcode filtering

Use the following settings to conditionally validate barcodes and highlight rejected barcodes:

Setting Options
Custom validation 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.

Visual cue

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.

Setting Options
View finder selection
  • 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%.

On this page

Is this page helpful?