Template Builder is a web-based tool for creating NG SimulScan templates, which define the information acquired from documents, forms and labels, simplifying the capture of multiple image regions and barcodes. DataWedge's Document Capture acquires data based on the defined template, processes the data and delivers it to an application. Each template corresponds with a target document (e.g. shipping receipt, part label) to capture and process as part of a workflow. This guide provides instructions for using Template Builder to create templates and deploy them to devices.
- Camera or supported 2D imager
- DataWedge v8.0.28 or higher configured to access NG SimulScan
- Zebra Professional devices, such as TC21 and TC26, require a Mobility DNA license for NG SimulScan's Document Capture feature
Before attempting to create a Template, the following assets are required:
- Sample(s) of the document(s) (forms, labels, etc.) for which the Template(s) is being created
- Photos or image scans of those same documents (for upload)
- An account on the Template Builder web site
- Camera or 2D Imager is selected under Scanner Selection in the DataWedge profile for the Template
- A familiarity with Template concepts
Most acquisition tasks involve capturing data from printed documents, forms or labels. These "target" documents often vary in size, shape and layout, and present a challenge for accurate data acquisition. Templates solve this problem by "teaching" NG SimulScan about the documents it will encounter, and defining how to scan and process data for each instance of that target document.
Sample document showing Form Region of Interest and Field Region(s) of Interest / Fields
A Template is associated with a "target" document (e.g. shipping receipt or shipping label) that contains multiple types of data. "Form Region of Interest" defines the border that encompasses all the data on the entire form. "Fields" are defined to identify specific "Field Region(s) of Interest" on the form from which data is to be extracted from. These Fields can contain different types of data, such as barcode, picture, signature, etc.
The Template is generated based on 2 types of documents and the data captured, described in the following subsections:
- Image Capture - captures barcodes and images of data (text, picture, signature, etc.)
- MultiBarcode - captures barcodes only
A Template is output as an .xml file containing details about the data to extract and other parameters. Templates are saved on the Template Builder server, unless downloaded to the local host.
Using DataWedge Mgr CSP, templates can be mass deployed to Zebra mobile computers for use by the end-user application employing NG SimulScan.
To create a template, see Using Template Builder below.
Image Capture is used to acquire mixed types of data at once (barcodes, text, images, etc.) when the document to be scanned ("Target") has a fixed layout - the location and type of data in each field of a Target remain consistent whenever the form is used, and only the data changes with each new instance of the form. By creating a Template to uniquely identify each region and data type, NG SimulScan learns what to expect from each region of a form, which allows the user to map the data from each region to specific fields of an application.
Image Capture Templates are used to:
- Scan barcodes, text and other data types from a single form
- Acquire mixed types of data at once (barcodes, text, images, signatures, etc.)
- Capture an image of the entire form or a region on the form, such as a photo, signature, etc.
- Detect for presence of a signature on the form
Field Types supported for Image Capture:
- Barcode - scan single or multiple barcodes in the field of view
- Picture - capture signature(s), photo(s), or entire document(s) as an image.
Example of an Image Capture-type document.
For example, a company that uses a fixed-format form such as the Postal/T&L example (shown above) would create an Image Capture template to identify the location of each field to be captured and the type of data to be processed from each identified field.
MultiBarcode is used to acquire data from forms that contain barcodes. This applies to cases where multiple barcodes are required to be captured simultaneously, or specific barcode(s) need to be read from a multitude of barcodes. For the latter, a template can be generated to capture only certain barcode(s) from that form, and use the data captured to populate specific fields within an application.
Scanning performance and workflow can be improved by creating a Template that is configured only for the specific types of barcodes it receives on a regular basis. MultiBarcode can simultaneously handle a large number of 1D/2D barcodes of the same or differing symbologies, but works most efficiently if the symbologies are narrowed to just a few.
MultiBarcode Templates are used to:
- Scan barcode(s) from a form that can contain multiple barcodes.
- Scan multiple barcodes simultaneously
- Scan a specific barcode from a multitude of barcodes.
- Automatically group barcodes based on a common pattern identified, e.g. same decoder, same data length, same first 1 or 2 characters of data
Field Type supported for MultiBarcode:
- Barcode - scan single or multiple barcodes in the field of view
MultiBarcode sample containing different data.
For example, a company that receives regular shipments accompanied with a label (like the one above) could create a MultiBarcode Template to map the part number and supplier number from the barcodes in the upper row, and the quantity-received information from the lower row to the corresponding fields of an application.
Template Builder is free for Zebra partners and other registered users. Existing Zebra customers, partners and ISVs with access to Partner Gateway can use their existing credentials to gain access to Template Builder. Others must register using the instructions below.
Below is a summary of the steps for creating a Template. The process is explained in detail in the sections that follow.
- Log in to the Template Builder web site.
- Select the Document Type and upload an image of the Target Document to be scanned (.bmp, .jpg, .png or .pdf; 5MB max.).
- Identify Fields of the Document and the data types (barcode, image) of each.
- Configure Field and Template settings.
- Validate the Template to verify the Fields and properties are set properly.
- Save and download the completed Template(s) to the local host computer.
- Copy or deploy Template(s) to the device(s) that are performing the scans.
- Configure DataWedge to setup the data so it can be consumed by the application.
In a browser, visit the NG SimulScan Template Builder site: ng-simulscan.zebra.com: Template Builder login screen
Click on Sign In and enter the login credentials.
For first time registrants, click on Sign Up to visit the Zebra NG SimulScan registration page. Follow prompts to create a free account and enter all requested information. Once an account is created, Zebra administrators will send login information to the registered address. Zebra recommends planning ahead; this process could take several days.
Prior to uploading the image for the template, make sure the image was taken with the document placed flat against a constrasting background with the camera perpendicular to the surface, and make sure the image was captured without any shape distortion.
To upload the image for the template:
- Select a Document Type:
- An Open... dialog appears. Select and upload an image of the Target Document for which to create the Template, observing the following parameters:
- Supported file types: .bmp, .jpg, .png or .pdf
- Minimum resolution: 640x480
- Maximum resolution: 6000x6000
- Maximum file size: 5 MB
- MP size: Recommended megapixel sizes - 2 MP for MultiBarcode, 3 MP for Image Capture
For a .pdf, select page number from the drop-down (if necessary).
Confirm that the AutoCrop feature (enabled by default) has accurately identified the Document boundaries. If boundary adjustments are necessary, click Disable AutoCrop and set the blue bounding box so that it is just outside the borders of the Document.
- Click OK when done. The "Form Region of Interest" for the Document is created. The form is loaded and displayed.
- Create the Field Regions of Interest, also known as Fields, by using the mouse cursor crosshair to drag a box from the upper-left corner to the lower-right corner over each region of the Document that contains data to be acquired. Field restrictions:
- Image Capture: maximum of 3 Fields
- MultiBarcode: maximum of 20 Fields
- Auto Group Identification: If one of the MultiBarcode Fields is set with Auto Group Identification, this restricts the maximum Fields to 10. Only 1 Field can be set with Auto Group Identification. If more than 1 Field is set, an error will occur.
NOTE: Barcode Regions must include only the bars and spaces - no surrounding characters should be included.
Example uploading image and designating Fields for Image Capture.
Alternative ways to create Fields:
- From the menu, select Edit > Create New Field. Enter a name for the field and draw a box around the corresponding Region.
- Right-click in the Fields panel and select Create New Field. Enter a name for the field and draw a box around the corresponding Region.
Add a Field to the Template by right-clicking in the Fields panel.
Configure the following settings:
Field Properties - Provide (or confirm) the following required settings for each Field:
- A name for the field
- Field Information - Use Field to Identify Form, Mandatory Field, Also Read Value from Field
- Field Type - Barcode, Picture
- Field Settings - specific processing-mode settings (decoder type, decoder data options, image adjustments, etc.).
Template Settings - Select the appropriate Template Settings based on the document type: Image Capture or MultiBarcode. Any data related settings apply to all data from the Template.
Save the template after configuring the settings, select File > Save Template. Save work often! Unsaved changes could be lost if the screen is dismissed or a session timeout is reached.
The Field Properties panel is visible in the far-left column, and presents the Properties of the selected Field. Image Capture is restricted to a maximum of 3 Fields.
- Use Field to Identify Form - designate the Field as an Anchor element, a unique attribute of a Document to positively identify it and determine its orientation relative to the scanner (ie. whether it is upside down). Anchor elements in a given Document remain in the same location and are fixed (do not change), such as a company logo or static text. Enabling this option aids in increasing the accuracy in reading the form in different conditions, e.g. lighting.
- Also Read Value from Field - sets the Template to acquire data from a Field that is designated as an Anchor element (Use Field to Identify Form is checked). Enabled by default.
Barcode Type - select the barcode decoder. Zebra recommends to select the appropriate decoder to filter out other symbologies and prevent them from being scanned, thus improving performance. If the decoder is not known, select ANY_BARCODE. If a specific decoder is selected, the corresponding decoder options are displayed.
Enable Character Checking - enable this to use the barcode data to aid in identification of the barcode with one or more of the following criteria:
Starts With - enter character(s) to check for barcodes that begin with the specified character(s) of the acquired barcode data. Leave blank if not needed.
Contains - enter character(s) to accept barcodes that contain the specified character(s) at the index position specified in the at field (index 0 = the first character).
String Length - enter the number of characters the barcode data must contain. Leave blank if not needed.
Barcode Orientation - select one of the following if the barcode is known to be rotated in a position other than the default position (0° Portrait):
0° (Portrait) - the barcode is right-side up on the form.
90° (Landscape) - the barcode is rotated 90 degrees to the left (counterclockwise).
180° (Portrait) - the barcode is upside down.
270° (Landscape)- the barcode is rotated 270 degrees to the left (counterclockwise).
Image Capture Field Settings for Barcode.
- Signature Presence - detect for the presence of a handwritten signature
- Field Settings (Image Adjustments):
- Brighten Selection - increase the brightness of the image
- Sharpen Selection - increase the contrast between light and dark regions to bring out features.
- Normalize Selection - change the range of pixel intensity values to increase the contrast, e.g. in cases of poor contrast due to glare
- Compress output image - enter the percentage to compress the file
- Output: select the orientation to rotate the output of the region:
- 0° (Portrait) - the barcode is right-side up on the form
- 90° (Landscape) - the barcode is rotated 90 degrees to the left (counterclockwise)
- 180° (Portrait) - the barcode is upside down
- 270° (Landscape) - the barcode is rotated 270 degrees to the left (counterclockwise)
Image Capture Field Settings for Picture.
MultiBarcode is restricted to a maximum of 20 Fields. If a MultiBarcode Field is set with Auto Group Identification, an additional 10 Fields can be created beyond that particular Field. Only 1 Field can be set with Auto Group Identification. If more than 1 Field is set, an error will occur.
- Mandatory Field - a barcode must be present on the Target document. Enabled by default. Disable this option if a barcode is not required to be present.
- Also Read Value from Field - sets the Template to acquire data from a Field that is designated as a Mandatory Field.
Auto Group Identification - rather than defining the decode data options of the group (e.g. Starts With or Contains), NG SimulScan can automatically group (n) number of barcodes when a common pattern is detected, such as same decoder, same first 1 or 2 characters of data, and same string length. Restricted to a maximum of 10 Fields per group. The quantity (n) of the group of common barcodes is not fixed; the quantity will change but is dictated by one of the following quantity options:
- Barcode - a separate mandatory barcode ("Quantity Barcode”) that specifies the quantity of barcodes to capture, must be present on the Document along with the data barcode. The Quantity Barcode must start with either the letter "Q" or "q", or the barcode length must be a numeric value that is 3 digits or less.
- Return quantity barcode data with results - the quantity of barcodes is output along with the scanned barcode data
- User/System Defined - sets the quantity of barcodes to scan through the DataWedge UI under Template params or with DataWedge SetConfig intent API by setting
common_barcode_dynamic_quantityto the desired quantity.
MultiBarcode sample containing quantity barcode and barcodes that can be grouped for Auto Group Identification
Enable Character Checking - uses the barcode data to aid in identification of the barcode with the following option(s):
Starts With - The acquired barcode data must start with the character(s) specified in order to be accepted. Leave blank if not needed. "+" allows for additional characters to be specified for this condition. The barcode is accepted if any of the conditions are met.
Contains - Specify the character(s) the barcode must contain in order to be accepted. "+" allows for additional characters to be specified for this condition. The barcode is accepted if any of the conditions are met.
- At - Specify the index to indicate the position where to begin the search of the specified character. The index is zero-based; the first character in the string has index 0.
String Length - Enter the number of characters the barcode data must contain. Leave blank if not needed.
MultiBarcode Field Settings.
The Template Settings panel is used to configure settings such as form identifier, output, image correction and other settings that apply generally across the Template.
To access the Template Settings panel:
- Log into the Template Builder web site.
- Open the Template in need of settings adjustment.
- Click on Template Settings or from the top menu select Edit > Template Settings.
- Adjust settings as needed according to descriptions that follow depending on the Document Type of the Template.
Form Identifier - determines how the form is identified, based on the presence of:
- Border - detects if the form has an enclosed border; a border line is present, enclosing the contents of the form. The form must have black borders surrounding all four sides or be bordered by a contrasting background, otherwise the document cannot be captured.
- Anchor Barcode - detects for the presence of an Anchor Barcode, a barcode that is located in a fixed location across different types of the same form (yet can contain different data). Other Fields on the form (e.g. signature, address) are output as cropped images.
Output Entire Form - output the entire form as an image, along with the extracted data. Enabling this option affects scanning performance.
- Normalize - change the range of pixel intensity values to increase the contrast, e.g. in cases of poor contrast due to glare, prior to outputting the entire form
Reset all Settings - reset all template settings to the default settings.
Template Settings for Image Capture.
- Data Formatting:
- Prefix to Data - enter the alphanumeric character to prepend to each data captured prior to output
- Suffix to Data - enter the alphanumeric character to append to each data captured prior to output
- Reset all Settings - reset all template settings to the default settings.
Template Settings for MultiBarcode.
Template Builder provides a Validation feature, which verifies template Fields and returns useful information about Field properties and settings prior to actual use.
To Validate Template:
Open the Template to be validated and select Edit > Validate Template.
A Validation Summary is displayed with one of more of the following messages:
- The Template successfully identified the target Document.
- At least two Fields have been designated "Use field to identify the form" to identify the document.
- Barcode Field(s) designated as “Use field to identify the form" use a supported decoder and its length is within the supported range.
- The uploaded image of the target Document is clear and its resolution is correct (2 MP for MultiBarcode, 3 MP for Image Capture).
Key field(s) identified in template:
- Required attribute(s) (e.g. name, number) found for each marked region.
- (√) = "Success!"
- (X) = "Error!"
Validation Summary showing success.
Following validation, test results can be reviewed by clicking on View Preview button as in the image below.
The image below shows a validation preview. Clicking on any Field in the image area displays in the left-hand column the data that is parsed by that Field.
Validation Preview of an Image Capture sample.
The Validation process may fail due to any of the following reasons, based on the template type.
For Anchor Barcode-based forms:
- Error Message: "Anchor barcode orientation is not properly set."
Suggested Solution: Properly set the orientation of the anchor barcode.
- Error Message: "Contents are widely spread."
Suggested Solution: If the contents on the form are widely spread apart, one Anchor barcode may not be sufficient. More than one Anchor barcode would be required.
For Border-based forms:
- Error Message: "Form image is not cropped properly."
Suggested Solution: If Auto Crop does not crop the image of the form properly, disable Auto Crop and manually crop the image.
- Error Message: "Image Resolution is too poor for barcodes fields to be processed/decoded."
Suggested Solution: Download the template to the device and perform a test with a physical label. If it fails, try recreating the template with a better image resolution.
- Error Message: "At least one Template Field cannot be found (i.e. it is looking for a barcode with character checking and it is not found)."
Suggested Solution: Decode each barcode individually on the form to ensure that all the rules of the template can be met. If at least one field is missing, then the Template will not work.
- Error Message: "One or more Barcodes are damaged and cannot be decoded."
Suggested Solution: Ensure that each barcode can be decoded with the mobile computer. Once validated, the template should work successfully on the device. If the barcode cannot be decoded on the device, then try another label that can be decoded.
After settings are configured and validated, select File > Download Template to download a copy to the local host. Zebra recommends testing all Templates before deployment to devices to ensure proper operation.
Once downloaded, the Template can be deployed to mobile computer devices. DataWedge Mgr CSP generates the XML file to be used by StageNow or an EMM (Enterprise Mobile Management) system to deploy to the devices. Refer to:
Configure the DataWedge profile for the Template as follows:
- Select Camera or 2D Imager under Scanner Selection.
- NextGen SimulScan Configuration is configured properly:
- Document Selection displays the desired Template file.
- Scanning Mode is set to Document Capture.
- If known, select the appropriate Decoders and corresponding parameters to improve scanning performance.
- For MultiBarcode templates, if Auto Group Identification and User/System Defined are enabled in Template Builder, DataWedge must be configured with the expected quantity of barcodes - select Template params and specify the User-defined Barcode Quantity.
- Set other parameters as needed, e.g. UPC/EAN params, Reader params, etc.
- Associate the app with the DataWedge profile so it can receive the data.
The Template is ready to be used. See the Content Provider Programmer's Guide to retrieve and process the acquired data so it can be output to the application.
Existing Templates can be modified to address changes that occur to incoming Documents, to allow for workflow changes, to make adjustments to settings based on input from the field, or for any other reason.
Warning: Do not attempt to modify the Template file by hand. Templates contain machine-generated XML stored in Base64-encoded files, and are not intended to be edited manually.
To modify an existing Template:
- Log into the Template Builder web site.
- Click the Open Template button or select File > Open Template to Open the template to be modified.
- Edit Template settings as required.
- Save using File > Save Template or File > Save As... to create a new version.
- Test, Validate and Deploy as explained above.