Zebra OEMConfig Powered by MX
For devices with Android 11, Android 13 and later.
This guide documents managed configurations contained in the "Zebra OEMConfig Powered by MX" schema, the most recent edition. This version MUST be used when targeting Zebra devices running Android 13 and later. For devices running Android 11, this is one of two compatible OEMConfig versions. This version is NOT compatible with devices running Android 10 or older Android versions. The OEMConfig app package corresponding to this schema is com.zebra.oemconfig.release. For targeting other devices, see Legacy Zebra OEMConfig schema docs. Learn more about legacy devices.
Use this guide if:
- Targeting devices with Android 13 or later
OR... - Targeting devices with Android 11*
AND... - All desired features were present in MX 11.5 or earlier (recommended)
* Potential staging errors. See important note, below.
IMPORTANT - PLEASE READ
If targeting devices running Android 11: Google-mandated Android security enhancements required major changes to the OEMConfig schema. To help facilitate the transition for customers, Zebra developed MX 11 to be compatible with both the original OEMConfig schema and the mandate-compliant schema under development at the time. For a period of time, this required implementation of MX features in both schemas. That period ended with the completion of MX 11.5, the last version with the same set of features in both schemas.
From that point onward, only "OEMConfig Powered by MX" continued to gain new MX functionality. Therefore, if using OEMConfig 13.x to target devices running Android 11, the EMM console could present features absent from one or more targeted devices (depending on the MX version installed on the target(s)). Attempts to configure any such setting would result in a staging error.
For a list of MX features, refer to the MX Feature Matrix. Use SmartDocs to filter by version.
Android 11 Notes
- If targeting devices running Android 11 and/or OLDER:
- Zebra recommends using Legacy Zebra OEMConfig and its original schema for full compatibility.
- Legacy OEMConfig can be used indefinitely to target all devices with Android versions prior to Android 13.
- If using OEMConfig 13.x to target devices running Android 11, some MX features configurable through the EMM console might not be present on the device.
- Targeting devices with Android versions older AND newer than Android 11 requires the use of BOTH OEMConfig versions.
Terms in this Guide
Type Styling
Bold Italic type indicates values of a Managed Configuration such as On or Enable.
Bold type indicates the name of an MC, Group, Sub-group, or Sub-array, such as the System Configuration Group, the Keyboard Configuration Sub-group, the Packages Sub-array, or the State Managed Configuration.
Italic type is used for emphasis and for referencing Defined Terms, such as Sub-group and Instance. Defined terms are Capitalized to differentiate them from italics used solely for emphasis.
Android Terms
- Android Package
An Android Package is how executable code is packaged for execution on Android devices. Android Packages can be built-into the Operating System image (OS), in which case they are referred to as being built-in, pre-loaded, or pre-installed. Android Packages that are not built-in can be added to an Android device by downloading and installing them, in which case they are referred to as post-loaded, post-installed, or installable. Each Android Package is identified by a unique Android Package Name and can contain one or more Android Activities and/or Android Services.
Android defines a series of standard behaviors that will generally be exhibited by Android Packages which may vary based on whether an Android Package is pre-loaded or post-loaded and based on whether the Android Package is Trusted or Non-Trusted. Most Android Packages will fall into one of the following basic types:
- Built-in System Application
A Built-in System Package is pre-loaded as part of the OS and is granted special System Permissions on the device. This makes it a Trusted Package and allows it to interact with system services and use System APIs that are not available to Non-Trusted Packages. Zebra carefully controls and vets all such Android Packages before building them into the OS to ensure that they are safe and contribute beneficially to the overall device experience without creating performance, security, or usability issues.
- Built-in Non-System Package
A Built-in Non-System Package is pre-loaded as part of the OS but is not granted any special System Permissions on the device. This makes it a Non-Trusted Package and allows it to interact with system services and to use System APIs that are not available to Non-Trusted Packages. Zebra carefully controls and vets all such Android Packages* before building them into the OS to ensure that they contribute beneficially to the overall device experience without creating performance or usability issues.
- Installable System Package
An Installable System Package must be post-loaded, since it is not part of the OS but is granted special System Permissions on the device. This makes it a Trusted Package and allows it to interact with system services and to useSystem APIs that are not available to Non-Trusted Packages. Only Zebra can provide such Android Packages* and Zebra carefully controls and vets all such Android Packages* it provides before they are published to ensure that they are safe and contribute beneficially to the overall device experience without creating performance, security, or usability issues. Ultimately, the decision of whether to install such an Android Package* on a device is the responsibility of the Device Administrator.
- Installable Non-System Package
An Installable Non-System Package must be post-loaded, since it is not part of the OS and is not granted any special System Permissions on the device. This makes it anNon-Trusted Package and prevents it from interacting with system services and from using System APIs that are not available to Non-Trusted Packages. Zebra carefully controls and vets all such Android Packages* before they are published to ensure that they contribute beneficially to the overall device experience without creating performance or usability issues. Zebra cannot and does not control or guarantee the suitability of such Android Packages* that it does not provide. Ultimately, evaluating such an Android Package* and deciding whether to install it on a device is the responsibility of the Device Administrator.
- Android Package Name
An Android Package Name is a string that uniquely identifies one or more versions of an Android Package.
- Android Application
An Android Application refers to an Android Package that contains at least one Android Activity and therefore has some in-device UI for interacting with the User to differentiate it from other Android Packages that may only have Android Services and therefore have no UI for interacting with the User.
- Android Status Bar
The Android Status Bar is an area at the top edge of the screen on an Android device where various status information can be displayed to the User.
- Android Notification Bar
The Android Notification Bar is an area at the bottom edge of the screen on an Android device where soft buttons are provided to allow the User to navigate within the UI of the device.
Managed Configuration Terms
- MC
See Managed Configuration.
- Managed Configuration
A Managed Configuration is a single configurable item, defined within the OEMConfig Schema, that can be used, alone or in conjunction with other MCs, to change some aspect of device behavior.
- Schema
See Managed Configuration Schema.
- Managed Configuration Schema
A Managed Configuration Schema is a definition of all the of the Managed Configuration that are supported by a given application.
- Group
See Managed Configuration Group.
- Managed Configuration Group
A Managed Configuration Group is a collection of Sub-groups or Sub-arrays that are defined to control multiple related aspects of device behavior (such as System Configuration or UI Configuration). A Group can include no more than one instance of any Sub-group or Sub-array that is defined for that Group.
- Sub-group
A Sub-group is a collection of MCs, Sub-groups, or Sub-arrays that can be used to control some sub-aspect of device behavior (such as the Clock Configuration Sub-group within the System Configuration Group). A Sub-group can include no more than one instance of any MC, Sub-group, or Sub-array defined for that Sub-group.
- Sub-array
A Sub-array is an ordered list of instances of a SINGLE Sub-group, each of which can contain anything that is defined for that Sub-group. The only time the same MC, Sub-group, or Sub-array can be included more than once into the same Sub-group is when it appears within different Instances of that Sub-group within a Sub-array.
OEMConfig Terms
- OEMConfig
OEMConfig is a term invented by Zebra and adopted by Google to refer to an OEM-specific application that exposes Managed Configurations which it uses to enable configuration of OEM-specific features of the device rather than to configure application features.
- Zebra OEMConfig
Zebra OEMConfig is a term used by Zebra to refer to Zebra-specific OEMConfig application(s) provided by Zebra to configure Zebra Android devices.
- Zebra OEMConfig Schema
Zebra OEMConfig Schema is a term used to refer to a Schema for a Zebra OEMConfig application.
- Zebra OEMConfig Old Schema
Zebra OEMConfig Old Schema is a term used to refer to the Zebra OEMConfig Schema defined for the old version of the Zebra OEMConfig application with package name "com.zebra.oemconfig.common" and intended for use on Zebra Android devices with Android 11 or lower.
- Zebra OEMConfig New Schema
Zebra OEMConfig New Schema is a term used to refer to the Zebra OEMConfig Schema defined for the new version of the Zebra OEMConfig application with package name "com.zebra.mdna.oemconfig" and intended for use on Zebra Android devices with Android 11 or higher.
Zebra OEMConfig Terms
- Setting
A Setting is a Managed Configuration defined in a Zebra OEMConfig Schema that is used to enable configuration of some aspect of device behavior. A Setting generally affects the ongoing behavior of a device from the time it is applied until some subsequent time when it is changed to a new value. The order of configuration of different Settings is generally expected to have little or no impact on the end result. Further, it is generally is expected to be safe to set a Setting to the same value repetitively with no negative impact. Common examples of Settings include display timeout and network configuration.
- Action
An Action is a Managed Configuration defined in a Zebra OEMConfig Schema that is used to enable performance on a device of some operation that takes place during some unit of time, that has a beginning, a middle, and an end, and then is over. An Action MAY, but doesn’t always, cause a change in the device state that affects ongoing behavior of a device. An Action MAY be REPEATED, but should NEVER be AUTOMATICALLY repeated and should be repeated ONLY when EXPLICITLY requested by an administrator. When an Action is repeated, the corresponding operation will occur again and that MIGHT produce negative or undesirable behavior if done unintentionally or unexpectedly. In many cases, the ORDER in which multiple different Actions are performed can be quite important since it can affect the actual outcome. Common examples of Actions include performing a reboot, uninstalling an application, or wiping an SD card. The Zebra OEMConfig Old Schema heavily relied on Actions, but Google has since discouraged the use of Actions in OEMConfig applications because it can be difficult or even impossible to reliably enforce ordering and prevent repetition. For this reason, the Zebra OEMConfig New Schema eliminated all support for Actions.
- Argument
An Argument is a parameter specified for an Action that defines or adjusts the operation performed by that Action. Most Actions have at least one Argument and some Actions have multiple Arguments. Each invocation of an Action may have different Arguments to suit the reason why the Action is being performed.
- Condition
A Condition is a criteria defining when an Action should be performed. Actions are generally invoked when an administrator determines that the .Conditions are appropriate to require the operation defined by that Action and its Arguments to be performed.
- Rule
A Rule is a Setting defined in a Zebra OEMConfig Schema that is used to configure a device to perform some defined operation at some time in the future when certain defined Conditions are met. Every Rule must specify information that defines an operation to be performed AND information that defines the Conditions when that operation should be performed. In many cases, an Action can be converted into one or more Rules to help conform to the Google recommendation that OEMConfig applications should ONLY support Settings and NOT Actions. Because a Rule is a Setting, it doesn't cause the operation to be performed when it is configured, but instead sets the operation up to be performed in the future. As a result, it is generally unnecessary to worry about the order in which Rules are configured or about preventing the repetition of the configuration of Rules. Common examples of Rules include configuring a device to automatically download a file when it is not already on a device or configuring a device to update its OS when it is out of date. The Zebra OEMConfig New Schema heavily relies on Rules to replace functionality that was previously supported in the the Zebra OEMConfig Old Schema via Actions.
- Array of Rules
An Array of Rules is a mechanism that uses an Array of Rules to replace an Action. Most Actions require Arguments to define variations in the operation to be performed and each invocation of an Action could have a different combination of Arguments. To provide a similar capability, an Array of Rules can be created where each element of the Array contains a different set of Arguments and thus defines a slightly different operation to be performed. Since each element of the Array is a Rule, each element of the Array must also include information that describes the Conditions when the defined operation should be performed. By creating an Array of Rules that contains elements that define the required combination of Arguments and Conditions, comparable results can be achieved without using Actions.
Additional Terms
The above terms have been defined here because they may be generally used throughout this document. Additional terms will be defined in subsequent sections of this document as needed to clarify concepts and usage specific to those sections.
Reversing a Setting
Managed configurations work to configure devices by pushing a bundle of parameter settings to the target device. To change or undo any previously configured setting, simply resend the same bundle with a new setting, or omit the setting entirely and resend to return the managed configuration to its default.
Application Configuration
Use this Group to configure Device Central Configuration .
Detail Information:
Key = appConfig
Type = bundle
Device Central Configuration
Use this Sub-group to configure Bluetooth Pairing Control, User Control of Bluetooth State, User Control of Firmware Update, and Smart Leash.
Detail Information:
Key = deviceCentralConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Bluetooth Pairing Control
Select whether Device Central system should allow multiple pairings to the same Device Class.
- If the value Single Pairing Per Device Class is selected, Device Central system will only allow one pairing at a time for each Bluetooth Device Class (e.g. one headset and one printer).
- If the value Multiple Pairings Per Device Class is selected, Device Central system will allow multiple pairings at a time for each Bluetooth Device Class (e.g. multiple headsets and/or multiple printers).
Detail Information:
Key = appDeviceCentralBluetoothPairingControl
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Single Pairing Per Device Class | 1 |
| Multiple Pairings Per Device Class | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
User Control of Bluetooth State
Select whether the User will be allowed to use the Device Central UI to control the Bluetooth State.
If the value Disallow is selected, the User will NOT be allowed to use the Device Central UI to control the Bluetooth State.
If the value Allow is selected, the User WILL be allowed to use the Device Central UI to control the Bluetooth State.
Detail Information:
Key = appDeviceCentralBluetoothOnOffControl
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
User Control of Firmware Update
Select whether the User will be Allowed to use the Firmware Update Button within the Device Central UI to perform Firmware Updates.
- If the value Disallow is selected, the User will NOT be Allowed to use the Firmware Update Button within the Device Central UI to perform Firmware Updates.
- If the value Allow is selected, the User WILL be Allowed to use the Firmware Update Button within the Device Central UI to perform Firmware Updates.
Detail Information:
Key = appDeviceCentralFirmwareUpdateButton
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
Smart Leash
Use this Sub-group to configure State, User Access To Smart Leash Section, Audio Feedback, and Haptic Feedback.
Detail Information:
Key = dcSmartLeash
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
State
Select whether the Smart Leash active (on) or inactive (off).
- If the value Off is selected, Device Central will turn on Smart Leash.
- If the value On is selected, Device Central will turn off Smart Leash.
Detail Information:
Key = slState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
User Access To Smart Leash Section
Select whether the User will be Allowed to use the Device Central UI to configure Smart Leash.
- If the value Disallow is selected, the User will NOT be Allowed to use the Device Central UI to configure Smart Leash.
- If the value Allow is selected, the User WILL be Allowed to use the Device Central UI to configure Smart Leash.
Detail Information:
Key = slSettingsUI
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Audio Feedback
Use this Sub-group to configure State, Sound, Volume, and Repeat Count.
Detail Information:
Key = slAudioFeedback
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
State
Select whether the Smart Leash Audio Feedback is active (on) or inactive (off).
- If the value Off is selected, Device Central will turn on Audio Feedback in Smart Leash.
- If the value On is selected, Device Central will turn off Audio Feedback in Smart Leash.
Detail Information:
Key = slafState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Sound
Enter the sound to be used when the Smart Leash Audio Feedback is active (on). The name of an existing Ringtone or the fully qualified path to an audio file is expected. .wav, .ogg, .mp3 and .m4a audio file types are supported.
Detail Information:
Key = slafSound
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Volume
Enter the percentage of volume that should be used when State is set to On. Supported values range between 1 and 100.
Detail Information:
Key = slafVolume
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Repeat Count
Enter the number of times the sound should be repeated when State is set to On. Supported values range between 0 and 100.
Detail Information:
Key = slafRepeatCount
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Haptic Feedback
Use this Sub-group to configure State and Time.
Detail Information:
Key = slHapticFeedback
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
State
Select whether the Smart Leash Haptic Feedback is active (on) or inactive (off).
- If the value Off is selected, Device Central will turn on Audio Feedback in Smart Leash.
- If the value On is selected, Device Central will turn off Audio Feedback in Smart Leash.
Detail Information:
Key = slhfState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Time
Enter the duration of vibration when the State is set to On
Detail Information:
Key = slhfDuration
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Files Configuration
Use this Array to configure one or more special handlings for one or more File(s).
Files are a fundamental unit of storage in Android, via which data is organized and stored within the storage areas of an Android device. The following terms can help explain how Files are used in Android:
Device File System
Device File System is generically used to refer to any storage area in an Android device in which data, organized as Files, can reside. This term can refer to Files that are built into the device, but it is most commonly used to refer to Files that are stored in storage areas on the device that can be read and modified during normal device operation, by the Android system and/or by Android Applications.
Folder
Folder refers to a location in the Device File System where Files can exist and that can be used to hierarchically organize Files into groups.
Media Storage
Media Storage is a collection of Folders in Android that is generically used to refer to any storage area in the Device File System in which common types of media data, organized as Files, can reside. This term is most commonly used to refer to Folders where media Files (such as pictures, video, audio, etc.) can be stored and shared by multiple applications.
Application Sandbox
Application Sandbox is a Folder in the Device File System that is associated with an Android Application into which application data, organized as Files, can be placed such that they are private to and accessible only by that Android Application. This term can apply to private Files stored in Primary Storage, Secondary Storage, or Portable Storage. The key criteria that applies to all Application Sandbox data, and that differentiates it from other data, is the fact that it is owned by and generally accessible only to the Android Package that created it.
Shared Folders
Shared Folders refer to Folders in the Device File System of an Android device in which data, organized as Files, can reside and be shared amongst multiple Android Packages. Android generally discourages the use of Shared Folders and has added more and more restrictions over time to limit their use. In particular, Scoped Storage is a recent addition to Android designed to severely restrict the use of Shared Folders to share data between Android Packages. Android provides other mechanisms, such as Intents, Content and File Providers, and the Storage Access Framework to enable sharing of data amongst Android Packages to be done in a more secure and controlled manner than could ever be achieved using Shared Folders. For the time being, many Zebra Android devices support the use of the following Shared Folders, but these are expected to be phased out over time to better comply with Android standard practice.
- /data/tmp/public
The folder /data/tmp/public is unique to Zebra Android devices and is commonly used for downloading Transient Files, such as Local Update Files for OS Updates.
- /enterprise/usr
The folder /enterprise/usr is unique to Zebra Android devices, is generally of a relatively small fixed size (e.g. 128MB), and is commonly used for downloading Persistent Files, such as Android Packages that might need to be re-installed following an Enterprise Reset.
Most Files stored in the Device File System do NOT require any special handling. Most Files are created, read, updated, and deleted by the Android system and/or by Android Applications on a device without any outside intervention. But some Files MAY require special handling, in which case this Array is used to identify which Files require special handling and what special handling each such File requires. There is generally no reason to include a file in this Array unless it needs some form of special handling, but a single File could have multiple types of special handling. Every element of this Array should specify a value for Device Path And Name that uniquely identifies a File by the path and file name where the File resides in the in the Device File System.
The following classes of special handling might be required:
- Download File
Download File special handling would be appropriate when there was a File that was created off-device that needed to be delivered to the device to support some system or application service that needed to consume that File. For example, a Local Update File used to initiate an OS Update would generally originate off-device and might need to be Downloaded to a Shared Folder before it could be used to initiate such an OS Update. A special case of Download File special handling is when the File to be downloaded is intended for the exclusive use of a single Android Application.
- Upload File
Upload File special handling would be appropriate when there was a File that was created by the Android system and/or by Android Applications on a device that needed to be Uploaded to somewhere off-device for its eventual consumption there. For example, a Log File might be uploaded to a server so it could be used for troubleshooting or analysis.
- Delete File
Delete File special handling would be appropriate when there was a need for a File to be Deleted (removed from the Device File System) for some reason NOT driven by the Android system and/or by Android Applications. For example, a File might be created by an Android Application that neglects to delete it, resulting in a large amount of space being occupied. Deleting such a File , under the right conditions, could be quite beneficial.
Special handling must be carefully defined to avoid the potential for repetition which could cause harm or negatively impact device performance. For example, repeatedly downloading the same File could have multiple negative effects, such as slowing down the device, clogging up the network, wearing out flash memory, etc.
This Array is used to specify which Files require special handling. Any File that does NOT require special handling should not have an element in this Array, indicating that NO special handling should be performed. Any File that DOES require special handling should not have an element in this Array that specifies ALL special handlings required for that File.
If this Array has never been specified (never included in the MCs sent), then no configuration of special handling will be configured for any Files.
If this Array is not specified (not included in the MCs sent), then no changes will be made to the configuration defined by any previously specified version of this Array.
If this Array is specified (included in the MCs sent), then the specified Array will entirely replace the configuration defined by any previously specified Array.
Note that it is generally NOT possible to specify an "empty" Array (i.e. an Array with zero elements). Every Array must contain at least one element. Any element(s) in this Array where a blank (empty string) value is entered for Device Path And Name will be ignored. It is therefore possible to specify a "virtually empty" Array by entering a blank (empty string) value for Device Path And Name in every element of the Array.
- If this Array is specified (included in the MCs sent), but that Array is "virtually empty," as described above, then all special handling previously configured by any previously specified Array will be removed, thus returning to a state equivalent to when no Array had ever been specified.
Detail Information:
Key = filesConfig
Type = bundle_array
File
Use this Sub-group to identify a File that needs special handling and to specify the special handling it needs.
To specify that a File should be downloaded, at least one Download Option Type must be specified via Download Options.
To specify that a File should be uploaded, at least one Upload Option Type must be specified via Upload Options.
To specify that a File should be deleted, at least one Delete Option Type must be specified via Delete Options.
Notes:
If none of Download Options, Upload Options, or Delete Options are specified for a File, then NO special handlings CAN occur for that File.
If one or more Download Options, Upload Options, or Delete Options are specified for a File, then one or more special handlings MAY occur for that File, if/when one or more of the conditions specified for that File via Download Option Type , Upload Option Type, or Delete Option Type are met for that File.
Detail Information:
Key = filesConfigFile
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Device Path And Name
Enter a string that uniquely identifies a File in the Device File System for which special handling is required.
For each element in the Array Files Configuration:
If no value is specified for this MC or if a blank (empty string) value is entered, then the element of the Array will be ignored (not processed), producing the same result as if the element of the Array was not present. This can be used to effectively remove an element of an Array or to create a virtually empty Array.
If a non-blank (non-empty string) value is entered, then the element of the Array will be processed and the value entered must uniquely identify a File that DOES or COULD exist in the Device File System.
The value entered could take the format /<path>/<filename> to indicate that the File is to be downloaded to a Shared Folder in the Device File System.
The value entered could take the format /<path>/<filename>, where <filename> includes one or more of the wildcard characters * (Asterisk) or ? (Question mark) to indicate that all *Files in the specified path that match are to be uploaded to a Server from a Shared Folder in the Device File System.
The value entered could take the format <packagename>/<path>/<filename> to indicate that the File should be downloaded using the Zebra Secure Storage Manager for the exclusive use of the Android Application identified by the specified Android Package Name. In such cases, Download Application Signature must also be specified to provide the Android Package Signature that will be verified to ensure that the instance of the Android Application to which the File will be deployed is genuine.
Detail Information:
Key = filesConfigDevicePathAndName
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Download Options
Use this Sub-array to configure when/how a File should be downloaded from a Server to the Device File System.
Detail Information:
Key = filesConfigDownloadOptions
Type = bundle_array
Support Information:
- Supported from: MX 5.0.
Download Option
Use this Sub-group to configure when/how a File should be downloaded from a Server to the Device File System.
Detail Information:
Key = fileMgmtDownloadOption
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Download Option Type
Select the Type of a single Download Option defining when/how to download a File From a Server to the Device File System.
If the value On Server is selected, a File will be downloaded from a Server if the file is present on the Server whether or not the File is currently present in the Device File System.
If the value On Server but not on Device is selected, a File will be downloaded from a Server, only if the file is present on the Server AND the File is NOT currently present in the Device File System.
If a File is downloaded, it will be downloaded from the location on the Server specified via Download Server URI to the Device File System at the location specified via Device Path And Name.
Detail Information:
Key = fileMgmtDownloadOptionType
Type = string
| UI Choice | JSON Value |
|---|---|
| On Server | 1 |
| On Server but not on Device | 2 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Download Server URI
Enter a URI that identifies a File on a Server that will be downloaded to the Device File System when indicated by one or more Download Options.
Detail Information:
Key = filesConfigDownloadServerUri
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Download Application Signature
Enter the Android Package Signature to be used to verify that the Android Application for which the File will be downloaded is genuine. This is meaningful ONLY when the format <packagename>/<path>/<filename> is used for Device Path And Name to indicate that the File should be downloaded using the Zebra Secure Storage Manager for the exclusive use of the Android Application.
Detail Information:
Key = filesConfigDestSignature
Type = string
Support Information:
- Supported from: MX 11.3.
Download File Persistence
Select whether the File downloaded to the Device File System should locally persist on the device following an Enterprise Reset. This is meaningful ONLY when the format <packagename>/<path>/<filename> is used for Device Path And Name to indicate that the File should be downloaded using the Zebra Secure Storage Manager for the exclusive use of the Android Application.
Detail Information:
Key = filesConfigDeployPersistence
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Persist | 0 |
| Persist | 1 |
Support Information:
- Supported from: MX 11.3.
Upload Options
Use this Sub-array to configure when/how Files should be uploaded to a Server from the Device File System.
It is important to understand that due to the one-to-many relationship between Enterprise Mobility Management Systems (EMMs) and devices, the nature of upload is fundamentally different from download. When downloading a File from a Server to the Device File System, a single File on a Server can be downloaded to the same location in the Device File System of many devices. But when a File in the Device File System of many devices is uploaded to the Server, it doesn't make sense for each upload to overwrite a single file on the Server. In order for upload to make sense, each copy of a File uploaded by a different device needs to be uploaded to the Server with a different name, to ensure that all uploaded Files will be retained. Further, to make the set of uploaded copies of a File useful, it is important that the different copies of a File uploaded by different devices be somehow associated to the device from which they were uploaded.
Unlike download, which always downloads a single File from the Server to the Device File System on any given device, upload COULD upload multiple Files to the Server from the Device File System of a given device. This is accomplished by using the /<path>/<filename> format for Device Path And Name where <filename> includes one or more of the wildcard characters * (Asterisk) or ? (Question mark). All *Files that match will be uploaded.
Unlike download, which can download the same File from the Server to the Device File System of many devices, upload may need to upload copies of the same File from many devices to the same Server and must therefore name the Files from different devices differently on the Server. This is accomplished by specifying only a location via Upload Server URI not a specific File AND by specifying a pattern via Upload File Name Pattern telling upload how to name Files from different devices when they are uploaded to a common location on the Server.
Detail Information:
Key = filesConfigUploadOptions
Type = bundle_array
Support Information:
- Supported from: MX 10.1.
Upload Option
Use this Sub-group to configure when/how Files should be to uploaded to a Server from the Device File System.
Detail Information:
Key = fileMgmtUploadOption
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Upload Option Type
Select the Type of a single Upload Option defining when/how to upload matching Files to a Server from the Device File System.
If the value Not on Server is selected, a matching File will be uploaded to a Server if the File is present in the Device File System and is NOT present on the Server.
If the value Sorted By Name is selected, if multiple matching Files exist to be uploaded to a Server, they will be uploaded in alphabetical order by filename instead of uploading them in the default order of oldest to newest.
If a File is uploaded, it will be uploaded from the Device File System at the location specified via Device Path And Name to the location specified via Download Server URI with a name determined from the value specified via Upload File Name Pattern.
Detail Information:
Key = fileMgmtUploadOptionType
Type = string
| UI Choice | JSON Value |
|---|---|
| Not on Server | 1 |
| Sorted By Name | 3 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Upload File Name Pattern
Enter a Pattern to be used to craft the names of Files uploaded to a Server to ensure that Files uploaded from different devices have different names. The Pattern may contain any characters that are valid for use in a File Name on the Server, which may vary by Server but will generally include letters, digits, and a decimal point (dot) and may also contain one or more of the following:
- If the constant value %model% appears in the Pattern, then it will be replaced with the model name of the device.
- If the constant value %serial% appears in the Pattern, then it will be replaced with the serial number of the device.
- If the constant value %date% appears in the Pattern, then it will be replaced with the date the File was created in the Device File System.
- If the constant value %time% appears in the Pattern, then it will be replaced with the time the File was created in the Device File System.
For example, if the Pattern was Log-%model%-%serial%-%date%-%time%.zip, a File that is Uploaded to the Server might be assigned the File Name Log-TC51-123456789-041520-112300.zip, indicating that the File was a Log File that was Created on a TC51 device whose serial number was 123456789 and where the File was created in the Device File System at 11:23 AM on April 15, 2020.
Detail Information:
Key = filesConfigUploadFileNamePattern
Type = string
Upload Server URI
Enter the URI of a location on a Server to which File(s) from the Device File System will be uploaded.
Note: Because multiple Files may be uploaded from a given device, and because Files may be uploaded from multiple devices, this URI should point to a Folder on the Server NOT to a File on the Server. The name of the Files uploaded to the specified location on the Server will be determined based on the value specified via Upload File Name Pattern.
Detail Information:
Key = filesConfigUploadServerURI
Type = string
Delete Options
Use this Sub-array to configure when a File should be deleted the Device File System.
Detail Information:
Key = filesConfigDeleteOptions
Type = bundle_array
Support Information:
- Supported from: MX 5.0.
Delete Option
Use this Sub-group to configure when a File should be deleted from the Device File System.
Detail Information:
Key = fileMgmtDeleteOption
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Delete Option Type
Select the Type of a single Delete Option defining when to delete a File from the Device File System.
If the value Always is selected, a File will be deleted from the Device File System whenever it exists.
If the value After Reboot(s) is selected, a File will be deleted from the Device File System only if it exists immediately after a reboot.
If a File is deleted, it will be deleted from the location in the Device File System specified via Device Path And Name.
Detail Information:
Key = fileMgmtDeleteOptionType
Type = string
| UI Choice | JSON Value |
|---|---|
| Always | 1 |
| After Reboot(s) | 2 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Keyboard Mappings
Use this Array to configure one or more Keyboard Mapping(s)
The following defined terms are important to understand:
Key
Key refers to any physical switch that can be activated through manual pressure or any logical (e.g. On-Screen) button that can be activated using a touch panel or other pointing device.
Keyboard
Keyboard refers to any input mechanism that utilizes Keys that can be pressed to enter data into a mobile device.
Built-In Keyboard
Built-In Keyboard refers to a Keyboard that is physically integrated with and is generally inseparable from a mobile device and where Keys are generally activated by manual pressure.
On-Screen Keyboard
On-Screen Keyboard refers to a Keyboard that is displayed on the screen and where Keys are generally activated by a touch panel or other pointing device. In Android devices, On-Screen Keyboards are typically implemented through the Soft Input Panel (SIP) mechanism.
External Keyboard
External Keyboard refers to a Keyboard that is physically separate from a mobile device and that must be connected to the mobile device via some communications channel, such as Bluetooth or USB, and where Keys are generally activated by manual pressure.
Key Behavior
Key Behavior refers to what will occur when a Key on a Keyboard is activated. Key Behavior for a Key may vary depending on the current Keyboard State of a Keyboard when the Key is activated on that Keyboard.
Keyboard Mapping
Keyboard Mapping refers to configuration that alters the operation of a Keyboard by changing The Key Behavior for one or more Keys on that Keyboard.
Keyboard State
Keyboard State refers to a logical state that a Keyboard can be in and which affects the Key Behavior of Keys that are pressed while in that state. Standard Keyboard States include Shift, Caps Lock, Control, and Alt. Built-In Keyboards on Zebra Android devices may also support non-standard Keyboard States, such as Function, Blue, Orange, etc.
Mapping Table
Mapping Table refers to a table maintained in memory on a Zebra Android device that holds the Keyboard Mappings defined for a Keyboard that apply to a particular Keyboard State. For example, the Shift Mapping Table for a Keyboard would contain Keyboard Mappings that apply to Keys pressed only when that Keyboard is in the Shift Keyboard State. Consult the product documentation for a Zebra Android device to determine which Mapping Tables it supports.
Key Identifier
Key Identifier refers to a value used to uniquely identify a Key on a Keyboard so the Key Behavior of that Key can be altered via a Keyboard Mapping for that Key. Key Identifiers are most commonly string values that match the label of a Key, for keys that are labelled. For example, the Key Identifier "A" would used to identify a Key that is labelled as having that function. In some cases, a Key may be labeled with a graphical symbol that cannot easily be represented through a direct text string. For example, the "Left Arrow" Key may be labeled with a graphical arrow symbol, in which the Key Identifier will attempt to describe that symbol (e.g. "Left"). In some cases, a Key may be unlabeled, in which case the Key Identifier will attempt to describe the Key using functional and/or positional information. For example, the "Volume Up" Key is unlabeled and will describe the function of the Key (e.g. "Volume Up") and the yellow "Scan" trigger Key on the left hand side of the device might be unlabeled and will describe the function and position of the Key (e.g. "Left Trigger").
Key Code
Key Code refers to a value that is sent to the Android System when a key is activated to indicate how the key should be interpreted.
Trigger Signal
Trigger Signal refers to a logical indication, on a Zebra Android device, that a Key has been activated that is configured to behave as a trigger. Various Zebra Value-Add services, such as Barcode Scanning, are designed to respond to Trigger Signals.
This Array allows Keyboard Mappings to be defined for Built-In Keyboards only.
Each element of this Array:
Defines a Keyboard Mapping for a single Key on the Built-In Keyboard, identified by the Key Identifier value specified in Key ID. By adding multiple elements to this Array, Keyboard Mappings for multiple Keys can be defined.
Can define the behavior of the identified Key in one or more Mapping Tables that are supported by the Built-In Keyboard on a Zebra Android device. .
Detail Information:
Key = keyboardMappings
Type = bundle_array
Keyboard Mapping
Use this Sub-group to configure Key ID and Behaviors for a single Key on the Built-In Keyboard.
Key ID must be specified to provide the Key Identifier of the Key whose Key Behaviors will be altered in one or more Keyboard States.
The Sub-array Behaviors must be specified to define the Key Behavior to be defined as the Keyboard Mapping for the Key identified by the Key Identifier. .
Detail Information:
Key = keyboardMapping
Type = bundle
Support Information:
- Supported from: MX 4.4.
Key ID
Select the Key Identifier value that uniquely identifies the Key on the Built-In Keyboard" whose *Key Behavior is to be changed in one or more Keyboard States.
Detail Information:
Key = keymappingKeyId
Type = string
| UI Choice | JSON Value |
|---|---|
| 0 | 0 |
| 1 | 1 |
| 2 | 2 |
| 3 | 3 |
| 4 | 4 |
| 5 | 5 |
| 6 | 6 |
| 7 | 7 |
| 8 | 8 |
| 9 | 9 |
| A | A |
| B | B |
| C | C |
| D | D |
| E | E |
| F | F |
| G | G |
| H | H |
| I | I |
| J | J |
| K | K |
| L | L |
| M | M |
| N | N |
| O | O |
| P | P |
| Q | Q |
| R | R |
| S | S |
| T | T |
| U | U |
| V | V |
| W | W |
| X | X |
| Y | Y |
| Z | Z |
| . (Period) | DOT |
| , (Comma) | COMMA |
| * (Star) | STAR |
| # (Pound) | POUND |
| F1 | F1 |
| F2 | F2 |
| F3 | F3 |
| F4 | F4 |
| F5 | F5 |
| F6 | F6 |
| F7 | F7 |
| F8 | F8 |
| F9 | F9 |
| F10 | F10 |
| F11 | F11 |
| F12 | F12 |
| Enter | ENTER |
| Up | UP |
| Down | DOWN |
| Left | LEFT |
| Right | RIGHT |
| NAV_OK | NAV_OK |
| Escape | ESC |
| Backspace | BACKSPACE |
| Space | SPACE |
| Return | RETURN |
| Clear | CLR |
| Field Exit | FIELD_EXIT |
| Alt | ALT |
| Control | CTRL |
| Shift | SHIFT |
| Func | FUNC |
| Alpha | ALPHA |
| CL | CL |
| FN | FN |
| Blue | BLUE |
| Orange | ORANGE |
| Grey | GREY |
| Diamond | DIAMOND |
| Green Dot | GREEN |
| Red Dot | RED |
| Volume Up | VOLUMEUP |
| Volume Down | VOLUMEDOWN |
| Scan | SCAN |
| Grip Trigger | GRIP_TRIGGER |
| Grip Trigger 2 | GRIP_TRIGGER_2 |
| Button L1 | LEFT_TRIGGER_1 |
| Button L2 | LEFT_TRIGGER_2 |
| Button R1 | RIGHT_TRIGGER_1 |
| Button R2 | RIGHT_TRIGGER_2 |
| Left Trigger | LEFT_TRIGGER |
| Right Trigger | RIGHT_TRIGGER |
| Center Trigger | CENTER_TRIGGER |
| Gun Trigger | GUN_TRIGGER |
| Headset Button | HEADSET_HOOK |
| Back | BACK |
| Home | HOME |
| Menu | MENU |
| Recent | RECENT |
| Search | SEARCH |
| Keyboard Backlight | KEYLIGHT |
| Display Backlight | LAMP |
| Power | POWER |
| P1 Button | P1 |
| P2 Button | P2 |
| P3 Button | P3 |
| P4 Button | P4 |
| P5 Button | P5 |
| P6 Button | P6 |
| W1 Button | W1 |
| W2 Button | W2 |
| Rear Button | REAR_BUTTON |
| Left External Trigger | LEFT_EXTERNAL_TRIGGER |
| Right External Trigger | RIGHT_EXTERNAL_TRIGGER |
| Bluetooth Remote Trigger 1 | BLUETOOTH_REMOTE_TRIGGER_1 |
| Bluetooth Remote Trigger 2 | BLUETOOTH_REMOTE_TRIGGER_2 |
| Touch NAV_PAD | NAV_PAD |
| Macro 1 | M1 |
| Macro 2 | M2 |
| Macro 3 | M3 |
| Macro 4 | M4 |
| Macro 5 | M5 |
| Macro 6 | M6 |
| Brightness Up | BRIGHTNESSUP |
| Brightness Down | BRIGHTNESSDOWN |
| Keyboard | KEYBOARD |
| Keyboard Backlight Brightness Up | KEYLIGHTUP |
| Keyboard Backlight Brightness Down | KEYLIGHTDOWN |
| Rotate | ROTATE |
| + (Plus) | PLUS |
| - (Minus) | MINUS |
| Pause | PAUSE |
| End | END |
| Page Up | PAGEUP |
| Page Down | PAGEDOWN |
| Tab | TAB |
| CLIP-MOUNT_BUTTON | DO_NOT_DISTURB |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Behaviors
Use this Sub-array to configure one or more Key Behaviors for a Key on the Built-In Keyboard.
Detail Information:
Key = keymappingBehaviors
Type = bundle_array
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Behavior
Use this Sub-group to configure Table Name, Behavior Type, Send Key Code, Alt State, Ctrl State, Fn State, Shift State, Send Trigger, Send Intent, Intent Method, Intent Action, Intent Category, Intent Package Name, Intent Class, Intent Data URI, Intent MIME Type, Intent Extra Name 1, Intent Extra Name 2, Intent Extra Name 3, Intent Extra Name 4, Intent Extra Name 5, Intent Extra Value 1, Intent Extra Value 2, Intent Extra Value 3, Intent Extra Value 4, Intent Extra Value 5, Intent Flags, Send Intent - Intent Add Key Event, and Launch Application Name to define a single Key Behavior for a Key on the Built-In Keyboard.
Table Name must be specified to identify the Mapping Table into which the Key Behavior should be stored and which will thereby define the Keyboard State in which the Key must be activated in order for the Key Behavior to occur.
Behavior Type must be specified to identify the type of Key Behavior being defined .
Detail Information:
Key = keymappingBehavior
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Table Name
Select the name of the Mapping Table into which the Key Behavior should be stored and which will thereby define the Keyboard State in which the Key must be activated in order for the Key Behavior to occur.
Each Mapping Table is associated with a Keyboard State and is generally named based on the state Key on the Built-in Keyboard that causes that Keyboard State to be set or cleared.
Note that due to variations in the size, layout, and intended use cases of Built-In Keyboards on various Zebra Android devices, not all Keyboard States may be supported on any given device. Consult the product documentation for a device to determine the supported Keyboard States and Mapping Tables.
Some or all of the following values may be supported by a Zebra Android device:
If the value Base is selected, the Base Mapping Table will be selected. The Base Mapping Table is used to store the Key Behaviors that will be performed for Keys that are activated under conditions where no Keyboard States are set.
If the value Blue is selected, the Blue Mapping Table will be selected. The Blue Mapping Table is used to store the Key Behaviors that will be performed for Keys that are activated under conditions where the Blue Key has been used to set the Blue Keyboard State.
If the value Orange is selected, the Orange Mapping Table will be selected. The Orange Mapping Table is used to store the Key Behaviors that will be performed for Keys that are activated under conditions where the Orange Key has been used to set the Orange Keyboard State.
If the value Grey is selected, the Grey Mapping Table will be selected. The Grey Mapping Table is used to store the Key Behaviors that will be performed for Keys that are activated under conditions where the Grey Key has been used to set the Grey Keyboard State.
If the value Diamond is selected, the Diamond Mapping Table will be selected. The Diamond Mapping Table is used to store the Key Behaviors that will be performed for Keys that are activated under conditions where the Diamond Key has been used to set the Diamond Keyboard State.
If the value Shift is selected, the Shift Mapping Table will be selected. The Shift Mapping Table is used to store the Key Behaviors that will be performed for Keys that are activated under conditions where the Shift Key has been used to set the Shift Keyboard State.
If the value Control is selected, the Control Mapping Table will be selected. The Control Mapping Table is used to store the Key Behaviors that will be performed for Keys that are activated under conditions where the Control Key has been used to set the Control Keyboard State.
Detail Information:
Key = keymappingBehaviorTableName
Type = string
| UI Choice | JSON Value |
|---|---|
| Base | Base |
| Blue | Blue |
| Orange | Orange |
| Grey | Grey |
| Diamond | Diamond |
| Shift | Shift |
| Control | Control |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Behavior Type
Select the type of Key Behavior that will be performed when a specified Key is activated while the Keyboard State associated with the specified Mapping Table is set. The following values are supported:
If the value Send Key Code is selected, the Key Behavior performed when the specified Key is activated while the Keyboard State associated with the specified Mapping Table is set will be to send a specified Key Code. This can be thought of as being “Classic Keyboard Remapping”, since it causes the standard Key Behavior of a Key, which is generally to send a standard Key Code to be altered to send a different Key Code, which may or may not be present on the Built-In Keyboard and hence might otherwise not been possible to send without using Key Mapping. You must also specify Send Key Code to provide the Key Code that will be sent.
If the value Send Trigger is selected, the Key Behavior performed when the specified Key is activated while the Keyboard State associated with the specified Mapping Table is set will be to send a Trigger Signal. You must also specify Send Trigger to select which Trigger Signal will be sent,
If the value Launch Application is selected, the Key Behavior performed when the specified Key is activated while the Keyboard State associated with the specified Mapping Table is set will be to launch an application. You must also specify Launch Application Name to provide the Friendly Name of the application to be launched.
Note that this is NOT the Android Package Name. To launch an application by its Android Package Name, the value Send Intent should be select.
If the value Send Intent is selected, the Key Behavior performed when the specified Key is activated while the Keyboard State associated with the specified Mapping Table is set will be to send an Android Intent
Sending an Android Intent provides a very flexible way to specify the Key Behavior to be performed for a Key by invoking an application or service.
There are many options that control the nature of the intent that will be sent.
It is generally recommended to fully understand the nature of the Android Intent to be sent before attempting to configure it as a Key Key Behavior.
In many cases, the application or service to be invoked will define the nature of the intent it wishes to receive and that definition can be used to drive the configuration.
Android allows a collection of named Extras, of various types, to be attached to any intent.
An Intent sent as a Key Behavior for a specified Key can optionally have up to 5 Extras attached which, if used, MUST always be of type String.
This limitation of only attaching up to 5 Extras of type String might prevent certain intents, those which require more Extras or Extras of type other than String, from being sent as a Key Behavior for a Key.
You should consult the documentation or developer of a given application or service to determine the intents it supports and whether a function you want to perform requires any Extra(s) to be attached and, if so, of what type(s).
Sending an Android Intent might cause any number of possible results, depending on the nature of the intent configured to be sent.
You must also specify some or all of the following to define the Android Intent to be sent:
Intent Method
Intent Action
Intent Category
Intent Package Name
Intent Class
Intent Data URI
Intent Flags
Intent MIME Type
Intent Extra Name 1
Intent Extra Value 1
Intent Extra Name 2
Intent Extra Value 2
Intent Extra Name 3
Intent Extra Value 3
Intent Extra Name 4
Intent Extra Value 4
Intent Extra Name 5
Intent Extra Value 5
If the value Suppress Key is selected, NO Key Behavior will be performed when the specified Key is activated while the Keyboard State associated with the specified Mapping Table is active. This provides a method to change a Key to do nothing (act as if it was Key has not been activated). - If the value Reset To Default is selected, the Key Behavior performed when the specified Key is activated while the Keyboard State associated with the specified Mapping Table is active be reset back to its default. This will effectively remove any prior mapping of that Key in that Keyboard State and return the Key to its out-of-box Key Behavior in that Keyboard State.
Detail Information:
Key = keymappingBehaviorType
Type = string
| UI Choice | JSON Value |
|---|---|
| Send Key Code | 2 |
| Send Trigger | 1 |
| Launch Application | 4 |
| Send Intent | 3 |
| Suppress Key | 5 |
| Reset To Default | 7 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Send Key Code
Select the Key Code that will be sent as the Key Behavior for a specified Key when activated in a specified Keyboard State and when the value Send Key Code is selected for Behavior Type.
Detail Information:
Key = keymappingBehaviorTypeSendKeyCode
Type = string
| UI Choice | JSON Value |
|---|---|
| 0 | 7 |
| 1 | 8 |
| 2 | 9 |
| 3 | 10 |
| 4 | 11 |
| 5 | 12 |
| 6 | 13 |
| 7 | 14 |
| 8 | 15 |
| 9 | 16 |
| + (Plus) | 81 |
| - (Minus) | 69 |
| = (Equals) | 70 |
| ( (Left Bracket) | 71 |
| ) (Right Bracket) | 72 |
| ` (Grave) | 68 |
| / (Slash) | 76 |
| \\\\ (Backslash) | 73 |
| ; (Semicolon) | 74 |
| ' (Apostrophe) | 75 |
| , (Comma) | 55 |
| . (Period) | 56 |
| * (Star) | 17 |
| # (Pound) | 18 |
| @ (At) | 77 |
| A | 29 |
| B | 30 |
| C | 31 |
| D | 32 |
| E | 33 |
| F | 34 |
| G | 35 |
| H | 36 |
| I | 37 |
| J | 38 |
| K | 39 |
| L | 40 |
| M | 41 |
| N | 42 |
| O | 43 |
| P | 44 |
| Q | 45 |
| R | 46 |
| S | 47 |
| T | 48 |
| U | 49 |
| V | 50 |
| W | 51 |
| X | 52 |
| Y | 53 |
| Z | 54 |
| Enter | 66 |
| Tab | 61 |
| Space | 62 |
| Escape | 111 |
| Delete | 67 |
| F1 | 131 |
| F2 | 132 |
| F3 | 133 |
| F4 | 134 |
| F5 | 135 |
| F6 | 136 |
| F7 | 137 |
| F8 | 138 |
| F9 | 139 |
| F10 | 140 |
| F11 | 141 |
| F12 | 142 |
| NUMPAD 0 | 144 |
| NUMPAD 1 | 145 |
| NUMPAD 2 | 146 |
| NUMPAD 3 | 147 |
| NUMPAD 4 | 148 |
| NUMPAD 5 | 149 |
| NUMPAD 6 | 150 |
| NUMPAD 7 | 151 |
| NUMPAD 8 | 152 |
| NUMPAD 9 | 153 |
| NUMPAD / (NUMPAD Divide) | 154 |
| NUMPAD * (NUMPAD Multiply) | 155 |
| NUMPAD - (NUMPAD Subtract) | 156 |
| NUMPAD + (NUMPAD Add) | 157 |
| NUMPAD . (NUMPAD Period) | 158 |
| NUMPAD , (NUMPAD Comma) | 159 |
| NUMPAD Enter | 160 |
| NUMPAD = (NUMPAD Equals) | 161 |
| NUMPAD { (NUMPAD Left Parenthesis) | 162 |
| NUMPAD } (NUMPAD Right Parenthesis) | 163 |
| DPAD Up | 19 |
| DPAD Down | 20 |
| DPAD Left | 21 |
| DPAD Right | 22 |
| DPAD Center | 23 |
| Move Home | 122 |
| Move End | 123 |
| Page Up | 92 |
| Page Down | 93 |
| Insert | 124 |
| Forward Delete | 112 |
| Clear | 28 |
| Lamp | 10024 |
| Do Nothing | 10026 |
| Blue | 10027 |
| Orange | 10028 |
| Grey | 10029 |
| Diamond | 10039 |
| Alt | 10030 |
| Control | 10031 |
| Shift | 10032 |
| Keyboard | 10034 |
| Touch Calibrate | 10035 |
| Scan | 10036 |
| Search Key | 10037 |
| None | 10038 |
| KeyLight | 10025 |
| Keylight Up | 10040 |
| Keylight Down | 10041 |
| Left Shift | 59 |
| Right Shift | 60 |
| Left Alt | 57 |
| Right Alt | 58 |
| Left Control | 113 |
| Right Control | 114 |
| Meta Left | 117 |
| Meta Right | 118 |
| Caps Lock | 115 |
| Num Lock | 143 |
| Scroll Lock | 116 |
| SysRq | 120 |
| Break | 121 |
| Function | 119 |
| Back | 4 |
| Forward | 125 |
| Home | 3 |
| Menu | 82 |
| Settings | 176 |
| Application Switch | 187 |
| Calculator | 210 |
| Explorer | 64 |
| Envelope | 65 |
| Bookmark | 174 |
| Music | 209 |
| Call | 5 |
| End Call | 6 |
| Microphone Mute | 91 |
| Camera | 27 |
| Search | 84 |
| Contacts | 207 |
| Calendar | 208 |
| Volume Up | 24 |
| Volume Down | 25 |
| Volume Mute | 164 |
| Brightness Up | 221 |
| Brightness Down | 220 |
| Power | 26 |
| Sleep | 223 |
| Wakeup | 224 |
| Headset | 79 |
| Push-to-talk | 228 |
| Camera Focus | 80 |
| Media Play/Pause | 85 |
| Media Stop | 86 |
| Media Next | 87 |
| Media Previous | 88 |
| Media Rewind | 89 |
| Media Fast-Forward | 90 |
| Media Play | 126 |
| Media Pause | 127 |
| Media Close | 128 |
| Media Eject | 129 |
| Media Record | 130 |
| Button L1 | 102 |
| Button R1 | 103 |
| Button L2 | 104 |
| Button R2 | 105 |
| Button A | 96 |
| Button B | 97 |
| Button C | 98 |
| Button X | 99 |
| Button Y | 100 |
| Button Z | 101 |
| Left Thumb Button | 106 |
| Right Thumb Button | 107 |
| Start Button | 108 |
| Select Button | 109 |
| Mode Button | 110 |
| Gamepad Button 1 | 188 |
| Gamepad Button 2 | 189 |
| Gamepad Button 3 | 190 |
| Gamepad Button 4 | 191 |
| Gamepad Button 5 | 192 |
| Gamepad Button 6 | 193 |
| Gamepad Button 7 | 194 |
| Gamepad Button 8 | 195 |
| Gamepad Button 9 | 196 |
| Gamepad Button 10 | 197 |
| Gamepad Button 11 | 198 |
| Gamepad Button 12 | 199 |
| Gamepad Button 13 | 200 |
| Gamepad Button 14 | 201 |
| Gamepad Button 15 | 202 |
| Gamepad Button 16 | 203 |
| Zenkaku/Hankaku | 211 |
| Eisu | 212 |
| Muhenkan | 213 |
| Henkan | 214 |
| Katakana/Hiragana | 215 |
| Ro | 217 |
| Yen | 216 |
| Kana | 218 |
| Keyboard | 10034 |
| DO NOT DISTURB | 10043 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Alt State
Select whether the Key Code specified via Send Key Code will be sent with the Alt Keyboard State set when it is sent as the Key Behavior.
- If the value Off is selected, then when the Key Code is sent, it will NOT be sent with the Alt Keyboard State set. This will ensure that it will NOT interpreted as a Alt Key.
- If the value On is selected, then when the Key Code is sent, it WILL be sent with the Alt Keyboard State set. This will ensure that it WILL be interpreted as a Alt Key.
- If no value is specified, then when the Key Code is sent, it will be sent without modifying the Alt Keyboard State. This will ensure that it will be interpreted as a Alt or non-Alt Key depending on whatever Keyboard State the Keyboard is currently in.
Detail Information:
Key = keymappingBehaviorTypeSendKeyCodeAltState
Type = string
| UI Choice | JSON Value |
|---|---|
| On | 1 |
| Off | 0 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Ctrl State
Select whether the Key Code specified via Send Key Code will be sent with the Control Keyboard State set when it is sent as the Key Behavior.
- If the value Off is selected, then when the Key Code is sent, it will NOT be sent with the Control Keyboard State set. This will ensure that it will NOT interpreted as a Control Key.
- If the value On is selected, then when the Key Code is sent, it WILL be sent with the Control Keyboard State set. This will ensure that it WILL be interpreted as a Control Key.
- If no value is specified, then when the Key Code is sent, it will be sent without modifying the Control Keyboard State. This will ensure that it will be interpreted as a Control or non-Control Key depending on whatever Keyboard State the Keyboard is currently in.
Detail Information:
Key = keymappingBehaviorTypeSendKeyCodeCtrlState
Type = string
| UI Choice | JSON Value |
|---|---|
| On | 1 |
| Off | 0 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Fn State
Select whether the Key Code specified via Send Key Code will be sent with the Function Keyboard State set when it is sent as the Key Behavior.
- If the value Off is selected, then when the Key Code is sent, it will NOT be sent with the Function Keyboard State set. This will ensure that it will NOT interpreted as a Function Key.
- If the value On is selected, then when the Key Code is sent, it WILL be sent with the Function Keyboard State set. This will ensure that it WILL be interpreted as a Function Key.
- If no value is specified, then when the Key Code is sent, it will be sent without modifying the Function Keyboard State. This will ensure that it will be interpreted as a Function or non-Function Key depending on whatever Keyboard State the Keyboard is currently in.
Detail Information:
Key = keymappingBehaviorTypeSendKeyCodeFnState
Type = string
| UI Choice | JSON Value |
|---|---|
| On | 1 |
| Off | 0 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Shift State
Select whether the Key Code specified via Send Key Code will be sent with the Shift Keyboard State set when it is sent as the Key Behavior.
- If the value Off is selected, then when the Key Code is sent, it will NOT be sent with the Shift Keyboard State set. This will ensure that it will NOT interpreted as a Shifted Key.
- If the value On is selected, then when the Key Code is sent, it WILL be sent with the Shift Keyboard State* set. This will ensure that it WILL be interpreted as a Shifted Key.
- If no value is specified, then when the Key Code is sent, it will be sent without modifying the Shift Keyboard State. This will ensure that it will be interpreted as a Shifted or Unshifted Key depending on whatever Keyboard State the Keyboard is currently in.
Detail Information:
Key = keymappingBehaviorTypeSendKeyCodeShiftState
Type = string
| UI Choice | JSON Value |
|---|---|
| On | 1 |
| Off | 0 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Send Trigger
Select the Trigger Signal that will be sent as the Key Behavior for a specified Key when activated in a specified Keyboard State and when the value Send Trigger is selected for Behavior Type.
Eight possible Trigger Signals are defined, but not all may be supported on all devices. All devices generally support at least one Trigger Signal and generally default to using the first Trigger Signal to activate the Barcode Scanner. Some devices may support additional Trigger Signals and could be configured to use one or more Trigger Signals for some purpose(s) other than Barcode Scanning. Consult the product documentation for a device to determine which Trigger Signals are supported and how they are configured by default to be used.
Detail Information:
Key = keymappingBehaviorTypeSendTrigger
Type = string
| UI Choice | JSON Value |
|---|---|
| Trigger 1 | 10016 |
| Trigger 2 | 10017 |
| Trigger 3 | 10018 |
| Trigger 4 | 10019 |
| Trigger 5 | 10020 |
| Trigger 6 | 10021 |
| Trigger 7 | 10022 |
| Trigger 8 | 10023 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Send Intent
Select the circumstances when an Android Intent will be sent as the Key Behavior for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type.
- If the value On Key Down is selected, the Android Intent will be sent when the Key is activated (pressed) but will NOT be sent again when the Key is deactivated (released).
- If the value On Key Up is selected, the Android Intent will be NOT be sent when the Key is activated (pressed) but will be sent when the Key is deactivated (released).
- If the value On Both Key Up and Down is selected, the Android Intent will be sent when the Key is activated (pressed) AND will be sent again when the Key is deactivated (released).
Detail Information:
Key = keymappingBehaviorTypeSendIntent
Type = string
| UI Choice | JSON Value |
|---|---|
| On Key Down | 1 |
| On Key Up | 2 |
| On Both Key Up and Down | 3 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Method
Select the method via which an Android Intent will be sent to invoke an application or service for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type.
Depending on the application or service to be invoked, there is likely only one method that can be used to successfully invoke a desired function in that application or service. You will need to consult the documentation or developer of a given application or service to determine the method via which a particular Android Intent must be sent to produce the desired function.
If the value StartActivity is selected, the Android Intent will be sent using the Android startActivity() method. This method is suitable for invoking Android Activities, which are components that perform user interactions. If the function to be invoked involves interacting with the User, this method will most likely be the correct one to use.
If the value Broadcast is selected, the Android Intent will be sent using the Android sendBroadcast() method. This method is suitable for invoking Services, which are components that implement background operations. If the function to be invoked does not involve interacting with the User, this method will most likely be the correct one to use.
Detail Information:
Key = keymappingBehaviorTypeSendIntentMethod
Type = string
| UI Choice | JSON Value |
|---|---|
| StartActivity | StartActivity |
| Broadcast | Broadcast |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Action
Enter an Android Intent Action Value for an Intent to be sent to invoke an application or service for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type.
An Android Intent Action Value is NOT mandatory to specify when sending every Android Intent. An Android Intent Action Value is a commonly used method to identify the purpose of an Android Intent. This can be especially important when the application or service to be invoked supports multiple functions, in which case the Android Intent Action Value is commonly used to identify which function to perform when invoking that application or service. When sending an Implicit Intent, which does not specify an exact recipient application or service, it is also common to use the Android Intent Action Value to indicate the function to be performed by whatever application or service ultimately receives the intent. You should consult the documentation or developer of a given application or service to determine the intents it supports and whether a function you want to perform requires an Android Intent Action Value to be supplied.
Detail Information:
Key = keymappingBehaviorTypeSendIntentAction
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Category
Enter an Android Intent Category Value for an Android Intent to be sent to invoke an application or service for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type.
An Android Intent Category Value is NOT mandatory to specify when sending every Android Intent. An Android Intent Action Value is a commonly used method to help identify the purpose of an Android Intent. You should consult the documentation or developer of a given application or service to determine the intents it supports and whether a function you want to perform requires an Android Intent Category Value to be supplied.
Detail Information:
Key = keymappingBehaviorTypeSendIntentCategory
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Package Name
Enter an Android Package Name Value that will be used to form an Android Component that identifies an application or service to invoke for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type and Intent Class is specified.
An Android Package Name Value is NOT mandatory to specify when sending every Android Intent. An Android Package Name Value is a commonly used, together with an Android Class Name Value, to send an Explicit Intent, which uses an Android Component comprised of a Package Name and a Class name to specify the exact recipient application or service to which the intent will be delivered. Intent Class must also be specified to complete the definition of the Android Component.
Using an Explicit Intent can increase security and is often used when the intent being sent requires any sensitive data. Using an Implicit Intent provides enhanced flexibility since it may be sent to any application or service that has registered its ability to handle that intent and is often used when the intent being sent requires no sensitive data and when it may be desirable to dynamically control which application or service is ultimately invoked to handle the intent.
Detail Information:
Key = keymappingBehaviorTypeSendIntentPackageName
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Class
Enter an Android Class Name Value that will be used to form an Android Component that identifies an application or service to invoke for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type and Intent Package Name is specified.
An Android Class Name Value is NOT mandatory to specify when sending every Android Intent. An Android Class Name Value is a commonly used, together with an Android Package Name Value, to send an Explicit Intent, which uses an Android Component comprised of a Package Name and a Class name to specify the exact recipient application or service to which the intent will be delivered. Intent Package Name must also be specified to complete the definition of the Android Component.
Using an Explicit Intent can increase security and is often used when the intent being sent requires any sensitive data. Using an Implicit Intent provides enhanced flexibility since it may be sent to any application or service that has registered its ability to handle that intent and is often used when the intent being sent requires no sensitive data and when it may be desirable to dynamically control which application or service is ultimately invoked to handle the intent.
Detail Information:
Key = keymappingBehaviorTypeSendIntentClass
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Data URI
Enter a Uniform Resource Identifier (URI) Value that identifies some data to be utilized by the application or service invoked by the intent for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type. It is often advisable, and sometimes required, to specify Intent MIME Type to identify the type of data pointed to by the URI.
A URI Value is NOT mandatory to specify when sending every Android Intent. Whether the application or service that will receive the Intent expects a URI to be specified as part of the intent or not is up to that recipient and/or the definition of the intent that recipient is designed to consume. You should consult the documentation or developer of a given application or service to determine the intents it supports and whether a function you want to perform requires a URI, and possibly a MIME Type, to be supplied.
Detail Information:
Key = keymappingBehaviorTypeSendIntentDataUri
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent MIME Type
Enter a Multipurpose Internet Mail Extensions (MIME) Type Value to assist the application or service invoked by the intent for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type and Intent Data URI is specified.
A MIME Type Value is NOT mandatory to specify when sending every Android Intent. Whether the application or service that will receive the Intent expects a MIME Type to be specified as part of the intent or not is up to that recipient and/or the definition of the intent that recipient is designed to consume. In some cases, the type may be assumed or may be inferred from the data itself. Setting a MIME Type explicitly, if supported by an application or service, could disable automatic type detection and and force handling according to the specified type. You should consult the documentation or developer of a given application or service to determine the intents it supports and whether a function you want to perform requires a MIME Type to be supplied along with a URI.
Detail Information:
Key = keymappingBehaviorTypeSendIntentMimeType
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Extra Name 1
Enter the Name of a String Extra to be attached to the Intent that will be utilized by the application or service invoked by the intent for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type and when Intent Extra Value 1 is specified.
- If specified, this Extra of type String must be provided as a Name/Value pair specified via Intent Extra Name 1 and Intent Extra Value 1.
Detail Information:
Key = keymappingBehaviorTypeSendIntentExtraName1
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Extra Name 2
Enter the Name of a String Extra to be attached to the Intent that will be utilized by the application or service invoked by the intent for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type and when Intent Extra Value 2 is specified.
- If specified, this Extra of type String must be provided as a Name/Value pair specified via Intent Extra Name 2 and Intent Extra Value 2.
Detail Information:
Key = keymappingBehaviorTypeSendIntentExtraName2
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Extra Name 3
Enter the Name of a String Extra to be attached to the Intent that will be utilized by the application or service invoked by the intent for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type and when Intent Extra Value 3 is specified.
- If specified, this Extra of type String must be provided as a Name/Value pair specified via Intent Extra Name 3 and Intent Extra Value 3.
Detail Information:
Key = keymappingBehaviorTypeSendIntentExtraName3
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Extra Name 4
Enter the Name of a String Extra to be attached to the Intent that will be utilized by the application or service invoked by the intent for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type and when Intent Extra Value 4 is specified.
- If specified, this Extra of type String must be provided as a Name/Value pair specified via Intent Extra Name 4 and Intent Extra Value 4.
Detail Information:
Key = keymappingBehaviorTypeSendIntentExtraName4
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Extra Name 5
Enter the Name of a String Extra to be attached to the Intent that will be utilized by the application or service invoked by the intent for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type and when Intent Extra Value 5 is specified.
- If specified, this Extra of type String must be provided as a Name/Value pair specified via Intent Extra Name 5 and Intent Extra Value 5.
Detail Information:
Key = keymappingBehaviorTypeSendIntentExtraName5
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Extra Value 1
Enter the Value of a single String Extra to be attached to the Intent that will be utilized by the application or service invoked by the intent for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type and when Intent Extra Name 1 is specified.
- If specified, the SINGLE Extra of type String must be provided as a Name/Value pair specified via Intent Extra Name 1 and Intent Extra Value 1.
Detail Information:
Key = keymappingBehaviorTypeSendIntentExtraValue1
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Extra Value 2
Enter the Value of a single String Extra to be attached to the Intent that will be utilized by the application or service invoked by the intent for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type and when Intent Extra Name 2 is specified.
- If specified, the SINGLE Extra of type String must be provided as a Name/Value pair specified via Intent Extra Name 2 and Intent Extra Value 2.
Detail Information:
Key = keymappingBehaviorTypeSendIntentExtraValue2
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Extra Value 3
Enter the Value of a single String Extra to be attached to the Intent that will be utilized by the application or service invoked by the intent for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type and when Intent Extra Name 3 is specified.
- If specified, the SINGLE Extra of type String must be provided as a Name/Value pair specified via Intent Extra Name 3 and Intent Extra Value 3.
Detail Information:
Key = keymappingBehaviorTypeSendIntentExtraValue3
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Extra Value 4
Enter the Value of a single String Extra to be attached to the Intent that will be utilized by the application or service invoked by the intent for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type and when Intent Extra Name 4 is specified.
- If specified, the SINGLE Extra of type String must be provided as a Name/Value pair specified via Intent Extra Name 4 and Intent Extra Value 4.
Detail Information:
Key = keymappingBehaviorTypeSendIntentExtraValue4
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Extra Value 5
Enter the Value of a single String Extra to be attached to the Intent that will be utilized by the application or service invoked by the intent for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type and when Intent Extra Name 5 is specified.
- If specified, the SINGLE Extra of type String must be provided as a Name/Value pair specified via Intent Extra Name 5 and Intent Extra Value 5.
Detail Information:
Key = keymappingBehaviorTypeSendIntentExtraValue5
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Intent Flags
Enter a value that encodes one or more Android Intent Flags to be set for the Intent to be sent to invoke an application or service for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type.
Android Intent Flags control how an Intent is handled by Android and/or by the application or service that receives the Intent. Further:
Some Android Intent Flags are specific to the type of Android Component that will be invoked by the Intent (e.g. activity vs service).
Whether certain Android Intent Flags are needed to invoke a desired function is up to that recipient and/or the definition of the intent that recipient is designed to consume.
Android Intent Flags MUST be specified as a hexadecimal value with the appropriate bits set for any flag or flags desired.
Consult the Android documentation to translate intent flag names, when needed, into their appropriate hexadecimal values.
Detail Information:
Key = keymappingBehaviorTypeSendIntentFlags
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Send Intent - Intent Add Key Event
Select whether the information about the Key Event should be attached to Intent to be sent to invoke an application or service for a specified Key when activated in a specified Keyboard State and when the value Send Intent is selected for Behavior Type.
Mapping is performed by responding to Key Events that indicate when a Key is being activated (pressed) or deactivated (released). When sending an Intent as the Key Behavior for a Key, the Intent can be sent when the Key is activated (pressed), deactivated (released), or both. When the same Intent is sent for both activation and deactivation, it may be important to the Android Component that is receiving and consuming the Intent to differentiate the two cases.
If the value Attach is selected, the Android Intent sent will have the Key Event attached, allowing the consumer of the Intent to determine whether the Intent was sent as a result of the Key being activated (pressed) or deactivated (released).
If the value Don't Attach is selected, the Android Intent sent will NOT have the Key Event attached, preventing the consumer of the Intent from determining whether the Intent was sent as a result of the Key being activated (pressed) or deactivated (released).
Detail Information:
Key = keymappingBehaviorTypeSendIntentAddKeyEvent
Type = string
| UI Choice | JSON Value |
|---|---|
| Attach | 1 |
| Don't Attach | 0 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Launch Application Name
Enter the Application Friendly Name that identifies an application to be launched when the value Launch Application is selected for Behavior Type.
Note that the Application Friendly Name is NOT the same as the Android Package Name. The Application Friendly Name is generally the name by which the application is identified in in-device UI. Launching an application by its Application Friendly Name is generally simpler and hence may be more convenient for an administrator than launching that application by its Android Package Name.
To launch an application by its Application Friendly Name, all the administrator needs to supply is that name. the Application Friendly Name is easily discoverable in-device in a variety of ways, including:
The Application Friendly Name may be displayed in the Title Bar of the application's UI.
The Application Friendly Names of recently launched applications are typically displayed in the Recent Applications panel.
The Application Friendly Name is displayed in the AppInfo section of the Settings UI for an application.
To launch an application based on its Android Package Name, the value Send Intent should be selected for Behavior Type and much more information, including Android Package Name, which may be harder to discover, will need to be provided to send the right Intent to launch the application.
Detail Information:
Key = keymappingBehaviorTypeLaunchApplicationName
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
License Configuration
Use this Group to configure Enterprise Reset Persistence, Licenses, and Features.
Detail Information:
Key = licenseConfig
Type = bundle
Enterprise Reset Persistence
Enter the name of the partition on the local server from which to pull a license. Leave blank to pull from a non-partitioned license pool
Detail Information:
Key = licensePersistence
Type = string
| UI Choice | JSON Value |
|---|---|
| Turn On | 1 |
| Turn Off | 2 |
Support Information:
- Supported from: MX 11.2.
Licenses
Use this Sub-array to configure one or more License(s) to Activate from Server(s) using AID(s) and/or to Activate from Local File(s).
Detail Information:
Key = licenses
Type = bundle_array
Support Information:
- Supported from: MX 8.1.
License
Use this Sub-group to configure Activation Source, Activation ID, Custom Server URL, Custom Server Friendly Name, and Local File Path and Name.
Detail Information:
Key = license
Type = bundle
Activation Source
Select the Source from which a License for a Zebra capability will be acquired.
Detail Information:
Key = activationSource
Type = string
| UI Choice | JSON Value |
|---|---|
| Production Cloud Direct | 1 |
| Production Cloud Proxy | 2 |
| Cloud / Local Server | 3 |
| Local File Production Cloud | 4 |
| Test (UAT) via Cloud Direct | 5 |
| Test (UAT) via Cloud Proxy | 6 |
| Test (UAT) via License File | 7 |
Support Information:
- Supported from: MX 7.1.
Activation ID
Enter the Activation ID (AID) to be used when acquiring a License for a Zebra capability from a Server.
Detail Information:
Key = activationID
Type = string
Support Information:
- Supported from: MX 7.1.
Custom Server URL
Enter the URL of the specific Custom Server from which a License for a Zebra capability will be acquired.
Detail Information:
Key = licenseCustomServerUrl
Type = string
Support Information:
- Supported from: MX 7.1.
Custom Server Friendly Name
Enter the Friendly Name to be associated with the Custom Server from which a License for a Zebra capability will be acquired.
Detail Information:
Key = licenseCustomServerFriendlyName
Type = string
Support Information:
- Supported from: MX 7.1.
Local File Path and Name
Enter the Path and Name of a local File in the Device File System from which a License for a Zebra capability will be acquired.
Detail Information:
Key = licenseLocalFilePathAndName
Type = string
Support Information:
- Supported from: MX 7.1.
Features
Use this Sub-array to configure one or more Feature(s) to be Acquired directly from Customer License Server Instance(s).
Detail Information:
Key = features
Type = bundle_array
Feature
Use this Sub-group to configure Name, Server URL, Server Friendly Name, and Partition Name.
Detail Information:
Key = feature
Type = bundle
Name
Enter the Name of the Zebra Feature for which licensing will be acquired.
Detail Information:
Key = licenseFeatureName
Type = string
Support Information:
- Supported from: MX 10.2.
Server URL
Enter the server URL from which licensing for a Zebra Feature will be acquired.
Detail Information:
Key = licenseFeatureServerUrl
Type = string
Support Information:
- Supported from: MX 10.2.
Server Friendly Name
Enter the Friendly Name to be assigned to the Server from which licensing for a Zebra Feature will be acquired.
Detail Information:
Key = licenseFeatureServerFriendlyName
Type = string
Support Information:
- Supported from: MX 10.2.
Partition Name
Enter the Friendly Name to be assigned to the Server from which licensing for a Zebra Feature will be acquired.
Detail Information:
Key = licenseLocalServerPartitionName
Type = string
Support Information:
- Supported from: MX 11.2.
Package Configuration
Use this Array to configure one or more Package(s)
Each Android Package of the given type will generally exhibit the same standard behaviors unless explicitly overridden by an Administrator. Android Packages of different types may exhibit different standard behaviors unless explicitly overridden by an Administrator.
This Sub-array allows an Administrator to identify Android Packages, by their Android Package Names, whose exhibited behavior should deviate from the standard behaviors that would otherwise apply based on their types. Any Android Packages whose Android Package Names are not specified in this Sub-array will exhibit the standard behaviors appropriate to their type.
The following high-level behaviors could be altered using this Sub-array.:
- Allowed Services
Zebra Android devices implement a variety of System Services that are generally available for use only by Trusted Applications. In some cases, there may be a need to grant such access to otherwise Non-Trusted Applications. In such cases, the Administrator can use Allowed Services to grant an application that he trusts, access to use one or more selected System Services.
- Permissions
Zebra Android devices have a variety of System Permissions that control access to System APIs that are generally available for use only by Trusted Applications. In some cases, there may be a need to grant such permissions to otherwise Non-Trusted Applications. In such cases, the Administrator can use Permissions to grant an application that he trusts, permission to use one or more System APIs.
- Class Variances
Zebra Android devices have a variety of standard application behaviors that an Administrator might want to adjust. In such cases, the Administrator can use one or more of the following Class Variances to specify which of the available deviations from behaviors to use for an application.
- Feature Variances
Zebra Android devices have a variety of standard application behaviors that an Administrator might want to adjust. In such cases, the Administrator can use one or more of the following Feature Variances to specify which of the available deviations from behaviors to use for an application.
This Sub-array is used to provide a list of Android Packages for which deviations from standard behaviors will be configured.
If this Sub-array has never been specified (never included in the MCs sent), then no configuration of deviation from standard behaviors will be made and hence all Android Packages will have standard behaviors.
If this Sub-array is not specified (not included in the MCs sent), then no changes will be made to the configuration defined by any previously specified Sub-array.
If this Sub-array is specified (included in the MCs sent), then the specified Sub-array will entirely replace the configuration defined by any previously specified Sub-array.
Note that it is NOT possible to specify an "empty" Sub-array (with zero elements). Every Sub-array must contain at least one element. Any element(s) in this Sub-array where a blank (empty string) value is entered for Package Name will be ignored. It is therefore possible to specify a "virtually empty" Sub-array by entering a blank (empty string) value for Package Name in every element of the Sub-array.
- If this Sub-array is specified (included in the MCs sent), but that Sub-array is "virtually empty", as described above, then all deviation from standard behaviors previously configured by any previously specified Sub-array will be removed, thus returning all Android Packages to standard behaviors, returning to a state equivalent to when no Sub-array had ever been specified. .
Detail Information:
Key = pkgConfig
Type = bundle_array
Package
Use this Sub-group to configure Class Name, Package Name, Package Signing Certificate, Permissions, Class Variances, Feature Variances, and Allowed Services for a single Android Package.
Detail Information:
Key = package
Type = bundle
Class Name
Enter the Class Name within the Android Package for which one or more non-default class related behaviors should be configured.
If the Class Name is left blank (empty string), then the elements of the Class Variances Sub-array in which it appears will be ignored.
If the Class Name is non-blank (non-empty string), then the element of the Class Variances Sub-array in which it appears will be processed and the entered Class Name will identify the class within the Android Package for which this element of the Package Configuration Sub-array will define one or more deviations from standard behaviors should be configured.
Detail Information:
Key = packageClassName
Type = string
Support Information:
- Supported from: MX 4.3.
Package Name
Enter the Package Name of an Android Package for which one or more deviations from standard behaviors should be configured. z
If the Package Name is left blank (empty string), then the element of the Package Configuration Sub-array in which it appears will be ignored.
If the Package Name is non-blank (non-empty string), then the element of the Package Configuration Sub-array in which it appears will be processed and the entered Package Name will identify the Android Package for which this element of the Package Configuration Sub-array will define one or more deviations from standard behaviors should be configured.
Detail Information:
Key = packagePackageNameName
Type = string
Package Signing Certificate
Enter the Package Signing Certificate that will be used to verify that the Android Package identified by the Package Name entered for Package Name is a genuine instance of that Android Package for which one or more deviations from standard behaviors should be configured.
The value specified must be the Base 64 encoded string representing the exact binary contents of the DER-format (e.g, a .CRT file) public certificate file used to sign the Android Package. This value can be obtained in the proper format from an .APK file for an Android Package by using the Zebra App Signature Tool.
Note that not all deviations from standard behaviors require verification that the Android Package is genuine and hence the Package Signing Certificate can be left blank (empty string) when it is not required. The deviations from standard behaviors that require verification are the following that grant special privileges to the Android Package:
Allowed Services
Permissions
Detail Information:
Key = packagePackageSigningCertifcate
Type = string
Permissions
Use this Sub-array to configure one or more Sensitive Android Permissions.
Detail Information:
Key = packagePermissions
Type = bundle_array
Support Information:
- Supported from: MX 10.4.
Permission
Use this Sub-group to configure Name and State for a single Sensitive Android Permission.
Detail Information:
Key = packagePermission
Type = bundle
Name
Select the name of a Sensitive Android Permission to be Granted to an Android Package. Select the name of a Sensitive Android Permission for which deviation from the standard behavior will be configured for an Android Package.
Detail Information:
Key = permissionName
Type = string
| UI Choice | JSON Value |
|---|---|
| Access Notifications | android.permission.ACCESS_NOTIFICATIONS |
| Package Usage Stats | android.permission.PACKAGE_USAGE_STATS |
| System Alert Window | android.permission.SYSTEM_ALERT_WINDOW |
| Get AppOps Stats | android.permission.GET_APP_OPS_STATS |
| Battery Stats | android.permission.BATTERY_STATS |
| Manage External Storage | android.permission.MANAGE_EXTERNAL_STORAGE |
| Bind Notification Listener | [binary data] |
| Read Logs (specially trusted Zebra apps only) | android.permission.READ_LOGS |
| All Dangerous Permissions | ALL_DANGEROUS_PERMISSIONS |
State
Select the State to to configure deviation from the standard behavior for Sensitive Android Permission for an Android Package.
If the value Grant is selected, then a Sensitive Android Permission will be Granted to the Android Package.
If the value Deny is selected, then a Sensitive Android Permission will be Denied from the Android Package.
If the value Prompt User is selected, then the User will be presented with dialog asking for permission to the Sensitive Android Permission for the Android Package.
Note that since Prompt User is the standard behavior for all Sensitive Android Permissions, this value is not really required, since the same effect can be obtained by removing the Sensitive Android Permission from the Permissions Sub-array. This is because not explicitly specifying a deviation from the standard behavior for a Sensitive Android Permission will result in the standard behavior. Similarly, if the Package Name is removed from the Package Configuration Sub-array then all Sensitive Android Permissions will return to standard behavior for that Android Package. It is not necessary to explicitly assign the standard behavior.
Detail Information:
Key = permissionState
Type = string
| UI Choice | JSON Value |
|---|---|
| Grant | 1 |
| Deny | 2 |
| Prompt User | 3 |
Class Variances
Use this Sub-array to configure one or more Class variance(s) that an application will is Allowed to use.
Detail Information:
Key = packageClassVariances
Type = bundle_array
Class Variance
Use this Sub-group to configure Variance Type.
Detail Information:
Key = packageClassVariance
Type = bundle
Variance Type
Select a Type of Class Variance that should be applied to an Android Package.
Detail Information:
Key = classVarianceType
Type = string
| UI Choice | JSON Value |
|---|---|
| Set as default Input Method | 1 |
Support Information:
- Supported from: MX 4.3.
Feature Variances
Use this Sub-array to configure one or more Feature Variance(s) (deviations from the standard behaviors of Android Packages) that should apply to Android Packages.
Detail Information:
Key = packageFeatureVariances
Type = bundle_array
Feature Variance
Use this Sub-group to configure Variance Type.
Detail Information:
Key = packageFeatureVariance
Type = bundle
Variance Type
Select a Type of Feature Variance that should be applied to an Android Package.
Detail Information:
Key = packageVarianceType
Type = string
| UI Choice | JSON Value |
|---|---|
| Disallow Background Data | 1 |
| Exempt from Battery Optimization | 2 |
| Disallow Launch | 3 |
| Use a Reserved UID | 6 |
| Disallow App From Upgrade | 7 |
| Hide Notifications | 8 |
| Set as default dialer | 9 |
| Set as default browser | 10 |
| Set as default launcher | 11 |
| Automatic Permission Control | 12 |
Support Information:
- Supported from: MX 9.3.
Allowed Services
Use this Sub-array to configure one or more System Service(s) that an application will is Allowed to use.
Detail Information:
Key = packageAllowedServices
Type = bundle_array
Support Information:
- Supported from: MX 8.3.
Allowed Service
Use this Sub-group to configure Service Identifier.
Detail Information:
Key = packageAllowedService
Type = bundle
Service Identifier
Enter the Service Identifier that identifies functionality of a System Service that an Android Package will be allowed to use.
A Service Identifier is a string value defined by the implementer of a System Service that identifies specific functionality within that System Service to which access will be controlled. A given System Service can choose to implement functionality that is NOT controlled by a Service Identifier and/or can defined multiple Service Identifiers to apply varying controls on different types of functionality. Consult the documentation for a given System Service to determine which, if any, Service Identifier(s) might be required to utilize the desired functionality of that System Service. Each Service Identifier that identifies functionality in a System Service to which usage will be allowed for a given Android Package must be configured through an element of the Permissions Sub-array for that Android Package.
Detail Information:
Key = packageAllowedServiceIdentifier
Type = string
Security and Privacy Configuration
Use this Group to configure Encryption, Screen Lock, and SD Card Setup Notification.
Detail Information:
Key = securityAndPrivacyConfig
Type = bundle
Encryption Configuration
Use this Sub-group to configure Encryption Keys and SD Card Encrypt Key Name.
Detail Information:
Key = encryptConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Encryption Keys
Use this Sub-array to configure one or more Encryption Key(s).
Detail Information:
Key = securityEncryptionKeys
Type = bundle_array
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.3.
Encryption Key
Use this Sub-group to configure Key Name and Key Value.
Detail Information:
Key = securityEncryptionKey
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Key Name
Enter the Key Name of a Named Encryption Key.
You must also specify Key Value to provide the Key Value to be added for the specified Named Encryption Key.
Detail Information:
Key = securityKeyName
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Key Value
Enter the Key Value of a Named Encryption Key.
A Key Value must be a string value containing exactly 64 hexadecimal characters ("0-9" and/or "A-F" characters) that encode a 256 bit binary value for an AES encryption key.
The Key Value can be generated in any manner desired as long as it is a 256 bit binary value and is represented as 64 hexadecimal characters, although in most cases, best practice would be to randomly generate Key Values to maximize their effectiveness in protecting data.
Detail Information:
Key = securityKeyValue
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
SD Card Encrypt Key Name
Enter the Key Name of a Named Encryption Key to be used to encrypt the removable SD Card.
Detail Information:
Key = securitySDCardEncryptKeyName
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.3.
Screen Lock Configuration
Use this Sub-group to configure Instant Screen Lock on Power Key, Lock Screen Wallpaper, Custom Lock Screen Wallpaper, Screen Lock Type, Notifications on Lock Screen, RC Lock Screen Visibility, Screen Lock Timeout, and User Selection of Secure Start-up.
Detail Information:
Key = screenLockConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Instant Screen Lock on Power Key
Select whether the device will Instantly Lock when the Power Key is used to turn the Display Off.
- If the value Off is selected, the device will NOT Instantly Lock when the Power Key is used to turn the Display Off. This will produce behavior comparable to when the device times out and Automatically turns the Display Off.
If the Display remains off for longer than Duration set via Screen Lock Timeout, then the device will become Locked, requiring it to be Unlocked in the manner specified via Screen Lock Type.
If the Display remains off for less than Duration set via Screen Lock Timeout, then the device will NOT become Locked.
- If the value On is selected, the device WILL Instantly Lock when the Power Key is used to turn the Display Off, requiring it to be Unlocked in the manner specified via Screen Lock Type.
Detail Information:
Key = securitySLPowerKeyInstantLock
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | Off |
| On | On |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.3.
Lock Screen Wallpaper
Select the wallpaper to use on the lock screen of the device.
If the value Restore to default is selected, the default lock screen wallpaper will be used.
If the value Custom is selected, the custom wallpaper specified in %?securityAndPrivacyConfig.screenLockConfig.securitySLCustomLockWallpaper% will be used on the lock screen.
Detail Information:
Key = securitySLLockScreenWallpaper
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Restore to default | 1 |
| Custom | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.5.
Custom Lock Screen Wallpaper
Enter the path and file name of an image file on the device (.jpg or .png)
Detail Information:
Key = securitySLCustomLockWallpaper
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.5.
Screen Lock Type
Select the type of lock that is used to protect the device from use by unauthorized persons.
If the value None is selected, no lock will be applied and the device can be used by anyone.
If the value Swipe is selected, unlocking will require only a simple swipe and the device can be used by anyone.
If the value PIN is selected, unlocking will require entry of a PIN (personal identification number) and the device can only be unlocked by someone knowing the correct PIN value.
If the value Password is selected, unlocking will require entry of a password and the device can only be unlocked by someone knowing the correct password value.
If the value Pattern is selected, unlocking will require drawing a pattern on the screen using the touch panel and the device can only be unlocked by someone knowing the correct pattern.
Detail Information:
Key = securitySLScreenLockType
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| None | 5 |
| Swipe | 1 |
| PIN | 3 |
| Password | 4 |
| Pattern | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 6.0.
Notifications on Lock Screen
Select the types of notifications to show on the lock screen
If the value Show all content is selected, all notifications will be shown.
If the value Show only non-sensitive content is selected, only non-sensitive content will be shown.
If the value Hide notifications is selected, all notifications will be hidden.
Detail Information:
Key = securitySLNotificationsOnLockScreen
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Show all content | 1 |
| Show only non-sensitive content | 2 |
| Hide notifications | 3 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.5.
RC Lock Screen Visibility
Select whether the Android Lock screen is visible on the remote console when a device is being remotely controlled
If the value Allow is selected, Shows the Android Lock Screen on the remote console if it appears on the device while being remotely controlled.
If the value Disallow is selected, Hides the Android Lock Screen on the remote console if it appears on a device while being remotely controlled.
Detail Information:
Key = securitySLRCLockScreenVisibility
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Allow | 1 |
| Disallow | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.3.
Screen Lock Timeout
Select what happens when a device turns off as a result of a timeout.
If the device stays off for at least the time specified, the device will be locked and an unlock will be required when the device is turned back on, if any lock was configured using Screen Lock Type.
If the device stays off for less than the time specified, the device will NOT be locked and hence no unlock will be required when the device is turned back on, even if a lock was configured using Screen Lock Type.
Detail Information:
Key = securitySLScreenLockTimeout
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Immediately after Display Timeout | 1 |
| 5 seconds after Display Timeout | 5 |
| 15 seconds after Display Timeout | 15 |
| 30 seconds after Display Timeout | 30 |
| 1 minute after Display Timeout | 60 |
| 2 minutes after Display Timeout | 120 |
| 5 minutes after Display Timeout | 300 |
| 10 minutes after Display Timeout | 600 |
| 30 minutes after Display Timeout | 1800 |
Support Information:
- Supported from: MX 4.3.
User Selection of Secure Start-up
Select whether the User will be Allowed to Select (Turn On) Secure Start-up when changing pin/password/pattern.
Detail Information:
Key = securitySLSecureStartupDialog
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Enable the YES button | 1 |
| Disable the YES button | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.0.
Support discontinued from: Android 13.
SD Card Setup Notification
Select whether to present the user with the notification when an SD card is inserted.
If the value Do not change is selected, then no change will be made to the setting for whether the dialog will be presented to the user.
If the value Showis selected, the user will be presented with the dialog box notifying that an SD Card has been inserted.
If the value Hide is selected, the user will not be presented with the dialog box notifying that an SD Card has been inserted.
Detail Information:
Key = sdConfigPopup
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | 0 |
| Show | 1 |
| Hide | 2 |
Support Information:
- Supported from: MX 11.5.
System Configuration
Use this Group to configure Analytics, Clock, Data Wipe, GMS, Lifeguard, Power, Remote Scanner Configurations, Wake-Up, Pass-Through Command, and Logs.
Detail Information:
Key = systemConfig
Type = bundle
Analytics Configuration
Use this Sub-group to configure Analytics State and User Control of Analytics State.
Detail Information:
Key = analyticsConfig
Type = bundle
Analytics State
Select whether the Analytics Client will collect machine data from the device and send it to Zebra.
The Analytics Client is turned on (enabled) by default on all devices:
If the value Off is selected, the Analytics Client will NOT collect machine data from the device nor will it send such data to Zebra.
If the value On is selected, the Analytics Client WILL collect machine data from the device and send such data to Zebra when connectivity is available.
Note that on some devices, the ability to turn off (disable) the Analytics Client may not be supported.
Detail Information:
Key = sysAnalyticsState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
- Supported from: MX 4.3.
User Control of Analytics State
Select whether the User will be Allowed to control whether the Analytics Client will collect machine data from the device and send it to Zebra.
The Analytics Client is turned on (enabled) by default on all devices:
If the value Disallow is selected, the User will NOT be Allowed to control whether the Analytics Client will collect machine data from the device and send it to Zebra
If the value Allow is selected, the User WILL be Allowed to control whether the Analytics Client will collect machine data from the device and send it to Zebra
Detail Information:
Key = sysAnalyticsUserControlState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
- Supported from: MX 7.2.
Clock Configuration
Use this Sub-group to configure Time Mode, Auto NTP Server Address, Auto NTP Drift Interval, Auto NTP Sync Interval, Time Zone Mode, Manual Time Zone, and Time Format
The following defined terms are important to understand:
GMT (See Greenwich Mean Time)
Greenwich Mean Time
Greenwich Mean Time refers to the Local Time at the Royal Observatory in Greenwich, London, which matches and is used as the basis for Coordinated Universal Time.
UTC (See Coordinated Universal Time)
Universal Time Coordinates (See Coordinated Universal Time)
Coordinated Universal Time
Coordinated Universal Time is the primary time standard by which the world regulates clocks and time and has a primary characteristic of being location independent. The time specified in Coordinated Universal Time is the same as Greenwich Mean Time.
Local Time
Local Time refers to the agreed-upon time observed time at a location that has elected to operate as part of a Time Zone.
Time Zone
Time Zone refers to a logical, and usually geographical, location where the Local Time observed may vary from the Local Time observed at other locations. Time Zone is also used to refer to the rules by which a Local Time to be observed at a location is computed based on Coordinated Universal Time. For example, Local Time might be computed using a fixed offset from Coordinated Universal Time and/or using a seasonable adjustment (e.g., Daylight Saving).
Daylight Saving
Daylight Saving refers to a seasonable variation in the Local Time observed at a location that has elected to operate as part of a Time Zone. For example, Local Time might be adjusted forward by one hour during that portion of the year when days are longer.
NTP (See Network Time Protocol)
Network Time Protocol
Network Time Protocol refers to a communication protocol used to communicate to a Time Server to acquire the current time and date, typically used to synchronize the clock on a client to the clock on the Time Server.
Time Server
Time Server refers to a server used as a trusted authority from which the current time and date can be acquired via some communication protocol, such as NTP .
Detail Information:
Key = clockConfig
Type = bundle
Time Mode
Select the mode via which the time and date will be set on a device.
If the value Automatic is selected, the time and date will be acquired and set automatically on a device via communication with a Time Server.
If the value Manual is selected, the time and date will NOT be acquired and set automatically on a device via communication with a Time Server. In such cases, the time and date might be set manually on the device, by the User, or through some other means (e.g. by an application).
Detail Information:
Key = sysClockTimeMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Manual | false |
| Automatic | true |
Support Information:
- Supported from: MX 4.2.
Auto NTP Server Address
Enter the IP address or URI of the Time Server that supports NTP from which the time and date on a device will be acqiured and set automatically when the value Automatic is selected for Time Mode.
Detail Information:
Key = sysClockAutoNtpServer
Type = string
Support Information:
- Supported from: MX 4.2.
Auto NTP Drift Interval
Enter the maximum difference between the time on-device and the NTP server time after which the time will be attempted to be acquired and set automatically.
Detail Information:
Key = sysClockAutoNtpDriftInterval
Type = string
Support Information:
- Supported from: MX 11.7.
Auto NTP Sync Interval
Select the interval at which the time and date will be attempted to be acquired and set automatically when the value Automatic is selected for Time Mode.
If the value 30 minutes is selected, the time and date will be attempted to be acquired and set automatically on a device via communication with a Time Server once every 30 minutes.
If the value 60 minutes is selected, the time and date will be attempted to be acquired and set automatically on a device via communication with a Time Server once each hour.
If the value 6 hours is selected, the time and date will be attempted to be acquired and set automatically on a device via communication with a Time Server once every 6 hours.
If the value 24 hours is selected, the time and date will be attempted to be acquired and set automatically on a device via communication with a Time Server once per day.
Detail Information:
Key = sysClockAutoNtpSyncInterval
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| 30 minutes | 00:30:00 |
| 60 minutes | 00:60:00 |
| 6 hours | 06:00:00 |
| 24 hours | 24:00:00 |
Support Information:
- Supported from: MX 4.2.
Time Zone Mode
Select how the Time Zone will be configured on a device.
If the value Automatic is selected, the Time Zone will be acquired and set automatically from a Network Identity and Time Zone (NITZ) source.
If the value Automatic is selected, the Time Zone will NOT be acquired and set automatically from a Network Identity and Time Zone (NITZ) source. In such cases, the Time Zone might be set manually on the device, by the User, or through some other means (e.g. by an application).
Detail Information:
Key = sysClockTimeZoneMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Manual | false |
| Automatic | true |
Support Information:
- Supported from: MX 6.0.
Manual Time Zone
Enter a string value that identifies the Time Zone to be set explicitly when Manual is set for Time Zone Mode.
The string value has a maximum size of 255 characters.
If the value is empty (zero length string), then the current Time Zone will NOT be changed.
If the value GMT is specified then the Time Zone will be set to Greenwich Mean Time, causing Local Time to be identical to UTC.
If a value starting with the prefix GMT, followed by a positive or negative offset in hours or hours and minutes is specified then the Time Zone will be set based on that offset from UTC.
For example:
GMT-10 would be 10 hours BEHIND Greenwich Mean Time.
GMT+05:30 would be 5 hours and 30 minutes AHEAD of Greenwich Mean Time.
- If a value matching an Olsen/tz Time Zone identifier (i.e. "America/New_York") is specified, then the Time Zone will be set based on the characteristics of the identified well-known Time Zone.
Detail Information:
Key = sysClockTimeZone
Type = string
Time Format
Select how time values will be formatted when displayed on a device.
If the value 12 is selected, time values will be displayed in 12 hour (AM/PM) format.
If the value 24 is selected, time values will be displayed in 24 hour (military) format.
Detail Information:
Key = sysClockTimeFormat
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| 12 | 2 |
| 24 | 1 |
Support Information:
- Supported from: MX 6.0.
Data Wipe Configuration
Use this Sub-group to configure Data Wipe Options and Bypass SUW on Enterprise Reset
Sometimes it may become necessary or desirable to Wipe some or all device data. To understand when and why it might be appropriate to Wipe device data, it is important to understand the different types of device data that could exist, and which could be Wiped.
- Primary Storage
Primary Storage is flash memory that is allocated to hold data, organized as files, that is produced and stored while the device is running. Every Zebra Android device has some form of Primary Storage. although the size and utilization of it may vary from device to device. This is where standard Android folders, such as /sdcard and /data are located. Primary Storage is the "workhorse" storage of the device and is frequently read, written, and updated during normal device operation. All data stored in Primary Storage is encrypted by the system using device unique keys.
- Persistent Storage
Persistent Storage is flash memory that is allocated to hold data, which may or may not be organized as files, that needs to be more Persistent than Primary Storage. Every Zebra Android device has some form of Persistent Storage. although the size and methods required to access it may vary from device to device. This is where the Zebra-proprietary folder /enterprise, on devices that have it, is located. Persistent Storage is commonly used to store applications, configuration, and data that collectively define a "known good state" to which a device can be returned by Wiping Primary Storage but preserving Persistent Storage. Data stored in Persistent Storage is not necessarily encrypted by the system.
- Portable Storage
Portable Storage is flash memory on a Removable Micro SD Card that is used to hold data, organized as files, that is physically removable from the device itself. Not every Zebra Android device supports Portable Storage, and among devices that do, the size(s) of cards supported may vary. Portable Storage may be used to import data into a device, export data from a device, share data amongst devices, etc. Over time, the types of data that can usefully be stored and accessed on Portable Storage has become more and more limited, and likely will be even more restricted in the future. Data stored in Portable Storage can optionally be encrypted. Any one Removable Micro SD Card can only be used for Portable Storage or Adopted Storage at any given time and switching between the two requires Wiping of all data from the card.
- Adopted Storage
Adopted Storage is flash memory on a Removable Micro SD Card that is used to extend Primary Storage. Even through the card is physically removable from the device, once adopted, it should not be removed since it can negatively impact the continuing operation of the device. Unlike Portable Storage, Adopted Storage CANNOT be used to import data into a device, export data from a device, share data amongst devices, etc. All data stored in Adopted Storage is encrypted in the same manner as the Primary Storage it extends. Wiping Primary Storage does NOT directly Wipe Adopted Storage but does render the data on the card unusable.
The following types of Data Wipe are supported:
- Enterprise Reset
Enterprise Reset causes Primary Storage to be Wiped, all data in Adopted Storage to be invalidated, and all data in Persistent Storage and Portable Storage to be preserved. When performing an Enterprise Reset, a flag is kept in Persistent Storage to indicate that it has been done. This flag is used to prevent repetition of Enterprise Reset from being performed if another request to Wipe Primary Storage is sent again after the Enterprise Reset. If another Enterprise Reset is later desired, the request to Wipe Persistent Storage must be removed, by removing the Primary Storage option. This will cause the flag to be removed and allow a subsequent Enterprise Reset to be performed once the Primary Storage is specified again. Enterprise Reset is typically used to return a device a previously stored "known good" state, based on applications, configurations, and data that were previously stored Persistently, and hence should be performed relatively infrequently.
- Factory Reset
Factory Reset is identical to Enterprise Reset with the exception that all data in Persistent Storage is also Wiped. Because Persistent Storage is also Wiped, the approach described above for storing a flag in Persistent Storage cannot be used to prevent repetition of Factory Reset from being performed if another request to Wipe Primary Storage is sent again after the Factory Reset. Factory Reset is typically used to forcibly terminate management of a device, either to enable repurposing of the device, to prepare for the device for servicing, etc. and hence should be performed very infrequently. When enrolling a device for management at a later time, following an earlier request to perform a Factory Reset, care should be taken to avoid resending the same options, since nothing will prevent Factory Reset from being performed again, if requested.
Notes:
The data to be Wiped is requested by specifying one or more Data Wipe Option Types within Data Wipe Option Type Sub-groups as elements of this Sub-array.
Each Data Wipe Option Type specifies a specific storage area to be Wiped and the type of Wipe operation(s) to be performed is chosen to ensure that all requested data will be Wiped.
In some cases, it may not be possible to Wipe one storage area without also Wiping another storage area.
If the combination of storage areas requested to be Wiped cannot be performed without Wiping additional storage areas that are NOT requested, then NOTHING will be Wiped, since no data will be Wiped unless specifically requested. For example, if ONLY Persistent Storage is specified, then nothing will be Wiped since it is not possible to Wipe Persistent Storage without ALSO Wiping Primary Storage. .
Detail Information:
Key = dataWipeConfig
Type = bundle
Support Information:
- Supported from: MX 7.1.
Data Wipe Options
Use this Sub-array to configure one or more Data Wipe Option(s) .
Detail Information:
Key = dataWipeDataWipeOptions
Type = bundle_array
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Data Wipe Option
Use this Sub-group to configure Data Wipe Option Type.
Detail Information:
Key = dataWipeDataWipeOption
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Data Wipe Option Type
Select the Type for a single Data Wipe Option to request that a specified device storage area be Wiped.
If the value Primary Storage is selected, then Primary Storage will be Wiped, also invalidating Adopted Storage if it is being used. This value will result in either an Enterprise Reset or a Factory Reset being performed, depending on what other Data Wipe Option Type(s) are also specified in Data Wipe Options.
If the value Persistent Storage is selected, then Persistent Storage will be Wiped, but only if this value is specified in addition to value Primary Storage. Primary Storage must also be specified since it is only possible to Wipe Persistent Storage when also Wiping Primary Storage, by doing a Factory Reset, and all storage areas to be Wiped must be explicitly specified.
If the value Portable Storage is selected, then Portable Storage will be Wiped, but only if this value is specified in addition to value Primary Storage. Primary Storage must also be specified since it is not possible to Wipe Portable Storage without also Wiping Primary Storage, by doing an Enterprise Reset or a Factory Reset, and only storage areas that are specifically specified will be Wiped. This value can optionally be used together with value Persistent Storage.
Detail Information:
Key = dataWipeDataWipeOptionType
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Primary Storage | 1 |
| Persistent Storage | 2 |
| Portable Storage | 4 |
Bypass SUW on Enterprise Reset
Select whether the Google Setup Wizard (SUW) should be bypassed when an Enterprise Reset is performed as a Data Wipe when Primary Storage is included as a Data Wipe Option Type in a Data Wipe Option in Data Wipe Options.
If the value Yes is selected, then the Google Setup Wizard (SUW) will be bypassed each time an Enterprise Reset is performed as a Data Wipe.
If the value No is selected, then the Google Setup Wizard (SUW) will NOT be bypassed each time an Enterprise Reset is performed as a Data Wipe.
Detail Information:
Key = dataWipeBypassSUWonEnterpriseReset
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Yes | 1 |
| No | 2 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
GMS Configuration
Use this Sub-group to configure GMS Feature Set and GMS Profile.
Detail Information:
Key = gmsConfig
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.3.
GMS Feature Set
Select the amount of functionality of Google Mobile Services (GMS) to enable.
- If the value All - Full Set of GMS Features is selected, the the entire set of Google Mobile Services (GMS), will be enabled for use.
Note that if Google Mobile Services are allowed to be used, may collect and send data to Google.
If the value Restricted - Fixed Minimal Set of GMS Features is selected, a limited (fixed) subset of Google Mobile Services (GMS), will be enabled for use. The subset will automatically be chosen to ensure that basic device functionality is not impaired, that all enabled Google Mobile Services operate usefully, and that no enabled Google Mobile Services send any data to Google.
If the value Profiled - Selected Subset of GMS Features is selected, a selected subset of Google Mobile Services (GMS) features will be enabled for use.
Detail Information:
Key = sysGmsFeatureSet
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| All - Full Set of GMS Features | 1 |
| Restricted - Fixed Minimal Set of GMS Features | 2 |
| Profiled - Selected Subset of GMS Features | 3 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
GMS Profile
Select the Google Mobile Services (GMS) profile to enable.
If the value Chrome Browser is selected, Chrome Browser will be enabled for use.
If the value Google Maps is selected, Google Maps will be enabled for use.
If the value Firebase Cloud Messaging is selected, Firebase Cloud Messaging will be enabled for use.
If the value Combination of Chrome and Maps and FCM is selected, Combination of Chrome, Maps and FCM will be enabled for use.
Detail Information:
Key = sysGmsProfile
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Chrome Browser | 1 |
| Google Maps | 2 |
| Firebase Cloud Messaging | 3 |
| Combination of Chrome and Maps and FCM | 4 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.3.
Lifeguard Configuration
Use this Sub-group to configure Update Mode, UI Control, Update Over Cellular, OTA Options, File-Based Update Source, File-Based Update Options, File-Based Update Local Path And Name, and Streaming
The following defined terms are important to understand:
Zebra LifeGuard
Zebra LifeGuard refers to Zebra’s LifeGuardTM for AndroidTM program that offers OS Updates for Zebra Android devices. Fore more information on the LifeGuard (LG) program, see the LifeGuard FAQ.
OS Update
An OS Update is the process or act of patching or replacing the Operating System (OS) software image of a Zebra Android device. OS Updates supported by Zebra LifeGuard can include OS Upgrades and, in some cases, OS Downgrades.
OS Upgrade
An OS Upgrade can provide security-only updates, maintenance releases (including features and fixes) and baseline and Android-version updates and generally changes the device to have a newer (higher) OS Version.
OS Downgrade
An OS Downgrade can remove security-only updates or maintenance releases (including features and fixes) or return a device to an earlier baseline or Android-version and generally changes the device to have a older (lower) OS Version. In most cases, an OS Downgrade also initiates a mandatory Data Wipe of Primary Storage to ensure that data is not placed at risk by the removal of security fixes that were protecting the data prior to the OS Downgrade.
OS Version
An OS Version is a string, also sometimes referred to as a Build ID, that uniquely identifies a particular Operating System (OS) software image for a Zebra Android device. A successful OS Update that applies a new software image will ALWAYS result in a change of the OS Version reported by the device.
Zebra LifeGuard OTA Server
The Zebra LifeGuard OTA Server is an Internet-hosted server that enables remote initiation of OS Updates on Internet-connected Zebra Android devices when using the Fully Automatic or EMM Controlled modes.
Zebra LifeGuard OTA Service
The Zebra LifeGuard OTA Service is a software component that is built-into Zebra Android devices and communicates with the Zebra LifeGuard OTA Server to allow it to remotely initiate OS Updates on the device. Use of this service requires the service to be enabled and requires device network connectivity over which the Zebra LifeGuard OTA Server on the Internet can be reached. Fore more information on the Zebra LifeGuard OTA Service, see Device Update.
Zebra LifeGuard Update Files
A Zebra LifeGuard Update File is a ZIP-format file released by Zebra. These files can be leveraged by the Zebra LifeGuard OTA Server and the Zebra LifeGuard OTA Service when performing Fully Automatic or EMM Controlled OS Updates or can be manually downloaded and used to perform File-Based Updates OS Updates.
Local Update Files
A Local Update File is a Zebra LifeGuard Update File that is downloaded in advance, using any available means, stored in the Device File System and then used to initiate File-Based Updates. Using Zebra Local Update Files can increase the reliability of OS Updates as well as allowing deferred initiation at a time when network connectivity may be unavailable, at the expense of occupying, at least temporarily, a potentially significant amount of Device File System space.
Streamed Update Files
A Streamed Update File is a Zebra LifeGuard Update File that is downloaded on demand when File-Based Updates are initiated and never needs to be stored in the Device File System. Using Streamed Update Files avoids the need to have sufficient Device File System space to hold potentially large files to initiate OS Updates, but increases the risk that network connectivity loss during the OS Update could cause the OS Update to fail. The use of Streamed Update Files is only allowed for Zebra LifeGuard Update Files that support A/B Mode due to the risks associated with failures due to network connectivity loss.
A/B Mode
A/B Mode is a mode wherein an OS Update can be performed by installing the new OS into the B partition while the device is running in the A partition. This allows the OS Update to be performed safely while the device is in use because the current OS being run from the A partition is not affected. When the OS Update is completed successfully, a device reboot is required to activate the new OS in the B partition. If the new OS is successfully activated, then the partitions are swapped so the next OS Update in A/B Mode will replace the prior OS. If the new OS cannot be successfully activated, the current OS will be retained, preventing any loss of operability. A/B Mode is sometimes also referred to as "Seamless Update" because the bulk of the processing can be performed in the background with minimal impact on User workflow. Sometime after the completion of an OS Update performed in A/B Mode, a reboot is required, but this reboot could be delayed until a time when it will little or no impact on User workflow.
Zebra StageNow
Zebra StageNow is Zebra's Android device Staging (configuration and deployment) solution, which simplifies the local initiation of OS Updates in File-Based Updates mode.
Zebra Recovery Mode
Zebra Recovery Mode is a special mode into which Zebra Android devices can be booted that enables a User to manually initiate OS Updates in File-Based Updates mode using Local Update Files. Zebra Recovery Mode is also used when OS Updates are remotely initiated using Zebra LifeGuard Update Files that DO NOT support A/B Mode. In such cases, the device will reboot into Zebra Recovery Mode when the OS Update is initiated, the OS Update will be performed in Zebra Recovery Mode, then the device will reboot into the new, updated, OS. .
Detail Information:
Key = fotaConfig
Type = bundle
Update Mode
Select how OS Updates will be initiated on the device.
If the value Fully Automatic is selected, then Zebra LifeGuard OTA Service will be enabled and configured to automatically update the device whenever a suitable new Zebra LifeGuard Update File is published by Zebra. Use of this mode requires device network connectivity over which the Zebra LifeGuard OTA Server on the Internet can be reached. Standard data rates apply for metered connections.
If the value EMM Controlled is selected, then Zebra LifeGuard OTA Service will be enabled but configured to NOT automatically update the OS even if a suitable new OS is published by Zebra. A LifeGuard OTA-integrated EMM can be used to control when/if OS Updates are initiated remotely on devices and which Zebra LifeGuard Update Files are used. Use of this mode requires device network connectivity over which the EMM Server can be reached and over which Zebra LifeGuard OTA Server can be reached. Standard data rates apply for metered connections.
If the value File-Based Updates is selected, then Zebra LifeGuard OTA Service will be disabled. File-Based Update Options can be specified to initiate OS Updates or OS Updates may be manually initiated on a device by the User using Zebra StageNow or Zebra Recovery Mode.
Detail Information:
Key = fotaUpdateMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Fully Automatic | 1 |
| EMM Controlled | 2 |
| File-Based Updates | 3 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.1.
UI Control
Select whether the User can change Zebra LifeGuard OTA Service settings.
If the value Disallow is selected, the User will NOT be Allowed to use UI to modify Zebra LifeGuard OTA Service settings.
If the value Allow is selected, the User WILL be Allowed to use UI to modify Zebra LifeGuard OTA Service settings.
Detail Information:
Key = fotaUserControlOfSettings
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 9.1.
Update Over Cellular
Select whether Full Automatic LifeGuard updates can occur over Cellular (metered) networks.
If the value On is selected, the User will use the cellular (metered) network to download the update.
If the value Off is selected, the User will use an unmetered network to download the update.
Detail Information:
Key = fotaUpdateOverCellular
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.1.
OTA Options
Enter one or more optional parameters to configure or adjust the behavior of the Zebra LifeGuard OTA Service.
Note: This feature is reserved for future use and no valid supported options currently exist. It is therefore recommended to leave this MC empty until future notice.
Detail Information:
Key = fotaOptions
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: Future Use.
File-Based Update Source
Select the Source for the Zebra LifeGuard Update File to be used to initiate an OS Update when File-Based Updates is specified for Update Mode.
If the value Local Update File is selected, then an OS Update, if initiated, will use a Local Update File, whose path and file name must be specified in File-Based Update Local Path And Name, and which must already be present in the Device File System for the OS Update to occur.
If the value Streamed Update File is selected, then an * OS Update, if initiated, will use a *Streamed Update File, information about which must be specified in Streaming Configuration, and which must be present and reachable by the device over a suitable network for the OS Update to occur.
Detail Information:
Key = fotaConfigUpdateFileSource
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Local Update File | 1 |
| Streamed Update File | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
File-Based Update Options
Use this Sub-array to configure one or more File-Based Update Option(s) when File-Based Updates is specified for Update Mode.
To initiate File-Based Updates, one or more File-Based Update Options must be specified to identify the condition(s) under which OS Updates will be initiated. This is necessary because File-Based Updates could be initiated at any time and it would generally be undesirable to repeat the initiation of an OS Update that has already been successfully completed because it would put unnecessary load on the device and could negatively impact User workflow (e.g., by rebooting, etc.).
Note: It is allowable to use any combination of File-Based Update Options together, in which case an OS Update will ONLY be performed if the conditions associated with ALL specified options are met.
Detail Information:
Key = fotaUpdateOptions
Type = bundle_array
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
File-Based Update Option
Use this Sub-group to configure File-Based Update Option Type and Mismatch Version.
Detail Information:
Key = fotaUpdateOption
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
File-Based Update Option Type
Select the Type of a single File-Based Update Option relating to how/when a Zebra LifeGuard Update File will be used to initiate an OS Update. when File-Based Updates is specified for Update Mode.
If the value Reboot Count Unchanged is selected, then an OS Update will be initiated when the value is set if the device has not rebooted since this value was first set and if the other requisite values for File Update are also specified. This Option assumes that a reboot will be performed as result of any OS Update (successful or unsuccessful) and hence that once the device has been rebooted, there would be no value in repeating the OS Update.
If the value Version Mismatch is selected, then an OS Update will be initiated when the value is set if the device reports a different OS Version for its current OS from that specified in Mismatch Version and if the other requisite values for File Update are also specified. This Option assumes that the administrator has properly determined the OS Version that will be present on the device once the Zebra LifeGuard Update File is applied and has accurately specified that OS Version value. The OS Version that will be present on the device once a Zebra LifeGuard Update File is applied to a device will be provided along with the Zebra LifeGuard Update File where it is posted by Zebra on the Internet. If an incorrect OS Version is specified, then it will likely never match the version reported by the device after performing the OS Update and could lead to repeated attempts to update the OS on the device.
Note: It is allowable to use any combination of File-Based Update Options together, in which case an OS Update will ONLY be performed if the conditions associated with ALL specified options are met.
Note: When using File-Based Update Options to perform an OS Update using a Zebra LifeGuard Update File, File-Based Update Source must also be specified to identify the Source from which the Zebra LifeGuard Update File will be acquired to perform the OS Update.
If the value Local Update File is selected for File-Based Update Source, then File-Based Update Local Path And Name must also be specified to provide the path and file name of the Local Update File, which must already be present in the Device File System, to be used to perform the OS Update.
If the value Streamed Update File is selected for File-Based Update Source, then Streaming Configuration must also be specified to provide the information required to Stream the Streamed Update File to perform the OS Update.
Detail Information:
Key = fotaUpdateOptionType
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Reboot Count Unchanged | 1 |
| Version Mismatch | 2 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Mismatch Version
Enter the OS Version that will be reported by the device once the Zebra LifeGuard Update File is applied to the device. This is used to determine if the device current reports a different OS Version and hence needs to initiate an OS Update using the Zebra LifeGuard Update File to bring the device to the desired OS.
Detail Information:
Key = fotaUpdateOptionTypeMismatchVersion
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
File-Based Update Local Path And Name
Enter the Path and File Name in the Device File System of a Local Update File to use to initiate an OS Update, when the value File-Based Updates is selected for Update Mode.
Detail Information:
Key = fotaConfigLocalFilePathAndName
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.1.
Streaming Configuration
Use this Sub-group to configure Source URL, Authorization Type, Zebra Authentication Token, Username, Password, and Custom Authentication Header when File-Based Updates is specified for Update Mode and Streamed Update File is specified for File-Based Update Source.
To initiate an OS Update using File-Based Updates and a Streamed Update File, it is necessary to specify the source location from which the Streamed Update File will be acquired. It is also be necessary to specify information about the form of Authentication that will be used to authorize access to it. The following types of Authentication are supported when acquiring a Streamed Update File:
No Authorization is used when the URI specified for the source location from which the Streamed Update File will be acquired requires no authentication to authorize access.
Zebra Authentication Token is used when the URI specified for the source location from which the Streamed Update File is aZebra Internet Repository and therefore requires a Zebra Authentication Token issued by Zebra to be specified to authorize access.
Basic Authentication is used when the URI specified for the source location from which the Streamed Update File is a Repository that uses Basic Authentication and therefore requires a Username and Password to be specified to authorize access.
Custom Authorization Header is used when the URI specified for the source location from which the Streamed Update File is a Repository that uses some other form of Authentication and therefore requires a Custom Authentication Header to be specified to authorize access. .
Detail Information:
Key = fotaStreamingConfig
Type = bundle
Support Information:
- Supported from: MX 10.0.
Source URL
Enter a URL via which a Streamed Update File can be accessed, when needed, to initiate an OS Update. This could be an Internet or Intranet URL, and might require some form of Authentication" to authorize access to it. The *Authentication required to authorize access to the Streamed Update File must also be specified via Authorization Type.
Detail Information:
Key = fotaStreamingConfigSourcerUrl
Type = string
Authorization Type
Select the Type of Authentication required to authorize access to the Streamed Update File that will be used to initiate an OS Update.
If the value No Authorization is selected, no Authentication will be used to authorize access to the Streamed Update File and you do not need to specify any additional information.
If the value Zebra Authentication Token is selected, then Zebra Authentication will be used to authorize access to the Streamed Update File and therefore you must also specify Zebra Authentication Token.
If the value Basic Authentication is selected, then Basic Authentication will be used to authorize access to the Streamed Update File and therefore you must also specify Username and Password.
If the value Custom Authorization Header is selected, then Custom Authentication will be used to authorize access to the Streamed Update File and therefore you must also specify Custom Authentication Header.
Detail Information:
Key = fotaStreamingConfigAuthType
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| No Authorization | 0 |
| Zebra Authentication Token | 1 |
| Basic Authentication | 2 |
| Custom Authorization Header | 3 |
Zebra Authentication Token
Enter the Zebra-issued Authentication token required to authorize access to the Streamed Update File to be used to initiate an OS Update when Zebra Authentication Token is specified for Authorization Type.
Detail Information:
Key = fotaStreamingConfigZebraAuthToken
Type = string
Username
Enter the Username required to authorize access to the Streamed Update File to be used to initiate an OS Update when Basic Authentication is specified for Authorization Type.
Detail Information:
Key = fotaStreamingConfigUserName
Type = string
Password
Enter the Password required to authorize access to the Streamed Update File to be used to initiate an OS Update when Basic Authentication is specified for Authorization Type.
Detail Information:
Key = fotaStreamingConfigPassword
Type = string
Custom Authentication Header
Enter the Custom Authentication Header value required to authorize access to the Streamed Update File to be used to initiate an OS Update when Custom Authorization Header is specified for Authorization Type.
Detail Information:
Key = fotaStreamingConfigCustomAuthHeader
Type = string
Power Configuration
Use this Sub-group to configure Auto Control, Battery, Battery Charge Mode, Maximum Battery Charge, Recovery Mode Access, Battery Charge Schedules, Heaters, Ports Power, and Doze Mode State.
Detail Information:
Key = powerConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Auto Control Configuration
Use this Sub-group to configure State, On Mode, Off Mode, and Off Timeout.
Detail Information:
Key = autoControlConfig
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 7.1.
State
Select whether device power will be automatically controlled.
If the value Off is selected, the device power will NOT be automatically controlled.
If the value On is selected, the device power will be automatically controlled and you should also specify one or more of Off Mode, to specify whether/how device power will automatically be turned off or On Mode, to specify whether/how device power will automatically be turned on.
Detail Information:
Key = autoPowerState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Change | |
| Off | 0 |
| On | 1 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
On Mode
Select whether and how device power will be automatically turned on as part of automatic power control when Off Timeout is specified:
If the value Never is selected, the device power will NOT automatically turn on when the ignition turns on.
If the value When Ignition is Turned On is selected, the device power will automatically turn on whenever the ignition turns on.
Detail Information:
Key = autoPowerOnMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Never | 0 |
| When Ignition is Turned On | 1 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Off Mode
Select whether and how device power will be automatically turned off as part of automatic power control when Auto Power Control is specified.
If the value Never is selected, the device power will NOT automatically turn off when the ignition turns off.
If the value When Ignition is Turned Off is selected, the device power will automatically turn off whenever the ignition turns off.
Detail Information:
Key = autoPowerOffMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Never | 0 |
| When Ignition is Turned Off | 1 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Off Timeout
Enter the timeout that will be in effect before device power is automatically turned off as part of automatic power control, when the value On is selected for State is specified and the value When Ignition is Turned Off is selected for Off Mode.
A value of 0 will leave the existing timeout unchanged.
Detail Information:
Key = autoPowerOffTimeout
Type = integer
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Battery Configuration
Use this Sub-group to configure Critical Low Threshold, Decommission Percentage Threshold, Decommission Usage Threshold, Saver Control Mode, Saver Mode Percentage Threshold, Saver State, and User Control of Saver.
Detail Information:
Key = batteryConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Critical Low Threshold
Enter the threshold battery level below which the battery is deemed to be critically low.
The Default Value is 4, which causes the battery to be deemed critical low when the battery level dips below 4% remaining capacity.
If the value 0 is entered, the currently configured critically low threshold will not be changed, which is functionally equivalent to not specifying a value.
If a value from 1 through 25 is entered, the critically low threshold will be set to the specified value.
Detail Information:
Key = batteryCriticalLowThreshold
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.3.
Decommission Percentage Threshold
Enter the percentage of remaining battery capacity below which the battery will be deemed ready for decommissioning.
Detail Information:
Key = batteryDecommissionPercentageThreshold
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.4.
Decommission Usage Threshold
Enter the amount of battery usage (e.g. charge/discharge cycles, coulombs in/out, etc.) that can occur before the battery will be deemed ready for Decommissioning.
Detail Information:
Key = batteryDecommissionUsageThreshold
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.4.
Saver Control Mode
Select how Battery Saver Mode will be controlled.
If the value Manually is selected, the device will NOT Automatically, and will activate Battery Saver Mode only when specifically requested by the User or by specifying the value On for Saver State.
If the value Automatically is selected, the device WILL Automatically activate Battery Saver Mode and Saver Mode Percentage Threshold must also be specified to provide the threshold battery level percentage below which the device will Automatically activate Battery Saver Mode.
Detail Information:
Key = powerBatterySaverControlMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Change | |
| Manually | 2 |
| Automatically | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.1.
Saver Mode Percentage Threshold
Enter the Battery Level percentage below which Battery Saver Mode will automatically turned On, when Automatically is specified for Saver Control Mode.
Detail Information:
Key = powerBatterySaverModePercentage
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.1.
Saver State
Select the Battery Saver State.
If the value Off is selected, Battery Saver State will be turned Of.
If the value On is selected, Battery Saver State will be turned On.
Detail Information:
Key = powerBatterySaverState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: TBD.
User Control of Saver
Select whether the User will be allowed to control the State of Battery Saver Mode via UI on the device.
If the value Disable is selected, then the User will NOT be allowed to control the State of Battery Saver Mode via UI on the device.
If the value Enable is selected, then the User will be allowed to control the State of Battery Saver Mode via UI on the device.
Detail Information:
Key = powerBatteryUserControlSaver
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disable | 2 |
| Enable | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.2.
Battery Charge Mode
Select battery charge mode.
If the value System default is selected, then the standard Android battery charging mechanisms will be used.
If the value Set maximum charge is selected, then the battery will be charged until it reaches the value specified in Maximum Battery Charge
Detail Information:
Key = powerBatteryChargeMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| System default | 1 |
| Set maximum charge | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.6.
Maximum Battery Charge
Enter the maximum battery charge percentage (between 65 and 100) at which charging will stop, when !!2@powerBatteryChargeMode!! is specified for Battery Charge Mode
Detail Information:
Key = powerBatteryMaximumCharge
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.6.
Recovery Mode Access
Select whether to turn on Recovery Mode Access.
If the value Full (default) is selected, Recovery Mode Access is turned on and OS changes will NOT be allowed.
If the value Partial (blocks sensitive operations) is selected, Recovery Mode Access is turned off and OS changes will be allowed.
Detail Information:
Key = powerZebraResetProtection
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Change | |
| Full (default) | 1 |
| Partial (blocks sensitive operations) | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.1.
Battery Charge Schedules
Use this Sub-array to configure one or more Schedule(s).
Detail Information:
Key = pBChargeSchedules
Type = bundle_array
Support Information:
Supported on Operating System(s): Android 11.
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.6.
Schedule
Use this Sub-group to configure Target Day and Target Time.
Detail Information:
Key = pBCSchedule
Type = bundle
Support Information:
Supported on Operating System(s): Android 11.
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.6.
Target Day
Select the day to have the battery fully charged.
Detail Information:
Key = pBCSDay
Type = string
| UI Choice | JSON Value |
|---|---|
| Monday | 1 |
| Tuesday | 2 |
| Wednesday | 3 |
| Thursday | 4 |
| Friday | 5 |
| Saturday | 6 |
| Sunday | 7 |
Support Information:
Supported on Operating System(s): Android 11.
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.6.
Target Time
Select the time to have the battery fully charged.
Detail Information:
Key = pBCSTime
Type = string
Support Information:
Supported on Operating System(s): Android 11.
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.6.
Heaters
Use this Sub-array to configure one or more Heater(s).
Detail Information:
Key = heaters
Type = bundle_array
Support Information:
Supported on Operating System(s): Oreo and Pie.
Supported on Device(s): VC80X and VC8300.
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 9.1.
Support discontinued from: MX 9.0.
Heater
Use this Sub-group to configure Type, Off Threshold, and On Threshold.
Detail Information:
Key = heater
Type = bundle
Support Information:
Supported on Operating System(s): Oreo and Pie.
Supported on Device(s): VC80X and VC8300.
NOT supported on Device(s): TC20 and TC25.
Support discontinued from: MX 9.0.
Type
Select the Type of Heater.
If the value Serial I/O is selected, the Heater that warms the Serial I/O Port of the device will be selected.
If the value USB I/O is selected, the Heater that warms the USB I/O Port of the device will be selected.
If the value Battery is selected, the Heater that warms the Battery of the device will be selected.
If the value Touch Panel is selected, the Heater that warms the Touch Panel of the device will be selected.
If the value Keyboard is selected, the Heater that warms the Keyboard of the device will be selected.
If the value Scanner Window is selected, the Heater that warms the Scanner Window of the device will be selected.
Detail Information:
Key = heaterType
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Serial I/O | 1 |
| USB I/O | 2 |
| Battery | 3 |
| Touch Panel | 4 |
| Keyboard | 5 |
| Scanner Window | 6 |
Support Information:
Supported on Operating System(s): Oreo and Pie.
Supported on Device(s): VC80X and VC8300.
NOT supported on Device(s): TC20 and TC25.
Off Threshold
Select the temperature above which a specified Heater should automatically turn OFF.
Detail Information:
Key = heaterOffThreshold
Type = integer
Support Information:
Supported on Operating System(s): Oreo and Pie.
Supported on Device(s): VC80X and VC8300.
NOT supported on Device(s): TC20 and TC25.
On Threshold
Select the temperature below which a specified Heater should automatically turn ON.
Detail Information:
Key = heaterOnThreshold
Type = integer
Support Information:
Supported on Operating System(s): Oreo and Pie.
Supported on Device(s): VC80X and VC8300.
NOT supported on Device(s): TC20 and TC25.
Ports Power
Use this Sub-array to configure one or more Port Power(s).
Detail Information:
Key = portsPower
Type = bundle_array
Support Information:
Supported on Operating System(s): Oreo and Pie.
Supported on Device(s): VC80X and VC8300.
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 7.1.
Support discontinued from: MX 9.0.
Port Power
Use this Sub-group to configure Power Port Type.
Detail Information:
Key = portPower
Type = bundle
Support Information:
Supported on Operating System(s): Oreo and Pie.
Supported on Device(s): VC80X and VC8300.
NOT supported on Device(s): TC20 and TC25.
Support discontinued from: MX 9.0.
Power Port Type
Select a Port Type for which the Output Power State will be specified.
If the value Serial Port 1 is selected, the the Output Power State will be specified for the first Serial Port.
If the value Serial Port 2 is selected, the Output Power State will be specified for the second device Serial Port.
If the value USB Port 2 is selected, the Output Power State will be specified for second device USB Port.
Detail Information:
Key = sysPowerPortType
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Serial Port 1 | 1 |
| Serial Port 2 | 2 |
| USB Port 2 | 3 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Doze Mode State
Select whether Doze Mode should be turned On or Off for the entire device.
If the value Off is selected, the device will never enter Doze Mode for any applications.
If the value On is selected, the device will will enter Doze Mode for various applications based on the normal Android rules for Doze Mode.
Detail Information:
Key = sysPowerDozeModeState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 7.2.
Remote Scanner Configurations
Use this Sub-group to configure Remote Scanner Configuration.
Detail Information:
Key = remoteScannerConfigs
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 5.2.
Remote Scanner Configuration
Use this Sub-array to configure one or more Remote Scanner(s).
Detail Information:
Key = remoteScannerConfig
Type = bundle_array
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Remote Scanner
Use this Sub-group to configure Config File, Scanner Serial Number, and Update File.
Detail Information:
Key = remoteScanner
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Config File
Enter the path and file name of a configuration file, which must exist at the specified location in the device file system, from which configuration should be applied to the specified Remote Scanner.
Detail Information:
Key = remoteScannerConfigFile
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 5.2.
Scanner Serial Number
Enter the Serial Number of the Remote Scanner to be affected.
Detail Information:
Key = remoteScannerSerialNumber
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 5.2.
Update File
Enter the path and file name of an Update File to be applied.
Detail Information:
Key = remoteScannerUpdateFile
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 5.2.
Wake-Up Configuration
Use this Sub-group to configure Wake-Up All Sources State, Wake-Up Method, and Wake-Up Sources.
Detail Information:
Key = wakeupConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Wake-Up All Sources State
Select whether all Wake-Up Sources should be collectively turned On or Off.
If the value Off is selected, then all Wake-Up Sources will be turned Off (will NOT Wake-Up the Display).
If the value On is selected, then all Wake-Up Sources will be turned On (will Wake-Up the Display).
Detail Information:
Key = wakeupAllSourcesState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.0.
Wake-Up Method
Select the Method that will be used to identify Wake-up Sources to be controlled.
If the value Use Hardware Signals for Wake-Up is selected, Wake-Up Sources will be Key Identifiers for Hardware Signals related to Physical Keys.
If the value Use Software (Mappable Keycodes) for Wake-Up is selected, Wake-Up Sources will be Key Identifiers for Software Remappable Keys.
Detail Information:
Key = wakeupMethod
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Use Hardware Signals for Wake-Up | 1 |
| Use Software (Mappable Keycodes) for Wake-Up | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 9.2.
Wake-Up Sources
Use this Sub-array to configure one or more Wake-Up Source(s).
Detail Information:
Key = powerWakeupSources
Type = bundle_array
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 9.3.
Wake-Up Source
Use this Sub-group to configure Key Identifier and Custom Key Identifier.
Detail Information:
Key = wakeupSource
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Key Identifier
Select the Key Identifier to be used to identify the Wake-Up Source to be controlled.
If the value L1 Button is selected, the First (Topmost) Button located on the Left side of the device will be the identified Wake-Up Source.
If the value L2 Button is selected, the Second (Down from the top) Button located on the Left side of the device will be the identified Wake-Up Source.
If the value R1 Button is selected, the First (Topmost) Button located on the Right side of the device will be the identified Wake-Up Source.
If the value R2 Button is selected, the Second (Down from the top) Button located on the Right side of the device will be the identified Wake-Up Source.
If the value Grip (Gun) Trigger is selected, the Trigger on the Grip (Gun Handle) will be the identified Wake-Up Source.
If the value Rear Button is selected, the Button located on the Rear of the device will be the identified Wake-Up Source.
If the value Custom is selected, a Custom Button will be the identified Wake-Up Source.
Detail Information:
Key = wakeupKeyId
Type = string
| UI Choice | JSON Value |
|---|---|
| Button L1 | BUTTON_L1 |
| Button L2 | BUTTON_L2 |
| Button R1 | BUTTON_R1 |
| Button R2 | BUTTON_R2 |
| Grip (Gun) Trigger | GUN_TRIGGER |
| Rear Button | REAR_BUTTON |
| Custom | Custom |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Custom Key Identifier
Enter the custom Key Identifier that identifies the Wake-Up Source to be controlled.
Detail Information:
Key = wakeupCustomKeyId
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Pass-Through Command
Enter XML to be passed-through by OEMConfig to a lower-level processing module.
Note: XML from BatchMgr, ConditionMgr and PersistMgr are not supported for pass-through.
Detail Information:
Key = passThroughCommand
Type = string
Logs Configuration
Use this Sub-group to configure Background Collection State, Logging Level, Upload When Logging Turned Off, Upload Snapshots URI, Control Secure Logging, and Control Secure Logging Password.
Detail Information:
Key = logsConfig
Type = bundle
Background Collection State
Select the Log Action to be performed.
If the value Start Background Collection is selected, then the Log Management subsystem will Start Background Collection of Log Files. To ensure that Log File content required for troubleshooting is available, Background Collection of Log Files should be Started well before the occurrence of an event of interest to ensure that when the Log Files are acquired, they will contain information concerning that event.
If the value Stop Background Collection is selected, then the Log Management subsystem will Stop Background Collection of Log Files. Since Background Collection of Log Files can consume significant system resources, it is best to Stop Background Collection of Log Files when troubleshooting is completed and collection of Log Files is no longer required.
Detail Information:
Key = backgroundCollectionState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 0 |
| On | 1 |
Logging Level
Select the Level of Logging to be performed.
If the value Basic is selected, then the Log Management subsystem will be configured to collect Kernel and Logcat log data.
If the value Basic+Qxdm is selected, then the Log Management subsystem will be configured to collect Kernel, Logcat and Qxdm log data. Qxdm log data is only supported on WAN (Cellular) devices.
If the value Basic+TCP Dump is selected, then the Log Management subsystem will be configured to collect Kernel, Logcat and TCP Dump log data.
Since Background Collection of Log Files can consume significant system resources, it is best to select the minimum level of Logcat logging that will serve the need. When unsure, it may be advisable to start with lowest level and work up to higher levels if needed.
Detail Information:
Key = logsCollectionConfigurationLogLevel
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Basic | [binary data] |
| Basic+Qxdm | [binary data] |
| Basic+TCP Dump | [binary data] |
Upload When Logging Turned Off
Select whether to upload logs to the specified URI when logging is turned off.
If the value No is selected, then when logging is turned off, no logs will be uploaded.
If the value Yes is selected, then when logging is turned off, logs will be sent to the URI defined in Upload Snapshots URI
Detail Information:
Key = logsCollectionConfigurationUploadWhenOff
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| No | 0 |
| Yes | 1 |
Upload Snapshots URI
Enter the URI of a location on a Remote Server to which all Snapshot Files previously Created on-device, and which have not yet been Uploaded, will be Uploaded.
Snapshot Files will be Uploaded to the Remote Server in the order they were Created on-device (oldest to newest).
Each Snapshot File will be automatically deleted from the device once it has been successfully Uploaded to the Remote Server.
The specified URI MUST start with a Protocol Specification that indicates which file transfer protocol should be used to Upload the Snapshot File. The following are supported:
FTP:// - The (insecure) File Transfer Protocol (FTP) protocol will be used to Upload the Snapshot File.
FTPS:// - The (secure) File Transfer Protocol over SSL (FTPS) protocol will be used to Upload the Snapshot File.
The specified URI:
MAY contain authentication credentials that will be used to authenticate to the Remote Server before Uploading the Snapshot File.
MUST contain an IP address or domain name that identifies the Remote Server to which the Snapshot File will be Uploaded.
SHOULD typically contain path that identifies the location on the Remote Server, relative to the home folder of the default account or the account selected by the authentication credentials, to which the Snapshot File will be Uploaded.
MUST NOT contain a file name since the name of the file to which the Snapshot File will be Uploaded on the Remote Server will be automatically generated, as described below, to ensure that Snapshot Files from various devices, and created at various times, do not overwrite each other.
Each Snapshot File that is Uploaded to the Remote Server will be assigned an automatically generated unique file name of the format:
- model-serial-date-time.zip.
The above format enables files Uploaded to the same folder on the Remote Server to be differentiated by the models and serial numbers of the devices that Uploaded them and by the date and time when the files were created on those devices.
- For example: TC510K-17068522528997-01312020-132649.zip
Within the above example:
TC510K is the model identifier of the device that Uploaded the Snapshot File.
17068522528997 is the serial number of the device that Uploaded the Snapshot File.
01312020 is the date the Snapshot File was Created in the device, indicating January 31, 2020.
132649 is the time the Snapshot File was Created in the device, indicating 1:26:49 PM.
Detail Information:
Key = logsUploadSnapshotsUri
Type = string
Control Secure Logging
Select whether Secure RxLogger should be on or off
If the value Turn On is selected, then RxLogger will capture data in secure mode.
If the value Turn Off is selected, then RxLogger will not capture data in secure mode.
RxLogger Secure Mode performs all the operations as Unsecure Mode. However, secure mode limits access to the logs by requiring a password to protect the data in the logs.
Detail Information:
Key = logsCollectionConfigurationSecureRxLogger
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Turn On | true |
| Turn Off | false |
Control Secure Logging Password
Enter the encrypted password to use for Secure RxLogger. Use Zebra's Data Encryption Tool to secure the password before pasting into this field.
Detail Information:
Key = logsCollectionConfigurationSecureRxLogPwd
Type = string
UI Configuration
Use this Group to configure Audio, DataWedge, Display, Event-Triggered Intents, General UI, Keyboard, Settings UI, Touch Panel, and Volume UI Profiles.
Detail Information:
Key = uiConfig
Type = bundle
Audio Configuration
Use this Sub-group to configure Best Path Exclusions, Charging Sounds, Replication, Vibrate On Call, Mute/Vibrate State, Vibrate Icon Usage, and VibrateIcon.
Detail Information:
Key = audioConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Best Path Exclusions
Use this Sub-array to configure one or more -Best Path Exclusion(s).
Detail Information:
Key = acBestPathExclusions
Type = bundle_array
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.1.
-Best Path Exclusion
Use this Sub-group to configure Device.
Detail Information:
Key = acBestPathExclusion
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.3.
Device
Select the device to include on the Best Path Exclusion list
Detail Information:
Key = acBPEDevice
Type = string
| UI Choice | JSON Value |
|---|---|
| Ignore | 0 |
| Wired Headset (3.5 mm) | 2 |
| USB Audio | 3 |
| Bluetooth A2DP Audio | 4 |
| HDMI Audio | 5 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.3.
Charging Sounds
Select whether a Sounds will be played when the Charging state of the device changes.
- If the value Do NOT Play is selected, no sound will be played when the Charging state of the device changes.
- If the value Play is selected, a chime will play when the Charging state of the device changes.
Detail Information:
Key = audioChargingSounds
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Do NOT Play | 2 |
| Play | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 9.3.
Replication
Select whether headset audio will be replicated to the built-in device speaker.
If the value Do not replicate headset audio on built-in speaker is selected, headset audio will NOT be replicated to the built-in device speaker. This might be desirable in a situation where the device is being used in an area where routing audio to the built-in device speaker could be disruptive to others in the area.
If the value Replicate headset audio on built-in speaker is selected, headset audio WILL be replicated to the built-in device speaker. This might be desirable in a situation where the User may walk away from a vehicle mounted device and leave his headset in the vehicle while performing some task nearby. If an audible alert is also routed to the built-in device speaker, the User might still hear it.
Detail Information:
Key = audioReplication
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Do not replicate headset audio on built-in speaker | 2 |
| Replicate headset audio on built-in speaker | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 7.2.
Vibrate On Call
Select whether the device will vibrate on call.
If the value Never Vibrate is selected, the device will never vibrate for incoming calls.
If the value Always Vibrate is selected, the device will always vibrate for incoming calls.
if the value Vibrate First Then Ring Gradually is selected, the device will vibrate first and then the ringer will gradually increase in volume.
Detail Information:
Key = audioSetVibrateOnCallsOption
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Never Vibrate | 1 |
| Always Vibrate | 2 |
| Vibrate First Then Ring Gradually | 3 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.1.
Mute/Vibrate State
Select the mute and vibrate behavior of a device.
If the value Mute without Vibrate is selected, the volume will be muted (made silent) and the device will NOT vibrate, permitting neither audible nor tactile alerts.
If the value Mute with Vibrate is selected, the volume will be muted (made silent) and the device will vibrate, permitting tactile but NOT audible alerts.
If the value Unmute without Vibrate is selected, the volume will be unmuted (made audible) and the device will NOT vibrate, permitting audible but not tactile alerts.
Detail Information:
Key = audioMuteVibrateState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Mute without Vibrate | 1 |
| Mute with Vibrate | 2 |
| Unmute without Vibrate | 3 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.4.
Vibrate Icon Usage
Select whether to display vibrate icon on the Status Bar.
If the value Disable is selected, Prevents the device user from changing the state (show/hide) of the vibration icon on the Status Bar.
If the value Enable is selected, Enables the device user to change the state (show/hide) of the vibration icon on the Status Bar.
Detail Information:
Key = audioVibrateIconUsage
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disable | 2 |
| Enable | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.2.
VibrateIcon
Select whether to display vibrate icon on the Status Bar.
If the value Show is selected, Allows display of the vibration setting icon on the Status Bar.
If the value Hide is selected, Prevents display of the vibration setting icon on the Status Bar.
Detail Information:
Key = audioVibrateIcon
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Show | 2 |
| Hide | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.2.
DataWedge Configuration
Use this Sub-group to configure APIs, Database File, Simulscan Template File, Automatic Database Import, and User Access to Configuration UI.
Detail Information:
Key = datawedgeConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
APIs Configuration
Use this Sub-group to configure Configuration Intent APIs, Import of DataWedge Database, Notification Intent APIs, Query Intent APIs, and Runtime Intent APIs.
Detail Information:
Key = dwApiConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Configuration Intent APIs
Select whether Access to the DataWedge Configuration Intent APIs will be controlled.
Detail Information:
Key = dwApiConfiguration
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Uncontrolled (default) - Allow use by all Applications | 1 |
| Controlled - Allow use only by Whitelisted Applications | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.1.
Import of DataWedge Database
Select whether applications will be allowed to programmatically import DataWedge Configuration Files using the DataWedge Intent API.
Detail Information:
Key = dwApiDatabaseImport
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 9.2.
Notification Intent APIs
Select whether Access to the DataWedge Notification Intent APIs will be controlled.
Detail Information:
Key = dwApiNotification
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Uncontrolled (default) - Allow use by all Applications | 1 |
| Controlled - Allow use only by Whitelisted Applications | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.1.
Query Intent APIs
Select whether Access to the DataWedge Query Intent APIs will be controlled.
Detail Information:
Key = dwApiQuery
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Uncontrolled (default) - Allow use by all Applications | 1 |
| Controlled - Allow use only by Whitelisted Applications | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.1.
Runtime Intent APIs
Select whether Access to the DataWedge Runtime Intent APIs will be controlled.
Detail Information:
Key = dwApiRuntime
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Uncontrolled (default) - Allow use by all Applications | 1 |
| Controlled - Allow use only by Whitelisted Applications | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.1.
Database File
Enter the path and file name of a valid full (datawedge.db) or partial (dwprofile_profilename.db) DataWedge Database file in the Device File System that should be imported to replace or merge with the current configuration of DataWedge.
Detail Information:
Key = datawedgeDatabaseFile
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 9.2.
Simulscan Template File
Enter the path and file name of a valid Simulscan template in the Device File System to be added or replaced via DataWedge.
Detail Information:
Key = datawedgeSimulscanTemplateFile
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.0.
Automatic Database Import
Select whether DataWedge will Allow Automatic importing of Database Files deployed to the DataWedge Autoimport Folder.
Detail Information:
Key = datawedgeAutoImport
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 0 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 9.2.
User Access to Configuration UI
Select whether device users will be permitted to Access the DataWedge configuration UI and hence to alter the configuration of DataWedge.
Detail Information:
Key = datawedgeUserAccessToConfigurationUi
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 9.2.
Display Configuration
Use this Sub-group to configure Force Activities Resizable, Blanking, Power, Secondary Display, and Size and Rotation.
Detail Information:
Key = displayConfig
Type = bundle
Force Activities Resizable
Select whether the device display and secondary display will force activities to be treated as resizable even if not declared in the application manifest.
If All Activities Resizable is selected, all activities running on the device display and secondary display will be forced to be treated as resizable even if not declared in the application manifest.
Iif Follow Application Manifest is selected, activities will be treated as resizable only if declared to be resizable in the application manifest.
Detail Information:
Key = uiDisplayForceActivitiesResizable
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| All Activities Resizable | 1 |
| Follow Application Manifest | 2 |
Support Information:
- Supported from: MX 10.5.
Blanking Configuration
Use this Sub-group to configure Mode, Signal, Debounce Delay, and Polarity.
Detail Information:
Key = blankingConfig
Type = bundle
Support Information:
- Supported from: MX 7.1.
Mode
Select whether the device Display will be Allowed to automatically Blank (display nothing) on a device under certain conditions.
When a User is operating a motor vehicle with a vehicle-mounted device, it is often advisable, and sometimes mandatory, for safety or regulatory reasons, to prevent the User from interacting with the device or being distracted by the Display of the device, while the vehicle is in motion.
At present, this feature is supported ONLY on the Zebra VC80x vehicle-mounted Android device.
If the value Never Blank is selected, the device Display will NOT be Allowed to automatically Blank (display nothing).
If the value Blank When Triggered by Signal is selected, the device Display WILL be Allowed to automatically Blank (display nothing). The following must also be specified:
Signal to specify the signal that will be used to activate automatic Display Blanking.
Polarity to specify the polarity of the signal specified via Signal that will be used to activate automatic Blanking.
Debounce Delay to specify the time that will be used to debounce the signal specified via Signal.
Detail Information:
Key = blankingMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Change | |
| Never Blank | 1 |
| Blank When Triggered by Signal | 2 |
Support Information:
- Supported on Device(s): VC8X.
Signal
Select the Signal that will be used to trigger automatic Display Blanking when the value Blank When Triggered by Signal is selected for Mode to turn on Display Blanking Mode.
- If the value Input 1 is selected, on the Zebra VC80x vehicle-mounted Android device the Clear To Send (CTS) input signal on Serial Port 1 will be used to trigger automatic Display Blanking.
- If the value Input 2 is selected, on the Zebra VC80x vehicle-mounted Android device the Clear To Send (CTS) input signal on Serial Port 2 will be used to trigger automatic Display Blanking.
A common configuration to support Display Blanking Mode would be to connect the Request to Send (RTS) output signal of the selected Serial Port to the Clear To Send (CTS) input signal on the same serial port, via a switch, such as one activated by the vehicle accelerator. When the switch is activated, the output RTS output signal would be fed back into the CTS input signal and detected to trigger automatic Display Blanking.
Detail Information:
Key = blankingModeSignal
Type = string
| UI Choice | JSON Value |
|---|---|
| No Signal | |
| Input 1 | 1 |
| Input 2 | 2 |
Support Information:
- Supported on Device(s): VC8X.
Debounce Delay
Enter the Debounce Delay that will be used for the Signal that will be used to trigger automatic Display Blanking when the value Blank When Triggered by Signal is selected for Mode to turn on Display Blanking Mode.
The value specified should be in milliseconds and will be used as a delay following a change in signal state for changing the state of Display Blanking. This is useful to avoid spurious or repetitive changes in Display Blanking state as a result of bounce or chatter on the signal used to trigger automatic Display Blanking. The value specified should be in the range of 250 milliseconds (one quarter of a second) to 32767 milliseconds (more than 32 seconds), which should be adequate to handle most situations.
1 second (1000) is used as the default if no value is entered.
Detail Information:
Key = blankingModeSignalDebounceDelay
Type = integer
Support Information:
- Supported on Device(s): VC8X.
Polarity
Select the Polarity of the Signal that will be used to trigger automatic Display Blanking when the value Blank When Triggered by Signal is selected for Mode to turn on Display Blanking Mode.
- If the value Blank screen when signal goes inactive (OFF) is selected, the automatic Display Blanking will occur when the specified signal is detected as going inactive (OFF). This choice would be used in specialized configurations where the signal to be used to trigger automatic Display Blanking has reverse polarity.
- If the value Blank screen when signal goes active (ON) is selected, , the automatic Display Blanking will occur when the specified signal is detected as going active (ON). This is the most common choice for the common configuration of connecting RTS and CTS via a switch.
Detail Information:
Key = blankingModeSignalPolarity
Type = string
| UI Choice | JSON Value |
|---|---|
| No polarity | |
| Blank screen when signal goes inactive (OFF) | 2 |
| Blank screen when signal goes active (ON) | 1 |
Support Information:
- Supported on Device(s): VC8X.
Power Configuration
Use this Sub-group to configure Stay Awake, Timeout, Mode, and Brightness.
Detail Information:
Key = displayPowerConfig
Type = bundle
Stay Awake
Select whether the Display Power State will be forced to remain On whenever the device is connected to external power.
- If the value Turn Off is selected, the Display Power State will NOT be forced to remain On whenever the device is connected to external power and hence the Display Power State MAY be Automatically turned Off, after a period of inactivity specified via Timeout.
- If the value Turn On is selected, the Display Power State WILL be forced to remain On whenever the device is connected to external power and hence the Display Power State will NOT be Automatically turned Off, even after a period of inactivity specified via Timeout.
When a device is used in a specialized environment, such as in a vehicle-mounted cradle or in a desktop docking station, the device may be continuously receiving power, rather than running off its own internal battery. In such situations, it may desirable to keep the device awake all the time since little would be gained from allowing the Display Power State to be Automatically turned Off.
Detail Information:
Key = displayPowerStayAwake
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Turn On | 15 |
| Turn Off | 0 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 7.2.
Timeout
Enter the Duration of inactivity (in seconds), after which the Display Power State will Automatically be turned Off.
A given device may not support all available Duration values. In the event that a selected Durationvalue is not supported on a given device, the smallest larger value that is supported will be used or, if no larger value is supported, the largest smaller value that is supported will be used.
Detail Information:
Key = displayPowerTimeout
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| 15 seconds | 15 |
| 30 seconds | 30 |
| 1 minute | 60 |
| 2 minutes | 120 |
| 5 minutes | 300 |
| 10 minutes | 600 |
| 30 minutes | 1800 |
| Never | 65535 |
Support Information:
- Supported from: MX 4.3.
Mode
Select how the Power State of the Display Backlight will be controlled.
If the value Manual is selected, the Power State of the Display Backlight will be controlled Manually by the User or by specifying Brightness.
If the value Automatic is selected, the Power State of the Display Backlight will be controlled automatically, based on the Ambient Light Sensor.
Detail Information:
Key = displayPowerBrightnessMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Manual | 2 |
| Automatic | 1 |
Support Information:
- Supported from: MX 10.2.
Brightness
Enter the Backlight Brightness when the value Manual is selected for Mode or enter -1 to leave the setting unchanged.
- #### Note - Setting the brightness level to 10 percent or less results in a setting of zero percent.
Detail Information:
Key = displayPowerBrightness
Type = integer
Support Information:
- Supported from: MX 10.2.
Secondary Display Configuration
Use this Sub-group to configure Resizable Windows, Secondary Display Mode, Secondary Display Remote Control, and ExternalScreenResolution.
Detail Information:
Key = secondaryDisplayConfig
Type = bundle
Resizable Windows
Select whether the device display and secondary display will support resizable windows.
If Turn On is selected, the device display and secondary display will allow resizing of windows.
If Turn Off is selected, the device display and secondary display will NOT allow resizing of windows.
Detail Information:
Key = uisDCResizableWindows
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Turn On | 1 |
| Turn Off | 2 |
Support Information:
- Supported from: MX 10.5.
Secondary Display Mode
Select the mode to use for the secondary display.
If Present Independent Desktop is selected, the secondary display will present a desktop that is independent from the device screen.
If Mirror Device Screen is selected, the secondary display will present a duplicate (mirror) of the device screen.
Detail Information:
Key = uisDCDisplayMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Present Independent Desktop | 1 |
| Mirror Device Screen | 2 |
Support Information:
- Supported from: MX 10.5.
Secondary Display Remote Control
Select the display on which remote operations will be performed.
If Primary (Mobile) is selected, remote control operations will be performed on the primary (mobile) display
If Secondary (Desktop) is selected, remote control operations will be performed on the secondary (desktop) display
Detail Information:
Key = uisDCRemoteControl
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Primary (Mobile) | 0 |
| Secondary (Desktop) | 1 |
Support Information:
- Supported from: MX 11.1.
ExternalScreenResolution
Select whether the device display and secondary display will support resizable windows.
If 1024x600 is selected, the device display and secondary display will allow resizing of windows.
If 1024x768 is selected, the device display and secondary display will NOT allow resizing of windows.
Detail Information:
Key = uisDCExternalScreenResolution
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| 800x600 | 0 |
| 1024x600 | 1 |
| 1024x768 | 2 |
| 1280x720 | 3 |
| 1280x800 | 4 |
| 1280x1024 | 5 |
| 1366x768 | 6 |
| 1440x900 | 7 |
| 1600x900 | 8 |
| 1680x1050 | 9 |
| 1920x1080 | 10 |
| 1920x1200 | 11 |
| 2560x1440 | 12 |
Support Information:
- Supported from: MX 13.3.
Size and Rotation Configuration
Use this Sub-group to configure Allowed Orientations, Locked Orientation Positions, Rotation Mode, Auto-Landscape External Display, Display Size, Font Size, and Lock Override Button.
Detail Information:
Key = sizeAndRotationConfig
Type = bundle
Allowed Orientations
Select which orientations are permitted when auto rotation is active.
If All (0 90 180 270 degrees) is selected, all orientations are allowed.
If All except portrait inverted (180 degrees) is selected, all orientations except inverted portrait are allowed.
Detail Information:
Key = displayAllowedOrientations
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Change | |
| All (0 90 180 270 degrees) | 1 |
| All except portrait inverted (180 degrees) | 2 |
Support Information:
- Supported from: MX 10.5.
Locked Orientation Positions
Select an orientation in which to lock the display when autorotation is turned off.
If Portrait (No rotation) is selected, portrait (no rotation) is locked.
If Landscape left (90 degrees) is selected, landscape left (90 degrees) is locked.
if Portrait inverted (180 degrees) is selected, portrait inverted (180 degrees) is locked.
if Landscape right (270 degrees) is selected, landscape right (270 degrees) is locked.
Detail Information:
Key = displayLockedOrientation
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Portrait (No rotation) | 0 |
| Landscape left (90 degrees) | 1 |
| Portrait inverted (180 degrees) | 2 |
| Landscape right (270 degrees) | 3 |
Support Information:
- Supported from: MX 10.5.
Rotation Mode
Select how Display Rotation will be performed.
If the value Manual is selected, Display Rotation will be performed Manually, by the User.
If the value Automatic is selected, Display Rotation will be performed Automatically, based on the Accelerometer.
Detail Information:
Key = displayConfigRotationMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Manual | Manual |
| Automatic | Auto |
Support Information:
- Supported from: MX 10.1.
Auto-Landscape External Display
Select whether the display will auto-rotate when the device is placed in a workstation cradle and display mirroring is used.
Detail Information:
Key = displayConfigAutoLandscape
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| On | 1 |
| Off | 2 |
Support Information:
Supported on Operating System(s): Pie.
NOT supported on Device(s): TC20 and TC25.
Display Size
Select the system display size
Detail Information:
Key = displayConfigDisplaySize
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Small | SMALL |
| Default | DEFAULT |
| Large | LARGE |
| Larger | LARGER |
| Largest | LARGEST |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 9.2.
Font Size
Select the system font size
Detail Information:
Key = displayConfigFontSize
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Small | 0.85 |
| Default | 1.0 |
| Large | 1.15 |
| Largest | 1.3 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 9.2.
Lock Override Button
Select whether the User is allowed to override the locked screen orientation.
If Enable is selected, the User is allowed to override the locked screen orientation.
if Disable is selected, the User is not allowed to override the locked screen orientation.
Detail Information:
Key = displayLockOverrideButton
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Enable | 1 |
| Disable | 2 |
Support Information:
- Supported from: MX 10.5.
Event-Triggered Intents
Use this Sub-array to configure one or more Event-Triggered Intent(s).
Detail Information:
Key = eventTriggeredIntents
Type = bundle_array
Event-Triggered Intent
Use this Sub-group to configure Type, Key Identifier, Intent Action, Intent Package Name, Intent Class Name, Intent Category, Intent Data URI, Intent File, Intent MIME Type, Intent Extras, Keep Device Awake, Method, Sensor Identifier, and Sensor Parameter.
Detail Information:
Key = eventTriggeredIntent
Type = bundle
Support Information:
- Supported from: MX 10.5.
Type
Select the Mode of the Alert on a device.
If the value Long press on selected key is selected, then an Intent will be scheduled to be sent each time the Key specified as the Alert Button via Key Identifier is long pressed. You must also specify some or all of the following to define the Intent to be sent (refer to the application receiving the intent for the values to use):
Intent Action
Intent Package Name
Intent Class Name
Intent Category
Intent Data URI
Intent File
Intent MIME Type
Intent Extras
If the value Sensor triggered is selected, then an Intent will be scheduled to be sent each time the sensor specified via Sensor Identifier is triggered. You must also specify some or all of the following to define the Intent to be sent (refer to the application receiving the intent for the values to use):
Intent Action
Intent Package Name
Intent Class Name
Intent Category
Intent Data URI
Intent File
Intent MIME Type
Intent Extras
Detail Information:
Key = uiAlertType
Type = string
| UI Choice | JSON Value |
|---|---|
| None | |
| Long press on selected key | 2 |
| Sensor triggered | 4 |
Support Information:
- Supported from: MX 10.2.
Key Identifier
Select the Key Identifier of the Key that will be used as the Alert Button.
Detail Information:
Key = uiAlertModeKeyIdentifier
Type = string
| UI Choice | JSON Value |
|---|---|
| None | |
| 0 | 0 |
| 1 | 1 |
| 2 | 2 |
| 3 | 3 |
| 4 | 4 |
| 5 | 5 |
| 6 | 6 |
| 7 | 7 |
| 8 | 8 |
| 9 | 9 |
| A | A |
| B | B |
| C | C |
| D | D |
| E | E |
| F | F |
| G | G |
| H | H |
| I | I |
| J | J |
| K | K |
| L | L |
| M | M |
| N | N |
| O | O |
| P | P |
| Q | Q |
| R | R |
| S | S |
| T | T |
| U | U |
| V | V |
| W | W |
| X | X |
| Y | Y |
| Z | Z |
| .(Period) | DOT |
| , (Comma) | COMMA |
| (Star) | STAR |
| #(Pound) | POUND |
| F1 | F1 |
| F2 | F2 |
| F3 | F3 |
| F4 | F4 |
| F5 | F5 |
| F6 | F6 |
| F7 | F7 |
| F8 | F8 |
| F9 | F9 |
| F10 | F10 |
| F11 | F11 |
| F12 | F12 |
| Enter | ENTER |
| Up | UP |
| Down | DOWN |
| Left | LEFT |
| Right | RIGHT |
| Escape | ESC |
| Backspace | BACKSPACE |
| Space | SPACE |
| Return | RETURN |
| Clear | CLR |
| Field Exit | FIELD_EXIT |
| Alt | ALT |
| Control | CTRL |
| Shift | SHIFT |
| Blue | BLUE |
| Orange | ORANGE |
| Diamond | DIAMOND |
| Green Dot | GREEN |
| Red Dot | RED |
| Volume Up | VOLUMEUP |
| Volume Down | VOLUMEDOWN |
| Scan | SCAN |
| Grip Trigger | GRIP_TRIGGER |
| Grip Trigger 2 | GRIP_TRIGGER_2 |
| Button L1 | LEFT_TRIGGER_1 |
| Button L2 | LEFT_TRIGGER_2 |
| Button R1 | RIGHT_TRIGGER_1 |
| Button R2 | RIGHT_TRIGGER_2 |
| Left Trigger | LEFT_TRIGGER |
| Right Trigger | RIGHT_TRIGGER |
| Center Trigger | CENTER_TRIGGER |
| Gun Trigger | GUN_TRIGGER |
| Headset Button | HEADSET_HOOK |
| Back | BACK |
| Home | HOME |
| Menu | MENU |
| Recent | RECENT |
| Search | SEARCH |
| Keyboard Backlight | KEYLIGHT |
| Display Backlight | LAMP |
| Power | POWER |
| P1 Button | P1 |
| P2 Button | P2 |
| P3 Button | P3 |
| P4 Button | P4 |
| P5 Button | P5 |
| P6 Button | P6 |
| Rear Button | REAR_BUTTON |
| Left External Trigger | LEFT_EXTERNAL_TRIGGER |
| Right External Trigger | RIGHT_EXTERNAL_TRIGGER |
| Touch NAV_PAD | NAV_PAD |
| Macro 1 | M1 |
| Macro 2 | M2 |
| Macro 3 | M3 |
| Macro 4 | M4 |
| Macro 5 | M5 |
| Macro 6 | M6 |
| Brightness Up | BRIGHTNESSUP |
| Brightness Down | BRIGHTNESSDOWN |
| Keyboard | KEYBOARD |
| Keyboard Backlight Brightness Up | KEYLIGHTUP |
| Keyboard Backlight Brightness Down | KEYLIGHTDOWN |
Support Information:
- Supported from: MX 10.2.
Intent Action
Enter the Android Intent Action to be sent in the Intent that will be sent when the specified Alert Button is long pressed or the sensor is triggered.
Detail Information:
Key = uiAlertModeIntentAction
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Intent Package Name
Enter the Android Package Name that identifies the Android Application to which an Intent will be sent when the specified Alert Button is long pressed.
Detail Information:
Key = uiAlertModeIntentPackageName
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Intent Class Name
Enter the Android Class to which an Intent will be sent when the specified Alert Button is long pressed.
Detail Information:
Key = uiAlertModeIntentClassName
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Intent Category
Enter an Android Intent Category for the Intent that will be sent when the specified Alert Button is long pressed or the sensor is triggered.
A category value is NOT mandatory to specify for an Android Intent. But a category value is commonly used to help identify the purpose of an Android Intent. This can be especially when the application or service to be invoked supports many functions, in which case many action values may be used to identify those functions and it may be useful to categorize those functions. In some cases, the same action value might be supported in more than one category. You will need to consult the documentation or developer of a given application or service to determine whether a category value is needed and, if so, which value will invoke the desired behavior.
Detail Information:
Key = uiAlertModeIntentCategory
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Intent Data URI
Enter a Uniform Resource Identifier (URI) that for the Intent that will be sent when the specified Alert Button is long pressed.
The URI specified could reference a local device resource (e.g. a file in the Device File System) or a remote resource (e.g. available via a network).
Detail Information:
Key = uiAlertModeIntentDataUri
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Intent File
Enter a Path and File Name for a File stored in the Device File System for the Intent that will be sent when the specified Alert Button is long pressed.
Detail Information:
Key = uiAlertModeIntentFile
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Intent MIME Type
Enter a Multipurpose Internet Mail Extensions (MIME) Type for the Intent that will be sent when the specified Alert Button is long pressed.
Detail Information:
Key = uiAlertModeIntentMimeType
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Intent Extras
Use this Sub-group to configure Name#1, Type#1, Value#1, Name#2, Type#2, Value#2, Name#3, Type#3, Value#3, Name#4, Type#4, Value#4, Name#5, Type#5, and Value#5 .
Detail Information:
Key = uiAlertModeIntentExtras
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Name#1
Enter the name of a single extra to be attached to the intent to be sent.
Android allows a collection of extra named values, of various types, to be attached to an intent. When a name is specified, you must also specify Type#1 and Value#1 to provide the corresponding type and value of the extra to be attached to the intent.
Detail Information:
Key = alertButtonExtra1Name
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Type#1
Select the type of a single extra to be attached to the intent to be sent.
Android allows a collection of extra named values, of various types, to be attached to an intent. When a type is specified, you must also specify Name#1 and Value#1 to provide the corresponding name and value of the extra to be attached to the intent.
Detail Information:
Key = alertButtonExtra1Type
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Standard Integer | int |
| Character | char |
| Character Sequence | charsequence |
| Floating Point | float |
| Long Integer | long |
| Boolean | boolean |
| Short | short |
| Double Precision Floating Point | double |
| String | string |
| Single Byte Integer | byte |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Value#1
Enter the value of a single extra to be attached to the intent to be sent.
Android allows a collection of extra named values, of various types, to be attached to an intent. When a value is specified, you must also specify Type#1 and Name#1 to provide the corresponding type and name of the extra to be attached to the intent.
Detail Information:
Key = alertButtonExtra1Value
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Name#2
Enter the name of a single extra to be attached to the intent to be sent.
Android allows a collection of extra named values, of various types, to be attached to an intent. When a name is specified, you must also specify Type#2 and Value#2 to provide the corresponding type and value of the extra to be attached to the intent.
Detail Information:
Key = alertButtonExtra2Name
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Type#2
Select the type of a single extra to be attached to the intent to be sent.
Android allows a collection of extra named values, of various types, to be attached to an intent. When a type is specified, you must also specify Name#2 and Value#2 to provide the corresponding name and value of the extra to be attached to the intent.
Detail Information:
Key = alertButtonExtra2Type
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Standard Integer | int |
| Character | char |
| Character Sequence | charsequence |
| Floating Point | float |
| Long Integer | long |
| Boolean | boolean |
| Short | short |
| Double Precision Floating Point | double |
| String | string |
| Single Byte Integer | byte |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Value#2
Enter the value of a single extra to be attached to the intent to be sent.
Android allows a collection of extra named values, of various types, to be attached to an intent. When a value is specified, you must also specify Type#2 and Name#2 to provide the corresponding type and name of the extra to be attached to the intent.
Detail Information:
Key = alertButtonExtra2Value
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Name#3
Enter the name of a single extra to be attached to the intent to be sent.
Android allows a collection of extra named values, of various types, to be attached to an intent. When a name is specified, you must also specify Type#3 and Value#3 to provide the corresponding type and value of the extra to be attached to the intent.
Detail Information:
Key = alertButtonExtra3Name
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Type#3
Select the type of a single extra to be attached to the intent to be sent.
Android allows a collection of extra named values, of various types, to be attached to an intent. When a type is specified, you must also specify Name#3 and Value#3 to provide the corresponding name and value of the extra to be attached to the intent.
Detail Information:
Key = alertButtonExtra3Type
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Standard Integer | int |
| Character | char |
| Character Sequence | charsequence |
| Floating Point | float |
| Long Integer | long |
| Boolean | boolean |
| Short | short |
| Double Precision Floating Point | double |
| String | string |
| Single Byte Integer | byte |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Value#3
Enter the value of a single extra to be attached to the intent to be sent.
Android allows a collection of extra named values, of various types, to be attached to an intent. When a value is specified, you must also specify Type#3 and Name#3 to provide the corresponding type and name of the extra to be attached to the intent.
Detail Information:
Key = alertButtonExtra3Value
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Name#4
Enter the name of a single extra to be attached to the intent to be sent.
Android allows a collection of extra named values, of various types, to be attached to an intent. When a name is specified, you must also specify Type#4 and Value#4 to provide the corresponding type and value of the extra to be attached to the intent.
Detail Information:
Key = alertButtonExtra4Name
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Type#4
Select the type of a single extra to be attached to the intent to be sent.
Android allows a collection of extra named values, of various types, to be attached to an intent. When a type is specified, you must also specify Name#4 and Value#4 to provide the corresponding name and value of the extra to be attached to the intent.
Detail Information:
Key = alertButtonExtra4Type
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Standard Integer | int |
| Character | char |
| Character Sequence | charsequence |
| Floating Point | float |
| Long Integer | long |
| Boolean | boolean |
| Short | short |
| Double Precision Floating Point | double |
| String | string |
| Single Byte Integer | byte |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Value#4
Enter the value of a single extra to be attached to the intent to be sent.
Android allows a collection of extra named values, of various types, to be attached to an intent. When a value is specified, you must also specify Type#4 and Name#4 to provide the corresponding type and name of the extra to be attached to the intent.
Detail Information:
Key = alertButtonExtra4Value
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Name#5
Enter the name of a single extra to be attached to the intent to be sent.
Android allows a collection of extra named values, of various types, to be attached to an intent. When a name is specified, you must also specify Type#4 and Value#4 to provide the corresponding type and value of the extra to be attached to the intent.
Detail Information:
Key = alertButtonExtra5Name
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Type#5
Select the type of a single extra to be attached to the intent to be sent.
Android allows a collection of extra named values, of various types, to be attached to an intent. When a type is specified, you must also specify Name#5 and Value#5 to provide the corresponding name and value of the extra to be attached to the intent.
Detail Information:
Key = alertButtonExtra5Type
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Standard Integer | int |
| Character | char |
| Character Sequence | charsequence |
| Floating Point | float |
| Long Integer | long |
| Boolean | boolean |
| Short | short |
| Double Precision Floating Point | double |
| String | string |
| Single Byte Integer | byte |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Value#5
Enter the value of a single extra to be attached to the intent to be sent.
Android allows a collection of extra named values, of various types, to be attached to an intent. When a value is specified, you must also specify Type#5 and Name#5 to provide the corresponding type and name of the extra to be attached to the intent.
Detail Information:
Key = alertButtonExtra5Value
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Keep Device Awake
Select whether the device should stay awake when the Alert Button is configured.
Detail Information:
Key = uiAlertModeKeepAwake
Type = boolean
Support Information:
- Supported from: MX 10.2.
Method
Select the Method by which the Intent will be sent when the Alert Button is pressed, when the value of Long press on selected key is selected for Type.
Detail Information:
Key = uiAlertModeMethod
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| StartActivity | StartActivity |
| StartService | StartService |
| Broadcast | Broadcast |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Sensor Identifier
Select the sensor in the device that will be used to trigger or cancel the intent, when the value Sensor triggered is selected for Type.
Detail Information:
Key = uiAlertModeSensorIdentifier
Type = string
| UI Choice | JSON Value |
|---|---|
| None | |
| Free Fall Detection | 1 |
Support Information:
- Supported from: MX 10.5.
Sensor Parameter
Enter name of the extra to send in the intent that is sent for sensor status when the value !!4@uiConfig.keyboardConfig.alertConfig.uiAlertMode!! is selected for Type and !!StartActivity@uiConfig.eventTriggeredIntents.eventTriggeredIntent.uiAlertModeMethod!!, or !!StartService@uiConfig.eventTriggeredIntents.eventTriggeredIntent.uiAlertModeMethod!!, or !!Broadcast@uiConfig.eventTriggeredIntents.eventTriggeredIntent.uiAlertModeMethod!! is selected for Method.
Detail Information:
Key = uiAlertModeSensorParameter
Type = string
Support Information:
- Supported from: MX 10.2.
General UI Configuration
Use this Sub-group to configure Feature Usage, Localization, Split Screen Workflows, and UI Element.
Detail Information:
Key = uiGeneralConfig
Type = bundle
Feature Usage Configuration
Use this Sub-group to configure Large-screen Taskbar, Active App List UI, Auto Correct, Clipboard, Sharing, Inter-App Sharing, Long Press on Home to Launch Google Assistant, Magnification Gestures, Notification Bar, Proximity Sensor, RemoteCastNotification, Screen Shot, SD Card, Access Clock from Date in Notification, and Battery Charging LED.
Detail Information:
Key = uiFeaturesConfig
Type = bundle
Large-screen Taskbar
Select whether to allow user access to the Large-screen Taskbar, which appears at the bottom of the screen on supported devices, and displays recent and pinned apps, plus a link to the app library
- If the value Disable is selected, Prevents the device user from controlling whether the Large-screen Taskbar is displayed.
- If the value Enable is selected, Allows the device user to control whether the Large-screen Taskbar is displayed on supported devices.
Detail Information:
Key = uiFeatureLargeScreenTaskbarUsage
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disable | 2 |
| Enable | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.2.
Active App List UI
Select whether to display the Active App List UI in the Notification panel.
- If the value Disable is selected, Prevents the device user from controlling whether the list of apps running on the device is shown.
- If the value Enable is selected, Allows the device user to control whether the list of apps running on the device is shown.
Detail Information:
Key = uiFeatureActiveAppList
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disable | 2 |
| Enable | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.2.
Auto Correct
Select whether the User will be presented with Automatic Correction suggestions to potential mistakes made during data entry.
If the value Off is selected, the User will NOT be presented with Automatic Correction suggestions to potential mistakes made during data entry.
If the value On is selected, the User MAY be presented with Automatic Correction suggestions to potential mistakes made during data entry.
Detail Information:
Key = uiFeatureAutoCorrect
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.3.
Clipboard
Select whether the User will be Allowed to utilize the Clipboard cut, copy, and paste text between applications.
- If the value Allow is selected, the User will NOT be Allowed to utilize the Clipboard cut, copy, and paste text between applications.
- If the value Disallow is selected, the User WILL be Allowed to utilize the Clipboard cut, copy, and paste text between applications.
Detail Information:
Key = uiFeatureClipboard
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.2.
Sharing
Select whether the User will be allowed to utilize the clipboard Sharing on a device to share the contents of the clipboard.
Detail Information:
Key = uiFeatureClipboardSharing
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.5.
Support discontinued from: MX 11.0.
Inter-App Sharing
Select whether the User will be Allowed to utilize the sharing functionality between applications.
Detail Information:
Key = uiFeatureInterAppSharing
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.1.
Long Press on Home to Launch Google Assistant
Select whether a the User will be Allowed to use a long press on the Home Key to Launch the Google Assistant.
If the value Disallow is selected, the User will NOT be Allowed to use a long press on the Home Key to Launch the Google Assistant.
If the value Allow is selected, the User WILL be Allowed to use a long press on the Home Key to Launch the Google Assistant.
Detail Information:
Key = uiFeatureLongPressHomeToLaunchGoogleAssistant
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.2.
Magnification Gestures
Select whether the User will be Allowed to Use Magnification Gestures.
If the value Disallow is selected, the User will NOT be Allowed to Use Magnification Gestures.
If the value Allow is selected, the User WILL be Allowed to Use Magnification Gestures.
Detail Information:
Key = uiFeatureMagnificationGestures
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
- Supported from: MX 8.0.
Notification Bar
Select whether the User will be Allowed to Pull Down the Notification Bar to interact with notifications in the Notifications Panel.
If the value Disallow is selected, the User will NOT be Allowed to Pull Down the Notification Bar to interact with notifications in the Notifications Panel.
If the value Allow is selected, the User WILL be Allowed to Pull Down the Notification Bar to interact with notifications in the Notifications Panel.
Detail Information:
Key = uiFeatureNotificationBar
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 5.1.
Proximity Sensor
Select whether the proximity sensor will be used.
If the value Disallow is selected, the proximity sensor is prevented from reacting to a human face.
If the value Allow is selected, the device Proximity Sensor is allowed to detect and react to a human face.
Detail Information:
Key = uiFeatureProximitySensor
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.5.
RemoteCastNotification
Select whether to show a notification in the Status Bar when the device is being remotely viewed or controlled
If the value Show is selected, Shows a notification in the Status Bar when the device is being remotely controlled or viewed.
If the value Hide is selected, Hides the notification when the device is being remotely controlled or viewed.
Detail Information:
Key = uiFeatureRemoteCastNotification
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Hide | 2 |
| Show | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.3.
Screen Shot
Select whether to allow or disallow the taking of a screen shot.
If the value Disallow is selected, screen shots will NOT be allowed.
If the value Allow is selected, screen shots will be allowed.
Detail Information:
Key = uiFeatureScreenShot
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.5.
SD Card
Select whether to allow or disallow the use of the SD card
If the value Disallow is selected, use of the SD card will NOT be allowed.
If the value Allow is selected, use of the SD card will be allowed.
Detail Information:
Key = uiFeatureSDCard
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.3.
Access Clock from Date in Notification
Select whether the User will be Allowed to Access the Clock Application from the Date displayed in a Notification in the Notification Panel.
If the value Allow is selected, the User will NOT be Allowed to Access the Clock Application from the Date displayed in a Notification in the Notification Panel.
If the value Disallow is selected, the User WILL be Allowed to Access the Clock Application from the Date displayed in a Notification in the Notification Panel.
Detail Information:
Key = uiFeatureDateInNotificationAccessClock
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Allow | 1 |
| Disallow | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.2.
Battery Charging LED
Select whether the battery charging sub-system of the device will be allowed to use the battery charging LED to indicate the state of charging the device battery.
If the value Disable is selected, the battery charging sub-system of the device will NOT be allowed to use the battery charging LED to indicate the state of charging the device battery. This could be used to help eliminate distractions, such as when the device is charging in a cradle in a darkened vehicle or when many devices are charging in close proximity resulting in many flashing LEDs.
If the value Enable is selected, the battery charging sub-system of the device will NOT be allowed to use the battery charging LED to indicate the state of charging the device battery. This could be beneficial by allowing at-a-glance determination of the charging status of a device.
Detail Information:
Key = uiFeatureBatteryChargingLED
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disable | 2 |
| Enable | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
Localization Configuration
Use this Sub-group to configure Locale and Custom Locale.
Detail Information:
Key = uiLocalizationConfig
Type = bundle
Locale
Select the Locale to be used.
A Locale identifies where a device is being used and adjusts UI elements to suit that location. A Locale is specified by selecting a mandatory Language (e.g. English) and may optionally specify a Region (e.g. the United States) where that Language is spoken.
When only a Language is specified, the value selected will be the name of the Language (e.g. CHINA).
When both a Language and a Region are specified, the value selected will be the name of the Region followed by the name of the Language, separated by an underscore (e.g. CANADA_FRENCH).
When Custom is selected, the value specified in Custom Locale is required.
Detail Information:
Key = uiLocalizationLocale
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Custom | CUSTOM |
| Arabic (Standard) | ar |
| Chinese (Simplified) | zh_CN |
| Chinese (Traditional) | zh_TW |
| Chinese spoken in China | zh_CN |
| Chinese (Standard) | zh |
| Danish spoken in Denmark | da_DK |
| Dutch (Standard) | nl |
| English spoken in Australia | en_AU |
| English spoken in Canada | en_CA |
| English spoken in India | en_IN |
| English spoken in the United Kingdom | en_GB |
| English spoken in the United States | en_US |
| English (Standard) | en |
| Finnish spoken in Finland | fi_FI |
| French spoken in Canada | fr_CA |
| French spoken in France | fr_FR |
| French (Standard) | fr |
| German spoken in Germany | de_DE |
| German (Standard) | de |
| Italian spoken in Italy | it_IT |
| Italian (Standard) | it |
| Japanese spoken in Japan | ja_JP |
| Japanese (Standard) | ja |
| Korean spoken in Korea | ko_KR |
| Korean (Standard) | ko |
| Norwegian spoken in Norway | nb_NO |
| Polish (Standard) | pl |
| Portuguese spoken in Brazil | pt_BR |
| Portuguese spoken in Portugal | pt_PT |
| Russian (Standard) | ru |
| Spanish spoken in Spain | es_ES |
| Spanish spoken in the United States | es_US |
| Swedish spoken in Sweden | sv_SE |
| Turkish (Standard) | tr |
| Ukrainian (Standard) | uk |
Support Information:
- Supported from: MX 5.1.
Custom Locale
Enter the Locale to be used.
Detail Information:
Key = uiLocalizationCustomLocale
Type = string
Support Information:
- Supported from: MX 5.1.
Split Screen Workflows
Use this Sub-array to configure one or more Split Screen Workflow(s).
Detail Information:
Key = uiGCSSWorkflows
Type = bundle_array
Support Information:
- Supported from: MX 11.9.
Split Screen Workflow
Use this Sub-group to configure Application 1 Allocation, Application 1 Package Name, and Application 2 Package Name.
Detail Information:
Key = uiGCSSWorkflow
Type = bundle
Support Information:
- Supported from: MX 11.9.
Application 1 Allocation
Enter percentage of device screen (from 20-80) for app Package Name 1; Package Name 2 (if specified) gets the remainder. Accept the default value (50) to divide the screen evenly.
Detail Information:
Key = uiGCSSWFApp1Allocation
Type = string
Support Information:
- Supported from: MX 11.9.
Application 1 Package Name
Enter the package name of the first application of the workflow
Detail Information:
Key = uiGCSSWFApp1PackageName
Type = string
Support Information:
- Supported from: MX 11.9.
Application 2 Package Name
Enter the package name of the second application of the workflow
Detail Information:
Key = uiGCSSWFApp2PackageName
Type = string
Support Information:
- Supported from: MX 11.9.
UI Element Configuration
Use this Sub-group to configure Battery Percentage, Battery Swap Popup, Immersive Mode, Navigation Bar, Status Bar, On-Screen Power Button, Airplane Mode in Power Key Menu, Do Not Disturb, Touch Mode in Power Key Menu, App Info Icon on Long Press on Recent App Header, App Management Notifications, Control Dark Theme, Passwords, Power Off in Power Key Menu, Talkback Shortcut, Assistant App, Custom Assistant App, Home Screen Wallpaper, Custom Home Screen Wallpaper, Control Airplane Mode, and Timer.
Detail Information:
Key = uiElementConfig
Type = bundle
Battery Percentage
Select whether the remaining battery level percentage of the device will be displayed on the Android Status Bar to augment the icon indicating the battery level in bars.
If the value Hide is selected, the remaining battery level percentage of the device will NOT be displayed.
If the value Show is selected, the remaining battery level percentage of the device WILL be displayed.
Detail Information:
Key = uiElementBatteryPercentage
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Hide | 2 |
| Show | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.1.
Battery Swap Popup
Select whether the User will be presented with a Battery Swap Popup UI to indicate the recommendation to swap the battery when the remaining battery level percentage of the device drops below a pre-defined, fixed threshold percentage.
If the value Disable is selected, the User will NOT be presented with a Battery Swap Popup UI.
If the value Enable is selected, the User MAY be presented with a Battery Swap Popup UI.
Detail Information:
Key = uiElementBatterySwapPopup
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disable | 2 |
| Enable | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
Immersive Mode
Select whether to display a pop-up warning the first time an app attempts to enter Immersive Mode, which allows the app to fill the screen and hides Status and Navigation bars.
Detail Information:
Key = uiElementImmersiveMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Hide | 2 |
| Show | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.1.
Navigation Bar
Select whether the Android Navigation Bar will be displayed and hence whether it will take up screen real estate and can be used by the User to navigate the device UI.
If the value Hide is selected, the Android Navigation Bar will NOT be displayed.
If the value Show is selected, the Android Navigation Bar WILL be displayed.
Detail Information:
Key = uiElementNavigationBar
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Hide | 2 |
| Show | 1 |
Support Information:
- Supported from: MX 7.1.
Status Bar
Select whether the Android Status Bar will be displayed.
If the value Hide is selected, the Android Status Bar will NOT be displayed.
If the value Show is selected, the Android Status Bar WILL be displayed.
Detail Information:
Key = uiElementStatusBar
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Hide | 2 |
| Show | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.4.
On-Screen Power Button
Select whether an on-screen power button will be displayed to allow the User to power the device fff.
If the value Disable is selected, an on-screen power button will NOT be displayed.
If the value Enable is selected, an on-screen power button WILL be displayed.
The on-screen power button behaves similarly to the physical power button and can be used to improve the user experience in cases where a physical power button is not present or is not convenient to use, such as when the User is wearing gloves.
Detail Information:
Key = uiElementOnScreenPowerButton
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disable | 2 |
| Enable | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.3.
Airplane Mode in Power Key Menu
Select whether the User will see an option to Control the State of Airplane Mode in the Menu presented when the power key is long pressed.
If the value Show is selected, the User WILL see an option to Control the State of Airplane Mode in the Menu presented when the power key is long pressed.
If the value Hide is selected, the User will NOT see an option to Control the State of Airplane Mode in the Menu presented when the power key is long pressed.
Detail Information:
Key = uiElementAirplaneModeInPwrKeyMenu
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Hide | 2 |
| Show | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.3.
Do Not Disturb
Select whether the device is in Do Not Disturb mode.
If the value Turn On is selected, Do Not Disturb mode is turned on and notifications will be surpressed.
If the value Turn Off is selected, Do Not Disturb mode is turned off and notifications will be presented.
Detail Information:
Key = uiElementDoNotDisturb
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Turn Off | 2 |
| Turn On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.1.
Touch Mode in Power Key Menu
Select whether the User will see an option to Control the Touch Mode in the Menu presented when the power key is long pressed.
If the value Show is selected, the User WILL see an option to Control the Touch Mode in the Menu presented when the power key is long pressed.
If the value Hide is selected, the User WILL NOT see an option to Control the Touch Mode in the Menu presented when the power key is long pressed.
Detail Information:
Key = uiElementTouchModeInPwrKeyMenu
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Hide | 2 |
| Show | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
App Info Icon on Long Press on Recent App Header
Select whether the User will be Allowed to navigate to App Info Settings for an application by long pressing on the application icon in the Recent Apps list, and then clicking the (i) icon.
If the value Allow is selected, the User WILL be Allowed to navigate to App Info in this manner.
If the value Disallow is selected, User will NOT be Allowed to navigate to App Info in this manner.
Detail Information:
Key = uiElementAppInfoOnLongPressRecentAppHeader
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Allow | 1 |
| Disallow | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.2.
App Management Notifications
Select whether the User will see notifications when the Device Owner installs, uninstalls or upgrades applications. Applies to Android 11 and later.
If the value Show is selected, notifications WILL be shown to the User when the Device Owner installs, uninstalls, or upgrades applications.
If the value Hide is selected, notifications will NOT be shown to the User when the Device Owner installs, uninstalls, or upgrades applications.
Detail Information:
Key = uiElementSilentAppInstall
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Show | 1 |
| Hide | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.5.
Control Dark Theme
Select whether dark theme is used on the device.
If the value Off is selected, dark theme is not used.
If the value On is selected, dark theme is used.
Detail Information:
Key = uiElementDarkTheme
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
- Supported from: MX 11.3.
Passwords
Select whether the User will be Allowed to see Passwords as they are entered.
If the value Off is selected, the User will NOT be Allowed to see Passwords as they are entered (Password characters will be masked as they are entered).
If the value On is selected, the User WILL be Allowed to see Passwords as they are entered (Password characters will be echoed as they are entered).
Note that this can increase usability, by reducing the chance of data entry errors, but should be used with caution since it can also reduce security by allowing Passwords to be disclosed (e.g. Shoulder surfing).
Detail Information:
Key = uiElementPasswords
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 9.1.
Power Off in Power Key Menu
Select whether the User will see an option to Power Off the Device in the Menu presented when the power key is long pressed.
If the value Show is selected, the User WILL see an option to Power Off the Device in the Menu presented when the power key is long pressed.
If the value Hide is selected, the User will NOT see an option to Power Off the Device in the Menu presented when the power key is long pressed.
Detail Information:
Key = uiElementPowerOffInPwrKeyMenu
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Hide | 2 |
| Show | 1 |
Support Information:
- Supported from: MX 10.1.
Talkback Shortcut
Select whether the Talkback shortcut will be activated or not. Applies to Android 11 and later.
If the value Turn On is selected, the Talkback shortcut will be turned on and available for use by performing a long press of both volume buttons.
If the value Turn Off is selected, the Talkback shortcut will be turned off and not available for use.
Detail Information:
Key = uiElementTalkbackShortcut
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Turn On | 1 |
| Turn Off | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: Mx 11.7.
Assistant App
Select the assistant to use on the device.
If the value Google Digital Assistant is selected, the Google Digital Assistant will be used
If the value Custom assistant app is selected, the custom assistant app specified in %?uiConfig.uiGeneralConfig.uiElementConfig.uiElementCustomAssistantApp% will be used.
If the value None is selected, no assistant app will be used.
Detail Information:
Key = uiElementAssistantApp
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Change | |
| Google Digital Assistant | 1 |
| Custom assistant app | 2 |
| None | 3 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.5.
Custom Assistant App
Enter the package name of the assistant application to be used on the device.
Detail Information:
Key = uiElementCustomAssistantApp
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.5.
Home Screen Wallpaper
Select the assistant to use on the device.
If the value Restore to default is selected, the default wallpaper will be used.
If the value Custom is selected, the custom wallpaper specified in %?uiConfig.uiGeneralConfig.uiElementConfig.uiElementCustomHomeWallpaper% will be used.
Detail Information:
Key = uiElementHomeScreenWallpaper
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Restore to default | 1 |
| Custom | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.5.
Custom Home Screen Wallpaper
Enter the path and file name of an image file on the device (.jpg or .png)
Detail Information:
Key = uiElementCustomHomeWallpaper
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.5.
Control Airplane Mode
Select whether airplane mode should be forced off after a predetermined amount of time.
If the value Do not change is selected, then no change will be made to the functioning of airplane mode.
If the value Disable Airplane Mode automatic shut-off is selected, airplane mode will be left on until specifically turned off.
If the value Enable Airplane Mode automatic shut-off is selected, airplane mode will be forced OFF after the amount of time
Detail Information:
Key = uiElementControlAirplaneMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disable Airplane Mode automatic shut-off | 2 |
| Enable Airplane Mode automatic shut-off | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.5.
Timer
Enter the amount of time (in minutes) after which airplane mode will be turned off.
Detail Information:
Key = uiElementControlAirplaneModeTimer
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.5.
Keyboard Configuration
Use this Sub-group to configure Auto Trigger, Input Method, Large Key Indicator, Use of Home, Use of Recent Apps, User Control of Large Key Indicator, Virtual KB when Physical KB is Active, Double Trigger, External Keyboard Configurations, External Keyboard Shortcut Keys, and External Keyboard Num Lock Handling.
Detail Information:
Key = keyboardConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Auto Trigger Configuration
Use this Sub-group to configure State and Range.
Detail Information:
Key = autoTriggerConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
State
Select whether and how Automatic Triggering will occur.
If the value Off is selected, Automatic Triggering will never occur and the User will be required to manually initiate trigger-activated functions.
If the value Auto On is selected, Automatic Triggering may occur if the device is placed into a suitable holster, holder, or stand allowing the User to initiate trigger-activated functions simply by bringing an object within proximity to the device sensor.
If the value Always On is selected, automatic triggering can always occur automatically , whether the device is placed into a suitable holster, holder, or stand allowing the User to initiate trigger-activated functions simply by bringing an object within proximity to the device sensor.
Detail Information:
Key = uiAutoTriggerState
Type = string
| UI Choice | JSON Value |
|---|---|
| Off | 0 |
| Auto On | 1 |
| Always On | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
Range
Select the range at which automatic triggering will detect the presence of an object and initiate automatic triggering.
If the value Near is selected, automatic triggering will occur only when an object is brought within near proximity to the device sensor. This may be desirable if the device is being worn in a holster and hence it is convenient to bring objects very close to the device sensor.
If the value Far is selected, automatic triggering will occur when an object is brought within less near proximity to the device sensor. This may be desirable if the device is located in a stand or holder and hence it is less convenient to have to bring objects very close to the device sensor.
Detail Information:
Key = uiAutoTriggerRange
Type = string
| UI Choice | JSON Value |
|---|---|
| Near | 0 |
| Far | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
Input Method
Select the input method.
If the value English(US) is selected, the input method will be configured for US English.
If the value Japanese is selected, the input method will be configured for Japanese.
If the value Chinese(China) is selected, the input method will be configured for China Chinese.
To select a custom input method, use the class variance of the Package Configuration category of managed configurations.
Detail Information:
Key = keyboardInputMethod
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| English(US) | English |
| Japanese | Japanese |
| Chinese(China) | Chinese |
Support Information:
- Supported from: MX 4.3.
Large Key Indicator
Select whether the Large Key Indicator will be displayed to indicate the state physical keypad.
If the value Hide is selected, the Large Key Indicator will NOT be displayed.
If the value Show is selected, the Large Key Indicator WILL be displayed.
Note that this can assist the User in cases where multiple key sequences are required.
Detail Information:
Key = keyboardLargeKeyIndicator
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Hide | 2 |
| Show | 1 |
Support Information:
- Supported from: MX 9.0.
Use of Home
Select whether the User will be Allowed to utilize the Home Key on a device to leave the current context and return to the Home/Launcher screen.
If the value Disallow is selected, the User will NOT be Allowed to utilize the Home Key.
If the value Allow is selected, the User WILL be Allowed to utilize the Home Key.
Detail Information:
Key = keyboardUseOfHome
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.3.
Use of Recent Apps
Select whether the User will be Allowed to Use the Recent Apps Key to access recently launched applications.
If the value Disallow is selected, the User will NOT be Allowed to Use the Recent Apps Key to access recently launched applications.
If the value Allow is selected, the User WILL be Allowed to Use the Recent Apps Key to access recently launched applications.
Detail Information:
Key = keyboardUseOfRecentApps
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
- Supported from: MX 7.1.
User Control of Large Key Indicator
Select whether the User will be Allowed to control whether the Large Key Indicator will be displayed.
If the value Enable is selected, the User will NOT be Allowed to control whether the Large Key Indicator will be displayed.
If the value Disable is selected, the User WILL be Allowed to control whether the Large Key Indicator will be displayed.
Detail Information:
Key = keyboardUserControlOfLargeKeyIndicator
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Enable | 1 |
| Disable | 2 |
Support Information:
- Supported from: MX 9.0.
Virtual KB when Physical KB is Active
Select whether the on-screen Virtual Keyboard will be shown when the Physical Keyboard is Active.
If the value Hide is selected, the on-screen Virtual Keyboard will NOT be shown when the Physical Keyboard is Active.
If the value Show is selected, the on-screen Virtual Keyboard WILL be shown when the Physical Keyboard is Active.
Note that this can help avoid the annoyance and confusion of using up screen real-estate to display an on-screen keyboard when the User is using a Physical Keyboard to enter data.
Detail Information:
Key = keyboardShowVirtualKbWhenPhysicalKbActive
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Hide | 2 |
| Show | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.0.
Double Trigger
Use this Sub-group to configure Maximum Time Between Trigger Pulls, Mode, Alt State, Ctrl State, Fn State, Key Code, and Shift State.
Detail Information:
Key = doubleTrigger
Type = bundle
Support Information:
- Supported from: MX 11.4.
Maximum Time Between Trigger Pulls
Enter the maximum time allowed for a double trigger pull to be considered in milliseconds.
Detail Information:
Key = dtMaxTime
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.4.
Mode
Select whether a double trigger will send a key code.
If Send a key-code is selected, a double trigger pull within the window specified by Maximum Time Between Trigger Pulls will cause the key code specified in Key Code to be sent.
If Don't send a key-code is selected, a double trigger pull will not send a key code.
Detail Information:
Key = dtMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Send a key-code | 1 |
| Don't send a key-code | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.4.
Alt State
Select whether the Key Code specified via Key Code will be sent with the Alt keyboard state.
If the value Off is selected, when the Key Code is sent, it will NOT be sent with the Alt keyboard state NOT set. This will ensure that the Key Code will NOT interpreted as an Alt key.
If the value On is selected, when the Key Code is sent, it WILL be sent with the Alt keyboard state set. This will ensure that the Key Code WILL be interpreted as an Alt key.
If no value is specified, when the Key Code is sent, it will be sent with the CURRENT Alt key state. This will cause the Key Code to be interpreted as an Alt key or not based on the current Alt key state.
Detail Information:
Key = dtAltState
Type = string
| UI Choice | JSON Value |
|---|---|
| On | 1 |
| Off | 0 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.4.
Ctrl State
Select whether the Key Code specified via Key Code will be sent with the Ctrl keyboard state when it is sent as the Behavior for a specified Key.
If the value Off is selected, when the Key Code is sent, it will NOT be sent with the Ctrl keyboard state NOT set. This will ensure that the Key Code will NOT interpreted as an Ctrl key.
If the value On is selected, when the Key Code is sent, it WILL be sent with the Ctrl keyboard state set. This will ensure that the Key Code WILL be interpreted as an Ctrl key.
If no value is specified, when the Key Code is sent, it will be sent with the CURRENT Ctrl key state. This will cause the Key Code to be interpreted as an Ctrl key or not based on the current Ctrl key state.
Detail Information:
Key = dtCtrlState
Type = string
| UI Choice | JSON Value |
|---|---|
| On | 1 |
| Off | 0 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.4.
Fn State
Select whether the Key Code specified via Key Code will be sent with the Fn keyboard state when it is sent as the Behavior for a specified Key.
If the value Off is selected, when the Key Code is sent, it will NOT be sent with the Fn keyboard state NOT set. This will ensure that the Key Code will NOT interpreted as an Fn key.
If the value On is selected, when the Key Code is sent, it WILL be sent with the Fn keyboard state set. This will ensure that the Key Code WILL be interpreted as an Fn key.
If no value is specified, when the Key Code is sent, it will be sent with the CURRENT Fn key state. This will cause the Key Code to be interpreted as an Fn key or not based on the current Fn key state.
Detail Information:
Key = dtFnState
Type = string
| UI Choice | JSON Value |
|---|---|
| On | 1 |
| Off | 0 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.4.
Key Code
Select the key code to send when Send a key-code is set to Mode and a double trigger is performed.
Detail Information:
Key = dtKeyCode
Type = string
| UI Choice | JSON Value |
|---|---|
| 0 | 7 |
| 1 | 8 |
| 2 | 9 |
| 3 | 10 |
| 4 | 11 |
| 5 | 12 |
| 6 | 13 |
| 7 | 14 |
| 8 | 15 |
| 9 | 16 |
| + (Plus) | 81 |
| - (Minus) | 69 |
| = (Equals) | 70 |
| ( (Left Bracket) | 71 |
| ) (Right Bracket) | 72 |
| ` (Grave) | 68 |
| / (Slash) | 76 |
| \\\\ (Backslash) | 73 |
| ; (Semicolon) | 74 |
| ' (Apostrophe) | 75 |
| , (Comma) | 55 |
| . (Period) | 56 |
| (Star) | 17 |
| # (Pound) | 18 |
| @ (At) | 77 |
| A | 29 |
| B | 30 |
| C | 31 |
| D | 32 |
| E | 33 |
| F | 34 |
| G | 35 |
| H | 36 |
| I | 37 |
| J | 38 |
| K | 39 |
| L | 40 |
| M | 41 |
| N | 42 |
| O | 43 |
| P | 44 |
| Q | 45 |
| R | 46 |
| S | 47 |
| T | 48 |
| U | 49 |
| V | 50 |
| W | 51 |
| X | 52 |
| Y | 53 |
| Z | 54 |
| Enter | 66 |
| Tab | 61 |
| Space | 62 |
| Escape | 111 |
| Delete | 67 |
| F1 | 131 |
| F2 | 132 |
| F3 | 133 |
| F4 | 134 |
| F5 | 135 |
| F6 | 136 |
| F7 | 137 |
| F8 | 138 |
| F9 | 139 |
| F10 | 140 |
| F11 | 141 |
| F12 | 142 |
| NUMPAD 0 | 144 |
| NUMPAD 1 | 145 |
| NUMPAD 2 | 146 |
| NUMPAD 3 | 147 |
| NUMPAD 4 | 148 |
| NUMPAD 5 | 149 |
| NUMPAD 6 | 150 |
| NUMPAD 7 | 151 |
| NUMPAD 8 | 152 |
| NUMPAD 9 | 153 |
| NUMPAD / (NUMPAD Divide) | 154 |
| NUMPAD * (NUMPAD Multiply) | 155 |
| NUMPAD - (NUMPAD Subtract) | 156 |
| NUMPAD + (NUMPAD Add) | 157 |
| NUMPAD . (NUMPAD Period) | 158 |
| NUMPAD , (NUMPAD Comma) | 159 |
| NUMPAD Enter | 160 |
| NUMPAD = (NUMPAD Equals) | 161 |
| NUMPAD { (NUMPAD Left Parenthesis) | 162 |
| NUMPAD } (NUMPAD Right Parenthesis) | 163 |
| DPAD Up | 19 |
| DPAD Down | 20 |
| DPAD Left | 21 |
| DPAD Right | 22 |
| DPAD Center | 23 |
| Move Home | 122 |
| Move End | 123 |
| Page Up | 92 |
| Page Down | 93 |
| Insert | 124 |
| Forward Delete | 112 |
| Clear | 28 |
| Lamp | 10024 |
| Do Nothing | 10026 |
| Blue | 10027 |
| Orange | 10028 |
| Grey | 10029 |
| Diamond | 10039 |
| Alt | 10030 |
| Control | 10031 |
| Shift | 10032 |
| Keyboard | 10034 |
| Touch Calibrate | 10035 |
| Scan | 10036 |
| Search Key | 10037 |
| None | 10038 |
| KeyLight | 10025 |
| Keylight Up | 10040 |
| Keylight Down | 10041 |
| Left Shift | 59 |
| Right Shift | 60 |
| Left Alt | 57 |
| Right Alt | 58 |
| Left Control | 113 |
| Right Control | 114 |
| Meta Left | 117 |
| Meta Right | 118 |
| Caps Lock | 115 |
| Num Lock | 143 |
| Scroll Lock | 116 |
| SysRq | 120 |
| Break | 121 |
| Function | 119 |
| Back | 4 |
| Forward | 125 |
| Home | 3 |
| Menu | 82 |
| Settings | 176 |
| Application Switch | 187 |
| Calculator | 210 |
| Explorer | 64 |
| Envelope | 65 |
| Bookmark | 174 |
| Music | 209 |
| Call | 5 |
| End Call | 6 |
| Microphone Mute | 91 |
| Camera | 27 |
| Search | 84 |
| Contacts | 207 |
| Calendar | 208 |
| Volume Up | 24 |
| Volume Down | 25 |
| Volume Mute | 164 |
| Brightness Up | 221 |
| Brightness Down | 220 |
| Power | 26 |
| Sleep | 223 |
| Wakeup | 224 |
| Headset | 79 |
| Push-to-talk | 228 |
| Camera Focus | 80 |
| Media Play/Pause | 85 |
| Media Stop | 86 |
| Media Next | 87 |
| Media Previous | 88 |
| Media Rewind | 89 |
| Media Fast-Forward | 90 |
| Media Play | 126 |
| Media Pause | 127 |
| Media Close | 128 |
| Media Eject | 129 |
| Media Record | 130 |
| Button L1 | 102 |
| Button R1 | 103 |
| Button L2 | 104 |
| Button R2 | 105 |
| Button A | 96 |
| Button B | 97 |
| Button C | 98 |
| Button X | 99 |
| Button Y | 100 |
| Button Z | 101 |
| Left Thumb Button | 106 |
| Right Thumb Button | 107 |
| Start Button | 108 |
| Select Button | 109 |
| Mode Button | 110 |
| Gamepad Button 1 | 188 |
| Gamepad Button 2 | 189 |
| Gamepad Button 3 | 190 |
| Gamepad Button 4 | 191 |
| Gamepad Button 5 | 192 |
| Gamepad Button 6 | 193 |
| Gamepad Button 7 | 194 |
| Gamepad Button 8 | 195 |
| Gamepad Button 9 | 196 |
| Gamepad Button 10 | 197 |
| Gamepad Button 11 | 198 |
| Gamepad Button 12 | 199 |
| Gamepad Button 13 | 200 |
| Gamepad Button 14 | 201 |
| Gamepad Button 15 | 202 |
| Gamepad Button 16 | 203 |
| Zenkaku/Hankaku | 211 |
| Eisu | 212 |
| Muhenkan | 213 |
| Henkan | 214 |
| Katakana/Hiragana | 215 |
| Ro | 217 |
| Yen | 216 |
| Kana | 218 |
| Keyboard | 10034 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.4.
Shift State
Select whether the Key Code specified via Key Code will be sent with the Shift keyboard state when it is sent as the Behavior for a specified Key.
If the value Off is selected, when the Key Code is sent, it will NOT be sent with the Shift keyboard state NOT set. This will ensure that the Key Code will NOT interpreted as an Shift key.
If the value On is selected, when the Key Code is sent, it WILL be sent with the Shift keyboard state set. This will ensure that the Key Code WILL be interpreted as an Shift key.
If no value is specified, when the Key Code is sent, it will be sent with the CURRENT Shift key state. This will cause the Key Code to be interpreted as an Shift key or not based on the current Shift key state.
Detail Information:
Key = dtShiftState
Type = string
| UI Choice | JSON Value |
|---|---|
| On | 1 |
| Off | 0 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.4.
External Keyboard Configurations
Use this Sub-array to configure one or more External Keyboard Configuration(s).
Detail Information:
Key = uiExternalKeyboardConfigs
Type = bundle_array
External Keyboard Configuration
Use this Sub-group to configure Keyboard Name and Layout Name.
Detail Information:
Key = uiExternalKeyboardConfig
Type = bundle
Support Information:
- Supported from: MX 10.5.
Keyboard Name
Select the keyboard name to associate the layout being defined.
Detail Information:
Key = uiEKCName
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.5.
Layout Name
Select the keyboard layout name being defined.
Detail Information:
Key = uiEKCLayoutName
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.5.
External Keyboard Shortcut Keys
Use this Sub-array to configure one or more External Keyboard Shortcut Key(s).
Detail Information:
Key = uiExternalKeyboardShortcuts
Type = bundle_array
External Keyboard Shortcut Key
Use this Sub-group to configure Key ID and Action.
Detail Information:
Key = uiEKbSCK
Type = bundle
Key ID
Select the ID of the shortcut key to which an action is to be defined.
Detail Information:
Key = scKID
Type = string
| UI Choice | JSON Value |
|---|---|
| Win+D | 1 |
| Win+E | 2 |
| Win+L | 3 |
| Win+M | 4 |
| Win+Tab | 5 |
| Win+Up | 6 |
| Win+Down | 7 |
| Esc | 8 |
| Alt+F4 | 9 |
| Alt+Tab | 10 |
| PrintScreen | 11 |
| Ctrl+Alt+Del | 12 |
Support Information:
- Supported from: MX 11.6.
Action
Select the action to perform when the associated shortcut key is pressed. If Do nothing (ignore key) is pressed, then no action is performed when the key associated with the key ID is pressed. If Perform standard handling (default) is pressed, then the standard action associated with the key ID is performed. If Send to focused app is pressed, then the key code associated with the key ID is sent to the application currently in-focus.
Detail Information:
Key = scKaction
Type = string
| UI Choice | JSON Value |
|---|---|
| Do nothing (ignore key) | 1 |
| Perform standard handling (default) | 2 |
| Send to focused app | 3 |
Support Information:
- Supported from: MX 11.6.
External Keyboard Num Lock Handling
Select how the Num Lock key on the external keyboard should behave. if Use keyboard's NUM LOCK state is selected, the current state of the Num Lock key will be used. If Force NUM LOCK state always is selected, Num Lock will be forced into the ON state.
Detail Information:
Key = uiExternalKeyboardNumLockHandling
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Change | |
| Use keyboard's NUM LOCK state | 1 |
| Force NUM LOCK state always | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.6.
Settings UI Configuration
Use this Sub-group to configure Quick Settings, User Access, User Control, and Settings Variant.
Detail Information:
Key = uiSettingsConfig
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.3.
Quick Settings
Use this Sub-array to configure one or more Quick Setting(s).
Detail Information:
Key = uiQuickSettings
Type = bundle_array
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.2.
Quick Setting
Use this Sub-group to configure Quick Tile Identifier and Quick Tile Custom Identifier.
Detail Information:
Key = uiQSQuickSetting
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.2.
Quick Tile Identifier
Select the action to show/hide a specific Quick Settings tile on the device.
If the value Airplane mode is selected, the Airplane mode Quick Settings Tile will be shown or hidden
If the value Auto-rotate is selected, the Auto-rotate Quick Settings Tile will be shown or hidden
If the value Battery Saver is selected, the Battery Saver Quick Settings Tile will be shown or hidden
If the value Bedtime mode is selected, the Bedtime mode Quick Settings Tile will be shown or hidden
If the value Bluetooth is selected, the Bluetooth Quick Settings Tile will be shown or hidden
If the value Dark theme is selected, the Dark theme Quick Settings Tile will be shown or hidden
If the value Data Saver is selected, the Data Saver Quick Settings Tile will be shown or hidden
If the value Do Not Disturb is selected, the Do Not Disturb Quick Settings Tile will be shown or hidden
If the value Flashlight is selected, the Flashlight Quick Settings Tile will be shown or hidden
If the value Focus mode is selected, the Focus mode Quick Settings Tile will be shown or hidden
If the value Hotspot is selected, the Hotspot Quick Settings Tile will be shown or hidden
If the value Invert colors is selected, the Invert colors Quick Settings Tile will be shown or hidden
If the value Location is selected, the Location Quick Settings Tile will be shown or hidden
If the value Mobile data is selected, the Mobile data Quick Settings Tile will be shown or hidden
If the value NFC is selected, the NFC Quick Settings Tile will be shown or hidden
If the value Nearby Share is selected, the Nearby Share Quick Settings Tile will be shown or hidden
If the value Night Light is selected, the Night Light Quick Settings Tile will be shown or hidden
If the value Screen Cast is selected, the Screen Cast Quick Settings Tile will be shown or hidden
If the value Screen Record is selected, the Screen Record Quick Settings Tile will be shown or hidden
If the value Wi-Fi is selected, the Wi-Fi Quick Settings Tile will be shown or hidden(NOTE: The Wi-Fi settings tile is NOT supported on devices running A13 or later)
If the value Custom is selected, a name of the custom Quick Settings Tile must be entered to be shown or hidden
Detail Information:
Key = uiQSTileIdentifier
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Airplane mode | Airplane mode |
| Auto-rotate | Auto-rotate |
| Battery Saver | Battery Saver |
| Bedtime mode | Bedtime mode |
| Bluetooth | Bluetooth |
| Dark theme | Dark theme |
| Data Saver | Data Saver |
| Do Not Disturb | Do Not Disturb |
| Flashlight | Flashlight |
| Focus mode | Focus mode |
| Hotspot | Hotspot |
| Invert colors | Invert colors |
| Location | Location |
| Mobile data | Mobile data |
| NFC | NFC |
| Nearby Share | Nearby Share |
| Night Light | Night Light |
| Screen Cast | Screen Cast |
| Screen Record | Screen Record |
| Wi-Fi | Wi-Fi |
| Custom | Custom |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Quick Tile Custom Identifier
Enter the name of the custom Quick Setting tile to show/hide on the device
Detail Information:
Key = uiQSTileCustomIdentifier
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.2.
User Access Configuration
Use this Sub-group to configure Split Screen Mode, Multi User, Mute/Vibrate Usage, App Info Section, Control Apps, Control Default Apps, Control Vibrate for Calls, Device Storage via USB, Quick Settings, Settings Via Notification Icon, Tethering and Hotspot Section, User Control of Notification Settings, and WLAN Section.
Detail Information:
Key = uiUserAccessConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Split Screen Mode
Select whether the User will be Allowed to Access Split Screen Mode.
- If the value Disallow is selected, the User will NOT be Allowed to Access Split Screen Mode.
- If the value Allow is selected, the User WILL be Allowed to Access Split Screen Mode.
Detail Information:
Key = uiUserAccessSplitScreenMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
Multi User
Select whether the Primary User will be Allowed to Access the Multi User Section of the Settings UI, which provides the ability to Create, Delete, and limit the actions of Secondary Users.
- If the value Disallow is selected, the Primary User will NOT be Allowed to Access the Multi User Section of the Settings UI.
- If the value Allow is selected, the Primary User WILL be Allowed to Access the Multi User Section of the Settings UI.
Detail Information:
Key = uiUserAccessMultiUser
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
Mute/Vibrate Usage
Select whether the device user can change the state of mute and vibrate.
If the value Allow is selected, the device user will be allowed to change the state of the mute and/or vibrate state.
If the value Disallow is selected, the device user will not be allowed to change the state of the mute and/or vibrate state.
Detail Information:
Key = audioMuteVibrateUsage
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.6.
App Info Section
Select whether the User will be allowed to Access the App Info section of the Settings UI.
- If the value Disallow is selected, the User will NOT be allowed to Access the App Info section of the Settings UI.
- If the value Allow is selected, the User WILL be allowed to Access the App Info section of the Settings UI.
Detail Information:
Key = uiUserAccessAppInfoSection
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Control Apps
Select whether the device user will be allowed to enter the AppInfo section of the Settings UI where applications can be controlled.
- If the value Off is selected, any attempt by the device user to enter the AppInfo section of the Settings UI will be ignored.
- If the value On is selected, attempts by the device user to enter the AppInfo section of the Settings will be honored.
Detail Information:
Key = uiUserControlApps
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.2.
Control Default Apps
Select whether the device user will be allowed to change the Default App used for standard functionality
- If the value Disable for Dialer is selected, the device user will not be allowed to change the default dialer.
- If the value Enable for Dialer is selected, the device user will be allowed to change the default dialer.
- If the value Disable for Browser is selected, the device user will not be allowed to change the default browser.
- If the value Enable for Browser is selected, the device user will be allowed to change the default browser.
Detail Information:
Key = uiUserControlDefaultApps
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Enable for Dialer | 1 |
| Disable for Dialer | 2 |
| Enable for Browser | 3 |
| Disable for Browser | 4 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.4.
Control Vibrate for Calls
Select whether the device user will be allowed to change the state of the vibrate for calls setting.
- If the value Disable is selected, the device user will not be allowed to change the state of vibrate for calls.
- If the value Enable is selected, the device user will be allowed to change the state of vibrate for calls.
Detail Information:
Key = uiUserControlVibrateForCallsUsage
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Enable | 1 |
| Disable | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.3.
Device Storage via USB
Select whether the User will be allowed to Access Device Storage via USB.
- If the value Disable is selected, the User will NOT be allowed to Access Device Storage via USB.
- If the value Enable is selected, the User WILL be allowed to Access Device Storage via USB.
Detail Information:
Key = uiUserAccessDeviceStorageViaUsb
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disable | 2 |
| Enable | 1 |
Quick Settings
Select whether the User will be permitted to Access the Quick Settings UI.
If the value Disallow is selected, any attempt by the User to enter the Quick Settings Panel will be ignored.
If the value Allow is selected, attempts by the User to enter the Quick Settings Panel will be honored and the Quick Settings Panel UI will be presented on request.
Detail Information:
Key = uiUserAccessToQuickSettings
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 5.2.
Settings Via Notification Icon
Select whether the User will be Allowed to Access the Settings UI via the Settings (Gear) Icon on the Notification Panel.
- If the value Disallow is selected, the User will NOT be Allowed to Access the Settings UI via the Settings (Gear) Icon on the Notification Panel.
- If the value Allow is selected, the User WILL be Allowed to Access the Settings UI via the Settings (Gear) Icon on the Notification Panel.
Detail Information:
Key = uiUserAccessSettingsViaNotificationIcon
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 5.1.
Tethering and Hotspot Section
Select whether the User will be Allowed to Access Tethering and Hotspot Section of the Settings UI.
- If the value Disallow is selected, the User will NOT be Allowed to Access Tethering and Hotspot Section of the Settings UI.
- If the value Allow is selected, the User WILL be Allowed to Access Tethering and Hotspot Section of the Settings UI.
Detail Information:
Key = uiUserAccessTetheringAndPortableHotspot
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
User Control of Notification Settings
Select whether the device user is allowed to control App Notifications.
If the value Disallow is selected, any attempt by the device user to change the configuration of application notifications will be blocked.
If the value Allow is selected, attempts by the device user to change the configuration of application notifications will be honored.
Detail Information:
Key = uiUserAccessNotificationSettingsFromNotification
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 7.2.
WLAN Section
Select whether the User will be Allowed to Access the WLAN section of the Settings UI.
- If the value Disallow is selected, the User will NOT be Allowed to Access the WLAN section of the Settings UI.
- If the value Allow is selected, the User WILL be Allowed to Access the WLAN section of the Settings UI.
Detail Information:
Key = uiUserAccessWlanSection
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
User Control Configuration
Use this Sub-group to configure Do Not Disturb Mode, Airplane Mode, Bluetooth, Configure Default Client Mode, Control USB Host Mode, Control USB Host Mode Rules, Edit Quick Settings, Erase All Data, Install From Unknown Sources, Instant Lock, USB ADB State, USB MTP Folder Access, and USB State.
Detail Information:
Key = uiUserControlConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Do Not Disturb Mode
Select whether the User will be Allowed to Control the State of Do Not Disturb Mode.
- If the value Show is selected, the User will NOT be Allowed to Control the State of Do Not Disturb Mode.
- If the value Hide is selected, the User WILL be Allowed to Control the State of Do Not Disturb Mode.
Detail Information:
Key = uiUserControlDoNotDisturb
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Hide | 2 |
| Show | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
Airplane Mode
Select whether the User will be Allowed to change the State of Airplane Mode.
- If the value Disallow is selected, the User will NOT be Allowed to change the State of Airplane Mode.
- If the value Allow is selected, the User WILL be Allowed to change the State of Airplane Mode.
Detail Information:
Key = uiUserControlOfAirplaneMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Bluetooth
Select whether the User will be Allowed to change the State of Bluetooth
- If the value Disallow is selected, the User will NOT be Allowed to change the State of Bluetooth.
- If the value Allow is selected, the User WILL be Allowed to change the State of Bluetooth.
Detail Information:
Key = uiUserControlOfBluetooth
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.2.
Configure Default Client Mode
Select the default configuration of an attached USB client.
- If the value Charging Only (no data transfer) is selected, "Charging Only" will be the default mode for client USB devices.
- If the value File Transfer is selected, "File Transfer" will be the default mode for client USB devices.
- If the value MIDI is selected, "MIDI" will be the default mode for client USB devices.
- If the value PTP is selected, "PTP" will be the default mode for client USB devices.
- If the value USB Tethering is selected, "USB Tethering" will be the default mode for client USB devices.
Detail Information:
Key = settingsUsbClientModeDefault
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Charging Only (no data transfer) | 0L |
| File Transfer | 4L |
| MIDI | 8L |
| PTP | 16L |
| USB Tethering | 32L |
Support Information:
- Supported from: MX 10.4.
Control USB Host Mode
Select whether to control USB connections and pop-up messages when device is in USB Host Mode
- If the value Uncontrolled (default) is selected, USB Host Mode will behave normally.
- If the value Controlled (rules list) is selected, The rules specified in Control USB Host Mode Rules will be used.
Detail Information:
Key = settingsUsbHostModeControl
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Uncontrolled (default) | 1 |
| Controlled (rules list) | 2 |
Support Information:
- Supported from: MX 11.6.
Control USB Host Mode Rules
Enter an XML-based set of rules that define the USB peripheral(s) the mobile device is allowed to use and/or pre-grant app(s) access to the peripheral(s) without pop-up messages. For more information, see techdocs.zebra.com/mx/usbmgr.
Detail Information:
Key = settingsUsbHostModeRules
Type = string
Support Information:
- Supported from: MX 11.6.
Edit Quick Settings
Select whether the User will be Allowed to edit the quick settings panel.
- If the value Disallow is selected, the User will NOT be Allowed to edit the Quick Settings Panel.
- If the value Allow is selected, the User WILL be Allowed to edit the Quick Settings Panel.
Detail Information:
Key = uiUserControlEditQuickSettings
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
- Supported from: MX 11.2.
Erase All Data
Select whether the User will be Allowed to Erase All Data (perform an Enterprise Reset) from the Settings UI.
- If the value Disallow is selected, the User will NOT be Allowed to Erase All Data (perform an Enterprise Reset) from the Settings UI.
- If the value Allow is selected, the User WILL be Allowed to Erase All Data (perform an Enterprise Reset) from the Settings UI.
Detail Information:
Key = uiUserControlEnterpriseReset
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Install From Unknown Sources
Select whether the User will be Allowed to install applications from unknown sources.
- If the value Disallow is selected, the User will NOT be Allowed to install applications from unknown sources.
- If the value Allow is selected, the User WILL be Allowed to install applications from unknown sources.
Detail Information:
Key = uiUserUnknownSources
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
- Supported from: MX 4.3.
Instant Lock
Select whether the User will be Allowed to control Instant Lock on Power Key.
- If the value Disallow is selected, the User will NOT be Allowed to control Instant Lock on Power Key.
- If the value Allow is selected, the User WILL be Allowed to control Instant Lock on Power Key.
Detail Information:
Key = uiUserControlInstantLock
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.3.
USB ADB State
Select whether the User will be Allowed to control the USB ADB State.
- If the value Disallow is selected, the User will NOT be Allowed to control the USB ADB State.
- If the value Allow is selected, the User WILL be Allowed to control the USB ADB State.
Detail Information:
Key = uiUserControlUsbADBState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
- Supported from: MX 4.2.
USB MTP Folder Access
Select whether to allow MTP write access on device.
- If the value Disallow write access is selected, Prevents MTP from writing in specific folders on the device.
- If the value Allow write access is selected, Allows MTP to write in specific folders on the device.
Detail Information:
Key = uiUserControlUsbMTPFolderAccess
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow write access | 2 |
| Allow write access | 1 |
Support Information:
- Supported from: MX 13.2.
USB State
Select whether the User will be Allowed to control the USB Power State.
- If the value Disallow is selected, the User will NOT be Allowed to control the USB Power State.
- If the value Allow is selected, the User WILL be Allowed to control the USB Power State.
Detail Information:
Key = uiUserControlUsbState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
- Supported from: MX 4.2.
Settings Variant
Select which variant of the Settings Ul (Reduced or Full) will be used.
If the value None is selected, then no Settings Ul will be used.
If the value Partial without Accessibility is selected, the Reduced (Partial) variant of the Settings Ul will be used without the Accessibility Menu
If the value Partial with Accessibility is selected, the Reduced (Partial) variant of the Settings Ul will be used including the Accessibility Menu
If the value Full is selected, the Full variant of the Settings Ul will be used.
Detail Information:
Key = uiSettingsVariant
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Full | 1 |
| Partial without Accessibility | 2 |
| Partial with Accessibility | 4 |
| None | 3 |
Support Information:
- Supported from: MX 4.1.
Touch Panel Configuration
Use this Sub-group to configure Touch and Hold Delay, Touch Mode, and Screen Protector.
Detail Information:
Key = uiTouchPanelConfig
Type = bundle
Touch and Hold Delay
Select the Touch and Hold delay. The Touch and Hold delay is the amount of time that the display is continuously touched to identify "long press"
If the value Short is selected, a duration of 400ms will be set.
If the value Medium is selected, a duration of 1000ms will be set.
If the value Long is selected, a duration of 1500ms will be set.
Detail Information:
Key = touchAndHoldDelay
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Short | 400 |
| Medium | 1000 |
| Long | 1500 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.8.
Touch Mode
Select the Touch Panel to be used.
If the value Stylus or Finger is selected, the Touch Panel will be configured to optimize use with a Stylus or an ungloved Finger.
If the value Glove or Finger is selected, the Touch Panel will be configured to optimize use with a Gloved finger or an ungloved Finger.
If the value Finger Only is selected, the Touch Panel will be configured to optimize an ungloved Finger.
If the value Stylus or Glove or Finger is selected, the Touch Panel will be configured to optimize use with a Stylus, a Gloved finger, or an ungloved Finger.
If the value Finger and Wet is selected, the Touch Panel will be configured to optimize use with a finger on a wet touch panel
Not all devices support the ability to configure the Touch Panel mode and those that do may not support every mode.
An attempt to configure the Touch Panel mode on a device that does not support it will result in an error.
An attempt to configure a Touch Panel mode on a device that does not support that mode will result in an error.
Detail Information:
Key = touchMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Stylus or Finger | Stylus and Finger |
| Glove or Finger | Glove and Finger |
| Finger Only | Finger |
| Stylus or Glove or Finger | Stylus and Glove and Finger |
| Finger and Wet | Finger and Wet |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 9.1.
Screen Protector
Select whether the Touch Panel configuration will be optimized for use with a Screen Protector.
If selected, the Touch Panel configuration will NOT be optimized for use with a Screen Protector.
If unselected, the Touch Panel configuration WILL be optimized for use with a Screen Protector.
Not all devices support the ability to configure the Touch Panel to account for the use or a Screen Protector.
Detail Information:
Key = touchScreenProtector
Type = boolean
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 9.1.
Volume UI Profiles
Use this Sub-array to configure one or more Volume UI Profile(s).
Detail Information:
Key = zvcprofiles
Type = bundle_array
Support Information:
- Supported from: MX 4.4.
Volume UI Profile
Use this Sub-group to configure Profile Name, Make Current, Adjust Volume, and Stream.
Detail Information:
Key = zvcprofile
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Profile Name
Enter the Profile Name for an Audio UI Profile in the Zebra Volume Control UI.
Detail Information:
Key = uiVolumeProfileName
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Make Current
Select whether a Profile should be made the current active Profile in the Zebra Volume Control UI.
Detail Information:
Key = uiVolumeMakeCurrent
Type = string
| UI Choice | JSON Value |
|---|---|
| Make Current | 1 |
| Do NOT Make Current | 2 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Adjust Volume
Select whether the current device Volume Settings will be adjusted to ensure that they fall within the range of Volume Settings defined by an Audio UI Profile being made the new current Audio UI Profile to be made the current active Audio UI Profile.
Detail Information:
Key = uiVolumeAdjustVolume
Type = string
| UI Choice | JSON Value |
|---|---|
| Off | Off |
| On | On |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Stream Configuration
Use this Sub-group to configure STREAM_MUSIC for HDMI Output, STREAM_MUSIC on Bluetooth Headset, STREAM_MUSIC on Speaker, STREAM_MUSIC on Wired Headset, STREAM_ALARM on Speaker/Wired and Bluetooth Headsets, STREAM_RING/STREAM_NOTIFICATION/STRING_SYSTEM on Speaker/Wired and Bluetooth Headsets, STREAM_VOICE_CALL on Bluetooth Headset, STREAM_VOICE_CALL on Receiver, STREAM_VOICE_CALL on Speaker, STREAM_VOICE_CALL on Wired Headset, Decode Beep on Speaker/Wired and Bluetooth Headsets, and Keyboard Feedback on Speaker/Wired and Bluetooth Headsets.
Detail Information:
Key = uiVolumeStream
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
STREAM_MUSIC for HDMI Output
Enter volume levels for music stream on HDMI. Use comma separated integers for min,max,preset from 0-15, e.g. 1,15,12
Detail Information:
Key = uiVolumeSMHDMI
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
STREAM_MUSIC on Bluetooth Headset
Enter volume levels for music stream on Bluetooth Headset. Use comma separated integers for min,max,preset from 0-15, e.g. 1,15,12
Detail Information:
Key = uiVolumeSMBTHeadset
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
STREAM_MUSIC on Speaker
Enter volume levels for music stream on Speaker. Use comma separated integers for min,max,preset from 0-15, e.g. 1,15,12
Detail Information:
Key = uiVolumeSMSpeaker
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
STREAM_MUSIC on Wired Headset
Enter volume levels for music stream on Wired Headset. Use comma separated integers for min,max,preset from 0-15, e.g. 1,15,12
Detail Information:
Key = uiVolumeSMWiredHeadset
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
STREAM_ALARM on Speaker/Wired and Bluetooth Headsets
Enter volume levels for alarm stream on Speaker, Wired Headst and Bluetooth Headset. Use comma separated integers for min,max,preset from 1-7, e.g. 1,7,5
Detail Information:
Key = uiVolumeSASpkrWHBH
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
STREAM_RING/STREAM_NOTIFICATION/STRING_SYSTEM on Speaker/Wired and Bluetooth Headsets
Enter volume levels for ring/notification.system on Speaker, Wired or Bluetooth Headsets. Use comma separated integers for min,max,preset from 0-7, e.g. 1,7,5
Detail Information:
Key = uiVolumeSRSNSSSpkrWHBH
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
STREAM_VOICE_CALL on Bluetooth Headset
Enter volume levels for voice call stream on Bluetooth Headsets. Use comma separated integers for min,max,preset from 1-5, e.g. 1,5,4
Detail Information:
Key = uiVolumeSVCBTH
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
STREAM_VOICE_CALL on Receiver
Enter volume levels for voice call stream on Receiver. Use comma separated integers for min,max,preset from 1-5, e.g. 1,5,4
Detail Information:
Key = uiVolumeSVCRcvr
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
STREAM_VOICE_CALL on Speaker
Enter volume levels for voice call stream on Speaker. Use comma separated integers for min,max,preset from 1-5, e.g. 1,5,4
Detail Information:
Key = uiVolumeSVCSpkr
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
STREAM_VOICE_CALL on Wired Headset
Enter volume levels for voice call stream on Wired Headsets. Use comma separated integers for min,max,preset from 1-5, e.g. 1,5,4
Detail Information:
Key = uiVolumeSVCWH
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Decode Beep on Speaker/Wired and Bluetooth Headsets
Enter volume levels for decode beep virtual volume on Speaker, Wired and Bluetooth Headsets. Use comma separated integers for min,max,preset from 0-10, e.g. 1,10,8
Detail Information:
Key = uiVolumeDecodeBeepSpkrWHBTH
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Keyboard Feedback on Speaker/Wired and Bluetooth Headsets
Enter volume levels for keyboard feedback sound on Speaker, Wired and Bluetooth Headsets. Use comma separated integers for min,max,preset from 0-4, e.g. 1,4,2
Detail Information:
Key = uiVolumeKBFeedbackSpkrWHBTH
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Wireless and Network Configuration
Use this Group to configure Bluetooth, DHCP, Enterprise NFC, Ethernet, Host Name, Network Connection, RFID, Wireless General, Wireless LAN, and Wireless WAN.
Detail Information:
Key = wirelessAndNetworkConfig
Type = bundle
Bluetooth Configuration
Use this Sub-group to configure Discoverability, New Pairings, Pairing Rules, Pairing Popup, Silent Pairing, Silent Pairing Default Method, Single Pairing, State, Blocked BLE Channels, Blocked RF-Based BLE Channels, and Beacon.
Detail Information:
Key = bluetoothConfig
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 5.1.
Discoverability
Select whether the device is Discoverable via Bluetooth.
Devices are NOT Discoverable via Bluetooth by default except when the Bluetooth Pairing screen of the Settings UI is active.
If the value Off is selected, the default behavior will be in effect and the device will not be Discoverable via Bluetooth except when the Bluetooth Pairing screen of the Settings UI is active.
If the value On is selected, the default behavior will be overridden and the device will be Discoverable via Bluetooth whenever Bluetooth is enabled (turned on).
Detail Information:
Key = btDiscoverability
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 6.2.
New Pairings
Select whether the device will be Allowed to Accept new Bluetooth Pairings.
If the value Disallow is selected, the device will NOT be Allowed to Accept new Bluetooth Pairings.
If the value Allow is selected, the device WILL be Allowed to Accept new Bluetooth Pairings.
Note that Zebra devices are configured by default to Accept new Bluetooth Pairings.
Detail Information:
Key = btNewPairings
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
| Pair only trusted devices | 3 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 5.1.
Pairing Rules
Use this Sub-array to configure one or more Pairing Rule(s) that define non-default Behavior for Pairing Bluetooth Devices.
Detail Information:
Key = btpRule
Type = bundle_array
Support Information:
- Supported from: MX 9.3.
Pairing Rule
Use this Sub-group to configure Name, Device Upper Address Part, MAC Address, Trusted Device Rule, Device Class, Silent Pairing Rule, Single Pairing Rule, Single Pairing Category, and Pairing PIN Code.
Detail Information:
Key = bluetoothRule
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Name
Enter a name for a Bluetooth Rule.
Note that you can specify Name and/or MAC Address.
Detail Information:
Key = bluetoothRuleName
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Device Upper Address Part
Enter the Device Upper Address Part for a Bluetooth Rule.
When a Device Upper Address Part is specified for a rule, Bluetooth Silent Pairing will automatically complete new Bluetooth Pairings for Bluetooth devices that have the specified Device Upper Address Part in the upper part of their Bluetooth Address.
Detail Information:
Key = bluetoothRuleUpperAddressPart
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
MAC Address
Enter the Bluetooth MAC Address XX:XX:XX:XX:XX:XX for a Bluetooth Rule.
Note that you can specify Name and/or MAC Address.
Detail Information:
Key = bluetoothRuleMACAddress
Type = string
Support Information:
Supported on Operating System(s): Pie.
NOT supported on Device(s): TC20 and TC25.
Trusted Device Rule
Select whether this is a trusted device rule.
If the value No is selected, the defined rule will NOT be considered a trusted device rule for pairing devices that satisfy the rule's parameters.
If the value Yes is selected, the defined rule will be considered a trusted device rule for pairing devices that satisfy the rule's parameters.
Detail Information:
Key = bluetoothRuleTrustedDevice
Type = string
| UI Choice | JSON Value |
|---|---|
| No | 0 |
| Yes | 1 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Device Class
Enter the Device Class for a Bluetooth Rule.
When a Device Class is specified for a rule, Bluetooth Silent Pairing will automatically complete new Bluetooth Pairings for Bluetooth devices that have the specified Device Class.
Detail Information:
Key = bluetoothRuleDeviceClass
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Silent Pairing Rule
Select whether this is a silent pairing rule.
If the value No is selected, the defined rule will NOT allow pairing without operator interaction.
If the value Yes is selected, the defined rule will allow pairing without operator interaction.
Detail Information:
Key = bluetoothRuleSilentPairing
Type = string
| UI Choice | JSON Value |
|---|---|
| No | 0 |
| Yes | 1 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Single Pairing Rule
Select whether this is a single pairing rule.
If the value No is selected, the defined rule will allow any number of devices of the selected category to pair.
If the value Yesis selected, the defined rule will only allow one device of the selected category to pair.
Detail Information:
Key = bluetoothRuleSinglePairing
Type = string
| UI Choice | JSON Value |
|---|---|
| No | 0 |
| Yes | 1 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Single Pairing Category
Select the class of Bluetooth peripheral for which only a single pairing will be allowed.
Only one peripheral of the specified class will be permitted to pair.
If the value Headset is selected, only one Bluetooth headset will be permitted to pair at a time.
If the value Scanner is selected, only one Bluetooth scanner will be permitted to pair at a time.
If the value Printer is selected, only one Bluetooth printer will be permitted to pair at a time.
If the value Payment is selected, only one Bluetooth payment will be permitted to pair at a time.
If the value Dex is selected, only one Bluetooth Dex will be permitted to pair at a time.
Note that even when the device IS configured to permit only single Bluetooth Pairings, it WILL NOT do so unless Action is used to configure specific silent pairing rules that define how single pairing should occur.
Detail Information:
Key = bluetoothSinglePairingCategory
Type = string
| UI Choice | JSON Value |
|---|---|
| Headset | 1 |
| Scanner | 2 |
| Printer | 3 |
| Payment | 4 |
| Dex | 5 |
| Custom_1 | 6 |
| Custom_2 | 7 |
| Custom_3 | 8 |
| Custom_4 | 9 |
| Custom_5 | 10 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Pairing PIN Code
Enter the Pairing PIN Code for a Bluetooth Rule.
When a Pairing PIN Code is specified for a rule, and the device has a Bluetooth version prior to 2.1, Bluetooth Silent Pairing will automatically use the specified Pairing PIN Code to complete Bluetooth Silent Pairings enabled by the Silent Pairing Rule.
When the device has a Bluetooth version 2.1 or later, a Pairing PIN Code is not required to complete Bluetooth Silent Pairings enabled by the Silent Pairing Rule.
Detail Information:
Key = bluetoothRulePIN
Type = string
Support Information:
Supported on Operating System(s): Pie.
NOT supported on Device(s): TC20 and TC25.
Pairing Popup
Select whether a New Pairing Popup will be Allowed to be presented when an unpaired peripheral device attempts to establish a new Bluetooth pairing with a device.
If the value Disallow is selected, a New Pairing Popup will NOT be Allowed to be presented when an unpaired peripheral device attempts to establish a new Bluetooth pairing with a device.
If the value Allow is selected, a New Pairing Popup WILL be Allowed to be presented when an unpaired peripheral device attempts to establish a new Bluetooth pairing with a device.
Additional Details:
This option will have no effect on existing pairings.
This option will not prevent new pairings that are initiated from the device to the peripheral.
This option will not prevent new pairings from being established based on configured Silent Pairing rules.
Detail Information:
Key = btPairingPopup
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.3.
Silent Pairing
Select whether the device will be Allowed to perform Bluetooth pairings silently.
If the value Allow is selected, the device will NOT be Allowed to perform Bluetooth pairings silently.
If the value Disallow is selected, the device WILL be Allowed to perform Bluetooth pairings silently.
Devices will silently perform Bluetooth Pairings by default.
Note that even when the device CAN silently perform Bluetooth Pairings, it WILL NOT do so unless Bluetooth Pairing Rules is used to configure specific silent pairing rules that define how silent pairing should occur.
Detail Information:
Key = btSilentPairingsState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Allow | 1 |
| Disallow | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 7.0.
Silent Pairing Default Method
Select whether to allow silent pairing using only Zebra-defined peripherals.
Devices will silently perform Bluetooth Pairings by default.
If the value Do not change is selected, the then no change will be made to the method used as the default for silent pairings.
If the value Disable All is selected, silent pairing will be performed on NO devices.
If the value Enable with Zebra-defined peripherals only is selected, silent pairing will only be performed on Zebra defined devices only.
Detail Information:
Key = btSilentPairingDefMethod
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disable All | 1 |
| Enable with Zebra-defined peripherals only | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.5.
Single Pairing
Select whether only one remote device of a certain category will be paired at a time.
Devices will allow more than one pairing of a category of device at a time by default.
If the value Allow is selected, the default behavior will be overridden and the device will only pair to one device of the specified category at a time.
If the value Disallow is selected, the default behavior will be in effect and the device will pair to more than one device of any category at a time.
Note that even when the device CAN silently perform Bluetooth Pairings, it WILL NOT do so unless Bluetooth Pairing Rules is used to configure specific single pairing rules that define how single pairing should occur.
Detail Information:
Key = btSinglePairingsState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Allow | 1 |
| Disallow | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
State
Select the Power State of the Bluetooth Radio.
Detail Information:
Key = btState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.3.
Blocked BLE Channels
Enter the BLE channels to block separated by commas or high/low pairs separated by a dash. For example, 0-5,7,31-35.
Detail Information:
Key = btBLEBlockedChannels
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.1.
Blocked RF-Based BLE Channels
Enter the RF-Based BLE channels to block separated by commas or high/low pairs separated by a dash. For example, 2414-2418,2420,2431-2453
Detail Information:
Key = btBLEBlockedRFChannels
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.1.
Beacon Configuration
Use this Sub-group to configure Airplane Mode State, Beaconing On Battery Reinsert, State, Type, Explicit Beacon UUID, AltBeacon, Custom Beacon, Custom Transmit Power Level, Transmit Power Level, Custom Transmit Interval, and Transmit Power Interval.
Detail Information:
Key = btBeaconConfig
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Airplane Mode State
Select whether the emitting of Beacons while the Device is Powered Off will be conditioned based on whether Airplane Mode was On at the time the Device was powered Off.
This is only relevant when On is specified for Airplane Mode State.
Detail Information:
Key = btBeaconAirplaneModeState
Type = string
| UI Choice | JSON Value |
|---|---|
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Beaconing On Battery Reinsert
Select whether to emit beacon upon battery reinsertion while device is still powered off. By default, beacon will be emitted.
This is only relevant when On is specified for Airplane Mode State.
Detail Information:
Key = btBeaconingOnBatteryReinsert
Type = string
| UI Choice | JSON Value |
|---|---|
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
State
Select whether a beacon will be emitted (on) or not (off) while the device display is turned off.
If the value Off is selected, a beacon will NOT be emitted when the device display is turned off.
If the value On is selected, a beacon WILL be emitted when the device display is turned off.
Detail Information:
Key = btBeaconState
Type = string
| UI Choice | JSON Value |
|---|---|
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Type
Select the Type of Beacon to be emitted.
If the value AltBeacon is selected, an AltBeacon style Beacon will be emitted.
If the value Custom is selected, a Custom style Beach will be emitted and Data must also be specified to define the Custom Beacon style.
Detail Information:
Key = btBeaconType
Type = string
| UI Choice | JSON Value |
|---|---|
| AltBeacon | 2 |
| Custom | 3 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Explicit Beacon UUID
Select whether an explicit UUID will be used for the beacon when AltBeacon is specified for Type.
Detail Information:
Key = btExplicitBeaconUUID
Type = string
| UI Choice | JSON Value |
|---|---|
| Off | 0 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
AltBeacon Configuration
Use this Sub-group to configure UUID, ID1, ID2, Manufacturing Byte, and Reference RSSI.
Detail Information:
Key = btAltBeaconConfig
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
UUID
Enter the UUID to use when On is specified for UUID and AltBeacon is specified for Type.
Detail Information:
Key = btAltBeaconUUID
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
ID1
Enter the 4 hexadecimal characters to use for ID1 when AltBeacon is specified for Type. If nothing is entered, the value of EBEB will be used.
Detail Information:
Key = btAltBeaconMajorID
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
ID2
Enter the 4 hexadecimal characters to use for ID2 when AltBeacon is specified for Type. If nothing is entered, the value of ECDD will be used.
Detail Information:
Key = btAltBeaconMinorID
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Manufacturing Byte
Enter the 2 hexadecimal characters to use for the manufacturing byte when AltBeacon is specified for Type. If no value is entered, the default value of 00 will be used.
Detail Information:
Key = btAltBeaconMfgByte
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Reference RSSI
Enter the 2 hexadecimal characters to used for the reference RSSI when AltBeacon is specified for Type. If no value is entered, a calculated value will be used.
Detail Information:
Key = btAltBeaconRefRSSI
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Custom Beacon Configuration
Use this Sub-group to configure Data.
Detail Information:
Key = btCustomBeaconConfig
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Data
Enter the custom UUID/URL/DATA to use for the custom beacon type. Up to 56 hexadecimal characters that follow the Bluetooth SIG Advertising format may be used when Custom is specified for Type.
Detail Information:
Key = btCustomBeaconData
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Custom Transmit Power Level
Enter the power level (in dBm) of the beacons that will be sent while the device is powered off. Valid range is between -127 and 1.
Detail Information:
Key = btCustomBeaconXmitPower
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Transmit Power Level
Select the Power Level of the beacon that will be emitted while the device is powered off. If not selected, default value will be used (default values vary by device)
If the value High (1dBm) is selected, the transmit power level of the beacon will be set to 1dBm (maximum power)
If the value Medium (-7dBm) is selected, the transmit power level of the beacon will be set to -7dBm.
If the value Low Power (-15dBm) is selected, the transmit power level of the beacon will be set to -15dBm
If the value Ultra Low Power(-21dBm) is selected, the transmit power level of the beacon will be set to -21dBm
If the value Custom is selected a value between -127 and +1 (dBm) must be entered for Transmit Power Level
Detail Information:
Key = btBeaconXmitPower
Type = string
| UI Choice | JSON Value |
|---|---|
| High (1dBm) | 1 |
| Medium (-7dBm) | 2 |
| Low Power (-15dBm) | 3 |
| Ultra Low Power(-21dBm) | 4 |
| Custom | 5 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Custom Transmit Interval
Enter the Interval between beacons that will be sent while the device is powered off. The valid range of values is between 100 and 10240 msec.
Detail Information:
Key = btCustomBeaconXmitInterval
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Transmit Power Interval
Select the Interval between beacons that will be sent while the device is powered off. If not selected, default value will be used (default values vary by device)
If the value Low Latency (100 ms) is selected, the transmit interval between beacons will be set to 100msec (Low Latency)
If the value Balanced (250 ms) is selected, the transmit interval between beacons will be set to 250msec (Balanced)
If the value Low Power (1000 ms) is selected, the transmit interval between beacons will be set to 1000msec (Low Power)
If the value Custom is selected, the transmit interval between beacons will be set to the value specified in Transmit Interval
Detail Information:
Key = btBeaconXmitInterval
Type = string
| UI Choice | JSON Value |
|---|---|
| Low Latency (100 ms) | 1 |
| Balanced (250 ms) | 2 |
| Low Power (1000 ms) | 3 |
| Custom | 4 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
DHCP Configuration
Use this Sub-group to configure DHCPV6, Request V4 Options, and Send V4 Options.
Detail Information:
Key = dhcpConfig
Type = bundle
Support Information:
- Supported from: MX 8.1.
DHCPV6
Select whether to use DHCP V6 addresses
Detail Information:
Key = dhcpV6
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Change | |
| Turn On | 0 |
| Turn Off | 1 |
Support Information:
- Supported from: MX 10.3.
Request V4 Options
Use this Sub-array to configure one or more Request V4 Option(s).
Detail Information:
Key = dhcpRequestV4Options
Type = bundle_array
Request V4 Option
Use this Sub-group to configure Request V4 Type.
Detail Information:
Key = dhcpRequestV4Option
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Request V4 Type
Select the Type of DHCP Option to be Requested from the DHCP Server by the DHCP Client.
Detail Information:
Key = dhcpRequestV4Type
Type = string
| UI Choice | JSON Value |
|---|---|
| 28 - Broadcast Address | 28 |
| 42 - NTP Server | 42 |
| 43 - Vendor Encapsulated Options | 43 |
| 66 - TFTP Server Address | 66 |
| 67 - Boot File Name | 67 |
| 119 - Domain Search List | 119 |
| 150 - TFTP Server Names | 150 |
| 186 - Vendor Specific Option#1 | 186 |
| 188 - Vendor Specific Option#2 | 188 |
| 230 - Vendor Specific Option#3 | 230 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Send V4 Options
Use this Sub-array to configure one or more Send V4 Option(s).
Detail Information:
Key = dhcpSendV4Options
Type = bundle_array
Send V4 Option
Use this Sub-group to configure Send V4 Flag Value, Send V4 Type, and Send V4 Value.
Detail Information:
Key = dhcpSendV4Option
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Send V4 Flag Value
Enter the Flag Value to be attached to DHCP Option 81 Sent to the DHCP Server by the DHCP Client.
Detail Information:
Key = dhcpSendV4FlagValue
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 6.3.
Send V4 Type
Select the Type of DHCP Option to be Sent to the DHCP Server by the DHCP Client.
Detail Information:
Key = dhcpSendV4Type
Type = string
| UI Choice | JSON Value |
|---|---|
| 12 - Host Name | 12 |
| 60 - Vendor Class | 60 |
| 61 - Client Identifier Value | 61 |
| 77 - User Class | 77 |
| 81 - FQDN Flag | 81 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Send V4 Value
Enter the Value to be attached to a DHCP Option to be Sent to the DHCP Server by the DHCP Client.
Detail Information:
Key = dhcpSendV4Value
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Enterprise NFC Configuration
Use this Sub-group to configure State, General NFC, and Tag.
Detail Information:
Key = nfcConfig
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.3.
State
Select the Enterprise NFC State.
If the value Off is selected, Enterprise NFC will be turned Off.
If the value On is selected, Enterprise NFC will be turned On.
Detail Information:
Key = wirelessNfcState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.3.
General NFC Configuration
Use this Sub-group to configure Reset to Defaults, Logging, NFC Data Exchange Format (NDEF), Polling Mode, CPU Boost, Peer to Peer Mode, Card Emulation Mode, and Use on Lock Screen.
Detail Information:
Key = nfcGeneralConfig
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.3.
Reset to Defaults
Select whether the Enterprise NFC settings should all be reset to their default values.
Detail Information:
Key = wirelessNfcResetToDefaults
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Reset | false |
| Reset | true |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Logging
Select whether logging should be used by Enterprise NFC
If the value Off is selected, Enterprise NFC will NOT capture logs.
If the value On is selected, Enterprise NFC will capture logs.
Detail Information:
Key = wirelessNfcDebugLoggingState
Type = string
| UI Choice | JSON Value |
|---|---|
| Off | false |
| On | true |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.3.
NFC Data Exchange Format (NDEF)
Select whether the Enterprise NFC should use NFC Data Exchange Format (NDEF).
If the value Do Not Use is selected, Enterprise NFC will NOT attempt tp read NDEF formatted tags. This could increase the speed of reading non-NDEF tags by not spending unnecessary time trying to interpret tag data according to NDEF formatting rules.
If the value Use is selected, Enterprise NFC will attempt to read NDEF formatted tags. This may decrease speed somewhat, compared to reading unformatted tags, but increases flexibility by allowing applications to receive tag data interpreted according to NDEF formatting rules. Starting in Android 11, support for NFC Data Exchange Format (NDEF) is deprecated.
Detail Information:
Key = wirelessNfcUseNDEF
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Use | false |
| Use | true |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Polling Mode
Select the Enterprise NFC Polling Mode that should be used.
If the value Hybrid is selected, Enterprise NFC will poll in a manner designed to strike a reasonable balance between polling speed and battery life.
If the value Standard is selected, then Enterprise NFC will poll in a manner designed to maximize polling speed. This may increase battery drain but will reduce tag detection time.
If the value Low Power is selected, Enterprise NFC will poll in a manner designed to minimize impact on battery life. This may increase the overall tag detection time, but will reduce battery drain.
Detail Information:
Key = wirelessNfcPollingMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Hybrid | 2 |
| Standard | 1 |
| Low Power | 0 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
CPU Boost
Select whether the Enterprise NFC should Boost CPU Speed during NFC transactions.
If the value Do Not Boost is selected, Enterprise NFC will leave the CPU Speed unmodified during NFC transactions.
If the value Boost is selected, Enterprise NFC will Boost the CPU Speed during NFC transactions to enhance performance of those transactions.
Detail Information:
Key = wirelessNfcCpuBoost
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Boost | false |
| Boost | true |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Peer to Peer Mode
Select whether the Enterprise NFC should use Peer-to-Peer Mode. This is generally used when two NFC enabled devices want to communicate with each other to exchange data.
If the value Do Not Use is selected, Enterprise NFC will NOT use Peer-to-Peer Mode and hence will operate only in Read/Write Mode, unless it is also configured to operated in Card Emulation Mode by via Card Emulation Mode.
If the value Use is selected, Enterprise NFC will use Peer-to-Peer Mode and hence will operate in both Peer-to-Peer Mode and Read/Write Mode, and and optionally also in Card Emulation Mode, if configured via Card Emulation Mode.
Note that starting in Android 11, support for Peer-to-Peer Mode is deprecated.
Detail Information:
Key = wirelessNfcPeerToPeerMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Use | false |
| Use | true |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Card Emulation Mode
Select whether the Enterprise NFC should use Card Emulation Mode. This is generally used when an NFC enabled device wants to emulate a Smart Card.
If the value Do Not Use is selected, Enterprise NFC will NOT use Card Emulation Mode and hence will operate only in Read/Write Mode, unless it is also configured to operated in Peer-to-Peer Mode by via Peer to Peer Mode.
If the value Use is selected, Enterprise NFC will use Card Emulation Mode and hence will operate in both Card Emulation Mode and Read/Write Mode and optionally also in Peer-to-Peer Mode, if configured via Peer to Peer Mode.
Detail Information:
Key = wirelessNfcCardEmulationMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Use | false |
| Use | true |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Use on Lock Screen
Select whether the User will be Allowed to Enterprise NFC from the Lock Screen.
If the value Disallow is selected, the User will NOT be Allowed to Enterprise NFC from the Lock Screen.
If the value Allow is selected, the User WILL be Allowed to Enterprise NFC from the Lock Screen.
Detail Information:
Key = wirelessNfcUseOnLockScreen
Type = string
| UI Choice | JSON Value |
|---|---|
| Disallow | false |
| Allow | true |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Tag Configuration
Use this Sub-group to configure Type A Tags, Type B Tags, Type F Tags, Type V Tags, Type A Tag Baud Rate, and Type B Tag Baud Rate.
Detail Information:
Key = nfcTagConfig
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.3.
Type A Tags
Select whether the Enterprise NFC should read NFC Type A Tags.
If the value Do Not Read is selected, Enterprise NFC will NOT attempt to read NFC Type A Tags. This could increase the speed of reading other tag types in cases where Type A Tags are not used.
If the value Read is selected, Enterprise NFC will attempt to read NFC Type A Tags. This might decrease the speed of reading tags unless reading of other tag types is turned off.
Detail Information:
Key = wirelessNfcReadTypeATags
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Read | false |
| Read | true |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Type B Tags
Select whether the Enterprise NFC should read NFC Type B Tags.
If the value Do Not Read is selected, Enterprise NFC will NOT attempt to read NFC Type B Tags. This could increase the speed of reading other tag types in cases where Type B Tags are not used.
If the value Read is selected, Enterprise NFC will attempt to read NFC Type B Tags. This might decrease the speed of reading tags unless reading of other tag types is turned off.
Detail Information:
Key = wirelessNfcReadTypeBTags
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Read | false |
| Read | true |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Type F Tags
Select whether the Enterprise NFC should read NFC Type F Tags.
If the value Do Not Read is selected, Enterprise NFC will NOT attempt to read NFC Type F Tags. This could increase the speed of reading other tag types in cases where Type F Tags are not used.
If the value Read is selected, Enterprise NFC will attempt to read NFC Type F Tags. This might decrease the speed of reading tags unless reading of other tag types is turned off.
Detail Information:
Key = wirelessNfcReadTypeFTags
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Read | false |
| Read | true |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Type V Tags
Select whether the Enterprise NFC should read NFC Type V Tags.
If the value Do Not Read is selected, Enterprise NFC will NOT attempt to read NFC Type V Tags. This could increase the speed of reading other tag types in cases where Type V Tags are not used.
If the value Read is selected, Enterprise NFC will attempt to read NFC Type V Tags. This might decrease the speed of reading tags unless reading of other tag types is turned off.
Detail Information:
Key = wirelessNfcReadTypeVTags
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Read | false |
| Read | true |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Type A Tag Baud Rate
Select the Baud Rate that Enterprise NFC should use for Type A Tags.
If the value 106 kbps is selected, Enterprise NFC will always communicate to Type A Tags using a Baud Rate of 106 kbps.
If the value 212 kbps is selected, Enterprise NFC will communicate to Type A Tags using a Baud Rate of 106 kbps or 212 kbps, depending on the Baud Rate supported by the tag.
If the value 424 kbps is selected, Enterprise NFC will communicate to Type A Tags using a Baud Rate of 106 kbps, 212 kbps, or 424 kbps, depending on the Baud Rate supported by the tag.
If the value Any is selected, Enterprise NFC will communicate to Type A Tags using any available (automatically selected) Baud Rate supported by the tag.
Detail Information:
Key = wirelessNfcTypeABaudRate
Type = string
| UI Choice | JSON Value |
|---|---|
| 106 kbps | 1 |
| 212 kbps | 16 |
| 424 kbps | 32 |
| Any | 2 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Type B Tag Baud Rate
Select the Baud Rate that Enterprise NFC should use for Type B Tags.
If the value 106 kbps is selected, Enterprise NFC will always communicate to Type B Tags using a Baud Rate of 106 kbps.
If the value 212 kbps is selected, Enterprise NFC will communicate to Type B Tags using a Baud Rate of 106 kbps or 212 kbps, depending on the Baud Rate supported by the tag.
If the value 424 kbps is selected, Enterprise NFC will communicate to Type B Tags using a Baud Rate of 106 kbps, 212 kbps, or 424 kbps, depending on the Baud Rate supported by the tag.
If the value Any is selected, Enterprise NFC will communicate to Type B Tags using any available (automatically selected) Baud Rate supported by the tag.
Detail Information:
Key = wirelessNfcTypeBBaudRate
Type = string
| UI Choice | JSON Value |
|---|---|
| 106 kbps | 4 |
| 212 kbps | 64 |
| 424 kbps | 128 |
| Any | 2 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Ethernet Configuration
Use this Sub-group to configure State, User Control of State, IP Address, Proxy, and Authentication.
Detail Information:
Key = ethernetConfig
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 6.2.
State
Select whether Ethernet Power will be turned on or off.
A given device may or may not support an Ethernet Adapter. An attempt to configure the Ethernet Adapter on a device that does not have one will result in an error.
Detail Information:
Key = netEthernetState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.4.
User Control of State
Select whether the User will be Allowed to control the Ethernet Power State.
If the value Disallow is selected, the User will NOT be Allowed to control the Ethernet Power State.
If the value Allow is selected, the User WILL be Allowed to control the Ethernet Power State.
Note that a given device may or may not support an Ethernet Adapter. An attempt to configure the Ethernet Adapter on a device that does not have one will result in an error.
Detail Information:
Key = netEthernetStateControlByUser
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.4.
IP Address Configuration
Use this Sub-group to configure Type, Static IP Address, Static Gateway Address, Static Network Mask, Static Primary DNS, and Static Secondary DNS.
Detail Information:
Key = netEthernetIpAddrConfig
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 6.2.
Type
Select how an IP Address will be assigned to the Ethernet adapter.
If the value Static (Manual) is selected, an IP Address for the Ethernet adapter will be automatically acquired by the DHCP Client from the DHCP Server.
If the value Dynamic (DHCP) is selected, an IP Address for the Ethernet adapter will be assigned based on the values selected for IP Address, Gateway Address, Network Mask, Primary DNS, and Secondary DNS, which you must also specify to provide the required values.
Note that a given device may or may not support an Ethernet Adapter. An attempt to configure the Ethernet Adapter on a device that does not have one will result in an error.
Detail Information:
Key = netEthernetIpAddrType
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Dynamic (DHCP) | 1 |
| Static (Manual) | 0 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Static IP Address
Enter the IP Address to be assigned to the Ethernet adapter.
A given device may or may not support an Ethernet Adapter. An attempt to configure the Ethernet Adapter on a device that does not have one will result in an error.
Detail Information:
Key = netEthernetIpStaticIpAddress
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Static Gateway Address
Enter the Gateway Address to be assigned to the Ethernet adapter.
A given device may or may not support an Ethernet Adapter. An attempt to configure the Ethernet Adapter on a device that does not have one will result in an error.
Detail Information:
Key = netEthernetIpStaticGatewayAddress
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Static Network Mask
Enter the Network Mask to be assigned to the Ethernet adapter.
A given device may or may not support an Ethernet Adapter. An attempt to configure the Ethernet Adapter on a device that does not have one will result in an error.
Detail Information:
Key = netEthernetIpStaticNetworkMask
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Static Primary DNS
Enter the Primary DNS Server Address to be assigned to the Ethernet adapter.
A given device may or may not support an Ethernet Adapter. An attempt to configure the Ethernet Adapter on a device that does not have one will result in an error.
Detail Information:
Key = netEthernetIpStaticDNS1
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Static Secondary DNS
Enter the Secondary DNS Server Address to be assigned to the Ethernet adapter.
A given device may or may not support an Ethernet Adapter. An attempt to configure the Ethernet Adapter on a device that does not have one will result in an error.
Detail Information:
Key = netEthernetIpStaticDNS2
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Proxy Configuration
Use this Sub-group to configure State, Port, Server, and Bypass List.
Detail Information:
Key = netEthernetProxyConfig
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 6.2.
State
Select whether a Proxy Server should be used to access the Internet from the network accessed via the Ethernet Adapter.
When specifying that a Proxy Server is to be used, you should specify Proxy Server, Port, and Bypass List together whenever Ethernet Proxy Server configuration is performed to help ensure that all three three values are properly synchronized.
A given device may or may not support an Ethernet Adapter. An attempt to configure the Ethernet Adapter on a device that does not have one will result in an error.
Detail Information:
Key = netEthernetProxyState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Use a Proxy Server | 2 |
| Do NOT Use a Proxy Server | 1 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Port
Enter the Port that will be used to reach the Proxy Server to access the Internet from the network accessed via the Ethernet Adapter.
You should specify Proxy Server, Port, and Bypass List whenever Ethernet Proxy Server configuration is performed to help ensure that all three three values are properly synchronized.
A given device may or may not support an Ethernet Adapter. An attempt to configure the Ethernet Adapter on a device that does not have one will result in an error.
Detail Information:
Key = netEthernetProxyServerPort
Type = integer
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Server
Enter the Proxy Server used to access the Internet from the network accessed via the Ethernet Adapter.
While it is not mandatory, you should specify Proxy Server, Port, and Bypass List whenever Ethernet Proxy Server configuration is performed to help ensure that all three three values are properly synchronized.
A given device may or may not support an Ethernet Adapter. An attempt to configure the Ethernet Adapter on a device that does not have one will result in an error.
Detail Information:
Key = netEthernetProxyServer
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Bypass List
Enter the Proxy Server Bypass List which specifies addresses that should bypass the Proxy Server used to access the Internet from the network accessed via the Ethernet Adapter.
While it is not mandatory, you should specify Proxy Server, Port, and Bypass List whenever Ethernet Proxy Server configuration is performed to help ensure that all three three values are properly synchronized.
A given device may or may not support an Ethernet Adapter. An attempt to configure the Ethernet Adapter on a device that does not have one will result in an error.
Detail Information:
Key = netEthernetProxyServerBypassList
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Authentication Configuration
Use this Sub-group to configure Authentication, Identity, Password, CA Certificate Name, Client Certificate Name, and Domain Name.
Detail Information:
Key = netEthernetAuthentication
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.3.
Authentication
Used to select the type of authentication required for connecting to a network.
If the value Disable is selected, Sets the authentication type to NONE.
If the value EAP-TLS is selected, Sets authentication to 802.1x Extensible Authentication Protocol - Transport Layer Security (EAP-TLS)
Detail Information:
Key = netEthernetAuthenticationType
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disable | 0 |
| EAP-TLS | 1 |
| PEAP-MSCHAPV2 | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.3.
Identity
Used to enter the user name for authentication on a network. Parm value input rules: String from 0–64 characters containing the network user name.
Detail Information:
Key = netEthernetAuthenticationIdentity
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.3.
Password
Used to enter the password corresponding to the user name entered in the Identity field. Parm value input rules: String from 0–64 characters containing the relevant password
Detail Information:
Key = netEthernetAuthenticationPassword
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.3.
CA Certificate Name
Used to enter the name of the optional certificate (if used) to validate a server on a network. Parm value input rules: String from 0–64 characters containing a CA server certificate
Detail Information:
Key = netEthernetAuthenticationCACertificate
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.3.
Client Certificate Name
Used to enter the name of the certificate to validate a user on a network. Parm value input rules: String from 1–64 characters containing a client certificate
Detail Information:
Key = netEthernetAuthenticationClientCertificate
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.3.
Domain Name
Used to enter the domain name of the network to be joined. Parm value input rules: String from 0–64 characters containing a valid domain name (e.g. myCompanyDomain.com)
Detail Information:
Key = netEthernetAuthenticationDomainName
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 13.3.
Host Name Configuration
Use this Sub-group to configure Device Friendly Name and Device Network Name.
Detail Information:
Key = hostConfig
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 5.1.
Device Friendly Name
Enter the name by which a device will be known on the network.
Detail Information:
Key = netDeviceFriendlyName
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Device Network Name
Enter the name by which a device will be known on the network.
Detail Information:
Key = netHostDeviceName
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Network Connection Configuration
Use this Sub-group to configure Allowed Access Points, Connection Refresh Interval, Signal Level to connect WLAN, and Signal Level to connect WWAN.
Detail Information:
Key = wirelessNetworkConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Allowed Access Points
Enter a comma delimited string of access point names to which the device may associate.
Detail Information:
Key = wNCAllowedAccessPoints
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.9.
Connection Refresh Interval
Enter the time interval (in seconds) to wait before evaluating quality of the current connection against the list of Wi-Fi access points stored on the device. A value of '0' (default) is ignored.
Detail Information:
Key = wNCRefreshInterval
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.9.
Signal Level to connect WLAN
Enter the minimum signal level (in dBm) for connection to a WLAN (Wi-Fi) network. Range of values: -90 dBm (poor) to -30 dBm (excellent). A value of '0' (default) is ignored.
Detail Information:
Key = wNCMinimumWLAN
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.9.
Signal Level to connect WWAN
Enter the minimum signal level (in dBm) for connection to a WWAN (cellular) network. Range of values: -156 dBm (poor) to -31 dBm (excellent). A value of '0' (default) is ignored.
Detail Information:
Key = wNCMinimumWWAN
Type = string
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.9.
RFID Configuration
Use this Sub-group to configure Update Firmware File, Country of Operation, Channel Hopping, Channel Mask, Ukraine Region Power Mode, Query Select, Query Session, Query Target, and Transmit Power Level.
Detail Information:
Key = rfidConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Update Firmware File
Enter the path and file name of the file containing the firmware update to be applied.
Detail Information:
Key = wirelessRfidUpdateFirmwareFile
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Country of Operation
Select the Country of Operation in which the RFID module will be used.
It is critical that the Country of Operation be set at least once, since the RFID module has no default Country of Operation and will not operate unless/until the Country of Operation is explicitly set, to ensure that country-specific regulator requirements are met.
In most cases, the Country of Operation will be set once and never changed, unless the device is physically relocated to a different country.
Detail Information:
Key = wirelessRfidCountryOfOperation
Type = string
| UI Choice | JSON Value |
|---|---|
| ALBANIA | 1 |
| ANDORRA | 2 |
| ARGENTINA | 3 |
| AUSTRALIA | 4 |
| BANGLADESH | 5 |
| BHUTAN | 6 |
| BOLIVIA | 7 |
| BOSNIA_HERZENGOVINA | 8 |
| BRAZIL | 9 |
| CANADA | 10 |
| CAMBODIA | 11 |
| CHILE | 12 |
| CHINA | 13 |
| COLOMBIA | 14 |
| DOMINICAN_REPUBLIC | 15 |
| ECUADOR | 16 |
| EL_SALVADOR | 17 |
| UNITED_KINGDOM | 18 |
| GUATEMALA | 19 |
| GUAM | 20 |
| HONG_KONG | 21 |
| INDIA | 22 |
| INDONESIA | 23 |
| JAPAN_1W_LBT | 24 |
| JAPAN_250MW | 25 |
| LAOS_EU | 26 |
| LAOS_FCC | 27 |
| MACAU | 28 |
| MACEDONIA | 29 |
| MALAYSIA | 30 |
| MEXICO | 31 |
| MONACO | 32 |
| MOTENEGRO | 33 |
| NEW_ZEALAND_FCC | 34 |
| NEW_ZEALAND_EU | 35 |
| PAKISTAN | 36 |
| PANAMA | 37 |
| PARAGUAY | 38 |
| PERU | 39 |
| PHILIPPINES | 40 |
| PUERTO_RICO | 41 |
| RUSSIA | 42 |
| SAUDI_ARABIA | 43 |
| SINGAPORE | 44 |
| SOUTH_AFRICA | 45 |
| SOUTH_KOREA | 46 |
| SRI_LANKA | 47 |
| TAIWAN | 48 |
| THAILAND | 49 |
| TURKEY | 50 |
| UAE | 51 |
| UNITED_STATES | 52 |
| URUGUAY | 53 |
| VENEZUELA | 54 |
| VIETNAM | 55 |
| VIRGINIA_ISLAND | 56 |
| ETSI 302.208 compliant generic | 57 |
| FCC Part-16 compliant generic | 58 |
| ISRAEL | 59 |
| ALGERIA | 60 |
| ARMENIA | 61 |
| AUSTRIA | 62 |
| AZERBAIJAN | 63 |
| BAHRAIN | 64 |
| BELGIUM | 65 |
| BULGARIA | 66 |
| COSTA_RICA | 67 |
| CROATIA | 68 |
| CYPRUS | 69 |
| CZECH_REPUBLIC | 70 |
| DENMARK | 71 |
| EGYPT | 72 |
| ESTONIA | 73 |
| FINLAND | 74 |
| FRANCE | 75 |
| GEORGIA | 76 |
| GERMANY | 77 |
| GREECE | 78 |
| HUNGARY | 79 |
| ICELAND | 80 |
| IRELAND | 81 |
| ITALY | 82 |
| JORDAN | 83 |
| KAZAKHSTAN | 84 |
| KUWAIT | 85 |
| LATVIA | 86 |
| LITHUANIA | 87 |
| LUXEMBOURG | 88 |
| MALTA | 89 |
| NETHERLANDS | 90 |
| NORWAY | 91 |
| OMAN | 92 |
| POLAND | 93 |
| PORTUGAL | 94 |
| QATAR | 95 |
| ROMANIA | 96 |
| SERBIA | 97 |
| SLOVAKIA | 98 |
| SLOVENIA | 99 |
| SPAIN | 100 |
| SWEDEN | 101 |
| SWITZERLAND | 102 |
| TUNISIA | 103 |
| UKRAINE | 104 |
| ANGUILLA | 106 |
| MOROCCO | 107 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
Channel Hopping
Select whether Channel Hopping will be performed among the Channels that are used by the RFID module.
Detail Information:
Key = wirelessRfidCountryOfOperationChannelHopping
Type = string
| UI Choice | JSON Value |
|---|---|
| Off | 0 |
| On | 1 |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Channel Mask
Enter the Channel Mask that determines which of the Channels that are allowed, based on the currently selected Country of Operation, will be used by the RFID module.
If no Channel Mask is specified, the RFID module will be free to use any or all Channels that are available based on the currently selected Country of Operation.
If a Channel Mask is specified, the specified value must consist of one or more Channel Numbers, separated by commas if more than one is specified, which identify the Channels that can be used. The RFID module will limit itself to just the Channels that are allowed for the currently selected Country of Operation AND that are in the set of Channels specified.
Note that you should consult the product documentation for the device being used to obtain the set of allowable Channel Numbers for that device.
Detail Information:
Key = wirelessRfidCountryOfOperationChannelMask
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Ukraine Region Power Mode
Select the Ukraine Region specific power mode to be used by the RFID module.
Detail Information:
Key = wirelessRfidCountryOfOperationUkraineRegionPowerMode
Type = string
| UI Choice | JSON Value |
|---|---|
| License free 100MW power-mode | 0 |
| Licensed 2W power-mode | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.1.
Query Select
Select which RFID tags should be operated upon by the RFID module during a Query Operation, based on the state of the SL flag.
If the value Query applies to all tags is selected, when the RFID module performs a Query Operation, it will consider all RFID tags that are currently visible to the RFID module.
If the value Query applies to tags with SL de-asserted is selected, when the RFID module performs a Query Operation, it will consider only those RFID tags that are currently visible to the RFID module AND that have SL flag de-asserted (i.e tags for which the SL flag has NOT been set using the Select command).
If the value Query applies to tags with SL asserted is selected, when the RFID module performs a Query Operation, it will consider only those RFID tags that are currently visible to the RFID module AND that have SL flag asserted (i.e tags for which the SL flag HAS been set using the Select command).
Detail Information:
Key = wirelessRfidQuerySelect
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Query applies to all tags | 0 |
| Query applies to tags with SL de-asserted | 2 |
| Query applies to tags with SL asserted | 3 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
Query Session
Select the Session that will be used by the RFID module to access RFID tags during a Query Operation.
Allowable values are SessionS0, SessionS1, SessionS2, and SessionS3.
Sessions provide options for how to count tags. For more information on the use of Sessions, consult the device product documentation.
Detail Information:
Key = wirelessRfidQuerySession
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| SessionS0 | 0 |
| SessionS1 | 1 |
| SessionS2 | 2 |
| SessionS3 | 3 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
Query Target
Select how the A and B flags of RFID tags should be handled by the RFID module during a Query Operation.
If the value Inventory Target Flag A is selected, when the RFID module performs a Query Operation, it will consider only those RFID tags that are currently visible to the RFID module AND that are in State A.
If the value Inventory Target Flag B is selected, when the RFID module performs a Query Operation, it will consider only those RFID tags that are currently visible to the RFID module AND that are in State B.
If the value AB Flip is selected, when the RFID module performs a Query Operation, it will consider only those RFID tags that are currently visible to the RFID module AND that are in either State A or State B and will Flip the State from A to B or B to A for the session.
Detail Information:
Key = wirelessRfidQueryTarget
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Inventory Target Flag A | 0 |
| Inventory Target Flag B | 1 |
| AB Flip | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
Transmit Power Level
Enter the RFID Power Level that should be used by the RFID module when transmitting.
The RFID Power Level should be specified in tenths of dBm in the range of 0 to 300, inclusive.
For example, to specify an RFID Power Level of 29.5 dBm, specify a value of 295.
Detail Information:
Key = wirelessRfidTransmitPowerLevel
Type = integer
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
Wireless General Configuration
Use this Sub-group to configure Antenna Selection, Bluetooth Scanning State, GPS Power State, Location State, Network Monitored Popup, and Wi-Fi Scanning State.
Detail Information:
Key = wirelessConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Antenna Selection
Select which of multiple antennas should be used for wireless communications.
Detail Information:
Key = wirelessConfigAntennaSelection
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Internal | 1 |
| External | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 7.1.
Bluetooth Scanning State
Select whether Bluetooth scanning is to be used to improve location
If the value Turn On is selected, system apps and services will detect Bluetooth devices and use them to improve location.
If the value Turn Off is selected, system apps and services will not detect Bluetooth devices and will not use them to improve location.
Detail Information:
Key = wirelessConfigGpsBluetoothScanning
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Turn On | 1 |
| Turn Off | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.4.
GPS Power State
Select whether the GPS radio state should be On or Off.
If the value Off is selected, the GPS radio state will be turned off, preventing GPS-based location detection from being performed.
If the value On is selected, the GPS radio state will be turned on, allowing GPS-based location detection to be performed, given satellite availability.
Detail Information:
Key = wirelessConfigGpsPowerState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.3.
Location State
Select whether to use location services.
If the value Turn On is selected, location services will be active.
If the value Turn Off is selected, location services will not be active.
Detail Information:
Key = wirelessConfigLocationState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Turn On | 1 |
| Turn Off | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.4.
Network Monitored Popup
Select whether a Popup informing the User that their network may be monitored will be Allowed to be displayed.
If the value Disallow is selected, a Popup informing the User that their network may be monitored will NOT be Allowed to be displayed.
If the value Allow is selected, a Popup informing the User that their network may be monitored WILL be Allowed to be displayed.
Detail Information:
Key = wirelessConfigNetworkMayBeMonitoredPopup
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 6.1.
Wi-Fi Scanning State
Select whether Wi-Fi scanning is to be used to improve location
If the value Turn On is selected, system apps and services will detect Wi-Fi networks and use them to improve location.
If the value Turn Off is selected, system apps and services will not detect Wi-Fi networks and will not use them to improve location.
Detail Information:
Key = wirelessConfigGpsWifiScanning
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Turn On | 1 |
| Turn Off | 2 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.4.
Wireless LAN Configuration
Use this Sub-group to configure Auto Wakeup, Country, Network Notification, RF Bands, State, Verbose Logging, Advanced Options, Diagnostics Options, Fine Timing Measurement (FTM), Global Proxy, Hotspot, and SecureFusionAdvanced.
Detail Information:
Key = wlanConfig
Type = bundle
Auto Wakeup
Select whether Wi-Fi (not the device) should Wake Up (turn on) automatically when the presence of a previously connected network is detected.
If the value Off is selected, automatic Wake Up will be turned OFF, preventing the device from detecting the presence of a previously connected network and automatically waking up to connect to it.
If the value On is selected, automatic Wake Up will be turned ON, allowing the device to periodically scan for and detect the presence of a previously connected network and automatically wake up to connect to it.
Detail Information:
Key = wlanAutoWakeup
Type = string
| UI Choice | JSON Value |
|---|---|
| Off | 0 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 9.1.
Country
Select the Country in which the WLAN subsystem will operate on a device:
If the value Auto (Use 802.11d) is selected, the Country to be used will be determined automatically.
When any other value is selected, the specified Country will be used.
Detail Information:
Key = wlanCountry
Type = string
| UI Choice | JSON Value |
|---|---|
| Auto (Use 802.11d) | AUTO |
| Algeria | DZ |
| Anguilla | AI |
| Argentina | AR |
| Australia | AU |
| Austria | AT |
| Azerbaijan | AZ |
| Bahamas | BS |
| Bahrain | BH |
| Bangladesh | BD |
| Barbados | BB |
| Belarus | BY |
| Belgium | BE |
| Bermuda | BM |
| Bolivia | BO |
| Bonaire | BQ |
| Bosnia and Herzegovina | BA |
| Brazil | BR |
| Bulgaria | BG |
| Canada | CA |
| Cayman Islands | KY |
| Chile | CL |
| China | CN |
| Christmas Island | CX |
| Columbia | CO |
| Costa Rica | CR |
| Croatia | HR |
| Curacao | CW |
| Cyprus | CY |
| Czech Republic | CZ |
| Denmark | DK |
| Dominican Republic | DO |
| Ecuador | EC |
| Egypt | EG |
| El Salvador | SV |
| Estonia | EE |
| Falkland Islands(Malvinas) | FK |
| Finland | FI |
| France | FR |
| French Guiana | GF |
| Germany | DE |
| Ghana | GH |
| Gibraltar | GI |
| Greece | GR |
| Guadelope | GP |
| Guam | GU |
| Guatemala | GT |
| Guernsey | GG |
| Guyana | GY |
| Haiti | HT |
| Honduras | HN |
| HongKong | HK |
| Hungary | HU |
| Iceland | IS |
| India | IN |
| Indonesia | ID |
| Ireland | IE |
| Israel | IL |
| Italy | IT |
| Jamaica | JM |
| Japan | JP |
| Jordan | JO |
| Kazakhstan | KZ |
| Kenya | KE |
| Korea Republic | KR |
| Kosovo | XK |
| Kuwait | KW |
| Kyrgyzstan | KG |
| Latvia | LV |
| Lebanon | LB |
| Liechtenstein | LI |
| Lithuania | LT |
| Luxembourg | LU |
| Macedonia | MK |
| Malaysia | MY |
| Malta | MT |
| Martinique | MQ |
| Mexico | MX |
| Moldova | MD |
| Montenegro | ME |
| Morocco | MA |
| Netherlands | AN |
| Netherlands | NL |
| NewZeaLand | NZ |
| Nicaragua | NI |
| Nigeria | NG |
| Niue | NU |
| Norfolk Islands | NF |
| Northern Marina Islands | MP |
| Norway | NO |
| Oman | OM |
| Pakistan | PK |
| Panama | PA |
| Paraguay | PY |
| Peru | PE |
| Philippines | PH |
| Poland | PL |
| Portugal | PT |
| Puerto Rico | PR |
| Qatar | QA |
| Romania | RO |
| Russian Federation | RU |
| St. Maarten | SX |
| Saudi Arabia | SA |
| Senegal | SN |
| Serbia | RS |
| Singapore | SG |
| Slovakia | SK |
| Slovenia | SI |
| South Africa | ZA |
| Spain | ES |
| Sri Lanka | LK |
| Sweden | SE |
| Switzerland | CH |
| Taiwan | TW |
| Thailand | TH |
| Trinidad and Tobago | TT |
| Tunisia | TN |
| Turkey | TR |
| Uganda | UG |
| Ukraine | UA |
| United Arab Emirates | AE |
| United Kingdom | GB |
| U.S.A. | US |
| Uruguay | UY |
| Venezuela | VE |
| Vietnam | VN |
| Virgin Islands(British) | VG |
| Virgin Islands(US) | VI |
Support Information:
- Supported from: MX 4.1.
Network Notification
Select whether the User will be notified about, and allowed to connect to, new WLANs that are detected.
If the value Off is selected, the User will NOT be notified about, nor allowed to connect to, new WLANs that are detected.
If the value On is selected, the User WILL be notified about, and allowed to connect to, new WLANs that are detected.
Detail Information:
Key = wlanNetworkNotification
Type = string
| UI Choice | JSON Value |
|---|---|
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.1.
RF Bands
Use this Sub-group to configure Bands, 2.4GHz Channels, 5.0GHz Channels, and 6.0GHz Channels.
Detail Information:
Key = wlanConfigRFBands
Type = bundle
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.5.
Bands
Select the Frequency Bands on which the WLAN subsystem will operate.
If the value 2.4GHz is selected, the WLAN subsystem will operate only on the 2.4 Gigahertz (Ghz) Frequency Band (used by 802.11b and 802.11g).
If the value 5.0GHz is selected, the WLAN subsystem will operate only on the 5.0 Gigahertz (Ghz) Frequency Band (used by 802.11a).
If the value 6.0GHz is selected, the WLAN subsystem will operate only on the 6.0 Gigahertz (Ghz) Frequency Band (used by 802.11ax).
If the value Auto is selected, WLAN subsystem will Automatically determine the Frequency Bands on which to operate.
Detail Information:
Key = wcRFBands
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| 2.4GHz | 2.4GHz |
| 5.0GHz | 5.0GHz |
| 6.0GHz | 6.0GHz |
| 2.4GHz and 5.0GHz | 2.4and5.0GHz |
| 5.0GHz and 6.0GHz | 5.0and6.0GHz |
| 2.4GHz and 6.0GHz | 2.4and6.0GHz |
| Auto | Auto |
Support Information:
- Supported from: MX 11.5.
2.4GHz Channels
Enter the channels to use when Auto or 2.4GHz is selected for Bands.
Detail Information:
Key = wcRF24
Type = string
Support Information:
- Supported from: MX 11.5.
5.0GHz Channels
Enter the channels to use when Auto or 5.0GHz is selected for Bands.
Detail Information:
Key = wcRF50
Type = string
Support Information:
- Supported from: MX 11.5.
6.0GHz Channels
Enter the channels to use when Auto or 6.0GHz is selected for Bands.
Detail Information:
Key = wcRF60
Type = string
Support Information:
- Supported from: MX 11.5.
State
Select whether the WLAN power should be turned on or off
Detail Information:
Key = wlanState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do Not Change | |
| Off | 0 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.1.
Verbose Logging
Select whether the Verbose Logging feature of the WLAN adapter should be turned ON or OFF on a device.
If the value Off is selected, the Verbose Logging will be turned OFF, preventing the device from logging additional information for debugging or troubleshooting WLAN issues.
If the value On is selected, the Verbose Logging will be turned ON, allowing the device to log additional information for debugging or troubleshooting WLAN issues.
Detail Information:
Key = wlanVerboseLogging
Type = string
| UI Choice | JSON Value |
|---|---|
| Off | 0 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.3.
Advanced Options
Use this Sub-array to configure one or more Advanced Option(s).
Detail Information:
Key = wlanAdvancedOptions
Type = bundle_array
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.4.
Advanced Option
Use this Sub-group to configure Name, Custom Name, and Value.
Detail Information:
Key = wlanAdvancedOptionPair
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Name
Select a standard name that identifies a single advanced option to be configured for the WLAN adapter on a device. You must also specify Value to provide the value to be set for the advanced option identified by the selected name.
Detail Information:
Key = wlanAdvancedOptionName
Type = string
| UI Choice | JSON Value |
|---|---|
| AutoTimeConfig | AutoTimeConfig |
| HFSR | HFSR |
| CCKM | CCKM |
| FT | FT |
| FTRIC | FTRIC |
| OKC | OKC |
| PMKID | PMKID |
| PreAuth | PreAuth |
| PowerSave | PowerSave |
| WLANPowerSave | WLANPowerSave |
| AdvancedLogging | AdvancedLogging |
| FIPS | FIPS |
| EnableRestrictedSettingsUI | EnableRestrictedSettingsUI |
| 802.11K | 802.11K |
| 802.11w | 802.11w |
| 802.11ac | 802.11ac |
| 802.11n | 802.11n |
| 802.11v | 802.11v |
| BandPreference | BandPreference |
| FTOverTheDS | FTOverTheDS |
| AggregatedFT | AggregatedFT |
| ScanAssist | ScanAssist |
| CHD | CHD |
| SubNetRoam | SubNetRoam |
| WANCountry | WANCountry |
| PasswordProtectEncryption | PasswordProtectEncryption |
| MACRandomization | MACRandomization |
| CallAdmissionControl | CallAdmissionControl |
| EnableAmpdu | EnableAmpdu |
| GratuitousARP | GratuitousARP |
| ChannelBondingMode2g | ChannelBondingMode2g |
| WLANExtendedConfig | WLANExtendedConfig |
| RoamRSSIThreshold | RoamRSSIThreshold |
| RoamRSSIDelta | RoamRSSIDelta |
| MandateServerCertificate | MandateServerCertificate |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Custom Name
Enter a custom Name that identifies a single advanced option to be configured for the WLAN adapter on a device. You must also specify Value to provide the value to be set for the advanced option identified by the specified name.
Detail Information:
Key = wlanAdvancedOptionCustomName
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Value
Enter a value for a single advanced option to be configured for the WLAN adapter on a device and should be specified when Name or Custom Name are specified to provide the name of the advanced option.
Detail Information:
Key = wlanAdvancedOptionValue
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Diagnostics Options
Use this Sub-array to configure one or more Diagnostics Option(s).
Detail Information:
Key = wlanDiagnosticsOptions
Type = bundle_array
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.4.
Diagnostics Option
Use this Sub-group to configure Name, Custom Name, and Value.
Detail Information:
Key = wlanDiagnosticsOptionPair
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Name
Select a Name that identifies a single standard Diagnostic Option to be configured for the WLAN adapter on a device. You must also specify Value to provide the value to be set for the Diagnostic Option identified by the specified name.
Detail Information:
Key = wlanDiagnosticsOptionName
Type = string
| UI Choice | JSON Value |
|---|---|
| FusionAdvancedLogging | FusionAdvancedLogging |
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Custom Name
Enter a custom name that identifies a single Diagnostic Option to be configured for the WLAN adapter on a device. You must also specify Value to provide the value to be set for the Diagnostic Option identified by the specified name.
Detail Information:
Key = wlanDiagnosticsOptionCustomName
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Value
Enter a value for a single Diagnostic Option to be configured for the WLAN adapter on a device. You must also specify Name or Name Custom to provide the name that identifies the Diagnostic Option to be set.
Detail Information:
Key = wlanDiagnosticsOptionValue
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
Fine Timing Measurement (FTM) Configuration
Use this Sub-group to configure AP Deployment File, AP Source, Deployment Mode, State, and Update Mode.
Detail Information:
Key = wlanFTM
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
AP Deployment File
Enter the AP Target path and file name which contains the AP coordinates used Fine Timing Measurement (FTM) used by the WLAN adapter.
Detail Information:
Key = wlanFTMAPFile
Type = string
Support Information:
- NOT supported on Device(s): TC20 and TC25.
AP Source
Select the AP Source for Fine Timing Measurement (FTM) used by the WLAN adapter.
- if Location XML is selected, then AP Deployment File must also be entered.
Detail Information:
Key = wlanFTMAPSource
Type = string
| UI Choice | JSON Value |
|---|---|
| Location XML | 0 |
| Location from LCR/LCI | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Deployment Mode
Select the deployment mode for Fine Timing Measurement (FTM) used by the WLAN adapter.
Detail Information:
Key = wlanFTMDeploymentMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Standard (FTM enabled) | 0 |
| Enhanced Infra (FTM-enabled) | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
State
Select whether to turn on (enable) or off (disable) Fine Timing Measurement (FTM) used by the WLAN adapter.
- If turned on (enabled) be sure to also specify Deployment Mode to provide the FTM mode to use and AP Source to provide the AP location source.
Detail Information:
Key = wlanFTMEnable
Type = string
| UI Choice | JSON Value |
|---|---|
| Off | 1 |
| On | 0 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.2.
Update Mode
Select whether to use the default update mode or a custom application defined update mode. If custom application defined is used, an application using the LocationManager APIs controls the interval.
If Default is selected, the interval to use is determined by the Zebra locationing app in-use.
If App-defined is selected, the interval to use is determined by any application through the Android LocationManager APIs.
Detail Information:
Key = wlanFTMLocationUpdateMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Default | 0 |
| App-defined | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 11.9.
Global Proxy Configuration
Use this Sub-group to configure State, Host Name, Port, and Bypass.
Detail Information:
Key = wlanGlobalProxyConfig
Type = bundle
Support Information:
- Supported from: MX 11.4.
State
Select whether a global proxy should be used.
If the value On is selected, then the global proxy defined in Host Name, Port, and Bypass will be used.
If the value Off is selected, then no global proxy will be used.
Detail Information:
Key = gpcState
Type = string
| UI Choice | JSON Value |
|---|---|
| On | 1 |
| Off | 0 |
Support Information:
- Supported from: MX 11.4.
Host Name
Enter a Host Name (URL or IP address) of the Global Proxy server
Detail Information:
Key = gpcHostName
Type = string
Support Information:
- Supported from: MX 11.4.
Port
Enter the port number of the Global Proxy Server.
Detail Information:
Key = gpcPort
Type = string
Support Information:
- Supported from: MX 11.4.
Bypass
Enter the host name(s) and/or IP address(es) of devices that should bypass the Global Proxy server. Use comma(s) to separate multiple names. Ex: www.myBypassProxy.com, 192.168.1.100
Detail Information:
Key = gpcBypass
Type = string
Support Information:
- Supported from: MX 11.4.
Hotspot Configuration
Use this Sub-group to configure Hotspot State, SSID, 2.4GHz Channel, 5GHz Channel, Band, Security Mode, and Security Passphrase.
Detail Information:
Key = wlanHotSpotOptions
Type = bundle
Support Information:
- Supported from: MX 6.3.
Hotspot State
Select the state of the Hotspot Mode of the WLAN adapter on a device.
If the value Off is selected, the Hotspot Mode will be turned OFF, preventing the device from sharing its Internet connection as a WLAN Hotspot. Any other existing configuration related to Hotspot Mode will not be affected, allowing Hotspot Mode to be configured and tested, turned OFF and back ON without having to reconfigure it.
If the value On is selected, the Hotspot Mode will be turned ON, allowing the device to share its Internet connection as a WLAN Hotspot, subject to appropriate configuration related to Hotspot Mode.
Detail Information:
Key = wlanHotSpotState
Type = string
| UI Choice | JSON Value |
|---|---|
| Off | 0 |
| On | 1 |
Support Information:
- Supported from: MX 8.1.
SSID
Enter the Service Set Identifier (SSID) that will identify the network supported in Hotspot Mode of the WLAN adapter on a device.
Detail Information:
Key = wlanHotSpotSSID
Type = string
2.4GHz Channel
Select the single 2.4 HGHz Channel in which Hotspot Mode of the WLAN adapter will operate on a device and should be specified when the value 2.4GHz is selected for Band.
Detail Information:
Key = wlanHotSpot24GHzChannel
Type = string
| UI Choice | JSON Value |
|---|---|
| 1 | 1 |
| 2 | 2 |
| 3 | 3 |
| 4 | 4 |
| 5 | 5 |
| 6 | 6 |
| 7 | 7 |
| 8 | 8 |
| 9 | 9 |
| 10 | 10 |
| 11 | 11 |
| 12 | 12 |
| 13 | 13 |
5GHz Channel
Select the single 5.0 HGHz Channel in which Hotspot Mode of the WLAN adapter will operate on a device when the value 5GHz is selected for Band.
Detail Information:
Key = wlanHotSpotBand5GhzChannel
Type = string
| UI Choice | JSON Value |
|---|---|
| 36 | 36 |
| 40 | 40 |
| 44 | 44 |
| 48 | 48 |
| 52 | 52 |
| 56 | 56 |
| 60 | 60 |
| 64 | 64 |
| 100 | 100 |
| 104 | 104 |
| 108 | 108 |
| 112 | 112 |
| 116 | 116 |
| 120 | 120 |
| 124 | 124 |
| 128 | 128 |
| 132 | 132 |
| 136 | 136 |
| 140 | 140 |
| 149 | 149 |
| 153 | 153 |
| 157 | 157 |
| 161 | 161 |
| 165 | 165 |
Band
Select the Frequency Band in which Hotspot Mode of the WLAN adapter will operate on a device.
If the value 2.4GHz is selected, the Hotspot Mode of the WLAN adapter will operate solely in the 2.4 Gigahertz (GHz) Frequency Band and hence only devices capable of operating in that Frequency Band will be capable of sharing the Internet connection of the device via Hotspot Mode.
If the value 5GHz is selected, the Hotspot Mode of the WLAN adapter will operate solely in the 5.0 Gigahertz (GHz) Frequency Band and hence only devices capable of operating in that Frequency Band will be capable of sharing the Internet connection of the device via Hotspot Mode.
Detail Information:
Key = wlanHotSpotBand
Type = string
| UI Choice | JSON Value |
|---|---|
| 2.4GHz | 0 |
| 5GHz | 1 |
Security Mode
Select the Security Mode to be used to secure the Hotspot Mode of the WLAN adapter will operate on a device.
If the value Open is selected, the WLAN adapter will apply no security for Hotspot Mode, thus providing no control over which devices can connect and share the Internet connection of the device via Hotspot Mode.
If the value WPA2/PSK is selected, the WLAN adapter will apply Wi-Fi Protected Access Version 2 (WPA2) Pre-shared Key (PSK) security for Hotspot Mode, thus providing some control over which devices can connect and share the Internet connection of the device via Hotspot Mode. You must also specify Security Passphrase to provide the PSK passphrase that will be used to secure the network.
Detail Information:
Key = wlanHotSpotSecurityMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Open | 0 |
| WPA2/PSK | 1 |
Security Passphrase
Enter the PSK passphrase that will be used to secure the Hotspot Mode network implemented by the WLAN adapter on a device, when the value WPA2/PSK is selected for Security Mode.
Detail Information:
Key = wlanHotSpotSecurityPassphrase
Type = string
SecureFusionAdvanced
Use this Sub-group to configure LoggingMode and EncryptionPassword.
Detail Information:
Key = wlanSecureFusionAdvanced
Type = bundle
Support Information:
- Supported from: MX 13.2.
LoggingMode
Select On/Off for Secure Advanced Logging Mode, which encrypts Wi-Fi Advanced logs and imposes a user-specified password for log access.
If the value Enable is selected, Enables secure logging of Wi-Fi events.
If the value Disable is selected, Disables secure logging of Wi-Fi events.
Detail Information:
Key = LoggingMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | 2 |
| Enable | 1 |
| Disable | 0 |
Support Information:
- Supported from: MX 13.2.
EncryptionPassword
Enter a Password for access to encrypted Wi-Fi event logs when Secure Logging is used. Case sensitive. Parm value input rules: String from 8–32 alphanumeric/special characters Permitted characters: A-Z, a-z, 0-9, underscore (_), pound (#), dollar sign ($)
Detail Information:
Key = EncryptionPassword
Type = string
Support Information:
- Supported from: MX 13.2.
Wireless WAN Configuration
Use this Sub-group to configure APNs, Data, Device Administrator Lock, Dual SIM Dual Standby, General, and eSIM Profiles.
Detail Information:
Key = wwanConfig
Type = bundle
Support Information:
- NOT supported on Device(s): TC20 and TC25.
APNs
Use this Sub-array to configure one or more Access Point Name(s) that can be used to connect to WWAN data services.
Detail Information:
Key = apns
Type = bundle_array
APN
Use this Sub-group to configure Name, Make Default, Access Point, User Name, Password, Port, Proxy, MMS Port, MMS Proxy, Server, MMSC, Type, MCC, MNC, Authentication Type, MVNO Type, Protocol, Roaming Protocol, and MVNO Match Data.
Detail Information:
Key = apn
Type = bundle
Name
Enter the name of an APN.
Detail Information:
Key = apnApnName
Type = string
Make Default
Select whether an APN should be the default APN.
If the value Yes is selected, the APN being will be the default APN and will be preferred over other APNs when establishing a cellular data connection.
If the value No is selected, the APN will not be the default APN.
Detail Information:
Key = apnMakeDefault
Type = string
| UI Choice | JSON Value |
|---|---|
| Yes | 1 |
| No | 0 |
Access Point
Enter a value that uniquely identifies an APN on the network.
APN Identifiers are allocated by cellular carriers to identify the networks that can be reached via various APNs. When acquiring a cellular data plan from a carrier, an APN Identifier will be provided, typically along with other information that qualifies or controls access to the network it identifies.
Detail Information:
Key = apnCustomAccessPoint
Type = string
User Name
Enter a user name that can be used to authenticate to an APN.
A network accessed via a given APN Identifier may or may not require authentication. If authentication is required, a user name is generally always required and a password MAY also be required.
Detail Information:
Key = apnUserName
Type = string
Password
Enter a password that can be used to authenticate to an APN.
A network accessed via a given APN Identifier may or may not require authentication. If authentication is required, a user name is generally always required and a password MAY also be required.
Detail Information:
Key = apnCustomPassword
Type = string
Port
Enter the port number of an HTTP proxy to use for all traffic over the network accessed via an APN.
If a Proxy is required, a Port is also generally always required.
Detail Information:
Key = CustomPort
Type = string
Proxy
Enter the address or name of an HTTP proxy to use for all traffic over the network accessed via an APN.
- If a Proxy is required, a Port is also generally always required.
Detail Information:
Key = apnCustomProxy
Type = string
MMS Port
Enter the port number of an HTTP proxy to use ONLY for (Multimedia Messaging Service) MMS traffic over the network accessed via an APN.
- If an MMS Proxy is required, an MMS Port is also generally always required.
Detail Information:
Key = apnCustomMmsPort
Type = string
MMS Proxy
Enter the address or name of an HTTP proxy to use ONLY for (Multimedia Messaging Service) MMS traffic over the network accessed via an APN.
- If an MMS Proxy is required, an MMS Port is also generally always required.
Detail Information:
Key = apnCustomMmsProxy
Type = string
Server
Enter a WAP Gateway Server address that should be used for an APN.
WAP Gateways are rarely, if ever, used on or supported by modern cellular carrier networks.
Detail Information:
Key = apnCustomServer
Type = string
MMSC
Enter the Multimedia Messaging Service Center (MMSC) address required to route MMS traffic over the network accessed via an APN.
Detail Information:
Key = apnCustomMmsc
Type = string
Type
Enter the Type of APN.
The value to enter for Type should be obtained from the cellular carrier whose network is to be accessed via the APN.
Detail Information:
Key = apnCustomType
Type = string
MCC
Enter the Mobile Country Code (MCC) of the APN.
The MCC generally match the SIM Card being used or the APN will not be usable.
Detail Information:
Key = apnCustomMcc
Type = string
MNC
Enter the Mobile Network Code (MNC) of the APN.
The MNC generally match the SIM Card being used or the APN will not be usable.
Detail Information:
Key = apnCustomMnc
Type = string
Authentication Type
Select the Type of Authentication to be used for APN.
If the value None is selected, No Authentication Protocol will be used to authenticate for the APN.
If the value PAP is selected, the Password Authentication Protocol (PAP) will be used to authenticate for the APN.
If the value CHAP is selected, the Challenge Handshake Authentication Protocol (CHAP) will be used to authenticate for the APN.
Detail Information:
Key = apnCustomAuthType
Type = string
| UI Choice | JSON Value |
|---|---|
| None | 1 |
| PAP | 2 |
| CHAP | 3 |
MVNO Type
Enter the Mobile Virtual Network Operator (MVNO) Type to be used for APN .
If the value None is selected, No MVNO will be used to configured for the APN.
If the value SPN is selected, the MVNO will be specified via an SPN (Service Provider Name) value for the APN, which you must also specify via MVNO Match Data.
If the value IMSI is selected, the MVNO will be specified via an IMSI (International Mobile Subscriber Identity) value for the APN, which you must specify via MVNO Match Data.
If the value GID is selected, the MVNO will be specified via an GID (Group Identifier) value for the APN, which you must specify via MVNO Match Data.
If the value ICCID is selected, the MVNO will be specified via an GID (Integrated Circuit Card ID) value for the APN, which you must specify via MVNO Match Data.
Detail Information:
Key = apnCustomMvnoType
Type = string
| UI Choice | JSON Value |
|---|---|
| None | 1 |
| SPN | 2 |
| IMSI | 3 |
| GID | 4 |
| ICCID | 5 |
Protocol
Select the Protocol for an APN.
If the value IPv4 is selected, IPv4 will be applied.
If the value IPv6 is selected, IPv6 will be applied.
If the value IPv4/IPv6 is selected, IPv4/IPv6 will be applied.
Detail Information:
Key = apnCustomProtocol
Type = string
| UI Choice | JSON Value |
|---|---|
| IPv4 | 1 |
| IPv6 | 2 |
| IPv4/IPv6 | 3 |
Roaming Protocol
Select the APN Roaming Protocol
If the value IPv4 is selected, IPv4 will be applied
If the value IPv6 is selected, IPv6 will be applied
If the value IPv4/IPv6 is selected, IPv4/IPv6 will be applied
Detail Information:
Key = apnCustomRoamingProtocol
Type = string
| UI Choice | JSON Value |
|---|---|
| IPv4 | 1 |
| IPv6 | 2 |
| IPv4/IPv6 | 3 |
MVNO Match Data
Enter the Mobile Virtual Network Operator (MVNO) Match Data to be used for an APN when a value other than None is selected for MVNO Type.
The exact value to be specified depends on the MVNO Type specified. Consult your MVNO carrier for information on the MVNO Type and MVNO Match Data value to be used.
Detail Information:
Key = apnCustomMvnoMatchData
Type = string
Data Configuration
Use this Sub-group to configure State, Service Type, Background Data, Data Roaming, User Control of Background Data, Data Limit State, Data Limit State Custom Limit, User Control of Data Limit, and Data Warning Threshold.
Detail Information:
Key = dataConfig
Type = bundle
State
Select the Power State of the WWAN adapter.
If the value Off is selected, the power to the WWAN adapter will be turned OFF, preventing all communications via the WWAN adapter and reducing battery drain.
If the value On is selected, the power to the WWAN adapter will be turned ON, potentially allowing communications via the WWAN adapter and increasing battery drain.
Detail Information:
Key = wwanDataConfigState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 6.3.
Service Type
Select the service type to use on the WWAN adapter.
If the value Data Only is selected, the service type of Data Only will be used.
If the value Voice + Data is selected, the service type of Voice + Data will be used.
Detail Information:
Key = wwanDataConfigServiceType
Type = string
| UI Choice | JSON Value |
|---|---|
| Data Only | 2 |
| Voice + Data | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 10.0.
Background Data
Select whether use of WWAN Background Data will be Allowed.
If the value Disallow is selected, use of WWAN Background Data will NOT be Allowed.
If the value Allow is selected, use of WWAN Background Data WILL be Allowed.
Detail Information:
Key = wwanDataConfigBackgroundData
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
- Supported from: MX 4.3.
Data Roaming
Select whether use of WWAN Data Roaming will be Allowed.
If the value Disallow is selected, use of WWAN Data Roaming will NOT be Allowed.
If the value Allow is selected, use of WWAN Data Roaming WILL be Allowed.
Detail Information:
Key = wwanDataConfigDataRoaming
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
- Supported from: MX 4.4.
User Control of Background Data
Select whether the User will be Allowed to control whether WWAN data can be used in the background.
If the value Disallow is selected, the User will NOT be Allowed to control whether WWAN data can be used in the background.
If the value Allow is selected, the User WILL be Allowed to control whether WWAN data can be used in the background.
Detail Information:
Key = wwanDataConfigUserControlBackgroundData
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 4.4.
Data Limit State
Select whether a limit should be imposed on the amount of WWAN data used, such as to control telecom expenses.
If the value Enable and set default limit is selected, a default limit will be imposed on the amount of WWAN data that can be used.
If the value Enable and set custom limit is selected, a custom limit will be imposed on the amount of WWAN data that can be used and you must also specify Custom Limit to provide the desired custom limit.
If the value Disable is selected, no limit will be imposed on the amount of WWAN data that can be used.
Detail Information:
Key = wwanDataConfigLimitState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Enable and set default limit | 1 |
| Enable and set custom limit | 2 |
| Disable | 3 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 6.3.
Data Limit State Custom Limit
Enter a custom limit that should be imposed on the amount of WWAN data used, such as to control telecom expenses, when the value Enable and set custom limit is selected for Data Limit State.
The custom limit should be an integer value specifying the maximum amount of WWAN data that can be used, in megabytes (MB).
Detail Information:
Key = wwanDataConfigCustomLimit
Type = integer
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 6.3.
User Control of Data Limit
Select whether the User will be Allowed to control limits on how much data can be communicated using the WWAN adapter.
If the value Disallow is selected, the User will NOT be Allowed to control limits on how much data can be communicated using the WWAN adapter.
If the value Allow is selected, the User WILL be Allowed to control limits on how much data can be communicated using the WWAN adapter.
Detail Information:
Key = wwanDataConfigUserControlDataLimit
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 6.3.
Data Warning Threshold
Enter a Threshold amount of WWAN data usage, where a Warning will be generated to the User if it is exceeded.
The threshold should be an integer value specifying the threshold amount of WWAN data, in megabytes (MB).
Detail Information:
Key = wwanDataConfigWarningThreshold
Type = integer
Support Information:
- Supported from: MX 6.3.
Device Administrator Lock Configuration
Use this Sub-group to configure State, Type, ICCID, Network List, Unlock Code, and Unlock Retry Count.
Detail Information:
Key = daLockConfig
Type = bundle
Support Information:
- Supported from: MX 9.2.
State
Select whether the WWAN adapter will be locked to a Device Administrator defined carrier.
If the value Unlocked is selected, the WWAN adapter will NOT be locked to a Device Administrator-defined carrier. If the WWAN adapter was previously locked to a carrier, then you must also specify Type to identify the type of prior Lock to be Unlocked and you must also specify Unlock Code to provide the same Unlock Code provided when the prior Lock was performed.
If the value Locked is selected, the WWAN adapter WILL be locked to a Device Administrator-defined carrier. You must specify Type, Unlock Code, Unlock Retry Count, and Network List to provide the detail information required to establish the Lock. You must also specify ICCID if the value ICCID Lock is selected for Type.
Detail Information:
Key = daLockConfigState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Locked | 1 |
| Unlocked | 2 |
Type
Select the Lock Type to be used to Lock the WWAN adapter to a Device Administrator-defined carrier when Locked is specified for State.
If the value Network Lock is selected, the WWAN adapter will be Locked to one or more carrier networks and Network List must be specified to identify those networks.
If the value ICCID Lock is selected, the WWAN adapter will be Locked to a SIM Card, identified by an Integrated Circuit Card Identifier (ICCID) and ICCID must be specified to identify that ICCID.
Detail Information:
Key = daLockConfigType
Type = string
| UI Choice | JSON Value |
|---|---|
| Network Lock | 0 |
| ICCID Lock | 1 |
ICCID
Enter the Integrated Circuit Card Identifier (ICCID) that identifies the SIM Card to which the WWAN adapter will be Locked when Locked is specified for State and ICCID Lock is specified for Type.
Detail Information:
Key = daLockConfigIccid
Type = string
Network List
Enter the Network List, as one or more MCC or MNC values, that identifies network(s) to which the WWAN adapter will be Locked when Locked is specified for State and Network Lock is specified for Type.
To provide multiple values, separate with commas (e.g. 1,310410,31012).
Detail Information:
Key = daLockConfigNetworkList
Type = string
Unlock Code
Enter a string value for the Unlock Code.
- When Locked is specified for State, an Unlock Code must be chosen, entered, and saved security, since it will be needed later to Unlock.
- When Unlocked is specified for State, the Unlock Code previously specified when the Lock was done must be entered in order to successfully Unlock.
Detail Information:
Key = daLockConfigUnlockCode
Type = string
Unlock Retry Count
Enter a integer value for the Unlock Retry Count when Locked is specified for State to configure the maximum number of unsuccessful Unlock attempts can be attempted before further attempts will be blocked.
Detail Information:
Key = daLockConfigUnlockRetryCount
Type = string
Dual SIM Dual Standby Configuration
Use this Sub-group to configure Subscription Mode, State, Automatic Subscription, and Manual Subscription.
Detail Information:
Key = dsdsConfig
Type = bundle
Support Information:
Supported on Operating System(s): Oreo and Android 10.
Supported on Device(s): L10, TC57, and TC77.
Supported from: MX 10.2.
Subscription Mode
Select how Subscription Selection should be performed when the value On is selected for State.
If the value Automatic is selected, Automatic Subscription Selection will be used. You can specify the preferred SIM, and hence the preferred Subscription, to use for Data Communications, Voice Calls, and Text Messages collectively, by specifying Preferred Data Subscription SIM. If you do not specify a preferred Subscription, the Subscription for the primary SIM will be used as the preferred Subsciption. The preferred Subscription will be used as the current Subscription when it is in an In Service condition. When the current Subscription is in a sustained Out of Service condition, an automatic switch to the Subscription for the other SIM will be performed if that Subscription is in an In Service condition. You must specify Out of Service Timeout to provide the duration that the current Subscription must remain in an Out of Service condition before automatic switching to the other Subscription can occur.
If the value Manual is selected, Manual Subscription Selection will be used. You can select the preferred SIM, and hence the preferred Subscription, to use for Data Communications, Voice Calls, and Text Messages independently, by specifying Preferred Data Subscription SIM, Preferred Voice Call Subscription SIM, and Preferred Text Message Subscription SIM, respectively. If you do not specify a preferred Subscription for any service, then the Subscription for the primary SIM will be used as the preferred Subscription.
Detail Information:
Key = dsdsSubscriptionMode
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Manual | 2 |
| Automatic | 1 |
Support Information:
Supported on Operating System(s): Oreo and Android 10.
Supported on Device(s): L10, TC57, and TC77.
State
Select whether the WWAN adapter will handle multiple SIM Card(s) in Dual SIM Dual Standby (DSDS) Mode.
If the value Off is selected, the WWAN adapter will NOT handle multiple SIM Cards in Single SIM Mode, which means that ONLY the Subscription for the currently selected SIM will be available for use. To use a different Subscription, a different SIM must be explicitly selected by specifying SIM Card Slot.
If the value On is selected, the WWAN adapter WILL handle multiple SIM Cards in Dual SIM Dual Standby Mode, which means that two SIM Cards, if present, can be active at the same time. This can be beneficial if the Subscriptions for those SIMs have different performance, pricing, coverage, etc. The default behavior in Dual SIM Dual Standby Mode is for Incoming Voice Calls and Incoming Text Messages to be received using BOTH Subscriptions, Outgoing Voice Calls and Outgoing Text Messages to ask the User which Subscription to use, and Data Communications to use the Subscription for the primary SIM. You can also use the Sub-group Dual SIM Dual Standby Configuration to modify the default behavior of Dual SIM Dual Standby Mode.
Detail Information:
Key = dsdsState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
Supported on Device(s): L10, TC57, and TC77.
Supported from: MX 8.1.
Automatic Subscription Configuration
Use this Sub-group to configure Out of Service Timeout and Preferred Subscription SIM.
Detail Information:
Key = dsdsAutoConfig
Type = bundle
Support Information:
Supported on Operating System(s): Oreo and Android 10.
Supported on Device(s): L10, TC57, and TC77.
Out of Service Timeout
Enter a Duration (in seconds) that the Subscription for the current SIM must remain in an Out of Service condition before automatic switching to the Subscription for the other SIM may occur, when the value On is selected for State and the value Automatic is selected for Subscription Mode.
Detail Information:
Key = dsdsAutoConfigOutOfServiceTimeout
Type = integer
Support Information:
Supported on Operating System(s): Oreo and Android 10.
Supported on Device(s): L10, TC57, and TC77.
Preferred Subscription SIM
Select the SIM that identifies the Subscription to be used as the preferred Subscription, when the value On is selected for State and the value Automatic is selected for Subscription Mode.
The Subscription for the selected SIM will be the initial default Subscription to use and the preferred Subscription to use to if the Subscriptions for both SIMs are in an In Service condition.
Detail Information:
Key = dsdsAutoConfigPreferredSubscriptionSim
Type = string
| UI Choice | JSON Value |
|---|---|
| SIM 1 | 0 |
| SIM 2 | 1 |
Support Information:
Supported on Operating System(s): Oreo and Android 10.
Supported on Device(s): L10, TC57, and TC77.
Manual Subscription Configuration
Use this Sub-group to configure Preferred Data Subscription SIM, Preferred Voice Call Subscription SIM, and Preferred Text Message Subscription SIM.
Detail Information:
Key = dsdsManualConfig
Type = bundle
Support Information:
Supported on Operating System(s): Oreo and Android 10.
Supported on Device(s): L10, TC57, and TC77.
Preferred Data Subscription SIM
Select the SIM that identifies the Subscription to be used as the preferred Subscription for Data Communications, when the value On is selected for State and the value Manual is selected for Subscription Mode. If you do not specify a preferred Subscription, then the Subscription for the primary SIM will be used as the preferred Subscription.
Detail Information:
Key = dsdsManualConfigPreferredDataSubscriptionSim
Type = string
| UI Choice | JSON Value |
|---|---|
| SIM 1 | 1 |
| SIM 2 | 2 |
Support Information:
Supported on Operating System(s): Oreo and Android 10.
Supported on Device(s): L10, TC57, and TC77.
Preferred Voice Call Subscription SIM
Select the SIM that identifies the Subscription to be used as the preferred Subscription for Voice Calls, when the value On is selected for State and the value Manual is selected for Subscription Mode.
If the value Ask is selected, then no preferred Subscription for Voice Calls will be specified and the User will be asked each time an Outgoing Voice Call is initiated.
If the value SIM 1 or SIM 2 is selected, then the Subscription for the selected SIM will be used as the preferred Subscription for Voice Calls and the User will NOT be asked each time an Outgoing Voice Call is initiated.
Detail Information:
Key = dsdsManualConfigPreferredVoiceCallSubscriptionSim
Type = string
| UI Choice | JSON Value |
|---|---|
| Ask | 1 |
| SIM 1 | 2 |
| SIM 2 | 3 |
Support Information:
Supported on Operating System(s): Oreo and Android 10.
Supported on Device(s): L10, TC57, and TC77.
Preferred Text Message Subscription SIM
Select the SIM that identifies the Subscription to be used as the preferred Subscription for Text Messages, when the value On is selected for State and the value Manual is selected for Subscription Mode.
If the value Ask is selected, then no preferred Subscription for Text Messages will be specified and the User will be asked each time an Outgoing Text Message is initiated.
If the value SIM 1 or SIM 2 is selected, then the Subscription for the selected SIM will be used as the preferred Subscription for Text Messages and the User will NOT be asked each time an Outgoing Text Messages is initiated.
Detail Information:
Key = dsdsManualConfigPreferredTextMessageSubscriptionSim
Type = string
| UI Choice | JSON Value |
|---|---|
| Ask | 1 |
| SIM 1 | 2 |
| SIM 2 | 3 |
Support Information:
Supported on Operating System(s): Oreo and Android 10.
Supported on Device(s): L10, TC57, and TC77.
General Configuration
Use this Sub-group to configure State, User Control of State, Incoming Calls, Incoming Call Blocking Emergency Override, Outgoing Calls, Preferred Network, SIM Card Slot, User Control of Sim Card Slot, Public Land Mobile Network Lock State, Public Land Mobile Network Lock Value, User Control of Public Land Mobile Network Lock, Configure Preferred 5G New Radio Mode, NR Mode, Slot ID for New Radio mode, and Configure VoLTE/VoNR.
Detail Information:
Key = generalConfig
Type = bundle
State
Select the Power State of the WWAN Adapter.
A given device may or may not support a WWAN Adapter. An attempt to configure the WWAN Adapter on a device that does not have one will result in an error.
Detail Information:
Key = wwanGeneralConfigState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
- Supported from: MX 4.3.
User Control of State
Select whether the User will be Allowed to change the WWAN Power State.
If the value Disallow is selected, the User will NOT be Allowed to change the WWAN Power State.
If the value Allow is selected, the User WILL be Allowed to change the WWAN Power State.
Detail Information:
Key = wwanGeneralConfigUserControlState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 6.3.
Incoming Calls
Select whether incoming calls are blocked or allowed.
If Allowed is selected, incoming calls will be blocked. One exception is incoming calls due to an emergency call.
If Blocked is selected, incoming calls will be allowed.
Detail Information:
Key = wwanGeneralIncomingCalls
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Blocked | 2 |
| Allowed | 1 |
Support Information:
- Supported from: MX 11.9.
Incoming Call Blocking Emergency Override
Enter the amount of time after an emergency call ends to allow for first responders to call back. Emergency service personnel may need to call the device for further information. If incoming calls are blocked, then use this managed configuration to specify an amount of time (in minutes) to disable call blocking to allow for callbacks.
Detail Information:
Key = wwanGeneralEmergencyOverride
Type = string
Support Information:
- Supported from: MX 11.9.
Outgoing Calls
Select whether outgoing calls are blocked or allowed.
If Allowed is selected, outgoing calls will be blocked. Emergency calls are always allowed.
If Blocked is selected, outgoing calls will be allowed.
Detail Information:
Key = wwanGeneralOutgoingCalls
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Blocked | 2 |
| Allowed | 1 |
Support Information:
- Supported from: MX 11.9.
Preferred Network
Use this Sub-group to configure State, Slot ID, and Mode.
Detail Information:
Key = preferredNetworkModeConfig
Type = bundle
State
Select whether to enable Preferred Network Mode, which can limit communications by network type
Detail Information:
Key = pNMCState
Type = string
| UI Choice | JSON Value |
|---|---|
| Turn On | Turn On |
| Turn Off | Turn Off |
Support Information:
- Supported from: MX 11.7.
Slot ID
Select a SIM slot to which to apply the preferred network mode
Detail Information:
Key = pNMCSlotID
Type = string
| UI Choice | JSON Value |
|---|---|
| SIM1 | SIM1 |
| SIM2 | SIM2 |
Support Information:
- Supported from: MX 11.7.
Mode
Select the preferred network mode to use for the specified SIM slot. NOTE: Not all devices and/or carriers support all listed network modes; unsupported selections are ignored.
Detail Information:
Key = pNMCMode
Type = string
| UI Choice | JSON Value |
|---|---|
| NR/LTE/GSM/WCDMA.NR/LTE/WCDMA | NR/LTE/GSM/WCDMA.NR/LTE/WCDMA |
| NR/LTE | NR/LTE |
| NR only | NR only |
| GSM/WCDMA/LTE | GSM/WCDMA/LTE |
| GSM/WCDMA | GSM/WCDMA |
| WCDMA only | WCDMA only |
| GSM only | GSM only |
Support Information:
- Supported from: MX 11.7.
SIM Card Slot
Select the SIM Card slot that will be used by the WWAN adapter.
If the value Slot 1 is selected, the WWAN adapter will attempt to use the SIM Card slot designated as Slot 1.
If the value Slot 2 is selected, the WWAN adapter will attempt to use the SIM Card slot designated as Slot 2.
If the value Slot 3 is selected, the WWAN adapter will attempt to use the SIM Card slot designated as Slot 3.
If the value Slot 4 is selected, the WWAN adapter will attempt to use the SIM Card slot designated as Slot 4.
Note that:
A given device may or may not support a WWAN Adapter. An attempt to configure the WWAN Adapter on a device that does not have one will result in an error.
A given device may have a limited number of SIM Card slots. An attempt to configure the WWAN Adapter to use an unsupported SIM Card slot will result in an error.
A given device may support a given SIM car slot, but that SIM car slot may not contain a SIM Card. An attempt to configure the WWAN Adapter to use a supported but unpopulated SIM Card slot will result in an error.
Detail Information:
Key = wwanGeneralConfigSimCardSlot
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Slot 1 | 1 |
| Slot 2 | 2 |
| Slot 3 | 3 |
| Slot 4 | 4 |
Support Information:
- Supported from: MX 6.2.
User Control of Sim Card Slot
Select whether the User will be allowed to select which WWAN SIM slot will be used.
If the value Disallow is selected, the User will NOT be allowed to select which WWAN SIM slot will be used.
If the value Allow is selected, the User WILL be allowed to select which WWAN SIM slot will be used.
Detail Information:
Key = wwanGeneralConfigUserControlSimCardSlot
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 6.2.
Public Land Mobile Network Lock State
Select whether the WWAN adapter will be locked to a single Public Land Mobile Network Lock (PLMN).
If the value Off is selected, the WWAN adapter will be locked to a single Public Land Mobile Network Lock (PLMN).and hence will be free to connect to any PLMN that is compatible with the SIM Card being used.
If the value On is selected, the WWAN adapter will be locked to a single Public Land Mobile Network Lock (PLMN) and hence will only be able to connect to the PLMN to which it is locked. You must also specify Value to provide the value that identifies the PLMN to which the WWAN adapter will be locked.
Detail Information:
Key = wwanGeneralConfigPlmnLockState
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Off | 2 |
| On | 1 |
Support Information:
- Supported from: MX 8.1.
Public Land Mobile Network Lock Value
Enter the value that identifies the Public Land Mobile Network Lock (PLMN) to which the WWAN adapter will be locked when the value On is selected for Public Land Mobile Network Lock State.
The value provided to identify a PLMN must specify both the Mobile Country Code (MCC) and the Mobile Network Code (MNC). Since all MCC values are three digits and MNC values can be 2 or 3 digits, the value provided must be of the format XXXYY or XXXYYY, where XXX is the three digit MCC value and YY or YYY is the 2 or 3 digit MNC value.
Detail Information:
Key = wwanGeneralConfigPlmnLockValue
Type = string
Support Information:
- Supported from: MX 8.1.
User Control of Public Land Mobile Network Lock
Select whether the User will be Allowed to control locking of the WWAN adapter to a single Public Land Mobile Network (PLMN).
If the value Disallow is selected, the User will NOT be Allowed to control locking of the WWAN adapter to a single Public Land Mobile Network (PLMN).
If the value Allow is selected, the User WILL be Allowed to control locking of the WWAN adapter to a single Public Land Mobile Network (PLMN).
Detail Information:
Key = wwanGeneralConfigUserControlPlmnLock
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | |
| Disallow | 2 |
| Allow | 1 |
Support Information:
NOT supported on Device(s): TC20 and TC25.
Supported from: MX 8.1.
Configure Preferred 5G New Radio Mode
Select whether to Control configuration of the 5G New Radio.
If the value Off is selected, Disables configuration of the 5G New Radio in the specified SIM slot, returning the SIM to its factory-default settings.
If the value On is selected, Turns on the 5G NR for the specified SIM slot, enabling the 5G Network Mode for the SIM to be configured.
Detail Information:
Key = wwanGeneralConfigPref5GNRModeFeatures
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | 0 |
| Off | 2 |
| On | 1 |
Support Information:
- Supported from: MX 13.2.
NR Mode
Select standalone (SA) or non-standalone (NSA) 5G New Radio (NR) Mode for the specified SIM slot.
If the value SA + NSA is selected, Allows either stand-alone or non stand-alone 5G New Radio modes to be used.
If the value Non-Stand-Alone (NSA) only is selected, Allows only the non-standalone 5G New Radio mode to be used.
If the value Stand-Alone (SA) only is selected, Allows standalone 5G New Radio mode to be used.
Detail Information:
Key = wwanGeneralConfigPref5GNRMode
Type = string
| UI Choice | JSON Value |
|---|---|
| SA + NSA | 0 |
| Non-Stand-Alone (NSA) only | 1 |
| Stand-Alone (SA) only | 2 |
Support Information:
- Supported from: MX 13.2.
Slot ID for New Radio mode
Select the SIM slot to which to apply the selected New Radio (NR) Mode.
If the value SIM2 is selected, Designates SIM2 as the slot to enable the selected 5G NR mode.
If the value SIM1 is selected, Designates SIM1 as the slot to enable the selected 5G NR mode.
Detail Information:
Key = wwanGeneralConfigPref5GNRModeSlotId
Type = string
| UI Choice | JSON Value |
|---|---|
| SIM2 | 1 |
| SIM1 | 0 |
Support Information:
- Supported from: MX 13.2.
Configure VoLTE/VoNR
Enter the content of a JSON file on the administrator PC that contains lists of at least one Mobile Country Code (MCC) and one Mobile Network Code (MNC) to use for Voice Over LTE (VoLTE) and/or Voice over New Radio (VoNR). The MCC/MNC is a five- or six-digit number that first indicates the country of operation (always three numerical digits) followed by the MNC, which is either two or three digits. When combined, each entry must therefore be expressed as either XXXYY or XXXYYY (where MCC = XXX and MNC = YY or YYY). Parm value input rules: File in JSON format containing at least one (1) character File must be named VolteConfigMccMncList.json
Detail Information:
Key = wwanGeneralConfigVolteConfigMccMncList
Type = string
Support Information:
- Supported from: MX 13.2.
eSIM Profiles
Use this Sub-array to configure one or more eSIM Profile(s).
Detail Information:
Key = esimProfiles
Type = bundle_array
Support Information:
- Supported from: MX 10.0.
eSIM Profile
Use this Sub-group to configure Type, Activation Code, State, Nickname, SIM Slot ID, and SM-DP+ Address.
Detail Information:
Key = esimProfile
Type = bundle
Type
Select the Type of an eSIM Profile.
If the value Use SM-DP+ Address is selected, the eSim profile will be created as a SM-DP+ Address type.
If the value Use Activation Code is selected, the eSim profile will be created as an Activation Code type.
Detail Information:
Key = esimType
Type = string
| UI Choice | JSON Value |
|---|---|
| Do not change | 0 |
| Use SM-DP+ Address | 2 |
| Use Activation Code | 1 |
Activation Code
Enter the Activation Code for an eSIM Profile.
Detail Information:
Key = eSimActivationCode
Type = string
State
Select the State (On/Off) of an eSIM Profile.
If the value Off is selected, the State the eSIM Profile will NOT be available for use.
If the value On is selected, the State the eSIM Profile WILL be available for use.
Detail Information:
Key = esimState
Type = string
| UI Choice | JSON Value |
|---|---|
| Off | 2 |
| On | 1 |
Nickname
Enter a Profile Nickname for an eSIM Profile.
Detail Information:
Key = esimProfileNickname
Type = string
SIM Slot ID
Select the SIM Slot ID to be used for an eSIM Profile.
Detail Information:
Key = esimProfileSlotId
Type = string
| UI Choice | JSON Value |
|---|---|
| SIM1 | 0 |
| SIM2 | 1 |
Support Information:
- Supported from: MX 10.0.
SM-DP+ Address
Enter the SM-DP+ Address for an eSIM Profile.
Detail Information:
Key = esimSmdpAddress
Type = string