DataWedge Manager

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

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.

Parm Name: ManualConfiguration

Option Name Description Note 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.

Parm Name: ControllingAPIs

Option Name Description Note 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.

Parm Name: ConfigAPIs

Option Name Description Note 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.

Parm Name: NotificationAPIs

Option Name Description Note 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.

Parm Name: QueryAPIs

Option Name Description Note 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.

Parm Name: RuntimeAPIs

Option Name Description Note 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.

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

Parm Name: AutoImporting

Option Name Description Note 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.

Parm Name: ApiImport

Option Name Description Note 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 copying any configuration files to the /enterprise/device/settings/datawedge/autoimport folder prior to calling DataWedgeMgr with the configuration file and path. When DataWedge launches, it checks this folder and executes the following functions if files are present:

  1. Import the new file(s)
  2. Replace the existing Config file and like-named Profile(s), if any
  3. Delete the imported files
  4. Put new settings immediately into effect
Important Notes:
  • 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.

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

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.

Parm Name: NGSimulScanTemplates

Option Name Description Note 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.

Parm Name: NGSimulScanTemplateFile

Requires:

  • MX: 10.0+