Deployment

DataWedge 13.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.

Note: Zebra Managed Configurations provides a single interface to configure Zebra Android device hardware and software.

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/tmp/public

Import NextGen SimulScan templates

Import NextGen SimulScan Templates for document capture by using StageNow. Once imported, the template appears under Document Selection in the NextGen SimulScan Configuration.

See Template Builder for instructions on how to create a NextGen SimulScan Template and NextGen SimulScan Template in DataWedge Manager CSP for more information.

Starting wtih Android 14, importing files via DataWedge Manager is not supported due to Android's file access restrictions. Zebra recommends using File Manager for importing files on Android 14 and above to comply with current Android security policies.

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

  1. Generate the template as an .XML file with Template Builder.
  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.
    c. Enter a profile name. Click Start.
    d. Select DataWedgeMgr and click on +. DataWedgeMgr is added to the list on the right. Click Add.
    e. 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.
    f. 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.

Video demonstration on how to deploy a SimulScan template using DataWedge Manager

File Manager CSP

The File Manager CSP (Configuration Service Provider) allows applications to manage device files using the MX framework, an XML-based communication platform that provides a common interface for managing capabilities and behaviors of Zebra Android devices. For example, FileMgr enables apps to download files from a server, copy files or folders within the device and delete files.

See File Manager CSP for more information.

Import NextGen SimulScan templates

Import NextGen SimulScan Templates for document capture via File Manager by using StageNow. After importing the template, it populates Document Selection under NextGen SimulScan Configuration.

See Template Builder for instructions on how to create a NextGen SimulScan Template.

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

  1. Generate the template as an .XML file with Template Builder.
  2. Copy the .XML file to the device (e.g. /storage/emulated/0/).
  3. On a host system, open StageNow to create a profile.
    a. Click on Create New Profile.
    b. Select MX 11.3 or higher and select Xpert Mode. Click Create.
    c. Enter a profile name. Click Start.
    d. Select FileMgr and click on +. FileMgr is added to the list on the right. Click Add.
    e. For NextGen SimulScan template, select or enter the following:
       • File Action: Deploy file for an application
       • Target Application File Definition: [Enter the package name and file name, e.g. "com.symbol.datawedge/ngsstemplate/Template.xml"]
       • Source Access Method: File in the Device File System
       • Source Path and File Name: [Select the file in the device system, e.g. "/storage/emulated/0/Template.xml"]
    f. 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.

image

Related Guides: