Table of Contents

<barCode> Element

This element contains a bar code definition.

Parent Elements

barCodes

Attributes

Name Type Description Required
format string The bar code format, which depends on syntax. See the remarks below for more information. Yes
syntax string The bar code syntax: Text or IsoIec15434Format06 No (defaults to Text)

Child Elements

None.

Remarks

Each potential bar code format that will be scanned by Acuit Pinpoint must be defined via one of these elements. For example, if units have a model number bar code and a separate serial number bar code, then two bar code formats must be configured. If units might also have a Data Matrix bar code that contains both the model number and serial number, then a third bar code format should be configured. Component types must have their bar code formats defined as well.

Multiple bar code syntaxes are supported to make it easier to define bar code formats. Each syntax has its own format that specifies how the raw bar code scan gets parsed to yield model and serial numbers.

The following names are used to identify captured numbers, regardless of the bar code syntax being used:

Capture Name Description
model A unit model number or a component model/part number.
serial A unit or component serial number.
unitModel A unit model number, encoded within a component bar code.

Model and serial number settings (see <modelNumber> Element and <serialNumber> Element) are also used to validate that the captured numbers before the bar code scans are accepted. For the most accurate bar code recognition, these number settings should always be defined as specifically as possible (especially the validNumber setting).

Syntaxes

The following bar code syntaxes are supported:

Text

This is the default syntax and is used if no syntax is specified.

The format can be any valid wildcard pattern, with the addition of number captures. Number captures are indicated via curly braces ({ and }) around the name of the number to capture (e.g., {model}). The number captures will capture any sequence of one or more characters, even spaces.

A regular expression pattern can also be specified for the bar code format by surrounding the format with slashes (/). The number captures should be specified using named capturing groups (e.g., (?<model>.+)). Normally, each regular expression pattern should start with ^ and end with $ to force the pattern to match the entire raw bar code scan. See Regular Expressions for more information.

A bar code format can contain a particular capture name included more than once. When matching against bar codes, only the last successful capture for that name will be used. (This is only for advanced scenarios and is not typically necessary.)

Note

Prefix and suffix characters added by the bar code scanner for every scan should not be included in the format. Only characters actually encoded within the bar codes should be included. Any prefix and suffix characters added by the bar code scanner should be configured in the bar code scanner configuration for Acuit Pinpoint Workstation.

IsoIec15434Format06

This syntax represents bar codes that contain data items encoded according to the ISO/IEC-15434 Format 06 specification. The content of an example bar code in this syntax is:

[)>␞06␝PAP1234-56␝S1234␞␄

In the above example:

  • ␝ = ASCII control character 1D (hex)
  • ␞ = ASCII control character 1E (hex)
  • ␄ = ASCII control character 04 (hex)
  • The first data item is:
    • Data identifier: P
    • Value: AP1234-56
  • The second data item is:
    • Data identifier: S
    • Value: 1234

The format for this bar code element should define how data items in the bar code are mapped to numbers using this syntax:

dataItemId1=numberName1;dataItemId2=numberName2;...

One or more items can be listed, separated by semi-colons. For example, for the above example bar code, the format could be defined like this:

P=model;S=serial

Note that when parsing bar codes, all data items defined by the format string must exist in the bar code for the bar code to accepted. However, extra data items in the bar code are ignored.

Examples

Simple Model Number Bar Code

Example raw scan: ABCD1234

format="{model}"

Yields:

  • Model: ABCD1234

Simple Serial Number Bar Code

Example raw scan: 12345678

format="{serial}"

Yields:

  • Serial: 12345678

Serial Number Bar Code with a Fixed "S" Prefix

Example raw scan: S12345678

format="S{serial}"

Yields:

  • Serial: 12345678

Single Bar Code with a Vendor-Specific Number, a Serial Number, and a Part Number, Separated by Spaces

Example raw scan: 1551D3C4 099003550587099 AP14904A-1

format="?* {serial} {model}"

Yields:

  • Model: AP14904A-1
  • Serial: 099003550587099

Data Matrix Bar Code with a Part Number and Serial Number Encoded According to ISO/IEC-15434 Format 06

Example raw scan: [)>␞06␝PAP14904A-1␝1P37C73U850P3␝S154203939␞␄

syntax="IsoIec15434Format06" format="P=model;S=serial"

The above format ignores extra data elements (e.g., the "1P" vendor part number).

Yields:

  • Model: AP14904A-1
  • Serial: 154203939