Zebra Parsing User manual

1 | P a g e Data Parsing on Zebra Scanners Zebra Technologies – v2

Data Parsing on Zebra Scanners

2 | P a g e Data Parsing on Zebra Scanners Zebra Technologies – v2

Overview

This document explains how to program and demonstrate data parsing on Zebra handheld scanners. Zebra’s Data Parsing technology supports the following industry solutions.

1. UDI Parsing (UDI Scan+: GS1, HIBBC and ICCBBA)

2. Label Parsing (Label Parse+ for GS1 labels)

3. Blood Bag Parsing ISBT 128 (Blood Bag Parse+)

This document can also be left with a customer to kick start their compliance testing.

Note. This document does not cover Zebra’s USA Driver’s License Parsing solution.

What is Data Parsing

Data Parsing allows a Zebra scanner to scan a UDI label or GS1 label or Blood Bags with one or more barcodes encoded with multiple data fields (date of manufacture, expiration date, batch number, GTIN, SSCC …) and transmit select data fields and not others, in a specific order to a host application. Simply wave the scanner over all the barcodes while holding the trigger and the scanner will take care of the rest. The scanner will find and transmit only the required data fields, even if they are spread across multiple barcodes and on different sides of the container. In addition, the scanner can insert field separators (tab, enter, slash …) to automate data entry into a host application.

Programming your scanner is easy using 123Scan’s intuitive drag and drop interface. To watch a video on Creating a Data Parsing Rule using 123Scan, go to:

http://www.zebra.com/ScannerHowToVideos

Scan a UDI Label using UDI Scan+

Government regulatory agencies* have established Unique Device Identification (UDI) standards to identify and monitor the distribution and use of medical devices within healthcare environments. These UDI standards identify medical devices from manufacturing through distribution to patient use enabling complete traceability of the millions of individual medical devices utilized for patient care. To

enable UDI compliance, all medical devices must carry a UDI label to enable “track and trace” from the

point of production, during shipment, through the product’s use and disposal.

* United States Food and Drug Administration (FDA), European Commission, International Medical Device Regulatory Forum

Scan a GS1 Label using Label Parse+

The GS1 Organization, an international standards body, has released specifications used worldwide for generating shipping labels. These labels are used when shipping packages (logistics), raw materials and produce.

For additional information see https://www.gs1.org/docs/tl/GS1_Logistic_Label_Guideline.pdf

Scan a Blood Bag Label using Blood Bag Parse+

For additional information see https://www.iccbba.org/tech-library/iccbba-documents/standards-

documents/standard-labeling-blood2

3 | P a g e Data Parsing on Zebra Scanners Zebra Technologies – v2

Required Equipment

The following is required to demonstrate data parsing on a Zebra Scanner.

1. 123Scan, scanner configuration utility. See Appendix B for details.

2. A Zebra scanner like the DS8108 or DS8178.

3. This document, “Data Parsing User Guide.doc”.

How to Use This Document

1. Watch the Data Parsing how to video a. www.zebra.com/ScannerHowToVideos b. Video Name: Zebra 123Scan: Creating a Data Parsing Rule (UDI, GS1 Label, Blood Bag)

Its grouped with the other 123Scan videos.

2. Update your DS8108/DS8178 scanner to the latest firmware. See Appendix B for details.

3. Program a data parsing rule. See Example 1 through 16 for step by step instructions in Appendix A.

4. Close 123Scan

5. Launch Microsoft’s Notepad. Place the mouse’s cursor within the Notepad window.

6. Scan the UDI/GS1/Blood Bag barcode from the examples below. a. UDI Parsing : Example 1 – 10 b. GS1 Label Parsing : Example 11 – 13 c. ADF Modify Data Parsed Output : Example 14 d. Blood Bag Parsing : Example 15 – 17

4 | P a g e Data Parsing on Zebra Scanners Zebra Technologies – v2

Table of Contents

Overview

1. What is Zebra’s Data Parsing Technology

2. What is a GS1 Label

3. What is Unique Device Identification (UDI) Label

4. What is a Blood Bag (ISBT 128) Label

5. What Zebra Scanners Support Data Parsing technology

General

6. Where can I get a complete list of GS1 data fields

7. Can an untrained user scan data parsing capable barcodes

8. What is the difference between MDF and data parsing

9. Can I scan all the data fields within multiple barcodes in one trigger pull

10. What if the required data fields are spread across both 1D and 2D barcodes

11. What does a GS1 barcode that supports data parsing look like

12. How do I scan into different screens in a host application

13. What is output if I scan a data parsing enabled barcode that lacks ALL the required data fields

14. Does data parsing support both handheld (triggered) and handsfree (presentation) scanning

15. How many data parsing rules can be programmed on a scanner

16. How many barcodes can be scanned from a UDI Label / GS1 Label / Blood Bag Label

17. How many data fields can be programmed within a single data parsing rule

18. How many separator fields can be inserted between two data fields

19. Can data parsing be enable / disabled by my application

20. Can an AIM Code ID be used when Data Parsing

21. Can a Function Key(s) Be Inserted Using ADF into Data Parsed Output

22. What data fields can have their date format modified by the scanner

23. What If I scan a new, previously undocumented or incorrectly formatted data field

123Scan

24. How is a scanner programmed to perform data parsing

25. Can the order of output data fields be programed in 123Scan

26. How long do I have to find all the barcodes (data fields) on the label

27. Can my data parsing programmed scanner scan regular barcodes

28. What if one required data field on a label is not present

29. Retrieving a data parsing rule from a scanner

30. Can a data parsing rule be programmed through Remote Management

UDI

31. What UDI standards are supported by Zebra Scanners

32. What are the most common UDI data fields tracked by hospitals

33. What GS1 / HIBCC / ICCBBA UDI output options are available within 123Scan

34. What HIBCC Data Field Identifiers can be scanned

35. What scanner parameters must be enabled to scan UDI properly

Blood Bag

36. What ISBT 128 Blood Bag fields are tracked by hospitals

37. What is the “Blood Bag Parsing Session Timeout”

38. Settings for scanning optional barcodes, that are not always present on the label

39. What scanner parameters must be enabled to scan blood bags

Trouble Shooting

40. The Data Matrix (GS1) output is not correct

41. The QR Code (GS1) output is not correct

42. Blood Bag scanning and ICCBBA UDI Scanning are not working correctly

5 | P a g e Data Parsing on Zebra Scanners Zebra Technologies – v2

43. In HID Keyboard, the Tab and / or Enter key is not recognized by your App

44. What options are available under “Other Settings”

1. Overview - What is Zebra’s Data Parsing Technology

(tab, enter, slash …) to automate data entry into a host application.

Programming your scanner is easy using 123Scan’s intuitive drag and drop interface.

To watch a video on Creating a Data Parsing Rule using 123Scan, go to:

http://www.zebra.com/ScannerHowToVideos

2. Overview - What is a GS1 Label

For a complete list of GS1 data fields (application identifiers – AI) click

https://www.gs1.org/standards/barcodes/application-identifiers?lang=en

3. Overview - What is Unique Device Identification (UDI) Label

enable UDI compliance, all medical devices must carry a UDI label to enable “track and trace” from the point of production, during shipment, through the product’s use and disposal.

* United States Food and Drug Administration (FDA), European Commission, International Medical Device Regulatory Forum

4. Overview - What is a Blood Bag (ISBT 128) Label

The ICCBBA Organization, an international standards body, has released a specification used worldwide for generating blood bag labels. These labels are used when shipping, storing and using blood bags. For additional information see https://www.iccbba.org/tech-library/iccbba-documents/standards-

documents/standard-labeling-blood2

5. Overview - What Zebra Scanners Support Data Parsing technology

Select 2D imaging scanners support Zebra’s Data Parsing technology.

• DS8108 All Configurations* 10.21.20 firmware update required – Healthcare

• DS8178 All Configurations* 10.21.20 firmware update required – Healthcare

• CS6080 All Configurations* 10.01.20 Ships functional from factory

6 | P a g e Data Parsing on Zebra Scanners Zebra Technologies – v2

• DS9908 All Configurations* Q4 ‘20 firmware update required – Healthcare

• DS9308 All Configurations* Q4 ‘20 firmware update required – Healthcare

• DS4608 All Configurations* Q4 ’20 firmware update required – Healthcare

• DS3608 All Configurations* Q4 ‘20/Q1 ‘21 firmware update required – Mfg. / T&L

• DS3678 All Configurations* Q4 ‘20/Q1 ‘21 firmware update required – Mfg. / T&L

* To confirm presence in the firmware, see 123Scan release notes. Data Parsing capability will be called out as “Added 1) UDI Parsing / Scan+; 2) Label Parsing / Parse+ for GS1; 3) Blood Bag Parsing / Parse+”

6. General - Where can I get a complete list of GS1 data fields

For a complete list of GS1 data fields (application identifiers – AI), click this link from the GS1 Organization’s website: https://www.gs1.org/standards/barcodes/application-identifiers?lang=en

7. General - Can an untrained user scan data parsing capable barcodes

Yes, just point the scanner at the desired UDI, GS1 Labeling barcode(s) and pull the trigger. The scanner will automatically decode all the barcodes within the field of view in one trigger pull. Alternatively, if the barcodes are on opposite sides of a box, the user can keep the trigger depressed, while aiming at one barcode then the next to capture all the barcodes. The scanner will accumulate the data and output it.

8. General - What is the difference between MDF and data parsing

MDF allows a scanner to scan multiple barcodes in one trigger pull and each barcode can only contain one data field. For example, 3 barcodes could contain 3 data fields (3 pieces of information). The barcodes must also be unique in some way, different symbology, different length …

Data parsing allows a scanner to scan one to many barcodes in one trigger pull, but each barcode can contain more than one data field. For example, 3 barcodes could contain 10 data fields (10 pieces of information). Unlike MDF, the barcodes are not required to be unique, they can be the same symbology and the same length.

9. General - Can I scan all the data fields within multiple barcodes in one trigger pull

Yes. In an industry first, Zebra’s Data Parsing solution solves this problem. Simply wave the scanner over all the barcodes while holding the trigger and the scanner will take care of the rest. The scanner will find and transmit only the required data fields, even if they are spread across multiple barcodes and on different sides of the container. In addition, the scanner can insert field separators

(tab, enter, slash …) to automate data entry into a host application. Programming your scanner is easy using 123Scan’s intuitive drag and drop interface.

10. General - What if the required data fields are spread across both 1D and 2D barcodes

Zebra’s Data Parsing solution is focused on data fields. If part of the required data fields are in a 1D

barcode but the remaining data fields are in a 2D barcode, the scanner will capture and output all the required data fields even though they are spread across multiple barcode and symbologies.

7 | P a g e Data Parsing on Zebra Scanners Zebra Technologies – v2

11. General - What does a GS1 barcode that supports data parsing look like

The following GS1 Parsing supported barcode formats can be scanned using select Zebra 2D imaging scanners.

i. 1D - GS1-128 (Single barcode)

ii. 1D - GS1-128 (Multiple barcodes)

iii. 1D - GS1 DataBar

iv. 1D - GS1 DataBar Stacked Barcode

v. 2D - GS1 Datamatrix

vi. 2D - GS1 QR Code

8 | P a g e Data Parsing on Zebra Scanners Zebra Technologies – v2

12. General - How do I scan into different screens in a host application

Depending on the host app’s requirement per screen (data fields and separator fields), one of the

following will apply. Option A – If the same data fields and separator are required for both screens, the same UDI parsing rule will work on both screens. Option B – If different data fields and / or separator are required per screen, a different UDI parsing rules will be required per screen. The recommended scanner programming methodology is scanning a 2D programming barcode generated from 123Scan. Each screen will require a unique 2D programming barcode. A possible approach would be to tape rule 1 and rule 2 near the monitor for scanning upon switching screens.

13. General - What is output if I scan a data parsing enabled barcode that lacks ALL the required data fields

If no required data fields are present, the scanner will not output any data fields. If one or more data fields is missing but the rest present, the output will vary with the selected output option chosen from the Other Settings menu.

14. General – Does data parsing support both handheld (triggered) and handsfree (presentation) scanning

Zebra Data Parsing capable scanners support both handheld (triggered) scanning and handsfree (presentation) scanning.

Though data parsing capable scanners support handsfree (presentation) scanning, its implementation can be tricky. Depending on the scanning condition, a handsfree scanning session may yield unexpected, undesired multiple outputs as a label passes through the field of view. The results may be anywhere between a complete set of data fields (successfully decode beep) to a partial set of data fields (Error beep) or both.

This problem is more likely to occur in presentation mode on a slow moving, complex label. As the label is moving through the field of view, the label is first partially read (some of the data fields are in the field of view – See frame 2 below) then a second decode can occur as it is fully read (all the data fields are in the field of view – See frame 3 below).

9 | P a g e Data Parsing on Zebra Scanners Zebra Technologies – v2

15. General - How many data parsing rules can be programmed on a scanner

Only one data parsing rules can be stored in a scanner at a time; Either a UDI parsing rule* or GS1 label parsing rule or Blood bag parsing rule. In the example below from 123Scan, a Blood bag rule is selected.

* Note if a UDI parsing rule is selected, it can contain all three UDI formats: GS1, HIBCC and ICCBBA.

16. General - How many barcodes can be scanned from a UDI Label / GS1 Label / Blood Bag Label

This question does not make sense in the data parsing world because a single barcode can contain numerous data fields. Traditionally, in a non-data parsing scenario, a barcode equals a single data field, but not here. In the example below, a single data parsing barcode contains 3 data fields, which traditionally in a non-data parsing scenario would require 3 barcodes.

With this explained, a Zebra scanner can scan 10 or more barcodes in one trigger pull when performing data parsing. The barcodes can be a combination of 1D and 2D symbologies.

Generally, UDI labels include up to three 1D stacked barcodes and possibly one additional 2D barcode. Generally, GS1 labels include up to three 1D stacked barcodes and possibly one additional 2D barcode.

10 | P a g e Data Parsing on Zebra Scanners Zebra Technologies – v2

Generally, Blood Bag labels include up to seven 1D barcodes and possibly one additional 2D barcode.

17. General - How many data fields can be programmed within a single data parsing rule

A data parsing rule can be written with up to 15 or more data fields, until the data parsing memory is completely used on the scanner. Memory usage is shown by clicking on the "Memory used" link on

123Scan’s data parsing screen.

18. General - How many separator fields can be inserted between two data fields

Up to ten separator fields can be inserted between two data fields.

Note only one pause can be inserted between data fields. To allow for shorter or longer pauses, the pause duration is programmable. At the end of the rule, after the last data field, a pause can only be inserted as the last field separator.

19. General - Can data parsing be enable / disabled by my application

Yes. An application can programmatically enable and disable data parsing using a Zebra driver and a Remote Scanner Management (RSM) command.

i. UDI - GS1 Parsing - RSM attribute number 881. 1 = Enable; -1 = Disable.

ii. UDI - HIBCC Parsing - RSM attribute number 882. 1 = Enable, -1 = Disable. iii. UDI - ICCBBA Parsing - RSM attribute number 883. 1 = Enable, -1 = Disable. iv. GS1 Label Parsing - RSM attribute number 881. 1 = Enable; -1 = Disable.

v. Blood Bag ISBT 128 Parsing - RSM attribute number 884. 1 = Enable, -1 = Disable.

20. General - Can an AIM Code ID be used when Data Parsing

Yes. If the AIM Code Identifier has been enabled (Transmit Code ID Character = AIM Code ID) within 123Scan. The following two AIM Code ID output options exist.

• If you select “Send each data field as a barcode (default)” the scanner will output the AIM ID

before each data field like below.

o ]x0(01)00884450019801 tab ]x0(17)190731 tab ]x0(10)H996267

• If you select “Send all data fields in one barcode” the scanner will output AIM ID once

before all data fields like below.

o ]x0(01)00884450019801 tab (17)190731 tab (10)H996267

To enable, find the “Data Transmission Options” under General Settings by clicking 123Scan’s

11 | P a g e Data Parsing on Zebra Scanners Zebra Technologies – v2

Note using “Send each data field as a barcode”, pause must be inserted through ADF. Note a generic UID AIM ID will be output, which will show up as an 'unknown' AIM code type

21. General - Can a Function Key(s) Be Inserted Using ADF into Data Parsed Output

Yes. See Appendix A / Barcode Example 13.

22. General - What data fields can have their date format modified by the scanner

UDI GS1 – Date fields can have their output format modified; the default is YYMMDD. UDI HIBCC - Common Fields – Date fields can have their output format modified; the default is

YYMMDD. An option also exists to output the date fields in the same format as present in the barcode.

UDI HIBCC - All Fields in Numeric Order – Output in native HIBCC format. UDI ICCBBA - Common Fields – Date fields can have their output format modified; the default is

YYMMDD. An option also exists to output the date fields in the same format as present in the barcode. UDI ICCBBA - All Fields in Numeric Order – Date fields can have their output format modified; the default is YYMMDD. An option also exists to output the date fields in the same format as present in the barcode.

GS1 Label Parsing – Date fields can have their output format modified; the default is YYMMDD. Blood Bag – Date fields are output in the same format as present in the barcode, YYYDDD.

23. General - What If I scan a new, previously undocumented or incorrectly formatted data field

If a new data field or incorrectly formatted data field appears in a label that is not recognized by the scanner’s firmware, it will behave in one of the following ways:

- If the scanner 1st captures a good data field(s) before hitting an undocumented and or

incorrectly formatted field – The scanner emit beeps as selected in Other Settings / “Handling

a label not containing all required data fields” and transmits the good data fields to the host

(default setting of scanner).

12 | P a g e Data Parsing on Zebra Scanners Zebra Technologies – v2

- If the undocumented field and or incorrectly formatted field is the first data field in the

barcode – The scanner emits a convert error beep (5 long error beeps) and no data will be transmitted to the host.

- If the scanner captures all the required data fields, then hits an undocumented and or

incorrectly formatted data field – The scanner emits a good decode beep and transmits the good, required data fields to the host.

24. 123Scan - How is a scanner programmed to perform data parsing

123Scan, Zebra’s scanner programming utility, is used to program data parsing enabled scanner. The parsing functionality is found in 123Scan’s configuration wizard by clicking the Modify Data tab, then

clicking Program Complex Data Modifications / Advanced / UDI Parsing or GS1 Label Parsing.

25. 123Scan - Can the order of output data fields be programed in 123Scan

Yes. 123Scan can be used to write a parsing rule which modifies the order of output data fields and transmit some or all of the data fields to a host application. In addition, to enable the data fields to be

entered into the host app’s appropriate entry fields, the UDI parsing rule can insert a separator like a tab between the data fields. 123Scan’s separator options include comma, carriage return, line feed, enter,

space, tab, pause, in addition to others.

The UDI parsing functionality is found in 123Scan’s configuration wizard by clicking the Modify Data tab,

then clicking Program Complex Data Modifications / Advanced / UDI Parsing or GS1 Label Parsing.

26. 123Scan - How long do I have to find all the barcodes (data fields) on the label

The “Parsing Session Timeout” is the maximum time (while depressing the trigger) to acquire all

required data fields. The scanning session will be exited after this time expires, similar to releasing the trigger. The longer this setting, the more time you have to scan multiple barcodes (while keeping the trigger depressed).

The Parsing Session Timeout is customer programmable within 123Scan’s data parsing screen. Default

value = 10 seconds.

27. 123Scan - Can my data parsing programmed scanner scan regular barcodes

Yes, a scanner programmed with a data parsing rule can be used to scan regular barcodes. If a scanner has a data parsing rule present, 123Scan can be used to fine tune how long a trigger must be depressed (called the “Parsing Prioritization Time”) before outputting a non-data parsing barcode.

Barcodes lacking the required data fields, will be ignored for a programmed amount of time called the “Parsing Prioritization Time”. During this time, only barcode(s) with the specified data parsing fields can be output.

After the “Parsing Prioritization Time” has passed and then a non-data parsing (regular) barcode is scanned, it will be output.

If only a regular barcode was scanned before the “Parsing Prioritization Time” has passed, that regular barcode will be output after the “Parsing Prioritization Time” has expired.

13 | P a g e Data Parsing on Zebra Scanners Zebra Technologies – v2

The “Parsing Prioritization Time” is found in 123Scan’s configuration wizard by clicking the Modify Data

tab, then clicking Program Complex Data Modifications / Advanced / UDI Parsing or GS1 Label Parsing.

28. 123Scan - What if one required data field on a label is not present

If a required data field is missing, not found when scanning, 123Scan gives the following programming options under the menu.

29. 123Scan - Retrieving a data parsing rule from a scanner

123Scan is not able to retrieve a data parsing rule from a scanner, for editing within 123Scan. But the data parsing rule is likely saved in the 123Scan configuration file used originally to program the scanner. Note, though 123Scan cannot edit a data parsing rule retrieved from a scanner, it can save the data parsing rule into a configuration file for cloning and remote management.

30. 123Scan - Can a data parsing rule be programmed through Remote Management

123Scan can be used to generation a SMS Package containing a data parsing rules for remote management. Zebra’s SMS can be used to push this package to a data parsing enabled Zebra scanner.

31. UDI - What UDI standards are supported by Zebra Scanners

All three UDI parsing standards as set forth by the United States FDA (Food and Drug Administration) are supported on select Zebra scanners.

i. GS1 Parsing

ii. HIBCC Parsing

iii. ICCBBA Parsing

32. UDI - What are the most common UDI data fields tracked by hospitals

Hospitals most often track GS1 UDI barcodes, in particular these three GS1 UDI fields.

14 | P a g e Data Parsing on Zebra Scanners Zebra Technologies – v2

• GS1 data field 01 – Device Identifier (GTIN - Global Trade Item Number)

• GS1 data field 10 – Batch / Lot Number

• GS1 data field 17 – Use by expiration date (YYMMDD)

For a complete list of GS1 data fields (application identifiers – AI) click

https://www.gs1.org/standards/barcodes/application-identifiers?lang=en

33. UDI - What GS1 / HIBCC / ICCBBA UDI output options are available within 123Scan

123Scan gives the following options under the menu.

15 | P a g e Data Parsing on Zebra Scanners Zebra Technologies – v2

34. UDI - What HIBCC Data Field Identifier can be scanned

HIBCC has a complicated data field identifier structure, the symbol(s) that identify a data field for example a single lone + indicates the Device Identifier. In some cases, multiple data field identifiers exist for the same piece of information. For example an expiration date can be identified with any of these thirteen sequences: $$, $$2, $$3, $$4,$$5, $$6, $$+, $$+2, $$+3, $$+4,$$ +5, $$+6 and 14D. All thirteen of these identifier sequences contain the expiration date but each is encoded in a slightly different format for example YYMMDD, YYMMDDHH, MMDDYY, MMYY…

The scanner can decipher all HIBCC data field identifier structures and output it in the desired format, as programmed through 123Scan.

+ 35 hidden pages

Zebra Parsing User manual

Specifications and Main Features

Frequently Asked Questions

User Manual