UpcEanSupplementalMode Decoder Setting

RhoElements 2.x API

Overview

The UpcEanSupplementalMode Decoder Setting is used to set the upcEanSupplementalMode.

Syntax

upcEanSupplementalMode (Decoder Setting) <META> Syntax

<META HTTP-Equiv="scanner" content="upcEanSupplementalMode:[parameter]">

upcEanSupplementalMode JavaScript Object Syntax:
By default the JavaScript Object 'scanner' will exist on the current page and can be used to interact directly with the upcEanSupplementalMode.
To Set upcEanSupplementalMode parameters via JavaScript use the following syntax: scanner.Parameter = Value;

e.g. scanner.upcEanSupplementalMode = Value;

Parameters

Items listed in this section indicate parameters, or attributes which can be set.

NamePossible ValuesDescriptionDefault Value
upcEanSupplementalMode:[Value] See DescriptionDescribes the supplemental mode enabled. Possible values: none: Supplementals are ignored. auto: Auto-discriminates supplementals. always: Will not decode upc/ean without supplementals smart: The decoder will return the decoded value of the main block right away if it does not belong to any of the supplemental types. If the barcode starts with one of the prefixes it will search the image more aggressively for a supplemental. The scanner will try to scan the supplemental if it is present but if that fails, the main barcode will be returned. 378or379: Auto-discriminates supplemental for upc/ean codes starting with 378 or 379. Will disable reading of supplementals for any other upc/ean barcodes not starting with these values. The supplemental will be scanned if present but if scanning fails then the main barcode will be returned. 978or979: Auto-discriminates supplemental for upc/ean codes starting with 978 or 979. Will disable reading of supplementals for any other upc/ean barcodes not starting with these values. The supplemental will be scanned if present but if scanning fails then the main barcode will be returned. 414or419or434or439: Auto-discriminates supplemental for upc/ean codes starting with 414 or 419 or 434 or 439. Will disable reading of supplementals for any other upc/ean barcodes not starting with these values. The supplemental will be scanned if present but if scanning fails then the main barcode will be returned. Device specific

Remarks

Picklist mode

UPC EAN Supplemental mode is not compatible with picklist mode.

Requirements

RhoElements Version1.0.0 or above
Supported DevicesAll supported devices.
Minimum RequirementsScanner or Imager module and device that supports decoding upcEanSupplemental barcodes.
PersistenceTransient - Decoder settings are only guaranteed to persist until the Scanner is disabled

HTML/JavaScript Examples

The following will only read upc/ean codes with supplementals:

<META HTTP-Equiv="scanner" Content="allDecoders:enabled">
<META HTTP-Equiv="scanner" Content="upcEanSupplementalMode:always">
<META HTTP-Equiv="scanner" Content="enabled">

Above example can also be written as shown below:

<META HTTP-Equiv="scanner" Content="allDecoders:enabled;upcEanSupplementalMode:always;enabled">

or

<META HTTP-Equiv="scanner-allDecoders" Content="enabled">
<META HTTP-Equiv="scanner-upcEanSupplementalMode" Content="always">
<META HTTP-Equiv="scanner-enabled" Content="SCN1">