Analytics Manager

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

EMDK For Xamarin - 2.6

Overview

The Analytics Manager (AnalyticsMgr) controls data collection on Zebra devices running Android. Data is organized and collected according to feature groups and individual metrics within those groups. The AnalyticsMgr controls which data metrics are collected, how often and under what conditions, and whether collected data is stored on the device or in the Zebra Cloud.

Use of the Analytics Manager indicates acceptance of the Zebra End User License Agreement.

Central to Zebra Analytics is the Analytics Engine, which collects information about the operation and health of a device and its battery, radios and other components. Such data can be used to detect devices in need of maintenance, are vulnerable to a security threat, or require other attention or preventative action to maintain optimal performance and avoid failures.

Main Functionality

  • Enable/disable data collection by the Analytics Engine
  • Enable/disable ability of device user or app to change data collection setting
  • Set data collection thresholds for individual metrics
  • Control whether data is stored on the device or in the Zebra Cloud
  • Automatically clear on-device data when Analytics Engine is disabled
  • Collect usage data on Bluetooth, NFC and Wi-Fi features
  • Collect device-drop and other ruggedness info
  • Collect data on a custom (user-defined) feature
  • Limit self-update to Wi-Fi connections
  • Allow other device apps to use the AnalyticsMgr cloud transport mechanism
  • Control collection of detailed data metrics in these groups:
    • Battery and CPU Status
    • GPS Information
    • System Information
    • WLAN Performance
    • WWAN Performance
  • Control the frequency of data collection by group:
    • Never
    • Low (infrequent)
    • Medium (moderate frequency)
    • High (very often)
    • Custom interval (in minutes)

Data Analytics State

This is the On/Off switch for the Analytics Engine, which performs data collection on the device, when enabled. Enabling the Analytics Engine also launches the Elemez B2M client, which provides cloud transportation services for data collected on the device (See Enable File/Events Upload and Transport Method). Access to this parameter can be blocked with the Data Analytics Usage (EnableDAEToggle) parameter.

Use of the Analytics Manager indicates acceptance of the Zebra End User License Agreement.

Note: Enabling Analytics indicates acceptance of the Zebra End-User License Agreement.

Parm Name: AnalyticsAction

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to whether the Analytics Engine collects data on the device; any previously selected setting will be retained.

MX: 4.3+

Android API: 19+

1 Enable Enables Analytics Engine to collect data on the device. Selecting this option indicates acceptance of the Zebra End User License Agreement (referenced above).

MX: 4.3+

Android API: 19+

2 Disable Stops the Analytics Engine from collecting data and halts the Elemez B2M cloud transportation service.

MX: 4.3+

Android API: 19+

Data Analytics Usage

Controls access to the Data Analytics State (AnalyticsAction) parameter, which is the On/Off switch for the Data Analytics Engine (DAE) and data collection on the device. When the DAE Toggle is disabled (option 2), the data collection On/Off setting cannot be changed by the device user by or an app running on the device. This parameter can act as a safeguard against undesired changes to data collection activities on the device.

Parm Name: EnableDAEToggle

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) causes no settings change; any previously selected setting is retained.

MX: 7.2+

Android API: 19+

1 Enable Enables the device user or an app to switch data collection on or off.

MX: 7.2+

Android API: 19+

2 Disable Prevents the device user or an app from switching data collection on or off.

MX: 7.2+

Android API: 19+

Analytics Client Settings

This is the On/Off switch for Analytics Client Settings, which allow AnalyticsMgr to control the ability of client components (such as Stats) to submit data and events to AnalyticsMgr for processing and transport. By enabling this parameter, administrators can set limits on incoming data and events using the throttling parameters (below), and can choose whether to allow the upload of those elements to the cloud. Analytics Client Settings can be used to prevent the Analytics Engine from being overwhelmed by client activities.

Shown if: Analytics Action is set to "Enable"

Parm Name: DASettings

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to whether the Analytics Client Settings are enabled; any previously selected setting will be retained.

MX: 5.1+

Android API: 19+

1 Enable Enables Analytics Client Settings to be configured for throttling or controlling data and events upload.

MX: 5.1+

Android API: 19+

2 Disable Disables the ability to configure Analytics Client Settings for throttling or data and events upload.

MX: 5.1+

Android API: 19+

Data Throttling

Controls the maximum amount of data (in MB) that the AnalyticsMgr on a device will accept from client components (such as Stats) for processing and transport in any 24-hour period before generating "threshold crossed" events. It's important to note that throttling does not govern data collection itself, but only the transfer of data from client components to the AnalyticsMgr. When selecting a Custom value, use an integer from 1-9999.

Shown if: Analytics Action is set to "Enable" and Analytics Client Settings is set to "Enable"

Parm Name: DataThrottling

Option Name Description Note Requires
0 Do Not Change This value (or the absence of this parm from the XML) will cause no change to the Data Throttling setting; any previously selected setting will be retained.

MX: 5.1+

Android API: 19+

1 1 MB Sets the data upload limit to 1 MB per day.

MX: 5.1+

Android API: 19+

2 5 MB Sets the data upload limit to 5 MB per day.

MX: 5.1+

Android API: 19+

3 10 MB Sets the data upload limit to 10 MB per day.

MX: 5.1+

Android API: 19+

4 50 MB Sets the data upload limit to 50 MB per day.

MX: 5.1+

Android API: 19+

5 100 MB Sets the data upload limit to 100 MB per day.

MX: 5.1+

Android API: 19+

99 Custom Data Limit in MB Accepts an integer from 1-9999 to set a custom daily data upload limit (in MB).

MX: 5.1+

Android API: 19+

Events Throttling

Controls the maximum number of events that the AnalyticsMgr on a device will accept from client components (such as Stats) for processing and transport in any 24-hour period before generating "threshold crossed" events. It's important to note that throttling does not govern collection of events, but only the transfer of events from client components to the AnalyticsMgr. When selecting a Custom value, use an integer from 1-9999.

Shown if: Analytics Action is set to "Enable" and Analytics Client Settings is set to "Enable"

Parm Name: EventsThrottling

Option Name Description Note Requires
0 Do Not Change This value (or the absence of this parm from the XML) will cause no change to the Events Throttling setting; any previously selected setting will be retained.

MX: 5.1+

Android API: 19+

1 1 Sets the events upload limit to 1 event per day.

MX: 5.1+

Android API: 19+

2 5 Sets the events upload limit to 5 events per day.

MX: 5.1+

Android API: 19+

3 10 Sets the events upload limit to 10 events per day.

MX: 5.1+

Android API: 19+

4 50 Sets the events upload limit to 50 events per day.

MX: 5.1+

Android API: 19+

5 100 Sets the events upload limit to 100 events per day.

MX: 5.1+

Android API: 19+

99 Custom Events Limit Accepts an integer from 1-9999 to set the daily events upload limit to a specified number of events per day.

MX: 5.1+

Android API: 19+

Enable File/Events Upload

Determines whether files and events generated by the Analytics Engine can be uploaded to the Zebra Cloud. At no time is locally stored data available to users or third-party apps. Cloud transport is provided on Zebra devices by the Elemez B2M client, which is switched on whenever the Analytics Engine is enabled. This setting has no effect on data collection.

Shown if: Analytics Action is set to "Enable" and Analytics Client Settings is set to "Enable"

Parm Name: EnableFileUpload

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to the ability to upload file and/or events from the device to the Zebra Cloud; any previously selected setting will be retained.

MX: 5.1+

Android API: 19+

1 Disable Disables the ability to upload files and/or events from the device to the Zebra Cloud.

MX: 5.1+

Android API: 19+

2 Enable Enables the ability to upload files and/or events from the device to the Zebra Cloud.

MX: 5.1+

Android API: 19+

Clear Data

Controls whether collected data stored on the device by the Analytics Engine and/or AnalyticsMgr CSP is cleared (erased). This function is available only when the Analytics Engine is disabled.

Clearing saved data can be useful when establishing a baseline for data collection during a specific period of time or under certain usage scenarios. For example, if a device has been out of contact for a period of time, clearing "old" data can avoid reports containing data that's no longer relevant or valuable. Similarly, it might sometimes be useful to clear previous data on a device just before running a test of some kind to ensure that only the data for that test is captured.

Clear Data has no effect on Analytics data stored in the cloud.

Shown if: Analytics Action is set to "Disable"

Parm Name: ClearData

Option Name Description Note Requires
0 Do not clear This value (or the absence of this parm from the XML) will ignore any data stored on the device by the Analytics Engine and/or AnalyticsMgr CSP. Use this option to Disable the Analytics Engine and retain saved data.

MX: 5.1+

Android API: 19+

1 Clear Data Causes any data stored on the device by the Analytics Engine or AnalyticsMgr CSP to be immediately cleared (erased). Use this option to Disable the Analytics Engine and erase saved data.

MX: 5.1+

Android API: 19+

Feature Switch

Used to select device Feature(s) about which to collect usage information. For each enabled Feature, usage data is collected and reported once per 24-hour period. Such data can include the number of times a device has been dropped from a minimum height of three feet, occurrences of an application not responding (ANR) and the frequency of access to features such as Bluetooth, NFC and Wi-Fi.

This parameter also can limit updates of the AnalyticsMgr CSP and Analytics Engine to Wi-Fi connections, and allow other apps on the device to use the Analytics Manager infrastructure to upload data to the Zebra Cloud. Prior to any transport, data to be uploaded is encrypted with an RSA-AES hybrid and compressed using gzip. The Custom field permits a user-built data collection agent from 1-64 characters to be specified.

Shown if: Analytics Client is set to "Enable" and Analytics Action is NOT set to "Disable"

Parm Name: FeatureSwitch

Option Name Description Note Requires
99 Unused This parameter is unused.

MX: 6.0+

Android API: 19+

0 FileUpload Enables all apps on the device to upload data to the Zebra Cloud using the Analytics Engine cloud transport mechanism.

MX: 6.0+

Android API: 19+

1 ANR Collects information about Applications Not Responding.

MX: 6.0+

Android API: 19+

2 Ruggedness Collects information related to device drops from a height of three feet or higher.

MX: 6.0+

Android API: 19+

3 FeatureUsage Collects usage frequency of Bluetooth, NFC and Wi-Fi on the device.

MX: 6.0+

Android API: 19+

4 RestrictSelfUpdateWiFi Limits updates of the Analytics Engine and AnalyticsMgr CSP to Wi-Fi connections.

MX: 6.0+

Android API: 19+

5 DeviceInfo Collects hardware revision number, keyboard type and other hardware-related device info.

MX: 6.0+

Android API: 19+

999 Custom A free text field from 1-64 characters that allows a custom data collection agent to be specified.

MX: 6.0+

Android API: 19+

Switch Action

This is the on-off switch for a given Feature as selected in the Feature Switch. The value selected here determines whether the Analytics Engine collects data on a given Feature.

Shown if: Group Action is set to "Configure Details for a Single Group" and Feature Switch is NOT set to "Unused"

Parm Name: SwitchAction

Option Name Description Note Requires
0 Disable Disables data collection for a given Feature.

MX: 6.0+

Android API: 19+

1 Enable Enables data collection for a given Feature.

MX: 6.0+

Android API: 19+

Group Action

Controls whether to configure data collection by the Analytics Engine on all metrics groups, or on one or more individual groups. When configuring for all groups, only the frequency of data collection can be configured. Select "Configure Levels for a Single Group" to enable fine-grained data collection on individual metrics. When a single Group Name is selected, that group's configurable metrics will become available.

Metrics groups are configured separately; the setting of one group has no affect on others. For example, the Analytics Manager in one instance could be configured to enable collection of WWAN Performance metrics while other groups are instructed to retain previously configured settings using the "Do not change" command. At a later time, the CSP could be called upon to collect GPS Performance metrics with all other groups given the "Do not change" command. This scenario would allow collection of both WWAN and GPS Performance metrics. Unless explicitly changed, any previously configured settings are retained.

Shown if: Analytics Action is set to "Enable"

Parm Name: GroupAction

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to which groups of metrics are collected by the Analytics Engine or how often they are collected; any previously selected setting will be retained.

MX: 4.3+

Android API: 19+

1 Configure Levels for Multiple Groups Controls the frequency (i.e. every 10 minutes) of data collection for all metrics in a group. Each group can have its own frequency, but all selected metrics in a group must be collected at the same frequency.

MX: 4.3+

Android API: 19+

2 Configure Levels for a Single Group Controls selection of individual metrics within a group to be collected. The metrics within each group are configured independently of other groups, and not all metrics need be collected within in a group. Metrics collected in a single group will be governed by that group's frequency, but each metric can be assigned a unique collection threshold, which can selectively include or exclude it from reports based on its collected data. (See "Condition" for details).

MX: 5.1+

Android API: 19+

Group Name

Selects the Group Name for collection of detailed metrics. The Analytics Engine can collect detailed metrics on individual feature groups as identified by the Group Names listed below.

When selecting a single group for data collection, a list of the metrics on which data can be collected becomes available. Data collection for each metric can be turned on or off, and each can be assigned its own condition (or threshold) that determines whether data is collected on that metric according to the frequency selected for the group. For example, an organization might wish to begin collecting data about device batteries only after a given battery's charge cycles have exceeded a number specified as optimal for maximum battery performance. Once reached, data collection will begin for that battery at the interval selected for that feature group.

The selected frequency for a single group applies to all metrics in the group. For example, if a 30-minute interval is selected for Smart Battery, data will be collected every 30 minutes for each enabled metric in the Smart Battery group, provided that metric has met its individual threshold (if any).

Shown if: Analytics Action is set to "Enable" and Group Action is set to "Configure Details for a Single Group"

Parm Name: GroupName

Option Name Description Note Requires
1 WWAN Performance Permits collection of WWAN stats such as signal quality, outgoing call attempts, successful incoming calls and duration, radio on-time and WWAN error rates.

MX: 5.1+

Android API: 19+

2 WLAN Performance Permits collection of WLAN stats such as signal quality, transmit and receive packet and byte deltas, Wi-Fi status, IP address, DNS name, BSSID and RSSI info, roam events and radio on-time.

MX: 5.1+

Android API: 19+

3 Smart Battery Status Permits collection of battery and CPU stats, including (but not limited to) battery status, temperature, charge count and cumulative charge, level, serial and part numbers, manufacture date, voltage, backup voltage, on time and rated capacity. CPU stats include process and device CPU time deltas, device model and serial numbers, Android version and build numbers and the DataAnalytics version.

MX: 5.1+

Android API: 19+

4 System Information Permits collection of system information such as available and total device RAM and storage space.

MX: 5.1+

Android API: 19+

5 GPS Information Permits collection of GPS stats such as GPS device state, GPS on-time, current location, altitude and course heading, current GPS time and ground speed, position dilution of precision and current and maximum satellite counts.

MX: 5.1+

Android API: 19+

Metric Action

This parm is the on-off switch for a given metric. The value selected here determines whether to perform data collection on the selected metric for the Group Name under which it is selected. The same values apply to all groups (0=Disable; 1=Enable).

Shown if: Analytics Action is set to "Enable" and Group Action is set to "Configure Details for a Single Group"

Parm Name: MetricAction

Option Name Description Note Requires
0 Disable Disables data collection for a given metric.

MX: 5.1+

Android API: 19+

1 Enable Enables data collection for a given metric.

MX: 5.1+

Android API: 19+

Condition

Determines whether data will always be collected for the metric (Unconditional) or will be collected only when a user-defined Threshold (Condition) has been satisfied. In either case, data will be collected at the frequency selected for the Group Name under which the metric is listed. When a threshold is in place, data will be collected at the group frequency only after the threshhold has been satisfied.

For example, if an organization wishes to begin collecting data about device batteries only after its batteries have exceeded the optimal number of charge cycles, that number would be entered here under the Condition of "Greater Than or Equal to a Threshold Value." Once that number is reached, data about that battery would begin at the frequency selected for that feature group.

The selected frequency for a single group applies to all metrics in the group. For example, if a 30-minute interval is selected for Smart Battery, data will be collected every 30 minutes for each enabled metric in the Smart Battery group, provided that metric has met its individual threshold (if any).

Shown if: Analytics Action is set to "Enable" and Group Action is set to "Configure Details for Single Group" and Standard Metric Name is set to "Custom" and Metric Action is set to "Enable the Metric"

Parm Name: Condition

Option Name Description Note Requires
0 Unconditional Causes data to be collected according to the selected frequency for the Group regardless of data condition.

MX: 5.1+

Android API: 19+

1 Equal to a Threshold Value Causes data to be collected only when the threshold value is equal to the value given for the given metric.

MX: 5.1+

Android API: 19+

2 Less Than a Threshold Value Causes data to be collected only when the threshold value is less than to the value given for the given metric.

MX: 5.1+

Android API: 19+

3 Greater Than a Threshold Value Causes data to be collected only when the threshold value is greater than to the value given for the given metric.

MX: 5.1+

Android API: 19+

4 Less Than or Equal to a Threshold Value Causes data to be collected only when the threshold value is less than or equal to the value given for the given metric.

MX: 5.1+

Android API: 19+

5 Greater Than or Equal to a Threshold Value Causes data to be collected only when the threshold value is greater than or equal to the value given for the given metric.

MX: 5.1+

Android API: 19+

Standard Interval

Allows the data collection interval to be set. Data will be collected by the Analytics Engine on the device at the given interval for a parameter that has met its threshold or has no condition assigned. This setting will apply to all metrics under a given Group Name when detailed metrics are configured for a single group. Otherwise, the collection interval will default to Low (every 60 minutes), Medium (every 30 minutes) and High (every 10 minutes).

Shown if: Analytics Action is set to "Enable" and Group Action is set to "Configure Details for a Single Group"

Parm Name: StdInterval

Option Name Description Note Requires
5 5 minutes Sets the data collection interval at five minutes.

MX: 5.1+

Android API: 19+

10 10 minutes Sets the data collection interval at 10 minutes.

MX: 5.1+

Android API: 19+

15 15 minutes Sets the data collection interval at 15 minutes.

MX: 5.1+

Android API: 19+

30 30 minutes Sets the data collection interval at 30 minutes.

MX: 5.1+

Android API: 19+

60 1 hour Sets the data collection interval at one hour (60 minutes).

MX: 5.1+

Android API: 19+

9999 Custom Accepts an integer as the custom data collection interval (in minutes).

MX: 5.1+

Android API: 19+

Transport Method

Controls whether data collected by the Analytics Engine is stored on the device or in the cloud. When "Cloud" is the selected Transport Method, data is stored temporarily on the device until transport to the Zebra Cloud is complete. At no time is locally stored data available to users or third-party apps. Cloud transport is provided on Zebra devices by the Elemez B2M client, which is switched on whenever the Analytics Engine is enabled.

Shown if: Analytics Action is set to "Enable"

Parm Name: TransportMethod

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to the Transport Method used by the Analytics Engine; any previously selected setting will be retained.

MX: 4.3+

Android API: 19+

1 Select Cloud Transport Causes the Analytics Engine to send data to the Zebra Cloud.

MX: 4.3+

Android API: 19+

2 Select File Transport Causes the Analytics Engine to store data locally on the device.

MX: 4.3+

Android API: 19+

Analytics Command

Sends pre-set or custom commands from a remote location to the Analytics Engine on a device with instructions to perform specific actions. The EnableFileUpload parameter must be set to "2" (enabled) to perform upload commands. Please refer to the "Enable File/Events Upload" parm for details. Cloud transport is provided on Zebra devices by the Elemez B2M client, which is switched on whenever the Analytics Engine is enabled.

Shown if: Analytics Action is set to "Enable"

Parm Name: AnalyticsCommand

Option Name Description Note Requires
0 No Command This value (or the absence of this parm from the XML) will execute no command.

MX: 5.1+

Android API: 19+

1 Engine.UploadCurrentLogFile Instructs the Analytics Engine to upload the current log file.

MX: 5.1+

Android API: 19+

2 Engine.UploadAllLogFiles Instructs the Analytics Engine to upload all log files.

MX: 5.1+

Android API: 19+

3 Custom Command Accepts a custom command.

MX: 5.1+

Android API: 19+

System Information

Controls whether the Analytics Engine collects data for the metrics in the System Information Group and if so, at what frequency.

Shown if: Analytics Action is set to "Enable" and Group Action is set to "Configure Levels for Multiple Groups"

Parm Name: SystemInfo

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to whether this group of metrics is collected by the Analytics Engine or how often it is collected; any previously selected setting will be retained.

MX: 4.3+

Android API: 19+

1 None Disables System Information data collection.

MX: 4.3+

Android API: 19+

2 Low Sets System Information data to be collected every 60 minutes.

MX: 4.3+

Android API: 19+

3 Medium Sets System Information data to be collected every 30 minutes.

MX: 4.3+

Android API: 19+

4 High Sets System Information data to be collected every 10 minutes.

MX: 4.3+

Android API: 19+

System Information Metrics

Controls the selection of detailed metrics collected by the Analytics Engine for the System Information Group.

Shown if: Analytics Action is set to "Enable" and Group Action is set to "Configure Details for Single Group" and Group Name is set to "System Information"

Parm Name: SystemInfoMetrics

Option Name Description Note Requires
0 Available (free) Storage Memory Enables data collection of the amount of Storage Memory (in bytes) that is currently available for the storage of files and that is not currently allocated to existing files. In an Android device, this is the total of available storage in the SD card (if any) and the device itself.

MX: 5.1+

Android API: 19+

1 Available (free) Physical Memory Enables data collection of the amount (in bytes) of Physical Memory (RAM) that is currently available for running an application and is not currently allocated to a program already running.

MX: 5.1+

Android API: 19+

3 Total (installed) Storage Memory Enables data collection of the total amount of Storage Memory (in bytes) that is present in the device for the storage of files, regardless of whether it is currently available or in use. In an Android device, this total includes the SD card (if any) and the device itself.

MX: 5.1+

Android API: 19+

4 Total (installed) Physical Memory Enables data collection of the total amount (in bytes) of Physical Memory (RAM) that is present in the device, whether it is currently available for running an application or allocated to a program already running.

MX: 5.1+

Android API: 19+

5 Total (installed) Memory Enables data collection of the total amount of memory present in the device, which generally is the sum of the values of TotalPhysicalMemory and TotalStorageMemory.

MX: 5.1+

Android API: 19+

999 Custom Metric Allows for a custom metric to be monitored. This slot is reserved for future plug-in analytics capabilities. Consult Zebra Professional Services for availability and usage information.

MX: 5.1+

Android API: 19+

Battery and CPU Status

Controls whether the Analytics Engine collects data for metrics in the Battery and CPU Status Group and if so, at what frequency.

Shown if: Analytics Action is set to "Enable" and Group Action is set to "Configure Levels for Multiple Groups"

Parm Name: SmartBattery

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to whether this group of metrics is collected by the Analytics Engine or how often it is collected; any previously selected setting will be retained.

MX: 4.3+

Android API: 19+

1 None Disables Battery and CPU Status data collection.

MX: 4.3+

Android API: 19+

2 Low Sets Battery and CPU Status data to be collected every 60 minutes.

MX: 4.3+

Android API: 19+

3 Medium Sets Battery and CPU Status data to be collected every 30 minutes.

MX: 4.3+

Android API: 19+

4 High Sets Battery and CPU Status data to be collected every 10 minutes.

MX: 4.3+

Android API: 19+

Battery and CPU Metrics

Controls the selection of detailed metrics collected by the Analytics Engine relating to the Battery and CPU Status Group. For more information about Smart and Gifted Batteries, refer to Battery Manager.

Shown if: Analytics Action is set to "Enable" and Group Action is set to "Configure Level for a Single Group" and Group Name is set to "Smart Battery Status"

Parm Name: SmartBatteryMetrics

Option Name Description Note Requires
0 Battery Status Enables data collection of an integer to indicate battery status (1=BATTERY_STATUS_UNKNOWN, 2=BATTERY_STATUS_CHARGING, 3=BATTERY_STATUS_DISCHARGING, 4=BATTERY_STATUS_NOT_CHARGING, 5=BATTERY_STATUS_FULL).

MX: 5.1+

Android API: 19+

1 Battery Level Enables data collection of the current battery level (from 0% to 100%) as a percentage of the total capacity of the battery. If the device does not have a battery or the level of the battery cannot be determined, collected value will be null.

MX: 5.1+

Android API: 19+

2 AC Charge Count Enables data collection of the number of times since the last collection that the device has been connected to AC power and has been charging.

MX: 5.1+

Android API: 19+

3 Display On-time Enables data collection of the length of elapsed time (in seconds) that the display on the device has been on since the last time this collection API was called for the same collection Group Name. If the device does not have a display or it is not possible to track the state of the display on the device, collected value will be null.

MX: 5.1+

Android API: 19+

4 AC Charge Time Enables data collection of the length of time elapsed (in seconds) since the last collection that the device has been connected to AC power and has been charging.

MX: 5.1+

Android API: 19+

5 AC Line Status Enables data collection of the power line status (0= running on battery power; 1=connected to AC power; 2=connected to USB).

MX: 5.1+

Android API: 19+

6 Process CPU Time Delta Enables data collection of the length of CPU time (in seconds) elapsed for all processes or for a selected process since the last time this collection API was called for the same process and the same Group Name. To acquire the CPU time for all processes, no additional parameters should be provided. To acquire the CPU time for a specific process, an additional parameter must be provided to supply the executable file name (with file extension but without path) for the process. For example, “Process=30agent.exe” would request the CPU time for the MSP Agent process. If the CPU time for a specified process is requested and that process is not running, collected value will be null.

MX: 5.1+

Android API: 19+

7 Device CPU Time Delta Enables data collection of the change in the amount of CPU time (in seconds) that has been accrued since the last collection. The value returned can range from 0 to the collection frequency of the named collection Group. If the amount of accrued CPU time cannot be measured, collected value will be null.

MX: 5.1+

Android API: 19+

8 Battery Health Percentage (gifted battery) Enables data collection of the Battery Health Percentage. Health percentage is the ratio of the battery's present capacity to its design capacity. This metric applies to gifted batteries only.

MX: 5.1+

Android API: 19+

9 Battery Decommission Enables data collection of the battery decommission status. A value of "0" indicates that the battery is NOT decommissioned, and "1" that the battery is decommissioned. A Gifted Battery's decommission value is set to "1" when its Battery Health Percentage exceeds the Battery Percent Decommission Threshold. A Smart Battery's decommission value is set to "1" when its Battery Usage Number exceeds the Battery Usage Decommission Threshold.

MX: 5.1+

Android API: 19+

10 Battery Usage Decommission Threshold (Smart Battery) Enables data collection of the BatteryUsageDecommissionThreshold on Smart Batteries. The default threshold value is 400.

MX: 5.1+

Android API: 19+

11 Battery Percent Decommission Threshold (Gifted Battery) Enables data collection of the BatteryPercentDecommissionThreshold on Gifted Batteries. The default threshold value is 70%.

MX: 5.1+

Android API: 19+

12 Battery Serial Enables data collection of the battery serial number as a string.

MX: 5.1+

Android API: 19+

13 Battery Part Number Enables data collection of the battery part number.

MX: 5.1+

Android API: 19+

14 Battery Manufacture Date Enables data collection of the battery manufacture date.

MX: 5.1+

Android API: 19+

15 Battery Temperature Enables data collection of the battery's current temperature (in degrees Celsius) at the time of collection.

MX: 5.1+

Android API: 19+

16 Battery Voltage Enables data collection of the battery voltage (in volts).

MX: 5.1+

Android API: 19+

17 Battery Backup Voltage Enables data collection of the battery backup voltage (in volts).

MX: 5.1+

Android API: 19+

18 Battery Rated Capacity Enables data collection of the rated capacity of the battery.

MX: 5.1+

Android API: 19+

19 Battery Usage Number (Smart Battery) Enables data collection of the battery usage number or charge cycles (applies to Smart Batteries only).

MX: 5.1+

Android API: 19+

20 DataAnalytics Version Enables data collection of the version number of the DataAnlytics application currently in use.

MX: 5.1+

Android API: 19+

21 Device Model Enables data collection of model number (i.e. MC40, TC8000) of the device.

MX: 5.1+

Android API: 19+

22 Device Serial Enables data collection of the device serial number (as a string).

MX: 5.1+

Android API: 19+

23 Android Version Enables data collection of the Android OS version running on the device.

MX: 5.1+

Android API: 19+

24 Build Number Enables data collection of the build number (as a string) of the version of Android on the device.

MX: 5.1+

Android API: 19+

25 Battery Property Capacity Enables data collection of the battery current (in microamps).

MX: 5.1+

Android API: 19+

26 Battery Property Current Average Enables data collection of the average battery current (in microamps).

MX: 5.1+

Android API: 19+

27 Battery Extra Temperature Enables data collection of the battery temperature (in degrees Celcius).

MX: 5.1+

Android API: 19+

28 Battery Cumulative Charge Enables data collection of the total accumulated charge in all chargers. This metric applies to gifted batteries only.

MX: 5.1+

Android API: 19+

999 Custom metric Allows for a custom metric to be monitored. This slot is reserved for future plug-in analytics capabilities. Consult Zebra Professional Services for availability and usage information.

MX: 5.1+

Android API: 19+

GPS Information

Controls whether the Analytics Engine collects data for metrics in the GPS Information Group and if so, at what frequency.

Shown if: Analytics Action is set to "Enable" and Group Action is set to "Configure Levels for Multiple Groups"

Parm Name: GPSInfo

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to whether this group of metrics is collected by the Analytics Engine or how often it is collected; any previously selected setting will be retained.

MX: 4.3+

Android API: 19+

1 None Disables GPS Information data collection.

MX: 4.3+

Android API: 19+

2 Low Sets GPS Information data to be collected every 60 minutes.

MX: 4.3+

Android API: 19+

3 Medium Sets GPS Information data to be collected every 30 minutes.

MX: 4.3+

Android API: 19+

4 High Sets GPS Information data to be collected every 10 minutes.

MX: 4.3+

Android API: 19+

GPS Information Metrics

Controls the collection of status and location information from the GPS receiver in the device.

Shown if: Analytics Action is set to "Enable" and Group Action is set to "Configure Details for a Single Group" and Group Name is set to "GPS Performance"

Parm Name: GPSInfoMetrics

Option Name Description Note Requires
0 Altitude Enables data collection of the height (in meters) relative to mean sea level (MSL) detected by the GPS receiver in the device.

MX: 5.1+

Android API: 19+

1 Device State Enables data collection of the state of the GPS receiver in the device (1=enabled; 0=disabled).

MX: 5.1+

Android API: 19+

2 GPS State On-Time Delta Enables data collection of the length of time (in seconds) the GPS receiver in the device has been powered on. If the GPS has been powered off and on within a given time interval, the accumulated active time will be reported.

MX: 5.1+

Android API: 19+

3 Heading Enables data collection of the direction of travel expressed as an angle of motion (in degrees) relative to magnetic north.

MX: 5.1+

Android API: 19+

4 GPS Location Enables data collection of the current position (in decimal degrees) on the earth as a latitude and longitude pair.

MX: 5.1+

Android API: 19+

5 Positional Dilution Of Precision Enables data collection of the degree to which the overall position is affected by positional dilution of position (PDOP), which results from the position of the satellites providing the fix. A PDOP of 1.0 indicates the least dilution (and highest accuracy); and a 50.0 represents the most dilution (and least accuracy).

MX: 5.1+

Android API: 19+

6 Satellite Count Enables data collection of the number of satellites used to calculate the position.

MX: 5.1+

Android API: 19+

7 Speed Enables data collection of the travel speed (in knots) of the GPS receiver.

MX: 5.1+

Android API: 19+

8 UTC Time Enables data collection of the time of the sample as reported by the GPS in the fixed format “MM/DD/YYYY HH MM SS” (with time figure pairs separated by colons).

MX: 5.1+

Android API: 19+

9 GPS Accuracy Enables data collection of an estimate (in meters) of the location accuracy.

MX: 5.1+

Android API: 19+

10 Max Satellite Count Enables data collection on the maximum number of satellites that the device can maintain in its satellites list.

MX: 5.1+

Android API: 19+

999 Custom Metric Allows for a custom metric to be monitored. This slot is reserved for future plug-in analytics capabilities. Consult Zebra Professional Services for availability and usage information.

MX: 5.1+

Android API: 19+

WLAN Performance

Controls whether the Analytics Engine collects data for metrics in the WLAN Performance Group and if so, at what frequency.

Shown if: Analytics Action is set to "Enable" and Group Action is set to "Configure Levels for Multiple Groups"

Parm Name: WLANPerf

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to whether this group of metrics is collected by the Analytics Engine or how often it is collected; any previously selected setting will be retained.

MX: 4.3+

Android API: 19+

1 None Disables WLAN Performance data collection.

MX: 4.3+

Android API: 19+

2 Low Sets WLAN Performance data to be collected every 60 minutes.

MX: 4.3+

Android API: 19+

3 Medium Sets WLAN Performance data to be collected every 30 minutes.

MX: 4.3+

Android API: 19+

4 High Sets WLAN Performance data to be collected every 10 minutes.

MX: 4.3+

Android API: 19+

WLAN Performance Metrics

Controls the selection of detailed metrics collected by the Analytics Engine for the WLAN Performance Group. Data colleciton of WLAN Roam Events offers the following metric options:

WLAN Roam Event Options

  • ASSOCIATED - Association completed
  • ASSOCIATING - Attempting to associate with a BSS/SSID
  • AUTHENTICATING - Attempting to authenticate with a BSS/SSID. This state is entered when wpa_supplicant has found a suitable BSS and the driver is configured to authenticate accordingly.
  • COMPLETED - All authentication completed
  • DISCONNECTED - The client is not associated but is likely to start looking for an access point
  • DORMANT - An Android-specific state that is reported when a client issues an explicit DISCONNECT command
  • FOUR_WAY_HANDSHAKE - WPA 4-Way Key Handshake in progress
  • GROUP_HANDSHAKE - WPA Group Key Handshake in progress
  • INACTIVE - Inactive state (wpa_supplicant disabled)
  • INTERFACE_DISABLED - The network interface is disabled
  • INVALID - A pseudo-state that should normally never be seen
  • SCANNING - Scanning for a network
  • UNINITIALIZED - No connection to wpa_supplicant

Shown if: Analytics Action is set to "Enable" and Group Action is set to "Configure Details for a Single Group" and Group Name is set to "WLAN Performance"

Parm Name: WLANPerfMetrics

Option Name Description Note Requires
0 WLAN Receive Packet Delta Enables data collection of the number of packets that have been received as part of WLAN communications on the device since the last collection. If the device does not have WLAN support or it is not possible to track the operation of the WLAN on the device, collected value will be null.

MX: 5.1+

Android API: 19+

1 WLAN Signal Quality Enables data collection of the current WLAN signal quality on the device (from 0% to 100%) as a percentage of the best possible signal quality. If the device does not have WLAN support or it is not possible to track the operation of the WLAN on the device, collected value will be null.

MX: 5.1+

Android API: 19+

2 WLAN Transmit Package Delta Enables data collection of the number of packets that have been transmitted as part of WLAN communications on the device since the last collection. If the device does not have WLAN support or it is not possible to track the operation of the WLAN on the device, collected value will be null.

MX: 5.1+

Android API: 19+

3 WLAN Receive Byte Delta Enables data collection of the number of bytes that have been received as part of WLAN communications on the device since the last collection. If the device does not have WLAN support or it is not possible to track the operation of the WLAN on the device, collected value will be null.

MX: 5.1+

Android API: 19+

4 WLAN Transmit Byte Delta Enables data collection of the number of bytes that have been transmitted as part of WLAN communications on the device since the last collection. If the device does not have WLAN support or it is not possible to track the operation of the WLAN on the device, collected value will be null.

MX: 5.1+

Android API: 19+

5 WLAN Radio On-Time Enables data collection of the elapsed time (in seconds) that the WLAN radio on the device has been powered on since the last collection. If the device does not have a WLAN radio, has more than one, or it is not possible to track the operation of the WLAN on the device, collected value will be null.

MX: 5.1+

Android API: 19+

6 WLAN Wi-Fi Enabled Disabled Indicates whether Wi-Fi is enabled or disabled.

MX: 5.1+

Android API: 19+

7 WLAN Wi-Fi Not Connected Indicates whether network connectivity exists and whether it is possible to establish connections and pass data.

MX: 5.1+

Android API: 19+

8 WLAN IP Address Change Enables data collection of a boolean value (true or false) to indicate whether the IP address has been changed.

MX: 5.1+

Android API: 19+

9 WLAN Static DHCP IP Enables data collection of the current IP address of the device.

MX: 5.1+

Android API: 19+

10 WLAN BSSID Enables data collection of the basic service set identifier (BSSID) of the current access point in the form of a six-byte MAC address (XX XX XX XX XX XX). If no network currently connected, the collected BSSID info will be null.

MX: 5.1+

Android API: 19+

11 WLAN RSSI Enables data collection of (in dBm) the received signal strength indicator (RSSI) of the current 802.11 network.

MX: 5.1+

Android API: 19+

12 WLAN Roam Event Enables data collection of the detailed state of the supplicant's negotiation with an access point in the form of a SupplicantState static object from the "Roam Event Options" list (above).

MX: 5.1+

Android API: 19+

13 WLAN DNS Name Enables data collection of the DNS IP address being used by the access point to which the device is currently connected.

MX: 5.1+

Android API: 19+

999 Custom Metric Allows for a custom metric to be monitored. This slot is reserved for future plug-in analytics capabilities. Consult Zebra Professional Services for availability and usage information.

MX: 5.1+

Android API: 19+

WWAN Performance

Controls whether the Analytics Engine collects data for metrics in the WWAN Performance Group and if so, at what frequency.

Shown if: Analytics Action is set to "Enable" and Group Action is set to "Configure Levels for Multiple Groups"

Parm Name: WWANPerf

Option Name Description Note Requires
0 Do not change This value (or the absence of this parm from the XML) will cause no change to whether this group of metrics is collected by the Analytics Engine or how often it is collected; any previously selected setting will be retained.

MX: 4.3+

Android API: 19+

1 None Disables WWAN Performance data collection.

MX: 4.3+

Android API: 19+

2 Low Sets WWAN Performance data to be collected every 60 minutes.

MX: 4.3+

Android API: 19+

3 Medium Sets WWAN Performance data to be collected every 30 minutes.

MX: 4.3+

Android API: 19+

4 High Sets WWAN Performance data to be collected every 10 minutes.

MX: 4.3+

Android API: 19+

WWAN Performance Metrics

Controls the selection of detailed metrics collected by the Analytics Engine for the WWAN Performance Group.

Shown if: Analytics Action is set to "Enable" and Group Action is set to "Configure Details for a Single Group" and Group Name is set to "WWAN Performance"

Parm Name: WWANPerfMetrics

Option Name Description Note Requires
0 WWAN Signal Quality Enables collection of the current WWAN signal quality on the device (from 0% to 100%) as a percentage of the best possible signal quality. If the device does not have WWAN support or it is not possible to track the operation of the WWAN on the device, collected value will be null.

MX: 5.1+

Android API: 19+

1 Outgoing Call Attempts Enables data collection of the number of outgoing call attempts that have been made since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have WWAN support or if it is not possible to track the operation of the WWAN on the device, collected value will be null. On some Android phones, support for trapping outgoing calls may not be available. On such phones, this metric may report no information (i.e. values of zero).

MX: 5.1+

Android API: 19+

2 WAN Radio On-Time Enables data collection of the amount of elapsed time in seconds that the WWAN radio on the device has been powered on since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have a WWAN radio, has more than one, or it is not possible to track the operation of the WWAN on the device, collected value will be null.

MX: 5.1+

Android API: 19+

3 Incoming Call Duration Enables data collection of the amount of elapsed time in seconds that incoming calls have been in progress since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have WWAN support or it is not possible to track the operation of the WWAN on the device, collected value will be null.

MX: 5.1+

Android API: 19+

4 Success Incoming Call Enables data collection of the number of incoming calls that have been successfully connected since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have WWAN support or it is not possible to track the operation of the WWAN on the device, collected value will be null.

MX: 5.1+

Android API: 19+

5 Success Incoming Calls Enables data collection of the number of incoming calls that have been successfully connected since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have WWAN support or it is not possible to track the operation of the WWAN on the device, collected value will be null.

MX: 5.1+

Android API: 19+

6 WWAN Error Rate Enables data collection of the bit error rate (in hundreths of a percent) as of the time the call is made. If the device does not have WWAN support or it is not possible to track the operation of the WWAN on the device, collected value will be null. Note that this is not supported in CDMA-based Android phones. In GSM based phones, this metric will be reported only if supported by that specific model.

MX: 5.1+

Android API: 19+

999 Custom Metric Allows for a custom metric to be monitored. This slot is reserved for future plug-in analytics capabilities. Consult Zebra Professional Services for availability and usage information.

MX: 5.1+

Android API: 19+