Advanced Settings

DataWedge 6.3

Overview

This guide covers advanced DataWedge features such as the importing and exporting of Profiles and Configuration files, mass deployment of those files, and Advanced Data Formatting, which allows acquired data to be manipulated based on its contents.

For this guide, a basic knowledge of DataWedge Profiles, Plug-ins and other concepts is required. If necessary, please see the About and Setup guides for additional information.

DataWedge Settings

Most of the functionality referenced in this guide will be accessed through the DataWedge Settings panel.

To access DataWedge Settings:

1. From the Profiles screen, tap the "hamburger" menu and select Settings as highlighted below. The DataWedge Settings panel appears similar to the image in Step 2. Access the DataWedge Settings panel from the Profiles screen.

2. Tap the desired feature to invoke it or change its status. The DataWedge Settings panel.

Functions of the DataWedge Settings panel:

  • DataWedge enabled - Controls the DataWedge service. Uncheck this box to disable DataWedge and return control of scanning hardware to the system.

  • Enable logging - Enables DataWedge to output logs for viewing in Logcat, Android Studio or a compatible viewer.

  • Disabled app list - Disables scanning functions for selected apps anywhere on the device.

  • Import - Invokes navigation for importing a DataWedge configuration file from device storage. This action replaces the current configuration.

  • Export - Exports the current DataWedge configuration to device storage.

  • Import Profile - Invokes navigation for importing a DataWedge Profile from device storage. If a Profile of the same name already exists in DataWedge, it will be modified by the imported one.

  • Export Profile - Exports an individual DataWedge profile to device storage.

  • Restore - Returns DataWedge on the device to factory default settings.

Logging

DataWedge provides the option of outputting system log messages for viewing through the Logcat command line tool, Android Studio or another compatible viewer, usually over a USB connection.

To Enable/Disable Logging:

From the DataWedge Settings panel, tap Enable Logging to enable or disable logging as desired.

Disable Scanning on Apps/Activities

DataWedge can prohibit certain apps from accessing its data capture services. This can be useful as a security measure to ensure that acquired data is sent only to approved apps, or simply as a means of controlling which apps will have access to the scanner. By default, all apps have access.

To Disable Data Capture for an app:

From the DataWedge Settings panel, tap Disabled app list:

A list appears showing all installed apps and packages, similar to the image below. Tap one or more app(s) or activities to add to the disabled list, scrolling as necessary.

Notes:

  • Apps/activities associated with a specific profile cannot be disabled.
  • Disabled apps/activities cannot be associated with a profile.
  • Disabling a parent package disables all of its activies.
  • A disabled activity does not disable the parent or its other activities.

Import a Config File

DataWedge can accept settings created on another device and distributed throughout an enterprise by importing a DataWedge Configuration file. This file contains Profiles, Plug-ins and all DataWedge settings, including its status (enabled/disabled), logging and other configurable parameters.

The DataWedge configuration file is always named datawedge.db.

To Import a DataWedge Configuration file:

1. From the DataWedge Settings panel, tap Import. A screen appears similar to the one in Step 2, below.

2. Navigate to the imported file on device storage using the interface provided:
Imported settings take effect immediately and overwrite all prior settings.

Export a Config File

Once DataWedge is set up and configured as desired on a device, its settings file can be exported, distributed to other devices, imported and activated automatically (or imported manually, as above).

See Configuration File Management section of this guide for other important information.

To Export a DataWedge Configuration file:

1. From the DataWedge Settings panel, tap Export as highlighted below. A screen appears similar to the one in Step 2.

2. If more than one storage device exists, tap the desired storage device, then tap Export. Only the storage device may be selected; the path will be inserted automatically.

The default path and filename of an exported configuration file is: /storage/sdcard0/Android/data/com.symbol.datawedge/files/datawedge.db

If an external SD card is installed, an alternate path can be selected: /storage/sdcard1/Android/data/com.symbol.datawedge/files/datawedge.db

3. Retrieve the file datawedge.db from the device and distribute to other devices manually or through a Mobile Device Management (MDM) system.

Import a Profile

Importing a Profile enables settings created elsewhere to quickly be activated on a device. This enables organizations to develop and fine-tune Profiles in a test lab, for example, before exporting and deploying them to the field or across an enterprise. For more information, see Export a Profile, below.

While the Profile importing process is similar to that of the Configuration file, the Profile itself is very different. A Profile is a single group of settings that control how DataWedge will behave with one or more specific applications and devices. A Config file can contain numerous Profiles as well as other DataWedge settings. Importing a Config file overwrites all previous DataWedge settings and Profiles. Importing a Profile simply adds the imported Profile to the list of available Profiles on the device. If a Profile exists on the device with the same name as the one being imported, the existing Profile will be modified by the imported one.

To Import a DataWedge Profile:

1. From the DataWedge Settings panel, tap Import Profile as highlighted below. A screen appears similar to the one in Step 2.

2. Navigate to the file being imported from device storage using the interface provided: Warning: If a Profile exists on the device with the same name as the one being imported, the existing Profile will be modified by the imported one.

Export a Profile

Once a DataWedge Profile is set up and configured as desired on a device, it can be exported and distributed for use on other devices throughout an enterprise. This enables a company to fine-tune settings for the acquisition, manipulation and disposition of data for specific applications(s), and easily propagate those settings to others in the organization.

If more than one Profile is to be created, exported and distributed at the same time, it might be beneficial to create and export the Profiles together as a single DataWedge Configuration file.

To Export a Profile:

1. From the DataWedge Settings panel, tap Export Profile as highlighted below. A list of Profiles on the device appears similar to the image in Step 2.

2. If more than one storage device exists, tap the desired storage device, then the name of the Profile to be exported, then tap Export. Only the storage device and Profile may be selected; the path will be inserted automatically.

The default path and filename of an exported Profile is: /storage/sdcard0/Android/data/com.symbol.datawedge/files/dwprofile_profilename.db

If an external SD card is installed, an alternate path can be selected: /storage/sdcard1/Android/data/com.symbol.datawedge/files/dwprofile_profilename.db

3. Retrieve the exported file from the device and distribute to other devices manually or through a Mobile Device Management (MDM) system.

Warning: If a Profile exists on the device with the same name as one being imported, the existing profile will be overwritten by the imported one.

Restore (defaults)

DataWedge has the ability to reset all user-configured settings and restore them to their original factory defaults. This action cannot be undone.

To Restore DataWedge to its factory-default settings:

1. From the DataWedge Settings panel, tap Restore as highlighted below. A confirmation screen appears similar to the image in Step 2.

2. Tap Yes to Restore factory defaults or No to cancel.

Advanced Data Formatting

DataWedge permits data acquired from barcode scanning, magstripe reading or other methods to be manipulated based on the data content. The Advanced Data Formatting (ADF) Process Plug-in can be configured to determine whether and how the data should be altered according to rules that perform actions based on specific criteria relating to the data itself. For example, a rule might be created to check the first four digits of any 16-digit number to determine if it's from a credit card affiliated with a specific bank.

ADF Components:

Rules - The containers for one or more processing Actions and the user-definable criteria that trigger Action(s). All DataWedge Output Plug-ins can contain one or more ADF rules for the processing of acquired data.

Criteria - The triggers for taking a processing Action. Criteria can be set according to input type (i.e. only data from a barcode scanner), Symbology (i.e. only Code39 data), and a specified string within the data (at a specified position in the data string and/or of a specified length). Acquired data not matching all defined criteria will not trigger Action(s). Any or all of the supported barcode types can be selected or excluded.

Actions - A set of procedures for analyzing, identifying and processing acquired data.

The four Action types:

  • Cursor movement (i.e. skip the first 10 characters)
  • Data modification (i.e remove all spaces; pad the left side with four zeros)
  • Data sending (i.e. output the last four digits)
  • Pause (i.e. pause 50 ms before executing the next action)

Creating ADF Rules

Setting up Advanced Data Formatting is done in three basic steps:

  1. Create a Rule
  2. Define Criteria to activate the Rule
  3. Define the Action(s) to be executed by the Rule

These steps are all carried out within the Advanced Data Formatting Process Plug-in, which is part of every DataWedge Output Plug-in. For further details, see the Plug-ins section of the DataWedge Setup Guide.

To Create an ADF Rule:

1. In the Profile that requires ADF, tap on Advanced data formatting as highlighted below. A screen appears similar to the image in Step 2.

2. Tap the "hamburger" menu, select New rule and enter a name for the rule. The new Rule appears with other Rules in the Output Plug-in screen similar to the image in Step 3, below.

3. Tap the new Rule to access its settings. A screen appears similar to the image in Step 4.

4. Tap Criteria as highlighted below to enter the criteria that will activate the Rule.

5. From the Criteria screen, enter the criteria that will activate the Rule based on the options below.

Action Criteria:

  • String to check for - Allows a string to be specified that if present in the acquired data will initiate the action(s) (i.e. output the acquired string). If the specified string is not present at the "Starting position" (see below), the action(s) will not be executed. DataWedge can check for the presence of alphanumeric or control characters. For example:

    • x - checks for the character "x"
    • \xhh - checks for the character with a hexadecimal value of 0xhh
    • \uhhhh - checks for the Unicode character with a value of 0xhhhh

  • String position - The starting position (starting at 0) at which to check for the string specified in the "String to check for" parameter. For example, the target string "AB" with a string position of 3 would invoke action(s) if the string "123ABC123" is acquired, but would not invoke action if the "AB" was located anywhere else in the string (or was not present). Notice that the "AB" portion of the example string begins at the fourth character from the left, which is position 3 when starting the count from 0.

  • String length - An optional parameter that allows a specific length (in characters) to be present before action(s) will be invoked. For example, if scanning U.S. Social Security numbers, a String length of nine (9) might be used as a means of initial validation.

  • Source criteria - An optional parameter that can invoke action(s) only when data is acquired by means of a barcode scanner (through which specific decoders can be further selected or excluded), or through SimulScan.

6. Tap the BACK button to save and return to the Rule screen.

To Add an Action:

7. From the Rule screen, tap "Actions" as highlighted below. Then select New action from the menu on the next screen. A scrollable list of Actions appears, similar to the image in Step 8.

8. Tap the desired Action in the Actions list, scrolling as necessary. After tapping an Action, the Rule screen reappears with that Action added to the bottom of the Actions list. For a description of each Action, see the table below.

Supported ADF Actions

Type Actions Description

Cursor Movement

Skip ahead

Moves the cursor forward by the specified number of characters.

Skip back

Moves the cursor back by the specified number of characters.

Skip to start

Moves the cursor to the beginning of the data.

Move to

Moves the cursor forward until the string specified in the data field is found.

Move past

Moves the cursor forward past the string specified in the data field.

Data Modification

Crunch spaces

Reduce spaces between words to one and remove all spaces at the beginning and end of the data.

Stop space crunch

Disables the last Crunch spaces action.

Remove all spaces

Remove all spaces in the data.

Stop space removal

Disables the last Remove all spaces action.

Remove leading zeros

Remove all zeros at the beginning of data.

Stop zero removal

Disables the previous Remove leading zeros action.

Pad with zeros

Left-pad data with the specified number of zeros.

Stop pad zeros

Disables the previous Pad with zeros action.

Replace string

Replaces a specified string with a new specified string. Both must be specified.

Stop all replace string

Stop all Replace string actions.

Remove characters

Remove the number of characters specified in given positions when send actions are executed.

Stop remove characters

Stops removing characters from subsequent send actions.

Data Sending

Send next

Sends the specified number of characters from the current cursor position.

Send remaining

Sends all data that remains from the current cursor position.

Send up to

Sends all data up to the specified string.

Send pause

Pauses the specified number of milliseconds (default = 0; max. = 1000) before executing the next action. Zebra recommends pausing 50 ms after sending any ENTER, LINE FEED or TAB character.

Send string

Sends the specified string.

Send char

Sends the specified ASCII/ Unicode character. The maximum Unicode character value can be entered is U-10FFFF (= 1114111 in decimal).

Note: To help minimize data loss, Zebra recommends sending a Pause Action of 50 ms after sending any ENTER, LINE FEED or TAB character.

9. Repeat Step 8 until all required Actions appear in an Actions list similar to the image below. Actions execute from top to bottom. To re-order an Action, drag by its "hamburger" icon. See additional notes and the example, below.
The ADF Rule screen from DataWedge 6.2 (with several configured actions).

The ADF Rule screen from DataWedge 6.2 (with no configured actions).

Action Notes:

  • Actions are processed from the top of the list downward to the bottom.
  • To reposition an Action, drag the Action by its handle (to the right of its name).
  • To delete an Action, long-press the Action name.
  • A Pause Action of 50 ms after sending ENTER, LINE FEED or TAB Actions can help minimize data loss.

Rules Notes:

  • Once a Rule is enabled (with a check mark in its Rule screen), a Rule will apply whenever its parent Profile is used.
  • All data acquired through the Profile will be processed according to the Actions defined in the Rule before being transferred to the selected Output Plug-in.
  • If no ADF rule is enabled or defined, DataWedge passes decoded data to the Output Plug-in without processing.

Non-printable Characters

When setting up an ADF data processing rule to find or replace control characters, extended ASCII characters or other non-printable characters, DataWedge supports the use of the \xNN notation to specify hex value of the character and \uNNNN notation for Unicode values.

For example, if the captured data contains the Group separator (GS) character (\x1D) and data on either side of the separator must be acquired, the following ADF actions can be added to the ADF rule:

To capture the data: 8100712345(GS)2112345678

Execute the following Actions:

  • Send data up to (\x1D)
  • Skip ahead (1)
  • Send remaining data

ADF Rule Example

The following is an example of the creation process for an Advanced Data Formatting Rule that might be typical for data processing scenarios.

Barcode scanning criteria:

  • Barcode: Code39
  • Decoded Length: 12 characters
  • Starting Position contents: "129"

How DataWedge should format the data:

  • Pad all sends with zeros to a length of 8
  • Send all data up to character X
  • Send a space character

To create an ADF rule for this example:

  1. Tap HOME -> DataWedge -> Profile0.
  2. Tap Advanced data formatting.
  3. Tap Enable.
  4. Tap Rule0.
  5. Tap Criteria.
  6. Tap String to check for. In the text box, enter "129" and Tap OK.
  7. Tap String position. Change value to 0 and Tap OK.
  8. Tap String length. Change value to 12 and Tap OK.
  9. Tap Source criteria.
  10. Tap Barcode input.
  11. Tap All decoders enabled to uncheck and disable all decoders.
  12. Tap Code39 to enable the Code39 decoder only.
  13. Tap BACK three times.
  14. Under Actions, tap and hold Send remaining until a menu appears.
  15. Tap Delete action.
  16. Tap Menu -> New action. Select Pad with zeros. The Pad with zeros Action appears in the Actions list.
  17. Tap the Pad with zeros Action.
  18. Tap How many. Change value to 8 and Tap OK.
  19. Tap BACK.
  20. Tap Menu -> New action. Select Send up to. The Send up to Action appears in the Action list.
  21. Tap the Send up to Action.
  22. Tap String. In the text box, enter "X" and Tap OK.
  23. Tap BACK.
  24. Tap Menu -> New action. Select Send char. The Send char Action appears in the Action list.
  25. Tap the Send char Action.
  26. Tap Character code. In the text box, enter 32 and Tap OK.
  27. Tap BACK.

The Rule0 screen should appear similar to the image below.

Configuration File Management

Once DataWedge is set up and configured as desired on a device, settings can be saved to a file and distributed to other devices either manually or using a Mobile Device Management (MDM) system. For further information and specific instructions, see Export a Config File and Import a Config File sections, above.

The DataWedge Configuration File is always named datawedge.db.

DataWedge Profiles are always named dwprofile_profilename.db.

Enterprise Folder

On Zebra devices, internal storage contains a directory named /enterprise that persists (is not erased) after an Enterprise reset is performed on the device. DataWedge stores its files in several directories below /enterprise, which allows them to persist after an Enterprise reset as well.

Directory Behavior:

  • /enterprise/device/settings/datawedge/enterprisereset/ - DataWedge checks this folder following an Enterprise reset and imports a configuration file and Profile(s), if present.

  • /enterprise/device/settings/datawedge/autoimport - DataWedge monitors this folder whenever it's running and immediately imports and activates any configuration file placed here, overwriting prior settings. See Auto Import, below.

Notes:

  • A DataWedge Restore operation will delete the working .db file.
  • A Factory reset deletes all files in the /enterprise folder.
  • If a datawedge.db file exists in the /enterprisereset directory, DataWedge will activate it as the new working config file.

Auto Import

DataWedge supports remote deployment of Configuration Files (datawedge.db) and Profiles (dwprofile_profilename.db) to devices through commercially available third-party Mobile Device Management (MDM) systems. When DataWedge launches, it checks the /enterprise/device/settings/datawedge/autoimport directory for the presence of such files. If any are found, it executes the functions below.

DataWedge Auto-Import routine:

  1. Import the new file(s)
  2. Replace the existing Configuration File and like-named Profile(s) (if any)
  3. Delete the imported files
  4. Put new settings immediately into effect

While DataWedge is running, it receives a system notification whenever a config file or Profile is placed in the /autoimport folder and executes the same four functions.

Notes:

  • For the best experience, Zebra strongly recommends that users be advised to exit DataWedge before new config files are remotely deployed.
  • On devices running Android KitKat or later, the /enterprise folder cannot be seen with File Explorer or other user-level tools. Moving configuration files to and from the /autoimport or /enterprisereset folders must be done programmatically, with a staging client app or MDM.
  • DataWedge will attempt to consume any of the monitored “.db” files as soon the file name(s) appear in the /autoimport folder. Therefore, it is possible for DataWedge to attempt to consume a file before it is completely written. To avoid this condition, Zebra recommends initially storing the file with an alternate extension (i.e. ".tmp") and changing the extension to .db once writing is complete. See sample code, below.
  • Zebra recommends applying explicit file permissions to the all .db files so that DataWedge will not be impeded from any of its file procedures.

Sample Code

The following sample Java code can be modified to suit individual needs. 

    //NOTE: This Java code is for demo purposes only; it has not been checked for errors.

    InputStream fis = null;
    FileOutputStream fos = null;
    String autoImportDir = "/enterprise/device/settings/datawedge/autoimport/"
    String temporaryFileName = "datawedge.tmp";
    String finalFileName = "datawedge.db";

    // Open the db as the input stream
    fis = context.getAssets().open("datawedge.db");

    // create a File object for the parent directory
    File outputDirectory = new File(autoImportDir);

    // create a temporary File object for the output file
    File outputFile = new File(outputDirectory,temporaryFileName);
    File finalFile = new File(outputDirectory, finalFileName);

    // attach the OutputStream to the file object
    fos = new FileOutputStream(outputFile);

    // transfer bytes from the input file to the output file
    byte[] buffer = new byte[1024];
    int length;
    int tot = 0;
    while ((length = fis.read(buffer)) > 0) {
            fos.write(buffer, 0, length);
            tot+= length;
    }
    Log.d("DEMO",tot+" bytes copied");

    //flush the buffers
    fos.flush();

    //release resources
    try {
            fos.close();
    }catch (Exception e){
    }finally {
            fos = null;
            //set permission to the file to read, write and exec.
            outputFile.setExecutable(true, false);
            outputFile.setReadable(true, false);
            outputFile.setWritable(true, false);
            //rename the file
            outputFile.renameTo(finalFile);
    }

Programming Notes

Capture Data, Photos in One App

It is possible to take pictures and capture barcode data using the same application if the application was designed with this in mind.

  1. Add separate Activities in the app: one for barcode scanning and another for picture taking.
  2. Create a DataWedge Profile with the following settings:
    • Associate the Profile with the picture-taking Activity
    • Disable scanning in the Profile
  3. Use the standard Android-SDK APIs to control the camera
  4. When the app is used for scanning, the default DataWedge profile will come into effect.
  5. For accessing specific decoders, processing rules or other special scanning needs, a second DataWedge Profile can be created and associated with the barcode scanning activity of the app.

Disable DataWedge

Control of barcode scanning hardware is exclusive. When DataWedge is active, Scanner and Barcode APIs of apps such as Enterprise Browser and others will be inoperative. Likewise, when an app such as Enterprise Browser controls the scanning hardware, other apps (including DataWedge) are locked out. It is therefore important to understand how to take control of a device's scanner hardware and, if necessary, release it to other apps when scanning is complete.

To disable DataWedge:

1. Start DataWedge and navigate to the Profiles list (if not shown by default).

2. Tap on the "hamburger" menu and select -> Settings:

3. Uncheck the "DataWedge enabled" checkbox. Control of scanner hardware is returned to the system.

To learn how to access DataWedge programmatically, see the Data Capture API Guide.