Overview
Zebra OEMConfig is an approach to performing administrative tasks on Zebra Android devices using Android Managed Configurations (MCs). To configure a feature for which no Android Enterprise API is available, MCs is the only method available that's based on publicly available specifications developed by Google and the Android community. Below are some common questions related to OEMConfig, MCs and the schemas that drive them.
IMPORTANT
The schema for OEMConfig 9.3 (and later) includes default values ONLY for hidden restriction types; it no longer includes default values for non-hidden restriction types. This is in compliance with changes in the Google managed configuration specification.
Q: What is OEMConfig?
A: OEMConfig is a Google-sanctioned, standards-based approach for an OEM to extend the capabilities of an Android Enterprise (AE) Device Owner (DO) Device Policy Controller (DPC) running on an Android device by using a OEM-provided application. This app exposes Managed Configurations as means to access OEM-specific and privileged functions that are not provided via standard Android Enterprise APIs, such as the DevicePolicyManager.
Q: What is Zebra OEMConfig?
A: Zebra OEMConfig is Zebra’s OEM-specific application that conforms to the OEMConfig model. It provides access to Zebra-specific and privileged functions via Managed Configurations that are exposed by the Zebra OEMConfig application.
Q: What is "Legacy Zebra OEMConfig?"
A: "Legacy Zebra OEMConfig" is the original version of Zebra OEMConfig (com.zebra.oemconfig.common) and is NOT compatible with devices running Android 13 or later. It was marked with "Legacy" to indicate its replacement by "Zebra OEMConfig Powered by MX" (see below), which supports Android 11 and LATER, delivers numerous organization and navigation enhancements, and which implements an all-new schema designed according to changes mandated by Google.
While both versions can target Zebra devices running Android 11, the new version CANNOT target devices with versions PRIOR to Android 11. Organizations with devices running Android 11 and OLDER can continue to use the Legacy version indefinitely. HOWEVER, targeting devices running Android 13 or later can ONLY be done using "Zebra OEMConfig Powered by MX," the "non-legacy" version of OEMConfig. Companies with mixed device populations running Android versions older AND newer than Android 11 MUST USE BOTH versions of Zebra OEMConfig.
Q: What is "Zebra OEMConfig Powered by MX?"
"Zebra OEMConfig Powered by MX" is a new version of Zebra OEMConfig (com.zebra.oemconfig.release) for Zebra devices running Android 11 and LATER. This app delivers numerous enhancements built by Zebra, and includes an all-new schema designed according to changes mandated by Google. The new version is NOT compatible with Android 10 or older.
Q: What are Managed Configurations?
A: Managed Configurations (MCs) are a standard feature of Android Enterprise whereby any application that is installed on an Android device can choose to expose a set of name/value pairs that can be used to configure selected aspects of that application.
Q: What is a Managed Configuration schema?
A: A Managed Configuration schema is a means by which an application that chooses to expose MCs defines the set of MCs that it supports. The MC schema allows an entity, such as an Enterprise Mobility Management system (EMM) to:
- Determine whether the application does or does not expose any Managed Configurations, so the EMM knows if any configuration of the application is possible.
- Identify the set of Managed Configurations that are exposed by the application, so the EMM knows what configurations can be controlled for the application.
- Provides sufficient information to generate and display a data-driven UI that allows the EMM to support configuration of the application without requiring the EMM to have any a-priori knowledge of the application nor to put any application-specific code into their solution.
Q: What is an OEMConfig schema?
A: An OEMConfig schema is the Managed Configuration schema that defines the MCs exposed by an OEMConfig application running on a device manufactured by the corresponding OEM.
Q: What is the Zebra OEMConfig schema?
A: The Zebra OEMConfig schema is the OEMConfig schema that defines the Managed Configurations exposed by the Zebra OEMConfig application.
Q: Are OEMConfig schemas different from the Managed Configuration schemas of other applications?
A: Yes and no. Android Enterprise defines that Managed Configuration schemas built-into Android applications can be very flexible, but applications that are published to the Google Play Store are constrained to use only a very limited subset of the complexity allowed by Android Enterprise for MC schemas. This was done to limit the complexity of MCs exposed by most applications to reduce the effort for EMMs to implement basic application configuration. With Google’s approval. OEMConfig applications provided by approved OEMs can get approval to upload OEMConfig applications to the Google Play Store that use more of the MC schemas capabilities defined as part of Android Enterprise than are supported by other non-OEMConfig applications. Thus, OEMConfig schemas are generally richer and more sophisticated than the MC schemas of other applications, even though both conform to the rules defined by Android Enterprise for MC schemas.
Q: Are OEMConfig Managed Configurations used for purposes other than for MCs exposed by other applications?
A: Yes. In most cases, OEMConfig Managed Configurations are used to configure OEM-specific device-oriented settings rather than application-oriented settings. As such, configuration performed using OEMConfig MCs will often have a more global, cross-application impact, rather than a localized, application-local impact
Q: Is the Zebra OEMConfig schema different than the OEMConfig schemas of other OEMs?
A: Every OEM is free to define their OEMConfig schema in whatever way they need to suit the needs for configuring their device. Since Zebra devices have their own proprietary OEM-specific value-add features, the Zebra OEMConfig schema exposes Managed Configurations that are tailored to the needs of configuring those features.
Q: Does an EMM need to handle OEMConfig schemas differently than the Managed Configuration schemas of other applications?
A: Yes. An EMM that wants to support OEMConfig must support the richer set of MC schema elements that OEMConfig application can expose. If an EMM only supports the more restricted set allowed to be used by non-OEMConfig applications, that EMM will likely not be able to support configuration using OEMConfig applications from any OEM.
Q: Must my EMM specifically support Zebra to use Zebra OEMConfig?
A: Not really. Among the major benefits of Managed Configurations is that they allow discoverability of the configurable aspects of applications that expose them. OEMConfig is no exception. Hence any EMM that supports MCs and that supports the richer MCs schemas allowed to be exposed by OEMConfig applications should be able to configure all the aspects exposed by the OEMConfig schema of any OEM, including Zebra, without having code specifically tailored to any OEM.
Q: Are there any features of Zebra OEMConfig that may require an EMM to provide special Zebra-specific customization to be able to utilize those features via that EMM?
A: Yes and no. There are some Zebra OEMConfig features that would require an EMM to enhance their solution to offer full support for those features. But those enhancements would not be Zebra-specific. If an EMM wishes to gain the full benefit of all Zebra OEMConfig features, they would need to enhance their solution in various ways. Whether a given EMM will elect to invest in providing such features depends on their own determination of the business value they offer.
Q: Does OEMConfig mirror the features of Zebra's MX management framework?
A: No. For various reasons, features added to MX might NOT be added as OEMConfig managed configurations. This might be because the feature implements one or more "Actions" (forbidden by Google in MCs), is already implemented as a DPC function or it's useful only for device staging.
Q: Where does an OEMConfig schema come from?
A: Fundamentally, an OEMConfig schema, like any Managed Configuration schema for any application, is built into the APK of the application by referencing it from the Manifest when the APK file is built. Hence the APK file is the primary source of the schema. APIs exist in the device to acquire the schema for any application that exposes MCs, hence an application (including an EMM Agent) could acquire an OEMConfig schema on-device and send it to the EMM Server. While that is possible, it is probably not the most common case since the EMM Server would then need to receive and collate one or more schemas from every single managed device.
More commonly, an OEMConfig APK is published to the Google Play Store. The advantage of doing this is that an EMM Server can then make a server-to-server call to the Google Play Store, using the Google Play EMM API to acquire the schema for that OEMConfig APK. This is especially beneficial since the EMM can use logic identical to that used for non-OEMConfig schemas to access the OEMConfig schema for any OEMConfig application from any OEM, so long as it knows the Android Package Name of that OEMConfig application.
Since an OEMConfig schema (like any other MC) is just a file, it could also be obtained in various other ways, such as downloading it from an OEM web site, an on-line repository, etc. Ultimately, it is the decision of a given EMM vendor which methods of schema acquisition make the most sense to provide based on the use cases of the users of that EMM.
Q: Where does the Zebra OEMConfig schema come from?
A: Zebra publishes the Zebra OEMConfig schema to the Google Play Store with the Android Package Name com.zebra.oemconfig.common. This means that any EMM vendor that has registered with Google to gain access to the Google Play EMM API can acquire the Zebra OEMConfig schema from the Google Play Store. Zebra also might elect to post the Zebra OEMConfig schema on its own web site and provide it through its online repository from which OS Update and Patch images can be acquired.
Q: Do OEMConfig schemas have versions?
A: Yes and no. Since the primary source of an OEMConfig schema is the APK for the corresponding OEMConfig application that exposes that schema, and since APKs have versions, you could say by inference that any OEMConfig schema can be considered to have the version of the APK file that publishes it. The versioning applied by an OEM to an OEMConfig application may or may not provide any particularly useful information about the nature of the OEMConfig schema exposed by that application. It would probably be a mistake to make any assumptions about the relationships between two OEMConfig schemas obtained from different versions of OEMConfig APKs from the same OEM that have the same Android Package Name.
Q: Do Zebra OEMConfig schemas have versions?
A: Yes. Zebra has recognized that the Zebra OEMConfig schema will evolve over time and that EMMs will likely want to have a way to differentiate various versions of Zebra OEMConfig schemas that may be supported on various Zebra Android device and that may support different sets of capabilities. Zebra has therefore chosen to include a “hidden” Managed Configuration within every Zebra OEMConfig schema that identifies the version of that schema. This allows an EMM or Administrator that chooses to do so to differentiate versions of schemas and better organize their use.
Q: Can multiple versions of OEMConfig schemas from the same OEM be obtained from the Google Play Store?
A: Not really. The Google Play Store only allows one version of a given APK, identified by a given Package Name to be uploaded at a time. If a newer version is uploaded, it replaces the older version. This means that only the “latest and greatest” version of OEMConfig schema for a given Package Name can be acquired from the Google Play Store using the Google Play EMM API at any given time. While an OEM could post a new version of an OEMConfig application to the Google Play Store with a different Package Name, this might create confusion for customers since they would not know which Package Name to use for a given device from that OEM, unless the OEM created some clear way to identify that, such as by including device models in the Package Name or some other similar method.
Q: What's a UEM?
A: A Unified Endpoint Management (UEM) system combines mobile device management (MDM) and enterprise mobility management (EMM) systems into a single client-management tool that can manage laptops, desktops, phones, tablets and other mobile computing devices.
Q: Can OEMConfig control the Zebra RxLogger utility on the device?
A: Yes, RxLogger can be controlled through Managed Configurations deployed in XML mode using the intent CSP and the following APIs:
- Start RX Logger -
com.symbol.rxlogger.intent.action.ENABLEBegins data collection for all enabled modules; the equivalent of tapping the Start button in the RxLogger device UI. - Stop RX Logger -
com.symbol.rxlogger.intent.action.DISABLEStops data collection for all modules; the equivalent of tapping the Stop button in the UI. - Capture a log snapshot -
com.symbol.rxlogger.intent.action.BACKUP_NOWTriggers a backup for logs currently in the RxLogger folder. Files are compressed and namedBackup-<date>-<HHMMSS>.zip.
RxLogger also can be configured through a settings file (config.json) created separately and pushed to the RxLogger folder on the device. Learn more.
Example
Enable RxLogger on the device
<characteristic version="8.3" type="Intent">
<parm name="Action" value="Broadcast" />
<parm name="ActionName" value="com.symbol.rxlogger.intent.action.ENABLE" />
</characteristic>
See RxLogger docs for more information.