Zebra Services Agent User Guide

Zebra-logo

Zebra Services Agent

Zebra-Services-Agent-product

Product Information

Specifications

  • Product Name: Zebra Services Agent
  • Model Number: MN-005031-03EN
  • Platform: Android
  • Manufacturer: Zebra Technologies Corporation

About This Guide

This guide provides comprehensive instructions for using the Zebra Services Agent (ZSA), a versatile mobile application designed to enhance the functionality of Zebra mobile computers running the Android platform.

  1. Zebra Services Battery Health (ZSBH): This feature monitors battery health on Zebra devices. It is deployed on the device via Mobile Device Management (MDM) and starts as a ZSA Service when the device boots up, and the Battery Health App runs as a service.
  2. Drop Detection: This feature uses the ZSA application’s sensitivity settings to detect and notify users when their devices fall. It detects device falls based on the sensitivity level of fall detection.
  3. Data Collection: This feature supports the collection of basic battery metrics, device information, and application-related data from non-Zebra devices. This data is then uploaded to the backend server for analysis and management.
  4. Diagnostic Tool: This tool tests the hardware functionality of Zebra devices, uploading diagnostic results to File Transfer Protocol (FTP) for troubleshooting and enhancing device uptime.
    This module tests and diagnoses the hardware functionality of Zebra mobile devices to determine
    the system’s health and functionality by performing various tests and uploading the results to a file on an FTP network. When necessary, the Zebra Help Desk uses this tool to troubleshoot device issues, using the results to determine the ideal steps for resolution. This functionality is beneficial for quickly addressing device problems, increasing worker productivity, and reducing device downtime and unnecessary returns to the Zebra Repair Center.
  5. Application Configuration: The ZSA application allows the configuration of other applications, such as Zebra Data Services (ZDS) and Wireless Insight, on Zebra devices.
  6. Device Actions: The log collection and messaging feature enables administrators to trigger log collection remotely, simplifying troubleshooting and maintenance. Additionally, messages can be sent to one or multiple devices, facilitating communication and instructions directly to users.
    The outdoor location tracking provides precise monitoring of device locations in real-time. This feature is beneficial for logistics and field service operations, ensuring devices are where they are needed most and helping track assets efficiently.

These make the ZSA a powerful tool for managing Zebra and non-Zebra devices, each with specific features tailored to maximise efficiency and performance.

Functional Overview

The ZSA mobile application features three main modules that verify the device’s battery health, diagnose its functions, and detect any drops if the device falls.

VIQF Smart Battery Health
ZSA is designed to have real-time Alert on Device capabilities for VisibilityIQ Foresight (VIQF) and Proactive Battery Replacement (PBR) Services.

NOTE: This feature can be configured using Managed Configuration through MDM or VIQ and is applicable only to Zebra devices.

Alert capabilities for VIQF

  • Identify VIQF Replace Now batteries with less than 30 days of useful life left easily through on-device battery alerts.
  • The device generates an alert message whenever it is swapped with a faulty battery. The app checks for cold battery swaps (via device reboot) and warm swaps (without device reboot).
  • Highlights battery health and battery details on the app.

Zebra-Services-Agent- (1)

Alert capabilities for PBR Services:

  • Identify faulty batteries for which a replacement is sent to the customer’s location. There is a 20-day period before an alert displays to allow the replacement battery to reach the customer’s location.
  • The device generates an alert message whenever it is swapped with a faulty battery. The app checks for cold battery swaps (via device reboot) and warm swaps (without device reboot).
  • Highlighting battery health and battery details on the app.

Zebra-Services-Agent- (1)

Drop Detection
The Drop Detection module of the ZSA mobile application uses the Android accelerometer sensor to detect when a device has been dropped. When a drop is detected, the application notifies the user and automatically uploads the fall data to the server. This feature is disabled by default but can be enabled through the settings configuration.

NOTE: This feature can be configured using Managed Configuration through MDM or VIQ and is applicable to Zebra and non-Zebra devices.

New Features
Enhanced Alert Options: In addition to standard notifications, users can now receive alerts via dialog boxes when a drop is detected. This dialog not only informs the user of the drop but also provides assistance or guidance if required, ensuring a more interactive and responsive user experience.
These enhancements offer users flexibility in how they receive alerts and ensure that they are promptly informed about device drops, with support readily available if needed. If the Admin provides access, the user can enable or disable drop detection from the settings screen.Zebra-Services-Agent- (3) Zebra-Services-Agent- (4)

Data Collection
The Data Collection Module of the ZSA mobile application is designed to gather a wide range of data to support device management and analytics. The collection interval and schedule upload can be configured and details are provided in the configuration table.

NOTE: This feature can be configured using Managed Configuration through MDM and is applicable only to non-Zebra devices.
This module provides data management capabilities, empowering administrators with detailed insights while offering the flexibility to adapt data collection practices as needed. This module collects various types of information, including:

  • Battery Information: Details about battery health and status.
  • Device Information: Specifications and operational status of the device.
  • Application Information: Comprehensive data regarding installed applications, including events such as installations, uninstallations, upgrades, and downgrades of any application on the device.
  • Application Usage: Aggregated data analysis and usage patterns of applications to provide insights into device and application performance.

The details of the last collected and uploaded data are accessible through the settings screen. Users can view this information and, if granted access by the administrator, can enable or disable data collection using the toggle button provided.

Zebra-Services-Agent- (5)

Diagnostic Tool
This module of the ZSA mobile application provides tests that verify the device’s hardware functionality to determine the system’s health and its result. When necessary, the Zebra Help Desk uses this tool to troubleshoot device issues, using the results to determine the ideal steps for resolution. This functionality is beneficial for quickly addressing device problems, increasing worker productivity, and reducing device downtime and unnecessary returns to the Zebra Repair Center.

NOTE: This feature can be configured using Managed Configuration through MDM or VIQ and is applicable to Zebra and non-Zebra devices (partially).

  1. Users access the Diagnostic Tool module from the home screen of the ZSA mobile application. The main screen of this module displays a list of tests that help identify the device’s system health and determine whether it needs to be sent to the Zebra Repair Center.Zebra-Services-Agent- (6)
  2. The Run All Test runs all the listed tests in sequence to verify the system’s health and simultaneously generates a result report.
  3. Users can perform individual tests to verify if a specific device function works correctly. After each test, the results are saved to a file and uploaded to the designated FTP network. The outcome of the test is also displayed on the test result screen.
    Below is an example of a Bluetooth test.
    • Click Run Test. Zebra-Services-Agent- (7)
    • The Testing in Progress page displays. Zebra-Services-Agent- (8)
    • After completing the test, the Result page displays. Zebra-Services-Agent- (9)
    • Users can cancel the test while it is in progress. A message prompts for confirmation with options for Yes or No. Zebra-Services-Agent- (10)
  4. The Diagnostic Tool module includes additional features, such as Settings, Configure, Test Scheduler, Upload and the option to enable or disable tests.Zebra-Services-Agent- (11)
  5. The Settings feature allows users to import diagnostic tool configurations from a configuration XML file, export the current configuration to a file for later use, or use the same configuration on different devices. The user can also configure the FTP server to upload test logs to a specific server.Zebra-Services-Agent- (12)
  6. The Configure feature provides different required configurations related to performing any test. This feature allows users to enable or disable tests and specify the time interval allocated to finish the test. The user can also view a list of sub-tests and enable or disable them from the configure test page.Zebra-Services-Agent- (13)
  7. The Test Scheduler feature allows scheduling weekly tests that are automatically executed at a specific time of the day. All the schedulers are visible on the schedule tests screen, as displayed below.Zebra-Services-Agent- (14)
  8. By selecting the Time, All Tests, and Days of the week, the tests are scheduled to run automatically in the background at the specified times on the chosen days.Zebra-Services-Agent- (15)
  9. After completing the test, whether successful or unsuccessful, the results are saved and uploaded to the designated FTP server. Users can modify server configurations via the Settings feature or the Upload feature. The Upload feature allows users to manually upload data to the FTP server anytime, even without conducting tests.Zebra-Services-Agent- (16)
Diagnostic Tool Tests Zebra Support Non-Zebra Support
Scanner Yes No
Button Yes Yes
Touch Screen Yes Yes
Bluetooth Yes No
Wi-Fi Yes No
Battery Yes No
WWAN Yes No
Audio Yes Yes
SD Card Yes Yes
USB Yes Yes
Network Yes Yes
Keyboard Yes Yes
Camera Yes Yes

Application Configuration
The Application Configuration Module of the ZSA mobile application is designed to provide advanced configuration capabilities for other applications on Zebra devices. This module empowers users to customize settings and optimize application functionality directly from the ZSA application, enhancing operational efficiency and device management. The module currently supports the customization of configuration settings for two specific applications:

NOTE: This feature can be configured using Managed Configuration through MDM or VIQ and is applicable only to Zebra devices.

  1. Zebra Data Service (ZDS): This feature enables or disables the ZDS with a customized configuration through VIQ only.
  2. Wireless Insight: This feature enables or disables the advanced logging specific to wireless communications through MDM or VIQ configuration.

Device Actions
The Device Actions Module in the ZSA mobile application offers a suite of powerful functionalities designed to enhance device management and operational efficiency. This module provides administrators with tools to interact with devices, gather valuable data, and track device locations.

Device Alert:
Administrators can display alert messages on devices either as notifications or dialogue boxes.

NOTE: This feature can be configured through VIQ and is applicable to Zebra and non-Zebra devices.

Zebra-Services-Agent- (17)

Collect Logs:
This functionality enables a one-time action to apply custom configurations to RxLogger for a specified duration. Additionally, this feature supports the inclusion of Diagnostic Tool during the logging period.

NOTE: This feature can be configured through VIQ and is applicable only to Zebra devices.

Zebra-Services-Agent- (18)

Outdoor Location Tracking:
Administrators can start or stop outdoor location tracking for a specific duration, enabling real-time monitoring of device movement. The application allows configuration of the interval for location updates, ensuring that location data is collected at a frequency suitable for operational needs and resource management. The prerequisite is that the ZSA application has granted the location permission and the device’s Location Accuracy setting is enabled.

NOTE: This feature can be configured through VIQ and is applicable to Zebra and non-Zebra devices.

Zebra-Services-Agent- (19)

Configure the ZSA Mobile Application
The basic configurations for all modules of the ZSA mobile application are described in the following tables.

Table 1    system configuration

Key Description Default value Min Max
enable Enable or disable ZSA. true
log level Specifies the logging  level  (0:  Info, 1: Debug, 2: Sensitive). 1 0 2
file upload URL URL where device logs are uploaded for analysis. https:// z4z.t.eu.fs.viq.zebra.com/ systemconfig-service/api/v1/ public/upload-scan-results
file upload Retry Count The number of retry attempts for uploading files in case of failure. 3 1 5
file upload Retry Interval In Mins Time interval (in minutes) between retry attempts for file uploads. 15 15 60
Key Description Default value Min Max
data upload URL URL for uploading analytics data. https://analytics.zebra.com/ client2
data upload cycle Interval In Mins Interval (in minutes) for data upload cycles. 1440 30 1440
device Data Collection Boolean indicating whether device data collection is enabled. false
enable Device Data Collection Toggle Boolean toggle for enabling/ disabling device data collection. true

Table 2    pbrconfiguration

Key Description Default value Min Max
custommessage Custom message displayed for bad battery alerts. Default message defined by Zebra.
alertType Specifies the type of alert (0: Notification, 1: Pop with OK button, 2: Pop with OK and Need Assistance button). 0 0 2
shouldBlockDevice Boolean indicating whether the device should be blocked due to the alert. false

Table 3    drop detection

Key Description Default value Min Max
enable Boolean indicating whether drop detection is enabled. false
alertType Specifies the type of alert (0: Notification, 1: Pop with OK button, 2: Pop with OK and Need Assistance button). 0 0 2
enableDropDetectionToggle Boolean toggle for enabling/disabling drop detection. true

Table 4    dcconfiguration/battery

Key Description Default value Min Max
enable Boolean indicating whether the module is enabled. true
interval Time interval (in minutes) for data collection cycles. 15 15 1440
params Additional parameters for the module (currently empty).

Table 5    dcconfiguration/device info

Key Description Default value Min Max
enable Boolean indicating whether the module is enabled. true
interval Time interval (in minutes) for data collection cycles. 360 15 1440
params Additional parameters for the module (currently empty).

Table 6    dcconfiguration/application info

Key Description Default value Min Max
enable Boolean indicating whether the module is enabled. true
interval Time interval (in minutes) for data collection cycles. 1440 15 1440
params Additional parameters for the module (currently empty).

Table 7    dcconfiguration/application usage

Key Description Default value Min Max
enable Boolean indicating whether the module is enabled. true
interval Time interval (in minutes) for data collection cycles. 60 15 60
params Additional parameters for the module (currently empty).

Table 8    ddtconfiguration

Key Description Default value Min Max
enable DDT Enable or disable the Diagnostic Tool. true
clear DDT Data Whether to clear the Diagnostic Tool configuration. false
upload Log Condition Upload the log file for the condition only (1: Only on Failure, 2: All test logs). 1/2 1 2
action After Log Upload Action after log upload (0: Keep the log file, 1: Delete the log file). 0/1 0 1
test: name Name of the test (for example, Bluetooth). Only non- user intervention tests. None
test: schedule Specify the Day of the week for the test (for example, Monday) and the Time of the day for the test (in HH:MM format). None
test: upload To FTP Specify FTP username, FTP protocol, FTP password, and FTP server IP address. None

Table 9    application configuration

Key Description Default value Min Max
ZDS Configuration : Payload Encrypted data (specific to ZDS Configuration). None
Wireless Insight Configuration : config Id Pre-defined Configuration ID (specific to Wireless Insight Configuration, 1: Start W-Fi Analysis, 2: Start Cellular Analysis, 3: Start Wi-Fi and Cellular Analysis, 4: Stop Wi-Fi Analysis, 5: Stop Cellular Analysis, 6: Stop Wi-Fi and Cellular Analysis). 1 1 6
Wireless Insight Configuration : custom config Accepts custom wireless configuration. None

Table 10    device actions

Key Description Default value Min Max
Device Alert : message Message displayed to the user. Empty
Device Alert : alert Type Specifies the type of alert (0: Notification, 1: Pop with OK button, 2: Pop with OK and Need Assistance button). 0 0 2
Collect Log : is Diagnostic Test Required Boolean specifying whether diagnostic tests are needed. true
Collect Log : Log Duration In Mins Duration (in minutes) for log collection. 5 5 1440
Collect Log : custom Rx Logger Config Custom configuration for the RxLogger. Empty
Outdoor Location Tracking : action Action to perform (for example, start). start
Outdoor Location Tracking : collection Interval InSecs Interval (in seconds) between location data collection points. 30 30 300
Outdoor Location Tracking : collection Duration InMins Total duration (in minutes) for location tracking. 60 60 1440

These features can be configured using Managed Configuration through MDM or VIQ. To receive managed configurations, ZSA displays a foreground notification in the device notification panel.

Zebra-Services-Agent- (20)

High-Level Design Overview

The Zebra Services Agent (ZSA) includes the following elements:

  1. ZSA Mobile Device Application: This app is deployed on the device via Mobile Device Management (MDM) and starts as a service when the device boots up. The application provides user interface screens for interaction, shows notifications, and launches or terminates other Zebra applications. It is only supported on the Android platform.
  2. ZSA Server-Side Platform: The server-side software and infrastructure are hosted in Zebra’s Virtual Private Cloud on the Google Cloud Platform. The server infrastructure is a multi-tenant solution that provides data security and confidentiality.

Zebra-Services-Agent- (21)

Zebra Services Agent Requirements

Zebra Services Agent (ZSA)
Requires 14.4 MB RAM
Requires 30 MB of storage memory
The impact on battery discharge is less than 2% over 24 hours.

Prerequisites
For deploying the Zebra Services Agent (ZSA) app and enabling alert notifications on the device:

  1. The customer requires MDM to deploy APK to the devices. Supported MDM platforms are SOTI, AirWatch, and 42Gears.
  2. The devices require an Android operating system version 10 or higher.
  3. The Zebra Data Services (ZDS) and Zebra Services Agent (ZSA) must be enabled on the device. If the devices are behind a corporate firewall, ensure the ZDS and ZSA cloud servers can be reached. Below are the server info and port used by ZDS and ZSA:
  4. The ZDS uses the following sites, which must be visible on the network for ZDS operation. For more information, go to Frequently Asked Questions – ZDS.
  5. Enable network connectivity on devices (WWAN or WLAN). The ZSA app provides Device Battery Alerts for VisibilityIQ Foresight and Proactive Battery Replacement Services. Below are the methods for collecting the required data to generate alerts.

NOTE: Zebra recommends using DNS server names (instead of IP addresses) when allow listing to avoid service interruptions due to IP address changes.

Android Version and Language Support
This section shows the supported Android operating system and languages.

Android Operating System 10 and above
Languages English

Installation

  • The Zebra team shares APK files with the customer admin.
  • APK files are installed on devices via Mobile Device Management (MDM).

Information
This section provides information on Zebra Data Services (ZDS) and Diagnostic Tool. You can enable the ZDS agent using the link below:

For more information on Diagnostic Tool, refer to the link below:

2025/06/23
ZEBRA and the stylized Zebra head are trademarks of Zebra Technologies Corporation, registered in many jurisdictions worldwide. All other trademarks are the property of their respective owners. ©2025 Zebra Technologies Corporation and/or its affiliates. All rights reserved.
Information in this document is subject to change without notice. The software described in this document is furnished under a license agreement or nondisclosure agreement. The software may be used or copied only in accordance with the terms of those agreements.
For further information regarding legal and proprietary statements, please go to:

Terms of Use

Proprietary Statement
This manual contains proprietary information of Zebra Technologies Corporation and its subsidiaries
(“Zebra Technologies”). It is intended solely for the information and use of parties operating and maintaining the equipment described herein. Such proprietary information may not be used, reproduced, or disclosed to any other parties for any other purpose without the express, written permission of Zebra Technologies.

Product Improvements
Continuous improvement of products is a policy of Zebra Technologies. All specifications and designs are subject to change without notice.

Liability Disclaimer
Zebra Technologies takes steps to ensure that its published Engineering specifications and manuals are correct; however, errors do occur. Zebra Technologies reserves the right to correct any such errors and disclaims liability resulting therefrom.

Limitation of Liability
In no event shall Zebra Technologies or anyone else involved in the creation, production, or delivery of the accompanying product (including hardware and software) be liable for any damages whatsoever (including, without limitation, consequential damages including loss of business profits, business interruption, or loss of business information) arising out of the use of, the results of use of, or inability to use such product, even if Zebra Technologies has been advised of the possibility of such damages. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so the above limitation or exclusion may not apply to you.

FAQ

Can I use Zebra Services Agent on devices other than Zebra mobile computers?

No, ZSA is specifically designed for Zebra mobile computers running the Android platform.

How often should I run the Diagnostic Tool tests?

It is recommended to run the Diagnostic Tool tests regularly to ensure the system's health and performance.

Documents / Resources

PDF thumbnailZebra Services Agent
User Guide · Zebra Services Agent, Services Agent, Agent

References

Ask a Question

Use this section to ask about setup, compatibility, troubleshooting, or anything missing from this manual.

Ask a Question

Ask about setup, compatibility, troubleshooting, or anything missing from this manual. Name and email are optional.