Barcode Reader plugin

The Barcode Reader plugin is used to read bar codes from the input images using zxing. The Barcode Reader plugin supports the following bar code types:

  • CODE39

  • QR

  • DATAMATRIX

  • PDF417

  • CODE128

  • CODE93

  • ITF

  • CODABAR

  • EAN13

For any bar code detected on the images using the Barcode Reader plugin, the decoded value is considered as the document type name for the bar code classification in Document Assembler.

Bar code values should match the document type values configured in the batch class that uses this plugin.

Configuration

The following table lists the configurable properties for the plugin.

Configurable property

Type of value

Value options

Description

Barcode Valid Extensions

String

  • tif

  • gif

These are the valid extensions of the input image files for decoding the bar code.

Barcode Max Confidence

Integer

N/A

This sets the maximum confidence threshold for decoding bar codes.

Barcode Min Confidence

Integer

N/A

This sets the minimum confidence threshold for decoding bar codes.

Barcode Classification Switch

String

  • ON

  • OFF

This switch enables or disables the Barcode Reader classification.

Default: ON

Barcode Reader Type

String

  • CODE39

  • QR

  • DATAMATRIX

  • PDF417

  • CODE128

  • CODE93

  • ITF

  • CODABAR

  • EAN13

These values are used to decode the bar code type using the bar code reader plugin.

Steps of execution

  • This plugin operates in the page process phase of the application when all import processing on the batch has been completed, and it is ready for page processing.

  • The plugin decodes the bar codes from the input images.

  • Upon completion, the decoded bar code information is written into the batch.xml file.

Dependency

The plugin assumes that the import processing of the batch has been completed correctly, after which it decodes the bar codes from the input images.

Troubleshooting

If a malfunction occurs with the Barcode Reader plugin, the following error messages may appear.

Error message

Possible root cause

No pages found in batch XML.

Invalid Batch.xml present in Batch Instance folder.

No valid extensions are specified in resources.

No valid barcode extensions found in the database.

File {image name} has invalid extension.

Specified image file has invalid file extension for processing with the Barcode Reader plugin.