Deployment

DataWedge 11.0

Overview

DataWedge configurations can be deployed to devices either manually or via mass deployment. There are 2 methods for secure mass deployment: StageNow or EMM (Enterprise Management Mobility).

Prerequisites

Generate DataWedge configuration file(s) as follows:

  1. Configure DataWedge as desired on a device.
  2. Create a DataWedge profile, specifying how to acquire, process, and output data.
  3. To distribute DataWedge configurations including multiple profiles and settings, export the config file (datawedge.db).
  4. To distribute a single DataWedge profile, export the profile (dwprofile_[profilename].db, where [profilename] is the name of the profile).

Deployment Methods

After fulfilling the prerequisites to generate the DataWedge configuration file(s), select one of the following methods of deployment.

Manual Deployment

To deploy the DataWedge configuration file manually:

  1. Copy the DataWedge configuration file to the target device, e.g. the SD card folder.
  2. Import the file by browsing to the folder location and selecting the file.

Mass Deployment

There are 2 methods for mass deployment of DataWedge configurations:

  • Using StageNow - create a StageNow profile and generate the barcode to scan and deploy the configuration:
    1. Host the DataWedge configuration file on an FTP or HTTP server.
    2. Create a StageNow profile to:
      A. Select one of the following:
           (a) If using auto import, copy the configuration file from the host server to the auto import folder on the device as follows: Using File Manager CSP, specify the source file path, the path of the configuration file on the host server. Specify the target file path, using the Auto Import feature: /enterprise/device/settings/datawedge/autoimport.
           (b) If using a specific folder location, copy the configuration file from a specific location accessible by DataWedge as follows: Using File Manager CSP, specify the source file path, the path of the configuration file on the host server. Using DataWedge Manager CSP, import the configuration file from a specified path.
      B. Generate the staging barcode.
    3. Scan the generated barcode with StageNow client on the device.
  • Using EMM - select one of the following methods:
    • Push the DataWedge configuration file to the auto import file path /enterprise/device/settings/datawedge/autoimport on the device to automatically import the configuration.
    • Use StageNow to export for EMM:
      1. Select one of the following:
             A. If using auto import, copy the configuration file from the host server to the auto import folder on the device as follows: Using File Manager CSP, specify the source file path, the path of the configuration file on the host server. Specify the target file path, using the Auto Import feature: /enterprise/device/settings/datawedge/autoimport.
             B. If using a specific folder location, copy the configuration file from a specific location accessible by DataWedge as follows: Using File Manager CSP, specify the source file path, the path of the configuration file on the host server. Using DataWedge Manager CSP, import the configuration file from a specified path.
      2. Export the .XML for EMM.
      3. Push the .XML generated to devices using EMM.
    • Use Zebra Managed Configurations through Zebra OEMConfig.
    • Use DataWedge Managed Configurations.

Note:

  • Zebra Managed Configurations provides a single interface to configure Zebra Android device hardware and software. DataWedge Managed Configurations are Managed Configurations specific for DataWedge and is a subset of Zebra Managed Configurations.
  • DataWedge Managed Configurations is based on Android's Managed Configurations architecture introduced in Android 11. Prior to Android 11, these configurations are supported in DataWedge Manager CSP. Moving forward, Zebra recommends administrators to transition to Managed Configurations, which will replace DataWedge Manager CSP.

For more information on DataWedge Manager CSP and Managed Configurations, see the sections that follow.


DataWedge Manager CSP

DataWedge Manager CSP (Configuration Service Provider) securely enables mass configuration deployment with the underlying MX framework, an XML-based communications platform that serves as a common interface for managing capabilities and behaviors of Zebra Android devices. The CSP is an MX plug-in that can set or query a particular configuration, allowing DataWedge to receive and process XML files. This lets device administrators utilize StageNow to create profiles specific to configuring DataWedge and deploy through StageNow or an EMM. Features that can be configured include:

  • Control access to intent APIs
  • Enable/Disable DataWedge UI
  • Enable/Disable configuration file import via intent API
  • Enable/Disable auto import of configuration file
  • Import configuration file from specified path
  • Import NextGen SimulScan Templates

See DataWedge Manager CSP for more information.

Note: When StageNow profiles are used to configure DataWedge Manager CSP, profiles created with MX 10.1 can result to a failure in some devices running DataWedge 8.1 and 8.2. Instead, select MX 10.0 when creating the StageNow profile with DataWedge Manager CSP. This is resolved with DataWedge 8.2.62 or higher. Until DataWedge is updated to 8.2.62, features specific to DataWedge Manager CSP with MX 10.1 may not be functional.

Version History

  • DataWedge 8.1 - New Control Access to Intent APIs
  • DataWedge 8.0 - New Import NextGen SimulScan Templates
  • DataWedge 7.5 - DataWedge Manager CSP support introduced, requires at minimum MX v9.2 and StageNow v3.5.

Control Access to Intent APIs

Restrict app access to DataWedge, preventing unauthorized configuration changes, by controlling whether DataWedge APIs are accessible from all apps or only whitelisted apps. DataWedge APIs are categorized as follows:

  • Configuration APIs - Intent APIs related to retrieving, setting or removing DataWedge configuration (e.g. SetConfig, GetConfig, etc.).
  • Notification APIs - Intent APIs related to retrieving status for the DataWedge scanner, profile or configuration (e.g. Scanner Status, Configuration Change, etc.).
  • Query APIs - Intent APIs related to retrieving DataWedge information or enumerating scanners (e.g. Enumerate Scanners, Get Active Profile, etc.).
  • Runtime APIs - Intent APIs related to DataWedge runtime configuration changes (e.g. Switch To Profile, Switch Scanner Params, etc.).

Refer to the Control Access to Intent APIs guide for more details.
Note: Supported only on devices with DataWedge 8.1 or later.


Enable/Disable DataWedge UI

Controls whether the DataWedge user interface is accessible to the device user, determining the ability to change DataWedge configuration settings on the device. If disabled, DWDemo profile settings can still be modified for demonstration purposes.


Enable/Disable configuration file import via intent API

Controls whether configuration files can be imported by apps via DataWedge Import Config intent API.


Enable/Disable auto import of configuration file

Controls whether DataWedge configuration files are auto-imported when located in the /enterprise/device/settings/datawedge/autoimport folder on the device.


Import configuration file from specified path

Specifies the full path and file name to import the configuration file (datawedge.db) or profile (by default, dwprofile_<profilename>.db). Can be used instead of the default Auto-Import (/enterprise/device/settings/datawedge/autoimport) folder. The file name must adhere to the existing DataWedge file naming convention:

  • Config file is always named datawedge.db
  • Profile naming convention: dwprofile_<profilename>.db

With the introduction of scoped storage restriction on Android 11 devices, EMM (Enterprise Mobile Management) systems cannot copy files to DataWedge folders on internal or external storage (e.g. /storage/emulated/x/Android/data/com.symbol.datawedge/file, where "x" is a digit). Instead, Zebra recommends to use either of the following folders by updating the file paths in the deployment configuration (such as OEMConfig, Managed Configurations or StageNow configuration): /enterprise/device/settings/datawedge or /data/temp/public


Import NextGen SimulScan templates

Import NextGen SimulScan Templates for document capture by using StageNow. After importing the template, it populates Document Selection under NextGen SimulScan Configuration. Contact your local Zebra Sales Representative for assistance in creating the template. Refer to NextGen SimulScan Template in DataWedge Manager CSP for more information.

Steps to deploy and import a Document Capture/NextGen SimulScan template to a device:

  1. Contact your local Zebra sales representative for assistance to create a Document Capture/NextGen SimulScan template.
  2. Copy the .XML file to the device (e.g. /sdcard).
  3. On a host system, open StageNow to create a profile.
    a. Click on Create New Profile.
    b. Select MX 10.0 or higher and select Xpert Mode. Click Create.
    d. Enter a profile name. Click Start.
    e. Select DataWedgeMgr and click on +. DataWedgeMgr is added to the list on the right. Click Add.
    f. For NextGen SimulScan template, select Add/Replace a template. For Template file, enter the file path where the template is located (e.g. /sdcard/template.xml). Click Continue.
    g. Click Complete Profile.
  4. Select the desired deployment method:
    • StageNow - Generate the barcode. Open StageNow on the device and scan the barcode.
    • EMM - Click on Export for MDM to export the .XML file to deploy via EMM.

Managed Configurations

Managed Configurations are specifications developed by Google and the Android community to remotely configure installed applications, apply application restrictions and deploy these configurations through an EMM (Enterprise Mobility Management). This enables DataWedge administrators to remotely specify settings and enforce policies, such as:

  • Securely mass deploy the same data capture configurations for DataWedge across all devices.
  • Lock the DataWedge configuration to prevent unexpected changes.
  • Restrict access to DataWedge APIs by limiting access only to approved applications.

A schema defines the DataWedge features available for consumption by the EMM, providing the information necessary to present to the EMM's corresponding data-driven UI. (The UI layout may vary depending on the EMM.) This mechanism integrates DataWedge remote configuration within the EMM for seamless operation. Through this UI, the administrator can select the desired Managed Configurations.


Requirements

Requirements for use of Managed Configurations with DataWedge:

  • Zebra device with Android 11 or higher
  • DataWedge schema, included with DataWedge built-in on Zebra Android devices
  • An EMM for device deployment

Use Managed Configurations via EMM

The process to setup an EMM console to use Managed Configurations varies depending on the EMM in use. The general steps follow:

  1. Add DataWedge to the application catalog. In the EMM, browse or search DataWedge from the Google Play Store and add it to the app catalog. This automatically retrieves the corresponding schema for the app and makes the app available for deployment to the device(s) through the EMM.
  2. Configure app restrictions using Managed Configurations as described in the schema. See App Restrictions section that follows, which describes the available options. Create or update Managed Configurations described in the schema.
  3. Push a policy that deploys DataWedge and the created Managed Configurations to the device(s).

App Restrictions

DataWedge restrictions are divided into 3 separate categories listed below with the corresponding bundle names:

  1. Secure DataWedge Configuration - Controls access to DataWedge UI to prevent unexpected configuration changes. Use Configuration Security bundle.
  2. Control access to DataWedge intent APIs - Restricts application use of different types of DataWedge intent APIs. Use Intent API Access Control bundle.
  3. Secure mass deployment - Securely mass deploy DataWedge configuration files across all devices in an organization. Use Configuration Settings bundle.

App Restriction Options

The following sections provide the options available for each of the configuration bundles.

Configuration Security

Configuration Security controls the ability to lock the DataWedge configuration on the device once the configuration is deployed preventing undesired configuration changes by device users.

Restriction Name Value Display Name Description
Automatic database import 0 Off Turn off auto import feature. This helps prevent undesired DataWedge configuration updates after the final configuration is deployed.
1 On Turn on auto import feature. This automatically imports the DataWedge configuration file when present.
Manual configuration 1 Allow Allow DataWedge UI to be launched and manually configured.
2 Disallow Disallow DataWedge UI from being launched, preventing users from manually changing the DataWedge configuration.
Programmatic import 1 Allow Allow applications to import a configuration database file (profile or full configuration) by calling the DataWedge intent API.
2 Disallow Disallow applications to import a configuration database file (profile or full configuration) by calling the DataWedge intent API.

Intent API Access Control

Intent API Access Control allows access to DataWedge intent APIs only to approved applications, preventing undesired retrieval of configuration or changes in configuration.

Restriction Name Value Display Name Description
Configuration APIs 1 Uncontrolled (default) - Allow use by all applications Allow any application to access DataWedge Configuration intent API.
2 Controlled - Allow use only by AllowListed applications Allow only applications listed in the AllowList to access DataWedge Configuration intent API.
Notification APIs 1 Uncontrolled (default) - Allow use by all applications Allow any application to access DataWedge Notification intent APIs.
2 Controlled - Allow use only by AllowListed applications Allow only whitelisted applications to access DataWedge Notification intent APIs.
Query APIs 1 Uncontrolled (default) - Allow use by all applications Allow any application to access DataWedge Query intent APIs.
2 Controlled - Allow use only by AllowListed applications Allow only whitelisted applications to access DataWedge Query intent APIs.
Runtime APIs 1 Uncontrolled (default) - Allow use by all applications Allow any application to access DataWedge Runtime Intent APIs.
2 Controlled - Allow use only by AllowListed applications Allow only whitelisted applications to access DataWedge Runtime Intent APIs.

See DataWedge APIs for more information.

Configuration Settings

Configuration Settings sets the file path for files, such as configuration or template file, for mass deployment through the EMM.

Restriction Name Value Description
Configuration File File path of the configuration file String from 0–255 characters containing file path and name of configuration file on the device.

DataWedge supports importing config files (datawedge.db) and profiles (dwprofile_profilename.db) to devices delivered through an EMM. The configuration file must be copied to the DataWedge sandbox folder or download folder on the device before sending the managed configuration.
NG SimulScan Template file File path of the template file String from 0–255 characters containing file path and file name of template file on the device.

Template files (.xml file) can be copied to a folder through an EMM before sending the managed configuration.

Related Guides: