ZEBRA Multicode-Data-Formatting-And-Preferred-Symbol-User-Guide-A-En-Us
ZEBRA Multicode-Data-Formatting-And-Preferred-Symbol-User-Guide-A-En-Us
Formatting and
Preferred Symbol
User Guide
MN-002895-01
MULTICODE DATA FORMATTING AND
PREFERRED SYMBOL
USER GUIDE
MN-002895-01
Rev A
August 2016
ii MDF and Preferred Symbol User Guide
Revision History
Changes to the original guide are listed below:
Appendix A: Examples
Example 1: Preferred Symbol - UPC for Retail ............................................................................. A-1
Customer Use Case ................................................................................................................ A-1
Preferred Symbol Approach .................................................................................................... A-1
Programming Details: Criteria & Actions ................................................................................. A-2
Preferred Symbol in 123Scan ................................................................................................. A-2
Validate Output: Programming Bar Code for This Example .................................................... A-4
Example 2: Simple MDF Example ................................................................................................ A-5
Customer Use Case ................................................................................................................ A-5
MDF Approach ........................................................................................................................ A-5
Programming Details: Criteria & Actions ................................................................................. A-6
Global Setting .................................................................................................................... A-6
Output 1 = Code 39 ........................................................................................................... A-6
Output 2 = Code 128 ......................................................................................................... A-7
MDF Output ............................................................................................................................. A-8
MDF Rule in 123Scan ............................................................................................................. A-9
Validate Output: Programming Bar Code For This Example ................................................ A-10
Example 3: Sending a Pause Using ADF ................................................................................... A-11
Customer Use Case .............................................................................................................. A-11
MDF Approach ...................................................................................................................... A-11
Programming Details: Criteria & Actions ............................................................................... A-11
MDF Output ........................................................................................................................... A-11
ADF Rule in 123Scan ............................................................................................................ A-12
Validate Output: Programming Bar Code For This Example ................................................ A-13
Example 4 ................................................................................................................................... A-14
Customer Use Case .............................................................................................................. A-14
MDF Approach ...................................................................................................................... A-14
Programming Details: Criteria & Actions ............................................................................... A-15
Global Setting .................................................................................................................. A-15
Output 1 .......................................................................................................................... A-15
Output 2 .......................................................................................................................... A-16
MDF Output ........................................................................................................................... A-17
MDF Rule in 123Scan ........................................................................................................... A-18
Validate Output: Programming Bar Code For This Example ................................................ A-18
Example 5: iPhone Box Label ..................................................................................................... A-20
Customer Use Case .............................................................................................................. A-20
vi Multicode Data Formatting and Preferred Symbol User Guide
Introduction
The Multicode Data Formatting and Preferred Symbol User Guide provides programming instruction for using MDF
and Preferred Symbol on select Zebra 2D imaging scanners.
NOTE Screens and windows pictured in this guide are samples and can differ from actual screens.
Chapter Descriptions
Topics covered in this guide are as follows:
• Chapter 1, Multicode Data Formatting (MDF) Overview, provides a basic description of MDF functionality.
• Chapter 2, Preferred Symbol, provides a basic description of Preferred Symbol functionality.
• Chapter 3, Multicode Data Formatting, describes MDF scanning session parameters, MDF programming
limits and pattern match criteria.
• Chapter 4, Data Formatting Within an MDF Rule, describes MDF data formatting options within a MDF rule.
• Chapter 5, User Feedback Controls (LEDs, Beeper, and Vibrate), describes user feedback settings applied
across all MDF rules and Preferred Symbol modes.
• Chapter 6, Multicode Configuration and Deployment, describes MDF programming and remote management
options.
• Chapter 7, MDF Non-Supported Capabilities, describes functionality not supported in Multicode Data
Formatting.
• Appendix A, Examples, includes simple to advanced programming examples.
viii Multicode Data Formatting and Preferred Symbol User Guide
Notational Conventions
The following conventions are used in this document:
For the latest version of this guide and all guides, go to: http://www.zebra.com/support.
Service Information
If you have a problem with your equipment, contact Zebra Global Customer Support for your region. Contact
information is available at: http://www.zebra.com/support.
If your problem cannot be solved by Zebra Customer Support, you may need to return your equipment for servicing
and will be given specific directions. Zebra is not responsible for any damages incurred during shipment if the
approved shipping container is not used. Shipping the units improperly can possibly void the warranty.
About This Guide ix
If you purchased your Zebra business product from a Zebra business partner, contact that business partner for
support.
x Multicode Data Formatting and Preferred Symbol User Guide
CHAPTER 1 MULTICODE DATA
FORMATTING (MDF)
OVERVIEW
Introduction
This User Guide documents two new user programming options:
MDF
MDF enables a 2D imaging scanner to scan all the bar codes within a label, with one trigger pull, and then modify
and transmit some or all of them to a host application. For working MDF examples that can be programmed to a
scanner, see Appendix A, Examples.
MC920LL/A iPhone 4, White, 8GB
Designed by Apple in California Assembled in China
Other items as marked thereon Model A1332
(1P) Part No. MC920LL/A UPC
8 85909 45985 8
()ICCID 00010002000300040005
• Discarding scanned data if all required bar codes are not present.
MDF is easy to program using 123Scan. Programming an MDF rule follows the same paradigm and user interface
as Advanced Data Formatting (ADF). MDF programming is saved within the 123Scan configuration file.
MDF can be deployed to a fleet of 2D imaging scanners using the Scanner Management Service (SMS) through a
traditional SMS Package, just like ADF.
Preferred Symbol
Preferred Symbol is a bar code prioritization technique. When scanning a label with multiple bar codes, one or
more bar code(s) can be singled out for decoding while excluding the others. The Preferred Symbol is the only bar
code that is decoded and output within a preset time (called the Preferred Symbol Timeout). During this time, the
scanner attempts to decode the prioritized bar code and reports only this bar code. With Preferred Symbol only one
bar code is output per trigger pull.
CHAPTER 2 PREFERRED SYMBOL
Introduction
Preferred Symbol is a bar code prioritization technique that enables favored decoding of a user designated high
priority bar code(s). Basically, if scanning a label with multiple bar codes, one bar code can be singled out to be
decoded instead of the others. See Example 1: Preferred Symbol - UPC for Retail on page A-1 for a real world
example.The Preferred Symbol is the only bar code that is decoded and output within a preset time called the
Preferred Symbol Timeout. During this time, the scanner attempts to decode the prioritized bar code and reports
only this bar code. With Preferred Symbol only one bar code is output per trigger pull. For more details including a
working Preferred Symbol example see Appendix A, Examples.
Parameter Range
The parameter range is 200 ms to 5000 ms and the default is 200 ms.
Code Type
This is a required field when specifying a preferred symbol.
Code Length
This is an optional field when specifying a preferred symbol.
String
This is an optional field when specifying a preferred symbol.
1. Trigger is Released
The scanner exits a Multicode session if the trigger was released.
4. Second Similar Bar Code That Also Meets Pattern Match Scanned
The scanner exits an MDF session if a second bar code is scanned that satisfies an already fulfilled bar code
criteria within this MDF session's pattern match.
3 - 2 Multicode Data Formatting and Preferred Symbol User Guide
Order of Execution
MDF Group 1 executes before MDF Group 2.
Within an MDF group, MDF Rule 1 (left most rule in 123Scan UI) executes before Rule 2.
Identifying Bar Codes Within the Pattern Match (Bar Code Criteria)
Each bar code within the pattern match is defined according to the bar code criteria identified below.
Code Type
This is a required field when specifying a bar code within the pattern match.
Code Length
This is an optional field when specifying a bar code within the pattern match.
String
This is an optional field when specifying a bar code within the pattern match.
Data Formatting
If a pattern match is met, the bar codes within the matched MDF group have the option for unique data formatting
to be applied per bar code. For example, the first output bar code could have a carriage return appended to its
data, the second bar code could have D appended to its data, etc.
If multiple MDF groups exist and no pattern match occurs, output the data for the highest priority MDF group (MDF
Group 1 has the highest priority) with a partial pattern match.
3 - 4 Multicode Data Formatting and Preferred Symbol User Guide
Figure 3-3 Discard Scanned Bar Codes Not Within Pattern Match
NOTE Outside the pattern match means the bar code does not satisfy any MDF rule.
The outside-pattern match bar code transmits to the host upon a trigger release, or the Time between MDF codes
time limit was exceeded (see 3. Time Since Last Scanned Bar Code Exceeds Limit on page 3-1).
NOTE If the MDF criteria for ANY rule is Output if NO pattern match = Transmit bar code AND a partial
pattern match exists, the Output if NO pattern match parameter takes precedence over the unchecked
Discard scanned bar code(s) NOT within the pattern match parameter.
For a real world use case, see Example 2: Simple MDF Example on page A-5.
Option 1 - Different Data in Each Bar Code (Two Unique Bar Codes)
If multiple bar codes with different data satisfy one MDF rule criteria, the scanner exits the decode session without
generating an MDF output.
For example, if scanning two Code 128 bar codes, each with 14 digits but with different data in each bar code, the
scanner does not output an MDF result.
This ability is user programmable through setting UPC as a Preferred Symbol. See Example 1: Preferred Symbol -
UPC for Retail on page A-1 for details.
Multicode Data Formatting 3 - 5
Multicode Industry wide name for the ability to scan multiple bar codes with
one trigger pull.
MDF Session An MDF session is the act of decoding a label from trigger pull to
either transmission of data or termination of decode session.
MDF Group The complete set of commands for processing a single label,
which contains multiple bar codes. 123Scan can program from 1
to 9 MDF Groups.
MDF Rule The programming specifics for processing a single bar code. The
MDF Rule, similar to an ADF Rule, contains both criteria and
actions. One MDF Rule identifies a single bar code and how to
format its data; more bar codes require more MDF Rules.
For example, if an MDF implementation is written for just one label which has two bar codes, it would be
programmed into MDF Group 1 and MDF Group 1 would contain two MDF rules (Rule 1 and Rule 2), as shown
below in Figure 3-4.
• Send Pause
• Rule Set
• Send value like Function Keys
• Beep.
4 - 2 Multicode Data Formatting and Preferred Symbol User Guide
MDF can support the ability to specify up to three alphanumeric string values through the use of an ‘or’
statement.
Example 1: String = 3 or 7 or Z
Example 4: String = 12
CHAPTER 5 USER FEEDBACK
CONTROLS (LEDS,
BEEPER, AND VIBRATE)
Consistent Feedback Across MDF Rules
User feedback settings are uniformly applied across all MDF rules and Preferred Symbol modes. Feedback
settings do not vary from MDF Group 1 to Group 2, etc.
• LED only
• LED, beeper (factory default)
• LED, vibrate
• LED, beeper, and vibrate.
5 - 2 Multicode Data Formatting and Preferred Symbol User Guide
CHAPTER 6 MULTICODE
CONFIGURATION AND
DEPLOYMENT
Programming Through 123Scan
123Scan is used to program MDF and Preferred Symbol to a scanner.
NOTE Once MDF is programmed to a scanner using 123Scan, you cannot use 123Scan to retrieve MDF from
the scanner for viewing and editing. However, you can use 123Scan to clone MDF from one (already
programmed) scanner A to another (unprogrammed) scanner B.
Application Control
Enabling/Disabling MDF Groups
An application can enable and disable MDF group(s) using an RSM command. For example, an application can
disable MDF Group 1 and enable MDF Group 2, and vice versa.
Time Delays
MDF does not support the interjection of a time delay between transmitted bar code data. A time delay may be
inserted through post MDF data process using an ADF rule.See section Data Formatting Actions: MDF Versus
ADF on page 4-1 for details.
Non-ASCII Values
MDF does not support the transmission of non-ASCII values.
7 - 2 Multicode Data Formatting and Preferred Symbol User Guide
APPENDIX A EXAMPLES
8 85909 45985 8
()ICCID 00010002000300040005
2. Select the Preferred Symbol check box to enable (circled in Figure A-3).
3. Select UPC-A from the drop-down list in Preferred Symbol Options (see Figure A-3).
4. Set the Prioritization time to 300 ms.
1. From the Modify data screen, create an ADF Rule as shown in Figure A-4 below.
This bar code can be used to demonstrate the desired data output.
abcdefgh
MDF Approach
• Use Case 1: If a pattern match exists (all required bar codes present), the MDF Rule is executed.
• Use Case 2: If a pattern match does not occur and a bar code outside the label is scanned, this bar code
should be transmitted to the host upon the trigger being released.
A - 6 Multicode Data Formatting and Preferred Symbol User Guide
Global Setting
With the Discard scanned bar code(s) NOT within pattern match setting unchecked, if a pattern match does not
occur, the last decoded bar code outside the pattern match1 is sent to the host, upon the trigger being released.
For addition information on this feature see Option 1 - Transmit Bar Code Not Within Pattern Match on page 3-4.
NOTE 1Outside the pattern match means the bar code does not satisfy any MDF Rule.
NOTE If the MDF criteria for ANY rule is Output if NO pattern match = Transmit bar code AND a partial
pattern match exists, the Output if NO pattern match parameter takes precedence over the unchecked
Discard scanned bar code(s) NOT within the pattern match parameter.
Figure A-7 Discard scanned bar code(s) NOT within pattern match
Output 1 = Code 39
MDF Criteria
Code Length = 6
String =
Start at position =
MDF Action
= Send <Enter>
Output
Output if no match =
Examples A - 7
Code Length = 8
String =
Start at position =
MDF Action
= Send <Enter>
Output
Output if no match =
A - 8 Multicode Data Formatting and Preferred Symbol User Guide
MDF Output
If pattern match with label
123456<Enter> abcdefgh<Enter>
No output
abcd
For details on the order of execution of MDF groups and MDF rules, see Order of Execution on page 3-2.
Examples A - 9
This bar code can be used to demonstrate the desired data output.
MDF Approach
• Use Case 1: Introduce a one second pause after transmitting the first bar code (Code 39) and a one second
pause after transmitting the second bar code (Code 128).
String =
Start at position =
ADF Action
= Send Next 7*
*6 digits + Enter = 7 digits
= Send Pause 10
= Send Next 9*
*8 digits + Enter = 9 digits
= Send Pause 10
MDF Output
If pattern match
If no pattern match
No output
NOTE The <pause> is experienced within the 123Scan Dataview if from the initial Select an operation mode
screen, the scanner's com protocol is set to USB HID Keyboard Emulation.
A - 12 Multicode Data Formatting and Preferred Symbol User Guide
This bar code can be used to demonstrate the desired data output.
Example 4
MDF Approach
• Use Case 1: A second set of MDF programming must be added to what was created for Example 2: Simple
MDF Example on page A-5. In Example 2, MDF programming is contained in MDF Group 1 (the default MDF
group). In this example, programming is contained in MDF Group 2.
• Use Case 2: Scanning multiple labels on different sides of a box can be handle with an appropriately large
Time between MDF Codes time.
Examples A - 15
Global Setting
Multiple bar codes, each on a different side of a package can be scanned within an MDF session, as long as the
trigger remains depressed and the Time between MDF codes is not exceeded.
The programmable time limit defaults to 10 seconds and can range from 5 to 25 seconds in 1 second increments.
With the factory default of 10 seconds, after decoding Label A you have 10 seconds to decode Label B.
For addition information on this feature, see3. Time Since Last Scanned Bar Code Exceeds Limit on page 3-1.
Output 1
MDF Criteria
Code Length = 3
String =
Start at position =
MDF Action
= Send <Enter>
Output
Output if no match =
A - 16 Multicode Data Formatting and Preferred Symbol User Guide
Output 2
MDF Criteria
Code Length = 4
String =
Start at position =
MDF Action
= Send <Enter>
Output
Output if no match =
Examples A - 17
MDF Output
If pattern match
123<Enter> abcd<Enter>
If no pattern match
No output
For details on the order of execution of MDF groups and MDF rules, see Order of Execution on page 3-2.
A - 18 Multicode Data Formatting and Preferred Symbol User Guide
This bar code can be used to demonstrate the desired data output.
8 85909 45985 8
()ICCID 00010002000300040005
MDF Approach
• Use Case 1: If a pattern match exists (all required bar codes present), the MDF rules are executed.
• Use Case 2: If a pattern match does not exist but the UPC was decoded, the UPC is transmitted to the
register.
• Use Case 3: If a bar code is scanned and it is not within the pattern match, it is not transmitted to the host.
• Use Case 4: One of the bar codes is not required by the host, but is present on all labels. It is used to set a
higher pattern match threshold. But the data is not sent to the host.
Examples A - 21
Global Setting
The check in the Discard scanned bar code(s) NOT within pattern match check box directs the scanner to
discard all decoded bar codes not identified within an MDF Rule.
String =
Start at position =
MDF Action
= Send <Enter>
A - 22 Multicode Data Formatting and Preferred Symbol User Guide
Output
String = 1P
Start at position = 1
MDF Action
= Skip ahead 2
= Send <Enter>
Output
Output if no match =
Examples A - 23
NOTE See Figure A-26 on page A-27 for a screen shot depicting all the programmed MDF rules and their
actions.
String = S
Start at position = 1
MDF Action
= Skip ahead 1
= Send <Enter>
A - 24 Multicode Data Formatting and Preferred Symbol User Guide
Output
Output if no match =
NOTE See Figure A-26 on page A-27 for a screen shot depicting all the programmed MDF rules and their
actions.
Code Length = 15 or 16
String =
Start at position =
MDF Action
= Send <Enter>
Examples A - 25
Output
Output if no match =
NOTE See Figure A-26 on page A-27 for a screen shot depicting all the programmed MDF rules and their
actions.
Code Length = 19 or 20
String =
Start at position =
A - 26 Multicode Data Formatting and Preferred Symbol User Guide
MDF Actions
Output
Output if match =
Output if no match =
NOTE See Figure A-26 on page A-27 for a screen shot depicting all the programmed MDF rules and their
actions.
Examples A - 27
MDF Output
If pattern match
885909459858<Enter>MC920LL/A<Enter>C8PJMN9CDTD0<Enter>013183004709357<Enter>
If no pattern match
885909459858<Enter>
For details on the order of execution of MDF groups and MDF rules, see Order of Execution on page 3-2.
This bar code can be used to demonstrate the desired data output.