DataWedge Manager - TechDocs

• DataWedge Manager

X MX Version On Device: 4.0 4.1 4.2 4.3 5.0 OSX Version On Device: 1.0 1.2 1.3.4-56 3.4 3.5 3.6 4.1 4.2 4.3 4.4 Android Version On Device: 6.0 Marshmallow 5.1 Lollipop 5.0 Lollipop 4.4 Kitkat 4.3 Jellybean 4.2.x Jellybean 4.1.x Jellybean 4.0.3-4.0.4 Ice Cream Sandwich 4.0-4.0.2 Ice Cream Sandwich 2.3.3-2.3.4 Gingerbread Save ChangesClear Changes DataWedge Manager

To display only the features present on a particular device, select one or more filters from the SmartDocs bar below.

Input fields accept ENGLISH ONLY.

Queries from MX are not supported on Zebra devices running Android 11 or later. See alternative method.

Toggle navigation

• SmartDocs

• Your Device:

• OSX: All
  • All
  • 1.0
  • 1.2
  • 1.3
  • 3.4
  • 3.5
  • 3.6
  • 4.1
  • 4.2
  • 4.3
  • 4.4
  • 5.0
  • 5.1
  • 5.2
  • 5.3
  • 6.2
  • 6.3
  • 7.0
  • 7.1
  • 7.2
  • 7.3
  • 7.4
  • 8.0
  • 8.1
  • 9.0
  • 9.1
  • 9.2
  • 10.0
  • 10.5
  • 11.x
  • 13.x
  • 14.x
  • 15.x
• MX: All
  • All
  • 4.0
  • 4.1
  • 4.2
  • 4.3
  • 4.4
  • 5.0
  • 5.1
  • 5.2
  • 6.0
  • 6.1
  • 6.2
  • 6.3
  • 7.0
  • 7.1
  • 7.2
  • 8.0
  • 8.1
  • 8.2
  • 8.3
  • 8.4
  • 9.0
  • 9.1
  • 9.2
  • 9.3
  • 10.0
  • 10.1
  • 10.2
  • 10.3
  • 10.4
  • 10.5
  • 11.1
  • 11.2
  • 11.3
  • 11.4
  • 11.5
  • 11.6
  • 11.7
  • 11.8
  • 11.9
  • 13.1
  • 13.2
  • 13.3
  • 13.4
  • 13.5
  • 14.0
  • 14.1
  • 14.2
  • 15.0
• Android: All
  • All
  • Android 15 (API 35)
  • Android 14 (API 34)
  • Android 13 (API 33)
  • Android 11 (API 30)
  • Android 10 (API 29)
  • 9.0 Pie (API 28)
  • 8.1 Oreo (API 27)
  • 8.0 Oreo (API 26)
  • 7.1 Nougat (API 25)
  • 7.0 Nougat (API 24)
  • 6.0 Marshmallow (API 23)
  • 5.1 Lollipop (API 22)
  • 5.0 Lollipop (API 21)
  • 4.4 KitKat (API 19)
  • 4.3 Jelly Bean (API 18)
  • 4.2.x Jelly Bean (API 17)
  • 4.1.x Jelly Bean (API 16)
• Model: All
  • All Devices
  • ET40/ET45
  • Professional Series
  • WS5x

X

About SmartDocs

The "SmartDocs" bar can customize this page to show only the features present on a particular Zebra device.

1. Use drop-downs to select the OSX, MX and/or Android version on the device, and/or the device Model, which highlights features supported in the device. Unsupported features turn gray based on selection(s).
2. SmartDocs Nav works when viewing features of an individual CSP. To use, click on a CSP (i.e. "App Manager") and make at least one selection in the SmartDocs bar. Unsupported features turn grey. Click the forward and back SmartNav buttons to scroll to the next and previous supported feature of that CSP (SmartNav is not supported on the feature matrix).
3. To clear all selections press the SmartDocs button.

OSX, MX and Android version information for a device can be found in the Android Settings panel or by querying the device through ADB, EMDK or the MX CSP. More info.

• The OSX layer provides extensions to the base operating system to implement functionality not offered by Android. The root OSX version number always matches the root number of the Android version that it extends. More info.
• The MX Management System provides a uniform interface into privileged and unprivileged Android APIs on the device. Some features require a specific pairing of MX and OSX versions. More info.
• The Android version is sometimes enough to determine a feature set. Others require a specific MX version plus a minimum version of Android.
• The Device Model indicates which subset of MX features is present in the device.

Overview

The DataWedge Manager (DataWedgeMgr) enables control of the Zebra DataWedge data acquisition service for Android devices programmatically or through an Enteprise Mobility Management system. DataWedge allows any application on the device to acquire data from any of a device's input sources, including barcode scanners and MSR and RFID readers, and to manipulate the data as needed based on simple options or complex rules.

NOTE: This CSP is supported only on devices with DataWedge 7.6 or later.

Main Functionality

• Enable/Disable:
  • Automatic importing of Configuration files
  • Importing of configuration files through intents
  • Settings changes by the device user
  • Importing of SimulScan templates
  • Access to intent APIs by all or whitelisted apps
  • Access to specific types of intent API (config, query, notification, runtime)

Device UI Enable/Disable

Controls whether the device user has access to the DataWedge user interface and can change configuration settings on the device.

Note: Supported only on devices with DataWedge 7.6 or later.

Status: On devices running Android 13 and later, this feature is accessible only through non-XML barcodes or .bin files generated by StageNow.

Parm Name: ManualConfiguration

Option	Name	Description	Note	Status	Requires
86	Do not change	This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained.	MX: 9.2+
1	Enable	Enables the DataWedge UI on the device.	MX: 9.2+
2	Disable	Disables the DataWedge UI on the device.	MX: 9.2+

Controlling APIs (checkbox)

Controls whether DataWedge intent APIs are accessible by apps. Selecting this option can either prevent API access by all apps or permit access only by apps included in the device's "whitelist" as configured in AccessMgr. Learn more about Secure APIs.

Note: Supported only on devices with DataWedge 8.1 or later.

Status: On devices running Android 13 and later, this feature is accessible only through non-XML barcodes or .bin files generated by StageNow.

Parm Name: ControllingAPIs

Option	Name	Description	Note	Status	Requires
0	(unchecked)	Allows all apps to access all DataWedge intent APIs.	MX: 10.1+
1	(checked)	Prevents unapproved apps from accessing DataWedge intent APIs.	MX: 10.1+

Configure APIs

Controls access to intent APIs relating to DataWedge device configuration settings such as the Get_Config and Set_Config APIs. See Access Manager for information about whitelisting. Learn more about Secure APIs.

Note: Supported only on devices with DataWedge 8.1 or later.

Status: On devices running Android 13 and later, this feature is accessible only through non-XML barcodes or .bin files generated by StageNow.

Parm Name: ConfigAPIs

Option	Name	Description	Note	Status	Requires
86	Do not change	This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained.	MX: 10.1+
1	Uncontrolled	Allows use of 'configuration' APIs by all apps.	MX: 10.1+
2	Controlled	Allows use of 'configuration' APIs only by apps in the whitelist.	MX: 10.1+

Notification APIs

Controls access to intent APIs relating to DataWedge notification settings on the device such as those for displaying scanner status and Profile information. See Access Manager for information about whitelisting. Learn more about Secure APIs.

Note: Supported only on devices with DataWedge 8.1 or later.

Status: On devices running Android 13 and later, this feature is accessible only through non-XML barcodes or .bin files generated by StageNow.

Parm Name: NotificationAPIs

Option	Name	Description	Note	Status	Requires
86	Do not change	This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained.	MX: 10.1+
1	Uncontrolled	Allows use of 'notification' APIs by all apps.	MX: 10.1+
2	Controlled	Allows use of 'notification' APIs only by apps in the whitelist.	MX: 10.1+

Query APIs

Controls access to intent APIs relating to DataWedge queries such as those for retrieving scanner information and the DataWedge version on the device. See Access Manager for information about whitelisting. Learn more about Secure APIs.

Note: Supported only on devices with DataWedge 8.1 or later.

Status: On devices running Android 13 and later, this feature is accessible only through non-XML barcodes or .bin files generated by StageNow.

Parm Name: QueryAPIs

Option	Name	Description	Note	Status	Requires
86	Do not change	This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained.	MX: 10.1+
1	Uncontrolled	Allows use of 'query' APIs by all apps.	MX: 10.1+
2	Controlled	Allows use of 'query' APIs only by apps in the whitelist.	MX: 10.1+

Runtime APIs

Controls access to intent APIs relating to DataWedge device runtime settings such as Switch_Scanner and Switch_Scanner_Params APIs. See Access Manager for information about whitelisting. Learn more about Secure APIs.

Note: Supported only on devices with DataWedge 8.1 or later.

Status: On devices running Android 13 and later, this feature is accessible only through non-XML barcodes or .bin files generated by StageNow.

Parm Name: RuntimeAPIs

Option	Name	Description	Note	Status	Requires
86	Do not change	This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained.	MX: 10.1+
1	Uncontrolled	Allows use of 'runtime' APIs by all apps.	MX: 10.1+
2	Controlled	Allows use of 'runtime' APIs only by apps in the whitelist.	MX: 10.1+

Auto-import Settings Enable/Disable

This is the On/Off switch for automatic importation of DataWedge configuration files when they're pushed to the /enterprise/device/settings/datawedge/autoimport folder on the device. When enabled (option 1), settings contained in a Configuration file take effect as soon as the file is pushed to the device if DataWedge is running when the file is received. If DataWedge is not running when a config file is pushed, settings take effect the next time DataWedge is launched.

SECURITY WARNING: Automatic importation of configuration settings can cause unwanted changes to device settings that result from pushing an unauthorized file to the device. Select "Turn Off" (option 0) to prevent unauthorized changes to the DataWedge configuration from taking effect.

Note: Supported only on devices with DataWedge 7.6 or later.

Status: On devices running Android 13 and later, this feature is accessible only through non-XML barcodes or .bin files generated by StageNow.

Parm Name: AutoImporting

Option	Name	Description	Note	Status	Requires
86	Do not change	This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained.	MX: 9.2+
1	Turn On	Causes settings contained in a Configuration file to take effect as soon as the file is pushed to the device if DataWedge is running, or to be put into effect the next time DataWedge launches.	MX: 9.2+
0	Turn Off	Maintains current DataWedge settings and does not activate settings contained in a Configuration file pushed to the device. Use this option to prevent unauthorized changes to the DataWedge configuration.	MX: 9.2+

Import via Intent Enable/Disable

Controls whether Configuration files can be delivered to DataWedge by other apps on the device using intents.

Note: Supported only on devices with DataWedge 7.6 or later.

Status: On devices running Android 13 and later, this feature is accessible only through non-XML barcodes or .bin files generated by StageNow.

Parm Name: ApiImport

Option	Name	Description	Note	Status	Requires
86	Do not change	This value (or the absence of this parm from the XML) causes no change device settings; any previously selected setting is retained.	MX: 9.2+
1	Enable	Enables Configuration files to be imported programmatically through intents.	MX: 9.2+
2	Disable	Disables intent-based Configuration file imports.	MX: 9.2+

Configuration File

Used to enter the name of a file on the device containing configuration settings to import into DataWedge.

Input value rules:

• String from 0–255 characters containing name of configuration file on the device

DataWedge supports the importation of Config files (datawedge.db) and Profiles (dwprofile_profilename.db) to devices delivered through commercially available Enterprise Mobility Management (EMM) systems.

Zebra recommends using FileMgr to download or copy data configuration file(s) to either of the following device locations prior to calling DataWedgeMgr:

• /enterprise/device/settings/datawedge/autoimport*
• /data/tmp/public

* Turn off Auto-import if copying file(s) to this location.

RECOMMENDATIONS

• For the best user experience, Zebra strongly recommends that device users be advised to exit any DataWedge configuration UI screen before new Config files are remotely deployed.
• Zebra recommends applying explicit file permissions to all .db files so that DataWedge file procedures are not impeded.
• Zebra recommends deleting DataWedge configuration files from the download location after completing the staging process.

Note: Supported only on devices with DataWedge 7.6 or later.

Status: On devices running Android 13 and later, this feature is accessible only through non-XML barcodes or .bin files generated by StageNow.

Parm Name: ConfigurationFile

Requires:

• MX: 9.2+

NG SimulScan Template Action

Controls whether the NextGen SimulScan template file entered in the NextGen SimulScan Templates parameter is imported to the device. WARNING: If a template is imported with a name matching a file already the device, the existing file is replaced.

Note: Supported only on devices with DataWedge 8.0 or later.

Status: On devices running Android 13 and later, this feature is accessible only through non-XML barcodes or .bin files generated by StageNow.

Parm Name: NGSimulScanTemplates

Option	Name	Description	Note	Status	Requires
86	Do not change	This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained.	MX: 10.0+
1	add	Adds a template to the device, replacing one of the same name if it exists.	MX: 10.0+

NG SimulScan Template Name

Used to enter the full path and name of a NextGen SimulScan template file on the device to import into DataWedge.

Input value rules:

• String from 0–255 characters containing device path and file name

Note: Supported only on devices with DataWedge 8.0 or later.

Status: On devices running Android 13 and later, this feature is accessible only through non-XML barcodes or .bin files generated by StageNow.

Parm Name: NGSimulScanTemplateFile

Requires:

• MX: 10.0+